Package google.cloud.identitytoolkit.v2

Indice

AccountManagementService

Gestione dell'account per Identity Toolkit

FinalizeMfaEnrollment

rpc FinalizeMfaEnrollment(FinalizeMfaEnrollmentRequest) returns (FinalizeMfaEnrollmentResponse)

Completa la registrazione di un secondo fattore 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.
StartMfaEnrollment

rpc StartMfaEnrollment(StartMfaEnrollmentRequest) returns (StartMfaEnrollmentResponse)

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

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

rpc WithdrawMfa(WithdrawMfaRequest) returns (WithdrawMfaResponse)

Revoca un secondo fattore dai secondi fattori registrati per un account.

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.

AuthenticationService

Autenticazione per Identity Toolkit

FinalizeMfaSignIn

rpc FinalizeMfaSignIn(FinalizeMfaSignInRequest) returns (FinalizeMfaSignInResponse)

Verifica la verifica a più fattori e esegue l'accesso

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

rpc GetPasswordPolicy(GetPasswordPolicyRequest) returns (PasswordPolicy)

Recupera la configurazione del criterio per le password impostata nel progetto o nel tenant.

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

rpc GetRecaptchaConfig(GetRecaptchaConfigRequest) returns (RecaptchaConfig)

Recupera i parametri necessari per l'analisi reCAPTCHA.

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

rpc RevokeToken(RevokeTokenRequest) returns (RevokeTokenResponse)

Revoca il token di un utente da un provider di identità (IdP). Ciò viene fatto fornendo manualmente una credenziale dell'IdP e i tipi di token per la revoca.

Per identificare il progetto Google Cloud, nella richiesta è obbligatoria una chiave API.

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

rpc StartMfaSignIn(StartMfaSignInRequest) returns (StartMfaSignInResponse)

Invia la verifica in due passaggi

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.

AutoRetrievalInfo

Le informazioni necessarie per recuperare automaticamente un SMS.

Campi
app_signature_hash

string

L'hash della firma dell'app per Android per l'API SMS Retriever di Google Play Services.

ClientType

Il tipo di piattaforma del cliente: web, android o ios.

Enum
CLIENT_TYPE_UNSPECIFIED Il tipo di client non è specificato.
CLIENT_TYPE_WEB Il tipo di client è web.
CLIENT_TYPE_ANDROID Il tipo di client è Android.
CLIENT_TYPE_IOS Il tipo di client è ios.

FinalizeMfaEnrollmentRequest

Completa la registrazione di un secondo fattore per l'utente.

Campi
id_token

string

Obbligatorio. Token ID.
display_name

string

Nome visualizzato inserito dagli utenti per distinguere i diversi secondi fattori dello stesso tipo o di tipo diverso.
tenant_id

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 verification_info. Dati di registrazione della verifica in due passaggi da verificare. verification_info può essere solo uno dei seguenti:
phone_verification_info

FinalizeMfaPhoneRequestInfo

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

FinalizeMfaTotpEnrollmentRequestInfo

Informazioni di verifica per TOTP.

FinalizeMfaEnrollmentResponse

Risposta FinalizeMfaEnrollment.

Campi
id_token

string

Token ID aggiornato in base alla registrazione all'MFA.
refresh_token

string

Il token di aggiornamento è stato aggiornato in base alla registrazione all'MFA.
Campo unione auxiliary_auth_info. Dati di registrazione verificati con l'autenticazione a più fattori. auxiliary_auth_info può essere solo uno dei seguenti:
phone_auth_info

FinalizeMfaPhoneResponseInfo

Informazioni di autenticazione ausiliarie specifiche per l'autenticazione del telefono.
totp_auth_info

FinalizeMfaTotpEnrollmentResponseInfo

Informazioni di autenticazione ausiliarie specifiche per l'autenticazione TOTP.

FinalizeMfaPhoneRequestInfo

Informazioni per la verifica telefonica per una richiesta FinalizeMfa.

Campi
session_info

string

Una stringa opaca che rappresenta la sessione di registrazione.
code

string

Codice di verifica inserito dall'utente.
android_verification_proof

string

Solo su Android. Utilizzi per la verifica "istantanea" del numero di telefono tramite GmsCore.
phone_number

string

Obbligatorio se viene presentata una prova di verifica Android.

FinalizeMfaPhoneResponseInfo

Informazioni sulla verifica telefonica per una risposta FinalizeMfa.

Campi
android_verification_proof

string

