Method: projects.verifyAppCheckToken

Verifica o token do App Check fornecido e retorna sinais de uso de token que os chamadores podem agir. Atualmente, esse método oferece suporte apenas a tokens do App Check trocados dos seguintes provedores de atestado:

  • API Play Integrity
  • Atestado de aplicativo
  • DeviceCheck (tokens DCDevice )
  • reCAPTCHA Empresarial
  • reCAPTCHA v3
  • Provedores personalizados

Os tokens do App Check trocados de segredos de depuração também são suportados. Chamar esse método em um token do App Check válido com um provedor não compatível fará com que um erro HTTP 400 seja retornado.

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

Observe que se o token do App Check fornecido for inválido, um erro HTTP 403 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 contadas. O uso do token App Check em outro lugar não marcará o token como já consumido.

O chamador deve ter a permissão firebaseappcheck.appCheckTokens.verify para chamar esse método. Essa permissão faz parte da função Firebase App Check Token Verifier .

Solicitação HTTP

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

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
project

string

Obrigatório. O nome relativo do recurso 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 Firebase. Saiba mais sobre como usar identificadores de projeto no padrão AIP 2510 do Google.

Solicitar corpo

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.

Os tokens App Check trocados do provedor SafetyNet não são suportados; um erro HTTP 400 será retornado.

Corpo de resposta

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

Se for bem-sucedido, o corpo da resposta conterá dados com a seguinte estrutura:

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

boolean

Se este token já foi consumido.

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

Observe que se o token do App Check fornecido for inválido, um erro HTTP 403 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 OAuth:

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

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