- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Essayer
Inscrit un nouvel utilisateur avec adresse e-mail et mot de passe ou un utilisateur anonyme, ou convertit un utilisateur anonyme en utilisateur avec adresse e-mail et mot de passe. Pour une requête d'administrateur avec des identifiants Google OAuth 2.0 disposant des autorisations appropriées, crée un utilisateur anonyme, avec une adresse e-mail et un mot de passe, ou un utilisateur avec un numéro de téléphone.
Une clé API est requise dans la requête pour identifier le projet Google Cloud.
Requête HTTP
POST https://identitytoolkit.googleapis.com/v1/projects/{targetProjectId}/tenants/{tenantId}/accounts
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
targetProjectId |
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. |
tenantId |
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. |
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Représentation JSON |
---|
{ "email": string, "password": string, "displayName": string, "captchaChallenge": string, "captchaResponse": string, "instanceId": string, "idToken": string, "emailVerified": boolean, "photoUrl": string, "disabled": boolean, "localId": string, "phoneNumber": string, "mfaInfo": [ { object ( |
Champs | |
---|---|
email |
Adresse e-mail à attribuer à l'utilisateur créé. L'e-mail doit comporter moins de 256 caractères et être au format |
password |
Mot de passe à attribuer à l'utilisateur créé. Le mot de passe doit comporter au moins six caractères. Si défini, le champ |
displayName |
Nom à afficher de l'utilisateur à créer. |
captchaChallenge |
|
captchaResponse |
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é. |
instanceId |
|
idToken |
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 |
emailVerified |
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. |
photoUrl |
URL de la photo de profil de l'utilisateur à créer. |
disabled |
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. |
localId |
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. |
phoneNumber |
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. |
mfaInfo[] |
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 captchaResponse. |
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une instance de SignUpResponse
.
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.