GET /user-management/local/users/{userId}/
This resource allows you to view a user's details information.
Used when you are operating a browser without access to the header parameter. This allows you to choose which encoding you want to use for the response:
All these resources can be used according what the resource allows.
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
This is the user's ID.
Object Name: User
| Property Name | Type | Description | Method |
|---|---|---|---|
| Id | Integer | This property is the user's ID | GET |
| Username | String | This property is the user's login. 3 to 16 characters. |
GET POST PUT |
| WelcomePage | String | This property is the user's welcome page. When a user logs into the controller, the first page they will see can be set so they do not have to navigate to that page every time they connect to the controller. The URL is everything after the Port number. |
GET POST PUT |
| PasswordReset | Boolean | This property is used to indicate if the user need to reset his password.
|
GET POST PUT |
| Roles | Array |
This object is an array of Role object. It will contain all the user's role. During a POST/PUT request, to edit user's roles or create a new user, you have to send an array of string : Example : ["Admin","BleRoomDevices_Admin"] |
GET POST PUT |
| Password | String | This is the user's password. This value can be used for a POST (create or edit a user) or PUT (edit a user). It will not be displayed with a GET. SHOULD be encoded in Base64. |
POST PUT |
URL Example: https://0.0.0.0/api/rest/v1/user-management/local/users/1
{
"id": 1,
"welcomePage": "",
"username": "admin",
"passwordReset": false,
"roles": {
"href": "/api/rest/v1/user-management/local/users/1/roles",
"name": "roles"
}
}
URL Example: https://0.0.0.0/api/rest/v1/user-management/local/users/1
<?xml version="1.0" encoding="utf-8"?>
<User>
<Id>1</Id>
<Username>admin</Username>
<WelcomePage />
<PasswordReset>false</PasswordReset>
<Roles>
<Href>/api/rest/v1/user-management/local/users/1/roles</Href>
<Name>roles</Name>
</Roles>
</User>