Create local user
Creates a local user.
This topic includes the following sections:
For a video demonstration of how to use this call, see Local-user-and-role-management-API.
Request
HTTP method: POST
URL: https://<server name>:<port>/rsso/config/local/user/add
Header: For header information, such as required authentication token, see Remedy-SSO-administrator-Login-and-Logout-calls.
Request body properties
Property | Type | Required | Description | Values | Default value |
|---|---|---|---|---|---|
loginName | String | Yes | User login name | User-provided value | NA |
userName | String | Yes | Display name | User-provided value | NA |
password | String | Yes | User password Minimum 8 characters long | User-provided value | NA |
description | String | No | User description | User-provided value | NA |
enabled | Boolean | No | User account status | User-provided value | false |
Example request JSON
"loginName": "<loginname>",
"userName": "<username>",
"password": "<password>",
"description":"test user",
"enabled":"true"
}
Response
If successful, this method creates the specified local user.
Response body properties
Property | Description |
|---|---|
code | Status code (see Status codes and messages) |
msg | Status |
data | NA |
Example response JSON
"code": 200,
"msg": "OK",
"data": {}
}
Status codes and messages
For more details about HTTP response codes, see HTTP response codes.
HTTP code | Message (msg) | Description |
|---|---|---|
200 | OK | Request succeeded |
400 |
| Bad request An error occurred while adding the user. Some causes are
|
401 |
| Unauthorized |
Related topics