Method: projects.accounts.update

Met à jour les informations liées au compte de l'utilisateur spécifié en définissant des champs spécifiques ou en appliquant des codes d'action. Les demandes des administrateurs et des utilisateurs finaux sont acceptées.

Requête HTTP

POST https://identitytoolkit.googleapis.com/v1/projects/{targetProjectId}/accounts:update

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
targetProjectId

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

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "idToken": string,
  "localId": string,
  "displayName": string,
  "email": string,
  "password": string,
  "provider": [
    string
  ],
  "oobCode": string,
  "emailVerified": boolean,
  "upgradeToFederatedLogin": boolean,
  "captchaChallenge": string,
  "captchaResponse": string,
  "validSince": string,
  "disableUser": boolean,
  "instanceId": string,
  "delegatedProjectNumber": string,
  "photoUrl": string,
  "deleteAttribute": [
    enum (UserAttributeName)
  ],
  "returnSecureToken": boolean,
  "deleteProvider": [
    string
  ],
  "lastLoginAt": string,
  "createdAt": string,
  "phoneNumber": string,
  "customAttributes": string,
  "tenantId": string,
  "mfa": {
    object (MfaInfo)
  },
  "linkProviderUserInfo": {
    object (ProviderUserInfo)
  }
}
Champs
idToken

string

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

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

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

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

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.
provider[]

string

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

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
emailVerified

boolean

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

boolean

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

string
captchaResponse

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

string (int64 format)

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

boolean

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

string
delegatedProjectNumber
(deprecated)

string (int64 format)
photoUrl

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.
deleteAttribute[]

enum (UserAttributeName)
returnSecureToken

boolean

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

string

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

string (int64 format)

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

string (int64 format)

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

string

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

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

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

object (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.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de SetAccountInfoResponse.

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.