access

DELETE /v1/orgs/{orgId}/members/{userId}

Remove a member and offboard them (docs/35

Alle access Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung members.remove verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Hier kommt Ihre Organisations-ID hin

Dieser Endpunkt erwartet Ihre Organisations-ID direkt in der URL als orgId. Setzen Sie diese in den Pfad ein – es gibt keinen Header oder Abfrageparameter, der stattdessen verwendet werden kann.

Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

curl -X DELETE https://api.zinndigital.com/v1/orgs/{orgId}/members/{userId} \
  -H "Authorization: Bearer zdk_live_…"

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

Removes the user from the org and runs the offboarding cascade: revokes their org access (immediate — a principal is resolved fresh per request), their Keycloak sessions (best-effort), and their own API keys, and emits `member.removed` so the hosting side rotates their per-site credentials. Audit-logged with the remover. Requires `members.remove`. Refuses (403) to remove a member more privileged than the caller, and (409) to remove the org's last owner.

Parameter

NameTypErforderlichWas es ist
orgId (path)UuidJaOrganization ID (UUIDv7).
userId (path)UuidJaThe user to remove from the organization.

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 409 · 429