Firebase App Check API

Firebase App Check は他の Firebase サービスと連携して、請求詐欺やフィッシングなどの不正行為からバックエンド リソースを保護します。

サービス: firebaseappcheck.googleapis.com

このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをおすすめします。アプリケーションで独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストの際に次の情報を使用してください。

ディスカバリ ドキュメント

ディスカバリ ドキュメントは、REST API を記述して使用するための機械可読仕様です。クライアント ライブラリ、IDE プラグイン、Google API と連携するその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリ ドキュメントを提供できます。このサービスでは、次のディスカバリ ドキュメントが用意されています。

サービス エンドポイント

サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。1 つのサービスに複数のサービス エンドポイントが存在することがあります。このサービスには次のサービス エンドポイントがあり、以下のすべての URI がこのサービス エンドポイントに関連しています。

  • https://firebaseappcheck.googleapis.com

REST リソース: v1beta.jwks

Methods
get GET /v1beta/{name}
RFC 7517 で指定されているように、App Check トークンの検証に使用できる公開 JWK セットを返します。

REST リソース: v1beta.oauthClients

Methods
exchangeAppAttestAssertion POST /v1beta/{app=oauthClients/*}:exchangeAppAttestAssertion
App Attest アサーションと以前に ExchangeAppAttestAttestation から取得したアーティファクトを受け入れ、Apple で検証します。
exchangeAppAttestAttestation POST /v1beta/{app=oauthClients/*}:exchangeAppAttestAttestation
App Attest CBOR 証明書を受け入れ、事前構成されたチームとバンドル ID を使用して Apple で検証します。
exchangeDebugToken POST /v1beta/{app=oauthClients/*}:exchangeDebugToken
CreateDebugToken を使用して以前に作成したデバッグ トークン シークレットを検証します。
generateAppAttestChallenge POST /v1beta/{app=oauthClients/*}:generateAppAttestChallenge
ExchangeAppAttestAttestation または ExchangeAppAttestAssertion の呼び出しの直後の完全性を保護するチャレンジを生成します。

REST リソース: v1beta.projects

Methods
verifyAppCheckToken POST /v1beta/{project=projects/*}:verifyAppCheckToken
指定された App Check トークンを検証し、呼び出し元が操作できるトークン使用シグナルを返します。

REST リソース: v1beta.projects.apps

Methods
exchangeAppAttestAssertion POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAssertion
App Attest アサーションと以前に ExchangeAppAttestAttestation から取得したアーティファクトを受け入れ、Apple で検証します。
exchangeAppAttestAttestation POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAttestation
App Attest CBOR 証明書を受け入れ、事前構成されたチームとバンドル ID を使用して Apple で検証します。
exchangeCustomToken POST /v1beta/{app=projects/*/apps/*}:exchangeCustomToken
プロジェクトの Admin SDK サービス アカウントの認証情報を使用して署名されたカスタム トークンを検証します。
exchangeDebugToken POST /v1beta/{app=projects/*/apps/*}:exchangeDebugToken
CreateDebugToken を使用して以前に作成したデバッグ トークン シークレットを検証します。
exchangeDeviceCheckToken POST /v1beta/{app=projects/*/apps/*}:exchangeDeviceCheckToken
DeviceCheck から発行された device_token を受け入れ、Apple での検証を試みます。
exchangePlayIntegrityToken POST /v1beta/{app=projects/*/apps/*}:exchangePlayIntegrityToken
Play Integrity からの完全性判定の結果レスポンス トークンを検証します。
exchangeRecaptchaEnterpriseToken POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
reCAPTCHA Enterprise レスポンス トークンを検証します。
exchangeRecaptchaToken
(deprecated)		 POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaToken
reCAPTCHA v3 レスポンス トークンを検証します。
exchangeRecaptchaV3Token POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaV3Token
reCAPTCHA v3 レスポンス トークンを検証します。
exchangeSafetyNetToken
(deprecated)		 POST /v1beta/{app=projects/*/apps/*}:exchangeSafetyNetToken
SafetyNet トークンを検証します。
generateAppAttestChallenge POST /v1beta/{app=projects/*/apps/*}:generateAppAttestChallenge
ExchangeAppAttestAttestation または ExchangeAppAttestAssertion の呼び出しの直後の完全性を保護するチャレンジを生成します。
generatePlayIntegrityChallenge POST /v1beta/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
Play Integrity API に対する完全性判定の結果リクエストの直後の完全性を保護するチャレンジを生成します。

REST リソース: v1beta.projects.apps.appAttestConfig

Methods
batchGet GET /v1beta/{parent=projects/*}/apps/-/appAttestConfig:batchGet
指定されたアプリリストの AppAttestConfig をアトミックに取得します。
get GET /v1beta/{name=projects/*/apps/*/appAttestConfig}
指定したアプリの AppAttestConfig を取得します。
patch PATCH /v1beta/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
指定したアプリの AppAttestConfig を更新します。

REST リソース: v1beta.projects.apps.debugTokens

Methods
create POST /v1beta/{parent=projects/*/apps/*}/debugTokens
指定したアプリの新しい DebugToken を作成します。
delete DELETE /v1beta/{name=projects/*/apps/*/debugTokens/*}
指定された DebugToken を削除します。
get GET /v1beta/{name=projects/*/apps/*/debugTokens/*}
指定された DebugToken を取得します。
list GET /v1beta/{parent=projects/*/apps/*}/debugTokens
指定したアプリのすべての DebugToken を一覧表示します。
patch PATCH /v1beta/{debugToken.name=projects/*/apps/*/debugTokens/*}
指定された DebugToken を更新します。

REST リソース: v1beta.projects.apps.deviceCheckConfig

Methods
batchGet GET /v1beta/{parent=projects/*}/apps/-/deviceCheckConfig:batchGet
指定されたアプリリストの DeviceCheckConfig をアトミックに取得します。
get GET /v1beta/{name=projects/*/apps/*/deviceCheckConfig}
指定したアプリの DeviceCheckConfig を取得します。
patch PATCH /v1beta/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
指定したアプリの DeviceCheckConfig を更新します。

REST リソース: v1beta.projects.apps.playIntegrityConfig

Methods
batchGet GET /v1beta/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
指定されたアプリリストの PlayIntegrityConfig をアトミックに取得します。
get GET /v1beta/{name=projects/*/apps/*/playIntegrityConfig}
指定したアプリの PlayIntegrityConfig を取得します。
patch PATCH /v1beta/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
指定したアプリの PlayIntegrityConfig を更新します。

REST リソース: v1beta.projects.apps.recaptchaConfig

Methods
batchGet
(deprecated)		 GET /v1beta/{parent=projects/*}/apps/-/recaptchaConfig:batchGet
指定されたアプリリストの RecaptchaConfig をアトミックに取得します。
get
(deprecated)		 GET /v1beta/{name=projects/*/apps/*/recaptchaConfig}
指定したアプリの RecaptchaConfig を取得します。
patch
(deprecated)		 PATCH /v1beta/{recaptchaConfig.name=projects/*/apps/*/recaptchaConfig}
指定したアプリの RecaptchaConfig を更新します。

REST リソース: v1beta.projects.apps.recaptchaEnterpriseConfig

Methods
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
指定されたアプリリストの RecaptchaEnterpriseConfig をアトミックに取得します。
get GET /v1beta/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
指定したアプリの RecaptchaEnterpriseConfig を取得します。
patch PATCH /v1beta/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
指定したアプリの RecaptchaEnterpriseConfig を更新します。

REST リソース: v1beta.projects.apps.recaptchaV3Config

Methods
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
指定されたアプリリストの RecaptchaV3Config をアトミックに取得します。
get GET /v1beta/{name=projects/*/apps/*/recaptchaV3Config}
指定したアプリの RecaptchaV3Config を取得します。
patch PATCH /v1beta/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
指定したアプリの RecaptchaV3Config を更新します。

REST リソース: v1beta.projects.apps.safetyNetConfig

Methods
batchGet
(deprecated)		 GET /v1beta/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
指定されたアプリリストの SafetyNetConfig をアトミックに取得します。
get
(deprecated)		 GET /v1beta/{name=projects/*/apps/*/safetyNetConfig}
指定したアプリの SafetyNetConfig を取得します。
patch
(deprecated)		 PATCH /v1beta/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
指定したアプリの SafetyNetConfig を更新します。

REST リソース: v1beta.projects.services

Methods
batchUpdate POST /v1beta/{parent=projects/*}/services:batchUpdate
指定された Service 構成をアトミックに更新します。
get GET /v1beta/{name=projects/*/services/*}
指定されたサービス名の Service 構成を取得します。
list GET /v1beta/{parent=projects/*}/services
指定されたプロジェクトのすべての Service 構成を一覧表示します。
patch PATCH /v1beta/{service.name=projects/*/services/*}
指定された Service 構成を更新します。

REST リソース: v1.jwks

Methods
get GET /v1/{name}
RFC 7517 で指定されているように、App Check トークンの検証に使用できる公開 JWK セットを返します。

REST リソース: v1.projects.apps

Methods
exchangeAppAttestAssertion POST /v1/{app=projects/*/apps/*}:exchangeAppAttestAssertion
App Attest アサーションと以前に ExchangeAppAttestAttestation から取得したアーティファクトを受け入れ、Apple で検証します。
exchangeAppAttestAttestation POST /v1/{app=projects/*/apps/*}:exchangeAppAttestAttestation
App Attest CBOR 証明書を受け入れ、事前構成されたチームとバンドル ID を使用して Apple で検証します。
exchangeCustomToken POST /v1/{app=projects/*/apps/*}:exchangeCustomToken
プロジェクトの Admin SDK サービス アカウントの認証情報を使用して署名されたカスタム トークンを検証します。
exchangeDebugToken POST /v1/{app=projects/*/apps/*}:exchangeDebugToken
CreateDebugToken を使用して以前に作成したデバッグ トークン シークレットを検証します。
exchangeDeviceCheckToken POST /v1/{app=projects/*/apps/*}:exchangeDeviceCheckToken
DeviceCheck から発行された device_token を受け入れ、Apple での検証を試みます。
exchangePlayIntegrityToken POST /v1/{app=projects/*/apps/*}:exchangePlayIntegrityToken
Play Integrity からの完全性判定の結果レスポンス トークンを検証します。
exchangeRecaptchaEnterpriseToken POST /v1/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
reCAPTCHA Enterprise レスポンス トークンを検証します。
exchangeRecaptchaV3Token POST /v1/{app=projects/*/apps/*}:exchangeRecaptchaV3Token
reCAPTCHA v3 レスポンス トークンを検証します。
exchangeSafetyNetToken
(deprecated)		 POST /v1/{app=projects/*/apps/*}:exchangeSafetyNetToken
SafetyNet トークンを検証します。
generateAppAttestChallenge POST /v1/{app=projects/*/apps/*}:generateAppAttestChallenge
ExchangeAppAttestAttestation または ExchangeAppAttestAssertion の呼び出しの直後の完全性を保護するチャレンジを生成します。
generatePlayIntegrityChallenge POST /v1/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
Play Integrity API に対する完全性判定の結果リクエストの直後の完全性を保護するチャレンジを生成します。

REST リソース: v1.projects.apps.appAttestConfig

Methods
batchGet GET /v1/{parent=projects/*}/apps/-/appAttestConfig:batchGet
指定されたアプリリストの AppAttestConfig をアトミックに取得します。
get GET /v1/{name=projects/*/apps/*/appAttestConfig}
指定したアプリの AppAttestConfig を取得します。
patch PATCH /v1/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
指定したアプリの AppAttestConfig を更新します。

REST リソース: v1.projects.apps.debugTokens

Methods
create POST /v1/{parent=projects/*/apps/*}/debugTokens
指定したアプリの新しい DebugToken を作成します。
delete DELETE /v1/{name=projects/*/apps/*/debugTokens/*}
指定された DebugToken を削除します。
get GET /v1/{name=projects/*/apps/*/debugTokens/*}
指定された DebugToken を取得します。
list GET /v1/{parent=projects/*/apps/*}/debugTokens
指定したアプリのすべての DebugToken を一覧表示します。
patch PATCH /v1/{debugToken.name=projects/*/apps/*/debugTokens/*}
指定された DebugToken を更新します。

REST リソース: v1.projects.apps.deviceCheckConfig

Methods
batchGet GET /v1/{parent=projects/*}/apps/-/deviceCheckConfig:batchGet
指定されたアプリリストの DeviceCheckConfig をアトミックに取得します。
get GET /v1/{name=projects/*/apps/*/deviceCheckConfig}
指定したアプリの DeviceCheckConfig を取得します。
patch PATCH /v1/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
指定したアプリの DeviceCheckConfig を更新します。

REST リソース: v1.projects.apps.playIntegrityConfig

Methods
batchGet GET /v1/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
指定されたアプリリストの PlayIntegrityConfig をアトミックに取得します。
get GET /v1/{name=projects/*/apps/*/playIntegrityConfig}
指定したアプリの PlayIntegrityConfig を取得します。
patch PATCH /v1/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
指定したアプリの PlayIntegrityConfig を更新します。

REST リソース: v1.projects.apps.recaptchaEnterpriseConfig

Methods
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
指定されたアプリリストの RecaptchaEnterpriseConfig をアトミックに取得します。
get GET /v1/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
指定したアプリの RecaptchaEnterpriseConfig を取得します。
patch PATCH /v1/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
指定したアプリの RecaptchaEnterpriseConfig を更新します。

REST リソース: v1.projects.apps.recaptchaV3Config

Methods
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
指定されたアプリリストの RecaptchaV3Config をアトミックに取得します。
get GET /v1/{name=projects/*/apps/*/recaptchaV3Config}
指定したアプリの RecaptchaV3Config を取得します。
patch PATCH /v1/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
指定したアプリの RecaptchaV3Config を更新します。

REST リソース: v1.projects.apps.safetyNetConfig

Methods
batchGet
(deprecated)		 GET /v1/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
指定されたアプリリストの SafetyNetConfig をアトミックに取得します。
get
(deprecated)		 GET /v1/{name=projects/*/apps/*/safetyNetConfig}
指定したアプリの SafetyNetConfig を取得します。
patch
(deprecated)		 PATCH /v1/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
指定したアプリの SafetyNetConfig を更新します。

REST リソース: v1.projects.services

Methods
batchUpdate POST /v1/{parent=projects/*}/services:batchUpdate
指定された Service 構成をアトミックに更新します。
get GET /v1/{name=projects/*/services/*}
指定されたサービス名の Service 構成を取得します。
list GET /v1/{parent=projects/*}/services
指定されたプロジェクトのすべての Service 構成を一覧表示します。
patch PATCH /v1/{service.name=projects/*/services/*}
指定された Service 構成を更新します。