Skip to main content
POST
auth.invitation.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
organizationId
string
required

The organization to invite to, as returned by auth.organizations.list.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
email
string
required

Email address to send the invitation to.

Required string length: 1 - 320
role
string
required

Role the invitee gets, e.g. member or admin.

Required string length: 1 - 64
Pattern: ^[a-z][a-z0-9_-]*$
redirectUrl
string

URL the invitee lands on after accepting. Accepts a public URL, or http on localhost for a local install.

inviterUserId
string

The user sending the invitation, when the auth system supports it.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Response

The result

invitationId
string
required

The invitation's id.

email
string
required

Email address invited.

role
string

Role offered.

status
string

e.g. pending, accepted or revoked.

expiresAt
string

When the invitation expires, ISO 8601.