Method: accounts.mfaEnrollment.start

Primo passaggio della procedura di registrazione all'MFA. Nel caso di SMS, viene inviato all'utente un codice di verifica via SMS.

Richiesta HTTP

POST https://identitytoolkit.googleapis.com/v2/accounts/mfaEnrollment:start

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "idToken": string,
  "tenantId": string,

  // Union field enrollment_info can be only one of the following:
  "phoneEnrollmentInfo": {
    object (StartMfaPhoneRequestInfo)
  },
  "totpEnrollmentInfo": {
    object (StartMfaTotpEnrollmentRequestInfo)
  }
  // End of list of possible types for union field enrollment_info.
}
Campi
idToken

string

Obbligatorio. Il token ID dell'utente.
tenantId

string

L'ID del tenant Identity Platform a cui appartiene l'utente che registra l'MFA. Se non è impostato, l'utente appartiene al progetto Identity Platform predefinito.
Campo unione enrollment_info. Informazioni sull'MFA in base al tipo di secondo fattore. enrollment_info può essere solo uno dei seguenti:
phoneEnrollmentInfo

object (StartMfaPhoneRequestInfo)

Informazioni di verifica per autorizzare l'invio di un SMS per la verifica telefonica.
totpEnrollmentInfo

object (StartMfaTotpEnrollmentRequestInfo)

Dati di accesso specifici per l'autenticazione TOTP.

Corpo della risposta

Risposta mfaEnrollment.start.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{

  // Union field enrollment_response can be only one of the following:
  "phoneSessionInfo": {
    object (StartMfaPhoneResponseInfo)
  },
  "totpSessionInfo": {
    object (StartMfaTotpEnrollmentResponseInfo)
  }
  // End of list of possible types for union field enrollment_response.
}
Campi
Campo unione enrollment_response. Risposta all'inizio della registrazione MFA in base al tipo di secondo fattore. enrollment_response può essere solo uno dei seguenti:
phoneSessionInfo

object (StartMfaPhoneResponseInfo)

Informazioni di verifica per autorizzare l'invio di un SMS per la verifica telefonica.
totpSessionInfo

object (StartMfaTotpEnrollmentResponseInfo)

Informazioni sulla risposta alla registrazione specifiche per l'autenticazione TOTP.

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.

StartMfaTotpEnrollmentRequestInfo

Questo tipo non contiene campi.

Informazioni sulla richiesta di autenticazione a due fattori specifiche per l'autenticazione TOTP per StartMfa.

StartMfaTotpEnrollmentResponseInfo

Informazioni sulla risposta dell'autenticazione a due fattori specifiche per l'autenticazione TOTP per StartMfa.

Rappresentazione JSON 
{
  "sharedSecretKey": string,
  "verificationCodeLength": integer,
  "hashingAlgorithm": string,
  "periodSec": integer,
  "sessionInfo": string,
  "finalizeEnrollmentTime": string
}
Campi
sharedSecretKey

string

Una stringa con codifica base 32 che rappresenta la chiave segreta TOTP condivisa.

La codifica base 32 è quella specificata dalla sezione 6 della RFC4648. (È la stessa codifica di base 32 della RFC3548#section-5.)
verificationCodeLength

integer

La lunghezza del codice di verifica da generare.
hashingAlgorithm

string

L'algoritmo di hashing utilizzato per generare il codice di verifica.
periodSec

integer

Durata in secondi al termine della quale il codice di verifica cambierà.
sessionInfo

string

Una stringa codificata che rappresenta la sessione di registrazione.
finalizeEnrollmentTime

string (Timestamp format)

L'ora entro cui deve essere completata la registrazione.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".