Method: accounts.signInWithPassword

Faz login de um usuário com e-mail e senha. Se o login for bem-sucedido, um novo token de ID e de atualização do Identity Platform será emitido para o usuário autenticado.

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

Solicitação HTTP

POST https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword

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

Corpo da solicitação

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

Representação JSON 
{
  "email": string,
  "password": string,
  "pendingIdToken": string,
  "captchaChallenge": string,
  "captchaResponse": string,
  "instanceId": string,
  "delegatedProjectNumber": string,
  "idToken": string,
  "returnSecureToken": boolean,
  "tenantId": string,
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion)
}
Campos
email

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

string

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

string
captchaChallenge
(deprecated)

string
captchaResponse

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.
instanceId
(deprecated)

string
delegatedProjectNumber
(deprecated)

string (int64 format)
idToken
(deprecated)

string
returnSecureToken

boolean

Precisa ser sempre verdadeiro.
tenantId

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

enum (ClientType)

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

enum (RecaptchaVersion)

A versão do reCAPTCHA do token reCAPTCHA no captchaResponse.

Corpo da resposta

Mensagem de resposta para accounts.signInWithPassword.

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

Representação JSON 
{
  "kind": string,
  "localId": string,
  "email": string,
  "displayName": string,
  "idToken": string,
  "registered": boolean,
  "profilePicture": string,
  "oauthAccessToken": string,
  "oauthExpireIn": integer,
  "oauthAuthorizationCode": string,
  "refreshToken": string,
  "expiresIn": string,
  "mfaPendingCredential": string,
  "mfaInfo": [
    {
      object (MfaEnrollment)
    }
  ],
  "userNotifications": [
    {
      object (UserNotification)
    }
  ]
}
Campos
kind
(deprecated)

string
localId

string

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

string

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

string

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

string

Um token de ID do Identity Platform para o usuário autenticado.
registered
(deprecated)

boolean

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

string

A foto do perfil do usuário armazenada nos atributos da conta.
oauthAccessToken
(deprecated)

string

O token de acesso OAuth2.
oauthExpireIn
(deprecated)

integer

O tempo de expiração do token de acesso em segundos.
oauthAuthorizationCode
(deprecated)

string
refreshToken

string

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

string (int64 format)

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

string

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

object (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.
userNotifications[]

object (UserNotification)

Notificações de aviso 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.

UserNotification

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

Representação JSON 
{
  "notificationCode": enum (NotificationCode),
  "notificationMessage": string
}
Campos
notificationCode

enum (NotificationCode)

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

string

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

NotificationCode

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

Enums
NOTIFICATION_CODE_UNSPECIFIED Nenhuma notificação especificada.
MISSING_LOWERCASE_CHARACTER A senha não tem um caractere minúsculo.
MISSING_UPPERCASE_CHARACTER A senha não tem caracteres maiúsculos.
MISSING_NUMERIC_CHARACTER A senha não tem um caractere numérico.
MISSING_NON_ALPHANUMERIC_CHARACTER A senha não tem um caractere não alfanumérico.
MINIMUM_PASSWORD_LENGTH A senha é menor que o tamanho mínimo exigido.
MAXIMUM_PASSWORD_LENGTH A senha é maior que o tamanho máximo necessário.