members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

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

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

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

ຈຸດສິ້ນສຸດນີ້ຮັບເອົາ org_id ເປັນຊ່ອງຂໍ້ມູນໃນ JSON body.

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

ລອງໃຊ້ເບິ່ງ

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

curl -X POST https://api.zinndigital.com/v1/members/invitations \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "email": <string>, "role": <string> }'

ເຂົ້າສູ່ລະບົບແລ້ວບໍ? ໂຄງສົນທະນາ API ໃນໜ້າັດສະຫຼອງຂອງທ່ານຈະຕື່ມຂໍ້ມູນລະຫັດອົງກອນຕົວຈິງ ແລະ ລະຫັດລັບສ່ວນຕົວຂອງທ່ານໂດຍອັດຕະໂນມັດ, ແລະ ປະຕິບັດການຮ້ອງຂໍຜ່ານ API ຕົວຈິງ ເພື່ອໃຫ້ທ່ານສາມາດເຫັນຜົນຕອບຮັບທີ່ແທ້ຈິງໄດ້. ເປີດຈຸດສິ້ນສຸດນີ້ໃນຄອນໂສລ API

ລາຍລະອຽດ

Invites an **email** (the person need not exist yet — users are Keycloak subjects) to join with a role. The role is validated to be one the inviter is themselves permitted to grant: a role holding any permission the inviter lacks in that organization is refused (422), so `members.invite` is not a ladder to owner. A re-invite of the same email refreshes the pending invite. Emits `member.invited` so the invitation email is sent. Requires `members.invite` in the target org.

ເນື້ອຫາຂອງຄຳຮ້ອງ

ຊື່	ປະເພດ	ຕ້ອງການ	ສິ່ງທີ່ມັນເປັນ
`email`	`string`	ແມ່ນແລ້ວ	—
`role`	`string`	ແມ່ນແລ້ວ	The role key to grant (e.g. `manager`, `billing`).
`org_id`	`string`	ບໍ່	Organization to invite into; defaults to the caller's own. The caller must hold `members.invite` in that organization.

ຖືກໂຈະ

ຊື່	ປະເພດ	ຕ້ອງການ	ສິ່ງທີ່ມັນເປັນ
`id`	`string`	ແມ່ນແລ້ວ	—
`org_id`	`string`	ແມ່ນແລ້ວ	—
`org_name`	`string`	ແມ່ນແລ້ວ	The inviting organisation's display name, so an invitee can answer "accept?".
`email`	`string`	ແມ່ນແລ້ວ	—
`role`	`string`	ແມ່ນແລ້ວ	—
`site_grants`	`object[]`	ແມ່ນແລ້ວ	The individual sites this invitation lends, when it was created by sharing a site with an address that had no account (`POST /v1/sites/{siteId}/collaborators`). Empty for an ord…
`status`	`string<pending, accepted, revoked>`	ແມ່ນແລ້ວ	—
`expires_at`	`string`	ແມ່ນແລ້ວ	—
`accepted_at`	`string`	ບໍ່	—
`created_at`	`string`	ແມ່ນແລ້ວ	—

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

401 · 403 · 422 · 429

POST /v1/members/invitations