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 which supports OAuth2 access (such as a Google or a Facebook account).
Details of how the OAuth2 flow works differ from one service provider to another, so to use this API with a particular service provider, you'll need to 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 can then use this in HTTP 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.
There's some setup you must do before publishing your extension.
Getting the redirect URL
You can get a redirect URL by calling
identity.getRedirectURL(). This function derives a redirect URL from the add-on's ID, so if you want to use it, you should probably set your add-on's ID explicitly using the
applications key (otherwise, each time you temporarily install the add-on, you'll get a different redirect URL).
You don't have to use the redirect URL returned by
identity.getRedirectURL(): you can supply your own, and it can be anything that the service will redirect to. However, it should use a domain that you control.
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
Registering your extension
Before you can 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 will supply your redirect URL, and receive a client ID (and sometimes also a secret). You'll need to pass both of these into
|Chrome||Edge||Firefox||Opera||Firefox for Android|
|Chrome Full support Yes||Edge No support No||Firefox Full support 53||Opera No support No||Firefox Android No support No|
|Chrome Full support Yes||Edge No support No||Firefox Full support 53||Opera Full support Yes||Firefox Android No support No|
- Full support
- Full support
- No support
- No support
This API is based on Chromium's
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.