- Richiesta HTTP
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- UserNotification
- NotificationCode
- Prova!
Consente a un utente di accedere con indirizzo email e password. Se l'accesso va a buon fine, vengono emessi un nuovo token ID e un nuovo token di aggiornamento di Identity Platform per l'utente autenticato.
Per identificare il progetto Google Cloud, nella richiesta è obbligatoria una chiave API.
Richiesta HTTP
POST https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword
L'URL utilizza la sintassi di transcodifica gRPC.
Corpo della richiesta
Il corpo della richiesta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{ "email": string, "password": string, "pendingIdToken": string, "captchaChallenge": string, "captchaResponse": string, "instanceId": string, "delegatedProjectNumber": string, "idToken": string, "returnSecureToken": boolean, "tenantId": string, "clientType": enum ( |
Campi | |
---|---|
email |
Obbligatorio. L'indirizzo email con cui l'utente accede. La lunghezza dell'email deve essere inferiore a 256 caratteri e nel formato |
password |
Obbligatorio. La password fornita dall'utente per accedere all'account. |
pendingIdToken |
|
captchaChallenge |
|
captchaResponse |
Il token reCAPTCHA fornito dall'integrazione lato client di reCAPTCHA. reCAPTCHA Enterprise lo utilizza per la valutazione del rischio. Obbligatorio quando reCAPTCHA Enterprise è attivato. |
instanceId |
|
delegatedProjectNumber |
|
idToken |
|
returnSecureToken |
Deve sempre essere true. |
tenantId |
L'ID del tenant Identity Platform a cui l'utente sta accedendo. Se non è impostato, l'utente accederà all'istanza Identity Platform predefinita nel progetto. |
clientType |
Il tipo di client, web, android o ios. Obbligatorio quando reCAPTCHA Enterprise è attivato. |
recaptchaVersion |
La versione reCAPTCHA del token reCAPTCHA in captchaResponse. |
Corpo della risposta
Messaggio di risposta per accounts.signInWithPassword.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione 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 ( |
Campi | |
---|---|
kind |
|
localId |
L'ID dell'utente autenticato. Sempre presente nella risposta. |
email |
L'indirizzo email dell'utente autenticato. Sempre presente nella risposta. |
displayName |
Il nome visualizzato dell'utente memorizzato negli attributi dell'account. |
idToken |
Un token ID Identity Platform per l'utente autenticato. |
registered |
Indica se l'email è per un account esistente. Sempre true. |
profilePicture |
L'immagine del profilo dell'utente archiviata negli attributi dell'account. |
oauthAccessToken |
Il token di accesso OAuth2. |
oauthExpireIn |
La data e l'ora di scadenza del token di accesso in secondi. |
oauthAuthorizationCode |
|
refreshToken |
Un token di aggiornamento di Identity Platform per l'utente autenticato. |
expiresIn |
Il numero di secondi che rimangono prima della scadenza del token ID di Identity Platform. |
mfaPendingCredential |
Una stringa opaca che funge da prova che l'utente ha superato l'autenticazione a due fattori. |
mfaInfo[] |
Informazioni sui provider di autenticazione a più fattori abilitati per l'account. Presente se l'utente deve completare l'accesso utilizzando l'autenticazione a più fattori. |
userNotifications[] |
Notifiche di avviso per l'utente. |
Ambiti di autorizzazione
Richiede uno dei seguenti ambiti OAuth:
https://www.googleapis.com/auth/identitytoolkit
https://www.googleapis.com/auth/cloud-platform
Per ulteriori informazioni, consulta la sezione Authentication Overview.
UserNotification
Notifiche di avviso per l'utente.
Rappresentazione JSON |
---|
{
"notificationCode": enum ( |
Campi | |
---|---|
notificationCode |
Enum di notifica di avviso. Può essere utilizzato per la localizzazione. |
notificationMessage |
Stringa di notifica di avviso. Può essere utilizzato come opzione di riserva. |
NotificationCode
Enum di notifica di avviso. Può essere utilizzato per la localizzazione.
Enum | |
---|---|
NOTIFICATION_CODE_UNSPECIFIED |
Nessuna notifica specificata. |
MISSING_LOWERCASE_CHARACTER |
Nella password manca un carattere minuscolo. |
MISSING_UPPERCASE_CHARACTER |
Nella password manca un carattere maiuscolo. |
MISSING_NUMERIC_CHARACTER |
Nella password manca un carattere numerico. |
MISSING_NON_ALPHANUMERIC_CHARACTER |
Nella password manca un carattere non alfanumerico. |
MINIMUM_PASSWORD_LENGTH |
La password è inferiore alla lunghezza minima richiesta. |
MAXIMUM_PASSWORD_LENGTH |
La password è più lunga della lunghezza massima richiesta. |