Package google.cloud.identitytoolkit.admin.v2

Index

ProjectConfigService

Configuration du projet pour Identity Toolkit

CreateDefaultSupportedIdpConfig

rpc CreateDefaultSupportedIdpConfig(CreateDefaultSupportedIdpConfigRequest) returns (DefaultSupportedIdpConfig)

Créez une configuration par défaut compatible avec un fournisseur d'identité pour un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

CreateInboundSamlConfig

rpc CreateInboundSamlConfig(CreateInboundSamlConfigRequest) returns (InboundSamlConfig)

Créez une configuration SAML entrante pour un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

CreateOAuthIdpConfig

rpc CreateOAuthIdpConfig(CreateOAuthIdpConfigRequest) returns (OAuthIdpConfig)

Créez une configuration d'IdP OIDC pour un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

DeleteDefaultSupportedIdpConfig

rpc DeleteDefaultSupportedIdpConfig(DeleteDefaultSupportedIdpConfigRequest) returns (Empty)

Supprimez une configuration d'IDP compatible par défaut pour un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

DeleteInboundSamlConfig

rpc DeleteInboundSamlConfig(DeleteInboundSamlConfigRequest) returns (Empty)

Supprimez une configuration SAML entrante pour un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

DeleteOAuthIdpConfig

rpc DeleteOAuthIdpConfig(DeleteOAuthIdpConfigRequest) returns (Empty)

Supprimez une configuration d'IdP OIDC pour un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

GetConfig

rpc GetConfig(GetConfigRequest) returns (Config)

Récupérez la configuration d'un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

GetDefaultSupportedIdpConfig

rpc GetDefaultSupportedIdpConfig(GetDefaultSupportedIdpConfigRequest) returns (DefaultSupportedIdpConfig)

Récupérez une configuration par défaut compatible avec un fournisseur d'identité pour un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

GetIamPolicy

rpc GetIamPolicy(GetIamPolicyRequest) returns (Policy)

Récupère la stratégie de contrôle d'accès d'une ressource. Une erreur est renvoyée si la ressource n'existe pas. Une stratégie vide est renvoyée si la ressource existe, mais ne dispose d'aucune stratégie. L'appelant doit disposer de l'autorisation Google IAM appropriée sur la ressource.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

GetInboundSamlConfig

rpc GetInboundSamlConfig(GetInboundSamlConfigRequest) returns (InboundSamlConfig)

Récupérez une configuration SAML entrante pour un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

GetOAuthIdpConfig

rpc GetOAuthIdpConfig(GetOAuthIdpConfigRequest) returns (OAuthIdpConfig)

Récupérez une configuration d'IdP OIDC pour un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

InitializeIdentityPlatform

rpc InitializeIdentityPlatform(InitializeIdentityPlatformRequest) returns (InitializeIdentityPlatformResponse)

Initialiser Identity Platform pour un projet Cloud Identity Platform est un système d'authentification de bout en bout qui permet aux utilisateurs tiers d'accéder à vos applications et services. Il peut s'agir d'applications mobiles/Web, de jeux, d'API, etc.

Il s'agit de la variante publique d'EnableIdentityPlatform, qui n'est disponible que pour les projets pour lesquels la facturation est activée.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

ListDefaultSupportedIdpConfigs

rpc ListDefaultSupportedIdpConfigs(ListDefaultSupportedIdpConfigsRequest) returns (ListDefaultSupportedIdpConfigsResponse)

Répertorie toutes les configurations IdP compatibles par défaut pour un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

ListDefaultSupportedIdps

rpc ListDefaultSupportedIdps(ListDefaultSupportedIdpsRequest) returns (ListDefaultSupportedIdpsResponse)

Répertorie tous les IDP compatibles par défaut.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

ListInboundSamlConfigs

rpc ListInboundSamlConfigs(ListInboundSamlConfigsRequest) returns (ListInboundSamlConfigsResponse)

Répertoriez toutes les configurations SAML entrantes d'un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

ListOAuthIdpConfigs

rpc ListOAuthIdpConfigs(ListOAuthIdpConfigsRequest) returns (ListOAuthIdpConfigsResponse)

Répertoriez toutes les configurations d'IdP OIDC pour un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

SetIamPolicy

rpc SetIamPolicy(SetIamPolicyRequest) returns (Policy)

Définit la stratégie de contrôle d'accès pour une ressource. Si la règle existe, elle est remplacée. L'appelant doit disposer de l'autorisation Google IAM appropriée sur la ressource.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

TestIamPermissions

rpc TestIamPermissions(TestIamPermissionsRequest) returns (TestIamPermissionsResponse)

Renvoie les autorisations de l'appelant sur une ressource. Une erreur est renvoyée si la ressource n'existe pas. L'appelant n'a pas besoin d'une autorisation IAM Google pour effectuer cette requête.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

UpdateConfig

rpc UpdateConfig(UpdateConfigRequest) returns (Config)

Mettre à jour la configuration d'un projet Identity Toolkit

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

UpdateDefaultSupportedIdpConfig

rpc UpdateDefaultSupportedIdpConfig(UpdateDefaultSupportedIdpConfigRequest) returns (DefaultSupportedIdpConfig)

Mettez à jour une configuration IdP compatible par défaut pour un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

UpdateInboundSamlConfig

rpc UpdateInboundSamlConfig(UpdateInboundSamlConfigRequest) returns (InboundSamlConfig)

Mettez à jour une configuration SAML entrante pour un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

UpdateOAuthIdpConfig

rpc UpdateOAuthIdpConfig(UpdateOAuthIdpConfigRequest) returns (OAuthIdpConfig)

Mettez à jour la configuration d'un IdP OIDC pour un projet Identity Toolkit.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

VerifyDomain

rpc VerifyDomain(VerifyDomainRequest) returns (VerifyDomainResponse)

