GET Roles Role Id Capabilities

Gets the list of capabilities granted to the authentication provider directory group.

Request

URI

GET

https://{api_host}/api/v2/roles/{roleId}/capabilities

COPY

Path Parameters

string

roleId

Required

A GUID that uniquely identifies the role.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Successfully retrieved the authentication provider directory group's capabilities.

Returns roles.id.capabilities.response of type(s) application/json

[
    {
        "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"
    }
]

401

Operation doesn't return any data structure

404

A role with the given identifier was not found.

Returns error of type(s) application/json

{
    "errorMessage": "Specified role does not exist.",
    "errorCode": "RBAC_GROUPS_ERROR",
    "errorDetails": {
        "errorCode": "com.vmware.loginsight.api.errors.rbac.group_does_not_exist"
    }
}

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.

440

Operation doesn't return any data structure

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/v2/roles/{roleId}/capabilities

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Roles Operations

GET Roles Role Id Capabilities

PUT

PUT Roles Role Id Capabilities

PATCH

PATCH Roles Role Id Capabilities

GET

GET Roles Role Id Datasets

PUT

PUT Roles Role Id Datasets

PATCH

PATCH Roles Role Id Datasets

GET

GET Roles Role Id Users

PATCH

PATCH Roles Role Id Users