Config

Représente un projet Identity Toolkit.

Représentation 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
}
Champs
name

string

Uniquement en sortie. Nom de la ressource Config. Exemple: "projects/my-awesome-project/config"
signIn

object (SignInConfig)

Configuration liée aux méthodes de connexion locales.
notification

object (NotificationConfig)

Configuration liée à l'envoi de notifications aux utilisateurs.
quota

object (QuotaConfig)

Configuration liée aux quotas.
monitoring

object (MonitoringConfig)

Configuration liée à la surveillance de l'activité du projet.
multiTenant

object (MultiTenantConfig)

Configuration liée à la fonctionnalité multi-tenant.
authorizedDomains[]

string

Liste des domaines autorisés pour les redirections OAuth
subtype

enum (Subtype)

Uniquement en sortie. Sous-type de cette configuration.
client

object (ClientConfig)

Options concernant la configuration des clients qui envoient des requêtes au nom d'un projet.
mfa

object (MultiFactorAuthConfig)

Configuration de l'authentification multifacteur de ce projet, y compris si elle est active et quels facteurs peuvent être utilisés pour le deuxième facteur
blockingFunctions

object (BlockingFunctionsConfig)

Configuration liée aux fonctions de blocage.
recaptchaConfig

object (RecaptchaConfig)

Configuration reCAPTCHA au niveau du projet.
smsRegionConfig

object (SmsRegionConfig)

Configure les régions pour lesquelles l'envoi du code de validation par SMS est activé.
autodeleteAnonymousUsers

boolean

Indique si les utilisateurs anonymes seront automatiquement supprimés au bout de 30 jours.
passwordPolicyConfig

object (PasswordPolicyConfig)

Configuration des règles relatives aux mots de passe au niveau du projet.
emailPrivacyConfig

object (EmailPrivacyConfig)

Configuration des paramètres liés à la confidentialité des e-mails et à la visibilité publique.
defaultHostingSite

string

Uniquement en sortie. Nom du site Firebase Hosting par défaut

SignInConfig

Configuration liée aux méthodes de connexion locales.

Représentation JSON 
{
  "email": {
    object (Email)
  },
  "phoneNumber": {
    object (PhoneNumber)
  },
  "anonymous": {
    object (Anonymous)
  },
  "allowDuplicateEmails": boolean,
  "hashConfig": {
    object (HashConfig)
  }
}
Champs
email

object (Email)

Options de configuration liées à l'authentification d'un utilisateur par son adresse e-mail.
phoneNumber

object (PhoneNumber)

Options de configuration liées à l'authentification d'un utilisateur par son numéro de téléphone.
anonymous

object (Anonymous)

Options de configuration liées à l'authentification d'un utilisateur anonyme.
allowDuplicateEmails

boolean

Indique si plusieurs comptes peuvent utiliser la même adresse e-mail.
hashConfig

object (HashConfig)

Uniquement en sortie. Informations de configuration du hachage.

E-mail

Options de configuration liées à l'authentification d'un utilisateur par son adresse e-mail.

Représentation JSON 
{
  "enabled": boolean,
  "passwordRequired": boolean
}
Champs
enabled

boolean

Indique si l'authentification par e-mail est activée ou non pour le projet.
passwordRequired

boolean

Indique si un mot de passe est requis pour l'authentification par e-mail. Si cette valeur est définie sur "true", vous devez fournir une adresse e-mail et un mot de passe pour vous connecter. Si la valeur est "false", un utilisateur peut se connecter via un e-mail/mot de passe ou un lien d'e-mail.

PhoneNumber

Options de configuration liées à l'authentification d'un utilisateur par son numéro de téléphone.

Représentation JSON 
{
  "enabled": boolean,
  "testPhoneNumbers": {
    string: string,
    ...
  }
}
Champs
enabled

boolean

Indique si l'authentification par numéro de téléphone est activée pour le projet.
testPhoneNumbers

map (key: string, value: string)

Carte des <numéros de téléphone de test, faux codes> pouvant être utilisés pour tester l'authentification par téléphone.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Anonyme

Options de configuration liées à l'authentification d'un utilisateur anonyme.

Représentation JSON 
{
  "enabled": boolean
}
Champs
enabled

boolean

Indique si l'authentification des utilisateurs anonymes est activée ou non pour le projet.

NotificationConfig

Configuration liée à l'envoi de notifications aux utilisateurs.

Représentation JSON 
{
  "sendEmail": {
    object (SendEmail)
  },
  "sendSms": {
    object (SendSms)
  },
  "defaultLocale": string
}
Champs
sendEmail

object (SendEmail)

Options d'envoi d'e-mails.
sendSms

object (SendSms)

Options d'envoi de SMS.
defaultLocale

string

Paramètres régionaux par défaut utilisés pour les e-mails et les SMS au format IETF BCP 47.

SendEmail

Options d'envoi d'e-mails.

Représentation 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.
}
Champs
method

enum (Method)

Méthode utilisée pour envoyer un e-mail.
resetPasswordTemplate

