Package google.cloud.identitytoolkit.v2

Índice

AccountManagementService

Gerenciamento de contas do Identity Toolkit

FinalizeMfaEnrollment

rpc FinalizeMfaEnrollment(FinalizeMfaEnrollmentRequest) returns (FinalizeMfaEnrollmentResponse)

Conclui o registro de um segundo fator para o usuário.

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.
StartMfaEnrollment

rpc StartMfaEnrollment(StartMfaEnrollmentRequest) returns (StartMfaEnrollmentResponse)

Etapa 1 do processo de registro do MFA. No caso do SMS, um código de verificação é enviado ao usuário.

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.
WithdrawMfa

rpc WithdrawMfa(WithdrawMfaRequest) returns (WithdrawMfaResponse)

Revoga um segundo fator dos segundos fatores registrados de uma conta.

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.

AuthenticationService

Autenticação para o Identity Toolkit

FinalizeMfaSignIn

rpc FinalizeMfaSignIn(FinalizeMfaSignInRequest) returns (FinalizeMfaSignInResponse)

Verifica o desafio de MFA e faz o login

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.
GetPasswordPolicy

rpc GetPasswordPolicy(GetPasswordPolicyRequest) returns (PasswordPolicy)

Recebe a configuração da política de senha definida no projeto ou locatário.

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.
GetRecaptchaConfig

rpc GetRecaptchaConfig(GetRecaptchaConfigRequest) returns (RecaptchaConfig)

Recebe os parâmetros necessários para a análise 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.
RevokeToken

rpc RevokeToken(RevokeTokenRequest) returns (RevokeTokenResponse)

Revoga o token de um usuário de um provedor de identidade (IdP). Isso é feito fornecendo manualmente uma credencial de IdP e os tipos de token para revogação.

Uma chave de API é necessária na solicitação para identificar o projeto do Google Cloud.

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.
StartMfaSignIn

rpc StartMfaSignIn(StartMfaSignInRequest) returns (StartMfaSignInResponse)

Envia o desafio de MFA

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.

AutoRetrievalInfo

As informações necessárias para recuperar automaticamente um SMS.

Campos
app_signature_hash

string

O hash da assinatura do app Android para a API SMS Retriever do Google Play Service.

ClientType

O tipo de plataforma do cliente: Web, Android ou iOS.

Enums
CLIENT_TYPE_UNSPECIFIED O tipo de cliente não foi especificado.
CLIENT_TYPE_WEB O tipo de cliente é "Web".
CLIENT_TYPE_ANDROID O tipo de cliente é "android".
CLIENT_TYPE_IOS O tipo de cliente é ios.

FinalizeMfaEnrollmentRequest

Conclui o registro de um segundo fator para o usuário.

Campos
id_token

string

Obrigatório. Token de ID.
display_name

string

Nome de exibição inserido pelos usuários para distinguir entre diferentes segundos fatores com o mesmo tipo ou diferentes tipos.
tenant_id

string

O ID do locatário do Identity Platform ao qual o usuário que está registrando a MFA pertence. Se não for definido, o usuário pertence ao projeto padrão do Identity Platform.
Campo de união verification_info. Informações de registro de MFA para verificação. verification_info pode ser apenas de um dos tipos a seguir:
phone_verification_info

FinalizeMfaPhoneRequestInfo

Informações de verificação para autorizar o envio de um SMS para a verificação por telefone.
totp_verification_info

FinalizeMfaTotpEnrollmentRequestInfo

Informações de verificação para TOTP.

FinalizeMfaEnrollmentResponse

Resposta FinalizeMfaEnrollment.

Campos
id_token

string

O token de identificação foi atualizado para refletir a inscrição no MFA.
refresh_token

string

O token de atualização foi atualizado para refletir a inscrição no MFA.
Campo de união auxiliary_auth_info. Informações de registro verificadas pela autenticação multifator. auxiliary_auth_info pode ser apenas de um dos tipos a seguir:
phone_auth_info

FinalizeMfaPhoneResponseInfo

Informações de autenticação auxiliares específicas para a autenticação por telefone.
totp_auth_info

FinalizeMfaTotpEnrollmentResponseInfo

Informações de autenticação auxiliares específicas para a autenticação TOTP.

FinalizeMfaPhoneRequestInfo

Informações de verificação de telefone para uma solicitação de FinalizeMfa.

