Exportation en bloc des données utilisateur

Exportez les données de profil utilisateur prises en charge d’Auth0 dans un fichier au format compatible avec JSON ou CSV.

Vous pouvez exporter en bloc des données utilisateur depuis Auth0. Pour obtenir la liste des champs de profil utilisateur qui peuvent être exportés, consultez Structure du profil utilisateur.

​

Formats de fichiers pris en charge

Nous prenons en charge les exportations de données utilisateur aux formats compatibles avec JSON et CSV.

• Nos fichiers d’exportation compatibles avec JSON sont au format NDJSON en raison de la grande taille des fichiers d’exportation.

• Dans les fichiers d’exportation CSV, nous échappons les données de type String conformément aux normes de l’OWASP pour atténuer les risques d’injection CSV.

  • Les guillemets doubles sont précédés d’un guillemet double.
  • Chaque String est précédée d’une apostrophe.
  • Chaque String est entourée de guillemets doubles.

  Cela ne s’applique pas aux dates générées par Auth0 au format ISO 8601.

​

Prérequis

Auth0 Dashboard

• Vous devez avoir l’un des rôles de membre du tenant suivants :
  • Admin
  • Editor - Users
  • Dashboard Viewer - Users

Management API

• Vous devez disposer d’un jeton de la Management API ou en créer un pour effectuer des requêtes au endpoint des jobs, avec les scopes nécessaires pour le endpoint de création d’un job d’exportation d’utilisateurs.

​

1. Soumettre un job d’exportation d’utilisateurs

Auth0 Dashboard

Pour exporter des données utilisateur à l’aide du Auth0 Dashboard :

1. Accédez à Dashboard > Gestion des utilisateurs > Utilisateurs.

2. Dans le coin supérieur droit de la page, sélectionnez Importer/exporter des utilisateurs pour accéder à la page Importer/exporter des utilisateurs.

3. Sélectionnez Exporter les utilisateurs pour accéder à la page Exporter les utilisateurs.

   

4. Dans la section Paramètres d’exportation :

   • Sous Connexion, ouvrez le menu déroulant et sélectionnez la connexion à la base de données à partir de laquelle vous souhaitez exporter les données utilisateur.

   • Sous Format d’exportation, ouvrez le menu déroulant et sélectionnez le format souhaité pour les données (JSON ou CSV).

5. Dans la section Champs d’exportation, choisissez les champs à inclure dans l’exportation :

   • Utilisez la bascule Inclure les champs par défaut pour ajouter les champs du schéma de profil utilisateur normalisé Auth0.

   • Sélectionnez Ajouter des champs et entrez un attribut utilisateur et un nom de champ pour ajouter des champs précis.

6. Facultativement, dans la section Champs d’exportation, cochez Exporter comme échantillon pour limiter l’exportation à 10 utilisateurs. Cela peut être utile pour valider la structure du fichier d’exportation.

7. Pour soumettre le job, sélectionnez Exporter les utilisateurs.

Management API

Pour exporter les données d’utilisateur à l’aide de l’API Management, appelez le point de terminaison Create export users job (POST /jobs/users-exports). Consultez la documentation du point de terminaison pour connaître les paramètres du corps de la requête et les schémas de réponse.

Si vous omettez le connection_id, l’endpoint exporte les données des utilisateurs de toutes les connections du tenant.

Vous pouvez consulter l’ID de la connexion à la base de données dans le Dashboard ou l’obtenir à l’aide de l’endpoint Obtenir toutes les connexions de la Management API.

Pour utiliser les exemples ci-dessous, remplacez les variables fictives par vos propres valeurs.

Lorsque vous créez un job avec succès, la valeur de retour comprend des renseignements sur le job, y compris son ID.

​

2. Vérifier le statut d’un job et télécharger l’exportation

Auth0 Dashboard

Pour vérifier le statut d’un job :

1. Accédez à Dashboard > User Management > Users.

2. Dans le coin supérieur droit de la page, sélectionnez Import/Export Users pour accéder à la page Import/Export Users. Une fois que vous avez lancé au moins un job, cette page répertorie les jobs que vous avez soumis.

3. Pour chaque job, vous pouvez sélectionner :

   • Check Status pour suivre la progression du job.

   • Download export pour télécharger le résultat.

   • More info pour consulter les erreurs ou les métadonnées du job.

Management API

Pour vérifier le statut d’un job, appelez le endpoint Get a job (GET /jobs) avec l’ID du job. Consultez la documentation de l’endpoint pour en savoir plus sur ses paramètres et les schémas de réponse.

Le nom de votre tenant correspond également au nom de votre fichier. Par exemple, si votre tenant s’appelle auth0docs, votre fichier sera auth0docs.csv ou auth0docs.json.

Vous pouvez accéder à vos fichiers d’exportation à l’aide de l’URL fournie comme valeur du paramètre location. Lorsque vous accédez à cette URL, le téléchargement du fichier commence automatiquement.

Le lien de téléchargement est valide pendant 60 secondes. Une fois ce délai écoulé, vous disposez de 24 heures pour appeler de nouveau l’endpoint avant l’expiration du job.

​

Limites

• Toutes les données associées aux jobs sont automatiquement supprimées après 24 heures.

• Les exportations de données au format CSV sont limitées à 30 champs.

• Les exportations de données au format CSV ne peuvent pas inclure app_metadata ou user_metadata sous forme d’objets uniques. Indiquez plutôt explicitement les champs des objets de métadonnées ou exportez les données dans un format compatible avec JSON (qui permet d’exporter les métadonnées sous forme d’objets uniques) :

  Corps de la requête au format compatible avec JSON

  {
    "format": "json",
    "fields": [
      { "name": "user_metadata.example" }
    ]
  }
  

  Corps de la requête au format CSV

  {
    "format": "csv",
    "fields": [
      { "name": "user_metadata.example.field_one" },
      { "name": "user_metadata.example.field_two" },
      { "name": "user_metadata.example.field_three" }
    ]
  }