Massen-Deprovisionierungssperren auflisten

GET /v1/directories/{directory_id}/deprovision-holds · Berechtigung directories:read

Listet die Massen-Deprovisionierungssperren des Verzeichnisses auf, offene und entschiedene, die neuesten zuerst: die Anzahl der zurückgehaltenen Deprovisionierungen, den Status und die Entscheidung; die zurückgehaltenen Benutzer werden nie zurückgegeben. Eine offene Sperre wird mit POST /v1/directories/{directory_id}/deprovision-holds/{hold_id}:approve oder :reject genehmigt bzw. abgelehnt; nach 72 Stunden wird sie durch Zeitablauf genehmigt. Es gibt nur Vorwärtspaginierung; der Cursor ist an das Verzeichnis gebunden.

Anfrage

Feld Typ Pflicht Beschreibung
directory_id Pfad ja SCIM-Verzeichnis-ID (dir_…).
limit Abfrage nein 1–100, Standard 20.
after Abfrage nein Der Cursor aus list_metadata.after.

Es gibt keinen Anfragetext.

Antwort

200 OK mit einer Seite von Sperren.

{
  "data": [
    {
      "id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
      "status": "approved",
      "opened_at": "2026-10-20T09:00:00Z",
      "pending_count": 42,
      "decided_by": "api_key:key_01j9xr6s8t0v2w4x6y8z0a2b4d",
      "decided_at": "2026-10-20T10:00:00Z"
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

status ist open, approved oder rejected. decided_by ist api_key:<key ID>, admin_portal_link:apl_… oder timeout; es und decided_at sind null, solange die Sperre offen ist.

Fehler

HTTP Code Wann
400 invalid_cursor Der Cursor ist ungültig oder gehört zu einem anderen Verzeichnis.
404 not_found Das Verzeichnis existiert in dieser Umgebung nicht.
422 validation_failed limit liegt außerhalb des gültigen Bereichs, oder before bzw. order wurde angegeben (unsupported).
401 unauthenticated Die Anmeldedaten fehlen, sind ungültig oder wurden widerrufen.
403 insufficient_permissions Den Anmeldedaten fehlt die erforderliche Berechtigung.
429 rate_limited Das Ratenlimit wurde überschritten; wiederholen Sie die Anfrage nach der Zeit aus Retry-After.
503 service_unavailable Die Verzeichnissynchronisierung 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/deprovision-holds?limit=20" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

Personenbezogene Daten

Dieser Endpunkt enthält personenbezogene Daten: Verzeichnis-(SCIM-)Benutzer. Personenbezogene Daten in den KeenAuth-APIs beschreibt, was gespeichert wird, wie lange es aufbewahrt wird und wie es gelöscht wird. Senden Sie in keinem Feld besondere Kategorien personenbezogener Daten (Gesundheit, biometrische Daten, Religion, politische Meinungen, sexuelle Orientierung).