Manifest V2 拡張機能は、2026 年 8 月 31 日に Chrome ウェブストアから削除されました。ユーザーが再び拡張機能を利用できるようにするには、Manifest V3 に移行してください。

Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

chrome.identity

更新日: 2026-09-25 robots: noindex

説明

chrome.identity API を使用して OAuth2 アクセストークンを取得します。

権限

identity

型

AccountInfo

プロパティ

id

文字列

アカウントの固有識別子。この ID は、アカウントの存続期間中は変更されません。

AccountStatus

Chrome 84 以降

列挙型

"SYNC"
メインアカウントで同期が有効になっていることを指定します。

"ANY"
メインアカウントが存在するかどうかを指定します。

GetAuthTokenResult

Chrome 105 以降

プロパティ

grantedScopes

string[] 省略可

拡張機能に付与された OAuth2 スコープのリスト。
token

文字列省略可

リクエストに関連付けられている特定のトークン。

InvalidTokenDetails

プロパティ

token

文字列

キャッシュから削除する必要がある特定のトークン。

ProfileDetails

Chrome 84 以降

プロパティ

accountStatus

AccountStatus 省略可

ProfileUserInfo を返す必要があるプロファイルにログインしているメインのアカウントのステータス。デフォルトは SYNC アカウントステータスです。

ProfileUserInfo

プロパティ

メール

文字列

現在のプロファイルにログインしているユーザーアカウントのメールアドレス。ユーザーがログインしていない場合、または identity.email マニフェスト権限が指定されていない場合は、空になります。
id

文字列

アカウントの固有識別子。この ID は、アカウントの存続期間中は変更されません。ユーザーがログインしていない場合、または（M41 以降で）identity.email マニフェスト権限が指定されていない場合は、空になります。

TokenDetails

プロパティ

アカウント

AccountInfo 省略可

トークンを返すアカウント ID。指定しない場合、この関数は Chrome プロファイルのアカウント（同期アカウントがある場合はそのアカウント、ない場合は最初の Google ウェブアカウント）を使用します。
enableGranularPermissions

boolean 省略可

Chrome 87 以降

enableGranularPermissions フラグを使用すると、拡張機能は、リクエストされた権限が個別に付与または拒否される、きめ細かい権限の同意画面に早期にオプトインできます。
インタラクティブ

boolean 省略可

トークンを取得するには、ユーザーが Chrome にログインするか、アプリケーションがリクエストしたスコープを承認する必要があります。インタラクティブフラグが true の場合、getAuthToken は必要に応じてユーザーにプロンプトを表示します。フラグが false であるか省略されている場合、getAuthToken はプロンプトが必要になるたびに失敗を返します。
スコープ

string[] 省略可

リクエストする OAuth2 スコープのリスト。

scopes フィールドが存在する場合、manifest.json で指定されたスコープのリストがオーバーライドされます。

WebAuthFlowDetails

プロパティ

abortOnLoadForNonInteractive

boolean 省略可

Chrome 113 以降

ページ読み込み後に非インタラクティブリクエストの launchWebAuthFlow を終了するかどうか。このパラメータは、インタラクティブフローには影響しません。

true（デフォルト）に設定すると、ページの読み込み直後にフローが終了します。false に設定すると、フローは timeoutMsForNonInteractive が経過した後にのみ終了します。これは、JavaScript を使用してページの読み込み後にリダイレクトを行う ID プロバイダに役立ちます。
インタラクティブ

boolean 省略可

インタラクティブモードで認証フローを起動するかどうか。

一部の認証フローでは、結果の URL にすぐにリダイレクトされることがあるため、launchWebAuthFlow は、最初のナビゲーションが最終的な URL にリダイレクトされるか、表示されるページの読み込みが完了するまで、ウェブビューを非表示にします。

interactive フラグが true の場合、ページの読み込みが完了するとウィンドウが表示されます。フラグが false であるか省略されている場合、最初のナビゲーションでフローが完了しないと、launchWebAuthFlow はエラーを返します。

