access

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

Remove a member and offboard them (docs/35

Alle access-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie members.remove beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Waar je organisatie-id komt te staan

Dit eindpunt gebruikt je organisatie-id rechtstreeks in de URL als orgId. Vervang dit in het pad; er is geen header of queryparameter die dit kan overnemen.

Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

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.

Parameters

NaamTypeVerplichtWat dit is
orgId (path)UuidJaOrganization ID (UUIDv7).
userId (path)UuidJaThe user to remove from the organization.

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 409 · 429