Config

Rappresenta un progetto Identity Toolkit.

Rappresentazione JSON
{
  "name": string,
  "signIn": {
    object (SignInConfig)
  },
  "notification": {
    object (NotificationConfig)
  },
  "quota": {
    object (QuotaConfig)
  },
  "monitoring": {
    object (MonitoringConfig)
  },
  "multiTenant": {
    object (MultiTenantConfig)
  },
  "authorizedDomains": [
    string
  ],
  "subtype": enum (Subtype),
  "client": {
    object (ClientConfig)
  },
  "mfa": {
    object (MultiFactorAuthConfig)
  },
  "blockingFunctions": {
    object (BlockingFunctionsConfig)
  },
  "recaptchaConfig": {
    object (RecaptchaConfig)
  },
  "smsRegionConfig": {
    object (SmsRegionConfig)
  },
  "autodeleteAnonymousUsers": boolean,
  "passwordPolicyConfig": {
    object (PasswordPolicyConfig)
  },
  "emailPrivacyConfig": {
    object (EmailPrivacyConfig)
  },
  "mobileLinksConfig": {
    object (MobileLinksConfig)
  },
  "defaultHostingSite": string
}
Campi
name

string

Solo output. Il nome della risorsa Config. Esempio: "projects/my-awesome-project/config"

signIn

object (SignInConfig)

Configurazione relativa ai metodi di accesso locale.

notification

object (NotificationConfig)

Configurazione relativa all'invio di notifiche agli utenti.

quota

object (QuotaConfig)

Configurazione relativa alle quote.

monitoring

object (MonitoringConfig)

Configurazione relativa al monitoraggio dell'attività del progetto.

multiTenant

object (MultiTenantConfig)

Configurazione relativa alla funzionalità multi-tenant.

authorizedDomains[]

string

Elenco dei domini autorizzati per i reindirizzamenti OAuth

subtype

enum (Subtype)

Solo output. Il sottotipo di questa configurazione.

client

object (ClientConfig)

Opzioni relative alla configurazione dei client che inviano richieste per conto di un progetto.

mfa

object (MultiFactorAuthConfig)

Configurazione dell'autenticazione a più fattori di questo progetto, inclusa la sua attivazione e i fattori che possono essere utilizzati per il secondo fattore

blockingFunctions

object (BlockingFunctionsConfig)

Configurazione relativa alle funzioni di blocco.

recaptchaConfig

object (RecaptchaConfig)

La configurazione di reCAPTCHA a livello di progetto.

smsRegionConfig

object (SmsRegionConfig)

Configura le regioni abilitate per l'invio del codice di verifica via SMS.

autodeleteAnonymousUsers

boolean

Indica se gli utenti anonimi verranno eliminati automaticamente dopo un periodo di 30 giorni.

passwordPolicyConfig

object (PasswordPolicyConfig)

La configurazione dei criteri per le password a livello di progetto.

emailPrivacyConfig

object (EmailPrivacyConfig)

Configurazione delle impostazioni relative alla privacy dell'email e alla visibilità pubblica.

defaultHostingSite

string

Solo output. Nome predefinito del sito Firebase Hosting

SignInConfig

Configurazione relativa ai metodi di accesso locale.

Rappresentazione JSON
{
  "email": {
    object (Email)
  },
  "phoneNumber": {
    object (PhoneNumber)
  },
  "anonymous": {
    object (Anonymous)
  },
  "allowDuplicateEmails": boolean,
  "hashConfig": {
    object (HashConfig)
  }
}
Campi
email

object (Email)

Opzioni di configurazione relative all'autenticazione di un utente tramite il suo indirizzo email.

phoneNumber

object (PhoneNumber)

Opzioni di configurazione relative all'autenticazione di un utente tramite il numero di telefono.

anonymous

object (Anonymous)

Opzioni di configurazione relative all'autenticazione di un utente anonimo.

allowDuplicateEmails

boolean

Indica se consentire a più account di avere lo stesso indirizzo email.

hashConfig

object (HashConfig)

Solo output. Hash delle informazioni di configurazione.

Email

Opzioni di configurazione relative all'autenticazione di un utente tramite il suo indirizzo email.

Rappresentazione JSON
{
  "enabled": boolean,
  "passwordRequired": boolean
}
Campi
enabled

boolean

Indica se l'autenticazione via email è abilitata o meno per il progetto.

passwordRequired

boolean

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.

PhoneNumber

Opzioni di configurazione relative all'autenticazione di un utente tramite il numero di telefono.

Rappresentazione JSON
{
  "enabled": boolean,
  "testPhoneNumbers": {
    string: string,
    ...
  }
}
Campi
enabled

boolean

