Package google.cloud.identitytoolkit.v1

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

int32

Obrigatório. O tamanho de hash desejado em bytes. O mínimo é 4 e o máximo é 1.024.

HashType

Obrigatório. Não pode ser HASH_TYPE_UNSPECIFIED.

int32

Obrigatório. O grau de paralelismo, também chamado de linhas de execução ou lanes. O mínimo é 1, e o máximo é 16.

int32

Obrigatório. O número de iterações a serem realizadas. O mínimo é 1, e o máximo é 16.

int32

Obrigatório. O custo de memória em kibibytes. O máximo é 32.768.

Version

A versão do algoritmo Argon2. O padrão é VERSION_13 se não for especificado.

bytes

Os dados associados adicionais, se fornecidos, são anexados ao valor de hash para fornecer uma camada extra de segurança. Uma string codificada em base64, se especificada por JSON.

string

Se tenant_id for especificado, o ID do projeto do Google Cloud ao qual o locatário da Identity Platform pertence. Caso contrário, o ID do projeto do Google Cloud a que as contas pertencem.

A autorização requer a seguinte permissão do IAM no recurso especificado targetProjectId:

• firebaseauth.users.delete

string

Obrigatório. Lista de IDs de usuários a serem excluídos.

bool

Forçar a exclusão de contas que não estão no estado "desativada". Se for falso, apenas as contas desativadas serão excluídas, e as que não estiverem desativadas serão adicionadas ao errors.

string

Se as contas pertencerem a um locatário do Identity Platform, o ID do locatário. Se as contas pertencem a um projeto padrão do Identity Platform, o campo não é necessário.

BatchDeleteErrorInfo

Informações detalhadas sobre erros para contas que não podem ser excluídas.

int32

O índice do item com erro no campo local_ids original.

string

O ID do usuário correspondente.

string

Mensagem de erro detalhada.

string

O identificador de e-mail da conta de usuário para buscar os provedores associados. Pelo menos um dos campos identifier e provider_id precisa ser definido.

O endereço de e-mail precisa ter menos de 256 caracteres e estar no formato name@domain.tld. O endereço de e-mail também precisa corresponder à produção de addr-spec do RFC 822.

string

Um URL válido para o IdP redirecionar o usuário. O URL não pode conter fragmentos ou o parâmetro de consulta state reservado.

string

string

O ID do provedor do provedor de identidade com que o usuário vai fazer login. Esse é um ID de provedor ativado para login, que pode ser da lista de IdPs compatíveis padrão ou do formato oidc.* ou saml.*. Alguns exemplos são google.com, facebook.com, oidc.testapp e saml.testapp. Pelo menos um dos campos identifier e provider_id precisa ser definido.

string

string

Outros escopos do OAuth 2.0 separados por espaços que especificam o escopo da solicitação de autenticação com o IdP. Usado para provedores de identidade do OAuth 2.0.

Para o provedor do Google, o fluxo do código de autorização será usado se esse campo estiver definido.

string

Uma string opaca usada para manter informações contextuais entre a solicitação de autenticação e o callback do IdP.

string

string

string

Usado para o provedor do Google. O domínio hospedado do G Suite do usuário para restringir o login a usuários nesse domínio.

string

Um ID de sessão que pode ser verificado em SignInWithIdp para evitar ataques de fixação de sessão. Se não estiver presente, uma string aleatória será gerada e retornada como o ID da sessão.

string

Usado para o provedor do Google. O tipo de fluxo de autenticação a ser usado. Se presente, deve ser CODE_FLOW para especificar o fluxo do código de autorização. Caso contrário, o fluxo padrão de ID Token será usado.

map<string, string>

Outros parâmetros de consulta personalizados a serem adicionados ao URI de autorização. Os parâmetros a seguir são reservados e não podem ser adicionados: client_id, response_type, scope, redirect_uri e state.

Para o provedor da Microsoft, o locatário do Azure AD para fazer login pode ser especificado no parâmetro personalizado tenant.

string

O ID do locatário do Identity Platform para criar um URI de autorização ou pesquisar um identificador de e-mail. Se não for definido, a operação será realizada na instância padrão do Identity Platform no projeto.

string

string

O URI de autorização para o provedor solicitado. Presente apenas quando um ID do provedor estiver definido na solicitação.

string

bool

Se o identificador de e-mail representa uma conta. Presente apenas quando um identificador de e-mail é definido na solicitação.

string

O ID do provedor da solicitação, se fornecido.

bool

Se o usuário já fez login com o ID do provedor na solicitação. Presente apenas quando um identificador de e-mail registrado é definido na solicitação.

bool

Se um CAPTCHA é necessário porque o usuário fez muitas tentativas de login sem sucesso. Presente apenas quando um identificador de e-mail registrado é definido na solicitação.

string

O ID da sessão da solicitação ou uma string aleatória gerada por CreateAuthUri, se ausente. Ele é usado para evitar ataques de fixação de sessão.

string

A lista de métodos de login que o usuário usou anteriormente. Cada elemento é password, emailLink ou o ID do provedor de um IdP. Presente apenas quando um identificador de e-mail registrado é definido na solicitação. Se a proteção contra enumeração de e-mails estiver ativada, esse método vai retornar uma lista vazia.

string

Obrigatório. Um token de ID do Identity Platform válido.

int64

O número de segundos até o cookie da sessão expirar. Especifique uma duração em segundos, entre cinco minutos e 14 dias.

string

O ID do projeto ao qual a conta pertence.

string

O ID do locatário do Identity Platform ao qual a conta pertence.

string

O cookie de sessão criado com base no token de ID do Identity Platform especificado na solicitação. Ele está na forma de um JSON Web Token (JWT). Sempre presente.

string

O ID da conta de usuário a ser excluída. Para especificar esse campo, é necessário ter uma credencial do Google OAuth 2.0 com as permissões adequadas. As solicitações de usuários sem a credencial precisam transmitir um token de ID.

int64

string

O token de ID do Identity Platform da conta a ser excluída. Exige que seja especificado para solicitações de usuários finais que não têm a credencial do Google OAuth 2.0. As solicitações autenticadas com uma credencial do Google OAuth2 com as permissões adequadas podem transmitir local_id para especificar a conta a ser excluída.

string

O ID do locatário a que a conta pertence, se aplicável. Só é necessário especificar para solicitações autenticadas com uma credencial do Google OAuth 2.0 que especifique o local_id de uma conta que pertence a um locatário da Identity Platform.

string

O ID do projeto ao qual a conta pertence. Só pode ser especificado em solicitações autenticadas que especificam o local_id de uma conta.

A autorização requer a seguinte permissão do IAM no recurso especificado targetProjectId:

• firebaseauth.users.delete

string

int64

string

O token de paginação da resposta de uma solicitação anterior.

int32

O número máximo de resultados a serem retornados. Precisa ser maior ou igual a 1 e menor que 1.000. O padrão é 20.

