Package google.cloud.identitytoolkit.v2

Index

AccountManagementService

Gestion des comptes pour Identity Toolkit

FinalizeMfaEnrollment

rpc FinalizeMfaEnrollment(FinalizeMfaEnrollmentRequest) returns (FinalizeMfaEnrollmentResponse)

Termine l'inscription d'un deuxième facteur pour l'utilisateur.

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

rpc StartMfaEnrollment(StartMfaEnrollmentRequest) returns (StartMfaEnrollmentResponse)

Première étape du processus d'inscription au MFA. Dans le cas d'un SMS, un code de validation est envoyé à l'utilisateur.

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

rpc WithdrawMfa(WithdrawMfaRequest) returns (WithdrawMfaResponse)

Révoque un deuxième facteur parmi les seconds facteurs enregistrés pour un compte.

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.

AuthenticationService

Authentification pour Identity Toolkit

FinalizeMfaSignIn

rpc FinalizeMfaSignIn(FinalizeMfaSignInRequest) returns (FinalizeMfaSignInResponse)

Vérifie le défi d'authentification multifacteur et effectue la connexion

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

rpc GetPasswordPolicy(GetPasswordPolicyRequest) returns (PasswordPolicy)

Récupère la configuration de la stratégie de mots de passe définie sur le projet ou le 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/cloud-platform

Pour en savoir plus, consultez Authentication Overview.
GetRecaptchaConfig

rpc GetRecaptchaConfig(GetRecaptchaConfigRequest) returns (RecaptchaConfig)

Récupère les paramètres nécessaires à l'analyse reCAPTCHA.

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

rpc RevokeToken(RevokeTokenRequest) returns (RevokeTokenResponse)

Révoque le jeton d'un utilisateur auprès d'un fournisseur d'identité (IdP). Pour ce faire, vous devez fournir manuellement des identifiants d'IDP et les types de jetons à révoquer.

Une clé API est requise dans la requête pour identifier le projet Google Cloud.

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

rpc StartMfaSignIn(StartMfaSignInRequest) returns (StartMfaSignInResponse)

Envoie le défi MFA

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.

AutoRetrievalInfo

Informations requises pour récupérer automatiquement un SMS.

Champs
app_signature_hash

string

Hachage de signature de l'application Android pour l'API SMS Retriever du service Google Play.

ClientType

Type de plate-forme du client: Web, Android ou iOS.

Enums
CLIENT_TYPE_UNSPECIFIED Le type de client n'est pas spécifié.
CLIENT_TYPE_WEB Le type de client est Web.
CLIENT_TYPE_ANDROID Le type de client est Android.
CLIENT_TYPE_IOS Le type de client est ios.

FinalizeMfaEnrollmentRequest

Termine l'inscription d'un deuxième facteur pour l'utilisateur.

Champs
id_token

string

Obligatoire. Jeton d'ID
display_name

string

Nom à afficher saisi par les utilisateurs pour distinguer les différents facteurs d'authentification à deux facteurs du même type ou de types différents.
tenant_id

string

ID du locataire Identity Platform auquel appartient l'utilisateur qui active l'authentification multifacteur. Si ce paramètre n'est pas défini, l'utilisateur appartient au projet Identity Platform par défaut.
Champ d'union verification_info. Informations d'enregistrement de l'authentification multifacteur à valider verification_info ne peut être qu'un des éléments suivants :
phone_verification_info

FinalizeMfaPhoneRequestInfo

Informations de validation pour autoriser l'envoi d'un SMS de validation du numéro de téléphone.
totp_verification_info

FinalizeMfaTotpEnrollmentRequestInfo

Informations de validation pour TOTP.

FinalizeMfaEnrollmentResponse

Réponse FinalizeMfaEnrollment.

Champs
id_token

string

Le jeton d'ID a été mis à jour pour refléter l'inscription au MFA.
refresh_token

string

Le jeton d'actualisation a été mis à jour pour refléter l'inscription à l'authentification multifacteur.
Champ d'union auxiliary_auth_info. Informations d'enregistrement validées par l'authentification multifacteur. auxiliary_auth_info ne peut être qu'un des éléments suivants :
phone_auth_info

FinalizeMfaPhoneResponseInfo

Informations d'authentification auxiliaires spécifiques à l'authentification par téléphone.
totp_auth_info

FinalizeMfaTotpEnrollmentResponseInfo

Informations d'authentification auxiliaires spécifiques à l'authentification TOTP.

FinalizeMfaPhoneRequestInfo

Informations de validation du numéro de téléphone pour une requête FinalizeMfa.

Champs
session_info

string

Chaîne opaque représentant la session d'enregistrement.
code

string

