Site Home
API Reference
LoginTry for Free

Create Invite Link

post
https://{application_vanity_domain}/api/v1/new-user-invitation/create-invite-link
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Generates an invitation link that can be directly given to a user to invite them into a tenant. Invitation links can only be used once to invite a single user.

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.

PermissionBoundaryDescription
new-user-invitation-workflow:executeApplicationThe subject can perform this operation for users associated with the application to which the subject belongs.
TenantThe subject can perform this operation for users associated with the tenant the subject belongs to.
Tenant Inclusion ListThe subject can perform this operation for users associated with tenants specified in the tenant inclusion list.
Tenant Exclusion ListThe subject can perform this operation on users associated with tenants that belong to the subject's application but are not on the tenant exclusion list.
Body Params

Create Invitation Link Request JSON object

Object representing a request to create a new invitation link.

string
required
length between 1 and 26

ID of the tenant the invited user should be provisioned into.

string
required
length between 1 and 60

The name of the person that the invite is being sent to. The invitee name serves as a case-insensitive identifier for the invite link - only one invite link can be active at a time for a single invitee per tenant.

rolesToAssign
array of strings
length ≤ 10

The list of role IDs specifying which roles will be assigned to the invited user.

rolesToAssign
Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?