string

Se tenant_id for especificado, o ID do projeto do Google Cloud ao qual o locatário da Identity Platform pertence. Caso contrário, o ID do projeto do Google Cloud a que as contas pertencem.

A autorização requer a seguinte permissão do IAM no recurso especificado targetProjectId:

• firebaseauth.users.get

string

O ID do locatário do Identity Platform ao qual as contas pertencem. Se não for especificado, as contas no projeto do Identity Platform serão retornadas.

string

UserInfo

Todas as contas pertencentes ao projeto/inquilino limitadas por max_results na solicitação.

string

Se houver mais contas para download, um token que pode ser transmitido de volta para DownloadAccount para receber mais contas. Caso contrário, o campo fica em branco.

string

Endereço de e-mail para onde a verificação de MFA será enviada.

bool

Indica se o modelo está desativado. Se definido como "true", um modelo padrão será usado.

string

Endereço de e-mail de origem

string

Corpo do e-mail

string

Assunto do e-mail

string

Do nome de exibição

EmailBodyFormat

Formato do corpo do e-mail

string

Endereço para resposta

string

Parte local do endereço "De"

string

O valor está no formato de código de idioma III (por exemplo, "zh-CN", "es"). Os separadores '-' e '_' são aceitos.

bool

Se o corpo ou o assunto do e-mail é personalizado.

int32

O índice do item, o intervalo é [0, request.size - 1]

string

Mensagem de erro detalhada

string

O token de ID do Identity Platform da conta a ser buscado. Exija que seja especificado para solicitações de usuários finais.

string

O ID de uma ou mais contas a serem buscadas. Só pode ser especificado por solicitações autenticadas com uma credencial do Google OAuth 2.0 com permissões adequadas.

string

O endereço de e-mail de uma ou mais contas a serem buscadas. O e-mail precisa ter menos de 256 caracteres e estar no formato name@domain.tld. O e-mail também precisa corresponder à produção de addr-spec do RFC 822. Só pode ser especificado por solicitações autenticadas de um desenvolvedor.

int64

string

O número de telefone de uma ou mais contas a serem buscadas. Só pode ser especificado por solicitações autenticadas de um desenvolvedor e precisa estar no formato E.164, por exemplo, +15555555555.

FederatedUserIdentifier

string

O ID do locatário ao qual a conta pertence. Só pode ser especificado por solicitações autenticadas de um desenvolvedor.

string

O ID do projeto do Google Cloud ao qual a conta ou o locatário do Identity Platform especificado por tenant_id pertence. Só pode ser especificado por solicitações autenticadas com uma credencial do Google OAuth 2.0 com permissões adequadas.

A autorização requer a seguinte permissão do IAM no recurso especificado targetProjectId:

• firebaseauth.users.get

string

O e-mail inicial de uma ou mais contas a serem extraídas. O e-mail precisa ter menos de 256 caracteres e estar no formato name@domain.tld. O e-mail também precisa corresponder à produção de addr-spec do RFC 822. Só pode ser especificado por solicitações autenticadas de um desenvolvedor.

string

O ID dos provedores de identidade compatíveis. Esse é um ID de provedor ativado para login, que pode ser da lista de IDPs compatíveis padrão ou do formato oidc.* ou saml.*. Alguns exemplos são google.com, facebook.com, oidc.testapp e saml.testapp.

string

O ID do usuário da conta no provedor de identidade de terceiros especificado por provider_id.

string

UserInfo

As informações de contas de usuário específicas que correspondem aos parâmetros da solicitação.

OobReqType

Obrigatório. O tipo de código fora da banda (OOB) a ser enviado. Dependendo desse valor, outros campos da solicitação serão obrigatórios e/ou terão significados diferentes. Há quatro códigos OOB diferentes que podem ser enviados: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL

string

O endereço de e-mail da conta para onde o código OOB será enviado e, geralmente, o endereço de e-mail da conta que precisa ser atualizado. Obrigatório para PASSWORD_RESET, EMAIL_SIGNIN e VERIFY_EMAIL. Só é necessário para solicitações VERIFY_AND_CHANGE_EMAIL quando return_oob_link é definido como verdadeiro. Nesse caso, é o e-mail original do usuário.

string

string

Para uma solicitação PASSWORD_RESET, uma resposta do reCaptcha é necessária quando o sistema detecta uma possível atividade de abuso. Nesses casos, essa é a resposta do desafio reCaptcha usado para verificar o autor da chamada.

string

O endereço IP do autor da chamada. Obrigatório apenas para solicitações PASSWORD_RESET.

string

O endereço de e-mail para o qual a conta está sendo atualizada. Obrigatório apenas para solicitações VERIFY_AND_CHANGE_EMAIL.

string

Um token de ID para a conta. Ele é necessário para solicitações VERIFY_AND_CHANGE_EMAIL e VERIFY_EMAIL, a menos que return_oob_link seja definido como verdadeiro.

string

O URL para continuar depois que o usuário clicar no link enviado por e-mail. Esse é o URL que permite que o widget da Web processe o código OOB.

string

Se um app iOS associado puder processar o código OOB, o ID do pacote iOS desse app. Isso permitirá que o app correto seja aberto se já estiver instalado.

string

Se um app iOS associado puder processar o código OOB, o ID da App Store desse app. Isso permitirá que a App Store abra o app correto se ele ainda não estiver instalado.

string

Se um app Android associado puder processar o código OOB, o nome do pacote do app Android que vai processar o callback quando esse código OOB for usado. Isso vai permitir que o app correto seja aberto se já estiver instalado ou que a Google Play Store abra o app correto se ele ainda não estiver instalado.

bool

Se um app Android associado puder processar o código OOB, ele vai decidir se vai instalar ou não o app Android no dispositivo em que o link é aberto, caso ele ainda não esteja instalado.

string

Se um app Android associado puder processar o código OOB, a versão mínima do app. Se a versão no dispositivo for anterior a essa versão, o usuário será direcionado para a Google Play Store para atualizar o app.

bool

Quando definido como "verdadeiro", o link do código OOB será enviado como um link universal ou um link do app Android e será aberto pelo app correspondente, se instalado. Se não for definido ou for definido como "false", o código OOB será enviado primeiro ao widget da Web e, em seguida, redirecionado para o app, se instalado.

string

O ID do locatário do Identity Platform ao qual a conta pertence.

string

O ID do projeto do Identity Platform ao qual a conta pertence. Para especificar esse campo, é necessária uma credencial do Google OAuth 2.0 com as permissões adequadas.

A autorização requer a seguinte permissão do IAM no recurso especificado targetProjectId:

• firebaseauth.users.sendEmail

string

Para garantir que o URL usado possa ser aberto facilmente no iOS ou no Android, criamos um link dinâmico do Firebase. A maioria dos projetos da Identity Platform só tem um domínio de link dinâmico ativado e pode deixar esse campo em branco. Esse campo contém um domínio de link dinâmico especificado para projetos que têm vários domínios ativados.

