members

POST `/v1/members/invitations`

Invite an email to join an organization with a role.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) members.invite jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

A szervezet azonosítójának helye

Ez a végpont a org_id mezőt várja a JSON törzsben.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Kérés törzse

Név	Típus	Kötelező	Mi ez
`email`	`string`	Igen	—
`role`	`string`	Igen	The role key to grant (e.g. `manager`, `billing`).
`org_id`	`string`	Nem	Organization to invite into; defaults to the caller's own. The caller must hold `members.invite` in that organization.

Válasz

Név	Típus	Kötelező	Mi ez
`id`	`string`	Igen	—
`org_id`	`string`	Igen	—
`org_name`	`string`	Igen	The inviting organisation's display name, so an invitee can answer "accept?".
`email`	`string`	Igen	—
`role`	`string`	Igen	—
`site_grants`	`object[]`	Igen	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…
`status`	`string<pending, accepted, revoked>`	Igen	—
`expires_at`	`string`	Igen	—
`accepted_at`	`string`	Nem	—
`created_at`	`string`	Igen	—

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 422 · 429