Obtenir un annuaire

GET /v1/directories/{directory_id} · autorisation directories:read

Renvoie un annuaire SCIM avec sa suspension de désactivation en masse ouverte (null s'il n'y en a pas). Une suspension s'ouvre lorsqu'une synchronisation désactiverait trop d'utilisateurs à la fois ; approuvez-la ou rejetez-la avec les points de terminaison deprovision-holds. Les métadonnées des jetons sont listées par GET /v1/directories/{directory_id}/tokens.

Requête

Champ Type Obligatoire Description
directory_id chemin oui ID de l'annuaire SCIM (dir_…).

Il n'y a pas de corps de requête.

Réponse

200 OK avec l'annuaire et son ETag (la valeur If-Match pour PATCH /v1/directories/{directory_id}).

{
  "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,
  "open_deprovision_hold": {
    "id": "0192a3c0-1d2e-7f3a-8b4c-5d6e7f8a9b0c",
    "opened_at": "2026-10-19T10:02:00Z",
    "pending_count": 42
  }
}

Erreurs

HTTP code Quand
404 not_found L'annuaire n'existe pas dans 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 "https://api.eu.keenauth.com/v1/directories/dir_01j9xm2n4p6q8r0s2t4v6w8y0z" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"