bool

Se o link de confirmação com o código OOB precisa ser retornado na resposta (nenhum e-mail é enviado). Usado quando um desenvolvedor quer criar e enviar o modelo de e-mail por conta própria. Por padrão, esse valor é falso. Para especificar esse campo e definir como verdadeiro, é necessária uma credencial do Google OAuth 2.0 com as permissões adequadas.

ClientType

O tipo de cliente: Web, Android ou iOS. Obrigatório quando a proteção do reCAPTCHA Enterprise está ativada.

RecaptchaVersion

A versão reCAPTCHA do token reCAPTCHA em captcha_response.

string

Opcional. Para garantir que o URL usado possa ser aberto facilmente no iOS ou Android, criamos um link de hospedagem "/__/auth/links". Esse campo opcional contém o domínio a ser usado na criação de um link do Hosting. Se não for definido, o domínio .firebaseapp.com será usado.

string

string

Se return_oob_link for verdadeiro na solicitação, o código OOB a ser enviado.

string

Se return_oob_link for falso na solicitação, o endereço de e-mail para o qual a verificação foi enviada.

string

Se return_oob_link for verdadeiro na solicitação, o link OOB será enviado ao usuário. Isso retorna o link criado, incluindo os parâmetros relacionados ao Firebase Dynamic Link.

int64

Número do projeto da solicitação de projeto delegada. Esse campo só deve ser usado como parte da migração do Firebase V1.

int64

Número do projeto da configuração a ser recuperada. Este campo foi descontinuado e não deve ser usado por novas integrações.

bool

Se o link dinâmico precisa ser retornado.

string

Nome do pacote Android a ser verificado com o nome real do pacote Android. Se esse campo for fornecido e sha1_cert_hash não for, a ação vai gerar um erro se ele não corresponder ao nome real do pacote Android.

string

ID do pacote do iOS para verificar o ID do pacote do iOS real. Se esse campo for fornecido, a ação vai gerar um erro se ele não corresponder ao ID real do pacote do iOS.

string

O ID do cliente OAuth do RP. Se definido, uma verificação será realizada para garantir que o cliente OAuth seja válido para o projeto recuperado e que a solicitação seja rejeitada com um erro do cliente, se não for válido.

string

Hash do certificado do aplicativo Android SHA-1. Se definido, uma verificação será realizada para garantir que o hash do certificado seja válido para o projeto recuperado e para android_package_name.

string

O ID do app do Firebase, para aplicativos que usam o Firebase. Você pode encontrar essa informação no Console do Firebase do seu projeto. Se definido, uma verificação será realizada para garantir que o ID do app seja válido para o projeto recuperado. Se não for válido, a solicitação será rejeitada com um erro do cliente.

string

O ID do projeto da configuração recuperada.

string

Chave da API Google Cloud. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

bool

Define se é possível fazer o registro de contas de senha. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

IdpConfig

Configuração do provedor OAuth2. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

string

Domínios autorizados para redirecionamento de widgets.

bool

Indica se o usuário anônimo está ativado. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

string

O domínio do Firebase Dynamic Links usado para criar links de redirecionamento para apps nativos.

bool

Se é possível usar o envio de e-mails. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

EmailTemplate

Modelo de e-mail para redefinir a senha. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

EmailTemplate

Modelo de e-mail para verificação de e-mail. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

EmailTemplate

Modelo de e-mail para mudança de e-mail. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

EmailTemplate

Modelo de e-mail de redefinição de senha para o app Firebase V1 legado. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

EmailTemplate

Modelo de e-mail para reverter adição de segundo fator. Esse campo só é retornado para chamadas autenticadas de um desenvolvedor.

string

string

string

A chave do site do reCAPTCHA v2 usada para invocar o serviço reCAPTCHA. Sempre presente.

string

O número do projeto do produtor usado para gerar tokens de PIA

OpenIdConnectKey

Chaves públicas do signatário do cookie de sessão, formatadas como chaves JSON da Web (JWKs).

Provider

bool

Verdadeiro se permite que o usuário faça login com o provedor.

int32

Porcentagem de usuários que vão receber uma solicitação/redirecionamento de login federado para esse IdP

string

ID do cliente OAuth2.

string

Secret de cliente OAuth2.

string

IDs de cliente na lista de permissões para verificação de público-alvo.

string

Identificador da parte confiável, que é o público-alvo da SAMLResponse emitida.

string

O token de ID do Identity Platform. Ele será verificado e convertido em uma nova SAMLResponse.

string

O ID da entidade do app SAML especificado no Google Admin Console para cada app. Se os desenvolvedores quiserem redirecionar para um app de terceiros em vez de um app do G Suite, provavelmente vão precisar disso. Quando ele é usado, retornamos um RelayState. Isso inclui uma SAMLRequest, que pode ser usada para acionar um fluxo SAML iniciado pelo SP para redirecionar ao app real.

string

SAMLResponse assinada criada para a parte confiável.

string

O endpoint do ACS que consome a SAMLResponse retornada.

string

RelayState gerado.

string

E-mail do usuário.

string

Nome do usuário.

string

Sobrenome do usuário.

bool

Indica se o usuário conectado foi criado por essa solicitação.

string

ID dessa opção de MFA.

string

Nome de exibição para essa opção de MFA, por exemplo, "celular corporativo".

Timestamp

Carimbo de data/hora em que a conta registrou esse segundo fator.

string

Normalmente, isso mostra o número de telefone associado a essa inscrição. Em algumas situações, como após uma primeira etapa de login, só será mostrada a versão ofuscada do número de telefone associado.

TotpInfo

Contém informações específicas sobre a MFA TOTP.

EmailInfo

Contém informações específicas sobre a MFA por e-mail.

string

Apenas saída. phone_info não ofuscado.

string

Tipo de chave.

string

Algoritmo de assinatura.

string

Uso da chave.

string

String exclusiva para identificar essa chave.

string

Modulus para a chave pública RSA, representado como a codificação base64url da representação big-endian do valor.

string

Expoente para a chave pública RSA, representado como a codificação base64url da representação big-endian do valor.

string

O ID do provedor de identidade.

string

O nome de exibição do usuário no provedor de identidade.

string

O URL da foto do perfil do usuário no provedor de identidade.

string

O identificador do usuário no provedor de identidade.

string

O endereço de e-mail do usuário no provedor de identidade.

string

O identificador bruto do usuário retornado diretamente pelo provedor de identidade.

string

O screen_name do usuário no Twitter ou o nome de login no GitHub.

string

O número de telefone do usuário no provedor de identidade.

bool

Se for true, a solicitação vai retornar as contas que correspondem à consulta. Se false, apenas o número de contas que correspondem à consulta será retornado. O padrão é true.

int64

O número máximo de contas a serem retornadas com um limite máximo de 500. O padrão é 500. Válido apenas quando return_user_info for definido como true.

