General Information
...
Name | Source | Mandatory | Type | Special Format | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
uId | Query | YES | String | N/A | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
username | Body | YES | String | alphanumeric with _ , - characters only | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
firstName | Body | YES | String | N/A | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lastName | Body | YES | String | N/A | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body | YES | String | N/A | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | Body | YES | enum | 'active', 'inactive' | restricted to either 'active' OR 'inactive' | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
groups | Body | NO | Array | N/A | array of group code values | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
profile | Body | NO | Object | N/A | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
password | body | NO | String | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
confirmation | body | NO | String | same as password | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pin | body | NO | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
code | YES | String | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
allowed | YES | Boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
config | Body | NO | Object | N/A | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example of config:
|
...