identity

identity API を使って OAuth2 の認証コードやアクセストークンを取得し、拡張機能が OAuth2 での認証 (Google や Facebook アカウントなど) をサポートするサービスからユーザーデータを取得できるようにします。

OAuth2 フローがどのように機能するかの詳細は、サービスプロバイダーごとに異なるため、特定のサービスプロバイダーにおいてこの API を使用するには、各サービスごとのドキュメントを参照する必要があります。例:

identity API は identity.launchWebAuthFlow() 関数を提供します。この関数は、必要に応じて、サービスのユーザー認証を行い、また、拡張機能にデータへのアクセスを認可するかどうかをユーザーに確認します。処理が完了すると、プロバイダーによって、アクセストークンか認可コードのどちらかが取得されます。

そして、OAuth2 フローを実施して取得した検証済みアクセストークンを、HTTP リクエスト内で使用することで、拡張機能はユーザーから認可された範囲でデータにアクセスできるようになります。

この API を利用するためには、"identity" API のパーミッションが必要です。

セットアップ

拡張機能を公開する前に、いくつかの設定が必要です。

リダイレクトURL を取得する

リダイレクト URL は、アクセストークンまたは認可コードを拡張機能に配布するための identity.launchWebAuthFlow() のエンドポイントを意味します。

identity.getRedirectURL()を呼び出すことでリダイレクトURL を取得できます。この関数は、アドオン ID からリダイレクト URL を生成するため、使用したい場合、browser_specific_settings キーを使用してアドオン ID を明示的に設定する必要があるでしょう (設定しない場合、アドオンを一時的にインストールするたびに、異なるリダイレクト URL を取得することになります)。

identity.getRedirectURL() によって返されるリダイレクト URL の利用が必須というわけではありません。独自の URL を指定することもできます。サービスがリダイレクトするものであれば何でもかまいません。ただし、ドメインは自分で管理しているものでなければいけません。

リダイレクト URL は 2 つの場面で利用されます:

  • 拡張機能を OAuth2 クライアントとして登録するとき
  • identity.launchWebAuthFlow()url 引数に URL パラメーターとして渡すとき

拡張機能を登録する

サービスプロバイダー経由で OAuth2 を使用する前に、プロバイダーに対して、拡張機能を OAuth2 クライアントとして登録する必要があります。

サービスプロバイダーごとにやり方が異なることがありますが、一般的には、プロバイダーの ウェブサイトにおいて、拡張機能を登録することを意味します。この登録手順の中で、自身のリダイレクトURLを登録し、プロバイダーからクライアント ID (場合によっては、シークレットも) を受け取ります。そして、この両方を identity.launchWebAuthFlow() に渡す必要があります。

関数

identity.getRedirectURL()
リダイレクト URL を取得します。
identity.launchWebAuthFlow()
ウェブ認証フローを開始します。

ブラウザー実装状況

Update compatibility data on GitHub
デスクトップモバイル
ChromeEdgeFirefoxOperaAndroid 版 Firefox
getRedirectURLChrome 完全対応 ありEdge 未対応 なしFirefox 完全対応 53Opera 完全対応 60Firefox Android 未対応 なし
launchWebAuthFlowChrome 完全対応 ありEdge 未対応 なしFirefox 完全対応 53
完全対応 53
未対応 53 — 63
補足
補足 The redirect_uri URL parameter is required.
Opera 完全対応 ありFirefox Android 未対応 なし

凡例

完全対応  
完全対応
未対応  
未対応
実装ノートを参照してください。
実装ノートを参照してください。

Example extensions

謝辞

この API は Chromium の chrome.identity API に基づいています。

Microsoft Edge の実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従います。