invites
Identity module · 6 operations
List invite rows
GET/invites
An email invitation to join an org. Created through `invites.create` (the `app.invite_member` RPC); the token is never stored or returned again. Returns a cursor page of invite rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
Invite a member
POST/invites
Invites an email to the caller's organization with a role the inviter may grant and an expiry of 1 hour to 30 days, through `app.invite_member`. Replaces any pending invite for the same email. Refused with 422 for a role above the inviter's band, a capability the inviter does not hold, an out-of-range expiry or a self-invite. The token is returned once. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
Get an invite
GET/invites/{id}
An email invitation to join an org. Created through `invites.create` (the `app.invite_member` RPC); the token is never stored or returned again. Returns one invite with its `ETag`. A invite the caller may not see returns 404.
Delete an invite
DELETE/invites/{id}
An email invitation to join an org. Created through `invites.create` (the `app.invite_member` RPC); the token is never stored or returned again. Soft-deletes the invite: it moves to Trash and can be restored for its table's retention period.
Preview an invite
POST/invites/preview
Shows the organization, role and expiry an invite offers, only to the confirmed sign-in it was sent to, through `app.preview_invite`. An invalid, expired, locked or mismatched token returns a 422 `REFUSE` with its reason; repeated failures rate-limit the caller. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
Accept an invite
POST/invites/accept
Accepts an invite for the confirmed sign-in it was sent to, through `app.accept_invite`: joins the organization, or reuses the active membership, and receives the role. Refused with 422 when the token is invalid or the inviter no longer holds `org.members.invite`. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.