Indica se l'autenticazione tramite numero di telefono è abilitata o meno per il progetto.

testPhoneNumbers

map (key: string, value: string)

Una mappa di <test phone number, fake code> che può essere utilizzata per i test di autenticazione telefonica.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Anonimo

Opzioni di configurazione relative all'autenticazione di un utente anonimo.

Rappresentazione JSON
{
  "enabled": boolean
}
Campi
enabled

boolean

Indica se l'autenticazione utente anonima è attivata o meno per il progetto.

NotificationConfig

Configurazione relativa all'invio di notifiche agli utenti.

Rappresentazione JSON
{
  "sendEmail": {
    object (SendEmail)
  },
  "sendSms": {
    object (SendSms)
  },
  "defaultLocale": string
}
Campi
sendEmail

object (SendEmail)

Opzioni per l'invio di email.

sendSms

object (SendSms)

Opzioni per l'invio di SMS.

defaultLocale

string

Impostazioni internazionali predefinite utilizzate per email e SMS in formato IETF BCP 47.

SendEmail

Opzioni per l'invio di email.

Rappresentazione JSON
{
  "method": enum (Method),
  "resetPasswordTemplate": {
    object (EmailTemplate)
  },
  "verifyEmailTemplate": {
    object (EmailTemplate)
  },
  "changeEmailTemplate": {
    object (EmailTemplate)
  },
  "legacyResetPasswordTemplate": {
    object (EmailTemplate)
  },
  "callbackUri": string,
  "dnsInfo": {
    object (DnsInfo)
  },
  "revertSecondFactorAdditionTemplate": {
    object (EmailTemplate)
  },

  // Union field email_provider_config can be only one of the following:
  "smtp": {
    object (Smtp)
  }
  // End of list of possible types for union field email_provider_config.
}
Campi
method

enum (Method)

Il metodo utilizzato per inviare un'email.

resetPasswordTemplate

object (EmailTemplate)

Modello email per la reimpostazione della password

verifyEmailTemplate

object (EmailTemplate)

Modello email per la verifica email

changeEmailTemplate

object (EmailTemplate)

Modello email per l'email di modifica

legacyResetPasswordTemplate

object (EmailTemplate)

Modello email di reimpostazione della password per l'app Firebase V1 precedente.

callbackUri

string

URL azione nel modello email.

dnsInfo

object (DnsInfo)

Informazioni sulla verifica DNS del dominio personalizzato.

revertSecondFactorAdditionTemplate

object (EmailTemplate)

Modello email per il ripristino delle email di aggiunta del secondo fattore

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

object (Smtp)

Utilizzare un inoltro SMTP personalizzato

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

Rappresentazione JSON
{
  "senderEmail": string,
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "securityMode": enum (SecurityMode)
}
Campi
senderEmail

string

Indirizzo email del mittente per l'inoltro SMTP

host

string

Host di inoltro SMTP

port

integer

Porta di inoltro SMTP

username

string

Nome utente dell'inoltro SMTP

password

string

Password di inoltro SMTP

securityMode

enum (SecurityMode)

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

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.

Rappresentazione JSON
{
  "senderLocalPart": string,
  "subject": string,
  "senderDisplayName": string,
  "body": string,
  "bodyFormat": enum (BodyFormat),
  "replyTo": string,
  "customized": boolean
}
Campi
senderLocalPart

string

Parte locale dell'indirizzo mittente

subject

string

Oggetto dell'email

senderDisplayName

string

Nome visualizzato del mittente

body

string

Corpo dell'email

bodyFormat

enum (BodyFormat)

Formato del corpo dell'email

replyTo

string

Indirizzo per risposte

customized

boolean

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

DnsInfo

Informazioni sulla verifica DNS del dominio personalizzato. Per impostazione predefinita, verrà utilizzato default_domain. Un dominio personalizzato può essere configurato utilizzando VerifyCustomDomain.

Rappresentazione JSON
{
  "customDomain": string,
  "useCustomDomain": boolean,
  "pendingCustomDomain": string,
  "customDomainState": enum (VerificationState),
  "domainVerificationRequestTime": string
}
Campi
customDomain

string

Solo output. Il dominio personalizzato verificato applicato.

useCustomDomain

boolean

Se utilizzare un dominio personalizzato.

pendingCustomDomain

string

Solo output. Il dominio personalizzato da verificare.

customDomainState

enum (VerificationState)

Solo output. Lo stato attuale della verifica del dominio personalizzato. Il dominio personalizzato verrà utilizzato solo dopo la verifica del dominio.

domainVerificationRequestTime

string (Timestamp format)

Solo output. Il timestamp della richiesta iniziale per la verifica del dominio attuale.

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

SendSms

Opzioni per l'invio di SMS.