object (EmailTemplate)

Modèle d'e-mail de réinitialisation du mot de passe
verifyEmailTemplate

object (EmailTemplate)

Modèle d'e-mail pour la validation de l'adresse e-mail
changeEmailTemplate

object (EmailTemplate)

Modèle d'e-mail pour modifier l'adresse e-mail
legacyResetPasswordTemplate

object (EmailTemplate)

Modèle d'e-mail de réinitialisation du mot de passe pour l'ancienne application Firebase V1.
callbackUri

string

URL d'action dans le modèle d'e-mail.
dnsInfo

object (DnsInfo)

Informations sur la validation DNS du domaine personnalisé.
revertSecondFactorAdditionTemplate

object (EmailTemplate)

Modèle d'e-mail pour annuler l'ajout d'un second facteur
Champ d'union email_provider_config. La configuration du fournisseur de messagerie utilisée pour envoyer des e-mails email_provider_config ne peut être que l'une des suivantes:
smtp

object (Smtp)

Utiliser un relais SMTP personnalisé

Méthode

Méthode utilisée pour envoyer un e-mail.

Enums
METHOD_UNSPECIFIED Méthode d'envoi par e-mail non spécifiée.
DEFAULT Envoi d'e-mails au nom du développeur.
CUSTOM_SMTP Envoi d'e-mails à l'aide de la configuration SMTP fournie par les développeurs.

SMTP

Configuration du relais SMTP

Représentation JSON 
{
  "senderEmail": string,
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "securityMode": enum (SecurityMode)
}
Champs
senderEmail

string

Adresse e-mail de l'expéditeur pour le relais SMTP
host

string

Hôte de relais SMTP
port

integer

Port du relais SMTP
username

string

Nom d'utilisateur du relais SMTP
password

string

Mot de passe du relais SMTP
securityMode

enum (SecurityMode)

Mode de sécurité SMTP.

SecurityMode

Mode de sécurité SMTP.

Enums
SECURITY_MODE_UNSPECIFIED Valeur par défaut. Ne l'utilisez pas.
SSL Mode SSL
START_TLS Mode START_TLS

EmailTemplate

Modèle d'e-mail Les champs d'objet et de corps peuvent contenir les espaces réservés suivants, qui seront remplacés par les valeurs appropriées : %LINK% : lien à utiliser pour utiliser le code hors connexion d'envoi. %EMAIL% : adresse e-mail à laquelle l'e-mail est envoyé. %NEW_EMAIL% : nouvelle adresse e-mail définie pour le compte (le cas échéant). %APP_NAME% : nom à afficher du projet Google Cloud. %DISPLAY_NAME% : nom à afficher de l'utilisateur.

Représentation JSON 
{
  "senderLocalPart": string,
  "subject": string,
  "senderDisplayName": string,
  "body": string,
  "bodyFormat": enum (BodyFormat),
  "replyTo": string,
  "customized": boolean
}
Champs
senderLocalPart

string

Partie locale de l'adresse de l'expéditeur
subject

string

Objet de l'e-mail
senderDisplayName

string

Nom à afficher de l'expéditeur
body

string

Corps de l'e-mail
bodyFormat

enum (BodyFormat)

Format du corps de l'e-mail
replyTo

string

Adresse de réponse
customized

boolean

Uniquement en sortie. Indique si le corps ou l'objet de l'e-mail est personnalisé.

BodyFormat

Format du corps de l'e-mail

Enums
BODY_FORMAT_UNSPECIFIED Valeur par défaut. Ne l'utilisez pas.
PLAIN_TEXT Texte brut
HTML HTML

DnsInfo

Informations sur la validation DNS du domaine personnalisé. Par défaut, "default_domain" est utilisé. Vous pouvez configurer un domaine personnalisé à l'aide de VerifyCustomDomain.

Représentation JSON 
{
  "customDomain": string,
  "useCustomDomain": boolean,
  "pendingCustomDomain": string,
  "customDomainState": enum (VerificationState),
  "domainVerificationRequestTime": string
}
Champs
customDomain

string

Uniquement en sortie. Domaine personnalisé validé appliqué.
useCustomDomain

boolean

Indique si vous souhaitez utiliser un domaine personnalisé.
pendingCustomDomain

string

Uniquement en sortie. Domaine personnalisé à valider.
customDomainState

enum (VerificationState)

Uniquement en sortie. État actuel de la validation du domaine personnalisé. Le domaine personnalisé ne sera utilisé qu'une fois la validation du domaine effectuée.
domainVerificationRequestTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la requête initiale pour la validation du domaine en cours.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

SendSms

Options d'envoi de SMS.

Représentation JSON 
{
  "useDeviceLocale": boolean,
  "smsTemplate": {
    object (SmsTemplate)
  }
}
Champs
useDeviceLocale

boolean

Indique si l'en-tête "accept_language" doit être utilisé pour les SMS.
smsTemplate

object (SmsTemplate)

Uniquement en sortie. Modèle à utiliser pour envoyer un SMS.

SmsTemplate

