API Import et Export Utilisateurs

L’API Import et Export te permet d’importer des utilisateurs en masse depuis des fichiers CSV ou JSON, et d’exporter les données utilisateurs pour la migration, la sauvegarde ou l’intégration avec des systèmes externes. Les deux opérations sont traitées de manière asynchrone via des jobs qui peuvent être surveillés jusqu’à leur complétion.

Tous les endpoints requièrent l’en-tête x-tenant et un token Bearer valide.

Importer des Utilisateurs

Charger un Fichier d’Importation

Corps de la requête (multipart/form-data)

Réponse de succès

{
  "ok": true,
  "data": {
    "id": "import_abc123",
    "status": "PENDING",
    "totalRows": 250,
    "processedRows": 0,
    "successCount": 0,
    "errorCount": 0,
    "errors": [],
    "createdAt": "2025-02-18T10:00:00Z"
  }
}

Lister les Jobs d’Importation

Paramètres de requête

Récupérer le Détail du Job

Réponse de succès

{
  "ok": true,
  "data": {
    "id": "import_abc123",
    "status": "PARTIAL",
    "totalRows": 250,
    "processedRows": 250,
    "successCount": 247,
    "errorCount": 3,
    "errors": [
      { "row": 14, "email": "bad-email", "error": "Invalid email format" },
      { "row": 87, "email": "[email protected]", "error": "Email already exists in this tenant" },
      { "row": 203, "email": "[email protected]", "error": "Role 'superadmin' does not exist" }
    ],
    "createdAt": "2025-02-18T10:00:00Z",
    "completedAt": "2025-02-18T10:02:15Z"
  }
}

Progression des États

Formats des Fichiers d’Importation

Format CSV

email,firstName,lastName,roles,password
[email protected],Jane,Doe,editor,SecurePass123!
[email protected],Bob,Smith,"editor,viewer",AnotherPass456!
[email protected],Alice,Johnson,,

• La première ligne doit être l’en-tête avec les noms de colonnes
• Plusieurs rôles doivent être entourés de guillemets : "editor,viewer"
• Un mot de passe vide génère un magic link ou force une réinitialisation au premier accès (approche recommandée)

Format JSON

[
  {
    "email": "[email protected]",
    "firstName": "Jane",
    "lastName": "Doe",
    "roles": ["editor"],
    "password": "SecurePass123!"
  },
  {
    "email": "[email protected]",
    "firstName": "Bob",
    "lastName": "Smith",
    "roles": ["editor", "viewer"]
  },
  {
    "email": "[email protected]"
  }
]

Référence des Champs

Erreurs par Ligne

Exporter des Utilisateurs

Démarrer l’Export

Corps de la requête

{
  "format": "csv"
}

Réponse de succès

{
  "ok": true,
  "data": {
    "id": "export_abc123",
    "status": "PENDING",
    "format": "csv",
    "expiresAt": "2025-02-19T10:00:00Z",
    "createdAt": "2025-02-18T10:00:00Z"
  }
}

Télécharger le Fichier d’Export

Réponse de succès

En-têtes de réponse :

Content-Type: text/csv
Content-Disposition: attachment; filename="users-export-2025-02-18.csv"

Le corps de la réponse est le contenu brut du fichier CSV ou JSON.

Codes d’erreur

Champs Exportés

Flux de Migration

Pour migrer des utilisateurs d’un tenant Auris vers un autre, suis ces étapes :

1. Exporter depuis le tenant source au format json
2. Télécharger le fichier d’export
3. Modifier optionnellement le fichier (ajuster les rôles, retirer certains utilisateurs)
4. Importer dans le tenant de destination
5. Surveiller le job d’importation jusqu’à l’état COMPLETED ou PARTIAL
6. Examiner les erreurs dans errors[] et les traiter manuellement si nécessaire
7. Notifier les utilisateurs de définir leur mot de passe via magic link ou réinitialisation

Corrélés

• Guide Import/Export Utilisateurs — Procédure pas à pas pour l’import et l’export
• Console Import/Export — Gère les imports et exports depuis la Console
• API Utilisateurs — Endpoints de gestion individuelle des utilisateurs
• API SCIM — Provisionnement automatisé des utilisateurs via SCIM 2.0