Firebase App Check API

Firebase App Check fonctionne avec d'autres services Firebase pour contribuer à protéger vos ressources backend contre les utilisations abusives, telles que la fraude à la facturation ou l'hameçonnage.

Service: firebaseappcheck.googleapis.com

Pour appeler ce service, nous vous recommandons d'utiliser les bibliothèques clientes fournies par Google. Si votre application doit utiliser vos propres bibliothèques pour appeler ce service, utilisez les informations suivantes lorsque vous effectuez les requêtes API.

Document de découverte

Un document de découverte est une spécification exploitable par un ordinateur qui permet de décrire et de consommer les API REST. Ce document permet de créer des bibliothèques clientes, des plug-ins IDE et d'autres outils qui interagissent avec les API Google. Un même service peut fournir plusieurs documents de découverte. Ce service fournit les documents de découverte suivants :

Point de terminaison du service

Un point de terminaison de service est une URL de base qui spécifie l'adresse réseau d'un service d'API. Un service peut posséder plusieurs points de terminaison de service. Ce service possède le point de terminaison de service suivant, et tous les URI ci-dessous sont relatifs à ce point de terminaison de service :

  • https://firebaseappcheck.googleapis.com

Ressource REST: v1beta.jwks

Méthodes
get GET /v1beta/{name}
Renvoie un JWK public défini comme spécifié par la RFC 7517, qui peut être utilisé pour vérifier les jetons App Check.

Ressource REST: v1beta.oauthClients

