Package google.cloud.identitytoolkit.v1

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

int32

Obligatoire. Longueur du hachage souhaitée en octets. La valeur minimale est 4 et la valeur maximale est 1 024.

HashType

Obligatoire. Ne doit pas être HASH_TYPE_UNSPECIFIED.

int32

Obligatoire. Degré de parallélisme, également appelé threads ou canaux. La valeur minimale est 1 et la valeur maximale est 16.

int32

Obligatoire. Nombre d'itérations à effectuer. La valeur minimale est 1 et la valeur maximale est 16.

int32

Obligatoire. Coût de la mémoire en kibioctets. La valeur maximale est de 32 768.

Version

Version de l'algorithme Argon2. Si ce champ n'est pas spécifié, la valeur par défaut est VERSION_13.

bytes

Les données associées supplémentaires, le cas échéant, sont ajoutées à la valeur de hachage pour fournir une couche de sécurité supplémentaire. Chaîne encodée en base64 si spécifiée via JSON.

string

Si tenant_id est spécifié, l'ID du projet Google Cloud auquel appartient le locataire Identity Platform. Sinon, l'ID du projet Google Cloud auquel les comptes appartiennent.

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

• firebaseauth.users.delete

string

Obligatoire. Liste des ID utilisateur à supprimer.

bool

Indique si vous devez forcer la suppression des comptes qui ne sont pas désactivés. Si la valeur est "false", seuls les comptes désactivés seront supprimés, et les comptes non désactivés seront ajoutés à errors.

string

Si les comptes appartiennent à un locataire Identity Platform, l'ID du locataire. Si les comptes appartiennent à un projet Identity Platform par défaut, ce champ n'est pas nécessaire.

BatchDeleteErrorInfo

Informations détaillées sur l'erreur pour les comptes qui ne peuvent pas être supprimés.

int32

Indice de l'élément en erreur dans le champ local_ids d'origine.

string

ID utilisateur correspondant.

string

Message d'erreur détaillé.

string

Identifiant de l'adresse e-mail du compte utilisateur pour lequel récupérer les fournisseurs associés. Au moins l'un des champs identifier et provider_id doit être défini.

L'adresse e-mail doit comporter moins de 256 caractères et respecter le format name@domain.tld. L'adresse e-mail doit également correspondre à la production d'addr-spec RFC 822.

string

URL valide vers laquelle le fournisseur d'identité doit rediriger l'utilisateur. L'URL ne doit pas contenir de fragments ni le paramètre de requête state réservé.

string

string

ID du fournisseur de l'IDP avec lequel l'utilisateur doit se connecter. Il doit s'agir d'un ID de fournisseur activé pour la connexion, qui figure dans la liste des IDP compatibles par défaut ou qui se présente au format oidc.* ou saml.*. Exemples : google.com, facebook.com, oidc.testapp et saml.testapp. Au moins l'un des champs identifier et provider_id doit être défini.

string

string

Champs d'application OAuth 2.0 supplémentaires séparés par des espaces spécifiant le champ d'application de la requête d'authentification avec l'IDP. Utilisé pour les IdP OAuth 2.0.

Pour le fournisseur Google, le flux avec code d'autorisation sera utilisé si ce champ est défini.

string

Chaîne opaque utilisée pour conserver des informations contextuelles entre la requête d'authentification et le rappel de l'IDP.

string

string

string

Utilisé pour le fournisseur Google. Domaine hébergé G Suite de l'utilisateur afin de limiter la connexion aux utilisateurs de ce domaine.

string

ID de session pouvant être validé dans SignInWithIdp pour éviter les attaques par fixation de session. Si cet argument est absent, une chaîne aléatoire est générée et renvoyée en tant qu'ID de session.

string

Utilisé pour le fournisseur Google. Type du flux d'authentification à utiliser. S'il est présent, il doit être défini sur CODE_FLOW pour spécifier le flux avec code d'autorisation. Sinon, le flux de jeton d'identité par défaut sera utilisé.

map<string, string>

Paramètres de requête personnalisés supplémentaires à ajouter à l'URI d'autorisation. Les paramètres suivants sont réservés et ne peuvent pas être ajoutés: client_id, response_type, scope, redirect_uri et state.

Pour le fournisseur Microsoft, le locataire Azure AD auquel vous souhaitez vous connecter peut être spécifié dans le paramètre personnalisé tenant.

string

ID du locataire Identity Platform pour lequel créer un URI d'autorisation ou rechercher un identifiant d'adresse e-mail. Si ce champ n'est pas défini, l'opération sera effectuée dans l'instance Identity Platform par défaut du projet.

string

string

URI d'autorisation du fournisseur demandé. Présent uniquement lorsqu'un ID de fournisseur est défini dans la requête.

string

bool

Indique si l'identifiant de l'adresse e-mail représente un compte existant. Présent uniquement lorsqu'un identifiant d'adresse e-mail est défini dans la requête.

string

ID du fournisseur de la requête, le cas échéant.

bool

Indique si l'utilisateur s'est déjà connecté avec l'ID du fournisseur indiqué dans la requête. Présent uniquement lorsqu'un identifiant d'adresse e-mail enregistré est défini dans la requête.

bool

Indique si un test CAPTCHA est nécessaire en raison d'un trop grand nombre de tentatives de connexion infructueuses de la part de l'utilisateur. Présent uniquement lorsqu'un identifiant d'adresse e-mail enregistré est défini dans la requête.

string

ID de session de la requête ou chaîne aléatoire générée par CreateAuthUri si elle est absente. Il permet d'éviter les attaques par fixation de session.

string

Liste des méthodes de connexion que l'utilisateur a déjà utilisées. Chaque élément est l'une des valeurs suivantes : password, emailLink ou l'ID du fournisseur d'un IdP. Présent uniquement lorsqu'un identifiant d'adresse e-mail enregistré est défini dans la requête. Si la protection contre l'énumération des adresses e-mail est activée, cette méthode renvoie une liste vide.

string

Obligatoire. Un jeton d'ID Identity Platform valide.

int64

Nombre de secondes avant l'expiration du cookie de session. Spécifiez une durée en secondes, comprise entre cinq minutes et quatorze jours, inclus.

string

ID du projet auquel appartient le compte.

string

ID du locataire Identity Platform auquel le compte appartient.

string

Cookie de session créé à partir du jeton d'ID Identity Platform spécifié dans la requête. Il se présente sous la forme d'un jeton Web JSON (JWT). Toujours présent.

string

ID du compte utilisateur à supprimer. Pour spécifier ce champ, vous devez disposer d'identifiants Google OAuth 2.0 avec les autorisations appropriées. Les requêtes des utilisateurs qui ne disposent pas de l'identifiant doivent transmettre un jeton d'ID à la place.

int64

string

Jeton d'ID Identity Platform du compte à supprimer. Doit être spécifié pour les requêtes d'utilisateurs finaux qui ne disposent pas d'identifiants Google OAuth 2.0. Les requêtes authentifiées comportant des identifiants Google OAuth2 avec les autorisations appropriées peuvent transmettre local_id pour spécifier le compte à supprimer.

string

ID du locataire auquel le compte appartient, le cas échéant. Ne doit être spécifié que pour les requêtes authentifiées comportant des identifiants Google OAuth 2.0 qui spécifient l'ID local d'un compte appartenant à un locataire Identity Platform.

string

ID du projet auquel appartient le compte. Ne doit être spécifié que dans les requêtes authentifiées qui spécifient l'ID local d'un compte.

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

• firebaseauth.users.delete

string

int64

string

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

int32

Nombre maximal de résultats à renvoyer. Doit être compris entre 1 et 1 000. Par défaut, cette valeur est de 20.

