Method: getRecaptchaConfig

Recebe os parâmetros necessários para a análise do reCAPTCHA.

Solicitação HTTP

GET https://identitytoolkit.googleapis.com/v2/recaptchaConfig

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

Parâmetros de consulta

Parâmetros
tenantId

string

O ID de um locatário.
clientType

enum (ClientType)

O reCAPTCHA Enterprise usa chaves de site separadas para diferentes tipos de cliente. Especifique o tipo de cliente para receber a chave correspondente.
version

enum (RecaptchaVersion)

A versão do reCAPTCHA.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Configuração do reCAPTCHA

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

Representação JSON 
{
  "recaptchaEnforcementState": [
    {
      object (RecaptchaEnforcementState)
    }
  ],
  "recaptchaKey": string,
  "useSmsBotScore": boolean,
  "useSmsTollFraudProtection": boolean
}
Campos
recaptchaEnforcementState[]

object (RecaptchaEnforcementState)

O estado de aplicação do reCAPTCHA para os provedores que o GCIP oferece suporte à proteção reCAPTCHA.
recaptchaKey

string

O nome do recurso da chave reCAPTCHA Enterprise, por exemplo, "projects/{project}/keys/{key}". Isso só será retornado quando o estado de aplicação do reCAPTCHA for AUDIT ou ENFORCE em pelo menos um dos provedores do reCAPTCHA.
useSmsBotScore

boolean

Define se a pontuação de bot rCE será usada para o provedor de telefone reCAPTCHA.
useSmsTollFraudProtection

boolean

Indica se a pontuação de risco da proteção contra fraude de cobrança por SMS do rCE é usada para o provedor de telefone do reCAPTCHA.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

RecaptchaEnforcementState

Estados de aplicação para proteção reCAPTCHA.

Representação JSON 
{
  "provider": enum (RecaptchaProvider),
  "enforcementState": enum (EnforcementState)
}
Campos
provider

enum (RecaptchaProvider)

O provedor que tem proteção reCAPTCHA.
enforcementState

enum (EnforcementState)

O estado de aplicação do reCAPTCHA para o provedor.

RecaptchaProvider

Os provedores do GCIP que oferecem suporte à proteção reCAPTCHA.

Enums
RECAPTCHA_PROVIDER_UNSPECIFIED Provedor do reCAPTCHA não especificado
EMAIL_PASSWORD_PROVIDER Provedor de senhas de e-mail
PHONE_PROVIDER Provedor de autenticação por telefone

EnforcementState

Estados de aplicação da proteção reCAPTCHA por provedor.

Enums
ENFORCEMENT_STATE_UNSPECIFIED O estado de restrição não foi definido.
OFF Não aplicada.
AUDIT A avaliação reCAPTCHA é criada, mas o resultado não é usado para aplicar.
ENFORCE A avaliação reCAPTCHA é criada, e o resultado é usado para aplicar.