access

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

Remove a member and offboard them (docs/35

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Кілтте members.remove рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.

Ұйымыңыздың идентификаторы орналасатын жер

Бұл соңғы нүкте 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.

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`orgId (path)`	`Uuid`	Иә	Organization ID (UUIDv7).
`userId (path)`	`Uuid`	Иә	The user to remove from the organization.

Бұл соңғы нүкте қайтара алатын қателер

401 · 403 · 404 · 409 · 429