string

Si tenant_id est spécifié, l'ID du projet Google Cloud auquel appartient le locataire Identity Platform. Sinon, l'ID du projet Google Cloud auquel les comptes appartiennent.

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

• firebaseauth.users.get

string

ID du locataire Identity Platform auquel les comptes appartiennent. Si aucun n'est spécifié, les comptes du projet Identity Platform sont renvoyés.

string

UserInfo

Tous les comptes appartenant au projet/locataire, limités par "max_results" dans la requête.

string

Si d'autres comptes doivent être téléchargés, un jeton pouvant être transmis à DownloadAccount pour obtenir d'autres comptes. Sinon, ce champ est vide.

string

Adresse e-mail à laquelle une validation de l'authentification multifacteur doit être envoyée.

bool

Indique si le modèle est désactivé. Si cette valeur est définie sur "true", un modèle par défaut est utilisé.

string

Adresse de l'expéditeur de l'e-mail

string

Corps de l'e-mail

string

Objet de l'e-mail

string

À partir du nom à afficher

EmailBodyFormat

Format du corps de l'e-mail

string

Adresse de réponse

string

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

string

La valeur est au format de code de langue III (par exemple, "zh-CN", "es"). Les séparateurs "-" et "_" sont acceptés.

bool

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

int32

Indice de l'élément, plage comprise entre [0, request.size - 1]

string

Message d'erreur détaillé

string

Jeton d'ID Identity Platform du compte à récupérer. Doit être spécifié pour les requêtes des utilisateurs finaux.

string

ID d'un ou de plusieurs comptes à extraire. Ne doit être spécifié que par des requêtes authentifiées comportant des identifiants Google OAuth 2.0 avec les autorisations appropriées.

string

Adresse e-mail d'un ou de plusieurs comptes à extraire. L'e-mail doit comporter moins de 256 caractères et être au format name@domain.tld. L'adresse e-mail doit également correspondre à la production d'adresses RFC 822. Ne doit être spécifié que par des requêtes authentifiées d'un développeur.

int64

string

Numéro de téléphone d'un ou de plusieurs comptes à extraire. Ne doit être spécifié que par des requêtes authentifiées d'un développeur et doit être au format E.164 (par exemple, +15555555555).

FederatedUserIdentifier

string

ID du locataire auquel le compte appartient. Ne doit être spécifié que par des requêtes authentifiées d'un développeur.

string

ID du projet Google Cloud auquel appartient le compte ou le locataire Identity Platform spécifié par tenant_id. Ne doit être spécifié que par des requêtes authentifiées comportant des identifiants Google OAuth 2.0 avec les autorisations appropriées.

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

• firebaseauth.users.get

string

Adresse e-mail initiale d'un ou de plusieurs comptes à extraire. L'e-mail doit comporter moins de 256 caractères et être au format name@domain.tld. L'adresse e-mail doit également correspondre à la production d'adresses RFC 822. Ne doit être spécifié que par des requêtes authentifiées d'un développeur.

string

ID des fournisseurs d'identité acceptés. Il doit s'agir d'un ID de fournisseur activé pour la connexion, qui figure dans la liste des IDP compatibles par défaut ou qui se présente au format oidc.* ou saml.*. Exemples : google.com, facebook.com, oidc.testapp et saml.testapp.

string

ID utilisateur du compte auprès du fournisseur d'identité tiers spécifié par provider_id.

string

UserInfo

Informations sur le ou les comptes utilisateur spécifiques correspondant aux paramètres de la requête.

OobReqType

Obligatoire. Type de code hors bande (OOB) à envoyer. En fonction de cette valeur, d'autres champs de cette requête seront obligatoires et/ou auront une signification différente. Quatre codes hors connexion différents peuvent être envoyés: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL

string

Adresse e-mail du compte à laquelle envoyer le code hors connexion, généralement l'adresse e-mail du compte à mettre à jour. Obligatoire pour PASSWORD_RESET, EMAIL_SIGNIN et VERIFY_EMAIL. Obligatoire uniquement pour les requêtes VERIFY_AND_CHANGE_EMAIL lorsque return_oob_link est défini sur "true". Dans ce cas, il s'agit de l'adresse e-mail d'origine de l'utilisateur.

string

string

Pour une requête PASSWORD_RESET, une réponse reCaptcha est requise lorsque le système détecte une activité suspecte. Dans ce cas, il s'agit de la réponse du défi reCaptcha utilisé pour valider l'appelant.

string

Adresse IP de l'appelant Obligatoire uniquement pour les requêtes PASSWORD_RESET.

string

Adresse e-mail à laquelle le compte est mis à jour. Obligatoire uniquement pour les requêtes VERIFY_AND_CHANGE_EMAIL.

string

Jeton d'ID du compte. Il est obligatoire pour les requêtes VERIFY_AND_CHANGE_EMAIL et VERIFY_EMAIL, sauf si return_oob_link est défini sur "true".

string

URL à utiliser pour continuer après que l'utilisateur a cliqué sur le lien envoyé par e-mail. Il s'agit de l'URL qui permettra au widget Web de gérer le code OOB.

string

Si une application iOS associée peut gérer le code hors bande, l'ID de bundle iOS de cette application. Cela permet d'ouvrir l'application appropriée si elle est déjà installée.

string

Si une application iOS associée peut gérer le code hors bande, l'ID de l'App Store de cette application. Cela permettra à l'App Store de s'ouvrir sur la bonne application si elle n'est pas encore installée.

string

Si une application Android associée peut gérer le code hors bande, nom du package Android de l'application Android qui gérera le rappel lorsque ce code hors bande sera utilisé. L'application appropriée s'ouvrira si elle est déjà installée, ou le Google Play Store s'ouvrira sur l'application appropriée si elle ne l'est pas encore.

bool

Si une application Android associée peut gérer le code hors bande, indique si l'application Android doit être installée ou non sur l'appareil où le lien est ouvert si elle n'est pas déjà installée.

string

Si une application Android associée peut gérer le code hors bande, la version minimale de l'application. Si la version installée sur l'appareil est inférieure à cette version, l'utilisateur est redirigé vers le Google Play Store pour mettre à niveau l'application.

bool

Si cette valeur est définie sur "true", le lien du code hors connexion sera envoyé en tant que lien universel ou Android App Link, et sera ouvert par l'application correspondante si elle est installée. Si ce paramètre n'est pas défini ou est défini sur "false", le code hors bande est d'abord envoyé au widget Web, puis, si l'application est installée, l'utilisateur est redirigé vers celle-ci.

string

ID du locataire Identity Platform auquel le compte appartient.

string

ID du projet Identity Platform auquel le compte appartient. Pour spécifier ce champ, vous devez disposer d'identifiants Google OAuth 2.0 avec les autorisations appropriées.

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

• firebaseauth.users.sendEmail

string

Pour nous assurer que l'URL utilisée peut être facilement ouverte sur iOS ou Android, nous créons un lien dynamique Firebase. La plupart des projets Identity Platform n'ont qu'un seul domaine de lien dynamique activé. Vous pouvez donc laisser ce champ vide. Ce champ contient un domaine de lien dynamique spécifié pour les projets pour lesquels plusieurs liens dynamiques sont activés.

bool

