Class AuthorizationInfo  |  Apps Script  |  Google for Developers (original) (raw)

Class AuthorizationInfo

Stay organized with collections Save and categorize content based on your preferences.

AuthorizationInfo

An object that checks if the user has granted authorization for the required scopes of the script. The object also provides an authorization URL for users to grant those permissions.

Some script executions can start without a user's consent to all required scopes used by the script. The information in this object lets you control access to sections of code that require certain scopes and request authorization of those scopes for subsequent executions.

This object is returned by [ScriptApp.getAuthorizationInfo(authMode)](/apps-script/reference/script/script-app#getAuthorizationInfo%28AuthMode%29). In almost all cases, scripts should call ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL), since no other authorization mode requires that users grant authorization.

Methods

Detailed documentation

Gets a value that indicates whether the user needs to authorize this script to use one or more services (for example, ScriptApp.AuthorizationStatus.REQUIRED).

// Log the authorization status (REQUIRED or NOT_REQUIRED). const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL); Logger.log(authInfo.getAuthorizationStatus());

Return

[AuthorizationStatus](/apps-script/reference/script/authorization-status) — the authorization status

getAuthorizationUrl()

Gets the authorization URL that can be used to grant access to the script. This method returnsnull if no authorization is required. The page at the URL will close automatically if it is accessed and the script does not require any authorization.

// Log the URL used to grant access to the script. const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL); Logger.log(authInfo.getAuthorizationUrl());

Return

String — a URL that can be used to authorize the script

getAuthorizedScopes()

Gets a list of authorized scopes for the script. If authorization information is requested for a specified list of scopes, returns the authorized scopes from the specified list.

// Logs which scopes in the specified list have been authorized for the script. const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL, [ 'https: //www.googleapis.com/auth/documents', 'https: //www.googleapis.com/auth/spreadsheets', ]); Logger.log(authInfo.getAuthorizedScopes());

Return

String[] — The list of authorized scopes.

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-01-08 UTC.