int64

O número de contas a pular desde o início dos registros correspondentes. Válido apenas quando return_user_info for definido como true.

SortByField

Order

string

O ID do projeto ao qual o resultado está vinculado.

A autorização requer a seguinte permissão do IAM no recurso especificado targetProjectId:

• firebaseauth.users.get

string

O ID do locatário para o qual o resultado é aplicado.

SqlExpression

string

Uma string sem distinção entre maiúsculas e minúsculas que deve corresponder ao e-mail da conta. Somente um dos parâmetros email, phone_number ou user_id pode ser especificado em uma SqlExpression. Se mais de um for especificado, apenas o primeiro (nessa ordem) será aplicado.

string

Uma string que o ID local da conta precisa corresponder. Apenas um dos parâmetros email, phone_number ou user_id pode ser especificado em uma SqlExpression. Se mais de um for especificado, apenas o primeiro (nessa ordem) será aplicado.

string

Uma string que precisa corresponder ao número de telefone da conta. Somente um dos parâmetros email, phone_number ou user_id pode ser especificado em uma SqlExpression. Se mais de um for especificado, apenas o primeiro (nessa ordem) será aplicado.

int64

Se return_user_info na solicitação for verdadeiro, esse será o número de contas retornadas nesta mensagem. Caso contrário, esse é o número total de contas que correspondem à consulta.

UserInfo

Se return_user_info na solicitação for verdadeiro, essas são as contas que correspondem à consulta.

string

Um código fora de banda (OOB, na sigla em inglês) gerado pela solicitação GetOobCode. Especifique apenas esse parâmetro (ou apenas esse parâmetro e um ID de locatário) para receber o tipo de código fora da banda na resposta sem mudar o estado da conta. Somente um código PASSWORD_RESET fora da banda pode ser consumido por esse método.

string

A nova senha que será definida para essa conta. A especificação desse campo resultará em uma mudança na conta e consumirá o código fora da banda, se um tiver sido especificado e for do tipo PASSWORD_RESET.

string

A senha atual da conta que será modificada. Especifique esse e-mail para mudar a senha de uma conta sem usar um código externo.

string

Opcional. O e-mail da conta que será modificado. Especifique esse código e a senha antiga para mudar a senha de uma conta sem usar um código externo.

string

Opcional. O ID do locatário do Identity Platform ao qual a conta pertence.

string

string

O e-mail associado ao código fora da banda que foi usado.

string

OobReqType

MfaEnrollment

string

O número de telefone para o qual o código de verificação será enviado no formato E.164.

string

Recebimento de confirmação de validação do token do app iOS. Pelo menos um dos seguintes valores (ios_receipt e ios_secret), recaptcha_token ou safety_net_token precisa ser especificado para verificar se o código de verificação está sendo enviado em nome de um app real e não de um emulador, se 'captcha_response' não for usado (o reCAPTCHA Enterprise não estiver ativado). Isso precisa vir da resposta de [verifyIosClient][v1.accounts.verifyIosClient]. Se estiver presente, o autor da chamada também precisará fornecer o ios_secret, bem como um ID de pacote no cabeçalho x-ios-bundle-identifier, que precisa corresponder ao ID de pacote da solicitação [verifyIosClient][v1.accounts.verifyIosClient].

string

Secret enviado ao app iOS como uma notificação push. Precisa ser transmitida com um ios_receipt e o cabeçalho x-ios-bundle-identifier.

string

Token reCAPTCHA para verificação de apps. Pelo menos um dos seguintes (ios_receipt e ios_secret), recaptcha_token ou safety_net_token precisa ser especificado para verificar se o código de verificação está sendo enviado em nome de um app real e não de um emulador, se 'captcha_response' não for usado (o reCAPTCHA Enterprise não estiver ativado). A reCaptcha precisa ser gerada chamando [getRecaptchaParams][v1.getRecaptchaParams], e o token da reCaptcha será gerado quando o usuário concluir o desafio da reCaptcha.

string

ID do locatário do Identity Platform em que o usuário está fazendo login.

AutoRetrievalInfo

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

string

Somente no Android. Usado para declarar a identidade do aplicativo no lugar de um token de reCaptcha. Pelo menos um dos seguintes valores (ios_receipt e ios_secret), recaptcha_token ou safety_net_token precisa ser especificado para verificar se o código de verificação está sendo enviado em nome de um app real e não de um emulador, se 'captcha_response' não for usado (o reCAPTCHA Enterprise não estiver ativado). 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.

string

Somente no Android. Usado para declarar a identidade do aplicativo no lugar de um token recaptcha (e safety_net_token). Pelo menos um dos seguintes (ios_receipt e ios_secret), recaptcha_token ou play_integrity_token precisa ser especificado para verificar se o código de verificação está sendo enviado em nome de um app real e não de um emulador, se 'captcha_response' não for usado (o reCAPTCHA Enterprise não estiver ativado). 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.

string

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

ClientType

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

RecaptchaVersion

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

string

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

string

Informações da sessão criptografada. Ele pode ser usado em [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber] para autenticar o número de telefone.

string

Um token de ID do Identity Platform válido. Obrigatório ao tentar mudar informações relacionadas ao usuário.

string

O ID do usuário. Para especificar esse campo, é necessário ter uma credencial do Google OAuth 2.0 com as permissões adequadas. Para solicitações de usuários finais, um token de ID precisa ser transmitido.

string

O novo nome de exibição do usuário a ser atualizado nos atributos da conta. O nome de exibição precisa ter menos de 256 caracteres.

string

O novo e-mail do usuário que será atualizado nos atributos da conta. O e-mail precisa ter menos de 256 caracteres e estar no formato name@domain.tld. O e-mail também precisa corresponder à produção de addr-spec do RFC 822. Se a proteção contra enumeração de e-mails estiver ativada, o usuário não poderá mudar o e-mail sem verificar o endereço primeiro, mas um administrador poderá fazer isso.

string

A nova senha do usuário para ser atualizada nos atributos da conta. A senha precisa ter pelo menos seis caracteres.

string

Os provedores de identidade aos quais a conta precisa estar associada.

string

O código fora da banda que será aplicado na conta do usuário. Os seguintes tipos de código fora da banda são aceitos: * VERIFY_EMAIL * RECOVER_EMAIL * REVERT_SECOND_FACTOR_ADDITION * VERIFY_AND_CHANGE_EMAIL

bool

Indica se o e-mail do usuário foi verificado. Para especificar esse campo, é necessário ter uma credencial do Google OAuth 2.0 com as permissões adequadas.

bool

Se a conta precisa ser restrita ao uso apenas do login federado.

string

string

A resposta do teste reCAPTCHA. Isso é necessário quando o sistema detecta possíveis atividades de abuso.

int64

Especifica o carimbo de data/hora mínimo em segundos para que um token de ID do Identity Platform seja considerado válido.

bool

