Class AuthorizationInfo
Stay organized with collections
Save and categorize content based on your preferences.
AI-generated Key Takeaways
-
AuthorizationInfo checks if a user has granted authorization for required script scopes and provides an authorization URL to grant those permissions.
-
The AuthorizationInfo object allows you to control access to code sections requiring certain scopes and request authorization for subsequent executions.
-
AuthorizationInfo is returned by
ScriptApp.getAuthorizationInfo(authMode), withScriptApp.AuthMode.FULLbeing the generally recommended authorization mode. -
Key methods of AuthorizationInfo include
getAuthorizationStatus(),getAuthorizationUrl(), andgetAuthorizedScopes().
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 Script. In almost
all cases, scripts should call Script,
since no other authorization mode requires that users grant authorization.
Methods
| Method | Return type | Brief description |
|---|---|---|
get | Authorization | Gets a value that indicates whether the user needs to authorize this script to use one or more
services (for example, Script). |
get | String | Gets the authorization URL that can be used to grant access to the script. |
get | String[] | Gets a list of authorized scopes for the script. |
Detailed documentation
getAuthorizationStatus()
Gets a value that indicates whether the user needs to authorize this script to use one or more
services (for example, Script).
// Log the authorization status (REQUIRED or NOT_REQUIRED). constauthInfo=ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL); Logger.log(authInfo.getAuthorizationStatus());
Return
Authorization — the authorization status
getAuthorizationUrl()
Gets the authorization URL that can be used to grant access to the script. This method returns
null 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. constauthInfo=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. constauthInfo=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.