access

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

Remove a member and offboard them (docs/35

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה members.remove; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

המקום שבו מזהה הארגון שלך נכנס

נקודת קצה זו מקבלת את מזהה הארגון שלך בכתובת ה-URL עצמה, בתור orgId. השתמש בו בנתיב — אין כותרת או פרמטר שאילתת חיפוש שיעשו זאת במקומו.

מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

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.

פרמטרים

שם	סוג	נדרש	מה זה
`orgId (path)`	`Uuid`	כן	Organization ID (UUIDv7).
`userId (path)`	`Uuid`	כן	The user to remove from the organization.

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 409 · 429