PATCH Roles Role Id Users
Update the list of users to use the role
Request
URI
PATCH
https://{api_host}/api/v1/roles/{roleId}/users
COPY
Path Parameters
string
roleId
Required
A GUID that uniquely identifies the role.
Request Body
{
"usersToAdd": [
"bb6dc93e-81b6-42c0-9368-c1008850719d",
"fe170f99-d5e5-44ef-80e7-0d0d35a8b2ec"
],
"usersToRemove": [
"bb6dc93e-81b6-42c0-9368-c1008850719d",
"377fda5b-37b5-4819-b528-796f2a6d9e0b"
]
}
array of
string
usersToAdd
Optional
usersToAdd
array of
string
usersToRemove
Optional
usersToRemove
Responses
200
Successfully updated the list of users to use the role
Returns
Array of
string
of type(s)
application/json
[
{
"id": "fe170f99-d5e5-44ef-80e7-0d0d35a8b2ec",
"username": "johndoe",
"roleIds": [
"00000000-0000-0000-0000-000000000002"
],
"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_SCHEDULED_REPORTS"
},
{
"id": "VIEW_ALERTS"
},
{
"id": "VIEW_USER_DASHBOARDS"
},
{
"id": "EDIT_INTERACTIVE_ANALYTICS"
},
{
"id": "EDIT_SHARED_DASHBOARD_URLS"
},
{
"id": "EDIT_CONTENT_PACKS"
},
{
"id": "EDIT_SCHEDULED_REPORTS"
},
{
"id": "VIEW_EXTRACTED_FIELDS"
},
{
"id": "VIEW_EXPORT"
},
{
"id": "EDIT_SHARED_DASHBOARDS"
},
{
"id": "EDIT_EXTRACTED_FIELDS"
}
],
"email": "[email protected]",
"type": "DEFAULT",
"authStatus": "ACTIVE",
"domain": "",
"upn": ""
},
{
"id": "377fda5b-37b5-4819-b528-796f2a6d9e0b",
"username": "admin",
"roleIds": [
"00000000-0000-0000-0000-000000000001"
],
"capabilities": [
{
"id": "VIEW_SHARED_DASHBOARDS"
},
{
"id": "ANALYTICS"
},
{
"id": "VIEW_FORWARDING"
},
{
"id": "EDIT_ALERTS"
},
{
"id": "EDIT_PARTITIONS"
},
{
"id": "VIEW_GENERAL_CONFIG"
},
{
"id": "VIEW_SSL_CONFIG"
},
{
"id": "EDIT_ADMIN"
},
{
"id": "EDIT_USER_DASHBOARDS"
},
{
"id": "VIEW_HOSTS"
},
{
"id": "EDIT_HOSTS"
},
{
"id": "VIEW_AGENTS"
},
{
"id": "EDIT_SCHEDULED_REPORTS"
},
{
"id": "VIEW_AUTHENTICATION_CONFIG"
},
{
"id": "EDIT_SHARED_DASHBOARDS"
},
{
"id": "DASHBOARD"
},
{
"id": "VIEW_SHARED_DASHBOARD_URLS"
},
{
"id": "VIEW_WEBHOOK_CONFIG"
}
],
"email": "[email protected]",
"type": "DEFAULT",
"authStatus": "ACTIVE",
"domain": "",
"upn": ""
}
]
400
Invalid request body
Returns
error
of type(s)
application/json
{
"errorMessage": "Non existing user ID is specified in request.",
"errorCode": "RBAC_COMMON_ERROR",
"errorDetails": {
"errorCode": "com.vmware.loginsight.api.errors.rbac.wrong_user_id_specified"
}
}
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.
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 -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
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