Method: projects.getAuthorization

  • Retrieves Google Workspace Add-on authorization details for a specific project.

  • Requires project name as a path parameter and an empty request body.

  • Response includes authorization name, service account email, and OAuth client ID.

  • Needs https://www.googleapis.com/auth/cloud-platform OAuth scope for authorization.

Gets the authorization information for deployments in a given project.

HTTP request

GET https://gsuiteaddons.googleapis.com/v1/{name=projects/*/authorization}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the project for which to get the Google Workspace add-on authorization information.

Example: projects/my_project/authorization.

Authorization requires the following IAM permission on the specified resource name:

  • gsuiteaddons.authorizations.get

Request body

The request body must be empty.

Response body

The authorization information used when invoking deployment endpoints.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "name": string,
  "serviceAccountEmail": string,
  "oauthClientId": string
}
Fields
name

string

The canonical full name of this resource. Example: projects/123/authorization
serviceAccountEmail

string

The email address of the service account used to authenticate requests to add-on callback endpoints.
oauthClientId

string

The OAuth client ID used to obtain OAuth access tokens for a user on the add-on's behalf.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authorization guide.