Campos
session_info

string

Uma string opaca que representa a sessão de inscrição.
code

string

Código de verificação inserido pelo usuário.
android_verification_proof

string

Somente no Android. Usos para a verificação "instantânea" do número de telefone pelo GmsCore.
phone_number

string

Obrigatório se o comprovante de verificação do Android for apresentado.

FinalizeMfaPhoneResponseInfo

Informações de verificação por telefone para uma resposta FinalizeMfa.

Campos
android_verification_proof

string

Somente no Android. Substituição de longa duração para código válido vinculado ao dispositivo Android.
android_verification_proof_expire_time

Timestamp

Somente no Android. Tempo de expiração do comprovante de verificação em segundos.
phone_number

string

Para a prova de verificação do Android.

FinalizeMfaSignInRequest

Conclui o login verificando o desafio de MFA.

Campos
mfa_pending_credential

string

Obrigatório. Credencial pendente do primeiro fator de login.
tenant_id

string

O ID do locatário do Identity Platform em que o usuário está fazendo login. Se não for definido, o usuário vai fazer login no projeto padrão do Identity Platform.
mfa_enrollment_id

string

O ID de registro da MFA da lista de registros atuais da MFA do usuário.
Campo de união verification_info. Prova de conclusão do desafio de MFA. verification_info pode ser apenas de um dos tipos a seguir:
phone_verification_info

FinalizeMfaPhoneRequestInfo

Prova de conclusão do desafio de MFA com base em SMS.
totp_verification_info

MfaTotpSignInRequestInfo

Prova de conclusão do teste de MFA baseado em TOTP.

FinalizeMfaSignInResponse

Resposta de FinalizeMfaSignIn.

Campos
id_token

string

Token de ID do usuário autenticado.
refresh_token

string

Token de atualização para o usuário autenticado.
Campo de união auxiliary_auth_info. Informações de login verificadas pela MFA. auxiliary_auth_info pode ser apenas de um dos tipos a seguir:
phone_auth_info

FinalizeMfaPhoneResponseInfo

Informações extras de autenticação do smartphone, incluindo comprovante de verificação do Android.

FinalizeMfaTotpEnrollmentRequestInfo

Informações da solicitação de MFA específicas para a autenticação TOTP para FinalizeMfa.

Campos
session_info

string

Uma string opaca que representa a sessão de inscrição.
verification_code

string

Código de verificação inserido pelo usuário.

FinalizeMfaTotpEnrollmentResponseInfo

Esse tipo não tem campos.

Informações de resposta da MFA específicas para a autenticação TOTP para FinalizeMfa.

GetPasswordPolicyRequest

A solicitação para GetPasswordPolicy.

Campos
tenant_id

string

O ID de um locatário.

GetRecaptchaConfigRequest

A solicitação para GetRecaptchaConfig.

Campos
tenant_id

string

O ID de um locatário.
client_type

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

RecaptchaVersion

A versão do reCAPTCHA.

MfaTotpSignInRequestInfo

Informações de verificação de TOTP para FinalizeMfaSignInRequest.

Campos
verification_code

string

Código de verificação inserido pelo usuário.

PasswordPolicy

Configuração da política de senha.

Campos
custom_strength_options

CustomStrengthOptions

As opções de nível de segurança personalizadas aplicadas pela política de senha.
schema_version

int32

Apenas saída. Número da versão do esquema para a política de senha
allowed_non_alphanumeric_characters[]

string

Apenas saída. Caracteres permitidos que atendem ao requisito não_alfanumérico.
enforcement_state

EnforcementState

Apenas saída. Qual modo de aplicação usar para a política de senha.
force_upgrade_on_signin

bool

Os usuários precisam ter uma senha que siga a política de senhas para fazer login.

CustomStrengthOptions

Opções de nível de segurança personalizadas para aplicar às senhas dos usuários.

Campos
min_password_length

int32

Tamanho mínimo da senha. Varia de 6 a 30
max_password_length

int32

Tamanho máximo da senha. Não há duração máxima padrão
contains_lowercase_character

bool

A senha precisa ter uma letra minúscula.
contains_uppercase_character

bool

A senha precisa ter uma letra maiúscula.
contains_numeric_character

bool

A senha precisa conter um número.
contains_non_alphanumeric_character

bool

A senha precisa conter um caractere não alfanumérico.

