GET /user-management-v2
FROM API REVISION 6.0
This resource is the entry point for the user-management changes.
The only valuable information you can recover at this point is the updateStarted
property.
From this resource you can access 4 other resources :
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: UserManagement
Property Name | Type | Description | Method |
---|---|---|---|
Users | Array <User> | User access to this controller and to other controllers that are using this controller as their RADIUS server are managed by adding them to this array. | GET |
PasswordPolicy | Object | This object is used to configure how secure the users password will be. | GET |
Client | Object | This object contains the configuration parameters used to connect you to a server using Radius or OIDC. | GET |
Server | Object | This object contains the configuration parameters used to allow other controllers to use this controller as a Radius or OIDC server. | GET |
UpdateStarted | String | This property represents the current status of the user-management update state. If an update has been started this will display true ; false otherwise. | GET |
Roles | Array <Role> | This object is an array of Role object. It will contain all the existing roles. | GET |
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2
{
"users": {
"href": "/api/rest/v1/user-management-v2/users",
"name": "users"
},
"server": {
"href": "/api/rest/v1/user-management-v2/server",
"name": "server"
},
"updateStarted": false,
"client": {
"href": "/api/rest/v1/user-management-v2/client",
"name": "client"
},
"passwordPolicy": {
"href": "/api/rest/v1/user-management-v2/passwordPolicy",
"name": "passwordPolicy"
},
"roles": {
"href": "/api/rest/v1/user-management-v2/roles",
"name": "roles"
}
}
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2
<?xml version="1.0" encoding="utf-8"?>
<UserManagement>
<Client>
<Href>/api/rest/v1/user-management-v2/client</Href>
<Name>client</Name>
</Client>
<Roles>
<Href>/api/rest/v1/user-management-v2/roles</Href>
<Name>roles</Name>
</Roles>
<Server>
<Href>/api/rest/v1/user-management-v2/server</Href>
<Name>server</Name>
</Server>
<Users>
<Href>/api/rest/v1/user-management-v2/users</Href>
<Name>users</Name>
</Users>
<PasswordPolicy>
<Href>/api/rest/v1/user-management-v2/passwordPolicy</Href>
<Name>passwordPolicy</Name>
</PasswordPolicy>
<UpdateStarted>false</UpdateStarted>
</UserManagement>