GET /user-management-v2/roles
FROM API REVISION 6.0
On this resource, you can list all the roles ID that exists, and can be use for a User.
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: Roles
| Property Name | Type | Description | Method |
|---|---|---|---|
| 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/roles
[
{
"href": "/api/rest/v1/user-management-v2/roles/1",
"name": "1"
},
{
"href": "/api/rest/v1/user-management-v2/roles/2",
"name": "2"
},
{
"href": "/api/rest/v1/user-management-v2/roles/3",
"name": "3"
},
{
"href": "/api/rest/v1/user-management-v2/roles/4",
"name": "4"
}
]
URL Example: https://0.0.0.0/api/rest/v1/user-management-v2/roles
<?xml version="1.0" encoding="utf-8"?>
<Roles>
<Role>
<Href>/api/rest/v1/user-management-v2/roles/1</Href>
<Name>1</Name>
</Role>
<Role>
<Href>/api/rest/v1/user-management-v2/roles/2</Href>
<Name>2</Name>
</Role>
<Role>
<Href>/api/rest/v1/user-management-v2/roles/3</Href>
<Name>3</Name>
</Role>
<Role>
<Href>/api/rest/v1/user-management-v2/roles/4</Href>
<Name>4</Name>
</Role>
</Roles>