Control API access with domain-wide delegation (2025)

Domain-wide delegationis a powerful feature that lets you grant client applications permission to access your Workspace users' data without requiring their consent.You can use domain-wide delegation in two ways:

  1. Authorize a service account to access data on behalf of a user. Aservice accountmight use the following types of apps:
    • Migration and sync tools that duplicate user content from another service to Google Workspace.

    • Internal apps (for example, automation apps) that developers create for your organization. For example, you can delegate access to an application that uses the Calendar API to add events to your users' calendars.

  2. Allow users to use OAuth client apps without seeing a consent screen. Users can access apps without being prompted for consent, and you can specify the user data that the apps can access.

You can also manage domain-wide installation and view API scopes for Google WorkspaceMarketplace apps. Learn about Marketplace apps data access and installation.

Open all | Close all

Before you begin

  • Ensure you have super admin privileges for your Google Workspace account.
  • Review the domain-wide delegation best practicesand best practices for using service accounts.
  • Verify the list of API scopes needed by the app or service account. Check that the app or service account has an appropriately small scope of access.
  • (If delegating an OAuth app) Get the OAuth client ID from the app developer.
  • (If delegating a service account) Get the client ID of the service account. If you’re the owner of the service account, you can find the ID as follows:
    1. Sign in to Google Cloud as a super administrator.
    2. Click IAM & AdminControl API access with domain-wide delegation (1)Service accountsControl API access with domain-wide delegation (2)[name of your service account].
    3. Expand Advanced settings and copy the Client ID.
  • With domain-wide delegation, the app has access to the data belonging to all of yourusers. We recommend setting up a regular review of service accounts and deleting any accounts no longer in use.

Set up domain-wide delegation for a client

  1. Sign in with a superadministrator account to the GoogleAdminconsole.

    If you aren’t using a super administrator account, you can’t complete these steps.

  2. Go to MenuControl API access with domain-wide delegation (3)Control API access with domain-wide delegation (4)Control API access with domain-wide delegation (5)Security > Access and data control > API controls > Manage Domain Wide Delegation.

    You must be signed in as asuper administratorfor this task.

  3. Click Add new.

  4. Enter the Client ID for either the service account or the OAuth2 client.

  5. InOAuth Scopes, add each scope that the application can access (should be appropriately narrow). You can use any of the OAuth 2.0 Scopes for Google APIs. For example, if the application needs domain-wide access to the Google Drive API and the Google Calendar API, enter https://www.googleapis.com/auth/drive and https://www.googleapis.com/auth/calendar.
  6. Click Authorize. If you get an error, the client ID might not be registered with Google or there might be duplicate or unsupported scopes.

    Note: If Multi-party approval is enabled for your organization, authorizing domain-wide delegation for a client app requires approval from another super admin.

  7. Point to the new client ID, click View details, and make sure that every scope is listed.

    If a scope is not listed, click Edit, enter the missing scope, and click Authorize. You can't edit the client ID.

Changes can take up to 24 hours but typically happen more quickly.Learn more

View, edit, or delete clients and scopes

As a best practice, periodically check your app's scopes and remove scopes that aren't required or actively used. Also, delete clients you no longer need. For example, remove access for a migration toolafter you complete your migration.

  1. Sign in with a superadministrator account to the GoogleAdminconsole.

    If you aren’t using a super administrator account, you can’t complete these steps.

  2. Go to MenuControl API access with domain-wide delegation (6)Control API access with domain-wide delegation (7)Control API access with domain-wide delegation (8)Security > Access and data control > API controls > Manage Domain Wide Delegation.

    You must be signed in as asuper administratorfor this task.

  3. Click a client name and then choose an option:

  • View details—View the full client name and list of scopes
  • Edit—Add or remove scopes. You can't edit the client ID.Changes can take up to 24 hours but typically happen more quickly.Learn more
  • Delete—Applications that depend on the client authorization will immediately stop working.

    Note: If Multi-party approval is enabled for your organization, editing scopes or deleting domain-wide delegation for a client app requires approval from another super admin.

Was this helpful?

How can we improve it?

Need more help?

Try these next steps:

Post to the help community Get answers from community members Contact us Tell us more and we’ll help you get there

Start your free 14-day trial today

Professional email, online storage, shared calendars, video meetings and more. Start your free Google Workspace trial today.

Control API access with domain-wide delegation (2025)
Top Articles
Latest Posts
Recommended Articles
Article information

Author: Kimberely Baumbach CPA

Last Updated:

Views: 6322

Rating: 4 / 5 (41 voted)

Reviews: 80% of readers found this page helpful

Author information

Name: Kimberely Baumbach CPA

Birthday: 1996-01-14

Address: 8381 Boyce Course, Imeldachester, ND 74681

Phone: +3571286597580

Job: Product Banking Analyst

Hobby: Cosplaying, Inline skating, Amateur radio, Baton twirling, Mountaineering, Flying, Archery

Introduction: My name is Kimberely Baumbach CPA, I am a gorgeous, bright, charming, encouraging, zealous, lively, good person who loves writing and wants to share my knowledge and understanding with you.