Help Center/ OneAccess/ API Reference/ OneAccess APIs/ Management APIs/ User Management/ Changing a User Password
Updated on 2024-12-30 GMT+08:00
View PDF
Share

Changing a User Password

Function

This API is used to change a user password.

Constraints

null

URI

PUT /api/v2/tenant/users/{user_id}/change-password

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

user_id

Yes

String

User ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Set this field to "application/json;charset=utf8".

Authorization

Yes

String

Authentication credential. The value is "Bearer {access_token}". access_token is obtained by calling the API for obtaining an access credential.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

password

Yes

String

New password.

pwd_must_modify

No

Boolean

Whether the password must be changed upon the first login.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

user_id

String

User ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error details.

Example Requests

Modify the user password to 12345678 and not requiring password change upon first login.

PUT https://{domain_name}/api/v2/tenant/users/{user_id}/change-password

Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...

{
  "password":"12345678",
  "pwd_must_modify":false
}

Example Responses

Status code: 200

Request successful.

{
  "user_id" : "20210621095935811-5E16-6B3060..."
}

Status Codes

Status Code

Description

200

Request successful.

400

Invalid parameter.

Error Codes

See Error Codes.

Parent topic: User Management