Vérifiez que le domaine personnalisé demandé dispose des enregistrements DNS requis.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

TenantManagementService

Service de gestion des locataires pour GCIP.

CreateTenant

rpc CreateTenant(CreateTenantRequest) returns (Tenant)

Créez un locataire. Nécessite une autorisation d'écriture sur le projet Agent.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

DeleteTenant

rpc DeleteTenant(DeleteTenantRequest) returns (Empty)

Supprimez un locataire. Nécessite une autorisation d'écriture sur le projet Agent.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

GetTenant

rpc GetTenant(GetTenantRequest) returns (Tenant)

Obtenez un locataire. Nécessite une autorisation de lecture sur la ressource de locataire.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

ListTenants

rpc ListTenants(ListTenantsRequest) returns (ListTenantsResponse)

Répertorie les locataires du projet d'agent donné. Nécessite une autorisation de lecture sur le projet de l'agent.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

UpdateTenant

rpc UpdateTenant(UpdateTenantRequest) returns (Tenant)

Mettez à jour un locataire. Nécessite une autorisation en écriture sur la ressource de locataire.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez Authentication Overview.

BlockingFunctionsConfig

Configuration liée aux fonctions de blocage.

Champs
triggers

map<string, 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"

forward_inbound_credentials

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

Champs
function_uri

string

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

update_time

Timestamp

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

ClientConfig

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

Champs
api_key

string

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

permissions

Permissions

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

firebase_subdomain

string

Uniquement en sortie. Sous-domaine Firebase.

Autorisations

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

Champs
disabled_user_signup

bool

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.

disabled_user_deletion

bool

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.

ClientPermissionConfig

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

Champs
permissions

ClientPermissions

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

ClientPermissions

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

Champs
disabled_user_signup

bool

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.

disabled_user_deletion

bool

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.

Config

Représente un projet Identity Toolkit.

Champs
name

string

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

sign_in

SignInConfig

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

notification

NotificationConfig

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

quota

QuotaConfig

Configuration liée aux quotas.

monitoring

MonitoringConfig

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

multi_tenant

MultiTenantConfig

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

authorized_domains[]

string

Liste des domaines autorisés pour les redirections OAuth

subtype

Subtype

Uniquement en sortie. Sous-type de cette configuration.

client

ClientConfig

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

mfa

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

blocking_functions

BlockingFunctionsConfig

Configuration liée aux fonctions de blocage.

recaptcha_config

RecaptchaConfig

Configuration reCAPTCHA au niveau du projet.

sms_region_config

SmsRegionConfig

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

autodelete_anonymous_users

bool

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

password_policy_config

PasswordPolicyConfig

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

email_privacy_config

EmailPrivacyConfig

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

default_hosting_site

string

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

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.

CreateDefaultSupportedIdpConfigRequest

Requête pour CreateDefaultSupportedIdpConfig

Champs
parent

string

Nom de la ressource parente où créer la configuration, par exemple: "projects/my-awesome-project"

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • firebaseauth.configs.update
idp_id

string

ID du fournisseur d'identité pour lequel créer une configuration. Appelez ListDefaultSupportedIdps pour obtenir la liste de tous les ID propriétaires compatibles par défaut.

default_supported_idp_config

DefaultSupportedIdpConfig

Ressource de configuration qui remplace la ressource sur le serveur.

CreateInboundSamlConfigRequest

Requête pour CreateInboundSamlConfig

Champs
parent

string

Nom de la ressource parente où créer la configuration, par exemple: "projects/my-awesome-project"

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • firebaseauth.configs.update
inbound_saml_config_id

string

ID à utiliser pour cette configuration.

inbound_saml_config

InboundSamlConfig

Ressource de configuration à créer. Le client ne doit pas définir le champ InboundSamlConfig.name. Le serveur ignore la valeur du champ si elle est définie par les clients.

CreateOAuthIdpConfigRequest

Requête pour CreateOAuthIdpConfig

Champs
parent

string

Nom de la ressource parente où créer la configuration, par exemple: "projects/my-awesome-project"

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • firebaseauth.configs.update
oauth_idp_config_id

string

ID à utiliser pour cette configuration.

oauth_idp_config

OAuthIdpConfig

Ressource de configuration à créer. Le client ne doit pas définir le champ OAuthIdpConfig.name. Le serveur ignore la valeur du champ si elle est définie par les clients.

CreateTenantRequest

Message de requête pour CreateTenant.

Champs
parent

string

Nom de la ressource parente dans laquelle le locataire sera créé. Par exemple, "projects/project1".

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • identitytoolkit.tenants.create
tenant

Tenant

Obligatoire. Locataire à créer.

DefaultSupportedIdp

IDP approuvés par Identity Toolkit standards

Champs
idp_id

string

ID de l'IdP

description

string

Description de l'IdP

DefaultSupportedIdpConfig

Options de configuration pour l'authentification à l'aide de l'ensemble standard de fournisseurs d'identité approuvés par Identity Toolkit.

Champs
name

string

Nom de la ressource DefaultSupportedIdpConfig, par exemple: "projects/mon-super-projet/defaultSupportedIdpConfigs/google.com"

enabled

bool

"True" si l'utilisateur peut se connecter avec le fournisseur.

client_id

string

ID client OAuth

client_secret

string

Code secret du client OAuth.

Champ d'union idp_specific_config. Paramètres de l'IDP spécifiques à un type de connexion idp_specific_config ne peut être qu'un des éléments suivants :
apple_sign_in_config

AppleSignInConfig

Configuration supplémentaire pour les projets Apple.

AppleSignInConfig

Configuration supplémentaire pour SignInWithApple.

Champs
code_flow_config

CodeFlowConfig

Configuration supplémentaire pour Apple pour le flux de code.

bundle_ids[]

string

Liste des ID de bundle utilisables par ce projet

CodeFlowConfig

Configuration supplémentaire pour Apple pour le flux de code.