Se for verdadeiro, marca a conta como desativada, o que significa que o usuário não poderá mais fazer login.

string

int64

string

O novo URL da foto do usuário para a foto do perfil da conta ser atualizada nos atributos da conta. O URL precisa ter menos de 2.048 caracteres.

UserAttributeName

bool

Indica se é necessário retornar um ID e atualizar o token. Precisa ser sempre verdadeiro.

string

Os provedores de identidade a serem desvinculados da conta do usuário.

int64

O carimbo de data/hora em milissegundos da última vez que a conta fez login.

int64

O carimbo de data/hora em milissegundos em que a conta foi criada.

string

O número de telefone que será atualizado nos atributos da conta.

string

Atributos personalizados formatados em JSON para serem armazenados no token de ID do Identity Platform. A especificação desse campo requer uma credencial do Google OAuth 2.0 com as permissões adequadas.

string

O ID do locatário do Identity Platform a que a conta pertence. As solicitações de usuários finais precisam transmitir um token de ID do Identity Platform em vez de definir esse campo.

string

O ID do projeto ao qual a conta pertence. A especificação desse campo exige uma credencial do Google OAuth 2.0 com as permissões adequadas. As solicitações de usuários finais precisam transmitir um token de ID do Identity Platform.

A autorização requer a seguinte permissão do IAM no recurso especificado targetProjectId:

• firebaseauth.users.update

MfaInfo

As informações relacionadas à autenticação multifator que serão definidas na conta do usuário. Isso vai substituir todas as informações anteriores relacionadas à autenticação multifator na conta. Para especificar esse campo, é necessário ter uma credencial do Google OAuth 2.0 com as permissões adequadas.

ProviderUserInfo

O provedor a ser vinculado à conta do usuário. Para especificar esse campo, é necessário ter uma credencial do Google OAuth 2.0 com as permissões adequadas.

MfaEnrollment

Os segundos fatores que o usuário registrou.

string

string

O ID do usuário autenticado.

string

O endereço de e-mail da conta.

string

O nome de exibição da conta.

string

Um token de ID do Identity Platform para a conta. É usado para a inscrição de usuários legados.

ProviderUserInfo

Os provedores de identidade vinculados à conta.

string

O novo e-mail definido nos atributos da conta do usuário.

string

O URL da foto do usuário para a foto do perfil da conta.

string

Um token de atualização para a conta. É usado para a inscrição de usuários legados.

int64

O número de segundos até o token de ID do Identity Platform expirar.

string

Obsoleto. No momento, nenhum hash de senha real é retornado.

bool

Se o e-mail da conta foi verificado.

string

Obrigatório. O token de autenticação personalizado declarado pelo desenvolvedor. O token precisa ser um token da Web JSON (JWT) que inclua as declarações listadas na referência da API na seção "Declarações de token personalizadas".

string

bool

Precisa ser sempre verdadeiro.

int64

string

O ID do locatário do Identity Platform em que o usuário está fazendo login. Se estiver presente, o ID precisa corresponder ao tenant_id no token.

string

string

Um token de ID do Identity Platform para o usuário autenticado.

string

Um token de atualização do Identity Platform para o usuário autenticado.

int64

O número de segundos até o token de ID expirar.

bool

Informa se o usuário autenticado foi criado por essa solicitação.

string

Obrigatório. O código fora de banda do link do e-mail.

string

Obrigatório. O endereço de e-mail para o qual o link de login foi enviado. O e-mail precisa ter menos de 256 caracteres e estar no formato name@domain.tld. O e-mail também precisa corresponder à produção de addr-spec do RFC 822.

string

Um token de ID válido para uma conta do Identity Platform. Se for aprovado, essa solicitação vai vincular o endereço de e-mail ao usuário representado por esse token de ID e ativar o login com o link de e-mail na conta no futuro.

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.

string

string

Um token de ID do Identity Platform para o usuário autenticado.

string

O e-mail usado para fazer login. Sempre presente na resposta.

string

Token de atualização para o usuário autenticado.

int64

O número de segundos até o token de ID expirar.

string

O ID do usuário autenticado. Sempre presente na resposta.

bool

Informa se o usuário autenticado foi criado por essa solicitação.

string

Uma string opaca que funciona como prova de que o usuário passou na verificação do primeiro fator.

MfaEnrollment

Informações sobre quais provedores de autenticação multifator estão ativados. Apresente se o usuário precisar concluir o login usando a autenticação multifator.

string

Obrigatório. O ID do player do Game Center do usuário. Descontinuado pela Apple.

Transmita playerID com gamePlayerID e teamPlayerID para iniciar a migração do ID do jogador do Game Center de um usuário para gamePlayerID.

string

Obrigatório. O URL para buscar a chave pública da Apple e verificar se a assinatura foi assinada pela Apple.

string

Obrigatório. Os dados de assinatura de verificação gerados pela Apple.

string

Obrigatório. Uma string aleatória usada para gerar a assinatura.

int64

Obrigatório. O momento em que a assinatura foi criada pela Apple, em milissegundos desde a época.

string

Um token de ID válido para uma conta do Identity Platform. Se presente, essa solicitação vai vincular o ID do jogador do Game Center à conta representada por esse token de ID.

string

O nome de exibição do usuário no Game Center.

string

O ID do locatário do Identity Platform em que o usuário está fazendo login.

string

O ID do jogador da equipe do Game Center do usuário. Um identificador exclusivo de um jogador de todos os jogos que você distribui usando sua conta de desenvolvedor. https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid

string

O ID do jogador do jogo do Game Center do usuário. Um identificador exclusivo para um jogador do jogo. https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid

string

O ID do usuário autenticado. Sempre presente na resposta.

string

O ID do player do Game Center do usuário.

Transmita playerID com gamePlayerID e teamPlayerID para iniciar a migração do ID do jogador do Game Center de um usuário para gamePlayerID.

string

Um token de ID do Identity Platform para o usuário autenticado.

string

Um token de atualização do Identity Platform para o usuário autenticado.

int64

O número de segundos até o token de ID expirar.

bool

Indica se o usuário conectado foi criado por essa solicitação.

string

Nome de exibição do usuário autenticado.

string

O ID do jogador da equipe do Game Center do usuário. Um identificador exclusivo de um jogador de todos os jogos que você distribui usando sua conta de desenvolvedor. https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid

string

O ID do jogador do jogo do Game Center do usuário. Um identificador exclusivo para um jogador do jogo. https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid

string

Obrigatório. O URL para o qual o IdP redireciona o usuário. Ele pode ser definido como http://localhost se o usuário estiver fazendo login com uma credencial de IdP fornecida manualmente.

string

Se o usuário estiver fazendo login com uma resposta de autorização obtida por uma solicitação de autorização CreateAuthUri anterior, este será o corpo do callback POST HTTP do IdP, se presente.

