Comprendre le fonctionnement des métadonnées dans les profils utilisateur

Décrit les métadonnées des utilisateurs, des applications et des clients Auth0. Découvrez comment utiliser les métadonnées pour stocker des informations qui ne proviennent pas d’un fournisseur d’identité.

Auth0 offre un système complet pour stocker des métadonnées dans le profil utilisateur Auth0. Vous pouvez utiliser les métadonnées pour :

• Stocker des données propres à l’application dans le profil utilisateur.
• Indiquer si des opérations précises ont été effectuées ou non pour un utilisateur.
• Mettre en cache les résultats d’opérations coûteuses dans le profil utilisateur afin de pouvoir les réutiliser lors de connexions futures.
• Stocker des informations qui ne proviennent pas d’un fournisseur d’identité ou qui remplacent ce qu’il fournit.

Les métadonnées peuvent être modifiées dans le cadre du flux de connexion d’un utilisateur.

Vous pouvez configurer la synchronisation de la connexion afin que les attributs racine de l’utilisateur soient mis à jour par le fournisseur d’identité uniquement lors de la création du profil utilisateur. Vous pouvez ensuite modifier les attributs racine individuellement ou au moyen d’une importation en bloc. Pour en savoir plus, consultez Configurer la connexion du fournisseur d’identité pour les mises à jour des profils utilisateur.

​

Types de métadonnées

Auth0 utilise trois types de métadonnées pour stocker des catégories précises d’information.

Type de métadonnées	Nom du champ	Description
Informations utilisateur	user_metadata	Stocke des attributs utilisateur, comme les préférences, qui n’ont pas d’incidence sur le fonctionnement de base d’un utilisateur. Ces données peuvent être modifiées par les utilisateurs connectés si vous créez un formulaire à l’aide de la Management API et ne doivent pas être utilisées comme stockage de données sécurisé.
Informations d’accès	app_metadata	Stocke des informations comme les permissions, le forfait Auth0 et des ID externes qui peuvent avoir une incidence sur l’accès de l’utilisateur aux fonctionnalités. Ces données ne peuvent pas être modifiées par les utilisateurs, et il existe des restrictions quant à ce qui peut être stocké dans ce champ.
Informations sur l’application	client_metadata dans l’objet Client, context.clientMetadata dans Rules et event.client.metadata dans les Actions post-login.	Stocke des informations sur une application (ou un client dans la terminologie OIDC OAuth2). Par exemple, l’URL de la page d’accueil de l’application (toute valeur qu’Auth0 ne définit pas dans les paramètres de l’application).

​

Gérer les métadonnées

Vous pouvez créer et mettre à jour les métadonnées à l’aide de Rules, de l’Authentication API, de la Management API, de l’Auth0 Dashboard et de la bibliothèque Lock.

Pour les scripts de base de données personnalisés et le script fetchUserProfile des connexions sociales personnalisées, vous pouvez créer et mettre à jour les métadonnées à l’aide de l’objet metadata.

​

Utiliser les Actions

Les Actions sont des fonctions sécurisées, propres au tenant et versionnées, écrites en Node.js, qui s’exécutent à certains points dans la plateforme Auth0. Les Actions servent à personnaliser et à étendre les capacités d’Auth0 à l’aide d’une logique personnalisée. Elles peuvent aussi servir à enrichir le profil utilisateur.

Par exemple, vous pouvez créer une Action post-login qui utilise des claims personnalisées pour copier les propriétés user_metadata dans les jetons ID. Vous pouvez ensuite récupérer le user_metadata des utilisateurs au moyen du point de terminaison Get User Info de l’Authentication API.

Pour en savoir plus, consultez Gérer les métadonnées utilisateur à l’aide du déclencheur d’action post-login.

​

Utiliser l’Management API

Un utilisateur peut demander un jeton d’accès avec les scopes appropriés et utiliser les points de terminaison de l’Management API suivants pour consulter, créer ou mettre à jour user_metadata, ou supprimer une configuration MFA.

Tâche	Point de terminaison	Scope
Consulter	GET /api/v2/users/{id}	read:current_user
Créer	PATCH /api/v2/users/{id}	create:current_user_metadata
Mettre à jour	PATCH /api/v2/users/{id}	update:current_user_metadata
Supprimer	DELETE /api/v2/users/{id}/multifactor/{provider}	update:users

Un jeton d’accès est requis pour appeler l’Management API Auth0. Pour en savoir plus, consultez Access Tokens for the Management API et Get Management API Tokens for SPAs.

​

Utiliser le Dashboard

Utilisez l’Auth0 Dashboard pour configurer les métadonnées de l’application, qui comprennent des paires clé/valeur. Pour en savoir plus, consultez Configurer les métadonnées de l’application.

​

Utiliser la bibliothèque Lock

Utilisez la bibliothèque Lock pour définir, ajouter, lire et mettre à jour user_metadata. Lisez les propriétés de user_metadata de la même manière que vous liriez n’importe quelle autre propriété du profil utilisateur. Par exemple, l’extrait de code suivant récupère la valeur associée à user_metadata.hobby et l’attribue à un élément de la page :

// Utiliser l'accessToken obtenu lors de l'authentification pour appeler getUserInfo
lock.getUserInfo(accessToken, function(error, profile) {
  if (!error) {
    document.getElementById('hobby').textContent = profile.user_metadata.hobby;
  }
});

Vous pouvez utiliser additionalSignUpFields pour ajouter des champs personnalisés aux formulaires d’inscription. Lorsqu’un utilisateur saisit des données dans un champ personnalisé, Auth0 stocke les valeurs entrées dans le user_metadata de cet utilisateur. Pour en savoir plus sur l’ajout de user_metadata lors de l’inscription, consultez Champs d’inscription supplémentaires.

​

Connexions de base de données personnalisées et métadonnées

Si vous avez une connexion de base de données personnalisée, vous pouvez utiliser le point de terminaison /dbconnections/signup de l’Authentication API pour définir le user_metadata d’un utilisateur. Pour en savoir plus sur l’utilisation des métadonnées dans le cadre d’un processus d’inscription personnalisé, consultez Inscription personnalisée.

Lorsque vous définissez le champ user_metadata à l’aide du point de terminaison /dbconnections/signup de l’Authentication API, vous ne pouvez utiliser qu’un maximum de 10 champs de type chaîne et de 500 caractères.

​

Courriels personnalisés et métadonnées

Utilisez les métadonnées pour stocker l’information que vous souhaitez utiliser pour personnaliser les courriels Auth0. Par exemple, utilisez user_metadata.lang si vous voulez permettre à l’utilisateur de modifier la valeur du champ, puis servez-vous de cette information pour personnaliser la langue d’un courriel. Pour en savoir plus, consultez Personnaliser les modèles de courriel.

​

En savoir plus

• Noms de champs et types de données des métadonnées
• Gérer les métadonnées avec Rules
• Gérer les métadonnées à l’aide de la Management API
• Gérer les métadonnées avec Lock
• Configurer les métadonnées de l’application
• Gérer les métadonnées utilisateur à l’aide du déclencheur d’action post-login