Ein Verzeichnis abrufen

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

Gibt ein SCIM-Verzeichnis mit seiner offenen Massen-Deprovisionierungssperre zurück (null, wenn keine besteht). Eine Sperre wird geöffnet, wenn eine Synchronisation zu viele Benutzer auf einmal deprovisionieren würde; genehmigen oder ablehnen Sie sie mit den deprovision-holds-Endpunkten. Die Metadaten der Token listet GET /v1/directories/{directory_id}/tokens.

Anfrage

Feld Typ Pflicht Beschreibung
directory_id Pfad ja SCIM-Verzeichnis-ID (dir_…).

Es gibt keinen Request-Body.

Antwort

200 OK mit dem Verzeichnis und seinem ETag (der If-Match-Wert für 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
  }
}

Fehler

HTTP code Wann
404 not_found Das Verzeichnis existiert in dieser Umgebung nicht.
401 unauthenticated Die Anmeldeinformation fehlt, ist ungültig oder widerrufen.
403 insufficient_permissions Die Anmeldeinformation besitzt nicht die erforderliche Berechtigung.
429 rate_limited Das Ratenlimit wurde überschritten; wiederholen Sie die Anfrage nach der Zeit aus Retry-After.
503 service_unavailable Die Verzeichnissynchronisation ist vorübergehend nicht verfügbar oder in dieser Bereitstellung nicht konfiguriert; wiederholen Sie die Anfrage nach der Zeit aus Retry-After.

Beispiel

curl -i "https://api.eu.keenauth.com/v1/directories/dir_01j9xm2n4p6q8r0s2t4v6w8y0z" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"