Solo su Android. Sostituzione a lungo termine per un codice valido associato al dispositivo Android.
android_verification_proof_expire_time

Timestamp

Solo su Android. Data e ora di scadenza della prova di verifica in secondi.
phone_number

string

Per la prova della verifica Android.

FinalizeMfaSignInRequest

Completa l'accesso verificando la verifica dell'MFA.

Campi
mfa_pending_credential

string

Obbligatorio. Credenziale in attesa dall'accesso con il primo fattore.
tenant_id

string

L'ID del tenant Identity Platform a cui l'utente sta accedendo. Se non è impostato, l'utente accederà al progetto Identity Platform predefinito.
mfa_enrollment_id

string

L'ID registrazione dell'autenticazione a due fattori dall'elenco delle registrazioni dell'autenticazione a due fattori correnti dell'utente.
Campo unione verification_info. Prova del completamento della verifica in due passaggi. verification_info può essere solo uno dei seguenti:
phone_verification_info

FinalizeMfaPhoneRequestInfo

Prova del completamento della verifica MFA basata su SMS.
totp_verification_info

MfaTotpSignInRequestInfo

Prova del completamento della verifica MFA basata su TOTP.

FinalizeMfaSignInResponse

Risposta FinalizeMfaSignIn.

Campi
id_token

string

Token ID per l'utente autenticato.
refresh_token

string

Token di aggiornamento per l'utente autenticato.
Campo unione auxiliary_auth_info. Dati di accesso verificati tramite l'autenticazione a più fattori. auxiliary_auth_info può essere solo uno dei seguenti:
phone_auth_info

FinalizeMfaPhoneResponseInfo

Informazioni aggiuntive sull'autenticazione dello smartphone, inclusa la prova di verifica Android.

FinalizeMfaTotpEnrollmentRequestInfo

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

Campi
session_info

string

Una stringa opaca che rappresenta la sessione di registrazione.
verification_code

string

Codice di verifica inserito dall'utente.

FinalizeMfaTotpEnrollmentResponseInfo

Questo tipo non contiene campi.

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

GetPasswordPolicyRequest

La richiesta di GetPasswordPolicy.

Campi
tenant_id

string

L'ID di un tenant.

GetRecaptchaConfigRequest

La richiesta di GetRecaptchaConfig.

Campi
tenant_id

string

L'ID di un tenant.
client_type

ClientType

reCAPTCHA Enterprise utilizza chiavi di sito separate per tipi di client diversi. Specifica il tipo di client per ottenere la chiave corrispondente.
version

RecaptchaVersion

La versione di reCAPTCHA.

MfaTotpSignInRequestInfo

Informazioni sulla verifica TOTP per FinalizeMfaSignInRequest.

Campi
verification_code

string

Codice di verifica inserito dall'utente.

PasswordPolicy

Configurazione del criterio relativo alla password.

Campi
custom_strength_options

CustomStrengthOptions

Le opzioni di complessità personalizzata applicate dai criteri relativi alle password.
schema_version

int32

Solo output. Numero di versione dello schema per il criterio della password
allowed_non_alphanumeric_characters[]

string

Solo output. Caratteri consentiti che soddisfano il requisito non_alphanumeric.
enforcement_state

EnforcementState

Solo output. La modalità di applicazione da utilizzare per il criterio relativo alle password.
force_upgrade_on_signin

bool

Per accedere, gli utenti devono avere una password conforme ai criteri relativi alle password.

CustomStrengthOptions

Opzioni di sicurezza personalizzate da applicare alle password degli utenti.

Campi
min_password_length

int32

Lunghezza minima della password. Intervallo da 6 a 30
max_password_length

int32

Lunghezza massima della password. Nessuna durata massima predefinita
contains_lowercase_character

bool

La password deve contenere un carattere minuscolo.
contains_uppercase_character

bool

La password deve contenere un carattere maiuscolo.
contains_numeric_character

bool

La password deve contenere un numero.
contains_non_alphanumeric_character

bool

La password deve contenere un carattere non alfanumerico.

EnforcementState

Stato di applicazione per il criterio relativo alle password

Enum
ENFORCEMENT_STATE_UNSPECIFIED Lo stato dell'applicazione forzata non è stato impostato.
OFF Il criterio per le password non verrà utilizzato nel progetto.
ENFORCE Le password non conformi alle norme relative alle password verranno rifiutate e verrà generato un errore.

RecaptchaConfig

Configurazione per reCAPTCHA

