access

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

Change a member's role.

ການພິສູດຕົວຕົນ

ສົ່ງລະຫັດ API ເປັນ bearer token. ລະຫັດຕ້ອງມີສິດ members.role.assign; ລະຫັດທີ່ບໍ່ມີສິດດັ່ງກ່າວຈະຖືກປະຕິເສດດ້ວຍລະຫັດ 403, ບໍ່ແມ່ນ 404.

ບ່ອນທີ່ລະບົບຈັດການອົງກອນຂອງທ່ານໄປ

ຈຸດສິ້ນສຸດນີ້ຈະຮັບເອົາລະຫັດອົງກອນຂອງທ່ານຢູ່ໃນ URL ເອງ, ເປັນ orgId. ໃຫ້ແທນທີ່ມັນລົງໃນເສັ້ນທາງ — ບໍ່ມີສ່ວນຫົວ ຫຼື ພາຣາະມິເຕີຄຳຖາມໃດທີ່ຈະເຮັດໜ້າທີ່ນັ້ນແທນ.

ລະຫັດອົງກອນຂອງທ່ານແມ່ນຢູ່ໜ້າກະແຈ API ໃນແຜງຄວບຄຸມຂອງທ່ານ, ຖັດຈາກກະແຈ itself. ມັນແມ່ນລະຫັດດຽວກັນໃນທຸກໆການໂທທີ່ທ່ານເຮັດ.

ລອງໃຊ້ເບິ່ງ

ປ່ຽນແທນທຸກຢ່າງທີ່ຢູ່ໃນວົງເລັບມຸມດ້ວຍຄ່າຂອງທ່ານເອງ, ແລະ ປ່ຽນແທນຕົວແທນບ່ອນວ່າງຄີດ້ວຍຄີຈາກແຜງຄວບຄຸມຂອງທ່ານ.

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 ໃນໜ້າັດສະຫຼອງຂອງທ່ານຈະຕື່ມຂໍ້ມູນລະຫັດອົງກອນຕົວຈິງ ແລະ ລະຫັດລັບສ່ວນຕົວຂອງທ່ານໂດຍອັດຕະໂນມັດ, ແລະ ປະຕິບັດການຮ້ອງຂໍຜ່ານ 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…

ຂໍ້ຜິດພາດທີ່ຈຸດເຊື່ອມຕໍ່ນີ້ສາມາດສົ່ງຄືນໄດ້

401 · 403 · 404 · 409 · 422 · 429

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