access

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

Change a member's role.

Баталгаажуулалт

API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Түлхүүр нь members.role.assign эрхтэй байх ёстой бөгөөд үүнгүйгээр 404 биш, харин 403 алдаа буцааж татгалзах болно.

Таны байгууллагын дугаар орох газар

Энэ төгсгөл цэг нь таны байгууллагын ID-г URL дотроо orgId хэлбэрээр авдаг. Үүнийг зам дотор орлуулан бичнэ үү — оронд нь ажиллах толгой эсвэл хүсэлтийн параметр байхгүй.

Танай байгууллагын ID нь таны хяналтын самбар дээрх API түлхүүрийн дэлгэцэнд, түлхүүр өөрөө хажууд байрладаг. Энэ нь таны хийх дуудлага бүрт ижил ID байна.

Туршиж үзэх

Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.

curl -X PATCH https://api.zinndigital.com/v1/orgs/{orgId}/members/{userId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "role": <string> }'

Та нэвтэрсэн байна уу? Таны хяналтын самбар дахь API консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй API рүү хүсэлт илгээх тул та бодит хариуг харах боломжтой болно. Энэ төгсгөлийн цэгийг API консол дээр нээх

Дэлгэрэнгүй

Sets this member's role in the organization. Requires `members.role.assign` **on that org**. ⛔ **Replaces** the member's roles with the one given rather than adding to them — a person may hold several `Membership` rows, and collapsing them can only ever reduce what they hold, so no path through this endpoint escalates by accident. Three refusals, and they are the same rules an invitation is held to: **403** if the member holds a permission the caller does not (`more_privileged`), **403** if the *role being granted* holds one (`role_not_grantable` — this is what stops any holder of the key promoting themselves to `owner`), and **409** for the org's last owner (`last_owner`). An unknown role is a **422**, never a 403, so a typo is distinguishable from a permission you lack.

Параметрүүд

Нэр	Төрөл	Заавал шаардлагатай	Энэ юу вэ
`orgId (path)`	`Uuid`	Тийм	Organization ID (UUIDv7).
`userId (path)`	`Uuid`	Тийм	The user to remove from the organization.

Хүсэлтийн бие

Нэр	Төрөл	Заавал шаардлагатай	Энэ юу вэ
`role`	`string`	Тийм	A role key from `GET /v1/orgs/{orgId}/roles`.

Хариу үйлдэл

Нэр	Төрөл	Заавал шаардлагатай	Энэ юу вэ
`user_id`	`Uuid`	Тийм	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`email`	`string`	Тийм	—
`name`	`string`	Тийм	Display name; may be empty for an account that never set one.
`roles`	`string[]`	Тийм	Every role this person holds in this org, sorted.
`joined_at`	`string`	Тийм	When their EARLIEST membership of this org was created.
`is_self`	`boolean`	Тийм	Whether this row is the calling user.
`removable`	`boolean`	Тийм	—
`not_removable_reason`	`OrgMemberRemovalBlock \| null`	Тийм	Why not, when `removable` is false. Null when removable — and also null for a caller lacking `members.remove`, because "you cannot remove anyone here" is a fact about the caller…
`role_assignable`	`boolean`	Тийм	Whether `PATCH` on this member would be accepted — the caller holds `members.role.assign` here, does not outrank themselves, and this is not the last owner. ⛔ Which role may t…

Энэ төгсгөл цэгээс буцааж болох алдаанууд

401 · 403 · 404 · 409 · 422 · 429

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