Champs
team_id

string

ID d'équipe Apple Developer

key_id

string

ID de clé pour la clé privée.

private_key

string

Clé privée utilisée pour signer le jeton JWT du secret client.

DeleteDefaultSupportedIdpConfigRequest

Requête pour DeleteDefaultSupportedIdpConfig

Champs
name

string

Nom de la ressource de la configuration, par exemple: "projects/mon-super-projet/defaultSupportedIdpConfigs/google.com"

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • firebaseauth.configs.update

DeleteInboundSamlConfigRequest

Requête pour DeleteInboundSamlConfig

Champs
name

string

Nom de la ressource de la configuration à supprimer, par exemple: "projects/my-awesome-project/inboundSamlConfigs/my-config-id".

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • firebaseauth.configs.update

DeleteOAuthIdpConfigRequest

Requête pour DeleteOAuthIdpConfig

Champs
name

string

Nom de la ressource de la configuration à supprimer, par exemple: "projects/my-awesome-project/oauthIdpConfigs/oauth-config-id".

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • firebaseauth.configs.update

DeleteTenantRequest

Message de requête pour DeleteTenant.

Champs
name

string

Nom de la ressource du locataire à supprimer.

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • identitytoolkit.tenants.delete

EmailPrivacyConfig

Configuration des paramètres liés à la confidentialité des e-mails et à la visibilité publique. Les paramètres de cette configuration protègent contre l'énumération des adresses e-mail, mais peuvent entraîner des compromis en termes de facilité d'utilisation.

Champs
enable_improved_email_privacy

bool

Migre le projet vers un état de confidentialité des e-mails améliorée. Par exemple, certains codes d'erreur sont plus génériques pour éviter de divulguer des informations sur l'existence du compte. De plus, cela désactive certaines fonctionnalités qui, en tant qu'effet secondaire, permettent l'énumération des utilisateurs. L'activation de ce bouton désactive la fonctionnalité fetchSignInMethodsForEmail et remplace l'adresse e-mail de l'utilisateur par une adresse non validée. Nous vous recommandons de ne plus dépendre de cette fonctionnalité et d'activer ce bouton pour améliorer la confidentialité des utilisateurs.

ForwardInboundCredentials

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

Champs
id_token

bool

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

access_token

bool

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

refresh_token

bool

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

GetConfigRequest

Requête pour GetConfig

Champs
name

string

Nom de la ressource de la configuration, par exemple: "projects/my-awesome-project/config"

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • firebaseauth.configs.get

GetDefaultSupportedIdpConfigRequest

Requête pour GetDefaultSupportedIdpConfig

Champs
name

string

Nom de la ressource de la configuration, par exemple: "projects/mon-super-projet/defaultSupportedIdpConfigs/google.com"

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • firebaseauth.configs.get

GetInboundSamlConfigRequest

Requête pour GetInboundSamlConfig

Champs
name

string

Nom de la ressource de la configuration, par exemple: "projects/my-awesome-project/inboundSamlConfigs/my-config-id".

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • firebaseauth.configs.get

GetOAuthIdpConfigRequest

Requête pour GetOAuthIdpConfig

Champs
name

string

Nom de la ressource de la configuration, par exemple: "projects/my-awesome-project/oauthIdpConfigs/oauth-config-id".

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • firebaseauth.configs.get

GetTenantRequest

Message de requête pour GetTenant.

Champs
name

string

Nom de ressource du locataire à récupérer.

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • identitytoolkit.tenants.get

HashConfig

Informations sur l'historique de l'algorithme de hachage et de la clé. Les mots de passe de différents comptes peuvent être générés par différentes versions.

Champs
algorithm

HashAlgorithm

Uniquement en sortie. Différents algorithmes de hachage de mot de passe utilisés dans Identity Toolkit

signer_key

string

Uniquement en sortie. Clé de signature au format base64.

salt_separator

string

Uniquement en sortie. Caractère non imprimable à insérer entre le sel et le mot de passe en texte brut au format base64.

rounds

int32

Uniquement en sortie. Nombre de tours pour le calcul du hachage. Utilisé par scrypt et d'autres algorithmes de dérivation de mot de passe similaires.

memory_cost

int32

Uniquement en sortie. Coût de la mémoire pour le calcul du hachage. Utilisé par scrypt et d'autres algorithmes de dérivation de mot de passe similaires. Pour en savoir plus sur ce champ, consultez la page https://tools.ietf.org/html/rfc7914.

HashAlgorithm

Différents algorithmes de hachage de mot de passe utilisés dans Identity Toolkit

Enums
HASH_ALGORITHM_UNSPECIFIED Valeur par défaut. Ne l'utilisez pas.
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

Données du certificat de l'IDP pour valider la signature dans la réponse SAML émise par l'IDP.

Champs
x509_certificate

string

Le certificat x509

InboundSamlConfig

Paire de configurations RP-IDP SAML lorsque le projet agit en tant que tiers de confiance.

Champs
name

string

Nom de la ressource InboundSamlConfig, par exemple: "projects/my-awesome-project/inboundSamlConfigs/my-config-id". Ignoré lors des requêtes de création.

idp_config

IdpConfig

Configuration du fournisseur d'identité (IdP) SAML lorsque le projet agit en tant que partie de confiance.

sp_config

SpConfig

Configuration du fournisseur de services (SP, Service Provider) SAML lorsque le projet agit en tant que partie de confiance pour recevoir et accepter une assertion d'authentification émise par un fournisseur d'identité SAML.

display_name

string

Nom à afficher de la configuration défini par les développeurs.

enabled

bool

"True" si l'utilisateur peut se connecter avec le fournisseur.

IdpConfig

Configuration du fournisseur d'identité (IdP) SAML lorsque le projet agit en tant que partie de confiance.

Champs
idp_entity_id

string

Identifiant unique de toutes les entités SAML.

