Help Center/ Workspace/ API Reference/ Workspace APIs/ User/ Modifying User Information

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

View PDF

Modifying User Information

Function

Modify desktop user information.

Debugging

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

URI

PUT /v2/{project_id}/users/{user_id}

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

Request Parameters

**Table 2** 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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
description	No	String	User description.
user_email	No	String	User mailbox.
user_phone	No	String	Mobile number.
active_type	No	String	Activation type. The default value is USER_ACTIVATE. USER_ACTIVATE: activated by the user ADMIN_ACTIVATE: activated by the administrator
account_expires	No	String	Account expiration time. 0 indicates that the account never expires.
enable_change_password	No	Boolean	Indicates whether the password can be changed. true indicates that the password can be changed, and false indicates that the password cannot be changed.
next_login_change_password	No	Boolean	Indicates whether the password needs to be reset upon the next login. true indicates that the password needs to be reset, and false indicates that the password does not need to be reset.
password_never_expired	No	Boolean	Indicates whether the password never expires. true indicates that the password never expires, and false indicates that the password will expire.
disabled	No	Boolean	Indicates whether the account is disabled. true indicates that the account is disabled, and false indicates that the account is not disabled.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	User ID.

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.

Example Requests

PUT /v2/0bec5db98280d2d02fd6c00c2de791ce/users/8a2c3f9579d240820179d51e6caf0001

{
  "user_email" : "test@huawei.com",
  "description" : "API test user."
}

Example Responses

Status code: 200

Response to the request for modifying user information.

{
  "id" : "8a2c3f9579d240820179d51e6caf0001"
}

Status Codes

Status Code	Description
200	Response to the request for modifying user information.
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.