Eine Umgebungsrolle löschen

DELETE /v1/roles/{role_id} · Berechtigung roles:write

Löscht die Rolle. Mit force=true wird eine zugewiesene Rolle ebenfalls gelöscht, und ihre Mitgliedszuweisungen werden im selben Vorgang entfernt; andernfalls gibt eine zugewiesene Rolle 409 role_in_use zurück. Eine Rolle, die als Admin-Rolle oder als Standard-Mitgliedsrolle einer Organisation verwendet wird, wird niemals gelöscht. If-Match ist optional. Die Löschung wird als role.deleted protokolliert.

Anfrage

Feld Typ Pflicht Beschreibung
role_id Pfad ja Rollen-ID (rol_…).
force Query nein true entfernt außerdem die Zuweisungen der Rolle; false (Standard) lehnt eine zugewiesene Rolle ab.
If-Match Header nein Aktuelles ETag; bei Abweichung 412.

Kein Anfragekörper.

Antwort

204 No Content.

Fehler

HTTP Code Wann
404 not_found Die Rolle existiert in diesem Geltungsbereich nicht.
409 role_in_use Die Rolle ist zugewiesen und force ist nicht true, oder sie ist die Admin- oder Standard-Mitgliedsrolle einer Organisation.
412 precondition_failed If-Match stimmt nicht mit der aktuellen Version überein.
422 validation_failed force ist weder true noch false oder wurde mehrfach angegeben.
401 unauthenticated Die Anmeldedaten fehlen, sind ungültig oder widerrufen.
403 insufficient_permissions Den Anmeldedaten fehlt die erforderliche Berechtigung.
429 rate_limited Das Ratenlimit wurde überschritten; wiederholen Sie die Anfrage nach dem Zeitraum aus Retry-After.
503 service_unavailable Eine Abhängigkeit ist vorübergehend nicht verfügbar; wiederholen Sie die Anfrage nach dem Zeitraum aus Retry-After.

Beispiel

curl -i -X DELETE "https://api.eu.keenauth.com/v1/roles/rol_01j9xr7s1t2w6x8y0z2a4b6c8e?force=true" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"