Indique si le lien de confirmation contenant le code OOB doit être renvoyé dans la réponse (aucun e-mail n'est envoyé). Utilisé lorsqu'un développeur souhaite créer le modèle d'e-mail et l'envoyer lui-même. Par défaut, cette valeur est définie sur "false". Pour spécifier ce champ et le définir sur "true", vous devez disposer d'identifiants Google OAuth 2.0 avec les autorisations appropriées.

ClientType

Type de client: Web, Android ou iOS Obligatoire lorsque la protection reCAPTCHA Enterprise est activée.

RecaptchaVersion

Version reCAPTCHA du jeton reCAPTCHA dans captcha_response.

string

Facultatif. Pour nous assurer que l'URL utilisée peut être facilement ouverte sur iOS ou Android, nous créons un lien Hosting '/__/auth/links'. Ce champ facultatif contient le domaine à utiliser lors de la création d'un lien Hosting. Si ce paramètre n'est pas défini, le domaine .firebaseapp.com est utilisé.

string

string

Si "return_oob_link" est défini sur "true" dans la requête, code OOB à envoyer.

string

Si la valeur de "return_oob_link" est "false" dans la requête, l'adresse e-mail à laquelle la validation a été envoyée.

string

Si la valeur de "return_oob_link" est "true" dans la requête, le lien hors connexion à envoyer à l'utilisateur. Cette méthode renvoie le lien créé, y compris les paramètres liés à Firebase Dynamic Links.

int64

Numéro du projet de la demande de projet déléguée. Ce champ ne doit être utilisé que dans le cadre de la migration Firebase V1.

int64

Numéro de projet de la configuration à récupérer. Ce champ est obsolète et ne doit pas être utilisé par les nouvelles intégrations.

bool

Indique si le lien dynamique doit être renvoyé.

string

Nom du package Android à comparer au nom réel du package Android. Si ce champ est fourni et que sha1_cert_hash ne l'est pas, l'action génère une erreur si le nom ne correspond pas au nom réel du package Android.

string

ID du bundle iOS à comparer à l'ID du bundle iOS réel. Si ce champ est fourni, l'action génère une erreur si l'ID de bundle iOS réel ne correspond pas.

string

ID client OAuth de la RP. Si cette valeur est définie, une vérification est effectuée pour s'assurer que le client OAuth est valide pour le projet récupéré et la requête est refusée avec une erreur client si elle ne l'est pas.

string

Hachage SHA-1 du certificat d'application Android. Si cette valeur est définie, une vérification est effectuée pour s'assurer que le hachage du certificat est valide pour le projet et le nom de package Android récupérés.

string

ID de l'application Firebase, pour les applications qui utilisent Firebase. Vous le trouverez dans la console Firebase de votre projet. Si cette valeur est définie, une vérification est effectuée pour s'assurer que l'ID de l'application est valide pour le projet récupéré. Si ce n'est pas le cas, la requête sera rejetée avec une erreur client.

string

ID du projet de la configuration récupérée.

string

Clé API Google Cloud Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

bool

Indique si l'inscription à un compte avec mot de passe est autorisée. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

IdpConfig

Configuration du fournisseur OAuth2. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

string

Domaines autorisés pour la redirection de widget.

bool

Indique si l'utilisateur anonyme est activé. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

string

Domaine Firebase Dynamic Links utilisé pour créer des liens de redirection vers des applications natives.

bool

Indique si l'envoi d'e-mails doit être utilisé. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

EmailTemplate

Modèle d'e-mail de réinitialisation de mot de passe. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

EmailTemplate

Modèle d'e-mail pour la validation de l'adresse e-mail. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

EmailTemplate

Modèle d'e-mail pour modifier l'adresse e-mail. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

EmailTemplate

Modèle d'e-mail de réinitialisation du mot de passe pour l'ancienne application Firebase V1. Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

EmailTemplate

Modèle d'e-mail pour annuler l'ajout d'un second facteur Ce champ n'est renvoyé que pour les appels authentifiés d'un développeur.

string

string

string

Clé de site reCAPTCHA v2 utilisée pour appeler le service reCAPTCHA. Toujours présent.

string

Numéro de projet du producteur utilisé pour générer des jetons PIA

OpenIdConnectKey

Clés publiques du signataire du cookie de session, au format clé Web JSON (JWK).

Provider

bool

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

int32

Pourcentage d'utilisateurs qui seront invités/redirigés vers la connexion fédérée pour ce fournisseur d'identité

string

ID client OAuth2.

string

Code secret du client OAuth2.

string

ID client ajoutés à la liste blanche pour la vérification des audiences.

string

Identifiant du tiers de confiance, qui correspond à l'audience de la réponse SAML émise.

string

Jeton d'ID Identity Platform. Il sera validé, puis converti en une nouvelle réponse SAML.

string

ID d'entité de l'application SAML spécifié dans la console d'administration Google pour chaque application. Les développeurs en auront probablement besoin s'ils souhaitent rediriger vers une application tierce plutôt qu'une application G Suite. Lorsqu'il est utilisé, nous renvoyons un RelayState. Cela inclut une requête SAML, qui peut être utilisée pour déclencher un flux SAML déclenché par le fournisseur de services afin de rediriger vers l'application réelle.

string

Réponse SAMLResponse signée créée pour la partie de confiance.

string

Point de terminaison ACS qui consomme la réponse SAMLResponse renvoyée.

string

RelayState généré.

string

Adresse e-mail de l'utilisateur.

string

Prénom de l'utilisateur.

string

Nom de famille de l'utilisateur.

bool

Indique si l'utilisateur connecté a été créé par cette requête.

string

ID de cette option de MFA.

string

Nom à afficher pour cette option d'authentification multifacteur (par exemple, "téléphone portable professionnel").

Timestamp

Code temporel de l'inscription de ce second facteur au compte.

string

Il s'agit généralement du numéro de téléphone associé à cet enregistrement. Dans certains cas, par exemple après une première connexion avec un facteur d'authentification, seule la version masquée du numéro de téléphone associé s'affiche.

TotpInfo

Contient des informations spécifiques à l'authentification multifacteur TOTP.

EmailInfo

Contient des informations spécifiques à l'authentification multifacteur par e-mail.

string

Uniquement en sortie. phone_info non obscurci.

string

Type de clé.

string

Algorithme de signature.

string

Utilisation de la clé

string

Chaîne unique permettant d'identifier cette clé.

string

Modulus de la clé publique RSA, représenté sous la forme de l'encodage base64url de la représentation big-endian de la valeur.

string

Exposant de la clé publique RSA. Il est représenté par l'encodage base64url de la représentation big-endian de la valeur.

string

ID du fournisseur d'identité.

string

Nom à afficher de l'utilisateur auprès du fournisseur d'identité.

string

URL de la photo de profil de l'utilisateur auprès du fournisseur d'identité.

string

Identifiant de l'utilisateur auprès du fournisseur d'identité.

string

Adresse e-mail de l'utilisateur auprès du fournisseur d'identité.

string

Identifiant brut de l'utilisateur renvoyé directement par le fournisseur d'identité.

string

Nom d'utilisateur de l'utilisateur sur Twitter ou nom de connexion sur GitHub.

string

Numéro de téléphone de l'utilisateur auprès du fournisseur d'identité.

bool

Si la valeur est true, cette requête renvoie les comptes correspondant à la requête. Si la valeur est false, seul le nombre de comptes correspondant à la requête est renvoyé. La valeur par défaut est true.

int64

Nombre maximal de comptes à renvoyer, limité à 500. La valeur par défaut est 500. Valable uniquement lorsque la valeur de return_user_info est définie sur true.

int64

Nombre de comptes à ignorer au début des enregistrements correspondants. Valable uniquement lorsque la valeur de return_user_info est définie sur true.

SortByField

Order

string

ID du projet auquel le résultat est appliqué.

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

• firebaseauth.users.get

string

ID du locataire auquel le résultat est limité.

SqlExpression

string

Chaîne sans distinction de casse à laquelle l'adresse e-mail du compte doit correspondre. Vous ne devez spécifier qu'une seule valeur parmi email, phone_number ou user_id dans une SqlExpression. Si vous en spécifiez plusieurs, seul le premier (dans cet ordre) sera appliqué.

string

Chaîne à laquelle l'ID local du compte doit correspondre. Vous ne devez spécifier qu'un seul élément email, phone_number ou user_id dans une SqlExpression. Si vous en spécifiez plusieurs, seul le premier (dans cet ordre) sera appliqué.

string

Chaîne à laquelle le numéro de téléphone du compte doit correspondre. Vous ne devez spécifier qu'une seule valeur parmi email, phone_number ou user_id dans une SqlExpression. Si vous en spécifiez plusieurs, seul le premier (dans cet ordre) sera appliqué.

int64

Si return_user_info dans la requête est défini sur "true", il s'agit du nombre de comptes renvoyés dans ce message. Dans le cas contraire, il s'agit du nombre total de comptes correspondant à la requête.

UserInfo

Si return_user_info est défini sur "true" dans la requête, il s'agit des comptes correspondant à la requête.

string

Code hors bande généré par la requête GetOobCode. Spécifiez uniquement ce paramètre (ou uniquement ce paramètre et un ID de locataire) pour obtenir le type de code hors bande dans la réponse sans modifier l'état du compte. Seul un code hors bande PASSWORD_RESET peut être utilisé via cette méthode.

string

Nouveau mot de passe à définir pour ce compte. Si vous spécifiez ce champ, le compte sera modifié et le code hors bande sera utilisé s'il a été spécifié et qu'il est de type PASSWORD_RESET.

string

Mot de passe actuel du compte à modifier. Spécifiez-le et l'adresse e-mail pour modifier le mot de passe d'un compte sans utiliser de code hors bande.

string

Facultatif. Adresse e-mail du compte à modifier. Spécifiez-le ainsi que l'ancien mot de passe pour modifier le mot de passe d'un compte sans utiliser de code hors bande.

string

Facultatif. ID du locataire Identity Platform auquel le compte appartient.

string

string

Adresse e-mail associée au code hors bande utilisé.

string

OobReqType

MfaEnrollment

string

Numéro de téléphone au format E.164 auquel envoyer le code de validation.

string

Validation réussie du jeton d'application iOS. Au moins l'un des éléments (ios_receipt et ios_secret), recaptcha_token ou safety_net_token doit être spécifié pour vérifier que le code de validation est envoyé au nom d'une application réelle et non d'un émulateur, si 'captcha_response' n'est pas utilisé (reCAPTCHA Enterprise n'est pas activé). Il doit provenir de la réponse de [verifyIosClient][v1.accounts.verifyIosClient]. Le cas échéant, l'appelant doit également fournir ios_secret, ainsi qu'un ID de bundle dans l'en-tête x-ios-bundle-identifier, qui doit correspondre à l'ID de bundle de la requête [verifyIosClient][v1.accounts.verifyIosClient].

