/auth/invite
Description:
The /auth/invite
endpoint allows administrators to invite new users to the system by providing their email address and specifying their permissions. Optionally, a redirect URL can be provided to redirect users after they accept the invitation.
Method:
POST
Security:
Query Parameters
Parameter | Type | Description | Required |
---|---|---|---|
workspaceId | string | The workspaceId/userId of the invitee | No |
userId | string | The ID of the user to invite | No |
Request Payload:
Parameter | Type | Description |
---|---|---|
string | The email address of the user to be invited. | |
sendEmail | boolean | This sends an invite email to the user, by default it is true. |
message (Optional) | string | This adds a message to invite email to the user |
firstName (Optional) | string | The first name of the user to be invited. |
lastName (Optional) | string | The last name of the user to be invited. |
redirect_url (Optional) | string | The URL to redirect the user to after they accept the invitation. |
role (Optional) | string | The role of the invited user. |
To prevent duplicate email addresses, a user can only be associated with one tenant user record within a workspace
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
The workspaceId/userId of the invitee
Success - Existing User Invite
The response is of type object
.