Package google.cloud.identitytoolkit.v2beta1

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.
EnableCicp

rpc EnableCicp(EnableCicpRequest) returns (EnableCicpResponse)

Activez le CICP pour un projet Cloud. Cloud Identity pour les clients et les partenaires (CICP) 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.

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.
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.
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.
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.
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"

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 des droits d'un utilisateur sur 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.
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.

Sous-type

Sous-type de cette configuration.

Enums
SUBTYPE_UNSPECIFIED Valeur par défaut. Ne l'utilisez pas.
CUSTOMER_IDENTITY Un projet d'identité client.
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.
display_on_cloud_console

bool

Uniquement en sortie. Indique si la configuration de l'IDP doit être affichée sur Pantheon si l'IDP est désactivé.

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

EnableCicpRequest

Requête pour EnableCicp.

Champs
project

string

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

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

  • firebaseauth.configs.create

EnableCicpResponse

Ce type ne comporte aucun champ.

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

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

Proto pour les données de certificat de l'IDP afin de valider la signature dans la réponse SAML émise par l'IDP.

Champs
x509_certificate

string

Le certificat x509

InboundSamlConfig

Proto permettant de stocker une paire de configurations RP-IDP SAML lorsque le projet agit en tant que partie 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

Proto permettant de stocker la configuration du fournisseur d'identité (IdP) SAML lorsque le projet agit en tant que partie de confiance.
sp_config

SpConfig

Proto permettant de stocker la 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

Proto permettant de stocker la 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

Proto permettant de stocker la 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.

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 ListDefaultSupportedIdpConfigs

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.

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.

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
ADMIN_ENABLED L'authentification multifacteur peut être utilisée pour ce projet, mais ne peut être configurée que par les administrateurs du projet.

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é.
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.

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

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.
hash_config

HashConfig

Uniquement en sortie. Informations de configuration du hachage.

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.

SpCertificate

Proto pour les données de 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

Nom de ressource d'un locataire. Exemple: "projects/project1/tenants/tenant1"
display_name

string

Nom à afficher du locataire.
saml_configs[]
(deprecated)

SamlConfig

Configurations SAML demandées.
idp_configs[]
(deprecated)

IdpConfig

Configurations de l'IDP demandées.
allow_password_signup

bool

Indique si la connexion par adresse e-mail/mot de passe est autorisée.
disable_auth

bool

Indique si l'authentification du locataire est désactivée. 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.

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

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.

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.