string

Secret envoyé à l'application iOS sous la forme d'une notification push. Doit être transmis avec un ios_receipt et l'en-tête x-ios-bundle-identifier.

string

Jeton reCAPTCHA pour la validation de l'application. Au moins l'un des éléments (ios_receipt et ios_secret), recaptcha_token ou safety_net_token doit être spécifié pour vérifier que le code de validation est envoyé au nom d'une application réelle et non d'un émulateur, si 'captcha_response' n'est pas utilisé (reCAPTCHA Enterprise n'est pas activé). Le recaptcha doit être généré en appelant [getRecaptchaParams][v1.getRecaptchaParams], et le jeton recaptcha sera généré lorsque l'utilisateur aura terminé le défi recaptcha.

string

ID du locataire Identity Platform auquel l'utilisateur se connecte.

AutoRetrievalInfo

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

string

Android uniquement. Utilisé pour affirmer l'identité de l'application à la place d'un jeton ReCaptcha. Au moins l'un des éléments (ios_receipt et ios_secret), recaptcha_token ou safety_net_token doit être spécifié pour vérifier que le code de validation est envoyé au nom d'une application réelle et non d'un émulateur, si 'captcha_response' n'est pas utilisé (reCAPTCHA Enterprise n'est pas activé). Un jeton SafetyNet peut être généré via l'API SafetyNet Android Attestation, avec l'encodage base64 du champ phone_number comme nonce.

string

Android uniquement. Utilisé pour affirmer l'identité de l'application à la place d'un jeton ReCaptcha (et de safety_net_token). Au moins l'un des éléments (ios_receipt et ios_secret), recaptcha_token, ou play_integrity_token doit être spécifié pour vérifier que le code de validation est envoyé au nom d'une application réelle et non d'un émulateur, si 'captcha_response' n'est pas utilisé (reCAPTCHA Enterprise n'est pas activé). 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.

string

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

ClientType

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

RecaptchaVersion

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

string

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

string

Informations chiffrées sur la session. Vous pouvez l'utiliser dans [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber] pour authentifier le numéro de téléphone.

string

Un jeton d'ID Identity Platform valide. Obligatoire lorsque vous essayez de modifier des informations liées à l'utilisateur.

string

ID de l'utilisateur. Pour spécifier ce champ, vous devez disposer d'identifiants Google OAuth 2.0 avec les autorisations appropriées. Pour les requêtes des utilisateurs finaux, un jeton d'ID doit être transmis à la place.

string

Nouveau nom à afficher de l'utilisateur à mettre à jour dans les attributs du compte. Le nom à afficher ne doit pas comporter plus de 256 caractères.

string

Nouvelle adresse e-mail de l'utilisateur à mettre à jour dans les attributs du compte. L'e-mail doit comporter moins de 256 caractères et être au format name@domain.tld. L'adresse e-mail doit également correspondre à la production d'adresses RFC 822. Si la protection contre l'énumération des adresses e-mail est activée, l'utilisateur ne peut pas modifier son adresse e-mail sans la valider au préalable, mais un administrateur peut le faire.

string

Nouveau mot de passe de l'utilisateur à mettre à jour dans les attributs du compte. Le mot de passe doit comporter au moins six caractères.

string

Les fournisseurs d'identité auxquels le compte doit être associé.

string

Code hors bande à appliquer au compte de l'utilisateur. Les types de codes hors bande suivants sont acceptés: * VERIFY_EMAIL * RECOVER_EMAIL * REVERT_SECOND_FACTOR_ADDITION * VERIFY_AND_CHANGE_EMAIL

bool

Indique si l'adresse e-mail de l'utilisateur a été validée. Pour spécifier ce champ, vous devez disposer d'identifiants Google OAuth 2.0 avec les autorisations appropriées.

bool

Indique si le compte doit être limité à la connexion fédérée.

string

string

Réponse du défi reCAPTCHA. Cette opération est obligatoire lorsque le système détecte des activités d'utilisation abusive potentielles.

int64

Spécifie l'horodatage minimal en secondes pour qu'un jeton d'ID Identity Platform soit considéré comme valide.

bool

Si la valeur est "true", le compte est marqué comme désactivé, ce qui signifie que l'utilisateur ne pourra plus se connecter.

string

int64

string

URL de la nouvelle photo de l'utilisateur pour que la photo de profil du compte soit mise à jour dans les attributs du compte. La longueur de l'URL doit être inférieure ou égale à 2 048 caractères.

UserAttributeName

bool

Indique s'il faut renvoyer un ID et un jeton d'actualisation. Doit toujours être défini sur "true".

string

Les fournisseurs d'identité à dissocier du compte de l'utilisateur.

int64

Code temporel en millisecondes correspondant à la dernière connexion au compte.

int64

Code temporel (en millisecondes) de création du compte.

string

Numéro de téléphone à mettre à jour dans les attributs du compte.

string

