access

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

Change a member's role.

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د members.role.assign اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

چیرته چې ستاسو د سازمان آی ډي ځي

دا پای ټکی ستاسو د سازمان آی ډي په خپله په URL کې د orgId په توګه اخلي. دا په لاره کې ځای پرځای کړئ — هیڅ سرلیک یا پوښتنې پیرامیټر شتون نلري چې د دې پرځای کار وکړي.

ستاسو د سازمان آی ډي ستاسو په ډشبورډ کې د API کېلي پر سکرین، خپله د کېلي څنګ ته شتون لري. دا په هره هغه غوښتنه کې چې تاسو یې کوئ، ورته آی ډي وي.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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 په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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}