...
Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
user | Body | NOW | Object | Includes ONE of id, username, or email | User object, if not set username will be fetch from access token |
Name | Mandatory | type | Description | ||
id | YES | string | User Id | ||
username | YES | string | Username | ||
YES | User email | ||||
tenant | Body | YES | Object | Includes tenant id, and code | Tenant object |
Name | Mandatory | type | Description | ||
id | YES | string | tenant id | ||
code | YES | string | tenant code | ||
groups | Body | NO | Array | Array of strings | Groups array |
pin | Body | NO | Object | Includes code and allowed parameters | Pin object |
Name | Mandatory | type | Description | ||
code | YES | Boolean | Set to true to create random code | ||
allowed | YES | Boolean | Set to true if this user is allowed to start pin login, this will also be set under main tenant | ||
Output
...
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
...
Code | Description |
|---|---|
535 | Sub tenant cannot self invite a user |
529 | User has already been invited. |
520 | Unable to find user |
525 | Unable to generate pin at this time. |
602 | Model error: + %model_error% |
527 | username or id is required to invite user. |