Attributs personnalisés au format JSON à stocker dans le jeton d'ID Identity Platform. Pour spécifier ce champ, vous devez disposer d'identifiants Google OAuth 2.0 avec les autorisations appropriées.

string

ID du locataire Identity Platform auquel le compte appartient. Les requêtes des utilisateurs finaux doivent transmettre un jeton d'ID Identity Platform plutôt que de définir ce champ.

string

ID du projet auquel appartient le compte. Pour spécifier ce champ, vous devez disposer d'identifiants Google OAuth 2.0 avec les autorisations appropriées. Les requêtes des utilisateurs finaux doivent transmettre un jeton d'ID Identity Platform à la place.

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

• firebaseauth.users.update

MfaInfo

Informations liées à l'authentification multifacteur à définir sur le compte de l'utilisateur. Toutes les informations précédentes liées à l'authentification multifacteur du compte seront écrasées. Pour spécifier ce champ, vous devez disposer d'identifiants Google OAuth 2.0 avec les autorisations appropriées.

ProviderUserInfo

Le fournisseur à associer au compte de l'utilisateur. Pour spécifier ce champ, vous devez disposer d'identifiants Google OAuth 2.0 avec les autorisations appropriées.

MfaEnrollment

Seconds facteurs que l'utilisateur a enregistrés.

string

string

ID de l'utilisateur authentifié.

string

Adresse e-mail du compte.

string

Nom à afficher du compte.

string

Jeton d'ID Identity Platform du compte. Il est utilisé pour l'inscription des anciens utilisateurs.

ProviderUserInfo

Fournisseurs d'identité associés au compte.

string

Nouvelle adresse e-mail définie sur les attributs du compte de l'utilisateur.

string

URL de la photo de l'utilisateur pour la photo de profil du compte.

string

Un jeton d'actualisation pour le compte. Il est utilisé pour l'inscription des anciens utilisateurs.

int64

Nombre de secondes avant l'expiration du jeton d'ID Identity Platform.

string

Obsolète. Aucun hachage de mot de passe n'est actuellement renvoyé.

bool

Indique si l'adresse e-mail du compte a été validée ou non.

string

Obligatoire. Jeton d'authentification personnalisé affirmé par le développeur. Le jeton doit être un jeton Web JSON (JWT) qui inclut les revendications listées dans la documentation de référence de l'API, sous la section "Revendications de jeton personnalisées".

string

bool

Doit toujours être défini sur "true".

int64

string

ID du locataire Identity Platform auquel l'utilisateur se connecte. Le cas échéant, l'ID doit correspondre à l'ID de locataire dans le jeton.

string

string

Jeton d'ID Identity Platform de l'utilisateur authentifié.

string

Jeton d'actualisation Identity Platform de l'utilisateur authentifié.

int64

Nombre de secondes avant l'expiration du jeton d'ID.

bool

Indique si l'utilisateur authentifié a été créé par cette requête.

string

Obligatoire. Code hors bande du lien de l'e-mail.

string

Obligatoire. Adresse e-mail à laquelle le lien de connexion a été envoyé. L'e-mail doit comporter moins de 256 caractères et être au format name@domain.tld. L'adresse e-mail doit également correspondre à la production d'adresses RFC 822.

string

Jeton d'ID valide pour un compte Identity Platform. Si cette valeur est transmise, cette requête associera l'adresse e-mail à l'utilisateur représenté par ce jeton d'identité et activera la connexion avec l'adresse e-mail dans le compte à l'avenir.

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.

string

string

Jeton d'ID Identity Platform de l'utilisateur authentifié.

string

Adresse e-mail avec laquelle l'utilisateur s'est connecté. Toujours présent dans la réponse.

string

Jeton d'actualisation de l'utilisateur authentifié.

int64

Nombre de secondes avant l'expiration du jeton d'ID.

string

ID de l'utilisateur authentifié. Toujours présent dans la réponse.

bool

Indique si l'utilisateur authentifié a été créé par cette requête.

string

Chaîne opaque qui sert de preuve que l'utilisateur a réussi la vérification du premier facteur.

MfaEnrollment

Informations sur les fournisseurs d'authentification multifacteur activés. Présent si l'utilisateur doit se connecter à l'aide de l'authentification multifacteur.

string

Obligatoire. ID de joueur Game Center de l'utilisateur. Obsolète par Apple.

Transmettez playerID avec gamePlayerID et teamPlayerID pour lancer la migration de l'ID de joueur Game Center d'un utilisateur vers gamePlayerID.

string

Obligatoire. L'URL permettant d'extraire la clé publique Apple pour valider la signature donnée est signée par Apple.

string

Obligatoire. Données de signature de validation générées par Apple.

string

Obligatoire. Chaîne aléatoire utilisée pour générer la signature donnée.

int64

Obligatoire. Heure à laquelle la signature a été créée par Apple, en millisecondes depuis l'epoch.

string

Jeton d'ID valide pour un compte Identity Platform. Si elle est présente, cette requête associera l'ID de joueur Game Center au compte représenté par ce jeton d'ID.

string

Nom à afficher de l'utilisateur dans Game Center.

string

ID du locataire Identity Platform auquel l'utilisateur se connecte.

string

ID de joueur de l'équipe Game Center de l'utilisateur. Identifiant unique d'un joueur de tous les jeux que vous distribuez à l'aide de votre compte de développeur. https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid

string

ID de joueur Game Center de l'utilisateur. Identifiant unique d'un joueur du jeu. https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid

string

ID de l'utilisateur authentifié. Toujours présent dans la réponse.

string

ID de joueur Game Center de l'utilisateur.

Transmettez playerID avec gamePlayerID et teamPlayerID pour lancer la migration de l'ID de joueur Game Center d'un utilisateur vers gamePlayerID.

string

Jeton d'ID Identity Platform de l'utilisateur authentifié.

string

Jeton d'actualisation Identity Platform de l'utilisateur authentifié.

int64

Nombre de secondes avant l'expiration du jeton d'ID.

bool

Indique si l'utilisateur connecté a été créé par cette requête.

string

Nom à afficher de l'utilisateur authentifié.

string

ID de joueur de l'équipe Game Center de l'utilisateur. Identifiant unique d'un joueur de tous les jeux que vous distribuez à l'aide de votre compte de développeur. https://developer.apple.com/documentation/gamekit/gkplayer/3174857-teamplayerid

string

ID de joueur Game Center de l'utilisateur. Identifiant unique d'un joueur du jeu. https://developer.apple.com/documentation/gamekit/gkplayer/3113960-gameplayerid

string

Obligatoire. URL vers laquelle l'IDP redirige l'utilisateur. Vous pouvez définir cette valeur sur http://localhost si l'utilisateur se connecte avec des identifiants d'IDP fournis manuellement.

string

Si l'utilisateur se connecte avec une réponse d'autorisation obtenue via une demande d'autorisation CreateAuthUri précédente, il s'agit du corps du rappel POST HTTP de l'IDP, le cas échéant.

Sinon, si l'utilisateur se connecte avec des identifiants d'IDP fournis manuellement, il doit s'agir d'un formulaire encodé en URL contenant les identifiants (par exemple, un jeton d'ID ou un jeton d'accès pour les IdP OAuth 2.0) et l'ID du fournisseur de l'IDP qui a émis les identifiants.

Par exemple, si l'utilisateur se connecte au fournisseur Google à l'aide d'un jeton d'ID Google, cette valeur doit être définie sur id_token=[GOOGLE_ID_TOKEN]&providerId=google.com, où [GOOGLE_ID_TOKEN] doit être remplacé par le jeton d'ID Google.