Rappresentazione JSON
{
  "useDeviceLocale": boolean,
  "smsTemplate": {
    object (SmsTemplate)
  }
}
Campi
useDeviceLocale

boolean

Indica se utilizzare l'intestazione accept_language per gli SMS.

smsTemplate

object (SmsTemplate)

Solo output. Il modello da utilizzare per l'invio di un SMS.

SmsTemplate

Il modello da utilizzare per l'invio di un SMS.

Rappresentazione JSON
{
  "content": string
}
Campi
content

string

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.

QuotaConfig

Configurazione relativa alle quote.

Rappresentazione JSON
{
  "signUpQuotaConfig": {
    object (TemporaryQuota)
  }
}
Campi
signUpQuotaConfig

object (TemporaryQuota)

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

Rappresentazione JSON
{
  "quota": string,
  "startTime": string,
  "quotaDuration": string
}
Campi
quota

string (int64 format)

Corrisponde al campo "refill_token_count" nella configurazione di QuotaServer

startTime

string (Timestamp format)

Quando entrerà in vigore questa quota

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

quotaDuration

string (Duration format)

Periodo di tempo durante il quale questa quota sarà attiva

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".

MultiTenantConfig

Configurazione relativa alla funzionalità multi-tenant.

Rappresentazione JSON
{
  "allowTenants": boolean,
  "defaultTenantLocation": string
}
Campi
allowTenants

boolean

Indica se questo progetto può avere o meno tenant.

defaultTenantLocation

string

L'organizzazione o la cartella principale cloud predefinita in cui deve essere creato il progetto tenant. Il nome della risorsa principale deve essere nel formato "/", ad esempio "folders/123" o "organizations/456". Se il valore non è impostato, il tenant verrà creato nella stessa organizzazione o cartella del progetto dell'agente.

Sottotipo

Il sottotipo di questa configurazione.

Enum
SUBTYPE_UNSPECIFIED Valore predefinito. Non utilizzare.
IDENTITY_PLATFORM Un progetto Identity Platform.
FIREBASE_AUTH Un progetto Firebase Authentication.

ClientConfig

Opzioni relative alla configurazione dei client che inviano richieste per conto di un progetto.

Rappresentazione JSON
{
  "apiKey": string,
  "permissions": {
    object (Permissions)
  },
  "firebaseSubdomain": string
}
Campi
apiKey

string

Solo output. Chiave API che può essere utilizzata per effettuare richieste per questo progetto.

permissions

object (Permissions)

Configurazione relativa alla limitazione della capacità di un utente di influire sul proprio account.

firebaseSubdomain

string

Solo output. Sottodominio Firebase.

Autorizzazioni

Configurazione relativa alla limitazione della capacità di un utente di influire sul proprio account.

Rappresentazione JSON
{
  "disabledUserSignup": boolean,
  "disabledUserDeletion": boolean
}
Campi
disabledUserSignup

boolean

Se il valore è true, gli utenti finali non possono creare un nuovo account nel progetto associato tramite nessuno dei nostri metodi API

disabledUserDeletion

boolean

Se il valore è true, gli utenti finali non possono eliminare il proprio account nel progetto associato tramite nessuno dei nostri metodi API

BlockingFunctionsConfig

Configurazione relativa alle funzioni di blocco.

Rappresentazione JSON
{
  "triggers": {
    string: {
      object (Trigger)
    },
    ...
  },
  "forwardInboundCredentials": {
    object (ForwardInboundCredentials)
  }
}
Campi
triggers

map (key: string, value: object (Trigger))

Mappa dell'attivatore al tipo di evento. La chiave deve essere uno dei tipi di eventi supportati: "beforeCreate", "beforeSignIn"

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

forwardInboundCredentials

object (ForwardInboundCredentials)

Le credenziali utente da includere nel payload JWT inviato alle funzioni di blocco registrate.

Trigger

Funzione Cloud sincrona con trigger HTTP

Rappresentazione JSON
{
  "functionUri": string,
  "updateTime": string
}
Campi
functionUri

string

Trigger URI HTTP per la funzione Cloud.

updateTime

string (Timestamp format)

Quando l'attivatore è stato modificato.

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

ForwardInboundCredentials

Indica quali credenziali passare alle Funzioni di blocco registrate.

Rappresentazione JSON
{
  "idToken": boolean,
  "accessToken": boolean,
  "refreshToken": boolean
}
Campi
idToken

boolean

Indica se passare il token ID del provider di identità OIDC dell'utente.

accessToken

boolean

Indica se passare il token di accesso del provider di identità OAuth dell'utente.

refreshToken

boolean

Indica se passare il token di aggiornamento del provider di identità OAuth dell'utente.