Caso contrário, se o usuário estiver fazendo login com uma credencial de IdP fornecida manualmente, ela precisa ser um formulário codificado em URL que contenha a credencial (por exemplo, um token de ID ou de acesso para IdPs do OAuth 2.0) e o ID do provedor do IdP que emitiu a credencial.

Por exemplo, se o usuário fizer login no provedor do Google usando um token de ID do Google, ele será definido como id_token=[GOOGLE_ID_TOKEN]&providerId=google.com, em que [GOOGLE_ID_TOKEN] será substituído pelo token de ID do Google.

Se o usuário estiver fazendo login no provedor do Facebook usando um token de autenticação do Facebook, ele precisa ser definido como id_token=[FACEBOOK_AUTHENTICATION_TOKEN]&providerId=facebook. com&nonce= [NONCE], em que [FACEBOOK_AUTHENTICATION_TOKEN] precisa ser substituído pelo token de autenticação do Facebook. O nonce é necessário para validar o token. A solicitação vai falhar se nenhum valor de uso único for fornecido.

Se o usuário estiver fazendo login no provedor do Facebook usando um token de acesso do Facebook, ele precisa ser definido como access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=facebook. com, em que [FACEBOOK_ACCESS_TOKEN] precisa ser substituído pelo token de acesso do Facebook.

Se o usuário estiver fazendo login no provedor do Twitter usando uma credencial do Twitter OAuth 1.0, ela precisa ser definida como access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret= [TWITTER_TOKEN_SECRET]&providerId=twitter.com, em que [TWITTER_ACCESS_TOKEN] e [TWITTER_TOKEN_SECRET] precisam ser substituídos pelo token de acesso e pela chave secreta do Twitter OAuth, respectivamente.

string

bool

Indica se é necessário retornar o token de atualização do OAuth do provedor de identidade, se disponível.

string

O ID da sessão retornado de uma chamada CreateAuthUri anterior. Esse campo é verificado com esse ID para evitar ataques de fixação de sessão. Obrigatório se o usuário estiver fazendo login com uma resposta de autorização de uma solicitação de autorização CreateAuthUri anterior.

int64

string

Um token de ID do Identity Platform válido. Se for aprovado, a conta do usuário no IdP será vinculada à conta representada por esse token de identificação.

bool

Precisa ser sempre verdadeiro.

bool

Define se as credenciais do OAuth do provedor de identidade serão retornadas ou não nos seguintes erros: FEDERATED_USER_ID_ALREADY_LINKED e EMAIL_EXISTS.

bool

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.

string

Uma string opaca de uma resposta anterior do SignInWithIdp. Se definido, pode ser usado para repetir a operação de login da operação SignInWithIdp anterior. Isso pode acontecer se o usuário precisar confirmar as informações da conta como parte de uma tentativa anterior de login federado ou realizar a vinculação da conta.

string

O ID da conta do usuário no IdP. Sempre presente na resposta.

string

O ID do provedor do IdP em que o usuário está fazendo login. Sempre presente na resposta.

string

O endereço de e-mail da conta do usuário no IdP.

bool

Indica se o endereço de e-mail da conta de usuário foi verificado.

string

O nome da conta do usuário no IdP.

string

O nome completo da conta do usuário no IdP.

string

O sobrenome da conta do usuário no IdP.

string

O apelido da conta do usuário no IdP.

string

A preferência de idioma da conta do usuário no IdP.

string

O fuso horário da conta do usuário no IdP.

string

O URL da foto do perfil do usuário no IdP.

string

A data de nascimento da conta do usuário no IdP.

string

string

O endereço de e-mail principal (de nível superior) da conta do usuário no Identity Platform, se for diferente do endereço de e-mail no IdP. Só aparece quando a configuração "Uma conta por endereço de e-mail" está ativada.

string

O ID do usuário autenticado do Identity Platform. Sempre presente na resposta.

bool

Se há ou não uma conta de usuário do Identity Platform com o mesmo endereço de e-mail, mas vinculada a uma conta diferente no mesmo IdP. Só aparece quando a configuração "Uma conta por endereço de e-mail" está ativada e o endereço de e-mail no IdP está verificado.

string

O nome de exibição da conta do usuário no IdP.

string

Um token de ID do Identity Platform para o usuário autenticado.

string

A string opaca definida em CreateAuthUri, que é usada para manter informações contextuais entre a solicitação de autenticação e o callback do IdP.

string

Uma lista de IDs de provedores em que o usuário pode fazer login para resolver um erro need_confirmation. Só aparece se need_confirmation estiver definido como true.

bool

Se existe ou não uma conta de usuário do Identity Platform com o mesmo endereço de e-mail da conta atual conectada no IdP e se o endereço de e-mail da conta não está verificado no IdP. O usuário precisa fazer login na conta do Identity Platform e vincular a credencial atual do IdP a ela. Só aparece quando a configuração "Uma conta por endereço de e-mail" está ativada.

string

O token de acesso do OAuth do provedor de identidade, se disponível.

string

O token de atualização OAuth 2.0 do provedor de identidade, se disponível e return_refresh_token estiver definido como true.

int32

O número de segundos até o token de acesso OAuth do IdP expirar.

string

O código de autorização OAuth 2.0, se disponível. Presente apenas para o provedor do Google.

bool

string

O secret do token OAuth 1.0 do provedor de identidade, se disponível. Presente apenas para o provedor do Twitter.

string

Um token de atualização do Identity Platform para o usuário autenticado.

int64

O número de segundos até o token de ID do Identity Platform expirar.

string

O token de ID do OpenID Connect do IdP, se disponível.

string

O nome de exibição da conta do usuário no IdP do Twitter ou o nome de login da conta do usuário no IdP do GitHub.

string

A resposta JSON em string que contém todos os dados correspondentes à conta do usuário no IdP.

string

A mensagem de erro retornada se return_idp_credential for definido como true e o erro FEDERATED_USER_ID_ALREADY_LINKED ou EMAIL_EXISTS for encontrado. O valor desse campo é FEDERATED_USER_ID_ALREADY_LINKED ou EMAIL_EXISTS.

bool

Se uma nova conta do Identity Platform foi criada para o usuário autenticado.

string

string

Uma string opaca que pode ser usada como uma credencial do IdP em que o usuário está fazendo login. O token pendente recebido aqui pode ser definido em uma futura solicitação SignInWithIdp para fazer login do mesmo usuário com o IdP novamente.

string

O valor do campo tenant_id na solicitação.

string

Uma string opaca que funciona como prova de que o usuário passou pela autenticação do primeiro fator.

MfaEnrollment

Informações sobre quais provedores de autenticação multifator estão ativados para a conta. Apresente se o usuário precisar concluir o login usando a autenticação multifator.

string

Obrigatório. O e-mail que o usuário está acessando. O e-mail precisa ter menos de 256 caracteres e estar no formato name@domain.tld. O e-mail também precisa corresponder à produção de addr-spec do RFC 822.

string

Obrigatório. A senha que o usuário fornece para fazer login na conta.

string