sso_url

string

URL à laquelle envoyer la requête d'authentification.

idp_certificates[]

IdpCertificate

Clés publiques de l'IDP pour valider la signature dans les assertions.

sign_request

bool

Indique si la requête SAML sortante doit être signée.

SpConfig

Configuration du fournisseur de services (SP, Service Provider) SAML lorsque le projet agit en tant que partie de confiance pour recevoir et accepter une assertion d'authentification émise par un fournisseur d'identité SAML.

Champs
sp_entity_id

string

Identifiant unique de toutes les entités SAML.

callback_uri

string

URI de rappel où les réponses de l'IDP sont gérées.

sp_certificates[]

SpCertificate

Uniquement en sortie. Certificats publics générés par le serveur pour valider la signature dans SAMLRequest dans le flux initié par le fournisseur de services.

Héritage

Paramètres que les locataires hériteront du niveau du projet.

Champs
email_sending_config

bool

Indique si le locataire peut hériter des domaines personnalisés, des modèles d'e-mail et des paramètres SMTP personnalisés. Si la valeur est "true", les e-mails envoyés depuis le locataire suivent les configurations d'envoi d'e-mails au niveau du projet. Si la valeur est "false" (par défaut), les e-mails sont envoyés avec les paramètres par défaut, sans aucune personnalisation.

InitializeIdentityPlatformRequest

Requête pour InitializeIdentityPlatform.

Champs
project

string

Nom de la ressource du projet cible pour lequel le développeur souhaite activer Identity Platform.

L'autorisation IAM suivante est requise pour la ressource project indiquée :

  • firebaseauth.configs.create

InitializeIdentityPlatformResponse

Ce type ne comporte aucun champ.

Réponse pour InitializeIdentityPlatform. Vide pour l'instant.

ListDefaultSupportedIdpConfigsRequest

Requête pour ListDefaultSupportedIdpConfigs

Champs
parent

string

Nom de la ressource parente, par exemple "projects/my-awesome-project".

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • firebaseauth.configs.get
page_size

int32

Nombre maximum d'éléments à renvoyer.

page_token

string

Valeur next_page_token renvoyée par une requête "List" précédente, le cas échéant.

ListDefaultSupportedIdpConfigsResponse

Réponse pour DefaultSupportedIdpConfigs

Champs
default_supported_idp_configs[]

DefaultSupportedIdpConfig

Ensemble de configurations.

next_page_token

string

Jeton permettant de récupérer la page suivante des résultats ou non renseigné si la liste ne contient plus de résultats.

ListDefaultSupportedIdpsRequest

Requête pour ListDefaultSupportedIdps

Champs
page_size

int32

Le nombre maximum d'éléments à renvoyer.

page_token

string

Valeur next_page_token renvoyée par une requête "List" précédente, le cas échéant.

ListDefaultSupportedIdpsResponse

Réponse pour ListDefaultSupportedIdps

Champs
default_supported_idps[]

DefaultSupportedIdp

Ensemble de configurations.

next_page_token

string

Jeton permettant de récupérer la page suivante des résultats ou non renseigné si la liste ne contient plus de résultats.

ListInboundSamlConfigsRequest

Requête pour ListInboundSamlConfigs

Champs
parent

string

Nom de la ressource parente, par exemple "projects/my-awesome-project".

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • firebaseauth.configs.get
page_size

int32

Nombre maximum d'éléments à renvoyer.

page_token

string

Valeur next_page_token renvoyée par une requête "List" précédente, le cas échéant.

ListInboundSamlConfigsResponse

Réponse pour ListInboundSamlConfigs

Champs
inbound_saml_configs[]

InboundSamlConfig

Ensemble de configurations.

next_page_token

string

Jeton permettant de récupérer la page suivante des résultats ou non renseigné si la liste ne contient plus de résultats.

ListOAuthIdpConfigsRequest

Requête pour ListOAuthIdpConfigs

Champs
parent

string

Nom de la ressource parente, par exemple "projects/my-awesome-project".

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • firebaseauth.configs.get
page_size

int32

Nombre maximum d'éléments à renvoyer.

page_token

string

Valeur next_page_token renvoyée par une requête "List" précédente, le cas échéant.

ListOAuthIdpConfigsResponse

Réponse pour ListOAuthIdpConfigs

Champs
oauth_idp_configs[]

OAuthIdpConfig

Ensemble de configurations.

next_page_token

string

Jeton permettant de récupérer la page suivante des résultats ou non renseigné si la liste ne contient plus de résultats.

ListTenantsRequest

Message de requête pour ListTenants.

Champs
parent

string

Obligatoire. Nom de la ressource parente pour laquelle lister les locataires.

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • identitytoolkit.tenants.list
page_token

string

Jeton de pagination de la réponse d'une requête précédente.

page_size

int32

Nombre maximal de résultats à renvoyer, limité à 1 000. Si aucune valeur n'est spécifiée, la valeur par défaut est 20.

ListTenantsResponse

Message de réponse pour ListTenants.

Champs
tenants[]

Tenant

Liste des locataires du projet d'agent donné.

next_page_token

string

Jeton permettant d'obtenir la page de résultats suivante.

MfaState

Indique si l'authentification multifacteur a été activée pour ce projet.

Enums
MFA_STATE_UNSPECIFIED État illégal, ne doit pas être utilisé.
DISABLED L'authentification multifacteur ne peut pas être utilisée pour ce projet.
ENABLED L'authentification multifacteur peut être utilisée pour ce projet.
MANDATORY L'authentification multifacteur est requise pour ce projet. Les utilisateurs de ce projet doivent s'authentifier avec le second facteur.

MobileLinksConfig

Liens de configuration pour mobile.

Champs
domain

Domain

Code ouvert dans le domaine de l'application à utiliser pour les liens vers une application et les liens universels.

Domaine

