Skip to content

Create a user invite

POST
/auth/user-invites

Generate a user invite token for registration. System admin only.

object
email
required
string format: email
expiresInDays
integer
default: 7 >= 1 <= 90

Invite created successfully

object
token
required
string
userInvite
required
object
userInviteId
required
string
email
required
string format: email
expiresAt
required
string format: date-time
createdByUserId
required
string
usedAt
required
string format: date-time
nullable
revokedAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
registrationUrl
required
string format: uri

Invalid request (email already registered or pending invite)

Unauthorized - invalid or missing token

Forbidden - insufficient permissions (system admin required)