Créer un annuaire

POST /v1/directories · autorisation directories:write

Crée un annuaire SCIM inactif pour une organisation, ainsi que son premier jeton SCIM. Donnez au fournisseur d'identité (Okta, Entra ID, Google Workspace…) le base_url et le token. token n'est renvoyé que dans cette réponse, une seule fois ; aucun point de terminaison ne le renvoie plus tard. La réponse porte Cache-Control: no-store, et une réponse rejouée pour la même Idempotency-Key omet token et porte secret_redacted: true ; créez un nouveau jeton avec POST /v1/directories/{directory_id}/tokens si vous l'avez perdu. La création est auditée sous directory.created et directory.token_created (le jeton n'entre jamais dans le journal d'audit).

scim_host doit être l'hôte principal de l'environnement : son domaine personnalisé actif, sinon <slug>.<region>.keenauth.app. L'URL de base SCIM de l'annuaire est https://<scim_host>/scim/v2/<directory>.

Requête

Champ Type Obligatoire Description
organization_id chaîne oui ID de l'organisation (org_…) ; elle doit exister dans cet environnement et être active.
name chaîne oui 1 à 64 caractères, sans caractères de contrôle, sans espace en début ou en fin.
scim_host chaîne oui L'hôte principal de l'environnement (nom DNS en minuscules) ; il doit router vers cet environnement.
type chaîne non scim (par défaut ; le seul type de cette version).
token_label chaîne non Libellé du premier jeton, 1 à 100 caractères ; par défaut Initial token.

Réponse

201 Created avec l'annuaire, token_id et le token à usage unique.

{
  "id": "dir_01j9xm2n4p6q8r0s2t4v6w8y0z",
  "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "type": "scim",
  "name": "Okta",
  "state": "inactive",
  "base_url": "https://acme.eu.keenauth.app/scim/v2/dir_01j9xm2n4p6q8r0s2t4v6w8y0z",
  "created_at": "2026-10-19T09:31:00.123456Z",
  "last_request_at": null,
  "provisioning_mode": "user_store",
  "attribute_allowlist": [],
  "unverified_domain_action": "invite",
  "delete_action": "remove_membership",
  "on_delete_memberships": "keep",
  "mass_deprovision_guard": {"enabled": true, "percent": 10, "absolute_min": 25},
  "send_welcome_email": false,
  "token_id": "0192a3b4-c5d6-7e8f-9a0b-1c2d3e4f5a6b",
  "token": "idp_scim_<token>"
}

Erreurs

HTTP code Quand
404 not_found L'organisation n'existe pas dans cet environnement.
409 organization_disabled L'organisation n'est pas active ; aucun annuaire n'est créé.
409 organization_pending_deletion L'organisation est programmée pour suppression ; aucun annuaire n'est créé.
422 idempotency_key_reuse Idempotency-Key a été utilisé pour une autre requête.
422 validation_failed Un champ est absent ou invalide ; /scim_host invalid lorsque l'hôte est mal formé ou ne route pas vers cet environnement.
401 unauthenticated L'identifiant est absent, invalide ou révoqué.
403 insufficient_permissions L'identifiant n'a pas l'autorisation requise.
429 rate_limited La limite de débit a été dépassée ; réessayez après la durée indiquée par Retry-After.
503 service_unavailable La synchronisation des annuaires est temporairement indisponible ou non configurée dans ce déploiement ; réessayez après la durée indiquée par Retry-After.

Exemple

curl -i -X POST "https://api.eu.keenauth.com/v1/directories" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"organization_id":"org_01j9xk3m7q8r2s4t6v8w0y2z4a","name":"Okta","scim_host":"acme.eu.keenauth.app"}'