Modifier partiellement un utilisateur par id

Mettre à jour un utilisateur.

Voici les attributs qui peuvent être mis à jour au niveau racine :

• app_metadata
• blocked
• email
• email_verified
• family_name
• given_name
• name
• nickname
• password
• phone_number
• phone_verified
• picture
• username
• user_metadata
• verify_email

Quelques points à prendre en compte :

• Les propriétés du nouvel objet remplacent les anciennes.
• Les champs de métadonnées font exception à cette règle (user_metadata et app_metadata). Ces propriétés sont fusionnées plutôt que remplacées, mais attention : la fusion ne s’effectue qu’au premier niveau.
• Si vous mettez à jour email, email_verified, phone_number, phone_verified, username ou password d’une identité secondaire, vous devez également préciser la propriété connection.
• Si vous mettez à jour email ou phone_number, vous pouvez aussi préciser, de façon facultative, la propriété client_id.
• La mise à jour de email_verified n’est pas prise en charge pour les connexions d’entreprise et les connexions Passwordless par SMS.
• Définir blocked à false n’a aucun effet sur l’état de blocage de l’utilisateur causé par un trop grand nombre d’informations d’identification incorrectes fournies. Utilisez le point de terminaison “Unblock a user” de l’API “User Blocks” pour modifier l’état de l’utilisateur.
• Les attributs pris en charge peuvent être réinitialisés en fournissant la valeur null.

Mise à jour d’un champ (propriété autre qu’une métadonnée)

Pour marquer l’adresse de courriel d’un utilisateur comme vérifiée, le corps de la requête à envoyer doit être :

{ "email_verified": true }

Mise à jour d’une propriété racine de user metadata

Supposons que notre utilisateur de test possède le user_metadata suivant :

{ "user_metadata" : { "profileCode": 1479 } }

Pour ajouter le champ addresses, le corps de la requête à envoyer doit être :

{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}

L’objet modifié aura alors la propriété user_metadata suivante :

{
  "user_metadata": {
    "profileCode": 1479,
    "addresses": { "work_address": "100 Industrial Way" }
  }
}

Mise à jour d’une propriété interne de user metadata

S’il existe déjà des métadonnées 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. Puisqu’il s’agit d’un objet de premier niveau, l’objet sera fusionné, mais pas ses propres propriétés. Le corps de la requête à envoyer doit être :

{
  "user_metadata": {
    "addresses": {
      "work_address": "100 Industrial Way",
      "home_address": "742 Evergreen Terrace"
    }
  }
}

L’objet modifié aura alors la propriété user_metadata suivante :

{
  "user_metadata": {
    "profileCode": 1479,
    "addresses": {
      "work_address": "100 Industrial Way",
      "home_address": "742 Evergreen Terrace"
    }
  }
}

PATCH https://{tenantDomain}/api/v2/users/{id}

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.UpdateUserRequestContent{}
    client.Users.Update(
        context.TODO(),
        "id",
        request,
    )
}

200