Code de validation saisi par l'utilisateur.
android_verification_proof

string

Android uniquement. Utilisé pour la validation "instantanée" du numéro de téléphone via GmsCore.
phone_number

string

Obligatoire si un justificatif de validation Android est présenté.

FinalizeMfaPhoneResponseInfo

Informations de validation du numéro de téléphone pour une réponse FinalizeMfa.

Champs
android_verification_proof

string

Android uniquement. Remplacement à long terme du code valide associé à l'appareil Android.
android_verification_proof_expire_time

Timestamp

Android uniquement. Délai d'expiration de la preuve de validation en secondes.
phone_number

string

Pour la preuve de validation Android.

FinalizeMfaSignInRequest

Finalise la connexion en validant le défi d'authentification multifacteur.

Champs
mfa_pending_credential

string

Obligatoire. Identifiants en attente de la connexion au premier facteur.
tenant_id

string

ID du locataire Identity Platform auquel l'utilisateur se connecte. Si ce paramètre n'est pas défini, l'utilisateur se connectera au projet Identity Platform par défaut.
mfa_enrollment_id

string

ID d'enregistrement de l'authentification multifacteur de la liste des enregistrements d'authentification multifacteur actuels de l'utilisateur.
Champ d'union verification_info. Justificatif de l'achèvement du test d'authentification multifacteur verification_info ne peut être qu'un des éléments suivants :
phone_verification_info

FinalizeMfaPhoneRequestInfo

Preuve de l'achèvement du défi MFA par SMS
totp_verification_info

MfaTotpSignInRequestInfo

Preuve de réussite du défi MFA basé sur le TOTP

FinalizeMfaSignInResponse

Réponse FinalizeMfaSignIn.

Champs
id_token

string

Jeton d'ID de l'utilisateur authentifié.
refresh_token

string

Jeton d'actualisation de l'utilisateur authentifié.
Champ d'union auxiliary_auth_info. Informations de connexion validées par l'authentification multifacteur. auxiliary_auth_info ne peut être qu'un des éléments suivants :
phone_auth_info

FinalizeMfaPhoneResponseInfo

Informations d'authentification supplémentaires pour le téléphone, y compris une preuve de validation Android

FinalizeMfaTotpEnrollmentRequestInfo

Informations sur la requête d'authentification multifacteur spécifiques à l'authentification TOTP pour FinalizeMfa.

Champs
session_info

string

Chaîne opaque représentant la session d'enregistrement.
verification_code

string

Code de validation saisi par l'utilisateur.

FinalizeMfaTotpEnrollmentResponseInfo

Ce type ne comporte aucun champ.

Informations de réponse de l'authentification multifacteur spécifiques à l'authentification TOTP pour FinalizeMfa.

GetPasswordPolicyRequest

Requête pour GetPasswordPolicy.

Champs
tenant_id

string

Identifiant d'un locataire.

GetRecaptchaConfigRequest

Requête pour GetRecaptchaConfig.

Champs
tenant_id

string

Identifiant d'un locataire.
client_type

ClientType

reCAPTCHA Enterprise utilise des clés de site distinctes pour différents types de clients. Spécifiez le type de client pour obtenir la clé correspondante.
version

RecaptchaVersion

Version de reCAPTCHA.

MfaTotpSignInRequestInfo

Informations de validation TOTP pour FinalizeMfaSignInRequest.

Champs
verification_code

string

Code de validation saisi par l'utilisateur.

PasswordPolicy

Configuration de la règle de mot de passe.

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
allowed_non_alphanumeric_characters[]

string

Uniquement en sortie. Caractères autorisés qui répondent à la condition non_alphanumérique.
enforcement_state

EnforcementState

Uniquement en sortie. Mode d'application à utiliser pour la stratégie 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.

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.

EnforcementState

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

Enums
ENFORCEMENT_STATE_UNSPECIFIED L'état d'application n'a pas été défini.
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.

RecaptchaConfig

Configuration pour reCAPTCHA

Champs
recaptcha_enforcement_state[]

RecaptchaEnforcementState

État de l'application forcée de reCAPTCHA pour les fournisseurs pour lesquels GCIP est compatible avec la protection reCAPTCHA.
recaptcha_key

string

Nom de la ressource de clé reCAPTCHA Enterprise, par exemple "projects/{project}/keys/{key}". Cette valeur ne sera renvoyée que lorsque l'état d'application de reCAPTCHA est AUDIT ou ENFORCE sur au moins l'un des fournisseurs reCAPTCHA.
use_sms_bot_score

bool

Indique si le score du bot rCE doit être utilisé pour le fournisseur de téléphone reCAPTCHA.
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.

RecaptchaEnforcementState

États d'application de la protection reCAPTCHA.

