PATCH Users User Id
Modifies the settings of a user.
Request
URI
PATCH
https://{api_host}/api/v2/users/{userId}
COPY
Path Parameters
string
userId
Required
The unique identifier of the user.
Request Body
users.id.patch.request
of type(s)
application/json
Optional
{
"password": "NewPassword",
"email": "[email protected]",
"roleIds": [
"cbe3bd0e-6605-4586-ad97-0e322093630f",
"151d728e-042f-4b94-917e-00de3c6a5748"
]
}Responses
200
Successfully updated the users settings
Returns
users.response
of type(s)
application/json
{
"id": "de305d54-75b4-431b-adb2-eb6b9e546014",
"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_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"
}
],
"email": "[email protected]",
"type": "DEFAULT",
"authStatus": "ACTIVE",
"domain": "",
"upn": ""
}
400
Bad request
Returns
error
of type(s)
application/json
{
"errorMessage": "Some fields have incorrect values",
"errorCode": "FIELD_ERROR",
"errorDetails": {
"email": [
{
"errorCode": "com.vmware.loginsight.api.errors.field_value_doesnt_match_pattern",
"errorMessage": "Value doesn't match email pattern."
}
],
"password": [
{
"errorCode": "com.vmware.loginsight.api.errors.field_password_not_secure",
"errorMessage": "Password must have only visible ASCII characters including space, must be at least 8 characters long and contain one uppercase, one lowercase, one number and one special character."
}
]
}
}
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
Operation doesn't return any data structure
404
A user with the given identifier was not found.
Returns
error
of type(s)
application/json
{
"errorMessage": "Specified user does not exist.",
"errorCode": "RBAC_USERS_ERROR",
"errorDetails": {
"errorCode": "com.vmware.loginsight.api.errors.rbac.user_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 -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]'