Method: accounts.signInWithPassword

Permite que un usuario acceda con un correo electrónico y una contraseña. Si el acceso se realiza de forma correcta, se emiten un nuevo token de ID y un token de actualización de Identity Platform para el usuario autenticado.

Se requiere una clave de API en la solicitud para identificar el proyecto de Google Cloud.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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

Obligatorio. El correo electrónico con el que accede el usuario. La longitud del correo electrónico debe ser inferior a 256 caracteres y debe tener el formato name@domain.tld. El correo electrónico también debe coincidir con la producción de addr-spec de la RFC 822.
password

string

Obligatorio. Es la contraseña que proporciona el usuario para acceder a la cuenta.
pendingIdToken
(deprecated)

string
captchaChallenge
(deprecated)

string
captchaResponse

string

Es el token de reCAPTCHA que proporciona la integración del cliente de reCAPTCHA. reCAPTCHA Enterprise lo usa para la evaluación de riesgos. Obligatorio cuando reCAPTCHA Enterprise está habilitado.
instanceId
(deprecated)

string
delegatedProjectNumber
(deprecated)

string (int64 format)
idToken
(deprecated)

string
returnSecureToken

boolean

Siempre debe ser verdadero.
tenantId

string

El ID del grupo de usuarios de Identity Platform al que accede el usuario. Si no se establece, el usuario accederá a la instancia predeterminada de Identity Platform en el proyecto.
clientType

enum (ClientType)

El tipo de cliente, web, Android o iOS. Obligatorio cuando reCAPTCHA Enterprise está habilitado.
recaptchaVersion

enum (RecaptchaVersion)

La versión de reCAPTCHA del token de reCAPTCHA en captchaResponse.

Cuerpo de la respuesta

Mensaje de respuesta para accounts.signInWithPassword.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación 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

El ID del usuario autenticado. Siempre está presente en la respuesta.
email

string

El correo electrónico del usuario autenticado Siempre está presente en la respuesta.
displayName

string

Es el nombre visible del usuario almacenado en los atributos de la cuenta.
idToken

string

Un token de ID de Identity Platform para el usuario autenticado.
registered
(deprecated)

boolean

Indica si el correo electrónico es para una cuenta existente. Siempre es verdadero.
profilePicture

string

La foto de perfil del usuario almacenada en los atributos de la cuenta.
oauthAccessToken
(deprecated)

string

El token de acceso de OAuth2.
oauthExpireIn
(deprecated)

integer

Es la fecha de vencimiento del token de acceso en segundos.
oauthAuthorizationCode
(deprecated)

string
refreshToken

string

Un token de actualización de Identity Platform para el usuario autenticado.
expiresIn

string (int64 format)

Es la cantidad de segundos hasta que vence el token de ID de Identity Platform.
mfaPendingCredential

string

Es una cadena opaca que funciona como prueba de que el usuario aprobó correctamente la autenticación del primer factor.
mfaInfo[]

object (MfaEnrollment)

Información sobre los proveedores de autenticación de varios factores habilitados para la cuenta Se muestra si el usuario necesita completar el acceso con la autenticación de varios factores.
userNotifications[]

object (UserNotification)

Notificaciones de advertencia para el usuario

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

UserNotification

Notificaciones de advertencia para el usuario

Representación JSON 
{
  "notificationCode": enum (NotificationCode),
  "notificationMessage": string
}
Campos
notificationCode

enum (NotificationCode)

Enum de notificación de advertencia. Se puede usar para la localización.
notificationMessage

string

Es la cadena de la notificación de advertencia. Se puede usar como resguardo.

NotificationCode

Enum de notificación de advertencia. Se puede usar para la localización.

Enums
NOTIFICATION_CODE_UNSPECIFIED No se especificó ninguna notificación.
MISSING_LOWERCASE_CHARACTER Falta un carácter en minúscula en la contraseña.
MISSING_UPPERCASE_CHARACTER Falta un carácter en mayúscula en la contraseña.
MISSING_NUMERIC_CHARACTER Falta un carácter numérico en la contraseña.
MISSING_NON_ALPHANUMERIC_CHARACTER Falta un carácter que no sea alfanumérico en la contraseña.
MINIMUM_PASSWORD_LENGTH La contraseña es inferior a la longitud mínima requerida.
MAXIMUM_PASSWORD_LENGTH La contraseña es superior a la longitud máxima requerida.