Firebase App Check API

O Firebase App Check funciona 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 de cliente fornecidas pelo Google. Caso seu aplicativo precise usar suas próprias bibliotecas para chamar esse serviço, use as informações a seguir quando fizer as solicitações da 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 criar bibliotecas de cliente, plug-ins IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. Este serviço apresenta os documentos de descoberta abaixo:

Endpoint de serviço

Um endpoint de serviço é um URL base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários endpoints de serviço. Este serviço tem o endpoint a seguir e todos os URIs abaixo são relativos a ele:

  • 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 (link em inglês) que pode ser usado para verificar os 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 recebido anteriormente de ExchangeAppAttestAttestation e os verifica com a Apple.
exchangeAppAttestAttestation POST /v1beta/{app=oauthClients/*}:exchangeAppAttestAttestation
Aceita um atestado CBOR do App Attest e o verifica com a Apple usando seus IDs de pacote e equipe pré-configurados.
exchangeDebugToken POST /v1beta/{app=oauthClients/*}:exchangeDebugToken
Valida um secret do token de depuração que você criou anteriormente usando CreateDebugToken.
generateAppAttestChallenge POST /v1beta/{app=oauthClients/*}:generateAppAttestChallenge
Gera um desafio que protege a integridade de uma chamada imediata 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 autores da chamada podem aplicar.

Recurso REST: v1beta.projects.apps

Métodos
exchangeAppAttestAssertion POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAssertion
Aceita uma declaração do App Attest e um artefato recebido anteriormente de ExchangeAppAttestAttestation e os verifica com a Apple.
exchangeAppAttestAttestation POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAttestation
Aceita um atestado CBOR do App Attest e o verifica com a Apple usando seus IDs de pacote e equipe pré-configurados.
exchangeCustomToken POST /v1beta/{app=projects/*/apps/*}:exchangeCustomToken
Valida um token personalizado assinado usando as credenciais da conta de serviço do SDK Admin do projeto.
exchangeDebugToken POST /v1beta/{app=projects/*/apps/*}:exchangeDebugToken
Valida um secret do token de depuração que você criou 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 veredito de integridade da Play Integrity.
exchangeRecaptchaEnterpriseToken POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
Valida um token de resposta do 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 imediata para ExchangeAppAttestAttestation ou ExchangeAppAttestAssertion.
generatePlayIntegrityChallenge POST /v1beta/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
Gera um desafio que protege a integridade de uma solicitação de veredito de integridade imediatamente posterior à API Play Integrity.

Recurso REST: v1beta.projects.apps.appAttestConfig

Métodos
batchGet GET /v1beta/{parent=projects/*}/apps/-/appAttestConfig:batchGet
Recebe atomicamente os AppAttestConfigs da lista de apps especificada.
get GET /v1beta/{name=projects/*/apps/*/appAttestConfig}
Recebe o AppAttestConfig do app especificado.
patch PATCH /v1beta/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
Atualiza o AppAttestConfig para o app especificado.

Recurso REST: v1beta.projects.apps.debugTokens

Métodos
create POST /v1beta/{parent=projects/*/apps/*}/debugTokens
Cria um novo DebugToken para o app especificado.
delete DELETE /v1beta/{name=projects/*/apps/*/debugTokens/*}
Exclui o DebugToken especificado.
get GET /v1beta/{name=projects/*/apps/*/debugTokens/*}
Recebe o DebugToken especificado.
list GET /v1beta/{parent=projects/*/apps/*}/debugTokens
Lista todos os DebugTokens do app 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
Recebe atomicamente os DeviceCheckConfigs da lista de apps especificada.
get GET /v1beta/{name=projects/*/apps/*/deviceCheckConfig}
Recebe o DeviceCheckConfig do app especificado.
patch PATCH /v1beta/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
Atualiza o DeviceCheckConfig para o app especificado.

Recurso REST: v1beta.projects.apps.playIntegrityConfig

Métodos
batchGet GET /v1beta/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
Recebe atomicamente os PlayIntegrityConfigs da lista de apps especificada.
get GET /v1beta/{name=projects/*/apps/*/playIntegrityConfig}
Recebe o PlayIntegrityConfig do app especificado.
patch PATCH /v1beta/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
Atualiza o PlayIntegrityConfig para o app especificado.

Recurso REST: v1beta.projects.apps.recaptchaConfig

Métodos
batchGet
(deprecated)
GET /v1beta/{parent=projects/*}/apps/-/recaptchaConfig:batchGet
Recebe atomicamente os RecaptchaConfigs da lista de apps especificada.
get
(deprecated)
GET /v1beta/{name=projects/*/apps/*/recaptchaConfig}
Recebe o RecaptchaConfig do app especificado.
patch
(deprecated)
PATCH /v1beta/{recaptchaConfig.name=projects/*/apps/*/recaptchaConfig}
Atualiza o RecaptchaConfig para o app especificado.

Recurso REST: v1beta.projects.apps.recaptchaEnterpriseConfig

Métodos
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
Recebe atomicamente os RecaptchaEnterpriseConfigs da lista de apps especificada.
get GET /v1beta/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
Recebe o RecaptchaEnterpriseConfig do app especificado.
patch PATCH /v1beta/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
Atualiza o RecaptchaEnterpriseConfig para o app especificado.

Recurso REST: v1beta.projects.apps.recaptchaV3Config

Métodos
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
Recebe atomicamente os RecaptchaV3Configs da lista de apps especificada.
get GET /v1beta/{name=projects/*/apps/*/recaptchaV3Config}
Recebe o RecaptchaV3Config do app especificado.
patch PATCH /v1beta/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
Atualiza o RecaptchaV3Config para o app especificado.

Recurso REST: v1beta.projects.apps.safetyNetConfig

Métodos
batchGet
(deprecated)
GET /v1beta/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
Recebe atomicamente os SafetyNetConfigs da lista de apps especificada.
get
(deprecated)
GET /v1beta/{name=projects/*/apps/*/safetyNetConfig}
Recebe o SafetyNetConfig do app especificado.
patch
(deprecated)
PATCH /v1beta/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
Atualiza o SafetyNetConfig para o app especificado.

Recurso REST: v1beta.projects.services

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

Recurso REST: v1.jwks

Métodos
get GET /v1/{name}
Retorna um conjunto JWK público conforme especificado pela RFC 7517 (link em inglês) que pode ser usado para verificar os 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 recebido anteriormente de ExchangeAppAttestAttestation e os verifica com a Apple.
exchangeAppAttestAttestation POST /v1/{app=projects/*/apps/*}:exchangeAppAttestAttestation
Aceita um atestado CBOR do App Attest e o verifica com a Apple usando seus IDs de pacote e equipe pré-configurados.
exchangeCustomToken POST /v1/{app=projects/*/apps/*}:exchangeCustomToken
Valida um token personalizado assinado usando as credenciais da conta de serviço do SDK Admin do projeto.
exchangeDebugToken POST /v1/{app=projects/*/apps/*}:exchangeDebugToken
Valida um secret do token de depuração que você criou 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 veredito de integridade da Play Integrity.
exchangeRecaptchaEnterpriseToken POST /v1/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
Valida um token de resposta do 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 imediata para ExchangeAppAttestAttestation ou ExchangeAppAttestAssertion.
generatePlayIntegrityChallenge POST /v1/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
Gera um desafio que protege a integridade de uma solicitação de veredito de integridade imediatamente posterior à API Play Integrity.

Recurso REST: v1.projects.apps.appAttestConfig

Métodos
batchGet GET /v1/{parent=projects/*}/apps/-/appAttestConfig:batchGet
Recebe atomicamente os AppAttestConfigs da lista de apps especificada.
get GET /v1/{name=projects/*/apps/*/appAttestConfig}
Recebe o AppAttestConfig do app especificado.
patch PATCH /v1/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
Atualiza o AppAttestConfig para o app especificado.

Recurso REST: v1.projects.apps.debugTokens

Métodos
create POST /v1/{parent=projects/*/apps/*}/debugTokens
Cria um novo DebugToken para o app especificado.
delete DELETE /v1/{name=projects/*/apps/*/debugTokens/*}
Exclui o DebugToken especificado.
get GET /v1/{name=projects/*/apps/*/debugTokens/*}
Recebe o DebugToken especificado.
list GET /v1/{parent=projects/*/apps/*}/debugTokens
Lista todos os DebugTokens do app 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
Recebe atomicamente os DeviceCheckConfigs da lista de apps especificada.
get GET /v1/{name=projects/*/apps/*/deviceCheckConfig}
Recebe o DeviceCheckConfig do app especificado.
patch PATCH /v1/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
Atualiza o DeviceCheckConfig para o app especificado.

Recurso REST: v1.projects.apps.playIntegrityConfig

Métodos
batchGet GET /v1/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
Recebe atomicamente os PlayIntegrityConfigs da lista de apps especificada.
get GET /v1/{name=projects/*/apps/*/playIntegrityConfig}
Recebe o PlayIntegrityConfig do app especificado.
patch PATCH /v1/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
Atualiza o PlayIntegrityConfig para o app especificado.

Recurso REST: v1.projects.apps.recaptchaEnterpriseConfig

Métodos
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
Recebe atomicamente os RecaptchaEnterpriseConfigs da lista de apps especificada.
get GET /v1/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
Recebe o RecaptchaEnterpriseConfig do app especificado.
patch PATCH /v1/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
Atualiza o RecaptchaEnterpriseConfig para o app especificado.

Recurso REST: v1.projects.apps.recaptchaV3Config

Métodos
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
Recebe atomicamente os RecaptchaV3Configs da lista de apps especificada.
get GET /v1/{name=projects/*/apps/*/recaptchaV3Config}
Recebe o RecaptchaV3Config do app especificado.
patch PATCH /v1/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
Atualiza o RecaptchaV3Config para o app especificado.

Recurso REST: v1.projects.apps.safetyNetConfig

Métodos
batchGet
(deprecated)
GET /v1/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
Recebe atomicamente os SafetyNetConfigs da lista de apps especificada.
get
(deprecated)
GET /v1/{name=projects/*/apps/*/safetyNetConfig}
Recebe o SafetyNetConfig do app especificado.
patch
(deprecated)
PATCH /v1/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
Atualiza o SafetyNetConfig para o app especificado.

Recurso REST: v1.projects.services

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