Champs
provider

RecaptchaProvider

Le fournisseur qui bénéficie de la protection reCAPTCHA.
enforcement_state

EnforcementState

État de l'application forcée de reCAPTCHA pour le fournisseur.

EnforcementState

États d'application de la protection reCAPTCHA par fournisseur.

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

RecaptchaProvider

Fournisseurs de GCIP compatibles avec la protection reCAPTCHA

Enums
RECAPTCHA_PROVIDER_UNSPECIFIED Fournisseur reCAPTCHA non spécifié
EMAIL_PASSWORD_PROVIDER Fournisseur de mot de passe de messagerie
PHONE_PROVIDER Fournisseur d'authentification par téléphone

RecaptchaVersion

Version de reCAPTCHA.

Enums
RECAPTCHA_VERSION_UNSPECIFIED La version de reCAPTCHA n'est pas spécifiée.
RECAPTCHA_ENTERPRISE L'entreprise reCAPTCHA.

RevokeTokenRequest

Message de requête pour RevokeToken.

Champs
provider_id

string

Obligatoire. Fournisseur d'identité pour le jeton. Actuellement, il n'est compatible qu'avec l'IDP Apple. Le format doit être "apple.com".
token_type

TokenType

Obligatoire. Type du jeton à révoquer.
token

string

Obligatoire. Le jeton à révoquer. Si un code d'autorisation est transmis, l'API échange d'abord le code contre un jeton d'accès, puis révoque le jeton échangé.
id_token

string

Obligatoire. Un jeton d'ID Identity Platform valide pour associer le compte. Si une demande de révocation de jeton a abouti sur le compte et qu'aucun jeton n'est généré après la révocation, les requêtes en double sont ignorées et renvoyées immédiatement.
tenant_id

string

ID du locataire Identity Platform auquel l'utilisateur se connecte. Si ce paramètre n'est pas défini, l'utilisateur se connectera au projet Identity Platform par défaut.
redirect_uri

string

URI de redirection fourni dans la requête d'autorisation initiale envoyée par le client à l'IDP. L'URI doit utiliser le protocole HTTPS, inclure un nom de domaine et ne pas contenir d'adresse IP ni de localhost. Obligatoire si la valeur de l'attribut token_type est CODE.

TokenType

Type du jeton à révoquer.

Enums
TOKEN_TYPE_UNSPECIFIED Valeur par défaut, ne pas utiliser.
REFRESH_TOKEN Le type de jeton est "refresh_token".
ACCESS_TOKEN Le type de jeton est access_token.
CODE Le type de jeton est authorization_code.

RevokeTokenResponse

Ce type ne comporte aucun champ.

Message de réponse pour RevokeToken. Vide pour l'instant.

StartMfaEnrollmentRequest

Envoie un SMS de validation de l'enregistrement du MFA pour un utilisateur.

Champs
id_token

string

Obligatoire. Jeton d'ID de l'utilisateur.
tenant_id

string

ID du locataire Identity Platform auquel appartient l'utilisateur qui active l'authentification multifacteur. Si ce paramètre n'est pas défini, l'utilisateur appartient au projet Identity Platform par défaut.
Champ d'union enrollment_info. Informations sur l'authentification multifacteur par type de deuxième facteur. enrollment_info ne peut être qu'un des éléments suivants :
phone_enrollment_info

StartMfaPhoneRequestInfo

Informations de validation pour autoriser l'envoi d'un SMS de validation du numéro de téléphone.
totp_enrollment_info

StartMfaTotpEnrollmentRequestInfo

Informations de connexion spécifiques à l'authentification TOTP.

StartMfaEnrollmentResponse

Réponse StartMfaEnrollment.

Champs
Champ d'union enrollment_response. Réponse de début d'inscription à l'authentification multifacteur par type de deuxième facteur. enrollment_response ne peut être qu'un des éléments suivants :
phone_session_info

StartMfaPhoneResponseInfo

Informations de validation pour autoriser l'envoi d'un SMS de validation du numéro de téléphone.
totp_session_info

StartMfaTotpEnrollmentResponseInfo

Informations de réponse d'enregistrement spécifiques à l'authentification TOTP.

StartMfaPhoneRequestInfo

Informations de validation de l'application pour une requête StartMfa.

Champs
phone_number

string

Obligatoire pour l'inscription. Numéro de téléphone à enregistrer pour l'authentification multifacteur.
ios_receipt

string

iOS uniquement. Validation réussie du jeton d'application avec APNS.
ios_secret

string

iOS uniquement. Secret envoyé à l'application iOS via APNS.
recaptcha_token

string

Web uniquement. Solution reCAPTCHA.
auto_retrieval_info

AutoRetrievalInfo

