La spec OpenAPI
Home
Tree BG 1
Tree
Tree
TreeLeaves
TreeLeaves
Cat IdleGrassGrassRockRock

Admin SCIM (bêta)

(beta) Admin - API Scim.

Déclencher une synchronisation SCIM

POST /v1/admin/scim/sync#

Déclencher une synchronisation SCIM à la demande pour l'Organization.

Nécessite que l'authentification SAML soit activée et que l'Organization soit en mode approvisionnement d'utilisateurs SCIM. Un essai à blanc prévisualise chaque modification sans l'appliquer; une exécution réelle applique les catégories sélectionnées dans sync_config. Une seule exécution peut être active à la fois — une demande conflictuelle retourne l'exécution déjà active.

202

Accepté

run_id#
*string

Identifiant unique de l'exécution de synchronisation SCIM créée.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/scim/sync \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{}'

202

{
  "run_id": "6f9619ff-8b86-d011-b42d-00cf4fc964ff"
}

Obtenir une exécution de synchronisation SCIM

GET /v1/admin/scim/sync/{run_id}#

Récupérer une exécution de synchronisation SCIM à la demande pour l'Organization.

Retourne le statut du cycle de vie de l'exécution ainsi que le résumé de la prévisualisation ou du résultat une fois le plan de synchronisation établi.

200

OK

created_at#
*date-time

Heure à laquelle l'exécution de synchronisation a été créée.

dry_run#
*boolean

Indique si l'exécution n'a fait que prévisualiser les changements.

error_message#
*string|null

Détail de l'échec lorsque l'exécution de synchronisation n'a pas pu se terminer.

finished_at#
*date-time|null

Heure à laquelle le traitement s'est terminé, s'il est terminé.

run_id#
*string

Identifiant unique de l'exécution de synchronisation SCIM.

started_at#
*date-time|null

Heure à laquelle le traitement a commencé, s'il a commencé.

status#
*"PENDING"|"RUNNING"|"SUCCESS"|"SKIPPED"|"FAILED"
summary#
*ScimSyncSummaryOut|null

Résumé de la prévisualisation ou du résultat, disponible après la création du plan de synchronisation.

sync_config#
*AdminScimSyncConfig|null

Catégories à synchroniser. Requis lorsque dry_run est false ; ignoré pour les exécutions en mode prévisualisation.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/scim/sync/{run_id} \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "created_at": "2026-07-28T10:00:00Z",
  "dry_run": "true",
  "error_message": null,
  "finished_at": null,
  "run_id": "6f9619ff-8b86-d011-b42d-00cf4fc964ff",
  "started_at": null,
  "status": "PENDING",
  "summary": null,
  "sync_config": null
}