Code ouvert possible dans le domaine de l'application à utiliser pour les liens d'application et les liens universels.

Enums
DOMAIN_UNSPECIFIED Valeur par défaut. Le domaine par défaut est le domaine Firebase Dynamic Links avant l'abandon de FDL et le domaine d'hébergement après l'abandon de FDL.
HOSTING_DOMAIN Utiliser le domaine d'hébergement comme domaine de lien d'application

MonitoringConfig

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

Champs
request_logging

RequestLogging

Configuration pour la journalisation des requêtes envoyées à ce projet dans Stackdriver Logging

Enregistrement des requêtes

Configuration pour la journalisation des requêtes envoyées à ce projet dans Stackdriver Logging

Champs
enabled

bool

Indique si la journalisation est activée pour ce projet.

MultiFactorAuthConfig

Options liées à l'authentification multifacteur pour le projet.

Champs
state

State

Indique si l'authentification multifacteur a été activée pour ce projet.

enabled_providers[]

Provider

Liste des deuxièmes facteurs utilisables pour ce projet.

provider_configs[]

ProviderConfig

Liste des deuxièmes facteurs utilisables pour ce projet, ainsi que leurs configurations. Ce champ n'est pas compatible avec l'authentification multifacteur par téléphone. Pour cela, utilisez le champ "enabled_providers".

Fournisseur

Liste des deuxièmes facteurs utilisables pour ce projet.

Enums
PROVIDER_UNSPECIFIED Fournisseur illégal, ne doit pas être utilisé
PHONE_SMS Le SMS est activé en tant que deuxième facteur pour ce projet.

État

Indique si l'authentification multifacteur a été activée pour ce projet.

Enums
STATE_UNSPECIFIED État illégal, ne doit pas être utilisé.
DISABLED L'authentification multifacteur ne peut pas être utilisée pour ce projet
ENABLED L'authentification multifacteur peut être utilisée pour ce projet
MANDATORY L'authentification multifacteur est requise pour ce projet. Les utilisateurs de ce projet doivent s'authentifier avec le second facteur.

MultiTenantConfig

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

Champs
allow_tenants

bool

Indique si ce projet peut avoir des locataires ou non.

default_tenant_location

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.

NotificationConfig

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

Champs
send_email

SendEmail

Options d'envoi d'e-mails.

send_sms

SendSms

Options d'envoi de SMS.

default_locale

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.

Champs
method

Method

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

reset_password_template

EmailTemplate

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

verify_email_template

EmailTemplate

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

change_email_template

EmailTemplate

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

legacy_reset_password_template

EmailTemplate

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

callback_uri

string

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

dns_info

DnsInfo

Informations sur la validation DNS du domaine personnalisé.

revert_second_factor_addition_template

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

Smtp

Utiliser un relais SMTP personnalisé

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.

Champs
custom_domain

string

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

use_custom_domain

bool

Indique si vous souhaitez utiliser un domaine personnalisé.

pending_custom_domain

string

Uniquement en sortie. Domaine personnalisé à valider.

custom_domain_state

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.

domain_verification_request_time

Timestamp

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

VerificationState

État actuel de la validation du domaine personnalisé.

Enums
VERIFICATION_STATE_UNSPECIFIED Valeur par défaut. Ne l'utilisez pas.
NOT_STARTED La validation n'a pas commencé.
IN_PROGRESS La validation est en cours.
FAILED Échec de la validation.
SUCCEEDED La validation a réussi et est prête à être appliquée.

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.

Champs
sender_local_part

string

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

subject

string

Objet de l'e-mail

sender_display_name

string

Nom à afficher de l'expéditeur

body

string

Corps de l'e-mail

body_format

BodyFormat

Format du corps de l'e-mail

reply_to

string

Adresse de réponse

customized

bool

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

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

Champs
sender_email

string

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

host

string

Hôte de relais SMTP

port

int32

Port du relais SMTP

username

string

Nom d'utilisateur du relais SMTP

password

string

Mot de passe du relais SMTP

security_mode

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

SendSms

Options d'envoi de SMS.

Champs
use_device_locale

bool

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

sms_template

SmsTemplate

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

SmsTemplate

Modèle à utiliser pour envoyer un SMS.

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.

OAuthIdpConfig

Options de configuration pour l'authentification avec un IDP OAuth.

Champs
name

string

Nom de la ressource OAuthIdpConfig, par exemple: "projects/my-awesome-project/oauthIdpConfigs/oauth-config-id". Ignoré lors des requêtes de création.

client_id

string

ID client d'un client OAuth.

issuer

string

Pour les fournisseurs d'identité OIDC, l'identifiant de l'émetteur.

display_name

string

Nom à afficher de la configuration défini par les développeurs.

enabled

bool

"True" si l'utilisateur peut se connecter avec le fournisseur.

client_secret

string

Code secret du client OAuth pour activer le flux de code OIDC.

response_type

OAuthResponseType

Type de réponse à demander dans le flux d'autorisation OAuth. Vous pouvez définir id_token ou code sur "true", mais pas les deux. La définition des deux types sur "true" ({code: true, id_token: true}) simultanément n'est pas encore possible.

OAuthResponseType

Type de réponse à demander dans le flux d'autorisation OAuth. Vous pouvez définir id_token ou code sur "true", mais pas les deux. La définition des deux types sur "true" ({code: true, id_token: true}) simultanément n'est pas encore possible.

Consultez https://openid.net/specs/openid-connect-core-1_0.html#Authentication pour obtenir un mappage du type de réponse sur le flux OAuth 2.0.

Champs
id_token

bool

Si cette valeur est définie sur "true" (vrai), le jeton d'ID est renvoyé par le point de terminaison d'autorisation de l'IdP.

code

bool

Si cette valeur est définie sur "true" (vrai), le code d'autorisation est renvoyé par le point de terminaison d'autorisation de l'IdP.

token
(deprecated)

