PATCH Users User Id Password

PATCH Users User Id Password

Modifies the password or status of the user. If new password is provided, user will still be unlocked

Request
URI
PATCH
https://{api_host}/api/v2/users/{userId}/password
COPY
Path Parameters
string
userId
Required

The unique identifier of the user.

Request Body
users.id.password.patch.request of type(s) application/json
Optional 
{
    "password": "newPassword",
    "unlock": true
}
Authentication
This operation uses the following authentication methods.
Responses
200

Required parameters successfully updated

Operation doesn't return any data structure

400

Bad request

Returns error of type(s) application/json 
{
    "errorMessage": "Some fields have incorrect values",
    "errorCode": "FIELD_ERROR",
    "errorDetails": {
        "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.


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.


Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]'
On This Page
Users Operations
GET
GET Users
POST
POST Users
GET
GET Users Self Settings
PATCH
PATCH Users Self Settings
GET
GET Users User Id
DELETE
DELETE Users User Id
PATCH
PATCH Users User Id
PATCH
PATCH Users User Id Password