Verzeichnis löschen
DELETE /v1/directories/{directory_id} · Berechtigung directories:write
Löscht das Verzeichnis sofort und endgültig: Seine Token (SCIM-Anfragen des Identitätsanbieters erhalten danach 401), Deprovisionierungssperren, Gruppen, Gruppenmitgliedschaften und Benutzerdatensätze des Verzeichnisses werden in derselben Transaktion gelöscht. Die Löschung wird als directory.deleted protokolliert. Das Löschen eines bereits gelöschten Verzeichnisses liefert 404.
Anfrage
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
directory_id |
path | ja | SCIM-Verzeichnis-ID (dir_…). |
Es gibt keinen Anfrage-Body.
Antwort
204 No Content.
Fehler
| HTTP | code | Wann |
|---|---|---|
| 404 | not_found |
Das Verzeichnis existiert nicht in dieser Umgebung. |
| 401 | unauthenticated |
Die Anmeldeinformation fehlt, ist ungültig oder widerrufen. |
| 403 | insufficient_permissions |
Der Anmeldeinformation fehlt die erforderliche Berechtigung. |
| 429 | rate_limited |
Das Ratenlimit wurde überschritten; nach Ablauf des Retry-After-Zeitraums erneut versuchen. |
| 503 | service_unavailable |
Die Verzeichnissynchronisation ist vorübergehend nicht verfügbar oder in diesem Deployment nicht konfiguriert; nach Ablauf des Retry-After-Zeitraums erneut versuchen. |
Beispiel
curl -i -X DELETE "https://api.eu.keenauth.com/v1/directories/dir_01j9xm2n4p6q8r0s2t4v6w8y0z" \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"