Google Workspace Admin

🚀 Quickstart
🧑‍💻 OAuth app setup
🔗 Useful links
🚨 API gotchas

Create an integration

In Nango (free signup), go to Integrations -> Configure New Integration -> Google Workspace Admin.

Authorize Google Workspace Admin

Go to Connections -> Add Test Connection -> Authorize, then log in to your Google Workspace accounts (with Admin privileges). Later, you’ll let your users do the same directly from your app.

Call the Google Workspace Admin API

Let’s make your first request to the Google Workspace Admin API (fetch a list of users in a specific domain). Replace the placeholders below with your secret key, integration ID, and connection ID:

cURL
Node

curl "https://api.nango.dev/proxy/admin/directory/v1/users?domain=${YourDomain}" \
  -H "Authorization: Bearer <NANGO-SECRET-KEY>" \
  -H "Provider-Config-Key: <INTEGRATION-ID>" \
  -H "Connection-Id: <CONNECTION-ID>"

Install Nango’s backend SDK with npm i @nangohq/node. Then run:

import { Nango } from '@nangohq/node';

const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });

const res = await nango.get({
    endpoint: '/admin/directory/v1/users',
    params: {
      'domain': ${YourDomain}
    },
    providerConfigKey: '<INTEGRATION-ID>',
    connectionId: '<CONNECTION-ID>'
});

console.log(JSON.stringify(res.data.users, null, 2));

Or fetch credentials dynamically via the Node SDK or API.

✅ You’re connected! Check the Logs tab in Nango to inspect requests.

Next step: Embed the auth flow in your app to let your users connect their Google Workspace accounts (with Admin privileges).

You will need to pass a security review to go live with your integration.Follow our guide to get approved as fast as possible.

Create your OAuth App

Create a Google Cloud account

If you don’t already have one, sign up for a Google Cloud account.

Create a new project

Go to the Google Cloud Console.
Click on the project dropdown at the top left of the page.
Click New Project.
Enter a Project Name for your project
Under Location, select the appropriate organization or folder where this project should belong.
If you’re not part of an organization, it will default to No organization
Click Create and wait for the project to be created.
Select it from the project dropdown.

Enable the APIs you need

Go to the API Library in the Google Cloud Console.
Search for Admin SDK API and select it, then click Enable.

Configure the OAuth consent screen

Go to APIs & Services > OAuth consent screen in the Google Cloud Console.
Click Get started.
Complete all required fields in the App Information form.
Click Next. Select the appropriate Audience:
- External: For applications available to any Google user
- Internal: For applications restricted to users within your Google Workspace organization
Click Next. Fill in the Contact Information, these are the email addresses that Google will use to notify you about any changes to your project.
Click Next, then check the I agree to the Google API Services: User Data Policy checkbox, and click Continue.
Add the scopes your application needs. Under Data Access, click Add or Remove Scopes and select the scopes that correspond to the APIs you enabled.
Under Audience, click Add users if you selected External user type (required for testing before verification).

Create OAuth 2.0 credentials

Go to APIs & Services > Credentials in the Google Cloud Console.
Click Create Credentials and select OAuth client ID.
Select Web application as the application type.
Enter a name for your OAuth client.
Under Authorized redirect URIs, add https://api.nango.dev/oauth/callback.
Click Create.
A dialog will appear with your client ID and client secret. Save these credentials securely as you’ll need them when configuring your integration in Nango.

Start building your integration

Follow the Quickstart to build your integration.

Verify your app

Most Google Workspace Admin scopes are classified as sensitive by Google. You can verify this by checking the Add or Remove Scopes section in the Configure the OAuth consent screen step.You can develop your integration in test mode, but you need to pass a security review to go live.Follow our guide to prepare and pass as quickly as possible.

Publish your app (switch from Testing to Production)

To move your OAuth app from testing to production:

Go to APIs & Services > OAuth consent screen > Audience.
Click Publish App to switch your app from testing to production.

Common Scopes

Scope	Description
`profile`	Access to user’s basic profile information
`email`	Access to user’s email address
`https://www.googleapis.com/auth/admin.directory.user`	View and manage users in your domain
`https://www.googleapis.com/auth/admin.directory.user.readonly`	View information about users in your domain (read-only)
`https://www.googleapis.com/auth/admin.directory.group`	View and manage groups in your domain
`https://www.googleapis.com/auth/admin.directory.orgunit`	View and manage organizational units in your domain
`https://www.googleapis.com/auth/admin.directory.customer`	View and manage customer-related information

Useful links

Topic	Links
General	Google Cloud Console
	Google Cloud Documentation
Developer	OAuth 2.0 Documentation
	Using OAuth 2.0 for Web Server Applications
	OAuth 2.0 Scopes for Google APIs
	API Library
	OAuth Consent Screen Configuration
	Credentials Management
	App Verification Requirements
	OAuth Token Expiration
	Google Workspace Admin API

Contribute API gotchas by editing this page

Questions? Join us in the Slack community.

Google Slides Google Service Account

⌘I

API Guides

APIs & Integrations

Google Workspace Admin

Create your OAuth App

Common Scopes

Useful links

API Guides

APIs & Integrations

​Create your OAuth App

​Common Scopes

​Useful links

Create your OAuth App

Common Scopes

Useful links