InviteUser
Send an email invitation to new user. Requires permissions: Access User Management Api and Access Users.
Execute
Sample EXECUTE InviteUser EmailAddress='[email protected]', FirstName='insert', LastName='api', UserWorkspaceRoles='[{"accessRoleId": 103, "workspaceId": 0}]
EXECUTE InviteUser EmailAddress='[email protected]', FirstName='insert', LastName='api', UserWorkspaceRoles='[{"accessRoleId": 103, "workspaceId": 0}]', Reason='test', UserId='[email protected]', ApiOnly=true, ExpiresAt='2024-12-12T00:00:00-01:00'
Input
| Name | Type | Required | Description |
| EmailAddress | String | True | The user's email address. |
| FirstName | String | True | The user's first name. |
| LastName | String | True | The user's last name. |
| UserWorkspaceRoles | String | True | The user roles provided as a json array of objects containing accessRoleId and workspaceId. |
| UserId | String | False | The user id in the form of an email address. If not specified, the emailAddress value is used. |
| Reason | String | False | Reason for user invitation. |
| ApiOnly | Boolean | False | Whether the user is API-Only.
The default value is false. |
| ExpiresAt | Datetime | False | Date and time when user login expires. |
Result Set Columns
| Name | Type | Description |
| Success | Boolean | Boolean indicating if the procedure was executed successfully. If false, the output parameter 'Details' will contain the failure details. |
| Details | String | Details of execution failure. NULL if success=true. |