Changing the password of the user

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request changes the password of a user account that performs operations on the storage system resources. The password cannot be changed for the user who is authorized by the external authentication server.
Note:

If you locked any resources of the target storage system by using the REST API, you will not be able to use this API function. In such cases, unlock the resources before running the API function.

Execution permission

Security Administrator (View & Modify)

Request line

PATCH base-URL/v1/objects/users/object-ID

Request message

Object ID

Specify the userObjectId value obtained by getting information about the user.

Attribute

Type

Description

userObjectId

string

(Required) Object ID of the user ID

The name is case sensitive.

Query parameters

None.

Body
{
  "userPassword":"userPass"
}

Attribute

Type

Description

userPassword

string

(Required) New password

For details about the number of characters that can be specified for passwords and the characters that can be used, see the description about input rules for user IDs and passwords.

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

Attribute

Description

affectedResources

URL of the user whose password was changed

Action template

None.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X PATCH https://192.0.2.100/ConfigurationManager/v1/objects/users/devUser