Help Center/ Workspace/ API Reference/ Workspace APIs/ User/ Resetting a Random Password for a User

Updated on 2024-01-10 GMT+08:00

View PDF

Resetting a Random Password for a User

Reset the password for a user.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

GET /v2/{project_id}/users/{user_id}/random-password

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
user_id	Yes	String	User ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
notification_type	No	String	User notification mode. The options are email and phone, which are separated by commas (,). When activation by users is used, the notification mode must be contained so that the user can receive the password notification.

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	MIME type of the request body, for example, application/json.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
password	String	Password.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 405

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 503

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

GET /v2/0bec5db98280d2d02fd6c00c2de791ce/users/8a2c3f9579d240820179d51e6caf0001/random-password

Status code: 200

Normal.

{
  "password" : "xxcsafxxA%"
}

Status Code	Description
200	Normal.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	You do not have required permissions.
404	No resource found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.
503	The service is unavailable.