Android uniquement. Utilisé par les services Google Play pour identifier l'application à récupérer automatiquement.
safety_net_token

string

Android uniquement. Utilisé pour affirmer l'identité de l'application à la place d'un jeton ReCaptcha. Un jeton SafetyNet peut être généré via l'API SafetyNet Android Attestation, avec l'encodage base64 du champ phone_number comme nonce.
play_integrity_token

string

Android uniquement. Utilisé pour affirmer l'identité de l'application à la place d'un jeton ReCaptcha (ou jeton de filet de sécurité). Un jeton Play Integrity peut être généré via l'API Play Integrity en appliquant SHA256 au champ phone_number en tant que nonce.
captcha_response

string

Jeton reCAPTCHA Enterprise fourni par l'intégration côté client de reCAPTCHA. Obligatoire lorsque reCAPTCHA Enterprise est activé.
client_type

ClientType

Type de client (Web, Android ou iOS) Obligatoire lorsque reCAPTCHA Enterprise est activé.
recaptcha_version

RecaptchaVersion

Version reCAPTCHA du jeton reCAPTCHA dans captcha_response. Obligatoire lorsque reCAPTCHA Enterprise est activé.

StartMfaPhoneResponseInfo

Informations de validation du numéro de téléphone pour une réponse StartMfa.

Champs
session_info

string

Chaîne opaque représentant la session d'enregistrement.

StartMfaSignInRequest

Lance la connexion multifacteur en envoyant la requête d'authentification multifacteur.

Champs
mfa_pending_credential

string

Obligatoire. Identifiants en attente de la connexion au premier facteur.
mfa_enrollment_id

string

Obligatoire. ID d'enregistrement de l'authentification multifacteur à partir de la liste des enregistrements d'authentification multifacteur actuels de l'utilisateur.
tenant_id

string

ID du locataire Identity Platform auquel l'utilisateur se connecte. Si ce paramètre n'est pas défini, l'utilisateur se connectera au projet Identity Platform par défaut.
Champ d'union sign_in_info. Informations sur l'authentification multifacteur par type de deuxième facteur. sign_in_info ne peut être qu'un des éléments suivants :
phone_sign_in_info

StartMfaPhoneRequestInfo

Informations de validation pour autoriser l'envoi d'un SMS de validation du numéro de téléphone.

StartMfaSignInResponse

Réponse StartMfaSignIn.

Champs
Champ d'union response_info. Réponse de début de connexion multifacteur par type de deuxième facteur. response_info ne peut être qu'un des éléments suivants :
phone_response_info

StartMfaPhoneResponseInfo

Informations sur la session de connexion multifacteur spécifiques aux seconds facteurs de type SMS. En plus du code à usage unique récupéré à partir du SMS envoyé, le contenu de ces informations de session doit être transmis à FinalizeMfaSignIn pour finaliser la connexion.

StartMfaTotpEnrollmentRequestInfo

Ce type ne comporte aucun champ.

Informations sur la requête d'authentification multifacteur spécifiques à l'authentification TOTP pour StartMfa.

StartMfaTotpEnrollmentResponseInfo

Informations de réponse de l'authentification multifacteur spécifiques à l'authentification TOTP pour StartMfa.

Champs
shared_secret_key

string

Chaîne encodée en base 32 représentant la clé secrète TOTP partagée.

L'encodage base 32 est celui spécifié dans la section 6 de la norme RFC 4648. Il s'agit de la même chose que l'encodage en base 32 de la RFC 3548, section 5.
verification_code_length

int32

Longueur du code de validation à générer.
hashing_algorithm

string

Algorithme de hachage utilisé pour générer le code de validation.
period_sec

int32

Durée en secondes pendant laquelle le code de validation change.
session_info

string

Chaîne encodée représentant la session d'enregistrement.
finalize_enrollment_time

Timestamp

Heure à laquelle l'inscription doit se terminer.

WithdrawMfaRequest

Révoque l'authentification multifacteur.

Champs
id_token

string

Obligatoire. Jeton d'ID de l'utilisateur.
mfa_enrollment_id

string

Obligatoire. ID d'enregistrement MFA d'un enregistrement MFA actuel.
tenant_id

string

ID du locataire Identity Platform auquel appartient l'utilisateur qui résilie l'authentification multifacteur. Si ce paramètre n'est pas défini, l'utilisateur appartient au projet Identity Platform par défaut.

WithdrawMfaResponse

Rétracte la réponse MultiFactorAuth.

Champs
id_token

string

Jeton d'identification mis à jour pour refléter la suppression du deuxième facteur.
refresh_token

string

Le jeton d'actualisation a été mis à jour pour refléter la suppression du deuxième facteur.