...
WorkFlow: Add User Flow
Input
...
Type: application/json
| Name |
| Source | Mandatory | Type | Special Format | Description |
|---|
tId | Body or Query | YES| tCode | Body or Query | YES | String | N/A | the code of the tenant |
String | N/A | the Id of the tenant where this user is added | | username | Body | YES | String | alphanumeric with _ , - characters only |
|
| firstName | Body | YES | String | N/A |
|
| lastName | Body | YES | String | N/A |
|
| email | Body | YES | String |
N/A| Email Address Format (JSON Schema Validation) |
|
| profile | Body | NO | Object | N/A | The profile object. |
| groups | Body | NO | Array | N/A | array of group code values |
| status | body | NO | String - enum | 'active', 'inactive', 'pendingNew' |
|
| password | body | NO | String |
|
|
| confirmation | body | NO | String | Value is as same as password |
|
| pin |
| body | NO |
|
|
|
| code |
| YES | String |
|
|
| allowed |
| YES | boolean |
|
|
Output
...
Valid Response
| Code Block |
|---|
| language | js |
|---|
| title | Valid Response Sample |
|---|
|
{
"result": true,
"data": "..."
} |
...
| Code Block |
|---|
| language | bash |
|---|
| title | Calling Add User API |
|---|
|
> CURL -X POST http://127.0.0.1:4000/urac/admin/addUser?tId=5551aca9e179c39b760f7a1a&tCode=DBTN -d 'username=john&firstName=John&lastName=Doe&email=johndoe@domain.com' |
...