members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

Санҷиши ҳаққоният

Kaliti API-ро ҳамчун рамзи доранда (bearer token) фиристед. Калит бояд дорои иҷозати members.invite бошад; калиди бидуни он бо хатои 403 рад карда мешавад, на 404.

Ҷое, ки рақами мушаххаси ташкилоти шумо ҷойгир аст

Ин нуқтаи поёнӣ org_id -ро ҳамчун майдон дар бадани JSON мегирад.

Rakami муайянкунандаи ташкилоти шумо дар экрани калидҳои API дар панели идоракунии шумо, дар паҳлӯи худи калид ҷойгир аст. Ин як раками муайянкунанда дар ҳар یک дархосте, ки шумо иҷро мекунед, якхела аст.

Санҷидан

Ҳар чизро дар қаavски кунҷӣ бо қиматҳои худ ва ҷойи нигоҳдорандаи калидро бо калима аз панели идоракунии худ иваз кунед.

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> }'

Воarid шудаед? Консоли 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