Add User
Creates a new user.
URL: /user
Type: POST
Parameters
| Param Type | Name | Description | Field Type |
|---|---|---|---|
| Header | sessionId ** | Session Id received after login | string |
| Query | gwkey | Tenant Key. Needed only in case of multitenant installations | string |
| Query | gwsource** | Source from which the request is triggered (Eg: web, external) | String |
| Payload | loginName** | Unique names used as the username for authentication. Duplication is not allowed | String |
| Payload | password** | A password that can be used to authenticate. Note: Not relevant if ‘isExternalAuth’ is set to Y | String |
| Payload | confirmPassword** |
Reconfirm the given password Note: Not relevant if ‘isExternalAuth’ is set to Y |
String |
| Payload | isExternalAuth** | Specify if the user is from an external authentication system like LDAP, Radius, etc. Possible values are ‘Y’ for yes and ‘N’ for No | String |
| Payload | comment | Comment for the user | String |
| Payload | preferredContactMode** | Preferred contact mode. Possible values are ‘E’ for email. | String |
| Payload | email** | Email address | String |
** - Mandatory value
Possible Response Message and Code
| HTTP Code | Description | Response Message |
|---|---|---|
| 400 | Bad request | The user password cannot be null or empty TBD … more 400 |
| 201 | Created | User added successfully |
| 409 | Conflict | Operation failed. Unable to add a new entity. Entity already exists |