Method: projects.verifyAppCheckToken

指定された App Check トークンを検証し、呼び出し元が操作できるトークン使用シグナルを返します。現在、このメソッドは次の証明書プロバイダから交換された App Check トークンのみをサポートしています。

  • Play Integrity API
  • App Attest
  • DeviceCheck（ DCDevice トークン）
  • reCAPTCHA Enterprise
  • reCAPTCHA v3
  • カスタム プロバイダ

デバッグ シークレットから交換された App Check トークンもサポートされます。サポートされていないプロバイダを使用して有効な App Check トークンに対してこのメソッドを呼び出すと、HTTP 400 エラーが返されます。

このトークンがこの呼び出しの前にすでに使用されていたかどうかを返します。このメソッドが指定された App Check トークンを初めて参照した場合、レスポンスの alreadyConsumed フィールドはありません。指定されたトークンは、その後、そのトークンに対してこのメソッドが呼び出される際に alreadyConsumed とマークされます（ true に設定されます）。

指定された App Check トークンが無効な場合は、トークンがすでに使用されているかどうかにかかわらず、レスポンス オブジェクトではなく HTTP 403 エラーが返されます。

現在、App Check トークンがすでに使用されているかどうかを評価する際は、この正確なメソッドの呼び出しのみがカウントされます。他の場所で App Check トークンを使用しても、トークンはすでに消費済みとしてマークされません。

このメソッドを呼び出すには、呼び出し元には firebaseappcheck.appCheckTokens.verify 権限が必要です。この権限は、 Firebase App Check トークン検証者のロール の一部です。

HTTP リクエスト

POST https://firebaseappcheck.googleapis.com/v1beta/{project=projects/*}:verifyAppCheckToken

この URL は gRPC コード変換 構文を使用します。

パスパラメータ

パラメータ
project

string

必須。トークンが作成されたプロジェクトの相対的なリソース名。形式は次のとおりです。

projects/{project_number}

必要に応じて、 project_number 要素を Firebase プロジェクトのプロジェクト ID に置き換えることができます。Google の AIP 2510 規格でプロジェクト ID を使用する方法の詳細をご覧ください。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "appCheckToken": string
}
フィールド
appCheckToken

string

必須。検証する App Check トークン。

SafetyNet プロバイダから交換された App Check トークンはサポートされていません。HTTP 400 エラーが返されます。

レスポンスの本文

projects.verifyAppCheckToken メソッドに対するレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "alreadyConsumed": boolean
}
フィールド
alreadyConsumed

boolean

このトークンがすでに使用されているかどうか。

このメソッドが指定された App Check トークンを初めて参照する場合、このフィールドはレスポンスから除外されます。指定されたトークンは、その後、そのトークンに対してこのメソッドが呼び出される際に alreadyConsumed とマークされます（ true に設定されます）。

指定された App Check トークンが無効な場合は、トークンがすでに使用されているかどうかにかかわらず、このフィールドを含むレスポンスではなく HTTP 403 エラーが返されます。

認可スコープ

次のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/firebase

詳細については、 認証の概要 をご覧ください。