GET Roles Role Id
Gets the details of a role.
Request
URI
GET
https://{api_host}/api/v1/roles/{roleId}
COPY
Path Parameters
string
roleId
Required
A GUID that uniquely identifies the role.
Responses
200
Successfully retrieved the role details.
Returns
roles.id.get.response
of type(s)
application/json
{
"id": "00000000-0000-0000-0000-000000000002",
"name": "User",
"description": "Can use Interactive Analytics and Dashboards",
"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_HOSTS"
},
{
"id": "VIEW_AGENTS"
},
{
"id": "VIEW_ALERTS"
},
{
"id": "VIEW_VROPS_INTEGRATION"
},
{
"id": "EDIT_INTERACTIVE_ANALYTICS"
},
{
"id": "VIEW_VSPHERE_INTEGRATION"
},
{
"id": "EDIT_SCHEDULED_REPORTS"
},
{
"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_SCHEDULED_REPORTS"
},
{
"id": "VIEW_SYSTEM_MONITOR"
},
{
"id": "VIEW_TIME_CONFIG"
},
{
"id": "VIEW_CLOUD_INTEGRATION"
},
{
"id": "VIEW_PROXY"
},
{
"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": [
{
"id": "97b7eeb7-9ebc-428c-b249-c3aefa983a0a",
"name": "index constraint",
"description": "desc test",
"type": "OR",
"constraints": [
{
"name": "_index",
"operator": "IN",
"value": "Default"
}
]
}
],
"required": true,
"editable": true
}
401
The request was refused because it lacks valid authentication
credentials. This can happen if the Authorization header
was missing, or if it contained an invalid session ID.
Obtain a new session ID and retry the request,
or make an unauthenticated request without the Authorization header.
"Invalid session ID"
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
The request was refused because the session ID has
expired. Obtain a new session ID from /api/v1/sessions.
"Login Timeout"Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/api/v1/roles/{roleId}
Roles Operations
GET
GET Roles
POST
POST Roles
GET
GET Roles Role Id
DELETE
DELETE Roles Role Id
PATCH
PATCH Roles Role Id
GET
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