GET Roles

GET Roles

Gets a list of all user roles.

Request
URI
GET
https://{api_host}/api/v2/roles
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved the list of roles.

Returns roles.get.response of type(s) application/json
[
    {
        "id": "00000000-0000-0000-0000-000000000001",
        "name": "Super Admin",
        "description": "Full Admin and User capabilities, including editing Shared content",
        "capabilities": [
            {
                "id": "VIEW_SHARED_DASHBOARDS"
            },
            {
                "id": "VIEW_FORWARDING"
            },
            {
                "id": "EDIT_ALERTS"
            },
            {
                "id": "EDIT_PARTITIONS"
            },
            {
                "id": "VIEW_GENERAL_CONFIG"
            },
            {
                "id": "VIEW_SSL_CONFIG"
            },
            {
                "id": "EDIT_USER_DASHBOARDS"
            },
            {
                "id": "VIEW_HOSTS"
            },
            {
                "id": "EDIT_HOSTS"
            },
            {
                "id": "VIEW_AGENTS"
            },
            {
                "id": "VIEW_AUTHENTICATION_CONFIG"
            },
            {
                "id": "EDIT_SHARED_DASHBOARDS"
            },
            {
                "id": "VIEW_SHARED_DASHBOARD_URLS"
            },
            {
                "id": "VIEW_WEBHOOK_CONFIG"
            },
            {
                "id": "EDIT_SYSTEM_MONITOR"
            },
            {
                "id": "EDIT_AUTHENTICATION_CONFIG"
            },
            {
                "id": "EDIT_LOG_MASK"
            },
            {
                "id": "EDIT_FORWARDING"
            },
            {
                "id": "VIEW_CERTIFICATES"
            },
            {
                "id": "EDIT_CLUSTER"
            },
            {
                "id": "VIEW_USER_DASHBOARDS"
            },
            {
                "id": "EDIT_ACCESS_CONTROL"
            },
            {
                "id": "EDIT_GENERAL_CONFIG"
            },
            {
                "id": "VIEW_PARTITIONS"
            },
            {
                "id": "EDIT_CERTIFICATES"
            },
            {
                "id": "EDIT_CONTENT_PACKS"
            },
            {
                "id": "EDIT_SSL_CONFIG"
            },
            {
                "id": "VIEW_EXPORT"
            },
            {
                "id": "VIEW_CLUSTER"
            },
            {
                "id": "VIEW_INTERACTIVE_ANALYTICS"
            },
            {
                "id": "VIEW_NSX_INTEGRATION"
            },
            {
                "id": "EDIT_SMTP_CONFIG"
            },
            {
                "id": "EDIT_VROPS_INTEGRATION"
            },
            {
                "id": "EDIT_TIME_CONFIG"
            },
            {
                "id": "VIEW_ALERTS"
            },
            {
                "id": "VIEW_VROPS_INTEGRATION"
            },
            {
                "id": "EDIT_INTERACTIVE_ANALYTICS"
            },
            {
                "id": "VIEW_VSPHERE_INTEGRATION"
            },
            {
                "id": "EDIT_AGENTS"
            },
            {
                "id": "VIEW_EXTRACTED_FIELDS"
            },
            {
                "id": "VIEW_LOG_MASK"
            },
            {
                "id": "VIEW_CONTENT_PACKS"
            },
            {
                "id": "VIEW_CONTENT_PACK_DASHBOARDS"
            },
            {
                "id": "VIEW_SMTP_CONFIG"
            },
            {
                "id": "EDIT_VSPHERE_INTEGRATION"
            },
            {
                "id": "EDIT_LICENSE"
            },
            {
                "id": "VIEW_ACCESS_CONTROL"
            },
            {
                "id": "EDIT_EXPORT"
            },
            {
                "id": "EDIT_LOG_FILTER"
            },
            {
                "id": "EDIT_NSX_INTEGRATION"
            },
            {
                "id": "VIEW_CLOUD_INTEGRATION"
            },
            {
                "id": "EDIT_CLOUD_INTEGRATION"
            },
            {
                "id": "VIEW_LICENSE"
            },
            {
                "id": "VIEW_SYSTEM_MONITOR"
            },
            {
                "id": "VIEW_TIME_CONFIG"
            },
            {
                "id": "EDIT_SHARED_DASHBOARD_URLS"
            },
            {
                "id": "VIEW_LOG_FILTER"
            },
            {
                "id": "EDIT_EXTRACTED_FIELDS"
            },
            {
                "id": "EDIT_WEBHOOK_CONFIG"
            }
        ],
        "dataSets": [],
        "required": true,
        "editable": false
    },
    {
        "id": "1d0bf770-4157-4663-b8f6-a1474a1a3db6",
        "name": "View Only Admin",
        "description": "Can view Admin info and has full User access",
        "capabilities": [
            {
                "id": "VIEW_SHARED_DASHBOARDS"
            },
            {
                "id": "VIEW_CLUSTER"
            },
            {
                "id": "VIEW_INTERACTIVE_ANALYTICS"
            },
            {
                "id": "VIEW_FORWARDING"
            },
            {
                "id": "EDIT_ALERTS"
            },
            {
                "id": "VIEW_GENERAL_CONFIG"
            },
            {
                "id": "VIEW_SSL_CONFIG"
            },
            {
                "id": "EDIT_USER_DASHBOARDS"
            },
            {
                "id": "VIEW_NSX_INTEGRATION"
            },
            {
                "id": "VIEW_CLOUD_INTEGRATION"
            },
            {
                "id": "VIEW_HOSTS"
            },
            {
                "id": "VIEW_AGENTS"
            },
            {
                "id": "VIEW_ALERTS"
            },
            {
                "id": "VIEW_VROPS_INTEGRATION"
            },
            {
                "id": "EDIT_INTERACTIVE_ANALYTICS"
            },
            {
                "id": "VIEW_VSPHERE_INTEGRATION"
            },
            {
                "id": "VIEW_EXTRACTED_FIELDS"
            },
            {
                "id": "VIEW_LOG_MASK"
            },
            {
                "id": "VIEW_AUTHENTICATION_CONFIG"
            },
            {
                "id": "EDIT_SHARED_DASHBOARDS"
            },
            {
                "id": "VIEW_CONTENT_PACKS"
            },
            {
                "id": "VIEW_SHARED_DASHBOARD_URLS"
            },
            {
                "id": "VIEW_CONTENT_PACK_DASHBOARDS"
            },
            {
                "id": "VIEW_WEBHOOK_CONFIG"
            },
            {
                "id": "VIEW_SMTP_CONFIG"
            },
            {
                "id": "VIEW_ACCESS_CONTROL"
            },
            {
                "id": "EDIT_EXPORT"
            },
            {
                "id": "VIEW_CERTIFICATES"
            },
            {
                "id": "VIEW_LICENSE"
            },
            {
                "id": "VIEW_SYSTEM_MONITOR"
            },
            {
                "id": "VIEW_TIME_CONFIG"
            },
            {
                "id": "VIEW_USER_DASHBOARDS"
            },
            {
                "id": "EDIT_SHARED_DASHBOARD_URLS"
            },
            {
                "id": "VIEW_PARTITIONS"
            },
            {
                "id": "VIEW_LOG_FILTER"
            },
            {
                "id": "EDIT_CONTENT_PACKS"
            },
            {
                "id": "VIEW_EXPORT"
            },
            {
                "id": "EDIT_EXTRACTED_FIELDS"
            }
        ],
        "dataSets": [],
        "required": true,
        "editable": false
    },
    {
        "id": "c75b3df5-6f56-4884-a474-bd706f47f4f7",
        "name": "Dashboard User",
        "description": "Can use only Dashboards",
        "capabilities": [
            {
                "id": "VIEW_SHARED_DASHBOARDS"
            },
            {
                "id": "VIEW_SHARED_DASHBOARD_URLS"
            },
            {
                "id": "VIEW_CONTENT_PACK_DASHBOARDS"
            },
            {
                "id": "VIEW_USER_DASHBOARDS"
            },
            {
                "id": "EDIT_SHARED_DASHBOARD_URLS"
            },
            {
                "id": "EDIT_USER_DASHBOARDS"
            },
            {
                "id": "EDIT_SHARED_DASHBOARDS"
            }
        ],
        "dataSets": [
            {
                "id": "b77c5e21-465c-4695-9e9d-9acde38273d0",
                "name": "dashboard_user_datasets",
                "type": "OR",
                "constraints": [
                    {
                        "name": "id",
                        "operator": "CONTAINS",
                        "value": "00000000-0000-0000-0000-000000000001",
                        "hidden": false
                    }
                ]
            }
        ],
        "required": true,
        "editable": false
    },
    {
        "id": "aca3224b-2ad6-4d17-85ec-df9c788df476",
        "name": "Test_Role",
        "description": "Can use Interactive Analytics and Dashboards",
        "capabilities": [
            {
                "id": "VIEW_SHARED_DASHBOARDS"
            },
            {
                "id": "VIEW_INTERACTIVE_ANALYTICS"
            },
            {
                "id": "VIEW_CONTENT_PACKS"
            },
            {
                "id": "VIEW_SHARED_DASHBOARD_URLS"
            },
            {
                "id": "EDIT_ALERTS"
            },
            {
                "id": "VIEW_CONTENT_PACK_DASHBOARDS"
            },
            {
                "id": "EDIT_USER_DASHBOARDS"
            },
            {
                "id": "EDIT_EXPORT"
            },
            {
                "id": "VIEW_ALERTS"
            },
            {
                "id": "VIEW_USER_DASHBOARDS"
            },
            {
                "id": "EDIT_INTERACTIVE_ANALYTICS"
            },
            {
                "id": "EDIT_SHARED_DASHBOARD_URLS"
            },
            {
                "id": "EDIT_CONTENT_PACKS"
            },
            {
                "id": "VIEW_EXTRACTED_FIELDS"
            },
            {
                "id": "VIEW_EXPORT"
            },
            {
                "id": "EDIT_SHARED_DASHBOARDS"
            },
            {
                "id": "EDIT_EXTRACTED_FIELDS"
            }
        ],
        "dataSets": [],
        "required": false,
        "editable": true
    },
    {
        "id": "00000000-0000-0000-0000-000000000002",
        "name": "User",
        "description": "Can use Interactive Analytics and Dashboards",
        "capabilities": [
            {
                "id": "VIEW_SHARED_DASHBOARDS"
            },
            {
                "id": "VIEW_INTERACTIVE_ANALYTICS"
            },
            {
                "id": "VIEW_CONTENT_PACKS"
            },
            {
                "id": "VIEW_SHARED_DASHBOARD_URLS"
            },
            {
                "id": "VIEW_CONTENT_PACK_DASHBOARDS"
            },
            {
                "id": "EDIT_USER_DASHBOARDS"
            },
            {
                "id": "EDIT_EXPORT"
            },
            {
                "id": "VIEW_ALERTS"
            },
            {
                "id": "VIEW_USER_DASHBOARDS"
            },
            {
                "id": "EDIT_INTERACTIVE_ANALYTICS"
            },
            {
                "id": "EDIT_SHARED_DASHBOARD_URLS"
            },
            {
                "id": "EDIT_CONTENT_PACKS"
            },
            {
                "id": "VIEW_EXTRACTED_FIELDS"
            },
            {
                "id": "VIEW_EXPORT"
            },
            {
                "id": "EDIT_SHARED_DASHBOARDS"
            },
            {
                "id": "EDIT_EXTRACTED_FIELDS"
            }
        ],
        "dataSets": [],
        "required": false,
        "editable": true
    }
]

401
Operation doesn't return any data structure

440
Operation doesn't return any data structure

500

Internal error while processing the client request

Returns error of type(s) application/json
{
    "errorMessage": "The operation failed due to an internal error."
}
string
errorMessage
Required

A message describing the error.

string
errorCode
Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,
object
errorDetails
Optional

Dynamic error details, where the field name can vary depending on the request field and error code.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v2/roles