List Roles
All the listed privileges are required -
Privileges | Description |
---|---|
GLOBAL_ROLE_VIEW | Caller should have permission to this privilege, to perform this operation. |
GLOBAL_PERMISSION_VIEW | Caller should have permission to this privilege, to read the permission IDs for Role. |
Request
URI
GET
https://{api_host}//localhost/rest/config/v1/roles
COPY
Responses
200
OK
[
{
"applies_to_federation_access_group": true,
"applies_to_local_access_group": true,
"built_in_role_type": "INVENTORY_ADMIN",
"description": "Administration users with rights for global and per Connection Server configuration settings.",
"id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
"name": "Global Configuration and Policy Administrators",
"permission_ids": [
"0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"6fd4638a-381f-4518-aed6-042aa3d9f14c"
],
"privileges": [
"GLOBAL_ADMIN_UI_INTERACTIVE",
"GLOBAL_CONFIG_MANAGEMENT",
"GLOBAL_CONFIG_VIEW",
"GLOBAL_CVP_PUBLICATION"
]
}
]
401
User is not authenticated
Operation doesn't return any data structure
403
Access to the resource is forbidden
Operation doesn't return any data structure
Config Operations
POST
Create Federation Access Group
POST
Create IC Domain Account
POST
Create IM Asset
POST
Create IM Assets
POST
Create IM Stream
POST
Create IM Streams
POST
Create IM Tag
POST
Create IM Tags
POST
Create IM Version
POST
Create IM Versions
POST
Create JWT Authenticator
POST
Create Local Access Group
POST
Create Permissions
POST
Create Role
DELETE
Delete Federation Access Group
DELETE
Delete IC Domain Account
DELETE
Delete IM Asset
DELETE
Delete IM Stream
DELETE
Delete IM Tag
DELETE
Delete IM Version
DELETE
Delete JWT Authenticator
DELETE
Delete Local Access Group
DELETE
Delete Permissions
DELETE
Delete Role
GET
Get Connection Server
GET
Get Environment
GET
Get Environment V2
GET
Get Feature Settings
GET
Get Federation Access Group
GET
Get Federation Access Group V2
GET
Get General Settings
GET
Get General Settings V2
GET
Get IC Domain Account
GET
Get IM Asset
GET
Get IM Stream
GET
Get IM Tag
GET
Get IM Version
GET
Get JWT Authenticator
GET
Get Local Access Group
GET
Get Local Access Group V2
GET
Get Permission
GET
Get Role
GET
Get Security Settings
GET
Get Settings
GET
Get Settings V2
GET
List Connection Servers
GET
List Federation Access Groups
GET
List Federation Access Groups V2
GET
List IC Domain Accounts
GET
List IM Assets
GET
List IM Streams
GET
List IM Tags
GET
List IM Versions
GET
List JWT Authenticators
GET
List Local Access Groups
GET
List Local Access Groups V2
GET
List Permissions
GET
List RCX Servers
GET
List Roles
GET
List Selectable Privileges
GET
List VC Info
GET
List VC Info V2
POST
Mark Datastores For Archival
POST
Register RCX Client
DELETE
Unregister RCX Client
PUT
Update Connection Server
PUT
Update Feature Settings
PUT
Update General Settings
PUT
Update General Settings V2
PUT
Update IC Domain Account
PUT
Update IM Asset
PUT
Update IM Stream
PUT
Update IM Tag
PUT
Update IM Version
PUT
Update JWT Authenticator
PUT
Update RCX Client
PUT
Update Role
PUT
Update Security Settings
PUT
Update Settings
PUT
Update Settings V2