Skip to main content
POST
Create organization invitation

Authorizations

Authorization
string
header
required

Bearer token authentication using OAuth2/OIDC tokens

Path Parameters

id
string<uuid>
required

Unique organization identifier

Body

application/json
email
string<email>
required

Email address of invitee

roles
string[]

Roles to assign to the invitee. At least one of roles or groups must be provided.

groups
string[]

Groups to add the invitee to. At least one of roles or groups must be provided.

message
string

Optional custom message to include in the invitation email.

Maximum string length: 500

Response

Invitation created successfully

User invitation to organization

Server-defined URL for this resource.

Example:

"/v1/regions/global/organizations/org-s1t2u3/invitations/invitation-y8z9a1"

uid
string<uuid>
read-only

Server-generated UUID.

id
string<uuid>

Unique invitation identifier

displayName
string

Invitee display name

email
string<email>

Invitee email address

roles
string[]

Roles assigned in invitation

groups
string[]

Groups the invitee will be added to upon acceptance

status
enum<string>

Invitation status

Available options:
pending,
accepted,
expired
createdAt
string<date-time>

Creation timestamp

expiresAt
string<date-time>

Expiration timestamp