{
  "app_metadata": {},
  "blocked": true,
  "created_at": "<string>",
  "email": "[e-mail]",
  "email_verified": false,
  "family_name": "<string>",
  "given_name": "<string>",
  "identities": [
    {
      "access_token": "<string>",
      "access_token_secret": "<string>",
      "connection": "<string>",
      "isSocial": true,
      "profileData": {
        "email": "<string>",
        "email_verified": true,
        "family_name": "<string>",
        "given_name": "<string>",
        "name": "<string>",
        "phone_number": "<string>",
        "phone_verified": true,
        "username": "johndoe"
      },
      "refresh_token": "<string>",
      "user_id": "<string>"
    }
  ],
  "last_ip": "<string>",
  "last_login": "<string>",
  "last_password_reset": "<string>",
  "logins_count": 123,
  "multifactor": [
    "<string>"
  ],
  "multifactor_last_modified": "<string>",
  "name": "<string>",
  "nickname": "<string>",
  "phone_number": "[phone]",
  "phone_verified": false,
  "picture": "<string>",
  "updated_at": "<string>",
  "user_id": "auth0|507f1f77bcf86cd799439020",
  "user_metadata": {},
  "username": "johndoe"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

En-têtes

auth0-custom-domain · string

Domaine personnalisé à utiliser pour cette requête

Required string length: 3 - 255

Paramètres de chemin

id · string · requis

ID de l’utilisateur à mettre à jour.

Corps

application/jsonapplication/x-www-form-urlencoded

app_metadata · object

Métadonnées utilisateur auxquelles cet utilisateur a accès en lecture seule.

blocked · boolean · défaut: false

Indique si cet utilisateur a été bloqué par un administrateur (true) ou non (false).

client_id · string · défaut: DaM8bokEXBWrTUFCiJjWn50jei6ardyX

ID client Auth0. Valide uniquement lors de la mise à jour de l'adresse de courriel.

Minimum string length: 1

connection · string · défaut: Initial-Connection

Nom de la connexion à cibler pour la mise à jour de cet utilisateur.

Minimum string length: 1

email · string<email> | null · défaut: [e-mail]

Adresse de courriel de cet utilisateur.

email_verified · boolean · défaut: false

Indique si cette adresse de courriel est vérifiée (true) ou non vérifiée (false). Si la valeur est false, l’utilisateur ne recevra pas de courriel de vérification, sauf si verify_email est défini à true.

family_name · string | null · défaut: Doe

Nom de famille de cet utilisateur.

Required string length: 1 - 150

given_name · string | null · défaut: John

Prénom de cet utilisateur.

Required string length: 1 - 150

name · string | null · défaut: John Doe

Nom de cet utilisateur.

Required string length: 1 - 300

nickname · string | null · défaut: Johnny

Surnom ou alias préféré de cet utilisateur.

Required string length: 1 - 300

password · string | null · défaut: secret

Nouveau mot de passe pour cet utilisateur. Valide uniquement pour les connexions de base de données.

Minimum string length: 1

phone_number · string | null · défaut: [phone]

Le numéro de téléphone de l'utilisateur (conforme à la recommandation E.164).

Pattern: ^\+[0-9]{1,15}$

phone_verified · boolean · défaut: false

Indique si ce numéro de téléphone a été vérifié (true) ou non (false).

picture · string<strict-uri> | null · défaut: https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png

URL de l'image, de la photo ou de l'avatar de cet utilisateur.

user_metadata · object

Métadonnées utilisateur auxquelles cet utilisateur a accès en lecture et en écriture.

username · string | null · défaut: johndoe

Nom d’utilisateur de l'utilisateur. Valide uniquement si la connexion exige un nom d’utilisateur.

Required string length: 1 - 128

verify_email · boolean · défaut: false

Indique si cet utilisateur recevra un courriel de vérification après sa création (true) ou ne recevra aucun courriel (false). Remplace le comportement du paramètre email_verified.

verify_phone_number · boolean · défaut: false

Indique si cet utilisateur recevra un message texte après avoir modifié son numéro de téléphone (true) ou ne recevra aucun message texte (false). Valide uniquement lors de la modification d'un numéro de téléphone pour les connexions SMS.

Réponse

200

application/json

Utilisateur mis à jour avec succès.

app_metadata · object

Métadonnées utilisateur auxquelles cet utilisateur a accès en lecture seule.

blocked · boolean

Indique si cet utilisateur a été bloqué par un administrateur (true) ou non (false).

created_at · string object

Date et heure de création de cet utilisateur (format ISO_8601).

email · string<email> · défaut: [e-mail]

Adresse de courriel de cet utilisateur.

email_verified · boolean · défaut: false

Indique si cette adresse de courriel est vérifiée (true) ou non vérifiée (false).

family_name · string

Nom de famille de cet utilisateur.

given_name · string

Prénom de cet utilisateur.

identities · object[]

Tableau d'objets d'identité utilisateur lorsque des comptes sont liés.

Show child attributes

last_ip · string

Dernière adresse IP à partir de laquelle cet utilisateur s'est connecté.

last_login · string object

Date et heure de création de cet utilisateur (format ISO_8601).

last_password_reset · string object

Date et heure de création de cet utilisateur (format ISO_8601).

logins_count · integer

Nombre total de connexions effectuées par cet utilisateur.

multifactor · string[]

Liste des fournisseurs d'authentification multifacteur auxquels cet utilisateur est inscrit.

multifactor_last_modified · string object

Date et heure de création de cet utilisateur (format ISO_8601).

name · string

Nom de cet utilisateur.

nickname · string

Surnom ou alias préféré de cet utilisateur.

phone_number · string · défaut: [phone]

Numéro de téléphone de cet utilisateur. Conforme à la recommandation E.164.

phone_verified · boolean · défaut: false

Indique si ce numéro de téléphone a été vérifié (true) ou non (false).

picture · string

URL de l'image, de la photo ou de l'avatar de cet utilisateur.

updated_at · string object

Date et heure de création de cet utilisateur (format ISO_8601).

user_id · string · défaut: auth0|507f1f77bcf86cd799439020

ID de l'utilisateur pouvant être utilisé lors d'interactions avec d'autres API.

user_metadata · object

Métadonnées utilisateur auxquelles cet utilisateur a accès en lecture et en écriture.

username · string · défaut: johndoe

Nom d’utilisateur de cet utilisateur.