Si l'utilisateur se connecte au fournisseur Facebook à l'aide d'un jeton d'authentification Facebook, ce champ doit être défini sur id_token=[FACEBOOK_AUTHENTICATION_TOKEN]&providerId=facebook. com&nonce= [NONCE], où [FACEBOOK_AUTHENTICATION_TOKEN] doit être remplacé par le jeton d'authentification Facebook. La valeur nonce est requise pour valider le jeton. Si aucun nonce n'est fourni, la requête échoue.

Si l'utilisateur se connecte au fournisseur Facebook à l'aide d'un jeton d'accès Facebook, cette valeur doit être définie sur access_token=[FACEBOOK_ACCESS_TOKEN]&providerId=facebook. com, où [FACEBOOK_ACCESS_TOKEN] doit être remplacé par le jeton d'accès Facebook.

Si l'utilisateur se connecte au fournisseur Twitter à l'aide d'identifiants Twitter OAuth 1.0, ce paramètre doit être défini sur access_token=[TWITTER_ACCESS_TOKEN]&oauth_token_secret= [TWITTER_TOKEN_SECRET]&providerId=twitter.com, où [TWITTER_ACCESS_TOKEN] et [TWITTER_TOKEN_SECRET] doivent être remplacés respectivement par le jeton d'accès Twitter OAuth et le secret du jeton Twitter OAuth.

string

bool

Indique si le jeton d'actualisation OAuth doit être renvoyé à partir du fournisseur d'identité, le cas échéant.

string

ID de session renvoyé par un appel CreateAuthUri précédent. Ce champ est validé par rapport à cet ID de session pour éviter les attaques par fixation de session. Obligatoire si l'utilisateur se connecte avec une réponse d'autorisation issue d'une demande d'autorisation CreateAuthUri précédente.

int64

string

Un jeton d'ID Identity Platform valide. Si ce paramètre est transmis, le compte de l'utilisateur auprès du fournisseur d'identité sera associé au compte représenté par ce jeton d'identité.

bool

Doit toujours être défini sur "true".

bool

Indique si les identifiants OAuth doivent être renvoyés ou non par le fournisseur d'identité en cas d'erreurs FEDERATED_USER_ID_ALREADY_LINKED et EMAIL_EXISTS.

bool

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.

string

Chaîne opaque issue d'une réponse SignInWithIdp précédente. Si elle est définie, elle peut être utilisée pour répéter l'opération de connexion à partir de l'opération SignInWithIdp précédente. Cela peut se produire si l'utilisateur doit confirmer les informations de son compte lors d'une tentative de connexion fédérée précédente ou s'il doit associer des comptes.

string

ID de compte de l'utilisateur auprès du fournisseur d'identité. Toujours présent dans la réponse.

string

ID du fournisseur de l'IDP auquel l'utilisateur se connecte. Toujours présent dans la réponse.

string

Adresse e-mail du compte de l'utilisateur auprès de l'IDP.

bool

Indique si l'adresse e-mail du compte utilisateur est validée.

string

Prénom associé au compte de l'utilisateur auprès de l'IDP.

string

Nom complet du compte de l'utilisateur auprès du fournisseur d'identité.

string

Nom de famille associé au compte de l'utilisateur auprès du fournisseur d'identité.

string

Pseudo du compte de l'utilisateur auprès du fournisseur d'identité.

string

Préférence linguistique du compte de l'utilisateur auprès du fournisseur d'identité.

string

Fuseau horaire du compte de l'utilisateur auprès du fournisseur d'identité.

string

URL de la photo de profil de l'utilisateur sur l'IDP.

string

Date de naissance du compte de l'utilisateur auprès du fournisseur d'identité.

string

string

Adresse e-mail principale (de premier niveau) du compte Identity Platform de l'utilisateur, si elle est différente de l'adresse e-mail du fournisseur d'identité. Ne s'affiche que si le paramètre "Un compte par adresse e-mail" est activé.

string

ID de l'utilisateur Identity Platform authentifié. Toujours présent dans la réponse.

bool

Indique si un compte utilisateur Identity Platform existe avec la même adresse e-mail, mais associé à un autre compte auprès du même IdP. Présent uniquement si le paramètre "Un compte par adresse e-mail" est activé et que l'adresse e-mail de l'IDP est validée.

string

Nom à afficher du compte de l'utilisateur auprès de l'IDP.

string

Jeton d'ID Identity Platform de l'utilisateur authentifié.

string

Chaîne opaque définie dans CreateAuthUri, qui permet de conserver des informations contextuelles entre la requête d'authentification et le rappel de l'IDP.

string

Liste des ID de fournisseur auxquels l'utilisateur peut se connecter pour résoudre une erreur need_confirmation. N'est présent que si need_confirmation est défini sur true.

bool

Indique si un compte utilisateur Identity Platform existe ou non avec la même adresse e-mail que le compte actuellement connecté au fournisseur d'identité, et si l'adresse e-mail du compte n'est pas validée auprès du fournisseur d'identité. L'utilisateur devra se connecter au compte Identity Platform existant, puis y associer les identifiants actuels du fournisseur d'identité. Ne s'affiche que si le paramètre "Un compte par adresse e-mail" est activé.

string

Le jeton d'accès OAuth de l'IDP, s'il est disponible.

string

Le jeton d'actualisation OAuth 2.0 de l'IDP, s'il est disponible et si return_refresh_token est défini sur true.

int32

Nombre de secondes avant l'expiration du jeton d'accès OAuth de l'IDP.

string

Code d'autorisation OAuth 2.0, le cas échéant Uniquement présent pour le fournisseur Google.

bool

string

Secret du jeton OAuth 1.0 de l'IDP, s'il est disponible. Uniquement présent pour le fournisseur Twitter.

string

Jeton d'actualisation Identity Platform de l'utilisateur authentifié.

int64

Nombre de secondes avant l'expiration du jeton d'ID Identity Platform.

string

Le jeton d'identification OpenID Connect du fournisseur d'identité, s'il est disponible.

string

Nom d'utilisateur du compte de l'utilisateur auprès du fournisseur d'identité Twitter ou nom d'utilisateur du compte de l'utilisateur auprès du fournisseur d'identité GitHub.

string

Réponse JSON convertie en chaîne contenant toutes les données correspondant au compte de l'utilisateur auprès de l'IDP.

string

Message d'erreur renvoyé si return_idp_credential est défini sur true et qu'une erreur FEDERATED_USER_ID_ALREADY_LINKED ou EMAIL_EXISTS est détectée. La valeur de ce champ est FEDERATED_USER_ID_ALREADY_LINKED ou EMAIL_EXISTS.

bool

Indique si un compte Identity Platform a été créé pour l'utilisateur authentifié.

string

string

Chaîne opaque pouvant être utilisée comme identifiant du fournisseur d'identité auquel l'utilisateur se connecte. Le jeton en attente obtenu ici peut être défini dans une future requête SignInWithIdp pour reconnecter le même utilisateur avec l'IDP.

string

Valeur du champ tenant_id dans la requête.

string

Chaîne opaque qui sert de preuve que l'utilisateur a réussi l'authentification par premier facteur.

MfaEnrollment

Informations sur les fournisseurs d'authentification multifacteur activés pour le compte. Présent si l'utilisateur doit se connecter à l'aide de l'authentification multifacteur.

string

Obligatoire. Adresse e-mail avec laquelle l'utilisateur se connecte. L'e-mail doit comporter moins de 256 caractères et être au format name@domain.tld. L'adresse e-mail doit également correspondre à la production d'adresses RFC 822.

string

Obligatoire. Mot de passe fourni par l'utilisateur pour se connecter au compte.

string

string

string

