identity

Use the identity API to get an OAuth2 authorization code or access token, which an extension can then use to access user data from a service that supports OAuth2 access (such as Google or Facebook).

OAuth2 flows vary between service provider so, to use this API with a particular service provider, consult their documentation. For example:

The identity API provides the identity.launchWebAuthFlow() function. This authenticates the user with the service, if necessary, and asks the user to authorize the extension to access data, if necessary. The function completes with an access token or authorization code, depending on the provider.

The extension then completes the OAuth2 flow to get a validated access token, and uses the token in HTTPS requests to access the user's data according to the authorization the user gave.

To use this API, you must have the "identity" API permission.

Setup

There's some setup you must do before publishing your extension.

Getting the redirect URL

The redirect URL represents the end point of identity.launchWebAuthFlow(), in which the access token or authorization code is delivered to the extension.

You get the redirect URL by calling identity.getRedirectURL(). This function derives a redirect URL from the add-on's ID.  To simplify testing, set your add-on's ID explicitly using the browser_specific_settings key (otherwise, each time you temporarily install the add-on, you get a different redirect URL).

Starting with Firefox 75, you must use the redirect URL returned by identity.getRedirectURL().  Earlier versions allowed you to supply any redirect url.

You'll use the redirect URL in two places:

  • supply it when registering your extension as an OAuth2 client.
  • pass it into identity.launchWebAuthFlow(), as a URL parameter added to that function's url argument.

Registering your extension

Before you use OAuth2 with a service provider, you must register the extension with the provider as an OAuth2 client.

This will tend to be specific to the service provider, but in general it means creating an entry for your extension on the provider's website. In this process you supply your redirect URL, and receive a client ID (and sometimes also a secret). You need to pass both of these into identity.launchWebAuthFlow().

Functions

identity.getRedirectURL()
Gets the redirect URL.
identity.launchWebAuthFlow()
Launches WAF.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaSafariFirefox for Android
getRedirectURLChrome Full support YesEdge Full support 79Firefox Full support 53Opera Full support 60Safari No support NoFirefox Android No support No
launchWebAuthFlowChrome Full support YesEdge Full support 79Firefox Full support 53
Full support 53
No support 53 — 63
Notes
Notes The redirect_uri URL parameter is required.
Opera Full support YesSafari No support NoFirefox Android No support No

Legend

Full support  
Full support
No support  
No support
See implementation notes.
See implementation notes.

Example extensions

Acknowledgements

This API is based on Chromium's chrome.identity API.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.