Method: projects.getAuthorization
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-22 UTC.
[null,null,["Last updated 2025-04-22 UTC."],[[["\u003cp\u003eRetrieves Google Workspace Add-on authorization details for a specific project.\u003c/p\u003e\n"],["\u003cp\u003eRequires project name as a path parameter and an empty request body.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes authorization name, service account email, and OAuth client ID.\u003c/p\u003e\n"],["\u003cp\u003eNeeds \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["This document details retrieving authorization information for Google Workspace add-on deployments within a project. It uses a `GET` HTTP request to a specific URL containing the project name. The request body must be empty. The response, formatted in JSON, includes the project's canonical name, service account email, and OAuth client ID. Authorization requires a `gsuiteaddons.authorizations.get` IAM permission and the `https://www.googleapis.com/auth/cloud-platform` OAuth scope.\n"],null,["# Method: projects.getAuthorization\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.Authorization.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGets the authorization information for deployments in a given project.\n\n### HTTP request\n\n`GET https://gsuiteaddons.googleapis.com/v1/{name=projects/*/authorization}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `gsuiteaddons.authorizations.get` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe authorization information used when invoking deployment endpoints.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"serviceAccountEmail\": string, \"oauthClientId\": string } ``` |\n\n| Fields ||\n|-----------------------|---------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The canonical full name of this resource. Example: `projects/123/authorization` |\n| `serviceAccountEmail` | `string` The email address of the service account used to authenticate requests to add-on callback endpoints. |\n| `oauthClientId` | `string` The OAuth client ID used to obtain OAuth access tokens for a user on the add-on's behalf. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