bool

Ne l'utilisez pas. Le type de réponse token n'est pas accepté pour le moment.

PasswordPolicyConfig

Configuration de la règle de mot de passe du projet.

Champs
password_policy_enforcement_state

PasswordPolicyEnforcementState

Mode d'application à utiliser pour la stratégie de mot de passe.

password_policy_versions[]

PasswordPolicyVersion

Doit comporter un seul caractère. Contient les attributs de sécurité de la règle de mot de passe.

force_upgrade_on_signin

bool

Pour se connecter, les utilisateurs doivent disposer d'un mot de passe conforme à la stratégie de mot de passe.

last_update_time

Timestamp

Uniquement en sortie. Date de la dernière mise à jour des règles relatives aux mots de passe du projet.

PasswordPolicyEnforcementState

État d'application de la règle de mot de passe

Enums
PASSWORD_POLICY_ENFORCEMENT_STATE_UNSPECIFIED État illégal, ne doit pas être utilisé.
OFF La stratégie de mot de passe ne sera pas utilisée pour le projet.
ENFORCE Les mots de passe non conformes aux règles sur les mots de passe seront rejetés et une erreur sera générée.

PasswordPolicyVersion

Attributs de force des règles concernant les mots de passe du projet.

Champs
custom_strength_options

CustomStrengthOptions

Options de sécurité personnalisées appliquées par la stratégie de mot de passe.

schema_version

int32

Uniquement en sortie. Numéro de version du schéma pour la stratégie de mots de passe

CustomStrengthOptions

Options de sécurité personnalisées à appliquer aux mots de passe des utilisateurs.

Champs
min_password_length

int32

Longueur minimale du mot de passe. Valeur comprise entre 6 et 30

max_password_length

int32

Longueur maximale du mot de passe. Aucune durée maximale par défaut

contains_lowercase_character

bool

Le mot de passe doit comporter une minuscule.

contains_uppercase_character

bool

Le mot de passe doit comporter une majuscule.

contains_numeric_character

bool

Le mot de passe doit comporter un chiffre.

contains_non_alphanumeric_character

bool

Le mot de passe doit comporter un caractère non alphanumérique.

ProviderConfig

ProviderConfig décrit les fournisseurs d'authentification multifacteur compatibles, ainsi que leurs configurations.

Champs
state

MfaState

Décrit l'état du type d'authentification multifacteur.

Champ d'union mfa_provider_config.

mfa_provider_config ne peut être qu'un des éléments suivants :

totp_provider_config

TotpMfaProviderConfig

Configuration du fournisseur d'authentification multifacteur TOTP pour ce projet.

QuotaConfig

Configuration liée aux quotas.

Champs
sign_up_quota_config

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

Champs
quota

int64

Correspond au champ "refill_token_count" de la configuration QuotaServer

start_time

Timestamp

Quand ce quota prendra-t-il effet ?

quota_duration

Duration

Durée pendant laquelle ce quota sera actif

RecaptchaConfig

Configuration de l'intégration reCAPTCHA Enterprise.

Champs
managed_rules[]

RecaptchaManagedRule

Règles gérées pour l'action d'authentification en fonction des scores reCAPTCHA. Les règles sont partagées entre les fournisseurs pour un projet de locataire donné.

recaptcha_keys[]

RecaptchaKey

Les clés reCAPTCHA.

toll_fraud_managed_rules[]

RecaptchaTollFraudManagedRule

Règles gérées pour l'action d'authentification en fonction des scores de risque de fraude par appel téléphonique reCAPTCHA. Les règles gérées pour la fraude aux péages ne prennent effet que lorsque l'état phone_enforcement_state est AUDIT ou ENFORCE et que use_sms_toll_fraud_protection est défini sur "true".

email_password_enforcement_state

RecaptchaProviderEnforcementState

Configuration reCAPTCHA pour le fournisseur d'adresses e-mail/de mots de passe, contenant l'état d'application. Le fournisseur d'adresse e-mail/de mot de passe contient tous les flux utilisateur liés à l'adresse e-mail protégés par reCAPTCHA.

use_account_defender

bool

Indique si l'outil Account Defender doit être utilisé pour l'évaluation reCAPTCHA. La valeur par défaut est false.

phone_enforcement_state

RecaptchaProviderEnforcementState

Configuration reCAPTCHA pour le fournisseur de téléphone, contenant l'état d'application forcée. Le fournisseur de téléphonie contient tous les flux utilisateur liés aux SMS protégés par reCAPTCHA.

use_sms_bot_score

bool

Indique si le score du bot rCE doit être utilisé pour le fournisseur de téléphone reCAPTCHA. Ne peut être défini sur "true" que si l'état phone_enforcement_state est AUDIT ou ENFORCE.

use_sms_toll_fraud_protection

bool

Indique si le score de risque de protection contre la fraude à la facturation par l'opérateur via SMS rCE doit être utilisé pour le fournisseur de téléphone reCAPTCHA. Ne peut être défini sur "true" que si l'état phone_enforcement_state est AUDIT ou ENFORCE.

RecaptchaProviderEnforcementState

États d'application de la protection reCAPTCHA.

Enums
RECAPTCHA_PROVIDER_ENFORCEMENT_STATE_UNSPECIFIED L'état d'application n'a pas été défini.
OFF Non appliquée.
AUDIT Une évaluation reCAPTCHA est créée, mais son résultat n'est pas utilisé pour l'application.
ENFORCE Une évaluation reCAPTCHA est créée, et le résultat est utilisé pour l'application.

RecaptchaKey

Configuration de la clé reCAPTCHA. reCAPTCHA Enterprise propose différentes clés pour différentes plates-formes clientes.

Champs
key

string

Nom de la ressource de clé reCAPTCHA Enterprise, par exemple "projects/{project}/keys/{key}"

type

RecaptchaKeyClientType

