Method: projects.verifyAppCheckToken

Verifica o token do App Check fornecido e retorna sinais de uso de token que os autores da chamada podem agir. No momento, esse método só é compatível com tokens do App Check trocados pelos seguintes provedores de atestado:

  • API Play Integrity
  • Atestado de app
  • DeviceCheck ( DCDevice tokens)
  • reCAPTCHA Enterprise
  • reCAPTCHA v3
  • Provedores personalizados

Os tokens do App Check trocados de secrets de depuração também são compatíveis. Chamar esse método em um token do App Check válido com um provedor sem suporte vai fazer com que um erro HTTP 400 seja retornado.

Retorna se esse token já foi consumido antes da chamada. Se esta for a primeira vez que esse método acessa o token fornecido do App Check, o campo alreadyConsumed na resposta estará ausente. O token fornecido será marcado como alreadyConsumed (definido como true ) para todas as invocações futuras desse método para esse token.

Se o token do App Check fornecido for inválido, um erro HTTP 403 vai ser retornado em vez de um objeto de resposta, independentemente de o token já ter sido consumido.

Atualmente, ao avaliar se um token do App Check já foi consumido, apenas as chamadas para esse método exato são contabilizadas. O uso do token do App Check em outro lugar não vai marcar o token como já consumido.

O autor da chamada precisa ter a permissão firebaseappcheck.appCheckTokens.verify para chamar esse método. Essa permissão faz parte do papel de Verificador de tokens do Firebase App Check .

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
project

string

Obrigatório. O nome de recurso relativo do projeto para o qual o token foi criado, no formato: 

projects/{project_number}

Se necessário, o elemento project_number pode ser substituído pelo ID do projeto do Firebase. Saiba mais sobre como usar identificadores de projeto no padrão AIP 2510 do Google.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "appCheckToken": string
}
Campos
appCheckToken

string

Obrigatório. O token do App Check a ser verificado.

Não há suporte para os tokens do App Check trocados pelo provedor SafetyNet. Um erro HTTP 400 será retornado.

Corpo da resposta

Mensagem de resposta para o método projects.verifyAppCheckToken .

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "alreadyConsumed": boolean
}
Campos
alreadyConsumed

boolean

Se esse token já foi consumido.

Se esta for a primeira vez que esse método acessa o token fornecido do App Check, este campo será omitido da resposta. O token fornecido será marcado como alreadyConsumed (definido como true ) para todas as invocações futuras desse método para esse token.

Se o token do App Check fornecido for inválido, um erro HTTP 403 vai ser retornado em vez de uma resposta contendo esse campo, independentemente de o token já ter sido consumido.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para mais informações, consulte a Visão geral da autenticação .