Organisationsrolle löschen

DELETE /fapi/v1/organizations/{org_id}/roles/{role_id} · wird vom Anmeldehost der Umgebung aufgerufen

Löscht eine Organisationsrolle, die keinem Mitglied zugewiesen ist. Rollen der Umgebung können hier nicht gelöscht werden. Erforderlich ist das Cookie __Host-idp_session des authentifizierten Benutzers; fehlt das Cookie, ist es abgelaufen oder widerrufen, antwortet der Endpunkt mit 401 unauthenticated. Eine First-Party-Anwendung auf einer anderen Origin kann stattdessen ihr Front-API-Zugriffstoken senden (Authorization: DPoP <token> mit einem DPoP-Proof; siehe Front-API-Zugriffstoken). Der Benutzer muss aktives Mitglied der Organisation sein und die Berechtigung idp_roles:manage besitzen. Ein Benutzer, der kein Mitglied ist, erhält 404 not_found, sodass die Existenz der Organisation nicht offengelegt wird; ein Mitglied ohne die Berechtigung erhält 403 insufficient_permissions. Organisationsrollen müssen für die Umgebung aktiviert und im Tarif enthalten sein.

Anfrage

Header:

Header Pflicht Beschreibung
Idp-Client ja SDK-Kennung.
Origin ja Muss genau https://<Anmeldehost> sein.
If-Match nein "<version>" der Rolle, wie zuletzt gelesen; hat sich die Rolle seitdem geändert, antwortet der Endpunkt mit 412 precondition_failed, und nichts wird geändert.

org_id: die Organisations-ID (org_…). role_id: die ID der Rolle (rol_…).

Kein Body.

Antwort

204 No Content.

Fehler

Status Code Wann
401 unauthenticated Kein gültiges Sitzungs-Cookie.
403 origin_not_allowed Origin fehlt oder ist falsch.
403 insufficient_permissions Dem Benutzer fehlt idp_roles:manage in der Organisation.
403 plan_feature_unavailable Der Tarif der Umgebung enthält keine Organisationsrollen (feature, required_plan).
403 org_custom_roles_disabled Organisationsrollen sind für die Umgebung deaktiviert.
403 role_not_assignable Die Rolle gewährt eine Berechtigung, die der Benutzer nicht besitzt, oder die eigene Mitgliedschaft des Benutzers enthält sie.
404 not_found Für diesen Benutzer existiert keine solche Organisation oder Organisationsrolle; eine Rolle der Umgebung sowie eine unbekannte, fehlerhafte oder fremde ID führen zur selben Antwort.
409 role_in_use Die Rolle ist noch zugewiesen.
409 organization_pending_deletion Die Organisation ist zur Löschung vorgesehen.
412 precondition_failed If-Match nennt nicht die aktuelle Version, oder die Rolle wurde während der Verarbeitung der Anfrage geändert.
503 service_unavailable Vorübergehend nicht verfügbar; wiederholen Sie die Anfrage nach Retry-After.

Beispiel

curl -X DELETE https://example.keenauth.app/fapi/v1/organizations/org_01jbz6x8kq3m2n4p5r6s7t8v9a/roles/rol_01jbz6x8kq3m2n4p5r6s7t8v9w \
  -H "Idp-Client: my-app/1.0.0 (node/22.0.0)" \
  -H "Origin: https://example.keenauth.app" \
  -b cookies.txt