Firebase App Check API

O Firebase App Check funciona junto com outros serviços do Firebase para ajudar a proteger seus recursos de back-end contra abusos, como fraude de faturamento ou phishing.

Serviço: firebaseappcheck.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas cliente fornecidas pelo Google. Se seu aplicativo precisar usar suas próprias bibliotecas para chamar esse serviço, use as informações a seguir ao fazer as solicitações de API.

Documento de descoberta

Um Documento de Descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para construir bibliotecas de clientes, plug-ins IDE e outras ferramentas que interagem com APIs do Google. Um serviço pode fornecer vários documentos de descoberta. Este serviço fornece os seguintes documentos de descoberta:

Ponto final de serviço

Um terminal de serviço é uma URL base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários terminais de serviço. Este serviço tem o seguinte terminal de serviço e todos os URIs abaixo são relativos a este terminal de serviço:

  • https://firebaseappcheck.googleapis.com

Recurso REST: v1beta.jwks

Métodos
get GET /v1beta/{name}
Retorna um conjunto JWK público conforme especificado pela RFC 7517 que pode ser usado para verificar tokens do App Check.

Recurso REST: v1beta.oauthClients

Métodos
exchangeAppAttestAssertion POST /v1beta/{app=oauthClients/*}:exchangeAppAttestAssertion
Aceita uma declaração do App Attest e um artefato obtido anteriormente do ExchangeAppAttestAttestation e os verifica com a Apple.
exchangeAppAttestAttestation POST /v1beta/{app=oauthClients/*}:exchangeAppAttestAttestation
Aceita um atestado App Attest CBOR e o verifica com a Apple usando sua equipe pré-configurada e IDs de pacote.
exchangeDebugToken POST /v1beta/{app=oauthClients/*}:exchangeDebugToken
Valida um segredo de token de depuração criado anteriormente usando CreateDebugToken .
generateAppAttestChallenge POST /v1beta/{app=oauthClients/*}:generateAppAttestChallenge
Gera um desafio que protege a integridade de uma chamada imediatamente seguinte para ExchangeAppAttestAttestation ou ExchangeAppAttestAssertion .

Recurso REST: v1beta.projects

Métodos
verifyAppCheckToken POST /v1beta/{project=projects/*}:verifyAppCheckToken
Verifica o token do App Check fornecido e retorna sinais de uso de token que os chamadores podem agir.

Recurso REST: v1beta.projects.apps

Métodos
exchangeAppAttestAssertion POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAssertion
Aceita uma declaração do App Attest e um artefato obtido anteriormente do ExchangeAppAttestAttestation e os verifica com a Apple.
exchangeAppAttestAttestation POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAttestation
Aceita um atestado App Attest CBOR e o verifica com a Apple usando sua equipe pré-configurada e IDs de pacote.
exchangeCustomToken POST /v1beta/{app=projects/*/apps/*}:exchangeCustomToken
Valida um token personalizado assinado usando as credenciais da conta de serviço do SDK Admin do seu projeto.
exchangeDebugToken POST /v1beta/{app=projects/*/apps/*}:exchangeDebugToken
Valida um segredo de token de depuração criado anteriormente usando CreateDebugToken .
exchangeDeviceCheckToken POST /v1beta/{app=projects/*/apps/*}:exchangeDeviceCheckToken
Aceita um device_token emitido pelo DeviceCheck e tenta validá-lo com a Apple.
exchangePlayIntegrityToken POST /v1beta/{app=projects/*/apps/*}:exchangePlayIntegrityToken
Valida um token de resposta de veredicto de integridade do Play Integrity .
exchangeRecaptchaEnterpriseToken POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
Valida um token de resposta reCAPTCHA Enterprise .
exchangeRecaptchaToken
(deprecated)
POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaToken
Valida um token de resposta reCAPTCHA v3 .
exchangeRecaptchaV3Token POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaV3Token
Valida um token de resposta reCAPTCHA v3 .
exchangeSafetyNetToken
(deprecated)
POST /v1beta/{app=projects/*/apps/*}:exchangeSafetyNetToken
Valida um token SafetyNet .
generateAppAttestChallenge POST /v1beta/{app=projects/*/apps/*}:generateAppAttestChallenge
Gera um desafio que protege a integridade de uma chamada imediatamente seguinte para ExchangeAppAttestAttestation ou ExchangeAppAttestAssertion .
generatePlayIntegrityChallenge POST /v1beta/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
Gera um desafio que protege a integridade de uma solicitação de veredicto de integridade imediatamente seguinte à API Play Integrity.

Recurso REST: v1beta.projects.apps.appAttestConfig

Métodos
batchGet GET /v1beta/{parent=projects/*}/apps/-/appAttestConfig:batchGet
Obtém atomicamente os AppAttestConfig s para a lista especificada de aplicativos.
get GET /v1beta/{name=projects/*/apps/*/appAttestConfig}
Obtém o AppAttestConfig do aplicativo especificado.
patch PATCH /v1beta/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
Atualiza o AppAttestConfig para o aplicativo especificado.

Recurso REST: v1beta.projects.apps.debugTokens

Métodos
create POST /v1beta/{parent=projects/*/apps/*}/debugTokens
Cria um novo DebugToken para o aplicativo especificado.
delete DELETE /v1beta/{name=projects/*/apps/*/debugTokens/*}
Exclui o DebugToken especificado.
get GET /v1beta/{name=projects/*/apps/*/debugTokens/*}
Obtém o DebugToken especificado.
list GET /v1beta/{parent=projects/*/apps/*}/debugTokens
Lista todos DebugToken s para o aplicativo especificado.
patch PATCH /v1beta/{debugToken.name=projects/*/apps/*/debugTokens/*}
Atualiza o DebugToken especificado.

Recurso REST: v1beta.projects.apps.deviceCheckConfig

Métodos
batchGet GET /v1beta/{parent=projects/*}/apps/-/deviceCheckConfig:batchGet
Obtém atomicamente os DeviceCheckConfig s para a lista especificada de aplicativos.
get GET /v1beta/{name=projects/*/apps/*/deviceCheckConfig}
Obtém o DeviceCheckConfig do aplicativo especificado.
patch PATCH /v1beta/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
Atualiza o DeviceCheckConfig para o aplicativo especificado.

Recurso REST: v1beta.projects.apps.playIntegrityConfig

Métodos
batchGet GET /v1beta/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
Obtém atomicamente os PlayIntegrityConfig s para a lista especificada de aplicativos.
get GET /v1beta/{name=projects/*/apps/*/playIntegrityConfig}
Obtém o PlayIntegrityConfig do aplicativo especificado.
patch PATCH /v1beta/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
Atualiza o PlayIntegrityConfig para o aplicativo especificado.

Recurso REST: v1beta.projects.apps.recaptchaConfig

Métodos
batchGet
(deprecated)
GET /v1beta/{parent=projects/*}/apps/-/recaptchaConfig:batchGet
Obtém atomicamente os RecaptchaConfig s para a lista especificada de aplicativos.
get
(deprecated)
GET /v1beta/{name=projects/*/apps/*/recaptchaConfig}
Obtém o RecaptchaConfig do aplicativo especificado.
patch
(deprecated)
PATCH /v1beta/{recaptchaConfig.name=projects/*/apps/*/recaptchaConfig}
Atualiza o RecaptchaConfig para o aplicativo especificado.

Recurso REST: v1beta.projects.apps.recaptchaEnterpriseConfig

Métodos
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
Obtém atomicamente os RecaptchaEnterpriseConfig s para a lista especificada de aplicativos.
get GET /v1beta/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
Obtém o RecaptchaEnterpriseConfig do aplicativo especificado.
patch PATCH /v1beta/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
Atualiza o RecaptchaEnterpriseConfig para o aplicativo especificado.

Recurso REST: v1beta.projects.apps.recaptchaV3Config

Métodos
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
Obtém atomicamente os RecaptchaV3Config s para a lista especificada de aplicativos.
get GET /v1beta/{name=projects/*/apps/*/recaptchaV3Config}
Obtém o RecaptchaV3Config do aplicativo especificado.
patch PATCH /v1beta/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
Atualiza o RecaptchaV3Config para o aplicativo especificado.

Recurso REST: v1beta.projects.apps.safetyNetConfig

Métodos
batchGet
(deprecated)
GET /v1beta/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
Obtém atomicamente os SafetyNetConfig s para a lista especificada de aplicativos.
get
(deprecated)
GET /v1beta/{name=projects/*/apps/*/safetyNetConfig}
Obtém o SafetyNetConfig do aplicativo especificado.
patch
(deprecated)
PATCH /v1beta/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
Atualiza o SafetyNetConfig para o aplicativo especificado.

Recurso REST: v1beta.projects.services

Métodos
batchUpdate POST /v1beta/{parent=projects/*}/services:batchUpdate
Atualiza atomicamente as configurações Service especificadas.
get GET /v1beta/{name=projects/*/services/*}
Obtém a configuração Service para o nome de serviço especificado.
list GET /v1beta/{parent=projects/*}/services
Lista todas as configurações Service do projeto especificado.
patch PATCH /v1beta/{service.name=projects/*/services/*}
Atualiza a configuração Service especificada.

Recurso REST: v1.jwks

Métodos
get GET /v1/{name}
Retorna um conjunto JWK público conforme especificado pela RFC 7517 que pode ser usado para verificar tokens do App Check.

Recurso REST: v1.projects.apps

Métodos
exchangeAppAttestAssertion POST /v1/{app=projects/*/apps/*}:exchangeAppAttestAssertion
Aceita uma declaração do App Attest e um artefato obtido anteriormente do ExchangeAppAttestAttestation e os verifica com a Apple.
exchangeAppAttestAttestation POST /v1/{app=projects/*/apps/*}:exchangeAppAttestAttestation
Aceita um atestado App Attest CBOR e o verifica com a Apple usando sua equipe pré-configurada e IDs de pacote.
exchangeCustomToken POST /v1/{app=projects/*/apps/*}:exchangeCustomToken
Valida um token personalizado assinado usando as credenciais da conta de serviço do SDK Admin do seu projeto.
exchangeDebugToken POST /v1/{app=projects/*/apps/*}:exchangeDebugToken
Valida um segredo de token de depuração criado anteriormente usando CreateDebugToken .
exchangeDeviceCheckToken POST /v1/{app=projects/*/apps/*}:exchangeDeviceCheckToken
Aceita um device_token emitido pelo DeviceCheck e tenta validá-lo com a Apple.
exchangePlayIntegrityToken POST /v1/{app=projects/*/apps/*}:exchangePlayIntegrityToken
Valida um token de resposta de veredicto de integridade do Play Integrity .
exchangeRecaptchaEnterpriseToken POST /v1/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
Valida um token de resposta reCAPTCHA Enterprise .
exchangeRecaptchaV3Token POST /v1/{app=projects/*/apps/*}:exchangeRecaptchaV3Token
Valida um token de resposta reCAPTCHA v3 .
exchangeSafetyNetToken
(deprecated)
POST /v1/{app=projects/*/apps/*}:exchangeSafetyNetToken
Valida um token SafetyNet .
generateAppAttestChallenge POST /v1/{app=projects/*/apps/*}:generateAppAttestChallenge
Gera um desafio que protege a integridade de uma chamada imediatamente seguinte para ExchangeAppAttestAttestation ou ExchangeAppAttestAssertion .
generatePlayIntegrityChallenge POST /v1/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
Gera um desafio que protege a integridade de uma solicitação de veredicto de integridade imediatamente seguinte à API Play Integrity.

Recurso REST: v1.projects.apps.appAttestConfig

Métodos
batchGet GET /v1/{parent=projects/*}/apps/-/appAttestConfig:batchGet
Obtém atomicamente os AppAttestConfig s para a lista especificada de aplicativos.
get GET /v1/{name=projects/*/apps/*/appAttestConfig}
Obtém o AppAttestConfig do aplicativo especificado.
patch PATCH /v1/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
Atualiza o AppAttestConfig para o aplicativo especificado.

Recurso REST: v1.projects.apps.debugTokens

Métodos
create POST /v1/{parent=projects/*/apps/*}/debugTokens
Cria um novo DebugToken para o aplicativo especificado.
delete DELETE /v1/{name=projects/*/apps/*/debugTokens/*}
Exclui o DebugToken especificado.
get GET /v1/{name=projects/*/apps/*/debugTokens/*}
Obtém o DebugToken especificado.
list GET /v1/{parent=projects/*/apps/*}/debugTokens
Lista todos DebugToken s para o aplicativo especificado.
patch PATCH /v1/{debugToken.name=projects/*/apps/*/debugTokens/*}
Atualiza o DebugToken especificado.

Recurso REST: v1.projects.apps.deviceCheckConfig

Métodos
batchGet GET /v1/{parent=projects/*}/apps/-/deviceCheckConfig:batchGet
Obtém atomicamente os DeviceCheckConfig s para a lista especificada de aplicativos.
get GET /v1/{name=projects/*/apps/*/deviceCheckConfig}
Obtém o DeviceCheckConfig do aplicativo especificado.
patch PATCH /v1/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
Atualiza o DeviceCheckConfig para o aplicativo especificado.

Recurso REST: v1.projects.apps.playIntegrityConfig

Métodos
batchGet GET /v1/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
Obtém atomicamente os PlayIntegrityConfig s para a lista especificada de aplicativos.
get GET /v1/{name=projects/*/apps/*/playIntegrityConfig}
Obtém o PlayIntegrityConfig do aplicativo especificado.
patch PATCH /v1/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
Atualiza o PlayIntegrityConfig para o aplicativo especificado.

Recurso REST: v1.projects.apps.recaptchaEnterpriseConfig

Métodos
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
Obtém atomicamente os RecaptchaEnterpriseConfig s para a lista especificada de aplicativos.
get GET /v1/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
Obtém o RecaptchaEnterpriseConfig do aplicativo especificado.
patch PATCH /v1/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
Atualiza o RecaptchaEnterpriseConfig para o aplicativo especificado.

Recurso REST: v1.projects.apps.recaptchaV3Config

Métodos
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
Obtém atomicamente os RecaptchaV3Config s para a lista especificada de aplicativos.
get GET /v1/{name=projects/*/apps/*/recaptchaV3Config}
Obtém o RecaptchaV3Config do aplicativo especificado.
patch PATCH /v1/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
Atualiza o RecaptchaV3Config para o aplicativo especificado.

Recurso REST: v1.projects.apps.safetyNetConfig

Métodos
batchGet
(deprecated)
GET /v1/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
Obtém atomicamente os SafetyNetConfig s para a lista especificada de aplicativos.
get
(deprecated)
GET /v1/{name=projects/*/apps/*/safetyNetConfig}
Obtém o SafetyNetConfig do aplicativo especificado.
patch
(deprecated)
PATCH /v1/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
Atualiza o SafetyNetConfig para o aplicativo especificado.

Recurso REST: v1.projects.services

Métodos
batchUpdate POST /v1/{parent=projects/*}/services:batchUpdate
Atualiza atomicamente as configurações Service especificadas.
get GET /v1/{name=projects/*/services/*}
Obtém a configuração Service para o nome de serviço especificado.
list GET /v1/{parent=projects/*}/services
Lista todas as configurações Service do projeto especificado.
patch PATCH /v1/{service.name=projects/*/services/*}
Atualiza a configuração Service especificada.