Choose Google Workspace Events API scopes

This document contains Google Workspace Events API-specific authorization and authentication information. Before reading this document, be sure to read the Google Workspace's general authentication and authorization information at Learn about authentication and authorization .

Configure OAuth 2.0 for authorization

Configure the OAuth consent screen and choose scopes to define what information is displayed to users and app reviewers, and register your app so that you can publish it later.

Google Workspace Events API scopes

To define the level of access granted to your app, you need to identify and declare authorization scopes . An authorization scope is an OAuth 2.0 URI string that contains the Google Workspace app name, what kind of data it accesses, and the level of access. Scopes are your app's requests to work with Google Workspace data, including users' Google Account data.

When your app is installed, a user is asked to validate the scopes used by the app. Generally, you should choose the most narrowly focused scope possible and avoid requesting scopes that your app doesn't require. Users more readily grant access to limited, clearly described scopes.

When possible, we recommend using non-sensitive scopes as it grants per-file access scope and narrows access to specific functionality needed by an app.

The Google Workspace Events API uses scopes from Google Workspace applications that support subscriptions. If your app already uses the scopes that are required for your subscription, you don't need to add additional scopes to use the Google Workspace Events API.

The following table displays the supported scopes for the Google Workspace Events API:

The Usage column in the preceding table indicates the sensitivity of each scope, according to the following definitions:

• Non-sensitive: These scopes provide the smallest scope of authorization access and only requires basic app verification. For information on this requirement, see Verification requirements .

• Sensitive: These scopes provide access to specific Google User Data that's authorized by the user for your app. It requires you to go through additional app verification. For information on this requirement, see Sensitive and Restricted Scope Requirements .

• Restricted: These scopes provide wide access to Google User Data and require you to go through a restricted scope verification process. For information on this requirement, see Google API Services: User Data Policy and Additional Requirements for Specific API Scopes . If you store restricted scope data on servers (or transmit), then you must go through a security assessment.

If your app requires access to any other Google APIs, you can add those scopes as well. For more information about Google API scopes, see Using OAuth 2.0 to Access Google APIs .

For more information about specific OAuth 2.0 scopes, see OAuth 2.0 Scopes for Google APIs .

OAuth verification

Using certain OAuth scopes might require that your app proceed through OAuth App Verification Help Center . Read the OAuth app FAQs to determine when your app should go through verification and what type of verification is required. See also the Google Drive Terms of Service .

Types of required authentication

This section explains which types of authentication are required or supported, and provides the supported scopes for each method of the Google Workspace Events API.

For subscriptions to Google Chat events, the Google Workspace Events API supports both user and app authentication to call some of its methods. If an API method supports both credentials, the type of credential used in the call affects the result that's returned. For example, if you call the subscriptions.list method with user authentication, the API returns a list of subscriptions that the authenticated user can access. If you use app authentication, the API returns a list of subscriptions that the app can access. To learn more about the types of Chat authentication, see Authenticate and authorize Chat apps and Google Chat API requests .

The following table displays which scopes and types of authentication are required or supported for each Google Workspace Events API method:

Scopes by event type

When you call the Google Workspace Events API using user authentication, you must specify one or more scopes that correspond to the event types of the subscription.

The following table displays which authorization scopes are supported for each event type:

Related topics

• Authentication overview for Google Chat
• Authentication overview for Google Drive
• Authentication overview for Google Meet