POST /user-management-v2/users
FROM API REVISION 6.0
User access to this controller and to other controllers that are using this controller as their RADIUS or OIDC server are managed by adding them to the users collection.
According the controller configuration, if it is connected to an external server or not, this will display the local user list or not.
In case it is connected to an external authentication server :
The users displayed will be only the one who already had a connection with the device or the one you entered to create them a welcome page.
To add a new user to the authentication database, you will have to do it on the authentication server.
In case it is not connected to an external authentication server :
The users displayed will be the users registered on this devices.
Adding a new user here will allow him to connect into the device.
Response :
201 Created
400 Bad Request
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.
There are multiple possible values according the resource:
If this parameter is not present during the request, and error 415 Unsupported Media Type will be thrown.
The Content-Length entity-header field indicates the size of the entity-body.
Object Name: User
| Property Name | Type | Description | Method |
|---|---|---|---|
| Id | Integer | This property is the remote user's ID. | GET |
| Username | String | This property is the user's name | GET POST PUT |
| WelcomePage | String | This property is the user's welcome page. | GET POST PUT |
| PasswordReset | Boolean | This property is used to indicate if the user need to reset his password.
|
GET POST PUT |
| Roles | Array<String> | This is the remote user's roles. | 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 |
| Id | Integer | This property is the remote user's ID. | GET |
| Username | String | This property is the user's name | GET POST PUT |
| WelcomePage | String | This property is the user's welcome page. | GET POST PUT |
| Roles | Array<String> | This is the remote user's roles. | GET POST PUT |
Object Name: User
| Property Name | Type | Description | Method |
|---|---|---|---|
| Id | Integer | This property is the remote user's ID. | GET |
| Username | String | This property is the user's name | GET |
| WelcomePage | String | This property is the user's welcome page. | GET |
| PasswordReset | Boolean | This property is used to indicate if the user need to reset his password. |
It will not be displayed with a GET.
SHOULD be encoded in Base64. | | POST | PUT |
Id | Integer | This property is the remote user's ID. | GET | | null |
Username | String | This property is the user's name | GET | POST | PUT |
WelcomePage | String | This property is the user's welcome page. | GET | POST | PUT |
Roles | Array
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/users
{
"username": "bryan",
"password": "RGlzdGVjaDEyMw==",
"roles": [
"admin"
],
"welcomePage": "/myCustomLink"
}
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/users
<?xml version="1.0" encoding="utf-8"?>
<User>
<Username>bryan</Username>
<Password>RGlzdGVjaDEyMw==</Password>
<Roles>
<Role>
<Name>Admin</Name>
</Role>
</Roles>
</User>