Campi
recaptcha_enforcement_state[]

RecaptchaEnforcementState

Lo stato di applicazione forzata di reCAPTCHA per i provider per i quali GCIP supporta la protezione reCAPTCHA.
recaptcha_key

string

Il nome della risorsa della chiave reCAPTCHA Enterprise, ad esempio "projects/{project}/keys/{key}". Questo valore viene restituito solo quando lo stato di applicazione di reCAPTCHA è AUDIT o ENFORCE su almeno uno dei provider reCAPTCHA.
use_sms_bot_score

bool

Indica se utilizzare il punteggio del bot rCE per il fornitore di telefonia reCAPTCHA.
use_sms_toll_fraud_protection

bool

Indica se utilizzare il punteggio di rischio della protezione antifrode tariffaria SMS di reCAPTCHA per il fornitore di telefoni di reCAPTCHA.

RecaptchaEnforcementState

Stati di applicazione per la protezione reCAPTCHA.

Campi
provider

RecaptchaProvider

Il fornitore che dispone della protezione reCAPTCHA.
enforcement_state

EnforcementState

Lo stato di applicazione forzata di reCAPTCHA per il provider.

EnforcementState

Stati di applicazione della protezione reCAPTCHA per ciascun provider.

Enum
ENFORCEMENT_STATE_UNSPECIFIED Lo stato dell'applicazione forzata non è stato impostato.
OFF Non applicato.
AUDIT La valutazione reCAPTCHA viene creata, ma il risultato non viene utilizzato per l'applicazione.
ENFORCE Viene creata la valutazione reCAPTCHA e il risultato viene utilizzato per l'applicazione.

RecaptchaProvider

I fornitori GCIP che supportano la protezione reCAPTCHA.

Enum
RECAPTCHA_PROVIDER_UNSPECIFIED Provider reCAPTCHA non specificato
EMAIL_PASSWORD_PROVIDER Fornitore della password email
PHONE_PROVIDER Fornitore di autenticazione telefonica

RecaptchaVersion

La versione di reCAPTCHA.

Enum
RECAPTCHA_VERSION_UNSPECIFIED La versione di reCAPTCHA non è specificata.
RECAPTCHA_ENTERPRISE reCAPTCHA Enterprise.

RevokeTokenRequest

Messaggio di richiesta per RevokeToken.

Campi
provider_id

string

Obbligatorio. Il provider IdP per il token. Al momento supporta solo Apple IdP. Il formato deve essere "apple.com".
token_type

TokenType

Obbligatorio. Il tipo di token da revocare.
token

string

Obbligatorio. Il token da revocare. Se viene passato un authorization_code, l'API scambia prima il codice con il token di accesso e poi revoca il token scambiato.
id_token

string

Obbligatorio. Un token ID Identity Platform valido per collegare l'account. Se è stata effettuata una richiesta di revoca del token andata a buon fine nell'account e non vengono generati token dopo la revoca, le richieste duplicate verranno ignorate e restituite immediatamente.
tenant_id

string

L'ID del tenant Identity Platform a cui l'utente sta accedendo. Se non è impostato, l'utente accederà al progetto Identity Platform predefinito.
redirect_uri

string

L'URI di reindirizzamento fornito nella richiesta di autorizzazione iniziale effettuata dal client all'IDP. L'URI deve utilizzare il protocollo HTTPS, includere un nome di dominio e non può contenere un indirizzo IP o localhost. Obbligatorio se token_type è CODE.

TokenType

Il tipo di token da revocare.

Enum
TOKEN_TYPE_UNSPECIFIED Valore predefinito, non da utilizzare.
REFRESH_TOKEN Il tipo di token è refresh_token.
ACCESS_TOKEN Il tipo di token è access_token.
CODE Il tipo di token è authorization_code.

RevokeTokenResponse

Questo tipo non contiene campi.

Messaggio di risposta per RevokeToken. Per il momento vuoto.

StartMfaEnrollmentRequest

Invia un SMS di verifica della registrazione all'autenticazione a più fattori per un utente.

Campi
id_token

string

Obbligatorio. Il token ID dell'utente.
tenant_id

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:
phone_enrollment_info

StartMfaPhoneRequestInfo

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

StartMfaTotpEnrollmentRequestInfo

Dati di accesso specifici per l'autenticazione TOTP.

StartMfaEnrollmentResponse

Risposta StartMfaEnrollment.

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:
phone_session_info