string

string

O token reCAPTCHA fornecido pela integração do reCAPTCHA no lado do cliente. O reCAPTCHA Enterprise o usa para avaliação de risco. Obrigatório quando o reCAPTCHA Enterprise está ativado.

string

int64

string

bool

Precisa ser sempre verdadeiro.

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 na instância padrão do Identity Platform no projeto.

ClientType

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

RecaptchaVersion

A versão reCAPTCHA do token reCAPTCHA em captcha_response.

string

string

O ID do usuário autenticado. Sempre presente na resposta.

string

O e-mail do usuário autenticado. Sempre presente na resposta.

string

O nome de exibição do usuário armazenado nos atributos da conta.

string

Um token de ID do Identity Platform para o usuário autenticado.

bool

Se o e-mail é de uma conta atual. Sempre verdadeiro.

string

A foto do perfil do usuário armazenada nos atributos da conta.

string

O token de acesso OAuth2.

int32

O tempo de expiração do token de acesso em segundos.

string

string

Um token de atualização do Identity Platform para o usuário autenticado.

int64

O número de segundos até o token de ID do Identity Platform expirar.

string

Uma string opaca que funciona como prova de que o usuário passou pela autenticação do primeiro fator.

MfaEnrollment

Informações sobre quais provedores de autenticação multifator estão ativados para a conta. Apresente se o usuário precisar concluir o login usando a autenticação multifator.

UserNotification

Notificações de aviso para o usuário.

string

Informações da sessão criptografada da resposta de [sendVerificationCode][v1.accounts.sendVerificationCode]. No caso de autenticação com um código de SMS, isso precisa ser especificado, mas no caso de usar uma prova temporária, não é necessário.

string

O número de telefone do usuário para fazer login. Isso é necessário no caso de uso de um comprovante temporário, que precisa corresponder ao número de telefone autenticado na solicitação que gerou o comprovante temporário. Esse campo é ignorado se as informações da sessão forem transmitidas.

string

Código de verificação inserido pelo usuário em um SMS enviado para o smartphone dele.

string

Uma prova da verificação do número de telefone, fornecida por uma solicitação anterior de [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber]. Se ele for transmitido, o autor da chamada também precisará transmitir o campo phone_number com o número de telefone verificado na solicitação anterior.

string

Não use.

string

Um token de ID válido para uma conta do Identity Platform. Se for transmitida, essa solicitação vai vincular o número de telefone ao usuário representado por esse token de ID se o número de telefone não estiver em uso ou vai fazer a autenticação novamente se o número de telefone já estiver vinculado ao usuário.

VerifyOp

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.

string

Token de ID do Identity Platform para o usuário autenticado.

string

Token de atualização para o usuário autenticado.

int64

O número de segundos até o token de ID expirar.

string

O ID do usuário autenticado. Presente no caso de uma autenticação bem-sucedida. Se o telefone puder ser verificado, mas a operação da conta não puder ser realizada, uma prova temporária será enviada.

bool

Informa se o usuário autenticado foi criado por essa solicitação.

string

Uma prova da verificação do número de telefone, fornecida se uma autenticação de telefone for bem-sucedida, mas a operação do usuário falhar. Isso acontece quando a solicitação tenta vincular um número de telefone a um usuário com um token de ID ou fazer uma nova autenticação com um token de ID, mas o número de telefone está vinculado a um usuário diferente.

string

Não use.

int64

Não use.

string

Número de telefone do usuário autenticado. Sempre presente na resposta.

int64

O número de segundos até a expiração do documento temporário.

string

O e-mail a ser atribuído ao usuário criado. O e-mail precisa ter menos de 256 caracteres e estar no formato name@domain.tld. O e-mail também precisa corresponder à produção de addr-spec do RFC 822. Um usuário anônimo será criado se não for fornecido.

string

A senha a ser atribuída ao usuário criado. A senha precisa ter pelo menos seis caracteres. Se definido, o campo email também precisa ser definido.

string

O nome de exibição do usuário a ser criado.

string

string

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

string

string

Um token de ID válido para um usuário do Identity Platform. Se definido, essa solicitação vai vincular a credencial de autenticação ao usuário representado por esse token de ID. Para uma solicitação que não seja de administrador, os campos email e password precisam ser definidos. Para uma solicitação de administrador, local_id não pode ser definido.

bool

Indica se o e-mail do usuário foi verificado. A especificação desse campo exige uma credencial do Google OAuth 2.0 com as permissões adequadas.

string

O URL da foto do perfil do usuário a ser criado.

bool

Indica se o usuário será desativado após a criação. As contas desativadas ficam inacessíveis, exceto para solicitações com uma credencial do Google OAuth2 com as permissões adequadas.

string

O ID do usuário a ser criado. O ID precisa ser exclusivo no projeto em que o usuário está sendo criado. A especificação desse campo exige uma credencial do Google OAuth 2.0 com as permissões adequadas.

string

O número de telefone do usuário a ser criado. A especificação desse campo exige uma credencial do Google OAuth 2.0 com as permissões adequadas.

string

O ID do locatário do Identity Platform para criar um usuário. Se não for definido, o usuário será criado no projeto padrão do Identity Platform.

string

O ID do projeto ao qual o usuário precisa pertencer. A especificação desse campo exige uma credencial do Google OAuth 2.0 com as permissões adequadas. Se não for definido, o projeto de destino será inferido do escopo associado ao token de acesso Bearer.

MfaFactor

Os provedores de autenticação multifator que o usuário vai criar.

ClientType

O tipo de cliente: Web, Android ou iOS. Obrigatório ao ativar a proteção do reCAPTCHA Enterprise.

RecaptchaVersion

A versão reCAPTCHA do token reCAPTCHA em captcha_response.

string

Nome de exibição para essa opção de MFA, por exemplo, "celular corporativo".

string

Número de telefone para receber o OTP para MFA.

string

string

Um token de ID do Identity Platform para o usuário criado. Esse campo é definido apenas para solicitações que não são de administrador.

string

O nome de exibição do usuário criado.

string

O e-mail do usuário criado.

string

Um token de atualização do Identity Platform para o usuário criado. Esse campo é definido apenas para solicitações que não são de administrador.

int64

O número de segundos até o token de ID expirar.

string

O ID do usuário criado. Sempre presente na resposta.

string

Obrigatório. A função de hash usada para gerar o hash das senhas da conta. Deve ser um dos seguintes: * HMAC_SHA256 * HMAC_SHA1 * HMAC_MD5 * SCRYPT * PBKDF_SHA1 * MD5 * HMAC_SHA512 * SHA1 * BCRYPT * PBKDF2_SHA256 * SHA256 * SHA512 * STANDARD_SCRYPT * ARGON2

bytes

A chave do signatário usada para gerar o hash da senha. Obrigatório para as seguintes funções de hash: * SCRYPT, * HMAC_MD5, * HMAC_SHA1, * HMAC_SHA256, * HMAC_SHA512

