IAM API ReferenceInvite

Create a user invitation

Invite a user to an Organization.

Path parameters

organizationIdstringRequired
The ID of the Organization to invite the user to.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
inviteeEmailstringRequired
The email of the user to invite.
roleenumRequired
The user's Organization role.
Allowed values:

Response

OK
expiresAtstring

The time when the invite is expired in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

inviteIdstring
The invite ID.
inviteeobject
inviterobject
organizationIdstring
The ID of the Organization where the invite was sent.
organizationNamestring or null
The name of the Organization where the invite was sent.
userIdstring or null
The ID for the user who was invited.

Errors