Modèle à utiliser pour envoyer un SMS.

Représentation JSON 
{
  "content": string
}
Champs
content

string

Uniquement en sortie. Contenu du SMS. Peut contenir les espaces réservés suivants, qui seront remplacés par les valeurs appropriées : %APP_NAME% : pour les applications Android ou iOS, nom à afficher de l'application. Pour les applications Web, le domaine qui héberge l'application. %LOGIN_CODE% : code hors bande envoyé par SMS.

QuotaConfig

Configuration liée aux quotas.

Représentation JSON 
{
  "signUpQuotaConfig": {
    object (TemporaryQuota)
  }
}
Champs
signUpQuotaConfig

object (TemporaryQuota)

Quota pour le point de terminaison "Signup" (Inscription), le cas échéant. Le quota d'inscriptions est mesuré en inscriptions par projet et par heure et par adresse IP.

TemporaryQuota

Augmentation / diminution temporaire du quota

Représentation JSON 
{
  "quota": string,
  "startTime": string,
  "quotaDuration": string
}
Champs
quota

string (int64 format)

Correspond au champ "refill_token_count" de la configuration QuotaServer
startTime

string (Timestamp format)

Quand ce quota prendra-t-il effet ?

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
quotaDuration

string (Duration format)

Durée pendant laquelle ce quota sera actif

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

MultiTenantConfig

Configuration liée à la fonctionnalité multi-tenant.

Représentation JSON 
{
  "allowTenants": boolean,
  "defaultTenantLocation": string
}
Champs
allowTenants

boolean

Indique si ce projet peut avoir des locataires ou non.
defaultTenantLocation

string

Organisation ou dossier parent cloud par défaut dans lequel le projet de locataire doit être créé. Le nom de la ressource parente doit suivre le format "/", par exemple "folders/123" ou "organizations/456". Si cette valeur n'est pas définie, le locataire sera créé dans la même organisation ou le même dossier que le projet de l'agent.

Sous-type

Sous-type de cette configuration.

Enums
SUBTYPE_UNSPECIFIED Valeur par défaut. Ne l'utilisez pas.
IDENTITY_PLATFORM Un projet Identity Platform.
FIREBASE_AUTH Un projet Firebase Authentication.

ClientConfig

Options concernant la configuration des clients qui envoient des requêtes au nom d'un projet.

Représentation JSON 
{
  "apiKey": string,
  "permissions": {
    object (Permissions)
  },
  "firebaseSubdomain": string
}
Champs
apiKey

string

Uniquement en sortie. Clé API pouvant être utilisée pour effectuer des requêtes pour ce projet.
permissions

object (Permissions)

Configuration liée à la restriction de la capacité d'un utilisateur à modifier son compte.
firebaseSubdomain

string

Uniquement en sortie. Sous-domaine Firebase.

Autorisations

Configuration liée à la restriction de la capacité d'un utilisateur à modifier son compte.

Représentation JSON 
{
  "disabledUserSignup": boolean,
  "disabledUserDeletion": boolean
}
Champs
disabledUserSignup

boolean

Si cette valeur est définie sur "true", les utilisateurs finaux ne peuvent pas créer de compte sur le projet associé à l'aide de l'une de nos méthodes d'API.
disabledUserDeletion

boolean

Si cette valeur est définie sur "true", les utilisateurs finaux ne peuvent pas supprimer leur compte du projet associé à l'aide de l'une de nos méthodes d'API.

BlockingFunctionsConfig

Configuration liée aux fonctions de blocage.

Représentation JSON 
{
  "triggers": {
    string: {
      object (Trigger)
    },
    ...
  },
  "forwardInboundCredentials": {
    object (ForwardInboundCredentials)
  }
}
Champs
triggers

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

Correspondance entre le déclencheur et le type d'événement. La clé doit correspondre à l'un des types d'événements acceptés: "beforeCreate", "beforeSignIn"

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
forwardInboundCredentials

object (ForwardInboundCredentials)

Identifiants utilisateur à inclure dans la charge utile JWT envoyée aux fonctions de blocage enregistrées.

Déclencheur

Fonction Cloud synchrone avec déclencheur HTTP

Représentation JSON 
{
  "functionUri": string,
  "updateTime": string
}
Champs
functionUri

string

Déclencheur d'URI HTTP pour la fonction Cloud.
updateTime

string (Timestamp format)

Date et heure auxquelles le déclencheur a été modifié.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

ForwardInboundCredentials

Indique les identifiants à transmettre aux fonctions de blocage enregistrées.

Représentation JSON 
{
  "idToken": boolean,
  "accessToken": boolean,
  "refreshToken": boolean
}
Champs
idToken

boolean

Indique si le jeton d'ID du fournisseur d'identité OIDC de l'utilisateur doit être transmis.
accessToken

boolean

Indique si le jeton d'accès du fournisseur d'identité OAuth de l'utilisateur doit être transmis.
refreshToken

boolean

Indique si le jeton d'actualisation du fournisseur d'identité OAuth de l'utilisateur doit être transmis.