GET /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
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.
The $select system query option allows clients to request a limited set of properties for each entity.
The value pass in the parameter can be:
*"(star): This will show all child elements.," (comma).If there is no value after the select query option, the parameter will be ignored. All the values that are not specified will not be printed in the response.
The $expand system query option specifies the related resources to be included in line with retrieved resources.
The value passed in the parameter can be:
*"(star): This will expand all child elements.," (comma).The $expand system query option can be used with the $levels query option, to expand recursively.
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.
Object Name: Users
| Property Name | Type | Description | Method |
|---|---|---|---|
| Users | Array<User> | User that access a controller connected in remote to another Radius server are cloned here. | GET |
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/users
[
{
"href": "/api/rest/v1/user-management-v2/users/1",
"name": "1"
},
{
"href": "/api/rest/v1/user-management-v2/users/2",
"name": "2"
},
{
"href": "/api/rest/v1/user-management-v2/users/4",
"name": "4"
},
{
"href": "/api/rest/v1/user-management-v2/users/5",
"name": "5"
}
]
Url Example: https://1.1.1.1/api/rest/v1/user-management-v2/users
<?xml version="1.0" encoding="utf-8"?>
<Users>
<User>
<Href>/api/rest/v1/user-management-v2/users/1</Href>
<Name>1</Name>
</User>
<User>
<Href>/api/rest/v1/user-management-v2/users/2</Href>
<Name>2</Name>
</User>
<User>
<Href>/api/rest/v1/user-management-v2/users/4</Href>
<Name>4</Name>
</User>
<User>
<Href>/api/rest/v1/user-management-v2/users/5</Href>
<Name>5</Name>
</User>
</Users>