access

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

Remove a member and offboard them (docs/35

همه نقاط پایانی access

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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