Méthodes
exchangeAppAttestAssertion POST /v1beta/{app=oauthClients/*}:exchangeAppAttestAssertion
Accepte une assertion App Attest et un artefact précédemment obtenu auprès de ExchangeAppAttestAttestation, et vérifie ces éléments auprès d'Apple.
exchangeAppAttestAttestation POST /v1beta/{app=oauthClients/*}:exchangeAppAttestAttestation
Accepte une attestation CBOR App Attest et la vérifie auprès d'Apple à l'aide de votre équipe préconfigurée et de vos ID de bundle.
exchangeDebugToken POST /v1beta/{app=oauthClients/*}:exchangeDebugToken
Valide un secret de jeton de débogage que vous avez créé précédemment à l'aide de CreateDebugToken.
generateAppAttestChallenge POST /v1beta/{app=oauthClients/*}:generateAppAttestChallenge
Génère une question d'authentification qui protège l'intégrité d'un appel de ExchangeAppAttestAttestation ou ExchangeAppAttestAssertion qui suit immédiatement.

Ressource REST: v1beta.projects

Méthodes
verifyAppCheckToken POST /v1beta/{project=projects/*}:verifyAppCheckToken
Vérifie le jeton App Check donné et renvoie des signaux d'utilisation du jeton sur lesquels les appelants peuvent agir.

Ressource REST: v1beta.projects.apps

Méthodes
exchangeAppAttestAssertion POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAssertion
Accepte une assertion App Attest et un artefact précédemment obtenu auprès de ExchangeAppAttestAttestation, et vérifie ces éléments auprès d'Apple.
exchangeAppAttestAttestation POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAttestation
Accepte une attestation CBOR App Attest et la vérifie auprès d'Apple à l'aide de votre équipe préconfigurée et de vos ID de bundle.
exchangeCustomToken POST /v1beta/{app=projects/*/apps/*}:exchangeCustomToken
Valide un jeton personnalisé signé à l'aide des identifiants du compte de service du SDK Admin de votre projet.
exchangeDebugToken POST /v1beta/{app=projects/*/apps/*}:exchangeDebugToken
Valide un secret de jeton de débogage que vous avez créé précédemment à l'aide de CreateDebugToken.
exchangeDeviceCheckToken POST /v1beta/{app=projects/*/apps/*}:exchangeDeviceCheckToken
Accepte un device_token émis par DeviceCheck et tente de le valider auprès d'Apple.
exchangePlayIntegrityToken POST /v1beta/{app=projects/*/apps/*}:exchangePlayIntegrityToken
Valide un jeton de réponse d'évaluation de l'intégrité de Play Integrity.
exchangeRecaptchaEnterpriseToken POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
Valide un jeton de réponse reCAPTCHA Enterprise.
exchangeRecaptchaToken
(deprecated)		 POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaToken
Valide un jeton de réponse reCAPTCHA v3.
exchangeRecaptchaV3Token POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaV3Token
Valide un jeton de réponse reCAPTCHA v3.
exchangeSafetyNetToken
(deprecated)		 POST /v1beta/{app=projects/*/apps/*}:exchangeSafetyNetToken
Valide un jeton SafetyNet.
generateAppAttestChallenge POST /v1beta/{app=projects/*/apps/*}:generateAppAttestChallenge
Génère une question d'authentification qui protège l'intégrité d'un appel de ExchangeAppAttestAttestation ou ExchangeAppAttestAssertion qui suit immédiatement.
generatePlayIntegrityChallenge POST /v1beta/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
Génère une question d'authentification qui protège l'intégrité d'une requête d'évaluation de l'intégrité envoyée à l'API Play Integrity immédiatement après.

Ressource REST: v1beta.projects.apps.appAttestConfig

Méthodes
batchGet GET /v1beta/{parent=projects/*}/apps/-/appAttestConfig:batchGet
Récupère atomiquement les AppAttestConfig pour la liste d'applications spécifiée.
get GET /v1beta/{name=projects/*/apps/*/appAttestConfig}
Récupère le AppAttestConfig pour l'application spécifiée.
patch PATCH /v1beta/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
Met à jour le AppAttestConfig pour l'application spécifiée.

Ressource REST: v1beta.projects.apps.debugTokens

Méthodes
create POST /v1beta/{parent=projects/*/apps/*}/debugTokens
Crée un objet DebugToken pour l'application spécifiée.
delete DELETE /v1beta/{name=projects/*/apps/*/debugTokens/*}
Supprime l'élément DebugToken spécifié.
get GET /v1beta/{name=projects/*/apps/*/debugTokens/*}
Récupère le DebugToken spécifié.
list GET /v1beta/{parent=projects/*/apps/*}/debugTokens
Répertorie toutes les DebugToken pour l'application spécifiée.
patch PATCH /v1beta/{debugToken.name=projects/*/apps/*/debugTokens/*}
Met à jour l'élément DebugToken spécifié.

Ressource REST: v1beta.projects.apps.deviceCheckConfig

Méthodes
batchGet GET /v1beta/{parent=projects/*}/apps/-/deviceCheckConfig:batchGet
Récupère atomiquement les DeviceCheckConfig pour la liste d'applications spécifiée.
get GET /v1beta/{name=projects/*/apps/*/deviceCheckConfig}
Récupère le DeviceCheckConfig pour l'application spécifiée.
patch PATCH /v1beta/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
Met à jour le DeviceCheckConfig pour l'application spécifiée.

Ressource REST: v1beta.projects.apps.playIntegrityConfig

Méthodes
batchGet GET /v1beta/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
Récupère atomiquement les PlayIntegrityConfig pour la liste d'applications spécifiée.
get GET /v1beta/{name=projects/*/apps/*/playIntegrityConfig}
Récupère le PlayIntegrityConfig pour l'application spécifiée.
patch PATCH /v1beta/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
Met à jour le PlayIntegrityConfig pour l'application spécifiée.

Ressource REST: v1beta.projects.apps.recaptchaConfig

Méthodes
batchGet
(deprecated)		 GET /v1beta/{parent=projects/*}/apps/-/recaptchaConfig:batchGet
Récupère atomiquement les RecaptchaConfig pour la liste d'applications spécifiée.
get
(deprecated)		 GET /v1beta/{name=projects/*/apps/*/recaptchaConfig}
Récupère le RecaptchaConfig pour l'application spécifiée.
patch
(deprecated)		 PATCH /v1beta/{recaptchaConfig.name=projects/*/apps/*/recaptchaConfig}
Met à jour le RecaptchaConfig pour l'application spécifiée.

Ressource REST: v1beta.projects.apps.recaptchaEnterpriseConfig

Méthodes
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
Récupère atomiquement les RecaptchaEnterpriseConfig pour la liste d'applications spécifiée.
get GET /v1beta/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
Récupère le RecaptchaEnterpriseConfig pour l'application spécifiée.
patch PATCH /v1beta/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
Met à jour le RecaptchaEnterpriseConfig pour l'application spécifiée.

Ressource REST: v1beta.projects.apps.recaptchaV3Config

Méthodes
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
Récupère atomiquement les RecaptchaV3Config pour la liste d'applications spécifiée.
get GET /v1beta/{name=projects/*/apps/*/recaptchaV3Config}
Récupère le RecaptchaV3Config pour l'application spécifiée.
patch PATCH /v1beta/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
Met à jour le RecaptchaV3Config pour l'application spécifiée.

Ressource REST: v1beta.projects.apps.safetyNetConfig

Méthodes
batchGet
(deprecated)		 GET /v1beta/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
Récupère atomiquement les SafetyNetConfig pour la liste d'applications spécifiée.
get
(deprecated)		 GET /v1beta/{name=projects/*/apps/*/safetyNetConfig}
Récupère le SafetyNetConfig pour l'application spécifiée.
patch
(deprecated)		 PATCH /v1beta/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
Met à jour le SafetyNetConfig pour l'application spécifiée.

Ressource REST: v1beta.projects.services

Méthodes
batchUpdate POST /v1beta/{parent=projects/*}/services:batchUpdate
Met à jour de manière atomique les configurations Service spécifiées.
get GET /v1beta/{name=projects/*/services/*}
Récupère la configuration Service pour le nom de service spécifié.
list GET /v1beta/{parent=projects/*}/services
Répertorie toutes les configurations Service pour le projet spécifié.
patch PATCH /v1beta/{service.name=projects/*/services/*}
Met à jour la configuration Service spécifiée.

Ressource REST: v1.jwks

Méthodes
get GET /v1/{name}
Renvoie un JWK public défini comme spécifié par la RFC 7517, qui peut être utilisé pour vérifier les jetons App Check.

Ressource REST: v1.projects.apps

Méthodes
exchangeAppAttestAssertion POST /v1/{app=projects/*/apps/*}:exchangeAppAttestAssertion
Accepte une assertion App Attest et un artefact précédemment obtenu auprès de ExchangeAppAttestAttestation, et vérifie ces éléments auprès d'Apple.
exchangeAppAttestAttestation POST /v1/{app=projects/*/apps/*}:exchangeAppAttestAttestation
Accepte une attestation CBOR App Attest et la vérifie auprès d'Apple à l'aide de votre équipe préconfigurée et de vos ID de bundle.
exchangeCustomToken POST /v1/{app=projects/*/apps/*}:exchangeCustomToken
Valide un jeton personnalisé signé à l'aide des identifiants du compte de service du SDK Admin de votre projet.
exchangeDebugToken POST /v1/{app=projects/*/apps/*}:exchangeDebugToken
Valide un secret de jeton de débogage que vous avez créé précédemment à l'aide de CreateDebugToken.
exchangeDeviceCheckToken POST /v1/{app=projects/*/apps/*}:exchangeDeviceCheckToken
Accepte un device_token émis par DeviceCheck et tente de le valider auprès d'Apple.
exchangePlayIntegrityToken POST /v1/{app=projects/*/apps/*}:exchangePlayIntegrityToken
Valide un jeton de réponse d'évaluation de l'intégrité de Play Integrity.
exchangeRecaptchaEnterpriseToken POST /v1/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
Valide un jeton de réponse reCAPTCHA Enterprise.
exchangeRecaptchaV3Token POST /v1/{app=projects/*/apps/*}:exchangeRecaptchaV3Token
Valide un jeton de réponse reCAPTCHA v3.
exchangeSafetyNetToken
(deprecated)		 POST /v1/{app=projects/*/apps/*}:exchangeSafetyNetToken
Valide un jeton SafetyNet.
generateAppAttestChallenge POST /v1/{app=projects/*/apps/*}:generateAppAttestChallenge
Génère une question d'authentification qui protège l'intégrité d'un appel de ExchangeAppAttestAttestation ou ExchangeAppAttestAssertion qui suit immédiatement.
generatePlayIntegrityChallenge POST /v1/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
Génère une question d'authentification qui protège l'intégrité d'une requête d'évaluation de l'intégrité envoyée à l'API Play Integrity immédiatement après.

Ressource REST: v1.projects.apps.appAttestConfig

Méthodes
batchGet GET /v1/{parent=projects/*}/apps/-/appAttestConfig:batchGet
Récupère atomiquement les AppAttestConfig pour la liste d'applications spécifiée.
get GET /v1/{name=projects/*/apps/*/appAttestConfig}
Récupère le AppAttestConfig pour l'application spécifiée.
patch PATCH /v1/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
Met à jour le AppAttestConfig pour l'application spécifiée.

Ressource REST: v1.projects.apps.debugTokens

Méthodes
create POST /v1/{parent=projects/*/apps/*}/debugTokens
Crée un objet DebugToken pour l'application spécifiée.
delete DELETE /v1/{name=projects/*/apps/*/debugTokens/*}
Supprime l'élément DebugToken spécifié.
get GET /v1/{name=projects/*/apps/*/debugTokens/*}
Récupère le DebugToken spécifié.
list GET /v1/{parent=projects/*/apps/*}/debugTokens
Répertorie toutes les DebugToken pour l'application spécifiée.
patch PATCH /v1/{debugToken.name=projects/*/apps/*/debugTokens/*}
Met à jour l'élément DebugToken spécifié.

Ressource REST: v1.projects.apps.deviceCheckConfig

Méthodes
batchGet GET /v1/{parent=projects/*}/apps/-/deviceCheckConfig:batchGet
Récupère atomiquement les DeviceCheckConfig pour la liste d'applications spécifiée.
get GET /v1/{name=projects/*/apps/*/deviceCheckConfig}
Récupère le DeviceCheckConfig pour l'application spécifiée.
patch PATCH /v1/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
Met à jour le DeviceCheckConfig pour l'application spécifiée.

Ressource REST: v1.projects.apps.playIntegrityConfig

Méthodes
batchGet GET /v1/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
Récupère atomiquement les PlayIntegrityConfig pour la liste d'applications spécifiée.
get GET /v1/{name=projects/*/apps/*/playIntegrityConfig}
Récupère le PlayIntegrityConfig pour l'application spécifiée.
patch PATCH /v1/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
Met à jour le PlayIntegrityConfig pour l'application spécifiée.

Ressource REST: v1.projects.apps.recaptchaEnterpriseConfig

Méthodes
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
Récupère atomiquement les RecaptchaEnterpriseConfig pour la liste d'applications spécifiée.
get GET /v1/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
Récupère le RecaptchaEnterpriseConfig pour l'application spécifiée.
patch PATCH /v1/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
Met à jour le RecaptchaEnterpriseConfig pour l'application spécifiée.

Ressource REST: v1.projects.apps.recaptchaV3Config

Méthodes
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
Récupère atomiquement les RecaptchaV3Config pour la liste d'applications spécifiée.
get GET /v1/{name=projects/*/apps/*/recaptchaV3Config}
Récupère le RecaptchaV3Config pour l'application spécifiée.
patch PATCH /v1/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
Met à jour le RecaptchaV3Config pour l'application spécifiée.

Ressource REST: v1.projects.apps.safetyNetConfig

Méthodes
batchGet
(deprecated)		 GET /v1/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
Récupère atomiquement les SafetyNetConfig pour la liste d'applications spécifiée.
get
(deprecated)		 GET /v1/{name=projects/*/apps/*/safetyNetConfig}
Récupère le SafetyNetConfig pour l'application spécifiée.
patch
(deprecated)		 PATCH /v1/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
Met à jour le SafetyNetConfig pour l'application spécifiée.

Ressource REST: v1.projects.services

Méthodes
batchUpdate POST /v1/{parent=projects/*}/services:batchUpdate
Met à jour de manière atomique les configurations Service spécifiées.
get GET /v1/{name=projects/*/services/*}
Récupère la configuration Service pour le nom de service spécifié.
list GET /v1/{parent=projects/*}/services
Répertorie toutes les configurations Service pour le projet spécifié.
patch PATCH /v1/{service.name=projects/*/services/*}
Met à jour la configuration Service spécifiée.