Indice
ProjectConfigService(interfaccia)TenantManagementService(interfaccia)BlockingFunctionsConfig(messaggio)BlockingFunctionsConfig.Trigger(messaggio)ClientConfig(messaggio)ClientConfig.Permissions(messaggio)Config(messaggio)Config.Subtype(enum)CreateDefaultSupportedIdpConfigRequest(messaggio)CreateInboundSamlConfigRequest(messaggio)CreateOAuthIdpConfigRequest(messaggio)CreateTenantRequest(messaggio)DefaultSupportedIdp(messaggio)DefaultSupportedIdpConfig(messaggio)DeleteDefaultSupportedIdpConfigRequest(messaggio)DeleteInboundSamlConfigRequest(messaggio)DeleteOAuthIdpConfigRequest(messaggio)DeleteTenantRequest(messaggio)EnableCicpRequest(messaggio)EnableCicpResponse(messaggio)GetConfigRequest(messaggio)GetDefaultSupportedIdpConfigRequest(messaggio)GetInboundSamlConfigRequest(messaggio)GetOAuthIdpConfigRequest(messaggio)GetTenantRequest(messaggio)HashConfig(messaggio)HashConfig.HashAlgorithm(enum)IdpCertificate(messaggio)InboundSamlConfig(messaggio)InboundSamlConfig.IdpConfig(messaggio)InboundSamlConfig.SpConfig(messaggio)ListDefaultSupportedIdpConfigsRequest(messaggio)ListDefaultSupportedIdpConfigsResponse(messaggio)ListDefaultSupportedIdpsRequest(messaggio)ListDefaultSupportedIdpsResponse(messaggio)ListInboundSamlConfigsRequest(messaggio)ListInboundSamlConfigsResponse(messaggio)ListOAuthIdpConfigsRequest(messaggio)ListOAuthIdpConfigsResponse(messaggio)ListTenantsRequest(messaggio)ListTenantsResponse(messaggio)MonitoringConfig(messaggio)MonitoringConfig.RequestLogging(messaggio)MultiFactorAuthConfig(messaggio)MultiFactorAuthConfig.Provider(enum)MultiFactorAuthConfig.State(enum)NotificationConfig(messaggio)NotificationConfig.SendEmail(messaggio)NotificationConfig.SendEmail.DnsInfo(messaggio)NotificationConfig.SendEmail.DnsInfo.VerificationState(enum)NotificationConfig.SendEmail.EmailTemplate(messaggio)NotificationConfig.SendEmail.EmailTemplate.BodyFormat(enum)NotificationConfig.SendEmail.Method(enum)NotificationConfig.SendEmail.Smtp(messaggio)NotificationConfig.SendEmail.Smtp.SecurityMode(enum)NotificationConfig.SendSms(messaggio)NotificationConfig.SendSms.SmsTemplate(messaggio)OAuthIdpConfig(messaggio)OAuthIdpConfig.OAuthResponseType(messaggio)QuotaConfig(messaggio)QuotaConfig.TemporaryQuota(messaggio)SignInConfig(messaggio)SignInConfig.Anonymous(messaggio)SignInConfig.Email(messaggio)SignInConfig.PhoneNumber(messaggio)SpCertificate(messaggio)Tenant(messaggio)UpdateConfigRequest(messaggio)UpdateDefaultSupportedIdpConfigRequest(messaggio)UpdateInboundSamlConfigRequest(messaggio)UpdateOAuthIdpConfigRequest(messaggio)UpdateTenantRequest(messaggio)VerifyDomainRequest(messaggio)VerifyDomainRequest.DomainVerificationAction(enum)VerifyDomainResponse(messaggio)
ProjectConfigService
Configurazione del progetto per Identity Toolkit
| CreateDefaultSupportedIdpConfig |
|---|
|
Crea una configurazione predefinita del provider di identità supportata per un progetto Identity Toolkit.
|
| CreateInboundSamlConfig |
|---|
|
Crea una configurazione SAML in entrata per un progetto Identity Toolkit.
|
| CreateOAuthIdpConfig |
|---|
|
Crea una configurazione del provider di identità OIDC per un progetto Identity Toolkit.
|
| DeleteDefaultSupportedIdpConfig |
|---|
|
Elimina una configurazione IdP supportata predefinita per un progetto Identity Toolkit.
|
| DeleteInboundSamlConfig |
|---|
|
Elimina una configurazione SAML in entrata per un progetto Identity Toolkit.
|
| DeleteOAuthIdpConfig |
|---|
|
Elimina una configurazione del provider di identità OIDC per un progetto Identity Toolkit.
|
| EnableCicp |
|---|
|
Abilita CICP per un progetto Cloud. Cloud Identity for Customers and Partners (o CICP) è un sistema di autenticazione end-to-end che consente agli utenti di terze parti di accedere alle tue app e ai tuoi servizi. Potrebbero essere incluse app mobile/web, giochi, API e altro ancora.
|
| GetConfig |
|---|
|
Recupera una configurazione del progetto Identity Toolkit.
|
| GetDefaultSupportedIdpConfig |
|---|
|
Recupera una configurazione predefinita del provider di identità supportata per un progetto Identity Toolkit.
|
| GetInboundSamlConfig |
|---|
|
Recupera una configurazione SAML in entrata per un progetto Identity Toolkit.
|
| GetOAuthIdpConfig |
|---|
|
Recupera una configurazione Idp Oidc per un progetto Identity Toolkit.
|
| ListDefaultSupportedIdpConfigs |
|---|
|
Elenca tutte le configurazioni Idp supportate predefinite per un progetto Identity Toolkit.
|
| ListDefaultSupportedIdps |
|---|
|
Elenca tutti gli IdP supportati per impostazione predefinita.
|
| ListInboundSamlConfigs |
|---|
|
Elenca tutte le configurazioni SAML in entrata per un progetto Identity Toolkit.
|
| ListOAuthIdpConfigs |
|---|
|
Elenca tutte le configurazioni Idp Oidc per un progetto Identity Toolkit.
|
| UpdateConfig |
|---|
|
Aggiornare la configurazione di un progetto Identity Toolkit.
|
| UpdateDefaultSupportedIdpConfig |
|---|
|
Aggiorna una configurazione predefinita del provider di identità supportata per un progetto Identity Toolkit.
|
| UpdateInboundSamlConfig |
|---|
|
Aggiorna una configurazione SAML in entrata per un progetto Identity Toolkit.
|
| UpdateOAuthIdpConfig |
|---|
|
Aggiorna la configurazione di un provider di identità OIDC per un progetto Identity Toolkit.
|
| VerifyDomain |
|---|
|
Verifica che il dominio personalizzato richiesto abbia i record DNS richiesti.
|
TenantManagementService
Servizio di gestione degli utenti per GCIP.
| CreateTenant |
|---|
|
Crea un tenant. Richiede l'autorizzazione di scrittura per il progetto Agent.
|
| DeleteTenant |
|---|
|
Eliminare un tenant. Richiede l'autorizzazione di scrittura per il progetto Agent.
|
| GetTenant |
|---|
|
Ottieni un tenant. Richiede l'autorizzazione di lettura per la risorsa Tenant.
|
| ListTenants |
|---|
|
Elenca gli utenti nel progetto dell'agente specificato. Richiede l'autorizzazione di lettura per il progetto Agent.
|
| UpdateTenant |
|---|
|
Aggiorna un tenant. Richiede l'autorizzazione di scrittura per la risorsa tenant.
|
BlockingFunctionsConfig
Configurazione relativa alle funzioni di blocco.
| Campi | |
|---|---|
triggers |
Mappa dell'attivatore al tipo di evento. La chiave deve essere uno dei tipi di eventi supportati: "beforeCreate", "beforeSignIn" |
Trigger
Funzione Cloud sincrona con trigger HTTP
| Campi | |
|---|---|
function_uri |
Trigger URI HTTP per la funzione Cloud. |
update_time |
Quando l'attivatore è stato modificato. |
ClientConfig
Opzioni relative alla configurazione dei client che inviano richieste per conto di un progetto.
| Campi | |
|---|---|
api_key |
Solo output. Chiave API che può essere utilizzata per effettuare richieste per questo progetto. |
permissions |
Configurazione relativa alla limitazione della capacità di un utente di influire sul proprio account. |
firebase_subdomain |
Solo output. Sottodominio Firebase. |
Autorizzazioni
Configurazione relativa alla limitazione della capacità di un utente di modificare il proprio account.
| Campi | |
|---|---|
disabled_user_signup |
Se il valore è true, gli utenti finali non possono creare un nuovo account nel progetto associato tramite nessuno dei nostri metodi API |
disabled_user_deletion |
Se il valore è true, gli utenti finali non possono eliminare il proprio account nel progetto associato tramite nessuno dei nostri metodi API |
Configurazione
Rappresenta un progetto Identity Toolkit.
| Campi | |
|---|---|
name |
Solo output. Il nome della risorsa Config. Esempio: "projects/my-awesome-project/config" |
sign_in |
Configurazione relativa ai metodi di accesso locale. |
notification |
Configurazione relativa all'invio di notifiche agli utenti. |
quota |
Configurazione relativa alle quote. |
monitoring |
Configurazione relativa al monitoraggio dell'attività del progetto. |
authorized_domains[] |
Elenco dei domini autorizzati per i reindirizzamenti OAuth |
subtype |
Solo output. Il sottotipo di questa configurazione. |
client |
Opzioni relative alla configurazione dei client che inviano richieste per conto di un progetto. |
mfa |
Configurazione dell'autenticazione a più fattori di questo progetto, inclusa la sua attivazione e i fattori che possono essere utilizzati per il secondo fattore |
blocking_functions |
Configurazione relativa alle funzioni di blocco. |
Sottotipo
Il sottotipo di questa configurazione.
| Enum | |
|---|---|
SUBTYPE_UNSPECIFIED |
Valore predefinito. Non utilizzare. |
CUSTOMER_IDENTITY |
Un progetto Customer Identity. |
FIREBASE_AUTH |
Un progetto Firebase Authentication. |
CreateDefaultSupportedIdpConfigRequest
Richiesta per CreateDefaultSupportedIdpConfig
| Campi | |
|---|---|
parent |
Il nome della risorsa principale in cui deve essere creata la configurazione, ad esempio: "projects/my-awesome-project" L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
idp_id |
L'ID dell'IdP per cui creare una configurazione. Chiama ListDefaultSupportedIdps per un elenco di tutti gli IdP supportati per impostazione predefinita. |
default_supported_idp_config |
La risorsa di configurazione che sostituisce la risorsa sul server. |
CreateInboundSamlConfigRequest
Richiesta per CreateInboundSamlConfig
| Campi | |
|---|---|
parent |
Il nome della risorsa principale in cui deve essere creata la configurazione, ad esempio: "projects/my-awesome-project" L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
inbound_saml_config_id |
L'ID da utilizzare per questa configurazione. |
inbound_saml_config |
La risorsa di configurazione da creare. Il client non deve impostare il campo |
CreateOAuthIdpConfigRequest
Richiesta per CreateOAuthIdpConfig
| Campi | |
|---|---|
parent |
Il nome della risorsa principale in cui deve essere creata la configurazione, ad esempio: "projects/my-awesome-project" L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
oauth_idp_config_id |
L'ID da utilizzare per questa configurazione. |
oauth_idp_config |
La risorsa di configurazione da creare. Il client non deve impostare il campo |
CreateTenantRequest
Messaggio di richiesta per CreateTenant.
| Campi | |
|---|---|
parent |
Il nome della risorsa principale in cui verrà creato il tenant. Ad esempio, "projects/project1". L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
tenant |
Obbligatorio. Tenant da creare. |
DefaultSupportedIdp
Provider di identità attendibili di Identity Toolkit standard.
| Campi | |
|---|---|
idp_id |
ID dell'IdP |
description |
Descrizione dell'IDP |
DefaultSupportedIdpConfig
Opzioni di configurazione per l'autenticazione con un insieme standard di provider di identità attendibili di Identity Toolkit.
| Campi | |
|---|---|
name |
Il nome della risorsa DefaultSupportedIdpConfig, ad esempio: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com" |
enabled |
True se consente all'utente di accedere con il provider. |
client_id |
ID client OAuth. |
client_secret |
Client secret OAuth. |
display_on_cloud_console |
Solo output. Indica se mostrare la configurazione dell'IdP su Pantheon se l'IdP è in stato di disattivazione. |
DeleteDefaultSupportedIdpConfigRequest
Richiesta per DeleteDefaultSupportedIdpConfig
| Campi | |
|---|---|
name |
Il nome risorsa della configurazione, ad esempio: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com" L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
DeleteInboundSamlConfigRequest
Richiesta per l'eliminazione di DeleteInboundSamlConfig
| Campi | |
|---|---|
name |
Il nome della risorsa della configurazione da eliminare, ad esempio: "projects/my-awesome-project/inboundSamlConfigs/my-config-id". L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
DeleteOAuthIdpConfigRequest
Richiesta per l'eliminazione di DeleteOAuthIdpConfig
| Campi | |
|---|---|
name |
Il nome della risorsa della configurazione da eliminare, ad esempio: "projects/my-awesome-project/oauthIdpConfigs/oauth-config-id". L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
DeleteTenantRequest
Messaggio di richiesta per DeleteTenant.
| Campi | |
|---|---|
name |
Nome della risorsa del tenant da eliminare. L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
EnableCicpRequest
Richiesta per EnableCicp.
| Campi | |
|---|---|
project |
Il nome della risorsa del progetto di destinazione per cui lo sviluppatore vuole attivare il CICP. L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
EnableCicpResponse
Questo tipo non contiene campi.
Risposta per EnableCicp. Per il momento vuoto.
GetConfigRequest
Richiesta di GetConfig
| Campi | |
|---|---|
name |
Il nome della risorsa della configurazione, ad esempio: "projects/my-awesome-project/config" L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
GetDefaultSupportedIdpConfigRequest
Richiesta per GetDefaultSupportedIdpConfig
| Campi | |
|---|---|
name |
Il nome risorsa della configurazione, ad esempio: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com" L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
GetInboundSamlConfigRequest
Richiesta per GetInboundSamlConfig
| Campi | |
|---|---|
name |
Il nome della risorsa della configurazione, ad esempio: "projects/my-awesome-project/inboundSamlConfigs/my-config-id". L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
GetOAuthIdpConfigRequest
Richiesta per GetOAuthIdpConfig
| Campi | |
|---|---|
name |
Il nome della risorsa della configurazione, ad esempio: "projects/my-awesome-project/oauthIdpConfigs/oauth-config-id". L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
GetTenantRequest
Messaggio di richiesta per GetTenant.
| Campi | |
|---|---|
name |
Nome della risorsa del tenant da recuperare. L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
HashConfig
Informazioni sulla cronologia dell'algoritmo di hashing e della chiave. Le password di account diversi potrebbero essere generate da versioni diverse.
| Campi | |
|---|---|
algorithm |
Solo output. Diversi algoritmi di hash per password utilizzati in Identity Toolkit. |
signer_key |
Solo output. Chiave del firmatario in base64. |
salt_separator |
Solo output. Carattere non stampabile da inserire tra il sale e la password in testo normale in base64. |
rounds |
Solo output. Il numero di round per il calcolo dell'hash. Utilizzato da scrypt e da altri algoritmi di derivazione della password simili. |
memory_cost |
Solo output. Costo della memoria per il calcolo dell'hash. Utilizzato da scrypt e da altri algoritmi di derivazione della password simili. Per una spiegazione del campo, visita la pagina https://tools.ietf.org/html/rfc7914. |
HashAlgorithm
Diversi algoritmi di hash per password utilizzati in Identity Toolkit.
| Enum | |
|---|---|
HASH_ALGORITHM_UNSPECIFIED |
Valore predefinito. Non utilizzare. |
HMAC_SHA256 |
HMAC_SHA256 |
HMAC_SHA1 |
HMAC_SHA1 |
HMAC_MD5 |
HMAC_MD5 |
SCRYPT |
SCRYPT |
PBKDF_SHA1 |
PBKDF_SHA1 |
MD5 |
MD5 |
HMAC_SHA512 |
HMAC_SHA512 |
SHA1 |
SHA1 |
BCRYPT |
BCRYPT |
PBKDF2_SHA256 |
PBKDF2_SHA256 |
SHA256 |
SHA256 |
SHA512 |
SHA512 |
STANDARD_SCRYPT |
STANDARD_SCRYPT |
IdpCertificate
Il proto per i dati del certificato dell'IdP per verificare la firma nella risposta SAML emessa dall'IdP.
| Campi | |
|---|---|
x509_certificate |
Il certificato x509 |
InboundSamlConfig
Il proto per l'archiviazione di una coppia di configurazioni RP-IdP SAML quando il progetto agisce come relying party.
| Campi | |
|---|---|
name |
Il nome della risorsa InboundSamlConfig, ad esempio: "projects/my-awesome-project/inboundSamlConfigs/my-config-id". Ignorato durante le richieste di creazione. |
idp_config |
Il proto per l'archiviazione della configurazione del provider di identità (IdP) SAML quando il progetto agisce come parte attendibile. |
sp_config |
Il proto per l'archiviazione della configurazione del fornitore di servizi SAML (Service Provider) quando il progetto agisce come parte attendibile per ricevere e accettare un'asserzione di autenticazione emessa da un provider di identità SAML. |
display_name |
Il nome visualizzato della configurazione impostato dagli sviluppatori. |
enabled |
True se consente all'utente di accedere con il provider. |
IdpConfig
Il proto per l'archiviazione della configurazione del provider di identità (IdP) SAML quando il progetto agisce come parte attendibile.
| Campi | |
|---|---|
idp_entity_id |
Identificatore univoco per tutte le entità SAML. |
sso_url |
URL a cui inviare la richiesta di autenticazione. |
idp_certificates[] |
Le chiavi pubbliche dell'IdP per la verifica della firma nelle asserzioni. |
sign_request |
Indica se la richiesta SAML in uscita deve essere firmata. |
SpConfig
Il proto per l'archiviazione della configurazione del fornitore di servizi SAML (Service Provider) quando il progetto agisce come parte attendibile per ricevere e accettare un'asserzione di autenticazione emessa da un provider di identità SAML.
| Campi | |
|---|---|
sp_entity_id |
Identificatore univoco per tutte le entità SAML. |
callback_uri |
URI di callback in cui vengono gestite le risposte dell'IDP. |
sp_certificates[] |
Solo output. Certificati pubblici generati dal server per verificare la firma in SAMLRequest nel flusso avviato dal provider di servizi. |
ListDefaultSupportedIdpConfigsRequest
Richiesta di ListDefaultSupportedIdpConfigs
| Campi | |
|---|---|
parent |
Il nome della risorsa principale, ad esempio "projects/my-awesome-project". L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
page_size |
Il numero massimo di elementi da restituire. |
page_token |
Il valore next_page_token restituito da una precedente richiesta di elenco, se presente. |
ListDefaultSupportedIdpConfigsResponse
Risposta per ListDefaultSupportedIdpConfigs
| Campi | |
|---|---|
default_supported_idp_configs[] |
L'insieme di configurazioni. |
next_page_token |
Token per recuperare la pagina di risultati successiva o vuoto se non ci sono altri risultati nell'elenco. |
ListDefaultSupportedIdpsRequest
Richiesta di ListDefaultSupportedIdps
| Campi | |
|---|---|
page_size |
Il numero massimo di elementi da restituire. |
page_token |
Il valore next_page_token restituito da una precedente richiesta di elenco, se presente. |
ListDefaultSupportedIdpsResponse
Risposta per ListDefaultSupportedIdps
| Campi | |
|---|---|
default_supported_idps[] |
L'insieme di configurazioni. |
next_page_token |
Token per recuperare la pagina di risultati successiva o vuoto se non ci sono altri risultati nell'elenco. |
ListInboundSamlConfigsRequest
Richiesta di ListInboundSamlConfigs
| Campi | |
|---|---|
parent |
Il nome della risorsa principale, ad esempio "projects/my-awesome-project". L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
page_size |
Il numero massimo di elementi da restituire. |
page_token |
Il valore next_page_token restituito da una precedente richiesta di elenco, se presente. |
ListInboundSamlConfigsResponse
Risposta per ListInboundSamlConfigs
| Campi | |
|---|---|
inbound_saml_configs[] |
L'insieme di configurazioni. |
next_page_token |
Token per recuperare la pagina di risultati successiva o vuoto se non ci sono altri risultati nell'elenco. |
ListOAuthIdpConfigsRequest
Richiesta di ListOAuthIdpConfigs
| Campi | |
|---|---|
parent |
Il nome della risorsa principale, ad esempio "projects/my-awesome-project". L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
page_size |
Il numero massimo di elementi da restituire. |
page_token |
Il valore next_page_token restituito da una precedente richiesta di elenco, se presente. |
ListOAuthIdpConfigsResponse
Risposta per ListOAuthIdpConfigs
| Campi | |
|---|---|
oauth_idp_configs[] |
L'insieme di configurazioni. |
next_page_token |
Token per recuperare la pagina di risultati successiva o vuoto se non ci sono altri risultati nell'elenco. |
ListTenantsRequest
Messaggio di richiesta per ListTenants.
| Campi | |
|---|---|
parent |
Obbligatorio. Il nome della risorsa padre per cui elencare gli utenti. L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
page_token |
Il token di paginazione della risposta di una richiesta precedente. |
page_size |
Il numero massimo di risultati da restituire, con un limite di 1000. Se non specificato, il valore predefinito è 20. |
ListTenantsResponse
Messaggio di risposta per ListTenants.
| Campi | |
|---|---|
tenants[] |
Un elenco di tenant nel progetto dell'agente specificato. |
next_page_token |
Il token per ottenere la pagina di risultati successiva. |
MonitoringConfig
Configurazione relativa al monitoraggio dell'attività del progetto.
| Campi | |
|---|---|
request_logging |
Configurazione per il logging delle richieste effettuate a questo progetto in Stackdriver Logging |
RequestLogging
Configurazione per il logging delle richieste effettuate a questo progetto in Stackdriver Logging
| Campi | |
|---|---|
enabled |
Indica se il logging è abilitato o meno per questo progetto. |
MultiFactorAuthConfig
Opzioni relative all'autenticazione a più fattori per il progetto.
| Campi | |
|---|---|
state |
Indica se l'autenticazione a più fattori è stata attivata per questo progetto. |
enabled_providers[] |
Un elenco di secondi fattori utilizzabili per questo progetto. |
Provider
Un elenco di secondi fattori utilizzabili per questo progetto.
| Enum | |
|---|---|
PROVIDER_UNSPECIFIED |
Fornitore illegale, non deve essere utilizzato |
PHONE_SMS |
L'SMS è abilitato come secondo fattore per questo progetto. |
Stato
Indica se l'autenticazione a più fattori è stata attivata per questo progetto.
| Enum | |
|---|---|
STATE_UNSPECIFIED |
Stato illegale, non deve essere utilizzato. |
DISABLED |
L'autenticazione a più fattori non può essere utilizzata per questo progetto |
ENABLED |
Per questo progetto è possibile utilizzare l'autenticazione a più fattori |
ADMIN_ENABLED |
L'autenticazione a più fattori può essere utilizzata per questo progetto, ma può essere configurata solo dagli amministratori del progetto |
NotificationConfig
Configurazione relativa all'invio di notifiche agli utenti.
| Campi | |
|---|---|
send_email |
Opzioni per l'invio di email. |
send_sms |
Opzioni per l'invio di SMS. |
default_locale |
Impostazioni internazionali predefinite utilizzate per email e SMS in formato IETF BCP 47. |
SendEmail
Opzioni per l'invio di email.
| Campi | |
|---|---|
method |
Il metodo utilizzato per inviare un'email. |
reset_password_template |
Modello email per la reimpostazione della password |
verify_email_template |
Modello email per la verifica email |
change_email_template |
Modello email per l'email di modifica |
legacy_reset_password_template |
Modello email di reimpostazione della password per l'app Firebase V1 precedente. |
callback_uri |
URL azione nel modello email. |
dns_info |
Informazioni sulla verifica DNS del dominio personalizzato. |
Campo unione email_provider_config. La configurazione del provider email utilizzata per inviare le email email_provider_config può essere solo una delle seguenti: |
|
smtp |
Utilizzare un inoltro SMTP personalizzato |
DnsInfo
Informazioni sulla verifica DNS del dominio personalizzato. Per impostazione predefinita, verrà utilizzato default_domain. Un dominio personalizzato può essere configurato utilizzando VerifyCustomDomain.
| Campi | |
|---|---|
custom_domain |
Solo output. Il dominio personalizzato verificato applicato. |
use_custom_domain |
Se utilizzare un dominio personalizzato. |
pending_custom_domain |
Solo output. Il dominio personalizzato da verificare. |
custom_domain_state |
Solo output. Lo stato attuale della verifica del dominio personalizzato. Il dominio personalizzato verrà utilizzato solo dopo la verifica del dominio. |
domain_verification_request_time |
Solo output. Il timestamp della richiesta iniziale per la verifica del dominio attuale. |
VerificationState
Lo stato attuale della verifica del dominio personalizzato.
| Enum | |
|---|---|
VERIFICATION_STATE_UNSPECIFIED |
Valore predefinito. Non utilizzare. |
NOT_STARTED |
La verifica non è iniziata. |
IN_PROGRESS |
La verifica è in corso. |
FAILED |
La verifica non è riuscita. |
SUCCEEDED |
La verifica è andata a buon fine ed è pronta per essere applicata. |
EmailTemplate
Modello email. I campi dell'oggetto e del corpo possono contenere i seguenti segnaposto che verranno sostituiti con i valori appropriati: %LINK%: il link da utilizzare per riscattare il codice OOB inviato. %EMAIL%: l'indirizzo email a cui viene inviata l'email. %NEW_EMAIL%: l'indirizzo email nuovo impostato per l'account (se applicabile). %APP_NAME%: il nome visualizzato del progetto Google Cloud. %DISPLAY_NAME%: il nome visualizzato dell'utente.
| Campi | |
|---|---|
sender_local_part |
Parte locale dell'indirizzo mittente |
subject |
Oggetto dell'email |
sender_display_name |
Nome visualizzato del mittente |
body |
Corpo dell'email |
body_format |
Formato del corpo dell'email |
reply_to |
Indirizzo per risposte |
customized |
Solo output. Indica se il corpo o l'oggetto dell'email è personalizzato. |
BodyFormat
Formato del corpo dell'email
| Enum | |
|---|---|
BODY_FORMAT_UNSPECIFIED |
Valore predefinito. Non utilizzare. |
PLAIN_TEXT |
Testo normale |
HTML |
HTML |
Metodo
Il metodo utilizzato per inviare un'email.
| Enum | |
|---|---|
METHOD_UNSPECIFIED |
Metodo email non specificato. |
DEFAULT |
Invio di email per conto dello sviluppatore. |
CUSTOM_SMTP |
Invio di email utilizzando la configurazione SMTP fornita dagli sviluppatori. |
SMTP
Configurazione per l'inoltro SMTP
| Campi | |
|---|---|
sender_email |
Indirizzo email del mittente per l'inoltro SMTP |
host |
Host di inoltro SMTP |
port |
Porta di inoltro SMTP |
username |
Nome utente dell'inoltro SMTP |
password |
Password di inoltro SMTP |
security_mode |
Modalità di sicurezza SMTP. |
SecurityMode
Modalità di sicurezza SMTP.
| Enum | |
|---|---|
SECURITY_MODE_UNSPECIFIED |
Valore predefinito. Non utilizzare. |
SSL |
Modalità SSL |
START_TLS |
Modalità START_TLS |
SendSms
Opzioni per l'invio di SMS.
| Campi | |
|---|---|
use_device_locale |
Indica se utilizzare l'intestazione accept_language per gli SMS. |
sms_template |
Solo output. Il modello da utilizzare per l'invio di un SMS. |
SmsTemplate
Il modello da utilizzare per l'invio di un SMS.
| Campi | |
|---|---|
content |
Solo output. Il contenuto dell'SMS. Può contenere i seguenti segnaposto che verranno sostituiti con i valori appropriati: %APP_NAME%: per le app per Android o iOS, il nome visualizzato dell'app. Per le app web, il dominio che ospita l'applicazione. %LOGIN_CODE%: il codice OOB inviato nell'SMS. |
OAuthIdpConfig
Opzioni di configurazione per l'autenticazione con un IdP OAuth.
| Campi | |
|---|---|
name |
Il nome della risorsa OAuthIdpConfig, ad esempio "projects/my-awesome-project/oauthIdpConfigs/oauth-config-id". Ignorato durante le richieste di creazione. |
client_id |
L'ID client di un client OAuth. |
issuer |
Per gli IdP OIDC, l'identificatore dell'emittente. |
display_name |
Il nome visualizzato della configurazione impostato dagli sviluppatori. |
enabled |
True se consente all'utente di accedere con il provider. |
client_secret |
Il client secret del client OAuth per abilitare il flusso di codice OIDC. |
response_type |
Il tipo di risposta da richiedere nel flusso di autorizzazione OAuth. Puoi impostare |
OAuthResponseType
Il tipo di risposta da richiedere nel flusso di autorizzazione OAuth. Puoi impostare id_token o code su true, ma non su entrambi. L'impostazione di entrambi i tipi su true contemporaneamente ({code: true, id_token: true}) non è ancora supportata.
Per una mappatura del tipo di risposta al flusso OAuth 2.0, visita la pagina https://openid.net/specs/openid-connect-core-1_0.html#Authentication.
| Campi | |
|---|---|
id_token |
Se true, il token ID viene restituito dall'endpoint di autorizzazione dell'IdP. |
code |
Se il valore è true, il codice di autorizzazione viene restituito dall'endpoint di autorizzazione dell'IdP. |
token |
Non utilizzare. Il tipo di risposta |
QuotaConfig
Configurazione relativa alle quote.
| Campi | |
|---|---|
sign_up_quota_config |
Quota per l'endpoint di registrazione, se sovrascritta. La quota di registrazioni viene misurata in registrazioni per progetto per ora per IP. |
TemporaryQuota
Aumento / diminuzione temporanea della quota
| Campi | |
|---|---|
quota |
Corrisponde al campo "refill_token_count" nella configurazione di QuotaServer |
start_time |
Quando entrerà in vigore questa quota |
quota_duration |
Periodo di tempo durante il quale questa quota sarà attiva |
SignInConfig
Configurazione relativa ai metodi di accesso locale.
| Campi | |
|---|---|
email |
Opzioni di configurazione relative all'autenticazione di un utente tramite il suo indirizzo email. |
phone_number |
Opzioni di configurazione relative all'autenticazione di un utente tramite il numero di telefono. |
anonymous |
Opzioni di configurazione relative all'autenticazione di un utente anonimo. |
allow_duplicate_emails |
Indica se consentire a più account di avere lo stesso indirizzo email. |
hash_config |
Solo output. Hash delle informazioni di configurazione. |
Anonimo
Opzioni di configurazione relative all'autenticazione di un utente anonimo.
| Campi | |
|---|---|
enabled |
Indica se l'autenticazione utente anonima è attivata o meno per il progetto. |
Opzioni di configurazione relative all'autenticazione di un utente tramite il suo indirizzo email.
| Campi | |
|---|---|
enabled |
Indica se l'autenticazione via email è abilitata o meno per il progetto. |
password_required |
Indica se è richiesta o meno una password per l'autenticazione via email. Se true, per accedere è necessario fornire sia un indirizzo email che una password. Se false, un utente può accedere tramite email/password o tramite link email. |
hash_config |
Solo output. Hash delle informazioni di configurazione. |
PhoneNumber
Opzioni di configurazione relative all'autenticazione di un utente tramite il numero di telefono.
| Campi | |
|---|---|
enabled |
Indica se l'autenticazione tramite numero di telefono è abilitata o meno per il progetto. |
test_phone_numbers |
Una mappa di <test phone number, fake code> che può essere utilizzata per i test di autenticazione telefonica. |
SpCertificate
Il proto per i dati del certificato dell'SP per consentire all'IdP di verificare la richiesta SAML generata dall'SP.
| Campi | |
|---|---|
x509_certificate |
Certificato pubblico autofirmato. |
expires_at |
Timestamp dell'istanza di scadenza del certificato. |
Tenant
Un tenant contiene la configurazione del tenant in un progetto multi-tenant.
| Campi | |
|---|---|
name |
Nome della risorsa di un tenant. Ad esempio: "projects/project1/tenants/tenant1" |
display_name |
Nome visualizzato del tenant. |
saml_configs[] |
Configurazioni SAML richieste. |
idp_configs[] |
Configurazioni IdP richieste. |
allow_password_signup |
Indica se consentire la registrazione tramite email/password. |
enable_email_link_signin |
Se attivare la registrazione tramite link email. |
disable_auth |
Indica se il tenant è disabilitato per l'autenticazione. Gli utenti del tenant disattivato non sono autorizzati ad accedere. Gli amministratori dell'organizzazione disattivata non sono in grado di gestire i relativi utenti. |
UpdateConfigRequest
Richiesta di UpdateConfig
| Campi | |
|---|---|
config |
La risorsa di configurazione che sostituisce la risorsa sul server. L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
update_mask |
La maschera di aggiornamento si applica alla risorsa. I campi impostati nella configurazione, ma non inclusi in questa maschera di aggiornamento, verranno ignorati. Per la definizione di |
UpdateDefaultSupportedIdpConfigRequest
Richiesta per l'aggiornamento di UpdateDefaultSupportedIdpConfig
| Campi | |
|---|---|
default_supported_idp_config |
La risorsa di configurazione che sostituisce la risorsa sul server. L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
update_mask |
La maschera di aggiornamento si applica alla risorsa. Per la definizione di |
UpdateInboundSamlConfigRequest
Richiesta per UpdateInboundSamlConfig
| Campi | |
|---|---|
inbound_saml_config |
La risorsa di configurazione che sostituisce la risorsa sul server. L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
update_mask |
La maschera di aggiornamento si applica alla risorsa. Se la maschera di aggiornamento è vuota, non verrà aggiornato nulla. Per la definizione di |
UpdateOAuthIdpConfigRequest
Richiesta per l'aggiornamento di OAuthIdpConfig
| Campi | |
|---|---|
oauth_idp_config |
La risorsa di configurazione che sostituisce la risorsa sul server. L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
update_mask |
La maschera di aggiornamento si applica alla risorsa. Se la maschera di aggiornamento è vuota, non verrà aggiornato nulla. Per la definizione di |
UpdateTenantRequest
Messaggio di richiesta per UpdateTenant.
| Campi | |
|---|---|
tenant |
Obbligatorio. Tenant da aggiornare. L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
update_mask |
La maschera di aggiornamento si applica alla risorsa. Per la definizione di |
VerifyDomainRequest
Messaggio di richiesta per verificare che il dominio personalizzato richiesto abbia i record DNS richiesti.
| Campi | |
|---|---|
resource |
Il nome della risorsa di cui verificare il dominio. Al momento, questo metodo accetta la verifica dei domini per progetti (ad es. "projects/my-awesome-project") o tenant (ad es. "projects/my-awesome-project/tenants/my-awesome-tenant"). L'autorizzazione richiede la seguente autorizzazione IAM sulla risorsa specificata
|
domain |
Il dominio di destinazione di questa richiesta. |
action |
L'azione tentata sul dominio specificato. |
DomainVerificationAction
L'azione tentata sul dominio specificato.
| Enum | |
|---|---|
DOMAIN_VERIFICATION_ACTION_UNSPECIFIED |
Valore predefinito. Non utilizzare. |
VERIFY |
Verifica il dominio richiesto. |
CANCEL |
Annullare la procedura di verifica in corso. |
APPLY |
Applica il dominio personalizzato all'invio delle email. |
VerifyDomainResponse
Risposta alla richiesta VerifyDomain.
| Campi | |
|---|---|
verification_state |
Lo stato risultante per il dominio specificato dopo l'elaborazione di questa richiesta. |
verification_error |
Se applicabile, una spiegazione testuale del motivo per cui non è stato possibile verificare il dominio. |