EnforcementState

Estado de aplicação da política de senha

Enums
ENFORCEMENT_STATE_UNSPECIFIED O estado de restrição não foi definido.
OFF A política de senhas não será usada no projeto.
ENFORCE As senhas que não estiverem em compliance com a política de senha serão rejeitadas com um erro.

RecaptchaConfig

Configuração do reCAPTCHA

Campos
recaptcha_enforcement_state[]

RecaptchaEnforcementState

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

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.
use_sms_bot_score

bool

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

bool

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.

RecaptchaEnforcementState

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

Campos
provider

RecaptchaProvider

O provedor que tem proteção reCAPTCHA.
enforcement_state

EnforcementState

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

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.

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

RecaptchaVersion

A versão do reCAPTCHA.

Enums
RECAPTCHA_VERSION_UNSPECIFIED A versão do reCAPTCHA não foi especificada.
RECAPTCHA_ENTERPRISE O reCAPTCHA Enterprise.

RevokeTokenRequest

Mensagem de solicitação para RevokeToken.

Campos
provider_id

string

Obrigatório. O provedor de idp do token. Atualmente, só oferece suporte ao Apple IdP. O formato precisa ser "apple.com".
token_type

TokenType

Obrigatório. O tipo de token a ser revogado.
token

string

Obrigatório. O token a ser revogado. Se um authorization_code for transmitido, a API vai trocar o código por um token de acesso e revogar o token trocado.
id_token

string

Obrigatório. Um token de ID do Identity Platform válido para vincular a conta. Se houver uma solicitação de revogação de token bem-sucedida na conta e nenhum token for gerado após a revogação, as solicitações duplicadas serão ignoradas e retornadas imediatamente.
tenant_id

string

O ID do locatário do Identity Platform em que o usuário está fazendo login. Se não for definido, o usuário vai fazer login no projeto padrão do Identity Platform.
redirect_uri

string

O URI de redirecionamento fornecido na solicitação de autorização inicial feita pelo cliente ao IdP. O URI precisa usar o protocolo HTTPS, incluir um nome de domínio e não pode conter um endereço IP ou localhost. Obrigatório se token_type for CODE.

TokenType

O tipo de token a ser revogado.

Enums
TOKEN_TYPE_UNSPECIFIED Valor padrão. Não use.
REFRESH_TOKEN O tipo de token é "refresh_token".
ACCESS_TOKEN O tipo de token é access_token.
CODE O tipo de token é authorization_code.

RevokeTokenResponse

Esse tipo não tem campos.

Mensagem de resposta para RevokeToken. Vazio por enquanto.

StartMfaEnrollmentRequest

Envia um SMS de verificação de inscrição de MFA para um usuário.

Campos
id_token

string

Obrigatório. Token de ID do usuário.
tenant_id

string

O ID do locatário do Identity Platform ao qual o usuário que está registrando a MFA pertence. Se não for definido, o usuário pertence ao projeto padrão do Identity Platform.
Campo de união enrollment_info. Informações de MFA por tipo de segundo fator. enrollment_info pode ser apenas de um dos tipos a seguir:
phone_enrollment_info

StartMfaPhoneRequestInfo

Informações de verificação para autorizar o envio de um SMS para a verificação por telefone.
totp_enrollment_info

StartMfaTotpEnrollmentRequestInfo

Informações de login específicas para a autenticação TOTP.

StartMfaEnrollmentResponse

Resposta StartMfaEnrollment.

Campos
Campo de união enrollment_response. Resposta de início da inscrição da MFA por tipo de segundo fator. enrollment_response pode ser apenas de um dos tipos a seguir:
phone_session_info

StartMfaPhoneResponseInfo

Informações de verificação para autorizar o envio de um SMS para a verificação por telefone.
totp_session_info

StartMfaTotpEnrollmentResponseInfo

Informações de resposta de registro específicas para a autenticação TOTP.

StartMfaPhoneRequestInfo

Informações de verificação de app para uma solicitação de StartMfa.

Campos
phone_number

string

Obrigatório para inscrição. Número de telefone a ser registrado como MFA.
ios_receipt

string

Somente para iOS. Recebimento de confirmação de validação do token do app com APNS.
ios_secret

string

Somente para iOS. Secret entregue ao app iOS por APNS.
recaptcha_token

string

Somente na Web. Solução reCAPTCHA.
auto_retrieval_info

