पूरे Google Workspace एडमिन को ऐक्सेस देना

Cloud Search Query API के लिए ज़रूरी है कि एपीआई कॉल को आपके डोमेन में लाइसेंस वाले उपयोगकर्ता के OAuth क्रेडेंशियल का इस्तेमाल करके अनुमति दी जाए. डिफ़ॉल्ट रूप से, इंडेक्स करने और कॉन्फ़िगरेशन एपीआई को ऐक्सेस करने के लिए इस्तेमाल किए जाने वाले सेवा खातों का इस्तेमाल, क्वेरी एपीआई कॉल के लिए नहीं किया जा सकता. ऐसा इसलिए है, क्योंकि ये खाते, Cloud Search या Google Workspace के लाइसेंस वाले डोमेन के उपयोगकर्ता नहीं हैं. अगर आपको क्वेरी एपीआई कॉल की पुष्टि करते समय, किसी सेवा खाते का इस्तेमाल करना है, तो डोमेन एडमिन उस खाते को डोमेन के सभी उपयोगकर्ताओं के डेटा का ऐक्सेस दे सकता है. इसे डोमेन के लिए अधिकार सौंपना कहा जाता है. किसी और को दी गई अनुमति वाला सेवा खाता, किसी भी उपयोगकर्ता के नाम पर काम कर सकता है. इसमें Cloud Search का ऐक्सेस रखने वाले उपयोगकर्ता भी शामिल हैं.

सेवा खाता और क्रेडेंशियल बनाना

अगर आपके पास अब तक सेवा खाते के क्रेडेंशियल नहीं हैं, तो सेवा खाते के क्रेडेंशियल बनाएं लेख पढ़ें.

अपने सेवा खाते को डोमेन के लिए अनुमति देना

Google Workspace डोमेन पर उपयोगकर्ता का डेटा ऐक्सेस करने के लिए, आपके बनाए गए सेवा खाते को डोमेन के सुपर एडमिन से ऐक्सेस देना होगा. पूरे डोमेन के डेटा का ऐक्सेस देने के बारे में ज़्यादा जानने के लिए, पूरे डोमेन के डेटा का ऐक्सेस देने की सुविधा की मदद से, Google Workspace API का ऐक्सेस कंट्रोल करना लेख पढ़ें.

किसी सेवा खाते को डोमेन के लिए अनुमति देने के लिए:

  1. अपने डोमेन के Admin console में, मुख्य मेन्यू > सुरक्षा > ऐक्सेस और डेटा कंट्रोल > एपीआई कंट्रोल पर जाएं.

  2. डोमेन के सभी उपयोगकर्ताओं के डेटा का ऐक्सेस पैनल में, डोमेन के सभी उपयोगकर्ताओं के डेटा का ऐक्सेस मैनेज करें चुनें.

  3. नया जोड़ें पर क्लिक करें.

  4. क्लाइंट आईडी फ़ील्ड में, ऊपर दिए गए सेवा खाता बनाने के तरीके से मिला क्लाइंट आईडी डालें.

  5. OAuth स्कोप फ़ील्ड में, अपने ऐप्लिकेशन के लिए ज़रूरी स्कोप की सूची डालें. सूची में, हर स्कोप को कॉमा लगाकर अलग करें. क्वेरी एपीआई का इस्तेमाल करने वाले खोज ऐप्लिकेशन के लिए, स्कोप https://www.googleapis.com/auth/cloud_search.query का इस्तेमाल करें.

  6. अनुमति दें पर क्लिक करें.

आपके सेवा खाते के पास अब डोमेन के लिए Cloud Search Query API का ऐक्सेस है. साथ ही, यह इस दायरे में आपके डोमेन के किसी भी उपयोगकर्ता के नाम पर काम कर सकता है. अब आपके पास अपने डोमेन के उपयोगकर्ताओं की ओर से, अनुमति वाले Cloud Search API सेवा ऑब्जेक्ट को इंस्टैंशिएट करने का विकल्प है.

Cloud Search API के सेवा ऑब्जेक्ट को इंस्टैंशिएट करना

इस सेक्शन में, Cloud Search API के सेवा ऑब्जेक्ट को इंस्टैंशिएट करने का तरीका बताया गया है. इसके बाद, Google Workspace के डोमेन-वाइड डिलीगेशन को पूरा करने के लिए, OAuth 2.0 और अपने सेवा खाते के क्रेडेंशियल का इस्तेमाल करके, एपीआई अनुरोध करने की अनुमति दी गई है. उदाहरणों में, JSON फ़ॉर्मैट में निजी कुंजी वाली फ़ाइल से, सेवा खाते की जानकारी पढ़ी जाती है.

Java

import java.util.Collections;
import java.io.FileInputStream;
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.services.cloudsearch.v1.CloudSearch;
import com.google.api.services.cloudsearch.v1.CloudSearchScopes;
...

/** Path to the Service Account's Private Key file */
private static final String SERVICE_ACCOUNT_FILE_PATH = "/path/to/key.json";

/**
 * Build and return a Cloud Search service object authorized with the service
 * account that acts on behalf of the given user.
 *
 * @param userEmail The email of the user to impersonate. Needs permissions to access Cloud Search.
 * @return CloudSearch service object that is ready to make requests.
 */
public static CloudSearch getCloudSearchAPIService(String userEmail)
    throws FileNotFoundException, IOException {

  FileInputStream credsFile = new FileInputStream(SERVICE_ACCOUNT_FILE_PATH);

  GoogleCredential init = GoogleCredential.fromStream(credsFile);

  HttpTransport httpTransport = init.getTransport();
  JsonFactory jsonFactory = init.getJsonFactory();

  GoogleCredential creds = new GoogleCredential.Builder()
      .setTransport(httpTransport)
      .setJsonFactory(jsonFactory)
      .setServiceAccountId(init.getServiceAccountId())
      .setServiceAccountPrivateKey(init.getServiceAccountPrivateKey())
      .setServiceAccountScopes(Collections.singleton(CloudSearchScopes.CLOUD_SEARCH_QUERY))
      .setServiceAccountUser(userEmail)
      .build();

  CloudSearch service = new CloudSearch.Builder(httpTransport, jsonFactory, creds).build();

  return service;
}

Python

from google.oauth2 import service_account
from googleapiclient.discovery import build

# Path to the Service Account's Private Key file
SERVICE_ACCOUNT_FILE_PATH = "/path/to/key.json"

def create_query_api_service(user_email):
    """Build and return a CloudSearch service object authorized with the service
    account that acts on behalf of the given user.

    Args:
        user_email: The email of the user to impersonate. Needs permissions to access Cloud Search.
    Returns:
        Cloud Search Query API service object that is ready to make requests.
    """
    credentials = service_account.Credentials.from_service_account_file(
        SERVICE_ACCOUNT_FILE_PATH,
        scopes=['https://www.googleapis.com/auth/cloud_search.query'])

    delegated_credentials = credentials.with_subject(user_email)

    return build("cloudsearch", "v1", credentials=delegated_credentials)