Mettre à jour un utilisateur
Met à jour un utilisateur.
Voici les attributs qui peuvent être mis à jour au root level :
- app_metadata
- blocked
- email_verified
- family_name
- given_name
- name
- nickname
- password
- phone_number
- phone_verified
- picture
- username
- user_metadata
- verify_email
Quelques points à considérer :
- Les propriétés du nouvel objet remplacent les anciennes.
- Les champs de metadata constituent une exception à cette règle (
user_metadataetapp_metadata). Ces propriétés sont fusionnées au lieu d’être remplacées, mais attention : la fusion ne s’effectue qu’au premier niveau. - Si vous mettez à jour
email,email_verified,phone_number,phone_verified,usernameoupasswordd’une identity secondaire, vous devez aussi préciser la propriétéconnection. - Si vous mettez à jour
emailouphone_number, vous pouvez préciser, de façon facultative, la propriétéclient_id. - La mise à jour de
email_verifiedn’est pas prise en charge pour les connections Enterprise et Passwordless SMS. - Définir
blockedàfalsen’a pas d’effet sur l’état de blocage de l’utilisateur causé par un trop grand nombre de credentials incorrects. Utilisez le endpoint « Unblock a user » de l’API « User Blocks » pour modifier l’état de l’utilisateur. - Les attributs Supported peuvent être désactivés en fournissant
nullcomme valeur.
Mise à jour d’un champ (propriété autre que metadata)
Pour marquer l’adresse courriel d’un utilisateur comme vérifiée, le Body à envoyer doit être :
Mise à jour d’une propriété racine de metadata utilisateur
Supposons que notre utilisateur de test ait le user_metadata suivant :
Pour ajouter le champ addresses, le Body à envoyer doit être :
L’objet modifié se retrouve avec la propriété user_metadata suivante :
Mise à jour d’une propriété interne de metadata utilisateur
S’il existe déjà des metadata utilisateur auxquelles nous voulons ajouter "home_address": "742 Evergreen Terrace" (au moyen de la propriété addresses), nous devons envoyer l’objet addresses au complet. Comme il s’agit d’un objet de premier niveau, l’objet sera fusionné, mais pas ses propres propriétés. Le Body à envoyer doit être :
L’objet modifié se retrouve avec la propriété user_metadata suivante :
Autorisations
Scopes
En-têtes
Corps
Réponse
Utilisateur mis à jour avec succès.