Type de plate-forme du client.

RecaptchaKeyClientType

Différents clients compatibles avec les clés reCAPTCHA Enterprise.

Enums
CLIENT_TYPE_UNSPECIFIED Le type de client n'est pas spécifié.
WEB Le type de client est Web.
IOS Le type de client est iOS.
ANDROID Le type de client est Android.

RecaptchaManagedRule

Configuration d'une règle gérée par reCAPTCHA. Modélise un seul intervalle [start_score, end_score]. La valeur start_score est implicite. Il s'agit de la valeur end_score la plus proche (si elle est disponible) ou de 0. Les intervalles de la valeur agrégée couvrent la plage [0, 1] sans se chevaucher.

Champs
end_score

float

Score de fin (inclus) de la plage de scores d'une action. Doit être une valeur comprise entre 0,0 et 1,0, avec 11 valeurs distinctes (par exemple, 0, 0,1, 0,2, 0,3, etc., 0,9, 1,0). Un score de 0,0 indique la requête la plus risquée (probablement un robot), tandis qu'un score de 1,0 indique la requête la plus sûre (probablement un humain). Consultez https://cloud.google.com/recaptcha-enterprise/docs/interpret-assessment.

action

RecaptchaAction

Action effectuée si le score reCAPTCHA d'une requête se situe dans l'intervalle [start_score, end_score].

RecaptchaAction

Actions pour les requêtes protégées par reCAPTCHA.

Enums
RECAPTCHA_ACTION_UNSPECIFIED L'action reCAPTCHA n'est pas spécifiée.
BLOCK La requête protégée par reCAPTCHA sera bloquée.

RecaptchaTollFraudManagedRule

Configuration d'une règle gérée d'évaluation de la fraude à la facturation par l'opérateur reCAPTCHA. Modélise un seul intervalle [start_score, end_score]. La valeur "end_score" est implicite. Il s'agit de la valeur end_score la plus proche (si elle est disponible) ou de 0. Les intervalles de la valeur agrégée couvrent la plage [0, 1] sans se chevaucher.

Champs
start_score

float

Score de début (inclus) pour une action. Doit être une valeur comprise entre 0,0 et 1,0, avec 11 valeurs distinctes (par exemple, 0, 0,1, 0,2, 0,3, etc., 0,9, 1,0). Un score de 0,0 indique la requête la plus sûre (probablement légitime), tandis qu'un score de 1,0 indique la requête la plus risquée (fraude à la facturation par l'opérateur probable). Consultez https://cloud.google.com/recaptcha-enterprise/docs/sms-fraud-detection#create-assessment-sms.

action

RecaptchaAction

Action effectuée si le score reCAPTCHA d'une requête se situe dans l'intervalle [start_score, end_score].

RecaptchaAction

La valeur par défaut est RECAPTCHA_ACTION_UNSPECIFIED.

Enums
RECAPTCHA_ACTION_UNSPECIFIED L'action reCAPTCHA n'est pas spécifiée.
BLOCK La requête protégée par reCAPTCHA sera bloquée.

SignInConfig

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

Champs
email

Email

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

phone_number

PhoneNumber

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

anonymous

Anonymous

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

allow_duplicate_emails

bool

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

hash_config

HashConfig

Uniquement en sortie. Informations de configuration du hachage.

Anonyme

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

Champs
enabled

bool

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

E-mail

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

Champs
enabled

bool

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

password_required

bool

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.

Champs
enabled

bool

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

test_phone_numbers

map<string, 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.

SmsRegionConfig

Configure les régions dans lesquelles les utilisateurs sont autorisés à envoyer des SMS de validation pour le projet ou le locataire. Il est basé sur le code d'appel du numéro de téléphone de destination.

Champs
Champ d'union sms_region_policy. Règle concernant les pays dans lesquels les utilisateurs sont autorisés à envoyer des SMS de validation. Vous pouvez autoriser toutes les régions par défaut ou n'autoriser les régions que via une liste d'autorisation explicite. sms_region_policy ne peut être qu'un des éléments suivants :
allow_by_default

AllowByDefault

Une règle autorisant les SMS dans toutes les régions par défaut et ajoutant les régions non autorisées à une liste de non-autorisation.

allowlist_only

AllowlistOnly

Règle qui n'autorise que les régions en les ajoutant explicitement à une liste d'autorisation.

AllowByDefault

Définit une règle autorisant toutes les régions par défaut et ajoutant les régions non autorisées à une liste de non-autorisation.

Champs
disallowed_regions[]

string

Codes de région Unicode à deux lettres à ne pas autoriser, comme défini sur https://cldr.unicode.org/. La liste complète de ces codes de région est disponible sur https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json.

AllowlistOnly

Définit une stratégie qui n'autorise que les régions en les ajoutant explicitement à une liste d'autorisation.

Champs
allowed_regions[]

string

Codes régionaux Unicode à deux lettres à autoriser, comme défini sur https://cldr.unicode.org/. La liste complète de ces codes régionaux est disponible sur https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json.

SpCertificate

Données du certificat du SP permettant à l'IdP de valider la requête SAML générée par le SP.

Champs
x509_certificate

string

Certificat public autosigné.

expires_at

Timestamp

Code temporel de l'instance d'expiration du certificat.

Locataire

Un locataire contient la configuration du locataire dans un projet multi-tenant.

Champs
name

string

Uniquement en sortie. Nom de ressource d'un locataire. Par exemple: "projects/{project-id}/tenants/{tenant-id}"

display_name

string

Nom à afficher du locataire.

allow_password_signup

bool

Indique si l'authentification des utilisateurs par adresse e-mail/mot de passe est autorisée.

disable_auth

bool

Indique si l'authentification est désactivée pour le locataire. Si la valeur est "True", les utilisateurs du locataire désactivé ne sont pas autorisés à se connecter. Les administrateurs du locataire désactivé ne peuvent pas gérer ses utilisateurs.