Jeton reCAPTCHA fourni par l'intégration côté client de reCAPTCHA. reCAPTCHA Enterprise l'utilise pour l'évaluation des risques. Obligatoire lorsque reCAPTCHA Enterprise est activé.

string

int64

string

bool

Doit toujours être défini sur "true".

string

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

ClientType

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

RecaptchaVersion

Version reCAPTCHA du jeton reCAPTCHA dans captcha_response.

string

string

ID de l'utilisateur authentifié. Toujours présent dans la réponse.

string

Adresse e-mail de l'utilisateur authentifié. Toujours présent dans la réponse.

string

Nom à afficher de l'utilisateur stocké dans les attributs du compte.

string

Jeton d'ID Identity Platform de l'utilisateur authentifié.

bool

Indique si l'adresse e-mail est associée à un compte existant. Toujours vrai.

string

Photo de profil de l'utilisateur stockée dans les attributs du compte.

string

Le jeton d'accès OAuth2.

int32

Délai d'expiration du jeton d'accès, en secondes.

string

string

Jeton d'actualisation Identity Platform de l'utilisateur authentifié.

int64

Nombre de secondes avant l'expiration du jeton d'ID Identity Platform.

string

Chaîne opaque qui sert de preuve que l'utilisateur a réussi l'authentification par premier facteur.

MfaEnrollment

Informations sur les fournisseurs d'authentification multifacteur activés pour le compte. Présent si l'utilisateur doit se connecter à l'aide de l'authentification multifacteur.

UserNotification

Notifications d'avertissement pour l'utilisateur.

string

Informations de session chiffrées issues de la réponse de [sendVerificationCode][v1.accounts.sendVerificationCode]. Dans le cas d'une authentification à l'aide d'un code SMS, ce paramètre doit être spécifié, mais il peut ne pas l'être si vous utilisez une preuve temporaire.

string

Numéro de téléphone de l'utilisateur à utiliser pour se connecter. Cela est nécessaire si vous utilisez un justificatif temporaire. Dans ce cas, il doit correspondre au numéro de téléphone authentifié dans la requête ayant généré le justificatif temporaire. Ce champ est ignoré si des informations de session sont transmises.

string

Code de validation saisi par l'utilisateur à partir d'un SMS envoyé sur son téléphone.

string

Preuve de la validation du numéro de téléphone, fournie à partir d'une précédente requête [signInWithPhoneNumber][v1.accounts.signInWithPhoneNumber]. Si cette valeur est transmise, l'appelant doit également transmettre le numéro de téléphone validé dans la requête précédente dans le champ "phone_number".

string

Ne l'utilisez pas.

string

Jeton d'ID valide pour un compte Identity Platform. Si cette valeur est transmise, cette requête associe le numéro de téléphone à l'utilisateur représenté par cet ID token si le numéro de téléphone n'est pas utilisé, ou réauthentifie l'utilisateur si le numéro de téléphone est déjà associé à l'utilisateur.

VerifyOp

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.

string

Jeton d'ID Identity Platform de l'utilisateur authentifié.

string

Jeton d'actualisation de l'utilisateur authentifié.

int64

Nombre de secondes avant l'expiration du jeton d'ID.

string

ID de l'utilisateur authentifié. Présent en cas d'authentification réussie. Si le téléphone a pu être validé, mais que l'opération de compte n'a pas pu être effectuée, une preuve temporaire sera renvoyée.

bool

Indique si l'utilisateur authentifié a été créé par cette requête.

string

Preuve de la validation du numéro de téléphone, fournie si l'authentification par téléphone réussit, mais que l'opération de l'utilisateur échoue. Cela se produit lorsque la requête tente d'associer un numéro de téléphone à un utilisateur avec un jeton d'ID ou de réauthentifier un utilisateur avec un jeton d'ID, mais que le numéro de téléphone est associé à un autre utilisateur.

string

Ne l'utilisez pas.

int64

Ne l'utilisez pas.

string

Numéro de téléphone de l'utilisateur authentifié. Toujours présent dans la réponse.

int64

Nombre de secondes avant l'expiration de la preuve temporaire.

string

Adresse e-mail à attribuer à l'utilisateur créé. L'e-mail doit comporter moins de 256 caractères et être au format name@domain.tld. L'adresse e-mail doit également correspondre à la production d'adresses RFC 822. Si ce champ n'est pas fourni, un utilisateur anonyme sera créé.

string

Mot de passe à attribuer à l'utilisateur créé. Le mot de passe doit comporter au moins six caractères. Si défini, le champ email doit également être défini.

string

Nom à afficher de l'utilisateur à créer.

string

string

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

string

string

Jeton d'ID valide pour un utilisateur Identity Platform. Si ce paramètre est défini, cette requête associera les identifiants d'authentification à l'utilisateur représenté par ce jeton d'ID. Pour une requête non destinée à un administrateur, les champs email et password doivent être définis. Pour une requête d'administrateur, local_id ne doit pas être défini.

bool

Indique si l'adresse e-mail de l'utilisateur est validée. Pour spécifier ce champ, vous devez disposer d'identifiants Google OAuth 2.0 avec les autorisations appropriées.

string

URL de la photo de profil de l'utilisateur à créer.

bool

Indique si l'utilisateur sera désactivé lors de sa création. Les comptes désactivés sont inaccessibles, sauf pour les requêtes comportant des identifiants Google OAuth2 avec les autorisations appropriées.

string

ID de l'utilisateur à créer. L'ID doit être unique dans le projet pour lequel l'utilisateur est créé. Pour spécifier ce champ, vous devez disposer d'identifiants Google OAuth 2.0 avec les autorisations appropriées.

string

Numéro de téléphone de l'utilisateur à créer. Pour spécifier ce champ, vous devez disposer d'identifiants Google OAuth 2.0 avec les autorisations appropriées.

string

ID du locataire Identity Platform sous lequel créer un utilisateur. Si ce paramètre n'est pas défini, l'utilisateur sera créé dans le projet Identity Platform par défaut.

string

ID du projet auquel l'utilisateur doit appartenir. Pour spécifier ce champ, vous devez disposer d'identifiants Google OAuth 2.0 avec les autorisations appropriées. Si cet élément n'est pas défini, le projet cible est déduit de la portée associée au jeton d'accès porteur.

MfaFactor

Les fournisseurs d'authentification multifacteur que l'utilisateur peut créer.

ClientType

Type de client: Web, Android ou iOS Obligatoire lorsque vous activez la protection reCAPTCHA Enterprise.

RecaptchaVersion

Version reCAPTCHA du jeton reCAPTCHA dans captcha_response.

string

Nom à afficher pour cette option d'authentification multifacteur (par exemple, "téléphone portable professionnel").

string

Numéro de téléphone pour recevoir l'OTP pour l'authentification multifacteur

string

string

Jeton d'ID Identity Platform de l'utilisateur créé. Ce champ n'est défini que pour les requêtes non destinées aux administrateurs.

string

Nom à afficher de l'utilisateur créé.

string

Adresse e-mail de l'utilisateur créé.

string

Jeton d'actualisation Identity Platform de l'utilisateur créé. Ce champ n'est défini que pour les requêtes non destinées aux administrateurs.

int64

Nombre de secondes avant l'expiration du jeton d'ID.

string

ID de l'utilisateur créé. Toujours présent dans la réponse.

string

Obligatoire. Fonction de hachage utilisée pour hacher les mots de passe des comptes. Doit être l'une des valeurs suivantes: * HMAC_SHA256 * HMAC_SHA1 * HMAC_MD5 * SCRYPT * PBKDF_SHA1 * MD5 * HMAC_SHA512 * SHA1 * BCRYPT * PBKDF2_SHA256 * SHA256 * SHA512 * STANDARD_SCRYPT * ARGON2

