संग्रह की मदद से व्यवस्थित रहें
अपनी प्राथमिकताओं के आधार पर, कॉन्टेंट को सेव करें और कैटगरी में बांटें.
एक Node.js कमांड-लाइन ऐप्लिकेशन बनाएं, जो Directory API को अनुरोध करता हो.
क्विकस्टार्ट में, Google Workspace API को कॉल करने वाले ऐप्लिकेशन को सेट अप और चलाने का तरीका बताया गया है. इस क्विकस्टार्ट में, पुष्टि करने का आसान तरीका इस्तेमाल किया गया है. यह टेस्टिंग एनवायरमेंट के लिए सही है. हमारा सुझाव है कि प्रोडक्शन एनवायरमेंट के लिए, ऐक्सेस क्रेडेंशियल चुनने से पहले, पुष्टि करने और अनुमति देने के बारे में जान लें. इससे आपको अपने ऐप्लिकेशन के लिए सही क्रेडेंशियल चुनने में मदद मिलेगी.
इस क्विकस्टार्ट में, Google Workspace की सुझाई गई एपीआई क्लाइंट लाइब्रेरी का इस्तेमाल किया जाता है. इससे पुष्टि करने और अनुमति देने की प्रोसेस की कुछ जानकारी को मैनेज किया जा सकता है.
मकसद
अपना एनवायरमेंट सेट अप करें.
क्लाइंट लाइब्रेरी इंस्टॉल करें.
सैंपल सेट अप करें.
सैंपल चलाएं.
ज़रूरी शर्तें
इस क्विकस्टार्ट को चलाने के लिए, आपको ये ज़रूरी शर्तें पूरी करनी होंगी:
इस क्विकस्टार्ट को पूरा करने के लिए, अपना एनवायरमेंट सेट अप करें.
एपीआई चालू करना
Google API का इस्तेमाल करने से पहले, आपको उन्हें Google Cloud प्रोजेक्ट में चालू करना होगा.
एक ही Google Cloud प्रोजेक्ट में, एक या उससे ज़्यादा एपीआई चालू किए जा सकते हैं.
Google Cloud Console में, डायरेक्ट्री एपीआई चालू करें.
उस स्क्रीन को कॉन्फ़िगर करना जहां OAuth के लिए सहमति दी जाती है
अगर आपको इस क्विकस्टार्ट को पूरा करने के लिए, नए Google Cloud प्रोजेक्ट का इस्तेमाल करना है, तो उस स्क्रीन को कॉन्फ़िगर करें जहां OAuth को सहमति दी जाती है. अगर आपने अपने Cloud प्रोजेक्ट के लिए यह चरण पहले ही पूरा कर लिया है, तो अगले सेक्शन पर जाएं.
Google Cloud Console में, मेन्यू menu>Google Auth platform>ब्रैंडिंग पर जाएं.
अगर आपने पहले ही Google Auth platformको कॉन्फ़िगर कर लिया है, तो ब्रैंडिंग, दर्शक, और डेटा ऐक्सेस में जाकर, OAuth सहमति स्क्रीन की इन सेटिंग को कॉन्फ़िगर किया जा सकता है. अगर आपको Google Auth platform अभी तक कॉन्फ़िगर नहीं किया गया है मैसेज दिखता है, तो शुरू करें पर क्लिक करें:
ऐप्लिकेशन की जानकारी में जाकर, ऐप्लिकेशन का नाम में ऐप्लिकेशन का नाम डालें.
उपयोगकर्ता सहायता के लिए ईमेल पता में, सहायता के लिए वह ईमेल पता चुनें जिस पर उपयोगकर्ता, सहमति से जुड़े सवालों के लिए आपसे संपर्क कर सकें.
आगे बढ़ें पर क्लिक करें.
दर्शक सेक्शन में जाकर, संगठन के अंदर से जनरेट होने वाला ट्रैफ़िक चुनें.
आगे बढ़ें पर क्लिक करें.
संपर्क जानकारी में जाकर, वह ईमेल पता डालें जिस पर आपको अपने प्रोजेक्ट में हुए किसी भी बदलाव की सूचना मिल सके.
फ़िलहाल, स्कोप जोड़ने की प्रोसेस को स्किप किया जा सकता है.
अगर आपको आने वाले समय में, अपने Google Workspace संगठन के बाहर इस्तेमाल करने के लिए कोई ऐप्लिकेशन बनाना है, तो आपको उपयोगकर्ता का टाइप बदलकर बाहरी करना होगा. इसके बाद, अपने ऐप्लिकेशन के लिए ज़रूरी अनुमति के स्कोप जोड़ें. ज़्यादा जानने के लिए, OAuth की सहमति कॉन्फ़िगर करना गाइड पढ़ें.
डेस्कटॉप ऐप्लिकेशन के लिए क्रेडेंशियल को अनुमति देना
असली उपयोगकर्ताओं की पुष्टि करने और अपने ऐप्लिकेशन में उपयोगकर्ता का डेटा ऐक्सेस करने के लिए, आपको एक या उससे ज़्यादा OAuth 2.0 क्लाइंट आईडी बनाने होंगे. क्लाइंट आईडी का इस्तेमाल, Google के OAuth सर्वर पर किसी एक ऐप्लिकेशन की पहचान करने के लिए किया जाता है. अगर आपका ऐप्लिकेशन कई प्लैटफ़ॉर्म पर चलता है, तो आपको हर प्लैटफ़ॉर्म के लिए अलग क्लाइंट आईडी बनाना होगा.
Google Cloud console में, मेन्यू menu>Google Auth platform>क्लाइंट पर जाएं.
constfs=require('fs').promises;constpath=require('path');constprocess=require('process');const{authenticate}=require('@google-cloud/local-auth');const{google}=require('googleapis');// If modifying these scopes, delete token.json.constSCOPES=['https://www.googleapis.com/auth/admin.directory.user'];// The file token.json stores the user's access and refresh tokens, and is// created automatically when the authorization flow completes for the first// time.constTOKEN_PATH=path.join(process.cwd(),'token.json');constCREDENTIALS_PATH=path.join(process.cwd(),'credentials.json');/** * Reads previously authorized credentials from the save file. * * @return {Promise<OAuth2Client|null>} */asyncfunctionloadSavedCredentialsIfExist(){try{constcontent=awaitfs.readFile(TOKEN_PATH);constcredentials=JSON.parse(content);returngoogle.auth.fromJSON(credentials);}catch(err){returnnull;}}/** * Serializes credentials to a file compatible with GoogleAuth.fromJSON. * * @param {OAuth2Client} client * @return {Promise<void>} */asyncfunctionsaveCredentials(client){constcontent=awaitfs.readFile(CREDENTIALS_PATH);constkeys=JSON.parse(content);constkey=keys.installed||keys.web;constpayload=JSON.stringify({type:'authorized_user',client_id:key.client_id,client_secret:key.client_secret,refresh_token:client.credentials.refresh_token,});awaitfs.writeFile(TOKEN_PATH,payload);}/** * Load or request or authorization to call APIs. * */asyncfunctionauthorize(){letclient=awaitloadSavedCredentialsIfExist();if(client){returnclient;}client=awaitauthenticate({scopes:SCOPES,keyfilePath:CREDENTIALS_PATH,});if(client.credentials){awaitsaveCredentials(client);}returnclient;}/** * Lists the first 10 users in the domain. * * @param {google.auth.OAuth2} auth An authorized OAuth2 client. */asyncfunctionlistUsers(auth){constservice=google.admin({version:'directory_v1',auth});constres=awaitservice.users.list({customer:'my_customer',maxResults:10,orderBy:'email',});constusers=res.data.users;if(!users||users.length===0){console.log('No users found.');return;}console.log('Users:');users.forEach((user)=>{console.log(`${user.primaryEmail} (${user.name.fullName})`);});}authorize().then(listUsers).catch(console.error);
सैंपल चलाना
अपनी वर्किंग डायरेक्ट्री में, सैंपल चलाएं:
node .
पहली बार सैंपल चलाने पर, आपको ऐक्सेस की अनुमति देने के लिए कहा जाएगा:
अगर आपने Google खाते में पहले से साइन इन नहीं किया है, तो मांगे जाने पर साइन इन करें. अगर आपने एक से ज़्यादा खातों में साइन इन किया हुआ है, तो पुष्टि के लिए किसी एक खाते को चुनें.
स्वीकार करें पर क्लिक करें.
आपका Nodejs ऐप्लिकेशन चलता है और Directory API को कॉल करता है.
अनुमति से जुड़ी जानकारी, फ़ाइल सिस्टम में सेव की जाती है. इसलिए, अगली बार सैंपल कोड चलाने पर, आपसे अनुमति नहीं मांगी जाती.
[null,null,["आखिरी बार 2025-08-28 (UTC) को अपडेट किया गया."],[],[],null,["Create a Node.js command-line application that makes requests to the\nDirectory API.\n\nQuickstarts explain how to set up and run an app that calls a\nGoogle Workspace API. This quickstart uses a\nsimplified authentication approach that is appropriate for a testing\nenvironment. For a production environment, we recommend learning about\n[authentication and authorization](/workspace/guides/auth-overview)\nbefore\n[choosing the access credentials](/workspace/guides/create-credentials#choose_the_access_credential_that_is_right_for_you)\nthat are appropriate for your app.\n\nThis quickstart uses Google Workspace's recommended API client libraries\nto handle some details of the authentication and authorization flow.\n\nObjectives\n\n- Set up your environment.\n- Install the client library.\n- Set up the sample.\n- Run the sample.\n\nPrerequisites\n\nTo run this quickstart, you need the following prerequisites:\n\n- [Node.js \\& npm](https://docs.npmjs.com/getting-started/installing-node#1-install-nodejs--npm) installed.\n- [A Google Cloud project](/workspace/guides/create-project).\n\n\n- A Google Workspace domain with [API access enabled](https://support.google.com/a/answer/60757).\n- A Google Account in that domain with administrator privileges.\n\n\u003cbr /\u003e\n\nSet up your environment\n\nTo complete this quickstart, set up your environment.\n\nEnable the API Before using Google APIs, you need to turn them on in a Google Cloud project. You can turn on one or more APIs in a single Google Cloud project.\n\n- In the Google Cloud console, enable the Directory API.\n\n [Enable the API](https://console.cloud.google.com/flows/enableapi?apiid=admin.googleapis.com)\n\nConfigure the OAuth consent screen\n\nIf you're using a new Google Cloud project to complete this quickstart, configure\nthe OAuth consent screen. If you've already\ncompleted this step for your Cloud project, skip to the next section.\n\n1. In the Google Cloud console, go to Menu menu \\\u003e **Google Auth platform** \\\u003e **Branding** .\n\n [Go to Branding](https://console.cloud.google.com/auth/branding)\n2. If you have already configured the Google Auth platform, you can configure the following OAuth Consent Screen settings in [Branding](https://console.cloud.google.com/auth/branding), [Audience](https://console.cloud.google.com/auth/audience), and [Data Access](https://console.cloud.google.com/auth/scopes). If you see a message that says **Google Auth platform not configured yet** , click **Get Started**:\n 1. Under **App Information** , in **App name**, enter a name for the app.\n 2. In **User support email**, choose a support email address where users can contact you if they have questions about their consent.\n 3. Click **Next**.\n 4. Under **Audience** , select **Internal**.\n 5. Click **Next**.\n 6. Under **Contact Information** , enter an **Email address** where you can be notified about any changes to your project.\n 7. Click **Next**.\n 8. Under **Finish** , review the [Google API Services User Data Policy](https://developers.google.com/terms/api-services-user-data-policy) and if you agree, select **I agree to the Google API Services: User Data Policy**.\n 9. Click **Continue**.\n 10. Click **Create**.\n3. For now, you can skip adding scopes. In the future, when you create an app for use outside of your Google Workspace organization, you must change the **User type** to **External** . Then add the authorization scopes that your app requires. To learn more, see the full [Configure OAuth consent](/workspace/guides/configure-oauth-consent) guide.\n\nAuthorize credentials for a desktop application To authenticate end users and access user data in your app, you need to create one or more OAuth 2.0 Client IDs. A client ID is used to identify a single app to Google's OAuth servers. If your app runs on multiple platforms, you must create a separate client ID for each platform. **Caution:** This quickstart must be run locally and with access to a browser. It doesn't work if run on a remote terminal such as Cloud Shell or over SSH.\n\n1. In the Google Cloud console, go to Menu menu \\\u003e **Google Auth platform** \\\u003e **Clients** .\n\n [Go to Clients](https://console.cloud.google.com/auth/clients)\n2. Click **Create Client**.\n3. Click **Application type** \\\u003e **Desktop app**.\n4. In the **Name** field, type a name for the credential. This name is only shown in the Google Cloud console.\n5. Click **Create** .\n\n\n The newly created credential appears under \"OAuth 2.0 Client IDs.\"\n6. Save the downloaded JSON file as `credentials.json`, and move the file to your working directory.\n\nInstall the client library\n\n- Install the libraries using npm:\n\n ```\n npm install googleapis@105 @google-cloud/local-auth@2.1.0 --save\n ```\n\nSet up the sample\n\n1. In your working directory, create a file named `index.js`.\n\n2. In the file, paste the following code:\n\n\n adminSDK/directory/index.js \n [View on GitHub](https://github.com/googleworkspace/node-samples/blob/main/adminSDK/directory/index.js) \n\n ```javascript\n const fs = require('fs').promises;\n const path = require('path');\n const process = require('process');\n const {authenticate} = require('@google-cloud/local-auth');\n const {google} = require('googleapis');\n\n // If modifying these scopes, delete token.json.\n const SCOPES = ['https://www.googleapis.com/auth/admin.directory.user'];\n // The file token.json stores the user's access and refresh tokens, and is\n // created automatically when the authorization flow completes for the first\n // time.\n const TOKEN_PATH = path.join(process.cwd(), 'token.json');\n const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');\n\n /**\n * Reads previously authorized credentials from the save file.\n *\n * @return {Promise\u003cOAuth2Client|null\u003e}\n */\n async function loadSavedCredentialsIfExist() {\n try {\n const content = await fs.readFile(TOKEN_PATH);\n const credentials = JSON.parse(content);\n return google.auth.fromJSON(credentials);\n } catch (err) {\n return null;\n }\n }\n\n /**\n * Serializes credentials to a file compatible with GoogleAuth.fromJSON.\n *\n * @param {OAuth2Client} client\n * @return {Promise\u003cvoid\u003e}\n */\n async function saveCredentials(client) {\n const content = await fs.readFile(CREDENTIALS_PATH);\n const keys = JSON.parse(content);\n const key = keys.installed || keys.web;\n const payload = JSON.stringify({\n type: 'authorized_user',\n client_id: key.client_id,\n client_secret: key.client_secret,\n refresh_token: client.credentials.refresh_token,\n });\n await fs.writeFile(TOKEN_PATH, payload);\n }\n\n /**\n * Load or request or authorization to call APIs.\n *\n */\n async function authorize() {\n let client = await loadSavedCredentialsIfExist();\n if (client) {\n return client;\n }\n client = await authenticate({\n scopes: SCOPES,\n keyfilePath: CREDENTIALS_PATH,\n });\n if (client.credentials) {\n await saveCredentials(client);\n }\n return client;\n }\n\n /**\n * Lists the first 10 users in the domain.\n *\n * @param {google.auth.OAuth2} auth An authorized OAuth2 client.\n */\n async function listUsers(auth) {\n const service = google.admin({version: 'directory_v1', auth});\n const res = await service.users.list({\n customer: 'my_customer',\n maxResults: 10,\n orderBy: 'email',\n });\n\n const users = res.data.users;\n if (!users || users.length === 0) {\n console.log('No users found.');\n return;\n }\n\n console.log('Users:');\n users.forEach((user) =\u003e {\n console.log(`${user.primaryEmail} (${user.name.fullName})`);\n });\n }\n\n authorize().then(listUsers).catch(console.error);\n ```\n\n \u003cbr /\u003e\n\n \u003cbr /\u003e\n\nRun the sample\n\n1. In your working directory, run the sample:\n\n ```\n node .\n ```\n\n\u003c!-- --\u003e\n\n2. The first time you run the sample, it prompts you to authorize access:\n 1. If you're not already signed in to your Google Account, sign in when prompted. If you're signed in to multiple accounts, select one account to use for authorization.\n 2. Click **Accept**.\n\n\n Your Nodejs application runs and calls the Directory API.\n\n\n Authorization information is stored in the file system, so the next time you run the sample\n code, you aren't prompted for authorization.\n\nNext steps\n\n- [Try the Google Workspace APIs in the APIs explorer](/workspace/explore)\n - [Troubleshoot authentication and authorization issues](/workspace/admin/directory/v1/guides/troubleshoot-authentication-authorization)\n - [Directory API developer guides](/workspace/admin/directory/v1/guides)\n - [Directory API reference documentation](/workspace/admin/directory/v1/reference)\n- [`google-api-nodejs-client` section of GitHub](https://github.com/google/google-api-nodejs-client/#google-apis-nodejs-client)"]]
