Complete the steps described in the rest of this page to create a simple Node.js command-line application that makes requests to the Directory API.
Prerequisites
To run this quickstart, you need the following prerequisites:
- Node.js & npm installed.
- A Google Workspace domain with API access enabled
- A Google account in that domain with administrator privileges
Step 1: Turn on the Directory API
Click this button to create a new Cloud Platform project and automatically enable the Directory API:
In resulting dialog click DOWNLOAD CLIENT CONFIGURATION and save the filecredentials.json
to your working directory.
Step 2: Install the client library
Run the following commands to install the libraries using npm:
npm install googleapis@39 --save
Step 3: Set up the sample
Create a file named index.js
in your working directory and copy in
the following code:
Step 4: Run the sample
Run the sample using the following command:
node .
The first time you run the sample, it will prompt you to authorize access:
Browse to the provided URL in your web browser.
If you are not already logged into your Google account, you will be prompted to log in. If you are logged into multiple Google accounts, you will be asked to select one account to use for the authorization.
If you don't have a browser on the machine running the code, and you've selected "Desktop app" when creating the OAuth client, you can browse to the URL provided on another machine, and then copy the authorization code back to the running sample.
- Click the Accept button.
- Copy the code you're given, paste it into the command-line prompt, and press Enter.
Notes
- Authorization information is stored on the file system, so subsequent executions will not prompt for authorization.
- The authorization flow in this example is designed for a command line application. For information on how to perform authorization in other contexts, see the Authorizing and Authenticating. section of the library's README.
Further reading
- Google APIs Client for Node.js documentation
- Admin SDK Directory API developer guides
- Admin SDK Directory API reference documentation
Troubleshooting
This section describes some common issues that you may encounter while attempting to run this quickstart and suggests possible solutions.
This app isn't verified.
The OAuth consent screen that is presented to the user may show the warning "This app isn't verified" if it is requesting scopes that provide access to sensitive user data. These applications must eventually go through the verification process to remove that warning and other limitations. During the development phase you can continue past this warning by clicking Advanced > Go to {Project Name} (unsafe).