bytes

Clé de signature utilisée pour hacher le mot de passe. Obligatoire pour les fonctions de hachage suivantes: * SCRYPT, * HMAC_MD5, * HMAC_SHA1, * HMAC_SHA256, * HMAC_SHA512

bytes

Un ou plusieurs octets à insérer entre le sel et le mot de passe en texte brut. Pour renforcer la sécurité, il doit s'agir d'un seul caractère non imprimable.

int32

Nombre de tours utilisés pour le calcul du hachage. Uniquement requis pour les fonctions de hachage suivantes: * MD5 * SHA1 * SHA256 * SHA512 * PBKDF_SHA1 * PBKDF2_SHA256 * SCRYPT

int32

Coût de la mémoire pour le calcul du hachage. Nécessaire uniquement lorsque la fonction de hachage est SCRYPT.

UserInfo

Liste des comptes à importer. local_id est obligatoire pour chaque utilisateur. Tout le reste est facultatif.

int64

bool

Si la valeur est définie sur "true", le service effectue la liste de vérifications suivante avant l'importation d'un compte: * Adresses e-mail en double * ID fédérés en double * Validation du fournisseur d'ID fédéré Si une duplication existe dans la liste des comptes à importer, l'importation de l'ensemble de la liste est bloquée. Si l'adresse e-mail ou l'ID fédéré est un doublon d'un utilisateur déjà présent dans le projet/le locataire, le compte ne sera pas importé, mais les autres comptes ne seront pas affectés. Si la valeur est "false", ces vérifications sont ignorées.

string

ID du projet Identity Platform auquel le compte appartient.

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

• firebaseauth.users.create

bool

Indique si un compte existant dans Identity Platform doit être écrasé par un local_id correspondant dans la requête. Si la valeur est "true", le compte existant sera écrasé. Si la valeur est "false", une erreur est renvoyée.

int32

Paramètre de coût de la mémoire du processeur à utiliser par la fonction de hachage STANDARD_SCRYPT. Ce paramètre, ainsi que block_size et cpu_mem_cost, permettent d'ajuster les ressources nécessaires au hachage d'un mot de passe. Il doit être ajusté à mesure que les vitesses de processeur et les technologies de mémoire évoluent.

int32

Paramètre de coût de parallélisation à utiliser par la fonction de hachage STANDARD_SCRYPT. Ce paramètre, ainsi que block_size et cpu_mem_cost, permettent d'ajuster les ressources nécessaires au hachage d'un mot de passe. Il doit être ajusté à mesure que les vitesses de processeur et les technologies de mémoire évoluent.

int32

Paramètre de taille de bloc utilisé par la fonction de hachage STANDARD_SCRYPT. Ce paramètre, ainsi que la parallélisation et cpu_mem_cost, permettent d'ajuster les ressources nécessaires au hachage d'un mot de passe. Il doit être ajusté à mesure que les vitesses de processeur et les technologies de mémoire évoluent.

int32

Longueur de clé souhaitée pour la fonction de hachage STANDARD_SCRYPT. Au moins 1.

PasswordHashOrder

string

ID du locataire Identity Platform auquel le compte appartient.

Argon2Parameters

Paramètres de l'algorithme de hachage Argon2.

string

ErrorInfo

Informations détaillées sur les erreurs pour les comptes qui ne peuvent pas être importés.

string

Immuable. Identifiant unique du compte.

string

Adresse e-mail du compte. L'e-mail doit comporter moins de 256 caractères et être au format name@domain.tld. L'adresse e-mail doit également correspondre à l'adresse addr-spec de la RFC 822.

string

Nom à afficher du compte. Cet attribut de compte n'est pas utilisé par Identity Platform. Il est disponible à titre purement informatif.

string

Uniquement en sortie. Préférence linguistique du compte. Cet attribut de compte n'est pas utilisé par Identity Platform. Il est disponible à titre purement informatif.

string

URL de la photo de profil du compte. Cet attribut de compte n'est pas utilisé par Identity Platform. Il est disponible à titre purement informatif.

string

Uniquement en sortie. Fuseau horaire préféré du compte. Cet attribut de compte n'est pas utilisé par Identity Platform. Il est disponible à titre purement informatif.

string

Uniquement en sortie. Date de naissance définie pour le compte. Cet attribut de compte n'est pas utilisé par Identity Platform. Il est disponible à titre purement informatif.

bytes

Mot de passe haché du compte. Uniquement accessible par les requêtes comportant des identifiants Google OAuth2 avec les autorisations appropriées.

bytes

Sel du mot de passe du compte. Uniquement accessible par les requêtes comportant des identifiants Google OAuth2 avec les autorisations appropriées.

int32

Version du mot de passe du compte. Uniquement accessible par les requêtes comportant des identifiants Google OAuth2 avec les autorisations appropriées.

bool

Indique si l'adresse e-mail du compte a été validée.

double

Code temporel en millisecondes à partir de l'epoch 1970-01-01T00:00:00Z, date de la dernière mise à jour du mot de passe du compte.

ProviderUserInfo

Informations sur l'utilisateur fournies par différents fournisseurs d'identité.

int64

Horodatage le plus ancien (en secondes depuis l'epoch) auquel un jeton d'ID doit être considéré comme valide. Tous les jetons d'ID émis avant cette heure sont considérés comme non valides.

bool

Indique si le compte est désactivé. Les comptes désactivés sont inaccessibles, sauf pour les requêtes comportant des identifiants Google OAuth2 avec les autorisations appropriées.

int64

Date et heure de la dernière connexion à ce compte, en millisecondes depuis l'epoch.

int64

Heure de création du compte (en millisecondes depuis l'epoch).

string

Uniquement en sortie. Nom d'utilisateur de ce compte sur Twitter ou nom de connexion sur GitHub.

bool

Uniquement en sortie. Indique si ce compte a été authentifié à l'aide de SignInWithCustomToken.

string

Uniquement en entrée. Mot de passe en texte brut utilisé pour mettre à jour le mot de passe d'un compte. Ce champ n'est utilisé que comme entrée dans une requête. Identity Platform utilise le hachage cryptographique pour gérer les mots de passe et ne stocke ni ne transmet jamais le mot de passe d'un utilisateur en texte brut.

string

Numéro de téléphone du compte.

string

Revendications personnalisées à ajouter à tous les jetons d'ID créés pour le compte. Doit comporter au maximum 1 000 caractères et être au format JSON valide.

bool

Uniquement en sortie. Indique si le compte peut s'authentifier avec l'association par e-mail.

string

ID du locataire auquel ce compte appartient. Ne définir que si ce compte appartient à un locataire.

MfaEnrollment

Informations sur les fournisseurs d'authentification multifacteur activés pour ce compte.

string

Première adresse e-mail associée à ce compte. Une fois définie, l'adresse e-mail initiale du compte ne peut plus être modifiée. Elle permet de récupérer l'accès à ce compte en cas de perte via le flux RECOVER_EMAIL dans GetOobCode. Doit correspondre à l'adresse spécifiée dans la RFC 822.

Timestamp

Code temporel de la dernière création d'un jeton d'ID pour ce compte.

NotificationCode

Enumération des notifications d'avertissement. Peut être utilisé pour la localisation.

string

Chaîne de notification d'avertissement. Peut être utilisé comme solution de secours.

string

Jeton d'appareil obtenu par le client iOS après son inscription aux APN (Apple Push Notification Service).

bool

Indique si le jeton de l'application se trouve dans le bac à sable iOS. Si la valeur est "false", le jeton d'application se trouve dans l'environnement de production.

string

Validation réussie du jeton d'application.

int64

Durée suggérée d'attente (en secondes) du client pour la diffusion de la notification push.