bytes

Um ou mais bytes a serem inseridos entre o sal e a senha de texto simples. Para maior segurança, esse caractere precisa ser único e não imprimível.

int32

O número de rodadas usadas para o cálculo de hash. Necessário apenas para as seguintes funções de hash: * MD5 * SHA1 * SHA256 * SHA512 * PBKDF_SHA1 * PBKDF2_SHA256 * SCRYPT

int32

Custo de memória para cálculo de hash. Obrigatório apenas quando a função de hash é SCRYPT.

UserInfo

Uma lista de contas para fazer upload. local_id é obrigatório para cada usuário. Todos os outros são opcionais.

int64

bool

Se verdadeiro, o serviço vai fazer a seguinte lista de verificações antes de fazer o upload de uma conta: * E-mails duplicados * IDs federados duplicados * Validação do provedor de ID federado Se a duplicação existir na lista de contas a serem enviadas, o upload de toda a lista será impedido. Se o e-mail ou o ID federado for uma cópia de um usuário que já está no projeto/inquilino, a conta não será enviada, mas o restante das contas não será afetado. Se for falso, essas verificações serão ignoradas.

string

O ID do projeto do Identity Platform ao qual a conta pertence.

A autorização requer a seguinte permissão do IAM no recurso especificado targetProjectId:

• firebaseauth.users.create

bool

Se é necessário substituir uma conta no Identity Platform por uma local_id correspondente na solicitação. Se verdadeiro, a conta atual será substituída. Se for "false", um erro será retornado.

int32

O parâmetro de custo de memória da CPU a ser usado pela função de hash STANDARD_SCRYPT. Esse parâmetro, junto com "block_size" e "cpu_mem_cost", ajuda a ajustar os recursos necessários para gerar um hash de uma senha e deve ser ajustado à medida que as velocidades do processador e as tecnologias de memória avançam.

int32

O parâmetro de custo de paralelização a ser usado pela função de hash STANDARD_SCRYPT. Esse parâmetro, junto com block_size e cpu_mem_cost, ajuda a ajustar os recursos necessários para gerar um hash de uma senha e deve ser ajustado à medida que as velocidades do processador e as tecnologias de memória avançam.

int32

O parâmetro de tamanho de bloco usado pela função de hash STANDARD_SCRYPT. Esse parâmetro, junto com a paralelização e cpu_mem_cost, ajuda a ajustar os recursos necessários para gerar uma senha e deve ser ajustado à medida que as velocidades do processador e as tecnologias de memória avançam.

int32

O comprimento de chave desejado para a função de hash STANDARD_SCRYPT. Precisa ser pelo menos 1.

PasswordHashOrder

string

O ID do locatário do Identity Platform ao qual a conta pertence.

Argon2Parameters

Os parâmetros do algoritmo de hash Argon2.

string

ErrorInfo

Informações detalhadas sobre erros de contas que não podem ser enviadas.

string

Imutável. O ID exclusivo da conta.

string

O endereço de e-mail da conta. O e-mail precisa ter menos de 256 caracteres e estar no formato name@domain.tld. O e-mail também precisa corresponder ao addr-spec do RFC 822.

string

O nome de exibição da conta. Esse atributo de conta não é usado pela Identity Platform. Ele está disponível apenas para fins informativos.

string

Apenas saída. A preferência de idioma da conta. Esse atributo de conta não é usado pela Identity Platform. Ele está disponível apenas para fins informativos.

string

O URL da foto do perfil da conta. Esse atributo de conta não é usado pela Identity Platform. Ele está disponível apenas para fins informativos.

string

Apenas saída. A preferência de fuso horário da conta. Esse atributo de conta não é usado pela Identity Platform. Ele está disponível apenas para fins informativos.

string

Apenas saída. A data de nascimento definida para a conta. Esse atributo de conta não é usado pela Identity Platform. Ele está disponível apenas para fins informativos.

bytes

A senha com hash da conta. Somente acessível por solicitações com uma credencial do Google OAuth2 com as permissões adequadas.

bytes

O sal da senha da conta. Somente acessível por solicitações com uma credencial do Google OAuth2 com as permissões adequadas.

int32

A versão da senha da conta. Somente acessível por solicitações com uma credencial OAuth2 do Google com as permissões adequadas.

bool

Se o endereço de e-mail da conta foi verificado.

double

O carimbo de data/hora, em milissegundos desde a época de 1970-01-01T00:00:00Z, quando a senha da conta foi atualizada pela última vez.

ProviderUserInfo

Informações sobre o usuário fornecidas por vários provedores de identidade.

int64

Carimbo de data/hora mais antigo, em segundos desde a época, em que um token de ID precisa ser considerado válido. Todos os tokens de identificação emitidos antes desse período são considerados inválidos.

bool

Se a conta está desativada. As contas desativadas ficam inacessíveis, exceto para solicitações com uma credencial do Google OAuth2 com as permissões adequadas.

int64

A última vez, em milissegundos desde a época, em que essa conta fez login.

int64

O horário, em milissegundos desde o início, em que a conta foi criada.

string

Apenas saída. O nome de exibição da conta no Twitter ou o nome de login no GitHub.

bool

Apenas saída. Indica se a conta foi autenticada usando SignInWithCustomToken.

string

Somente entrada. Senha de texto simples usada para atualizar a senha de uma conta. Esse campo só é usado como entrada em uma solicitação. O Identity Platform usa hash criptograficamente seguro ao gerenciar senhas e nunca armazena ou transmite a senha de um usuário em texto simples.

string

O número de telefone da conta.

string

Declarações personalizadas a serem adicionadas a todos os tokens de ID criados para a conta. Deve ter no máximo 1.000 caracteres e estar no formato JSON válido.

bool

Apenas saída. Se a conta pode ser autenticada com o link de e-mail.

string

É o ID do locatário a que esta conta pertence. Defina apenas se a conta pertencer a um locatário.

MfaEnrollment

Informações sobre quais provedores de autenticação multifator estão ativados para essa conta.

string

O primeiro endereço de e-mail associado a esta conta. O e-mail inicial da conta não pode ser alterado depois de definido e é usado para recuperar o acesso a essa conta caso ele seja perdido pelo fluxo RECOVER_EMAIL no GetOobCode. Precisa corresponder ao addr-spec do RFC 822.

Timestamp

Carimbo de data/hora em que um token de ID foi criado pela última vez para essa conta.

NotificationCode

Enum de notificação de aviso. Pode ser usado para localização.

string

String de notificação de aviso. Pode ser usado como substituto.

string

Um token de dispositivo que o cliente iOS recebe após se registrar no APNs (serviço de notificação push da Apple).

bool

Indica se o token do app está no sandbox do iOS. Se for falso, o token do app está no ambiente de produção.

string

Confirmação de validação do token do app.

int64

Tempo sugerido que o cliente deve esperar em segundos para o envio da notificação push.