リダイレクトに JavaScript を使用するフローの場合、timeoutMsForNonInteractive を設定するとともに abortOnLoadForNonInteractive を false に設定することで、ページでリダイレクトを実行できるようになります。
timeoutMsForNonInteractive

number 省略可

Chrome 113 以降

launchWebAuthFlow が非インタラクティブモードで実行できる合計時間（ミリ秒単位）。interactive が false の場合にのみ有効です。
URL

文字列

認証フローを開始する URL。

メソッド

clearAllCachedAuthTokens()

Promise Chrome 87 以降

chrome.identity.clearAllCachedAuthTokens(
  callback?: function,
): Promise<void>

Identity API の状態をリセットします。

トークンキャッシュからすべての OAuth2 アクセストークンを削除します。
ユーザーのアカウント設定を削除します
すべての認証フローからユーザーの認証を解除します。

パラメータ

callback

function 省略可

callback パラメータは次のようになります。
```
() => void
```

戻り値

Promise<void>

Chrome 106 以降

状態がクリアされると解決される Promise を返します。

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getAccounts()

Promise Dev チャンネル

chrome.identity.getAccounts(
  callback?: function,
): Promise<AccountInfo[]>

プロファイルに存在するアカウントを記述する AccountInfo オブジェクトのリストを取得します。

getAccounts は Dev チャンネルでのみサポートされています。

パラメータ

callback

function 省略可

callback パラメータは次のようになります。
```
(accounts: AccountInfo[]) => void
```
- アカウント
  
  AccountInfo[]

戻り値

<AccountInfo[]> を約束

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getAuthToken()

Promise

chrome.identity.getAuthToken(
  details?: TokenDetails,
  callback?: function,
): Promise<GetAuthTokenResult>

manifest.json の oauth2 セクションで指定されたクライアント ID とスコープを使用して、OAuth2 アクセストークンを取得します。

Identity API はアクセストークンをメモリにキャッシュするため、トークンが必要なときにいつでも非インタラクティブに getAuthToken を呼び出すことができます。トークンキャッシュは有効期限を自動的に処理します。

優れたユーザーエクスペリエンスを提供するには、アプリの UI でインタラクティブなトークンリクエストを開始し、認可の目的を説明することが重要です。この設定を行わないと、ユーザーに承認リクエストが表示されたり、ログインしていない場合は Chrome のログイン画面が表示されたりします。特に、アプリの初回起動時に getAuthToken をインタラクティブに使用しないでください。

注: コールバックを指定して呼び出した場合、この関数はオブジェクトを返すのではなく、2 つのプロパティを個別の引数としてコールバックに渡します。

パラメータ

詳細

TokenDetails 省略可

トークンオプション。
callback

function 省略可

callback パラメータは次のようになります。
```
(result: GetAuthTokenResult) => void
```
- 件の結果
  
  GetAuthTokenResult
  
  Chrome 105 以降

戻り値

Promise<GetAuthTokenResult>

Chrome 105 以降

マニフェストで指定された OAuth2 アクセストークンで解決される Promise を返します。エラーが発生した場合は拒否されます。grantedScopes パラメータは Chrome 87 以降で入力されます。このパラメータには、返されたトークンに対応する付与されたスコープのリストが含まれます（利用可能な場合）。

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getProfileUserInfo()

Promise

chrome.identity.getProfileUserInfo(
  details?: ProfileDetails,
  callback?: function,
): Promise<ProfileUserInfo>

プロファイルにログインしているユーザーのメールアドレスと難読化された GAIA ID を取得します。

identity.email マニフェスト権限が必要です。それ以外の場合は、空の結果を返します。

この API は、次の 2 つの点で identity.getAccounts と異なります。返される情報はオフラインで利用可能で、プロファイルのメインアカウントにのみ適用されます。

パラメータ

詳細

ProfileDetails 省略可

Chrome 84 以降

プロフィールの設定。
callback

function 省略可