AutoRetrievalInfo

Somente no Android. Usado pelo Google Play Services para identificar o app para recuperação automática.
safety_net_token

string

Somente no Android. Usado para declarar a identidade do aplicativo no lugar de um token de reCaptcha. Um token da SafetyNet pode ser gerado pela API SafetyNet Attestation para Android, com a codificação Base64 do campo phone_number como o valor de uso único.
play_integrity_token

string

Somente no Android. Usado para declarar a identidade do aplicativo no lugar de um token de reCaptcha (ou token de segurança). Um token de integridade pode ser gerado pela API Play Integrity com a aplicação do SHA256 ao campo phone_number como o valor de uso único.
captcha_response

string

O token reCAPTCHA Enterprise fornecido pela integração do reCAPTCHA no lado do cliente. Obrigatório quando o reCAPTCHA Enterprise está ativado.
client_type

ClientType

O tipo de cliente, Web, Android ou iOS. Obrigatório quando o reCAPTCHA Enterprise está ativado.
recaptcha_version

RecaptchaVersion

A versão reCAPTCHA do token reCAPTCHA em captcha_response. Obrigatório quando o reCAPTCHA Enterprise está ativado.

StartMfaPhoneResponseInfo

Informações de verificação de número de telefone para uma resposta do StartMfa.

Campos
session_info

string

Uma string opaca que representa a sessão de inscrição.

StartMfaSignInRequest

Inicia o login multifator enviando o desafio de autenticação multifator.

Campos
mfa_pending_credential

string

Obrigatório. Credencial pendente do primeiro fator de login.
mfa_enrollment_id

string

Obrigatório. ID da inscrição da MFA na lista de inscrições atuais da MFA do usuário.
tenant_id

string

O ID do locatário do Identity Platform em que o usuário está fazendo login. Se não for definido, o usuário vai fazer login no projeto padrão do Identity Platform.
Campo de união sign_in_info. Informações de MFA por tipo de segundo fator. sign_in_info pode ser apenas de um dos tipos a seguir:
phone_sign_in_info

StartMfaPhoneRequestInfo

Informações de verificação para autorizar o envio de um SMS para a verificação por telefone.

StartMfaSignInResponse

Resposta StartMfaSignIn.

Campos
Campo de união response_info. A autenticação multifator inicia a resposta de login pelo segundo tipo de fator. response_info pode ser apenas de um dos tipos a seguir:
phone_response_info

StartMfaPhoneResponseInfo

Informações da sessão de autenticação multifator específicas para segundo fatores do tipo SMS. Além do código único recuperado do SMS enviado, o conteúdo das informações da sessão precisa ser transmitido para FinalizeMfaSignIn para concluir o login.

StartMfaTotpEnrollmentRequestInfo

Esse tipo não tem campos.

Informações da solicitação de MFA específicas para a autenticação TOTP para StartMfa.

StartMfaTotpEnrollmentResponseInfo

Informações de resposta da MFA específicas para a autenticação TOTP para StartMfa.

Campos
shared_secret_key

string

Uma string codificada em base 32 que representa o segredo TOTP compartilhado.

A codificação de base 32 é a especificada pela RFC4648#section-6. Ela é igual à codificação Base32 da RFC3548#section-5.
verification_code_length

int32

A extensão do código de verificação que precisa ser gerado.
hashing_algorithm

string

O algoritmo de hash usado para gerar o código de verificação.
period_sec

int32

Duração em segundos em que o código de verificação vai mudar.
session_info

string

Uma string codificada que representa a sessão de inscrição.
finalize_enrollment_time

Timestamp

O horário em que a inscrição precisa ser concluída.

WithdrawMfaRequest

Cancela a MFA.

Campos
id_token

string

Obrigatório. Token de ID do usuário.
mfa_enrollment_id

string

Obrigatório. ID de registro de MFA de uma inscrição de MFA atual.
tenant_id

string

O ID do locatário do Identity Platform ao qual o usuário que está desativando o MFA pertence. Se não for definido, o usuário pertence ao projeto padrão do Identity Platform.

WithdrawMfaResponse

Cancela a resposta da MultiFactorAuth.

Campos
id_token

string

O ID token foi atualizado para refletir a remoção do segundo fator.
refresh_token

string

O token de atualização foi atualizado para refletir a remoção do segundo fator.