Gérer les métadonnées à l’aide de la Management API

Découvrez comment créer, mettre à jour, fusionner et supprimer des métadonnées à l’aide de la Management API.

​

Métadonnées de l’utilisateur

​

Créer des métadonnées utilisateur

Pour créer un utilisateur avec les détails du profil suivants :

{
    "email": "[e-mail]",
    "user_metadata": {
        "hobby": "surfing"
    },
    "app_metadata": {
        "plan": "full"
    }
}

Effectuez la requête POST suivante vers le Management API /post_users point de terminaison pour créer l’utilisateur et définir les valeurs des propriétés :

​

Mettre à jour les métadonnées utilisateur

Vous pouvez mettre à jour les métadonnées d’un utilisateur en envoyant une requête PATCH au point de terminaison /patch_users_by_id de la Management API.

Supposons que vous avez créé un utilisateur avec les valeurs de métadonnées suivantes :

{
    "email": "[e-mail]",
    "user_metadata": {
        "hobby": "surfing"
    },
    "app_metadata": {
        "plan": "full"
    }
}

Pour mettre à jour user_metadata et ajouter l’adresse résidentielle de l’utilisateur comme propriété de second niveau :

{
    "addresses": {
        "home": "123 Main Street, Anytown, ST 12345"
    }
}

Vous enverriez la requête PATCH suivante :

Le profil de l’utilisateur apparaîtra désormais comme suit :

{
    "email": "[e-mail]",
    "user_metadata": {
        "hobby": "surfing",
        "addresses": {
            "home": "123 Main Street, Anytown, ST 12345"
        }
    },
    "app_metadata": {
        "plan": "full"
    }
}

Lorsque vous envoyez une requête PATCH dans laquelle vous avez défini la valeur d’une propriété sur null (par exemple, {user_metadata: {color: null}}), Auth0 supprime cette paire propriété-valeur de la base de données. De plus, si vous appliquez un PATCH aux métadonnées elles-mêmes avec un objet vide, les métadonnées sont entièrement supprimées.

​

Fusionner les métadonnées utilisateur

Seules les propriétés au niveau racine sont fusionnées dans l’objet. Toutes les propriétés de niveaux inférieurs seront remplacées.

Par exemple, pour ajouter l’adresse professionnelle d’un utilisateur comme sous-propriété supplémentaire, vous devez inclure l’intégralité du contenu de la propriété addresses. Comme l’objet addresses est une propriété de niveau racine, il sera fusionné dans l’objet JSON final représentant l’utilisateur, mais pas ses sous-propriétés.

{
  "user_metadata": {
    "addresses": {
      "home": "123 Main Street, Anytown, ST 12345",
      "work": "100 Industrial Way, Anytown, ST 12345"
    }
  }
}

Par conséquent, la requête PATCH correspondante envoyée à l’API serait :

​

Supprimer les métadonnées utilisateur

Vous pouvez supprimer user_metadata :

{
  "user_metadata": {}
}

​

Métadonnées d’application

Mettre à jour les métadonnées avec un objet vide les supprime complètement. Par exemple, l’envoi du corps de requête suivant supprime entièrement app_metadata :

{
  "app_metadata": {}
}

​

Métadonnées du client

​

Créer des applications avec les métadonnées du client

Un objet clientMetadata peut être inclus lors de la création d’une nouvelle application au moyen du point de terminaison d’applications POST /api/v2/.

​

Consulter les métadonnées du client

Les métadonnées du client sont incluses dans la réponse renvoyée par les points de terminaison GET /api/v2/clients et GET /api/v2/client/{id}.

​

Mettre à jour les métadonnées du client

Les métadonnées du client peuvent être mises à jour à l’aide du point de terminaison PATCH /api/v2/clients/{id}, en fournissant un objet d’application avec la propriété clientMetadata, dont la valeur est un objet contenant les métadonnées que vous souhaitez modifier.

Application avant :

{
  ...
  "name": "myclient",
  "client_metadata": {
    "mycolor": "red",
    "myflavor": "grape"
  }
  ...
}

Requête : PATCH /api/v2/client/myclientid123 avec le corps de la requête :

{ "client_metadata": { "mycolor": "blue" } }

Application après :

{
  "name": "myclient",
  "client_metadata": {
    "mycolor": "blue",
    "myflavor": "grape"
  }
  ...
}

​

Supprimer des propriétés et des valeurs des métadonnées du client

Les clés des métadonnées du client peuvent être supprimées au moyen d’une requête PATCH, comme décrit dans « Update app_metadata » ci-dessus, en fournissant null comme valeur de la clé. Ce comportement correspond à celui des propriétés user_metadata et app_metadata dans le point de terminaison PATCH /api/v2/users/.

​

En savoir plus

• Jetons d’accès de la Management API
• Configurer les métadonnées de l’application