callback パラメータは次のようになります。
```
(userInfo: ProfileUserInfo) => void
```
- userInfo
  
  ProfileUserInfo

戻り値

Promise<ProfileUserInfo>

Chrome 106 以降

メインの Chrome アカウントの ProfileUserInfo で解決される Promise を返します。指定された details のアカウントが存在しない場合は、空の ProfileUserInfo を返します。

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

getRedirectURL()

chrome.identity.getRedirectURL(
  path?: string,
): string

launchWebAuthFlow で使用するリダイレクト URL を生成します。

生成された URL はパターン https://<app-id>.chromiumapp.org/* と一致します。

パラメータ

パス

文字列省略可

生成された URL の末尾に追加されるパス。

戻り値

文字列

launchWebAuthFlow()

Promise

chrome.identity.launchWebAuthFlow(
  details: WebAuthFlowDetails,
  callback?: function,
): Promise<string | undefined>

指定された URL で認証フローを開始します。

このメソッドは、ウェブビューを起動してプロバイダの認証フローの最初の URL に移動することで、Google 以外の ID プロバイダでの認証フローを可能にします。プロバイダがパターン https://<app-id>.chromiumapp.org/* に一致する URL にリダイレクトすると、ウィンドウが閉じ、最終的なリダイレクト URL が callback 関数に渡されます。

優れたユーザーエクスペリエンスを提供するには、アプリの UI でインタラクティブな認証フローを開始し、認証の目的を説明することが重要です。これを行わないと、ユーザーにコンテキストのない承認リクエストが届くことになります。特に、アプリの初回起動時には、インタラクティブな認証フローを起動しないでください。

パラメータ

詳細

WebAuthFlowDetails

WebAuth フローのオプション。
callback

function 省略可

callback パラメータは次のようになります。
```
(responseUrl?: string) => void
```
- responseUrl
  
  文字列省略可

戻り値

Promise<string | undefined>

Chrome 106 以降

アプリケーションにリダイレクトされる URL で解決される Promise を返します。

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

removeCachedAuthToken()

Promise

chrome.identity.removeCachedAuthToken(
  details: InvalidTokenDetails,
  callback?: function,
): Promise<void>

Identity API のトークンキャッシュから OAuth2 アクセストークンを削除します。

アクセストークンが無効であることが判明した場合は、removeCachedAuthToken に渡してキャッシュから削除する必要があります。アプリは getAuthToken を使用して新しいトークンを取得できます。

パラメータ

詳細

InvalidTokenDetails

トークン情報。
callback

function 省略可

callback パラメータは次のようになります。
```
() => void
```

戻り値

Promise<void>

Chrome 106 以降

トークンがキャッシュから削除されると解決される Promise を返します。

Promise は Manifest V3 以降でのみサポートされています。他のプラットフォームではコールバックを使用する必要があります。

イベント

onSignInChanged

chrome.identity.onSignInChanged.addListener(
  callback: function,
)

ユーザーのプロファイルのアカウントのログイン状態が変更されたときに呼び出されます。

パラメータ

callback

関数

callback パラメータは次のようになります。
```
(account: AccountInfo, signedIn: boolean) => void
```
- アカウント
  
  AccountInfo
- signedIn
  
  ブール値

chrome.identity コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

説明

権限

型

AccountInfo

プロパティ

AccountStatus

列挙型

GetAuthTokenResult

プロパティ

InvalidTokenDetails

プロパティ

ProfileDetails

プロパティ

ProfileUserInfo

プロパティ

TokenDetails

プロパティ

WebAuthFlowDetails

プロパティ

メソッド

clearAllCachedAuthTokens()

パラメータ

戻り値

getAccounts()

パラメータ

戻り値

getAuthToken()

パラメータ

戻り値

getProfileUserInfo()

パラメータ

戻り値

getRedirectURL()

パラメータ

戻り値

launchWebAuthFlow()

パラメータ

戻り値

removeCachedAuthToken()

パラメータ

戻り値

イベント

onSignInChanged

パラメータ

chrome.identity