StartMfaPhoneResponseInfo

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

StartMfaTotpEnrollmentResponseInfo

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

StartMfaPhoneRequestInfo

Informazioni per la verifica dell'app per una richiesta StartMfa.

Campi
phone_number

string

Obbligatorio per la registrazione. Numero di telefono da registrare come autenticazione a due fattori.
ios_receipt

string

Solo su iOS. Ricezione della convalida del token dell'app con APNS.
ios_secret

string

Solo su iOS. Secret inviato all'app per iOS tramite APNS.
recaptcha_token

string

Solo web. Soluzione reCAPTCHA.
auto_retrieval_info

AutoRetrievalInfo

Solo su Android. Utilizzato da Google Play Services per identificare l'app per il recupero automatico.
safety_net_token

string

Solo su Android. Utilizzato per affermare l'identità dell'applicazione al posto di un token recaptcha. Un token SafetyNet può essere generato tramite l'API SafetyNet Android Attestation, con la codifica Base64 del campo phone_number come nonce.
play_integrity_token

string

Solo su Android. Utilizzato per affermare l'identità dell'applicazione al posto di un token recaptcha (o token di protezione). Un token Play Integrity può essere generato tramite l'API PlayIntegrity applicando SHA256 al campo phone_number come nonce.
captcha_response

string

Il token reCAPTCHA Enterprise fornito dall'integrazione lato client di reCAPTCHA. Obbligatorio se reCAPTCHA Enterprise è attivato.
client_type

ClientType

Il tipo di client, web, android o ios. Obbligatorio quando reCAPTCHA Enterprise è attivato.
recaptcha_version

RecaptchaVersion

La versione reCAPTCHA del token reCAPTCHA in captcha_response. Obbligatorio quando reCAPTCHA Enterprise è attivato.

StartMfaPhoneResponseInfo

Informazioni sulla verifica telefonica per una risposta StartMfa.

Campi
session_info

string

Una stringa opaca che rappresenta la sessione di registrazione.

StartMfaSignInRequest

Avvia l'accesso a più fattori inviando la verifica dell'autenticazione a più fattori.

Campi
mfa_pending_credential

string

Obbligatorio. Credenziale in attesa dall'accesso con il primo fattore.
mfa_enrollment_id

string

Obbligatorio. L'ID registrazione dell'autenticazione a due fattori dall'elenco delle registrazioni dell'autenticazione a due fattori correnti dell'utente.
tenant_id

string

L'ID del tenant Identity Platform a cui l'utente sta accedendo. Se non è impostato, l'utente accederà al progetto Identity Platform predefinito.
Campo unione sign_in_info. Informazioni sull'MFA in base al tipo di secondo fattore. sign_in_info può essere solo uno dei seguenti:
phone_sign_in_info

StartMfaPhoneRequestInfo

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

StartMfaSignInResponse

Risposta StartMfaSignIn.

Campi
Campo unione response_info. Risposta all'inizio dell'accesso con l'autenticazione a più fattori in base al tipo di secondo fattore. response_info può essere solo uno dei seguenti:
phone_response_info

StartMfaPhoneResponseInfo

Informazioni sulla sessione di accesso MultiFactor specifiche per i secondi fattori di tipo SMS. Oltre al codice una tantum recuperato dall'SMS inviato, i contenuti di queste informazioni sulla sessione devono essere passati a FinalizeMfaSignIn per completare l'accesso.

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.

Campi
shared_secret_key

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.)
verification_code_length

int32

La lunghezza del codice di verifica da generare.
hashing_algorithm

string

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

int32

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

string

Una stringa codificata che rappresenta la sessione di registrazione.
finalize_enrollment_time

Timestamp

L'ora entro cui deve essere completata la registrazione.

WithdrawMfaRequest

Ritira l'MFA.

Campi
id_token

string

Obbligatorio. Il token ID dell'utente.
mfa_enrollment_id

string

Obbligatorio. L'ID registrazione MFA di una registrazione MFA attuale.
tenant_id

string

L'ID del tenant Identity Platform a cui appartiene l'utente che annulla la registrazione dell'MFA. Se non è impostato, l'utente appartiene al progetto Identity Platform predefinito.

WithdrawMfaResponse

Ritira la risposta di MultiFactorAuth.

Campi
id_token

string

Token ID aggiornato per riflettere la rimozione del secondo fattore.
refresh_token

string

Il token di aggiornamento è stato aggiornato in base alla rimozione del secondo fattore.