Indice
AccountManagementService(interfaccia)AuthenticationService(interfaccia)ProjectConfigService(interfaccia)SessionManagementService(interfaccia)Argon2Parameters(messaggio)Argon2Parameters.HashType(enum)Argon2Parameters.Version(enum)BatchDeleteAccountsRequest(messaggio)BatchDeleteAccountsResponse(messaggio)BatchDeleteAccountsResponse.BatchDeleteErrorInfo(messaggio)ClientType(enum)CreateAuthUriRequest(messaggio)CreateAuthUriResponse(messaggio)CreateSessionCookieRequest(messaggio)CreateSessionCookieResponse(messaggio)DeleteAccountRequest(messaggio)DeleteAccountResponse(messaggio)DownloadAccountRequest(messaggio)DownloadAccountResponse(messaggio)EmailInfo(messaggio)EmailTemplate(messaggio)EmailTemplate.EmailBodyFormat(enum)ErrorInfo(messaggio)GetAccountInfoRequest(messaggio)GetAccountInfoRequest.FederatedUserIdentifier(messaggio)GetAccountInfoResponse(messaggio)GetOobCodeRequest(messaggio)GetOobCodeResponse(messaggio)GetProjectConfigRequest(messaggio)GetProjectConfigResponse(messaggio)GetRecaptchaParamResponse(messaggio)GetSessionCookiePublicKeysResponse(messaggio)IdpConfig(messaggio)IdpConfig.Provider(enum)IssueSamlResponseRequest(messaggio)IssueSamlResponseResponse(messaggio)MfaEnrollment(messaggio)OobReqType(enum)OpenIdConnectKey(messaggio)ProviderUserInfo(messaggio)QueryUserInfoRequest(messaggio)QueryUserInfoRequest.Order(enum)QueryUserInfoRequest.SortByField(enum)QueryUserInfoRequest.SqlExpression(messaggio)QueryUserInfoResponse(messaggio)RecaptchaVersion(enum)ResetPasswordRequest(messaggio)ResetPasswordResponse(messaggio)SendVerificationCodeRequest(messaggio)SendVerificationCodeRequest.AutoRetrievalInfo(messaggio)SendVerificationCodeResponse(messaggio)SetAccountInfoRequest(messaggio)SetAccountInfoRequest.MfaInfo(messaggio)SetAccountInfoRequest.UserAttributeName(enum)SetAccountInfoResponse(messaggio)SignInWithCustomTokenRequest(messaggio)SignInWithCustomTokenResponse(messaggio)SignInWithEmailLinkRequest(messaggio)SignInWithEmailLinkResponse(messaggio)SignInWithGameCenterRequest(messaggio)SignInWithGameCenterResponse(messaggio)SignInWithIdpRequest(messaggio)SignInWithIdpResponse(messaggio)SignInWithPasswordRequest(messaggio)SignInWithPasswordResponse(messaggio)SignInWithPhoneNumberRequest(messaggio)SignInWithPhoneNumberRequest.VerifyOp(enum)SignInWithPhoneNumberResponse(messaggio)SignUpRequest(messaggio)SignUpRequest.MfaFactor(messaggio)SignUpResponse(messaggio)TotpInfo(messaggio)UploadAccountRequest(messaggio)UploadAccountRequest.PasswordHashOrder(enum)UploadAccountResponse(messaggio)UserInfo(messaggio)UserNotification(messaggio)UserNotification.NotificationCode(enum)VerifyIosClientRequest(messaggio)VerifyIosClientResponse(messaggio)
AccountManagementService
Gestione dell'account per Identity Toolkit
| BatchDeleteAccounts |
|---|
|
Consente di eliminare più account contemporaneamente. Per gli account che non vengono eliminati, le informazioni sull'errore sono contenute nella risposta. Il metodo ignora gli account che non esistono o sono duplicati nella richiesta. Questo metodo richiede una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate.
|
| DeleteAccount |
|---|
|
Consente di eliminare l'account di un utente.
|
| DownloadAccount |
|---|
|
Scarica le informazioni degli account di tutti gli account del progetto in modo paginato. Per utilizzare questo metodo è necessaria una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate. Inoltre, sono necessarie autorizzazioni aggiuntive per ottenere l'hash della password, il sale della password e la versione della password dagli account; in caso contrario, questi campi vengono oscurati.
|
| GetAccountInfo |
|---|
|
Recupera le informazioni dell'account per tutti gli account corrispondenti. Per una richiesta di un utente finale, recupera l'account dell'utente finale. Per una richiesta di amministratore con credenziale OAuth 2.0 di Google, recupera uno o più account con criteri di corrispondenza.
|
| GetOobCode |
|---|
|
Invia un codice di conferma fuori banda per un account. Le richieste di una richiesta autenticata possono, facoltativamente, restituire un link che include il codice OOB anziché inviarlo.
|
| QueryUserInfo |
|---|
|
Cerca gli account utente all'interno di un progetto o di un tenant in base alle condizioni della richiesta.
|
| ResetPassword |
|---|
|
Reimposta la password di un account utilizzando un codice out-of-band generato da [sendOobCode][v1.accounts.sendOobCode] o specificando l'email e la password dell'account da modificare. Può anche controllare lo scopo di un codice out-of-band senza consumarlo.
|
| SetAccountInfo |
|---|
|
Aggiorna le informazioni relative all'account dell'utente specificato impostando campi specifici o applicando codici di azione. Sono supportate le richieste di amministratori e utenti finali.
|
| UploadAccount |
|---|
|
Carica più account nel progetto Google Cloud. Se si verifica un problema durante il caricamento di uno o più account, gli altri verranno caricati e verrà restituito un elenco degli errori. Per utilizzare questo metodo è necessaria una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate.
|
AuthenticationService
Autenticazione per Identity Toolkit
| CreateAuthUri |
|---|
|
Se viene specificato un identificatore email, controlla e restituisce se è presente un account utente registrato con l'email. Se esiste un account registrato, recupera tutti i fornitori associati all'indirizzo email dell'account. Se è specificato l'ID provider di un provider di identità (IdP), viene creato un URI di autorizzazione per l'IdP. L'utente può essere indirizzato a questo URI per accedere con l'IdP. Per identificare il progetto Google Cloud, nella richiesta è obbligatoria una chiave API.
|
| GetPublicKeys |
|---|
|
Recupera le chiavi pubbliche del firmatario del token Identity Toolkit precedente per consentire a terze parti di verificare il token ID precedente. Per il momento, il certificato PEM X509 è l'unico formato supportato.
|
| GetRecaptchaParam |
|---|
|
Recupera i parametri necessari per generare un test reCAPTCHA.
|
| IssueSamlResponse |
|---|
|
Sperimentale
|
| SendVerificationCode |
|---|
|
Invia un codice di verifica via SMS per l'accesso con numero di telefono. Per localizzare il testo dell'SMS inviato all'utente, imposta l'intestazione HTTP Per identificare il progetto Google Cloud, nella richiesta è obbligatoria una chiave API.
|
| SignInWithCustomToken |
|---|
|
Consente a un utente di accedere o registrarsi scambiando un token di autenticazione personalizzato. Dopo l'accesso o la registrazione, all'utente vengono emessi un nuovo token ID e un token di aggiornamento di Identity Platform. Per identificare il progetto Google Cloud, nella richiesta è obbligatoria una chiave API.
|
| SignInWithEmailLink |
|---|
|
Consente a un utente di accedere o registrarsi con un codice out-of-band da un link email. Se non esiste un utente con l'indirizzo email specificato, verrà creato un record utente. Se l'accesso va a buon fine, vengono emessi un ID Identity Platform e un token di aggiornamento per l'utente autenticato. Per identificare il progetto Google Cloud, nella richiesta è obbligatoria una chiave API.
|
| SignInWithGameCenter |
|---|
|
Consente a un utente di accedere o registrarsi con le credenziali di Game Center per iOS. 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. L'ID bundle è obbligatorio nell'intestazione della richiesta come Per identificare il progetto Google Cloud, nella richiesta è obbligatoria una chiave API. Apple ha ritirato il campo L'upgrade delle integrazioni di accesso a Game Center esistenti alla versione SDK 10.5.0 o successive è irreversibile.
|
| SignInWithIdp |
|---|
|
Consente a un utente di accedere o registrarsi utilizzando le credenziali di un provider di identità (IdP). Ciò viene fatto fornendo manualmente una credenziale dell'IdP o fornendo la risposta di autorizzazione ottenuta tramite la richiesta di autorizzazione da CreateAuthUri. 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. Verrà creato un nuovo account utente Identity Platform se l'utente non ha eseguito l'accesso in precedenza al provider di identità con lo stesso account. Inoltre, quando l'impostazione "Un account per indirizzo email" è attiva, non deve esistere un account utente Identity Platform con lo stesso indirizzo email per poter creare un nuovo account utente. Per identificare il progetto Google Cloud, nella richiesta è obbligatoria una chiave API.
|
| SignInWithPassword |
|---|
|
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.
|
| SignInWithPhoneNumber |
|---|
|
Completa un tentativo di autenticazione del numero di telefono. Se esiste già un utente con il numero di telefono specificato, viene creato un token ID per quell'utente. In caso contrario, viene creato un nuovo utente e associato al numero di telefono. Questo metodo può essere utilizzato anche per collegare un numero di telefono a un utente esistente. Per localizzare il testo dell'SMS inviato all'utente, imposta l'intestazione HTTP Per identificare il progetto Google Cloud, nella richiesta è obbligatoria una chiave API.
|
| Registrazione |
|---|
|
Registra un nuovo utente con email e password o un utente anonimo oppure esegue l'upgrade di un utente anonimo a utente con email e password. Per una richiesta di amministratore con una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate, crea un nuovo utente anonimo, con indirizzo email e password o numero di telefono. Per identificare il progetto Google Cloud, nella richiesta è obbligatoria una chiave API.
|
| VerifyIosClient |
|---|
|
Verifica che un client iOS sia un dispositivo iOS reale. Se la richiesta è valida, nella risposta verrà inviata una conferma e un token segreto tramite il servizio di notifiche push di Apple. Il cliente deve inviarli entrambi a determinate API Identity Platform in una chiamata successiva (ad esempio /accounts:sendVerificationCode) per la verifica del cliente. L'ID pacchetto è obbligatorio nell'intestazione della richiesta come Per identificare il progetto Google Cloud, nella richiesta è obbligatoria una chiave API.
|
ProjectConfigService
Configurazione del progetto per Identity Toolkit
| GetProjectConfig |
|---|
|
Recupera la configurazione pubblica di Identity Toolkit di un progetto. (Legacy) Questo metodo supporta anche le chiamate autenticate da uno sviluppatore per recuperare la configurazione non pubblica.
|
SessionManagementService
Gestione delle sessioni per Identity Platform.
| CreateSessionCookie |
|---|
|
Crea un cookie di sessione per il token ID di Identity Platform specificato. Il cookie di sessione viene utilizzato dal client per mantenere lo stato di accesso dell'utente.
|
| GetSessionCookiePublicKeys |
|---|
|
Recupera l'insieme di chiavi pubbliche del firmatario del token web JSON (JWT) del cookie di sessione che può essere utilizzato per convalidare il cookie di sessione creato tramite [createSessionCookie][v1.projects.createSessionCookie]. |
Argon2Parameters
I parametri per l'algoritmo di hashing Argon2.
| Campi | |
|---|---|
hash_length_bytes |
Obbligatorio. La lunghezza dell'hash desiderata in byte. Il valore minimo è 4 e il valore massimo è 1024. |
hash_type |
Obbligatorio. Non deve essere HASH_TYPE_UNSPECIFIED. |
parallelism |
Obbligatorio. Il grado di parallelismo, chiamato anche thread o corsie. Il valore minimo è 1, il valore massimo è 16. |
iterations |
Obbligatorio. Il numero di iterazioni da eseguire. Il valore minimo è 1, il valore massimo è 16. |
memory_cost_kib |
Obbligatorio. Il costo della memoria in kibibyte. Il valore massimo è 32768. |
version |
La versione dell'algoritmo Argon2. Se non specificato, il valore predefinito è VERSION_13. |
associated_data |
I dati associati aggiuntivi, se forniti, vengono aggiunti al valore hash per fornire un ulteriore livello di sicurezza. Una stringa con codifica base64, se specificata tramite JSON. |
HashType
I tipi di algoritmo.
| Enum | |
|---|---|
HASH_TYPE_UNSPECIFIED |
Il tipo di hash non è specificato. |
ARGON2_D |
Una variante di Argon2, Argon2d. |
ARGON2_ID |
Una variante di Argon2, Argonid. Consigliata. |
ARGON2_I |
Una variante di Argon2, Argon2i. |
Versione
La versione dell'algoritmo.
| Enum | |
|---|---|
VERSION_UNSPECIFIED |
La versione non è specificata. |
VERSION_10 |
La versione precedente, 0x10. |
VERSION_13 |
La versione corrente, 0x13. Il valore predefinito per la versione. |
BatchDeleteAccountsRequest
Messaggio di richiesta per BatchDeleteAccounts.
| Campi | |
|---|---|
target_project_id |
Se è specificato L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
local_ids[] |
Obbligatorio. Elenco di ID utente da eliminare. |
force |
Indica se forzare l'eliminazione degli account che non sono in stato disattivato. Se false, verranno eliminati solo gli account disattivati e gli account non disattivati verranno aggiunti a |
tenant_id |
Se gli account appartengono a un tenant di Identity Platform, l'ID del tenant. Se gli account appartengono a un progetto Identity Platform predefinito, il campo non è necessario. |
BatchDeleteAccountsResponse
Messaggio di risposta a BatchDeleteAccounts.
| Campi | |
|---|---|
errors[] |
Informazioni dettagliate sugli errori relativi agli account che non possono essere eliminati. |
BatchDeleteErrorInfo
Impossibile eliminare le informazioni sull'errore per l'account.
| Campi | |
|---|---|
index |
L'indice dell'elemento con errore nel campo local_ids originale. |
local_id |
L'ID utente corrispondente. |
error_message |
Messaggio di errore dettagliato. |
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. |
CreateAuthUriRequest
Messaggio di richiesta per CreateAuthUri.
| Campi | |
|---|---|
identifier |
L'identificatore email dell'account utente per cui recuperare i fornitori associati. Deve essere impostato almeno uno dei campi La lunghezza dell'indirizzo email deve essere inferiore a 256 caratteri e deve avere il formato |
continue_uri |
Un URL valido a cui l'IdP deve reindirizzare l'utente. L'URL non può contenere frammenti o il parametro di query |
openid_realm |
|
provider_id |
L'ID provider dell'IdP con cui l'utente deve accedere. Deve essere un ID provider abilitato per l'accesso, che deve provenire dall'elenco degli IdP supportati per impostazione predefinita o avere il formato |
oauth_consumer_key |
|
oauth_scope |
Altri ambiti OAuth 2.0 separati da spazi che specificano l'ambito della richiesta di autenticazione con l'IDP. Utilizzato per le IdP OAuth 2.0. Per il fornitore Google, verrà utilizzato il flusso del codice di autorizzazione se questo campo è impostato. |
context |
Una stringa opaca utilizzata per mantenere le informazioni contestuali tra la richiesta di autenticazione e il callback dall'IdP. |
ota_app |
|
app_id |
|
hosted_domain |
Utilizzato per il provider Google. Il dominio ospitato di G Suite dell'utente per limitare l'accesso agli utenti di quel dominio. |
session_id |
Un ID sessione che può essere verificato in SignInWithIdp per impedire attacchi di fissaggio della sessione. Se non è presente, verrà generata e restituita una stringa casuale come ID sessione. |
auth_flow_type |
Utilizzato per il provider Google. Il tipo di flusso di autenticazione da utilizzare. Se presente, deve essere |
custom_parameter |
Parametri di query personalizzati aggiuntivi da aggiungere all'URI di autorizzazione. I seguenti parametri sono riservati e non possono essere aggiunti: Per il provider Microsoft, il tenant Azure AD a cui accedere può essere specificato nel parametro personalizzato |
tenant_id |
L'ID del tenant di Identity Platform per cui creare un URI di autorizzazione o cercare un identificatore email. Se non è impostato, l'operazione verrà eseguita nell'istanza Identity Platform predefinita del progetto. |
CreateAuthUriResponse
Messaggio di risposta per CreateAuthUri.
| Campi | |
|---|---|
kind |
|
auth_uri |
L'URI di autorizzazione per il provider richiesto. Presente solo quando nella richiesta è impostato un ID provider. |
all_providers[] |
|
registered |
Indica se l'identificatore email rappresenta un account esistente. Presente solo quando nella richiesta è impostato un identificatore email. |
provider_id |
L'ID provider della richiesta, se fornito. |
for_existing_provider |
Indica se l'utente ha eseguito l'accesso in precedenza con l'ID provider nella richiesta. Presente solo quando nella richiesta è impostato un identificatore email registrato. |
captcha_required |
Indica se è necessario un CAPTCHA perché l'utente ha effettuato troppi tentativi di accesso non riusciti. Presente solo quando nella richiesta è impostato un identificatore email registrato. |
session_id |
L'ID sessione della richiesta o una stringa casuale generata da CreateAuthUri, se assente. Viene utilizzato per impedire attacchi di fissazione della sessione. |
signin_methods[] |
L'elenco dei metodi di accesso utilizzati in precedenza dall'utente. Ogni elemento è |
CreateSessionCookieRequest
Messaggio di richiesta per CreateSessionCookie.
| Campi | |
|---|---|
id_token |
Obbligatorio. Un token ID Identity Platform valido. |
valid_duration |
Il numero di secondi che mancano alla scadenza del cookie della sessione. Specifica una durata in secondi, compresa tra cinque minuti e quattordici giorni. |
target_project_id |
L'ID del progetto a cui appartiene l'account. |
tenant_id |
L'ID del tenant di Identity Platform a cui appartiene l'account. |
CreateSessionCookieResponse
Messaggio di risposta per CreateSessionCookie.
| Campi | |
|---|---|
session_cookie |
Il cookie della sessione creato dall'ID token di Identity Platform specificato nella richiesta. È sotto forma di token JWT (JSON Web Token). Sempre presente. |
DeleteAccountRequest
Messaggio di richiesta per DeleteAccount.
| Campi | |
|---|---|
local_id |
L'ID dell'account utente da eliminare. La specifica di questo campo richiede una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate. Le richieste degli utenti che non dispongono della credenziale devono invece passare un token ID. |
delegated_project_number |
|
id_token |
Il token ID di Identity Platform dell'account da eliminare. Deve essere specificato per le richieste degli utenti finali che non dispongono della credenziale Google OAuth 2.0. Le richieste autenticate che contengono una credenziale OAuth2 di Google con le autorizzazioni appropriate possono passare local_id per specificare l'account da eliminare. |
tenant_id |
L'ID del tenant a cui appartiene l'account, se applicabile. Deve essere specificato solo per le richieste autenticate che contengono una credenziale OAuth 2.0 di Google che specifica local_id di un account appartenente a un tenant Identity Platform. |
target_project_id |
L'ID del progetto a cui appartiene l'account. Deve essere specificato solo nelle richieste autenticate che specificano l'attributo local_id di un account. L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
DeleteAccountResponse
Messaggio di risposta per DeleteAccount.
| Campi | |
|---|---|
kind |
|
DownloadAccountRequest
Messaggio di richiesta per DownloadAccount
| Campi | |
|---|---|
delegated_project_number |
|
next_page_token |
Il token di paginazione della risposta di una richiesta precedente. |
max_results |
Il numero massimo di risultati da restituire. Deve essere almeno 1 e non deve superare 1000. Il valore predefinito è 20. |
target_project_id |
Se è specificato L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
tenant_id |
L'ID del tenant di Identity Platform a cui appartengono gli account. Se non specificato, vengono restituiti gli account del progetto Identity Platform. |
DownloadAccountResponse
Messaggio di risposta per DownloadAccount.
| Campi | |
|---|---|
kind |
|
users[] |
Tutti gli account appartenenti al progetto/tenant limitati da max_results nella richiesta. |
next_page_token |
Se ci sono altri account da scaricare, un token che può essere passato a DownloadAccount per ottenere altri account. In caso contrario, il campo rimane vuoto. |
EmailInfo
Informazioni sull'MFA per le email.
| Campi | |
|---|---|
email_address |
Indirizzo email a cui deve essere inviata una verifica tramite l'autenticazione a due fattori. |
EmailTemplate
Modello email
| Campi | |
|---|---|
disabled |
Indica se il modello è disattivato. Se il valore è true, verrà utilizzato un modello predefinito. |
from |
Indirizzo del mittente dell'email |
body |
Corpo dell'email |
subject |
Oggetto dell'email |
from_display_name |
Dal nome visualizzato |
format |
Formato del corpo dell'email |
reply_to |
Indirizzo per risposte |
from_local_part |
Parte locale dell'indirizzo mittente |
locale |
Il valore è nel formato del codice lingua III (ad es. "zh-CN", "es"). Sono accettati entrambi i separatori "-" e "_". |
customized |
Indica se il corpo o l'oggetto dell'email è personalizzato. |
EmailBodyFormat
Formato del corpo dell'email
| Enum | |
|---|---|
EMAIL_BODY_FORMAT_UNSPECIFIED |
Valore predefinito. Non utilizzare. |
PLAINTEXT |
Il corpo dell'email è in formato di testo normale. |
HTML |
Il corpo dell'email è in formato HTML. |
ErrorInfo
Informazioni sull'errore che spiegano perché non è possibile caricare un account.
| Campi | |
|---|---|
index |
L'indice dell'elemento, l'intervallo è [0, request.size - 1] |
error_message |
Messaggio di errore dettagliato |
GetAccountInfoRequest
Messaggio di richiesta per GetAccountInfo.
| Campi | |
|---|---|
id_token |
Il token ID di Identity Platform dell'account da recuperare. Deve essere specificato per le richieste degli utenti finali. |
local_id[] |
L'ID di uno o più account da recuperare. Deve essere specificato solo dalle richieste autenticate che contengono una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate. |
email[] |
L'indirizzo email di uno o più account da recuperare. La lunghezza dell'email deve essere inferiore a 256 caratteri e nel formato |
delegated_project_number |
|
phone_number[] |
Il numero di telefono di uno o più account da recuperare. Deve essere specificato solo da richieste autenticate di uno sviluppatore e deve essere nel formato E.164, ad esempio +15555555555. |
federated_user_id[] |
|
tenant_id |
L'ID del tenant a cui appartiene l'account. Deve essere specificato solo dalle richieste autenticate di uno sviluppatore. |
target_project_id |
L'ID del progetto Google Cloud a cui appartiene l'account o il tenant Identity Platform specificato da L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
initial_email[] |
L'email iniziale di uno o più account da recuperare. La lunghezza dell'email deve essere inferiore a 256 caratteri e nel formato |
FederatedUserIdentifier
Identificatore utente federato in un provider di identità.
| Campi | |
|---|---|
provider_id |
L'ID dei provider di identità supportati. Deve essere un ID provider abilitato per l'accesso, che deve provenire dall'elenco degli IdP supportati per impostazione predefinita o avere il formato |
raw_id |
L'ID utente dell'account presso il provider di identità di terze parti specificato da |
GetAccountInfoResponse
Messaggio di risposta per GetAccountInfo.
| Campi | |
|---|---|
kind |
|
users[] |
Le informazioni di account utente specifici corrispondenti ai parametri nella richiesta. |
GetOobCodeRequest
Messaggio di richiesta per GetOobCode.
| Campi | |
|---|---|
req_type |
Obbligatorio. Il tipo di codice out-of-band (OOB) da inviare. A seconda di questo valore, altri campi di questa richiesta saranno obbligatori e/o avranno significati diversi. Esistono 4 diversi codici OOB che possono essere inviati: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL |
email |
L'indirizzo email dell'account a cui inviare il codice OOB e in genere l'indirizzo email dell'account da aggiornare. Obbligatorio per PASSWORD_RESET, EMAIL_SIGNIN e VERIFY_EMAIL. Obbligatorio solo per le richieste VERIFY_AND_CHANGE_EMAIL quando return_oob_link è impostato su true. In questo caso, si tratta dell'indirizzo email originale dell'utente. |
challenge |
|
captcha_resp |
Per una richiesta PASSWORD_RESET, è necessaria una risposta reCaptcha quando il sistema rileva possibili attività di abuso. In questi casi, si tratta della risposta alla verifica reCaptcha utilizzata per verificare chi chiama. |
user_ip |
L'indirizzo IP del chiamante. Obbligatorio solo per le richieste PASSWORD_RESET. |
new_email |
L'indirizzo email a cui viene aggiornato l'account. Obbligatorio solo per le richieste VERIFY_AND_CHANGE_EMAIL. |
id_token |
Un token ID per l'account. È obbligatorio per le richieste VERIFY_AND_CHANGE_EMAIL e VERIFY_EMAIL, a meno che return_oob_link non sia impostato su true. |
continue_url |
L'URL per continuare dopo che l'utente fa clic sul link inviato via email. Questo è l'URL che consentirà al widget web di gestire il codice OOB. |
ios_bundle_id |
Se un'app per iOS associata può gestire il codice OOB, l'ID pacchetto iOS di questa app. In questo modo, l'app corretta verrà aperta se è già installata. |
ios_app_store_id |
Se un'app iOS associata può gestire il codice OOB, l'ID App Store di questa app. In questo modo, l'App Store aprirà l'app corretta se non è ancora installata. |
android_package_name |
Se un'app per Android associata può gestire il codice OOB, il nome del pacchetto Android dell'app per Android che gestirà il callback quando viene utilizzato questo codice OOB. In questo modo, l'app corretta verrà aperta se è già installata oppure Google Play Store aprirà l'app corretta se non è ancora installata. |
android_install_app |
Se un'app per Android associata può gestire il codice OOB, se installare o meno l'app per Android sul dispositivo in cui viene aperto il link se l'app non è già installata. |
android_minimum_version_code |
Se un'app Android associata può gestire il codice OOB, la versione minima dell'app. Se la versione sul dispositivo è precedente a questa, l'utente viene indirizzato al Google Play Store per eseguire l'upgrade dell'app. |
can_handle_code_in_app |
Se impostato su True, il link al codice OOB verrà inviato come link universale o link all'app per Android e verrà aperto dall'app corrispondente, se installata. Se non è impostato o se è impostato su false, il codice OOB verrà inviato prima al widget web e poi al continuare verrà reindirizzato all'app, se installata. |
tenant_id |
L'ID del tenant di Identity Platform a cui appartiene l'account. |
target_project_id |
L'ID progetto del progetto Identity Platform a cui appartiene l'account. Per specificare questo campo, è necessaria una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate. L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
dynamic_link_domain |
Per assicurarci che l'URL utilizzato possa essere aperto facilmente su iOS o Android, creiamo un link dinamico Firebase. La maggior parte dei progetti Identity Platform avrà un solo dominio di collegamento dinamico abilitato e può lasciare vuoto questo campo. Questo campo contiene un dominio Dynamic Link specificato per i progetti in cui sono attivati più domini. |
return_oob_link |
Indica se il link di conferma contenente il codice OOB deve essere restituito nella risposta (non viene inviata alcuna email). Viene utilizzato quando uno sviluppatore vuole creare il modello email e inviarlo autonomamente. Per impostazione predefinita, questo valore è false. Per specificare questo campo e impostarlo su true, è necessaria una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate. |
client_type |
Il tipo di client: web, Android o iOS. Obbligatorio se la protezione reCAPTCHA Enterprise è attivata. |
recaptcha_version |
La versione reCAPTCHA del token reCAPTCHA in captcha_response. |
link_domain |
Facoltativo. Per assicurarci che l'URL utilizzato possa essere aperto facilmente su iOS o Android, creiamo un link di hosting "/__/auth/links". Questo campo facoltativo contiene il dominio da utilizzare per la creazione di un link di hosting. Se non viene impostato, verrà utilizzato il dominio " |
GetOobCodeResponse
Messaggio di risposta per GetOobCode.
| Campi | |
|---|---|
kind |
|
oob_code |
Se return_oob_link è true nella richiesta, il codice OOB da inviare. |
email |
Se return_oob_link è falso nella richiesta, l'indirizzo email a cui è stata inviata la verifica. |
oob_link |
Se return_oob_link è true nella richiesta, il link OOB da inviare all'utente. Viene restituito il link creato, inclusi i parametri relativi a Firebase Dynamic Link. |
GetProjectConfigRequest
Messaggio di richiesta per GetProjectConfig.
| Campi | |
|---|---|
delegated_project_number |
Numero del progetto della richiesta di progetto delegata. Questo campo deve essere utilizzato solo nell'ambito della migrazione a Firebase versione 1. |
project_number |
Numero del progetto della configurazione da recuperare. Questo campo è deprecato e non deve essere utilizzato dalle nuove integrazioni. |
return_dynamic_link |
Indica se deve essere restituito il link dinamico. |
android_package_name |
Nome del pacchetto Android da confrontare con il nome del pacchetto Android reale. Se questo campo viene fornito e non viene fornito sha1_cert_hash, l'azione restituirà un errore se non corrisponde al nome del pacchetto Android reale. |
ios_bundle_id |
L'ID bundle iOS da confrontare con l'ID bundle iOS reale. Se viene fornito questo campo, l'azione restituirà un errore se non corrisponde all'ID bundle iOS reale. |
client_id |
L'ID client OAuth dell'RP. Se impostato, verrà eseguito un controllo per verificare che il client OAuth sia valido per il progetto recuperato e la richiesta rifiutata con un errore del client se non è valido. |
sha1_cert |
Hash del certificato dell'applicazione Android SHA-1. Se impostato, verrà eseguito un controllo per verificare che l'hash del certificato sia valido per il progetto e il nome del pacchetto Android recuperati. |
firebase_app_id |
L'ID app Firebase per le applicazioni che utilizzano Firebase. Puoi trovarlo nella Console Firebase del tuo progetto. Se impostato, verrà eseguito un controllo per verificare che l'ID app sia valido per il progetto recuperato. In caso contrario, la richiesta verrà rifiutata con un errore del client. |
GetProjectConfigResponse
Messaggio di risposta per GetProjectConfig.
| Campi | |
|---|---|
project_id |
L'ID progetto della configurazione recuperata. |
api_key |
Chiave API Google Cloud. Questo campo viene restituito solo per le chiamate autenticate da uno sviluppatore. |
allow_password_user |
Indica se consentire la registrazione dell'account con password. Questo campo viene restituito solo per le chiamate autenticate da uno sviluppatore. |
idp_config[] |
Configurazione del provider OAuth2. Questo campo viene restituito solo per le chiamate autenticate da uno sviluppatore. |
authorized_domains[] |
Domini autorizzati per il reindirizzamento dei widget. |
enable_anonymous_user |
Indica se l'utente anonimo è attivo. Questo campo viene restituito solo per le chiamate autenticate da uno sviluppatore. |
dynamic_links_domain |
Il dominio Firebase Dynamic Links utilizzato per creare link per i reindirizzamenti alle app native. |
use_email_sending |
Se utilizzare l'invio di email. Questo campo viene restituito solo per le chiamate autenticate da uno sviluppatore. |
reset_password_template |
Modello email per la reimpostazione della password. Questo campo viene restituito solo per le chiamate autenticate da uno sviluppatore. |
verify_email_template |
Modello email per l'email di verifica. Questo campo viene restituito solo per le chiamate autenticate da uno sviluppatore. |
change_email_template |
Modello di email per l'email di modifica. Questo campo viene restituito solo per le chiamate autenticate da uno sviluppatore. |
legacy_reset_password_template |
Modello email di reimpostazione della password per l'app Firebase V1 precedente. Questo campo viene restituito solo per le chiamate autenticate da uno sviluppatore. |
revert_second_factor_addition_template |
Modello email per annullare le aggiunte del secondo fattore. Questo campo viene restituito solo per le chiamate autenticate da uno sviluppatore. |
GetRecaptchaParamResponse
Messaggio di risposta per GetRecaptchaParam.
| Campi | |
|---|---|
kind |
|
recaptcha_stoken |
|
recaptcha_site_key |
La chiave di sito reCAPTCHA v2 utilizzata per richiamare il servizio reCAPTCHA. Sempre presente. |
producer_project_number |
Il numero del progetto del produttore utilizzato per generare i token PIA |
GetSessionCookiePublicKeysResponse
Messaggio di risposta per GetSessionCookiePublicKeys.
| Campi | |
|---|---|
keys[] |
Chiavi pubbliche del firmatario del cookie di sessione, formattate come JSON Web Key (JWK). |
IdpConfig
Configurazione di un provider di identità.
| Campi | |
|---|---|
provider |
|
enabled |
True se consente all'utente di accedere con il provider. |
experiment_percent |
Percentuale di utenti a cui verrà richiesto/reindirizzato l'accesso federato per questo IdP |
key |
ID client OAuth2. |
secret |
Client secret OAuth2. |
whitelisted_audiences[] |
ID client inseriti nella lista consentita per il controllo del segmento di pubblico. |
Provider
Nome del provider di identità.
| Enum | |
|---|---|
PROVIDER_UNSPECIFIED |
|
MSLIVE |
Microsoft Live come provider di identità. |
GOOGLE |
Google come provider di identità. |
FACEBOOK |
Facebook come provider di identità. |
PAYPAL |
PayPal come provider di identità. |
TWITTER |
Twitter come provider di identità. |
YAHOO |
Yahoo come provider di identità. |
AOL |
AOL come provider di identità. |
GITHUB |
GitHub come provider di identità. |
GOOGLE_PLAY_GAMES |
Google Play Giochi come provider di identità. |
LINKEDIN |
LinkedIn come provider di identità. |
IOS_GAME_CENTER |
Game Center di iOS come provider di identità. |
IssueSamlResponseRequest
Messaggio di richiesta per IssueSamlResponse.
| Campi | |
|---|---|
rp_id |
Identificatore della parte interessata, ovvero il pubblico della risposta SAML emessa. |
id_token |
Il token ID di Identity Platform. Verrà verificato e poi convertito in una nuova SAMLResponse. |
saml_app_entity_id |
L'ID entità dell'app SAML specificato nella Console di amministrazione Google per ogni app. Se gli sviluppatori vogliono reindirizzare a un'app di terze parti anziché a un'app G Suite, probabilmente ne avranno bisogno. Quando viene utilizzato, restituiremo un RelayState. È incluso un SAMLRequest, che può essere utilizzato per attivare un flusso SAML avviato dall'SP per reindirizzare all'app reale. |
IssueSamlResponseResponse
Risposta alla richiesta IssueSamlResponse.
| Campi | |
|---|---|
saml_response |
SAMLResponse firmato creato per la terza parte attendibile. |
acs_endpoint |
L'endpoint ACS che utilizza la risposta SAML restituita. |
relay_state |
Stato di inoltro generato. |
email |
Indirizzo email dell'utente. |
first_name |
Nome dell'utente. |
last_name |
Cognome dell'utente. |
is_new_user |
Indica se l'utente che ha eseguito l'accesso è stato creato da questa richiesta. |
MfaEnrollment
Informazioni sui provider di autenticazione a più fattori (MFA) abilitati per un account.
| Campi | |
|---|---|
mfa_enrollment_id |
ID di questa opzione MFA. |
display_name |
Nome visualizzato per questa opzione di autenticazione a due fattori, ad esempio "cellulare aziendale". |
enrolled_at |
Timestamp della registrazione di questo secondo fattore nell'account. |
Campo unione mfa_value. Il valore che definisce l'opzione MFA. mfa_value può essere solo uno dei seguenti: |
|
phone_info |
In genere viene visualizzato il numero di telefono associato a questa registrazione. In alcuni casi, ad esempio dopo un accesso con il primo fattore, verrà mostrata solo la versione offuscata del numero di telefono associato. |
totp_info |
Contiene informazioni specifiche sull'autenticazione a due fattori TOTP. |
email_info |
Contiene informazioni specifiche sull'autenticazione a due fattori via email. |
Campo unione
|
|
unobfuscated_phone_info |
Solo output. phone_info non offuscato. |
OobReqType
Il tipo di azione richiesto per un codice OOB.
| Enum | |
|---|---|
OOB_REQ_TYPE_UNSPECIFIED |
Il tipo di codice OOB non è specificato. |
PASSWORD_RESET |
reimposta password |
OLD_EMAIL_AGREE |
|
NEW_EMAIL_ACCEPT |
|
VERIFY_EMAIL |
verifica l'indirizzo email dell'account inviando un'email |
RECOVER_EMAIL |
|
EMAIL_SIGNIN |
Accedi solo con email |
VERIFY_AND_CHANGE_EMAIL |
Questo flusso invia un'email al nuovo indirizzo email specificato e, quando viene applicato facendo clic sul link nell'email, modifica l'indirizzo email dell'account con il nuovo indirizzo. Viene utilizzato quando l'account deve avere sempre un indirizzo email verificato, ad esempio gli account con autenticazione a due fattori. |
REVERT_SECOND_FACTOR_ADDITION |
|
OpenIdConnectKey
Rappresenta una chiave pubblica del firmatario del cookie di sessione, formattata come JSON Web Key (JWK).
| Campi | |
|---|---|
type |
Tipo di chiave. |
algorithm |
Algoritmo di firma. |
use |
Utilizzo della chiave. |
id |
Stringa univoca per identificare questa chiave. |
modulus |
Modulo per la chiave pubblica RSA, rappresentato come codifica base64url della rappresentazione big endian del valore. |
exponent |
Exponente per la chiave pubblica RSA, rappresentato come codifica base64url della rappresentazione big endian del valore. |
ProviderUserInfo
Informazioni sull'utente fornite da vari fornitori di servizi di identità.
| Campi | |
|---|---|
provider_id |
L'ID del provider di identità. |
display_name |
Il nome visualizzato dell'utente presso il provider di identità. |
photo_url |
L'URL della foto del profilo dell'utente presso il provider di identità. |
federated_id |
L'identificatore dell'utente presso il provider di identità. |
email |
L'indirizzo email dell'utente presso l'Identity Provider. |
raw_id |
L'identificatore non elaborato dell'utente restituito direttamente dal provider di identità. |
screen_name |
Lo screen_name dell'utente su Twitter o il nome di accesso su GitHub. |
phone_number |
Il numero di telefono dell'utente presso l'Identity Provider. |
QueryUserInfoRequest
Messaggio di richiesta per QueryUserInfo.
| Campi | |
|---|---|
return_user_info |
Se |
limit |
Il numero massimo di account da restituire con un limite massimo di 500. Il valore predefinito è 500. Valido solo quando |
offset |
Il numero di account da saltare dall'inizio dei record corrispondenti. Valido solo quando |
sort_by |
|
order |
|
target_project_id |
L'ID del progetto a cui è limitato l'ambito del risultato. L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
tenant_id |
L'ID del tenant a cui è associato l'ambito del risultato. |
expression[] |
|
Ordine
Un ordine per l'ordinamento del risultato della query.
| Enum | |
|---|---|
ORDER_UNSPECIFIED |
L'ordine non è specificato. |
ASC |
Ordina in ordine crescente. |
DESC |
Ordina in ordine decrescente. |
SortByField
Un campo da utilizzare per ordinare gli account utente.
| Enum | |
|---|---|
SORT_BY_FIELD_UNSPECIFIED |
Il campo di ordinamento non è specificato. |
USER_ID |
Ordina il risultato per userId. |
NAME |
Ordina il risultato per nome. |
CREATED_AT |
Ordina il risultato per createdAt. |
LAST_LOGIN_AT |
Ordina il risultato per lastLoginAt. |
USER_EMAIL |
Ordina il risultato per userEmail. |
SqlExpression
Condizioni di query utilizzate per filtrare i risultati.
| Campi | |
|---|---|
email |
Una stringa senza distinzione tra maiuscole e minuscole a cui deve corrispondere l'indirizzo email dell'account. In un'espressione Sql deve essere specificato un solo valore tra |
user_id |
Una stringa a cui deve corrispondere l'ID locale dell'account. In un'espressione Sql deve essere specificato un solo valore tra |
phone_number |
Una stringa a cui deve corrispondere il numero di telefono dell'account. In un'espressione Sql deve essere specificato solo uno dei valori |
QueryUserInfoResponse
Messaggio di risposta per QueryUserInfo.
| Campi | |
|---|---|
records_count |
Se |
user_info[] |
Se |
RecaptchaVersion
La versione di reCAPTCHA.
| Enum | |
|---|---|
RECAPTCHA_VERSION_UNSPECIFIED |
La versione di reCAPTCHA non è specificata. |
RECAPTCHA_ENTERPRISE |
reCAPTCHA Enterprise. |
ResetPasswordRequest
Messaggio di richiesta per ResetPassword.
| Campi | |
|---|---|
oob_code |
Un codice fuori banda (OOB) generato dalla richiesta GetOobCode. Specifica solo questo parametro (o solo questo parametro e un ID tenant) per ottenere il tipo di codice out-of-band nella risposta senza modificare lo stato dell'account. Tramite questo metodo è possibile utilizzare solo un codice PASSWORD_RESET out-of-band. |
new_password |
La nuova password da impostare per questo account. La specifica di questo campo comporterà una modifica dell'account e utilizzerà il codice out-of-band, se specificato e di tipo PASSWORD_RESET. |
old_password |
La password attuale dell'account da modificare. Specifica questo indirizzo e l'indirizzo email per cambiare la password di un account senza utilizzare un codice esterno. |
email |
Facoltativo. L'indirizzo email dell'account da modificare. Specifica questo codice e la password precedente per cambiare la password di un account senza utilizzare un codice esterno. |
tenant_id |
Facoltativo. L'ID del tenant di Identity Platform a cui appartiene l'account. |
ResetPasswordResponse
Messaggio di risposta per ResetPassword.
| Campi | |
|---|---|
kind |
|
email |
L'email associata al codice out-of-band utilizzato. |
new_email |
|
req_type |
|
mfa_info |
|
SendVerificationCodeRequest
Messaggio di richiesta per SendVerificationCode. "captcha_response" è obbligatorio quando reCAPTCHA Enterprise è abilitato, altrimenti è necessario specificare almeno uno dei valori (ios_receipt e ios_secret), recaptcha_token o safety_net_token per verificare che il codice di verifica venga inviato per conto di un'app reale e non di un emulatore.
| Campi | |
|---|---|
phone_number |
Il numero di telefono a cui inviare il codice di verifica in formato E.164. |
ios_receipt |
Ricezione della convalida del token dell'app per iOS. Se non viene utilizzato "captcha_response" (reCAPTCHA Enterprise non è abilitato), è necessario specificare almeno uno dei valori ( |
ios_secret |
Il secret viene inviato all'app per iOS sotto forma di notifica push. Deve essere passato con un |
recaptcha_token |
Token reCAPTCHA per la verifica dell'app. Se non viene utilizzato "captcha_response" (reCAPTCHA Enterprise non è abilitato), è necessario specificare almeno uno dei valori ( |
tenant_id |
ID del tenant di Identity Platform a cui l'utente sta accedendo. |
auto_retrieval_info |
Solo su Android. Utilizzato da Google Play Services per identificare l'app per il recupero automatico. |
safety_net_token |
Solo su Android. Utilizzato per affermare l'identità dell'applicazione al posto di un token recaptcha. Se non viene utilizzato "captcha_response" (reCAPTCHA Enterprise non è abilitato), è necessario specificare almeno uno dei valori ( |
play_integrity_token |
Solo su Android. Utilizzato per affermare l'identità dell'applicazione al posto di un token recaptcha (e safety_net_token). Se non viene utilizzato "captcha_response" (reCAPTCHA Enterprise non è abilitato), è necessario specificare almeno uno dei valori ( |
captcha_response |
Facoltativo. Il token reCAPTCHA Enterprise fornito dall'integrazione lato client di reCAPTCHA. Obbligatorio se reCAPTCHA Enterprise è attivato. |
client_type |
Facoltativo. Il tipo di client, web, android o ios. Obbligatorio se reCAPTCHA Enterprise è attivato. |
recaptcha_version |
Facoltativo. La versione reCAPTCHA del token reCAPTCHA in captcha_response. Obbligatorio quando reCAPTCHA Enterprise è attivato. |
AutoRetrievalInfo
Le informazioni necessarie per recuperare automaticamente un SMS.
| Campi | |
|---|---|
app_signature_hash |
L'hash della firma dell'app per Android per l'API SMS Retriever di Google Play Services. |
SendVerificationCodeResponse
Messaggio di risposta per SendVerificationCode.
| Campi | |
|---|---|
session_info |
Informazioni sulla sessione criptate. Questo può essere utilizzato in [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber] per autenticare il numero di telefono. |
SetAccountInfoRequest
Messaggio di richiesta per SetAccountInfo.
| Campi | |
|---|---|
id_token |
Un token ID Identity Platform valido. Obbligatorio quando si tenta di modificare le informazioni relative all'utente. |
local_id |
L'ID dell'utente. La specifica di questo campo richiede una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate. Per le richieste degli utenti finali, deve essere passato un token ID. |
display_name |
Il nuovo nome visualizzato dell'utente da aggiornare negli attributi dell'account. La lunghezza del nome visualizzato deve essere inferiore o uguale a 256 caratteri. |
email |
Il nuovo indirizzo email dell'utente da aggiornare negli attributi dell'account. La lunghezza dell'email deve essere inferiore a 256 caratteri e nel formato |
password |
La nuova password dell'utente da aggiornare negli attributi dell'account. La password deve contenere almeno 6 caratteri. |
provider[] |
Gli Identity Provider a cui deve essere associato l'account. |
oob_code |
Il codice out-of-band da applicare all'account dell'utente. Sono supportati i seguenti tipi di codici out-of-band: * VERIFY_EMAIL * RECOVER_EMAIL * REVERT_SECOND_FACTOR_ADDITION * VERIFY_AND_CHANGE_EMAIL |
email_verified |
Indica se l'indirizzo email dell'utente è stato verificato. La specifica di questo campo richiede una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate. |
upgrade_to_federated_login |
Indica se l'account deve essere limitato all'utilizzo solo dell'accesso federato. |
captcha_challenge |
|
captcha_response |
La risposta alla verifica reCAPTCHA. Questo è necessario quando il sistema rileva possibili attività illecite. |
valid_since |
Specifica il timestamp minimo in secondi affinché un token ID di Identity Platform sia considerato valido. |
disable_user |
Se true, l'account viene contrassegnato come disattivato, il che significa che l'utente non potrà più accedere. |
instance_id |
|
delegated_project_number |
|
photo_url |
Il nuovo URL della foto dell'utente per la foto del profilo dell'account da aggiornare negli attributi dell'account. La lunghezza dell'URL deve essere inferiore o uguale a 2048 caratteri. |
delete_attribute[] |
|
return_secure_token |
Se restituire o meno un ID e un token di aggiornamento. Deve sempre essere true. |
delete_provider[] |
Gli Identity Provider da scollegare dall'account dell'utente. |
last_login_at |
Il timestamp in millisecondi dell'ultimo accesso all'account. |
created_at |
Il timestamp in millisecondi della creazione dell'account. |
phone_number |
Il numero di telefono da aggiornare negli attributi dell'account. |
custom_attributes |
Attributi personalizzati in formato JSON da memorizzare nel token ID di Identity Platform. La specifica di questo campo richiede una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate. |
tenant_id |
L'ID del tenant di Identity Platform a cui appartiene l'account. Le richieste degli utenti finali devono passare un token ID di Identity Platform anziché impostare questo campo. |
target_project_id |
L'ID del progetto a cui appartiene l'account. La specifica di questo campo richiede le credenziali OAuth 2.0 di Google con le autorizzazioni appropriate. Le richieste degli utenti finali devono invece passare un token ID di Identity Platform. L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
mfa |
Le informazioni relative all'autenticazione a più fattori da impostare nell'account dell'utente. Verranno sovrascritte eventuali informazioni precedenti relative all'autenticazione a più fattori nell'account. La specifica di questo campo richiede una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate. |
link_provider_user_info |
Il fornitore da collegare all'account dell'utente. La specifica di questo campo richiede una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate. |
MfaInfo
Informazioni correlate all'autenticazione a più fattori.
| Campi | |
|---|---|
enrollments[] |
I secondi fattori registrati dall'utente. |
UserAttributeName
Gli attributi dell'account che possono essere eliminati.
| Enum | |
|---|---|
USER_ATTRIBUTE_NAME_UNSPECIFIED |
Il nome dell'attributo utente non è specificato. |
EMAIL |
Il nome della chiave dell'attributo utente è email. |
DISPLAY_NAME |
Il nome della chiave dell'attributo utente è displayName. |
PROVIDER |
Il nome della chiave dell'attributo utente è provider. |
PHOTO_URL |
Il nome della chiave dell'attributo utente è photoURL. |
PASSWORD |
Il nome della chiave dell'attributo utente è password. |
RAW_USER_INFO |
Il nome della chiave dell'attributo utente è rawUserInfo. |
SetAccountInfoResponse
Messaggio di risposta per SetAccountInfo
| Campi | |
|---|---|
kind |
|
local_id |
L'ID dell'utente autenticato. |
email |
L'indirizzo email dell'account. |
display_name |
Il nome visualizzato dell'account. |
id_token |
Un token ID di Identity Platform per l'account. Viene utilizzato per la registrazione degli utenti precedenti. |
provider_user_info[] |
I provider di identità collegati all'account. |
new_email |
La nuova email impostata negli attributi dell'account dell'utente. |
photo_url |
L'URL della foto dell'utente per la foto del profilo dell'account. |
refresh_token |
Un token di aggiornamento per l'account. Viene utilizzato per la registrazione degli utenti precedenti. |
expires_in |
Il numero di secondi che rimangono prima della scadenza del token ID di Identity Platform. |
password_hash |
Deprecato. Al momento non viene restituito alcun hash della password effettivo. |
email_verified |
Indica se l'indirizzo email dell'account è stato verificato. |
SignInWithCustomTokenRequest
Messaggio di richiesta per SignInWithCustomToken.
| Campi | |
|---|---|
token |
Obbligatorio. Il token di autenticazione personalizzato rivendicato dallo sviluppatore. Il token deve essere un token web JSON (JWT) che includa le attestazioni elencate nel riferimento API nella sezione "Attestazioni token personalizzate". |
instance_id |
|
return_secure_token |
Deve sempre essere true. |
delegated_project_number |
|
tenant_id |
L'ID del tenant Identity Platform a cui l'utente sta accedendo. Se presente, l'ID deve corrispondere a tenant_id nel token. |
SignInWithCustomTokenResponse
Messaggio di risposta per SignInWithCustomToken.
| Campi | |
|---|---|
kind |
|
id_token |
Un token ID Identity Platform per l'utente autenticato. |
refresh_token |
Un token di aggiornamento di Identity Platform per l'utente autenticato. |
expires_in |
Il numero di secondi che rimangono prima della scadenza del token ID. |
is_new_user |
Indica se l'utente autenticato è stato creato da questa richiesta. |
SignInWithEmailLinkRequest
Messaggio di richiesta per SignInWithEmailLink
| Campi | |
|---|---|
oob_code |
Obbligatorio. Il codice out-of-band dal link dell'email. |
email |
Obbligatorio. L'indirizzo email a cui è stato inviato il link di accesso. La lunghezza dell'email deve essere inferiore a 256 caratteri e nel formato |
id_token |
Un token ID valido per un account Identity Platform. Se viene passata, questa richiesta collegherà l'indirizzo email all'utente rappresentato da questo token ID e attiverà l'accesso con il link email nell'account per il futuro. |
tenant_id |
L'ID del tenant Identity Platform a cui l'utente sta accedendo. Se non è impostato, l'utente accederà al progetto Identity Platform predefinito. |
SignInWithEmailLinkResponse
Messaggio di risposta per SignInWithEmailLink.
| Campi | |
|---|---|
kind |
|
id_token |
Un token ID Identity Platform per l'utente autenticato. |
email |
L'indirizzo email con cui l'utente ha eseguito l'accesso. Sempre presente nella risposta. |
refresh_token |
Token di aggiornamento per l'utente autenticato. |
expires_in |
Il numero di secondi che rimangono prima della scadenza del token ID. |
local_id |
L'ID dell'utente autenticato. Sempre presente nella risposta. |
is_new_user |
Indica se l'utente autenticato è stato creato da questa richiesta. |
mfa_pending_credential |
Una stringa opaca che funge da prova del fatto che l'utente ha superato correttamente il controllo del primo fattore. |
mfa_info[] |
Informazioni sui fornitori di autenticazione a più fattori abilitati. Presente se l'utente deve completare l'accesso utilizzando l'autenticazione a più fattori. |
SignInWithGameCenterRequest
Messaggio di richiesta per SignInWithGameCenter
| Campi | |
|---|---|
player_id |
Obbligatorio. L'ID giocatore di Game Center dell'utente. È stato ritirato da Apple. Passa |
public_key_url |
Obbligatorio. L'URL per recuperare la chiave pubblica di Apple al fine di verificare la firma specificata è firmato da Apple. |
signature |
Obbligatorio. I dati della firma di verifica generati da Apple. |
salt |
Obbligatorio. Una stringa casuale utilizzata per generare la firma specificata. |
timestamp |
Obbligatorio. L'ora in cui la firma è stata creata da Apple, in millisecondi dall'epoca. |
id_token |
Un token ID valido per un account Identity Platform. Se presente, questa richiesta collegherà l'ID utente di Game Center all'account rappresentato da questo token ID. |
display_name |
Il nome visualizzato di Game Center dell'utente. |
tenant_id |
L'ID del tenant Identity Platform a cui l'utente sta accedendo. |
team_player_id |
L'ID giocatore del team di Game Center dell'utente. Un identificatore univoco per un giocatore di tutti i giochi che distribuisci utilizzando il tuo account sviluppatore. https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid |
game_player_id |
L'ID giocatore del gioco Game Center dell'utente. Un identificatore univoco per un giocatore del gioco. https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid |
SignInWithGameCenterResponse
Messaggio di risposta per signInWithGameCenter
| Campi | |
|---|---|
local_id |
L'ID dell'utente autenticato. Sempre presente nella risposta. |
player_id |
L'ID giocatore di Game Center dell'utente. Passa |
id_token |
Un token ID Identity Platform per l'utente autenticato. |
refresh_token |
Un token di aggiornamento di Identity Platform per l'utente autenticato. |
expires_in |
Il numero di secondi che rimangono prima della scadenza del token ID. |
is_new_user |
Indica se l'utente che ha eseguito l'accesso è stato creato da questa richiesta. |
display_name |
Nome visualizzato dell'utente autenticato. |
team_player_id |
L'ID giocatore del team di Game Center dell'utente. Un identificatore univoco per un giocatore di tutti i giochi che distribuisci utilizzando il tuo account sviluppatore. https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid |
game_player_id |
L'ID giocatore del gioco Game Center dell'utente. Un identificatore univoco per un giocatore del gioco. https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid |
SignInWithIdpRequest
Messaggio di richiesta per SignInWithIdp.
| Campi | |
|---|---|
request_uri |
Obbligatorio. L'URL a cui l'IdP reindirizza l'utente. Questo valore può essere impostato su |
post_body |
Se l'utente accede con una risposta di autorizzazione ottenuta tramite una precedente richiesta di autorizzazione CreateAuthUri, questo è il corpo del callback POST HTTP dall'IdP, se presente. In caso contrario, se l'utente accede con una credenziale dell'IDP fornita manualmente, deve essere un modulo con codifica URL contenente la credenziale (ad es. un token ID o un token di accesso per le IdP OAuth 2.0) e l'ID provider dell'IDP che ha emesso la credenziale. Ad esempio, se l'utente accede al provider Google utilizzando un token ID Google, questo valore deve essere impostato su id_token Se l'utente accede al provider Facebook utilizzando un token di autenticazione Facebook, questo valore deve essere impostato su id_token Se l'utente accede al provider Facebook utilizzando un token di accesso Facebook, questo valore deve essere impostato su access_token Se l'utente accede al provider Twitter utilizzando una credenziale OAuth 1.0 di Twitter, questo valore deve essere impostato su access_token |
pending_id_token |
|
return_refresh_token |
Se restituire o meno il token di aggiornamento OAuth dall'IdP, se disponibile. |
session_id |
L'ID sessione restituito da una chiamata CreateAuthUri precedente. Questo campo viene verificato in base a questo ID sessione per impedire attacchi di fissazione della sessione. Obbligatorio se l'utente accede con una risposta di autorizzazione da una precedente richiesta di autorizzazione CreateAuthUri. |
delegated_project_number |
|
id_token |
Un token ID Identity Platform valido. Se viene superato, l'account dell'utente presso l'IdP verrà collegato all'account rappresentato da questo token ID. |
return_secure_token |
Deve sempre essere true. |
return_idp_credential |
Indica se restituire o meno le credenziali OAuth dall'IDP in caso di errori |
auto_create |
|
tenant_id |
L'ID del tenant Identity Platform a cui l'utente sta accedendo. Se non è impostato, l'utente accederà al progetto Identity Platform predefinito. |
pending_token |
Una stringa opaca di una risposta precedente a SignInWithIdp. Se impostato, può essere utilizzato per ripetere l'operazione di accesso dall'operazione SignInWithIdp precedente. Questo può verificarsi se l'utente deve confermare i dati del proprio account nell'ambito di un precedente tentativo di accesso federato o eseguire il collegamento dell'account. |
SignInWithIdpResponse
Messaggio di risposta per SignInWithIdp.
| Campi | |
|---|---|
federated_id |
L'ID account dell'utente presso il provider di identità. Sempre presente nella risposta. |
provider_id |
L'ID provider dell'IdP a cui l'utente sta accedendo. Sempre presente nella risposta. |
email |
L'indirizzo email dell'account dell'utente presso l'IDP. |
email_verified |
Indica se l'indirizzo email dell'account utente è verificato. |
first_name |
Il nome dell'account dell'utente presso l'IDP. |
full_name |
Il nome completo dell'account dell'utente presso l'IDP. |
last_name |
Il cognome dell'account dell'utente presso l'IDP. |
nick_name |
Il nickname dell'account dell'utente presso l'IDP. |
language |
La preferenza di lingua per l'account dell'utente presso l'IDP. |
time_zone |
Il fuso orario dell'account dell'utente presso l'IDP. |
photo_url |
L'URL dell'immagine del profilo dell'utente nell'IDP. |
date_of_birth |
La data di nascita dell'account dell'utente presso l'SP. |
input_email |
|
original_email |
L'indirizzo email principale (di primo livello) dell'account Identity Platform dell'utente, se diverso dall'indirizzo email dell'IdP. Presente solo se è attiva l'impostazione "Un account per indirizzo email". |
local_id |
L'ID dell'utente di Identity Platform autenticato. Sempre presente nella risposta. |
email_recycled |
Se esiste o meno un account utente Identity Platform con lo stesso indirizzo email, ma collegato a un altro account nello stesso IdP. Presente solo se l'impostazione "Un account per indirizzo email" è attivata e l'indirizzo email presso l'IDP è verificato. |
display_name |
Il nome visualizzato dell'account dell'utente presso l'IDP. |
id_token |
Un token ID Identity Platform per l'utente autenticato. |
context |
La stringa opaca impostata in CreateAuthUri che viene utilizzata per mantenere le informazioni contestuali tra la richiesta di autenticazione e il callback dell'IDP. |
verified_provider[] |
Un elenco di ID provider a cui l'utente può accedere per risolvere un errore |
need_confirmation |
Se esiste o meno un account utente Identity Platform con lo stesso indirizzo email dell'account corrente che ha eseguito l'accesso all'IdP e se l'indirizzo email dell'account non è verificato nell'IdP. L'utente dovrà accedere all'account Identity Platform esistente e collegare le credenziali correnti dell'IdP. Presente solo se è attiva l'impostazione "Un account per indirizzo email". |
oauth_access_token |
Il token di accesso OAuth dell'IDP, se disponibile. |
oauth_refresh_token |
Il token di aggiornamento OAuth 2.0 dell'IDP, se disponibile e |
oauth_expire_in |
Il numero di secondi che rimangono prima della scadenza del token di accesso OAuth dell'IDP. |
oauth_authorization_code |
Il codice di autorizzazione OAuth 2.0, se disponibile. Presente solo per il provider Google. |
need_email |
|
oauth_token_secret |
Il secret del token OAuth 1.0 dell'IDP, se disponibile. Presente solo per il provider Twitter. |
refresh_token |
Un token di aggiornamento di Identity Platform per l'utente autenticato. |
expires_in |
Il numero di secondi che rimangono prima della scadenza del token ID di Identity Platform. |
oauth_id_token |
Il token ID OpenID Connect del provider di identità, se disponibile. |
screen_name |
Il nome visualizzato dell'account dell'utente presso l'IDP Twitter o il nome di accesso dell'account dell'utente presso l'IDP GitHub. |
raw_user_info |
La risposta JSON con stringa contenente tutti i dati corrispondenti all'account dell'utente presso l'IDP. |
error_message |
Il messaggio di errore restituito se |
is_new_user |
Indica se è stato creato o meno un nuovo account Identity Platform per l'utente autenticato. |
kind |
|
pending_token |
Una stringa opaca che può essere utilizzata come credenziale dell'IdP a cui l'utente accede. Il token in attesa ottenuto qui può essere impostato in una futura richiesta SignInWithIdp per far accedere di nuovo lo stesso utente con l'IdP. |
tenant_id |
Il valore del campo |
mfa_pending_credential |
Una stringa opaca che funge da prova che l'utente ha superato l'autenticazione a due fattori. |
mfa_info[] |
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. |
SignInWithPasswordRequest
Messaggio di richiesta per SignInWithPassword.
| 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. |
pending_id_token |
|
captcha_challenge |
|
captcha_response |
Il token reCAPTCHA fornito dall'integrazione lato client di reCAPTCHA. reCAPTCHA Enterprise lo utilizza per la valutazione del rischio. Obbligatorio se reCAPTCHA Enterprise è attivato. |
instance_id |
|
delegated_project_number |
|
id_token |
|
return_secure_token |
Deve sempre essere true. |
tenant_id |
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. |
client_type |
Il tipo di client, web, android o ios. Obbligatorio se reCAPTCHA Enterprise è attivato. |
recaptcha_version |
La versione reCAPTCHA del token reCAPTCHA in captcha_response. |
SignInWithPasswordResponse
Messaggio di risposta per SignInWithPassword.
| Campi | |
|---|---|
kind |
|
local_id |
L'ID dell'utente autenticato. Sempre presente nella risposta. |
email |
L'indirizzo email dell'utente autenticato. Sempre presente nella risposta. |
display_name |
Il nome visualizzato dell'utente memorizzato negli attributi dell'account. |
id_token |
Un token ID Identity Platform per l'utente autenticato. |
registered |
Indica se l'email è per un account esistente. Sempre true. |
profile_picture |
L'immagine del profilo dell'utente archiviata negli attributi dell'account. |
oauth_access_token |
Il token di accesso OAuth2. |
oauth_expire_in |
La data e l'ora di scadenza del token di accesso in secondi. |
oauth_authorization_code |
|
refresh_token |
Un token di aggiornamento di Identity Platform per l'utente autenticato. |
expires_in |
Il numero di secondi che rimangono prima della scadenza del token ID di Identity Platform. |
mfa_pending_credential |
Una stringa opaca che funge da prova che l'utente ha superato l'autenticazione a due fattori. |
mfa_info[] |
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. |
user_notifications[] |
Notifiche di avviso per l'utente. |
SignInWithPhoneNumberRequest
Messaggio di richiesta per SignInWithPhoneNumber.
| Campi | |
|---|---|
session_info |
Informazioni sulla sessione criptate dalla risposta di [sendVerificationCode][v1.accounts.sendVerificationCode]. Se l'autenticazione avviene con un codice SMS, questo valore deve essere specificato, ma se viene utilizzata una prova temporanea, può essere non specificato. |
phone_number |
Il numero di telefono dell'utente con cui accedere. Questo è necessario nel caso in cui venga utilizzata una prova temporanea, in cui deve corrispondere al numero di telefono autenticato nella richiesta che ha generato la prova temporanea. Questo campo viene ignorato se viene passata una sessione. |
code |
Codice di verifica inserito dall'utente da un SMS inviato al suo telefono. |
temporary_proof |
Una prova della verifica del numero di telefono, fornita da una richiesta [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber] precedente. Se questo valore viene passato, l'utente che chiama deve anche passare nel campo phone_number il numero di telefono verificato nella richiesta precedente. |
verification_proof |
Non utilizzare. |
id_token |
Un token ID valido per un account Identity Platform. Se viene passata, questa richiesta collegherà il numero di telefono all'utente rappresentato da questo token ID se il numero di telefono non è in uso oppure autentica di nuovo l'utente se il numero di telefono è già collegato all'utente. |
operation |
|
tenant_id |
L'ID del tenant Identity Platform a cui l'utente sta accedendo. Se non è impostato, l'utente accederà al progetto Identity Platform predefinito. |
VerifyOp
Operazione prevista.
| Enum | |
|---|---|
VERIFY_OP_UNSPECIFIED |
L'operazione non è specificata. |
SIGN_UP_OR_IN |
Verifica che l'operazione sia la registrazione/l'accesso. |
REAUTH |
Verifica che l'operazione sia di autenticazione. |
UPDATE |
Verifica che l'operazione sia di aggiornamento. |
LINK |
Verifica che l'operazione sia di collegamento. |
SignInWithPhoneNumberResponse
Messaggio di risposta per SignInWithPhoneNumber.
| Campi | |
|---|---|
id_token |
Token ID di Identity Platform per l'utente autenticato. |
refresh_token |
Token di aggiornamento per l'utente autenticato. |
expires_in |
Il numero di secondi che rimangono prima della scadenza del token ID. |
local_id |
L'ID dell'utente autenticato. Presente in caso di autenticazione riuscita. Se lo smartphone è stato verificato, ma non è stato possibile eseguire l'operazione sull'account, verrà restituita una prova temporanea. |
is_new_user |
Indica se l'utente autenticato è stato creato da questa richiesta. |
temporary_proof |
Una prova della verifica del numero di telefono, fornita se l'autenticazione telefonica è andata a buon fine, ma l'operazione dell'utente non è riuscita. Questo accade quando la richiesta tenta di collegare un numero di telefono a un utente con un token ID o di eseguire la riconferma con un token ID, ma il numero di telefono è collegato a un altro utente. |
verification_proof |
Non utilizzare. |
verification_proof_expires_in |
Non utilizzare. |
phone_number |
Numero di telefono dell'utente autenticato. Sempre presente nella risposta. |
temporary_proof_expires_in |
Il numero di secondi che mancano alla scadenza della prova temporanea. |
SignUpRequest
Messaggio di richiesta per la registrazione.
| Campi | |
|---|---|
email |
L'indirizzo email da assegnare all'utente creato. La lunghezza dell'email deve essere inferiore a 256 caratteri e deve essere nel formato |
password |
La password da assegnare all'utente creato. La password deve contenere almeno 6 caratteri. Se impostato, deve essere impostato anche il campo |
display_name |
Il nome visualizzato dell'utente da creare. |
captcha_challenge |
|
captcha_response |
Il token reCAPTCHA fornito dall'integrazione lato client di reCAPTCHA. reCAPTCHA Enterprise lo utilizza per la valutazione. Obbligatorio se reCAPTCHA Enterprise è attivato. |
instance_id |
|
id_token |
Un token ID valido per un utente di Identity Platform. Se impostato, questa richiesta collegherà la credenziale di autenticazione all'utente rappresentato da questo token ID. Per una richiesta non di amministratore, devono essere impostati entrambi i campi |
email_verified |
Indica se l'indirizzo email dell'utente è verificato. La specifica di questo campo richiede una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate. |
photo_url |
L'URL della foto del profilo dell'utente da creare. |
disabled |
Indica se l'utente verrà disattivato al momento della creazione. Gli account disattivati non sono accessibili, ad eccezione delle richieste che contengono una credenziale OAuth2 di Google con le autorizzazioni appropriate. |
local_id |
L'ID dell'utente da creare. L'ID deve essere univoco all'interno del progetto in cui viene creato l'utente. La specifica di questo campo richiede una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate. |
phone_number |
Il numero di telefono dell'utente da creare. La specifica di questo campo richiede una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate. |
tenant_id |
L'ID del tenant di Identity Platform in cui creare un utente. Se non è impostato, l'utente verrà creato nel progetto Identity Platform predefinito. |
target_project_id |
L'ID del progetto a cui deve appartenere l'utente. La specifica di questo campo richiede una credenziale OAuth 2.0 di Google con le autorizzazioni appropriate. Se non è impostato, il progetto di destinazione viene dedotto dall'ambito associato al token di accesso con autorizzazione. |
mfa_info[] |
I provider di autenticazione a più fattori da creare dall'utente. |
client_type |
Il tipo di client: web, Android o iOS. Obbligatorio per attivare la protezione reCAPTCHA Enterprise. |
recaptcha_version |
La versione reCAPTCHA del token reCAPTCHA in captcha_response. |
MfaFactor
| Campi | |
|---|---|
display_name |
Nome visualizzato per questa opzione di autenticazione a due fattori, ad esempio "cellulare aziendale". |
Campo unione
|
|
phone_info |
Numero di telefono per ricevere l'OTP per l'autenticazione a due fattori. |
SignUpResponse
Messaggio di risposta per SignUp.
| Campi | |
|---|---|
kind |
|
id_token |
Un token ID di Identity Platform per l'utente creato. Questo campo viene impostato solo per le richieste non amministrative. |
display_name |
Il nome visualizzato dell'utente creato. |
email |
L'indirizzo email dell'utente creato. |
refresh_token |
Un token di aggiornamento di Identity Platform per l'utente creato. Questo campo viene impostato solo per le richieste non amministrative. |
expires_in |
Il numero di secondi che rimangono prima della scadenza del token ID. |
local_id |
L'ID dell'utente creato. Sempre presente nella risposta. |
TotpInfo
Questo tipo non contiene campi.
Informazioni sulla verifica in due passaggi TOTP.
UploadAccountRequest
Messaggio di richiesta per UploadAccount.
| Campi | |
|---|---|
hash_algorithm |
Obbligatorio. La funzione di hashing utilizzata per sottoporre ad hashing le password dell'account. Deve essere uno dei seguenti: * HMAC_SHA256 * HMAC_SHA1 * HMAC_MD5 * SCRYPT * PBKDF_SHA1 * MD5 * HMAC_SHA512 * SHA1 * BCRYPT * PBKDF2_SHA256 * SHA256 * SHA512 * STANDARD_SCRYPT * ARGON2 |
signer_key |
La chiave di firma utilizzata per sottoporre ad hashing la password. Obbligatorio per le seguenti funzioni di hashing: * SCRYPT, * HMAC_MD5, * HMAC_SHA1, * HMAC_SHA256, * HMAC_SHA512 |
salt_separator |
Uno o più byte da inserire tra il sale e la password in testo normale. Per una maggiore sicurezza, deve essere un singolo carattere non stampabile. |
rounds |
Il numero di round utilizzati per il calcolo dell'hash. Obbligatorio solo per le seguenti funzioni di hashing: * MD5 * SHA1 * SHA256 * SHA512 * PBKDF_SHA1 * PBKDF2_SHA256 * SCRYPT |
memory_cost |
Costo della memoria per il calcolo dell'hash. Obbligatorio solo se la funzione di hashing è SCRYPT. |
users[] |
Un elenco di account da caricare. |
delegated_project_number |
|
sanity_check |
Se il valore è true, il servizio eseguirà il seguente elenco di controlli prima del caricamento di un account: * Email duplicate * ID federati duplicati * Convalida del provider di ID federato Se la duplicazione esiste nell'elenco degli account da caricare, ne verrà impedito il caricamento dell'intero elenco. Se l'email o l'ID federato è un duplicato di un utente già presente nel progetto/tenant, l'account non verrà caricato, ma gli altri account non saranno interessati. Se è falso, questi controlli verranno ignorati. |
target_project_id |
L'ID progetto del progetto Identity Platform a cui appartiene l'account. L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
allow_overwrite |
Indica se sovrascrivere un account esistente in Identity Platform con un |
cpu_mem_cost |
Il parametro del costo della memoria della CPU da utilizzare dalla funzione di hashing STANDARD_SCRYPT. Questo parametro, insieme a block_size e cpu_mem_cost, consente di ottimizzare le risorse necessarie per sottoporre ad hashing una password e deve essere ottimizzato man mano che le velocità del processore e le tecnologie di memoria avanzano. |
parallelization |
Il parametro del costo di parallellizzazione da utilizzare dalla funzione di hashing STANDARD_SCRYPT. Questo parametro, insieme a block_size e cpu_mem_cost, consente di ottimizzare le risorse necessarie per sottoporre ad hashing una password e deve essere ottimizzato man mano che le velocità del processore e le tecnologie di memoria avanzano. |
block_size |
Il parametro della dimensione del blocco utilizzato dalla funzione di hashing STANDARD_SCRYPT. Questo parametro, insieme alla parallellizzazione e a cpu_mem_cost, consente di ottimizzare le risorse necessarie per sottoporre ad hashing una password e deve essere ottimizzato man mano che le velocità del processore e le tecnologie di memoria avanzano. |
dk_len |
La lunghezza della chiave desiderata per la funzione di hashing STANDARD_SCRYPT. Deve essere almeno 1. |
password_hash_order |
|
tenant_id |
L'ID del tenant di Identity Platform a cui appartiene l'account. |
argon2_parameters |
I parametri per l'algoritmo di hashing Argon2. |
PasswordHashOrder
Quando esegui l'hashing delle password, se la password deve precedere o seguire il sale.
| Enum | |
|---|---|
UNSPECIFIED_ORDER |
L'ordine non è specificato. |
SALT_AND_PASSWORD |
L'ordine è prima il sale e poi la password. |
PASSWORD_AND_SALT |
L'ordine è prima la password e poi il sale. |
UploadAccountResponse
Messaggio di risposta per UploadAccount.
| Campi | |
|---|---|
kind |
|
error[] |
Informazioni dettagliate sugli errori relativi agli account che non possono essere caricati. |
UserInfo
Le informazioni di un account Identity Platform.
| Campi | |
|---|---|
local_id |
Immutabile. L'ID univoco dell'account. |
email |
L'indirizzo email dell'account. La lunghezza dell'email deve essere inferiore a 256 caratteri e nel formato |
display_name |
Il nome visualizzato dell'account. Questo attributo account non è utilizzato da Identity Platform. È disponibile solo a scopo informativo. |
language |
Solo output. La preferenza di lingua dell'account. Questo attributo account non è utilizzato da Identity Platform. È disponibile solo a scopo informativo. |
photo_url |
L'URL della foto del profilo dell'account. Questo attributo account non è utilizzato da Identity Platform. È disponibile solo a scopo informativo. |
time_zone |
Solo output. La preferenza del fuso orario dell'account. Questo attributo account non è utilizzato da Identity Platform. È disponibile solo a scopo informativo. |
date_of_birth |
Solo output. La data di nascita impostata per l'account. Questo attributo account non è utilizzato da Identity Platform. È disponibile solo a scopo informativo. |
password |
La password sottoposta ad hashing dell'account. Accessibile solo da richieste con una credenziale OAuth2 di Google con le autorizzazioni appropriate. |
salt |
Il salt della password dell'account. Accessibile solo da richieste con una credenziale OAuth2 di Google con le autorizzazioni appropriate. |
version |
La versione della password dell'account. Accessibile solo da richieste con una credenziale OAuth2 di Google con le autorizzazioni appropriate. |
email_verified |
Indica se l'indirizzo email dell'account è stato verificato. |
password_updated_at |
Il timestamp, in millisecondi dall'epoca 1970-01-01T00:00:00Z, dell'ultimo aggiornamento della password dell'account. |
provider_user_info[] |
Informazioni sull'utente fornite da vari fornitori di servizi di identità. |
valid_since |
Il timestamp più antico, in secondi dall'epoca, per cui un token ID deve essere considerato valido. Tutti gli ID token emessi prima di questo orario sono considerati non validi. |
disabled |
Indica se l'account è disattivato. Gli account disattivati non sono accessibili, ad eccezione delle richieste che contengono una credenziale OAuth2 di Google con le autorizzazioni appropriate. |
last_login_at |
L'ultima volta, in millisecondi dall'epoca, in cui è stato eseguito l'accesso a questo account. |
created_at |
L'ora in cui è stato creato l'account, in millisecondi dall'epoca. |
screen_name |
Solo output. Lo screen name di questo account su Twitter o il nome di accesso su GitHub. |
custom_auth |
Solo output. Indica se questo account è stato autenticato utilizzando SignInWithCustomToken. |
raw_password |
Solo input. Password in testo normale utilizzata per aggiornare la password di un account. Questo campo viene utilizzato solo come input in una richiesta. Identity Platform utilizza l'hashing con crittografia sicura per gestire le password e non memorizza né trasmette mai la password di un utente in testo non criptato. |
phone_number |
Il numero di telefono dell'account. |
custom_attributes |
Claim personalizzati da aggiungere a qualsiasi token ID creato per l'account. Deve avere una lunghezza massima di 1000 caratteri e deve essere in formato JSON valido. |
email_link_signin |
Solo output. Indica se l'account può autenticarsi con il link email. |
tenant_id |
ID del tenant a cui appartiene l'account. Impostato solo se questo account appartiene a un tenant. |
mfa_info[] |
Informazioni sui provider di autenticazione a più fattori abilitati per questo account. |
initial_email |
Il primo indirizzo email associato a questo account. L'indirizzo email iniziale dell'account non può essere modificato una volta impostato e viene utilizzato per recuperare l'accesso a questo account in caso di perdita tramite il flusso RECOVER_EMAIL in GetOobCode. Deve corrispondere all'addr-spec RFC 822. |
last_refresh_at |
Timestamp dell'ultima emissione di un token ID per questo account. |
UserNotification
Notifiche di avviso per l'utente.
| Campi | |
|---|---|
notification_code |
Enum di notifica di avviso. Può essere utilizzato per la localizzazione. |
notification_message |
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. |
VerifyIosClientRequest
Messaggio di richiesta per VerifyIosClient
| Campi | |
|---|---|
app_token |
Un token dispositivo che il client iOS riceve dopo la registrazione ad APN (Apple Push Notification Service). |
is_sandbox |
Indica se il token dell'app si trova nella sandbox di iOS. Se false, il token dell'app si trova nell'ambiente di produzione. |
VerifyIosClientResponse
Messaggio di risposta per VerifyIosClient.
| Campi | |
|---|---|
receipt |
Ricezione della convalida del token dell'app riuscita. |
suggested_timeout |
Tempo suggerito in secondi che il client deve attendere per la consegna della notifica push. |