hash_config

HashConfig

Uniquement en sortie. Informations de configuration du hachage d'un locataire à afficher sur Pantheon. Cette information ne peut être affichée que sur Pantheon pour éviter que des informations sensibles ne soient divulguées accidentellement. Ne renvoyé que dans la réponse GetTenant pour limiter la lecture de ces informations. Pour renvoyer ce champ, vous devez disposer de l'autorisation firebaseauth.configs.getHashConfig sur le projet de l'agent.

enable_anonymous_user

bool

Indique si l'authentification anonyme des utilisateurs doit être activée.

mfa_config

MultiFactorAuthConfig

Configuration des options d'authentification multifacteur au niveau du locataire.

test_phone_numbers

map<string, string>

Carte des paires <numéro de téléphone de test, faux code> pouvant être utilisées pour l'authentification multifacteur. Le numéro de téléphone doit être au format E.164 (https://www.itu.int/rec/T-REC-E.164/). Vous pouvez ajouter au maximum 10 paires (une erreur sera générée si vous dépassez ce nombre).

inheritance

Inheritance

Spécifiez les paramètres que le locataire peut hériter.

recaptcha_config

RecaptchaConfig

Configuration reCAPTCHA au niveau du locataire.

sms_region_config

SmsRegionConfig

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

autodelete_anonymous_users

bool

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

monitoring

MonitoringConfig

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

password_policy_config

PasswordPolicyConfig

Configuration des règles de mot de passe au niveau du locataire

email_privacy_config

EmailPrivacyConfig

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

client

ClientPermissionConfig

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

TotpMfaProviderConfig

TotpMFAProviderConfig représente le fournisseur d'authentification multifacteur basé sur le TOTP.

Champs
adjacent_intervals

int32

Nombre d'intervalles adjacents autorisés qui seront utilisés pour la validation afin d'éviter les décalages de l'horloge.

UpdateConfigRequest

Requête pour UpdateConfig

Champs
config

Config

Ressource de configuration qui remplace la ressource sur le serveur.

L'autorisation IAM suivante est requise pour la ressource config indiquée :

  • firebaseauth.configs.update
update_mask

FieldMask

Le masque de mise à jour s'applique à la ressource. Les champs définis dans la configuration, mais non inclus dans ce masque de mise à jour, seront ignorés. Pour obtenir la définition de FieldMask, consultez la page https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

UpdateDefaultSupportedIdpConfigRequest

Requête pour UpdateDefaultSupportedIdpConfig

Champs
default_supported_idp_config

DefaultSupportedIdpConfig

Ressource de configuration qui remplace la ressource sur le serveur.

L'autorisation IAM suivante est requise pour la ressource defaultSupportedIdpConfig indiquée :

  • firebaseauth.configs.update
update_mask

FieldMask

Le masque de mise à jour s'applique à la ressource. Pour obtenir la définition de FieldMask, consultez la page https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

UpdateInboundSamlConfigRequest

Requête pour UpdateInboundSamlConfig

Champs
inbound_saml_config

InboundSamlConfig

Ressource de configuration qui remplace la ressource sur le serveur.

L'autorisation IAM suivante est requise pour la ressource inboundSamlConfig indiquée :

  • firebaseauth.configs.update
update_mask

FieldMask

Le masque de mise à jour s'applique à la ressource. Si le masque de mise à jour est vide, aucune mise à jour n'est effectuée. Pour obtenir la définition de FieldMask, consultez la page https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

UpdateOAuthIdpConfigRequest

Requête pour UpdateOAuthIdpConfig

Champs
oauth_idp_config

OAuthIdpConfig

Ressource de configuration qui remplace la ressource sur le serveur.

L'autorisation IAM suivante est requise pour la ressource oauthIdpConfig indiquée :

  • firebaseauth.configs.update
update_mask

FieldMask

Le masque de mise à jour s'applique à la ressource. Si le masque de mise à jour est vide, aucune mise à jour n'est effectuée. Pour obtenir la définition de FieldMask, consultez la page https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

UpdateTenantRequest

Message de requête pour UpdateTenant.

Champs
tenant

Tenant

Obligatoire. Locataire à mettre à jour.

L'autorisation IAM suivante est requise pour la ressource tenant indiquée :

  • identitytoolkit.tenants.update
update_mask

FieldMask

Si elle est fournie, ne mettez à jour que les champs définis dans le masque de mise à jour. Sinon, tous les champs pouvant être définis seront mis à jour. Pour obtenir la définition de FieldMask, consultez la page https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.

VerifyDomainRequest

Message de demande visant à vérifier que le domaine personnalisé demandé dispose des enregistrements DNS requis.

Champs
resource

string

Nom de la ressource dont vous souhaitez valider le domaine. Cette méthode accepte actuellement la validation de domaines pour les projets (par exemple, "projects/my-awesome-project") ou les locataires (par exemple, "projects/my-awesome-project/tenants/my-awesome-tenant").

L'autorisation IAM suivante est requise pour la ressource resource indiquée :

  • firebaseauth.configs.update
domain

string

Domaine cible de cette requête.

action

DomainVerificationAction

Action tentée sur le domaine donné.

DomainVerificationAction

Action tentée sur le domaine donné.

Enums
DOMAIN_VERIFICATION_ACTION_UNSPECIFIED Valeur par défaut. Ne l'utilisez pas.
VERIFY Vérifiez le domaine dans la requête.
CANCEL Annulez la procédure de validation en cours.
APPLY Appliquez le domaine personnalisé lors de l'envoi d'e-mails.

VerifyDomainResponse

Réponse à la requête VerifyDomain.

Champs
verification_state

VerificationState

État obtenu pour le domaine donné une fois cette requête traitée.

verification_error

string

Le cas échéant, une explication textuelle expliquant pourquoi la validation du domaine n'a pas été possible.