Gets an OAuth2 access token using the client ID and scopes specified in the oauth2 section of manifest.json.

The Identity API caches access tokens in memory, so it's ok to call getAuthToken any time a token is required. The token cache automatically handles expiration.

Parameters

details ( optional object )

Token options.

interactive ( optional boolean )

Fetching a token may require the user to sign-in to Chrome, or approve the application's requested scopes. If the interactive flag is true, getAuthToken will prompt the user as necessary. When the flag is false or ommitted, getAuthToken will return failure any time a prompt would be required.

callback ( function )

Called with an OAuth2 access token as specified by the manifest, or undefined if there was an error.

Callback

The callback parameter should specify a function that looks like this:

function(string token) {...};

token ( optional string )

Removes an OAuth2 access token from the Identity API's token cache.

If an access token is discovered to be invalid, it should be passed to removeCachedAuthToken to remove it from the cache. The app may then retrieve a fresh token with getAuthToken.

Parameters

details ( object )

Token information.

token ( string )

The specific token that should be removed from the cache.

callback ( function )

Called when the token has been removed from the cache.

Callback

The callback parameter should specify a function that looks like this:

function() {...};

Starts an auth flow at the specified URL.

This method enables auth flows with non-Google identity providers by launching a web view and navigating it to the first URL in the provider's auth flow. When the provider redirects to a URL matching the pattern https://<app-id>.chromiumapp.org/*, the window will close, and the final redirect URL will be passed to the callback function.

Parameters

details ( object )

WebAuth flow options.

url ( string )

The URL that initiates the auth flow.

interactive ( optional boolean )

Whether to launch auth flow in interactive mode.

Since some auth flows may immediately redirect to a result URL, launchWebAuthFlow hides its web view until the first navigation either redirects to the final URL, or finishes loading a page meant to be displayed.

If the interactive flag is true, the window will be displayed when a page load completes. If the flag is false or ommitted, launchWebAuthFlow will return with an error if the initial navigation does not complete the flow.

callback ( function )

Called with the URL redirected back to your application.

Callback

The callback parameter should specify a function that looks like this:

function(string responseUrl) {...};

responseUrl ( optional string )