Method: accounts.signInWithPassword

Connecte un utilisateur avec une adresse e-mail et un mot de passe. Si la connexion réussit, un nouveau jeton d'ID Identity Platform et un nouveau jeton d'actualisation sont émis pour l'utilisateur authentifié.

Une clé API est requise dans la requête pour identifier le projet Google Cloud.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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)
}
Champs
email

string

Obligatoire. Adresse e-mail avec laquelle l'utilisateur se connecte. L'e-mail doit comporter moins de 256 caractères et être au format name@domain.tld. L'adresse e-mail doit également correspondre à la production d'adresses RFC 822.
password

string

Obligatoire. Mot de passe fourni par l'utilisateur pour se connecter au compte.
pendingIdToken
(deprecated)

string
captchaChallenge
(deprecated)

string
captchaResponse

string

Jeton reCAPTCHA fourni par l'intégration côté client de reCAPTCHA. reCAPTCHA Enterprise l'utilise pour l'évaluation des risques. Obligatoire lorsque reCAPTCHA Enterprise est activé.
instanceId
(deprecated)

string
delegatedProjectNumber
(deprecated)

string (int64 format)
idToken
(deprecated)

string
returnSecureToken

boolean

Doit toujours être défini sur "true".
tenantId

string

ID du locataire Identity Platform auquel l'utilisateur se connecte. Si ce paramètre n'est pas défini, l'utilisateur se connectera à l'instance Identity Platform par défaut du projet.
clientType

enum (ClientType)

Type de client (Web, Android ou iOS) Obligatoire lorsque reCAPTCHA Enterprise est activé.
recaptchaVersion

enum (RecaptchaVersion)

Version reCAPTCHA du jeton reCAPTCHA dans captchaResponse.

Corps de la réponse

Message de réponse pour accounts.signInWithPassword.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation 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)
    }
  ]
}
Champs
kind
(deprecated)

string
localId

string

ID de l'utilisateur authentifié. Toujours présent dans la réponse.
email

string

Adresse e-mail de l'utilisateur authentifié. Toujours présent dans la réponse.
displayName

string

Nom à afficher de l'utilisateur stocké dans les attributs du compte.
idToken

string

Jeton d'ID Identity Platform de l'utilisateur authentifié.
registered
(deprecated)

boolean

Indique si l'adresse e-mail est associée à un compte existant. Toujours vrai.
profilePicture

string

Photo de profil de l'utilisateur stockée dans les attributs du compte.
oauthAccessToken
(deprecated)

string

Le jeton d'accès OAuth2.
oauthExpireIn
(deprecated)

integer

Délai d'expiration du jeton d'accès, en secondes.
oauthAuthorizationCode
(deprecated)

string
refreshToken

string

Jeton d'actualisation Identity Platform de l'utilisateur authentifié.
expiresIn

string (int64 format)

Nombre de secondes avant l'expiration du jeton d'ID Identity Platform.
mfaPendingCredential

string

Chaîne opaque qui sert de preuve que l'utilisateur a réussi l'authentification par premier facteur.
mfaInfo[]

object (MfaEnrollment)

Informations sur les fournisseurs d'authentification multifacteur activés pour le compte. Présent si l'utilisateur doit se connecter à l'aide de l'authentification multifacteur.
userNotifications[]

object (UserNotification)

Notifications d'avertissement pour l'utilisateur.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez Authentication Overview.

UserNotification

Notifications d'avertissement pour l'utilisateur.

Représentation JSON 
{
  "notificationCode": enum (NotificationCode),
  "notificationMessage": string
}
Champs
notificationCode

enum (NotificationCode)

Enumération des notifications d'avertissement. Peut être utilisé pour la localisation.
notificationMessage

string

Chaîne de notification d'avertissement. Peut être utilisé comme solution de secours.

NotificationCode

Enumération des notifications d'avertissement. Peut être utilisé pour la localisation.

Enums
NOTIFICATION_CODE_UNSPECIFIED Aucune notification n'est spécifiée.
MISSING_LOWERCASE_CHARACTER Le mot de passe ne comporte pas de caractère minuscule.
MISSING_UPPERCASE_CHARACTER Le mot de passe ne comporte pas de caractère majuscule.
MISSING_NUMERIC_CHARACTER Le mot de passe ne comporte pas de caractère numérique.
MISSING_NON_ALPHANUMERIC_CHARACTER Le mot de passe ne comporte pas de caractère non alphanumérique.
MINIMUM_PASSWORD_LENGTH Le mot de passe est inférieur à la longueur minimale requise.
MAXIMUM_PASSWORD_LENGTH Le mot de passe est plus long que la longueur maximale requise.