Ein Verzeichnis aktivieren

POST /v1/directories/{directory_id}:activate · Berechtigung directories:write

Aktiviert das Verzeichnis (state wird active); ein deaktiviertes Verzeichnis nimmt SCIM-Anfragen wieder an. Der Vorgang ist idempotent: Ist das Verzeichnis bereits aktiv, wird nichts geschrieben, die Version bleibt gleich und das Verzeichnis wird mit 200 zurückgegeben. Eine Organisation kann höchstens 3 aktive Verzeichnisse haben. Der Schreibvorgang wird als directory.activated protokolliert.

Anfrage

Feld Typ Pflicht Beschreibung
directory_id Pfad ja SCIM-Verzeichnis-ID (dir_…).
Idempotency-Key Header nein Gibt die erste Antwort für eine wiederholte Anfrage erneut zurück.

Der Body ist optional und hat keine Felder ({}). If-Match wird nicht verwendet.

Antwort

200 OK mit dem Verzeichnis und seinem ETag.

{
  "id": "dir_01j9xm2n4p6q8r0s2t4v6w8y0z",
  "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "type": "scim",
  "name": "Okta",
  "state": "active",
  "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": ["title", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:user:department"],
  "unverified_domain_action": "invite",
  "delete_action": "remove_membership",
  "on_delete_memberships": "keep",
  "mass_deprovision_guard": {"enabled": true, "percent": 20, "absolute_min": 25},
  "send_welcome_email": false
}

Fehler

HTTP code Wann
400 unknown_field Der Body enthält ein Feld.
404 not_found Das Verzeichnis existiert in dieser Umgebung nicht.
409 conflict Die Organisation hat bereits 3 aktive Verzeichnisse, oder das Verzeichnis wird gerade gelöscht.
422 idempotency_key_reuse Der Idempotency-Key wurde für eine andere Anfrage verwendet.
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 -X POST "https://api.eu.keenauth.com/v1/directories/dir_01j9xm2n4p6q8r0s2t4v6w8y0z:activate" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"