Adding an Application to Domain-Wide Delegation
Adding an Application to Domain-Wide Delegation
This guide provides step-by-step instructions for adding an application to domain-wide delegation in Google Admin. These steps are essential for enabling our application to pull OAuth token reports and revoke staff token sessions across your organization.
Prerequisites
Before you begin, ensure you have:
- Administrator access to your Google Workspace Admin Console
- The Client ID of the service account provided by our application
- A list of required OAuth scopes for the application
Understanding the Process
Adding an application to domain-wide delegation involves:
- Creating a service account (already done by our application)
- Configuring domain-wide delegation in Google Admin Console
- Granting specific OAuth scopes to the service account
Step-by-Step Instructions
1. Access the Google Workspace Admin Console
- Navigate to admin.google.com
- Sign in with your administrator account
2. Navigate to Security Settings
- From the Admin Console dashboard, click on Security
- In the Security menu, select API controls
3. Configure Domain-Wide Delegation
- In the API Controls section, locate Domain-wide Delegation
- Click on Manage Domain Wide Delegation
- Click the Add new button
4. Enter Application Details
- In the Client ID field, enter the service account’s Client ID provided by our application
- This is a long numeric string that identifies our service account
- In the OAuth Scopes field, enter the following scopes (separated by commas):
https://www.googleapis.com/auth/admin.reports.audit.readonly,https://www.googleapis.com/auth/admin.reports.usage.readonly,https://www.googleapis.com/auth/admin.directory.user.readonly,https://www.googleapis.com/auth/admin.directory.user.security
- Click Authorize
Understanding the Required Scopes
The OAuth scopes requested provide specific permissions:
admin.reports.audit.readonly
: Allows reading audit reports, including OAuth token activitiesadmin.reports.usage.readonly
: Enables access to usage reports across your domainadmin.directory.user.readonly
: Provides read-only access to user informationadmin.directory.user.security
: Allows management of user security settings, including token revocation
Verification
To verify that domain-wide delegation has been properly configured:
- Return to the Domain-wide Delegation page
- Confirm that our application appears in the list with the correct Client ID
- Verify that all required scopes are listed
Security Considerations
Do not grant more scopes than these, as these are the only scopes that Inocula currently requires.
Troubleshooting
If you encounter issues during setup:
- Verify that the Client ID is entered correctly
- Ensure all scopes are properly formatted and separated by commas
- Check that your administrator account has sufficient privileges
- Confirm that API access is enabled in your Google Workspace settings
Next Steps
After configuring domain-wide delegation:
- Our application will automatically detect the new permissions
- OAuth token reports will begin populating in your dashboard
- The ability to revoke staff token sessions will become available
For more information about domain-wide delegation and its implications, see our guide on Domain-Wide Delegation in Google Admin.