Site Home
API Reference
LoginTry for Free

Invite New User

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

Sends a tenant-scoped invite to the specified email address.

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 included in the tenant exclusion list.
Body Params

Invite New User Request JSON object

Object representing a request to send a new user invitation.

string
required
length between 1 and 26

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

string
required
length between 1 and 200

The email that the invite will be sent to.

rolesToAssign
array of strings
length ≤ 10

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

rolesToAssign
Responses

Updated 22 days ago

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 22 days ago