Modifying IAM User Information (Recommended)

Function

This API is provided for the administrator to modify IAM user information.

The API can be called using both the global endpoint and region-specific endpoints. For IAM endpoints, see Regions and Endpoints.

URI

PUT /v3.0/OS-USER/users/{user_id}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
user_id	Yes	String	IAM user ID. For details about how to obtain a user ID, see Obtaining Account, IAM User, Group, Project, Region, and Agency Information.

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Fill application/json;charset=utf8 in this field.
X-Auth-Token	Yes	String	Token with Security Administrator permissions.

**Table 3** Parameters in the request body
Parameter	Mandatory	Type	Description
user	Yes	Object	IAM user information.

**Table 4** user
Parameter	Mandatory	Type	Description
name	No	String	New IAM user name, which consists of 1 to 32 characters. It can contain letters, digits, spaces, hyphens (-), underscores (_), and periods (.) and cannot start with a digit or space.
password	No	String	Password of the user. The password must meet the following requirements: Can contain 6 to 32 characters. The default minimum password length is 6 characters. Must contain at least two of the following character types: uppercase letters, lowercase letters, digits, and special characters. Must meet the password requirements defined in the password policy. Must be different from the old password.
email	No	String	Email address, which can contain not more than 255 characters.
areacode	No	String	Country code. The country code must be used together with a mobile number.
phone	No	String	New mobile number, which can contain a maximum of 32 digits. The mobile number must be used together with a country code.
enabled	No	Boolean	Enabling status of the IAM user. true (default value) indicates that the user is enabled. false indicates that the user is disabled.
pwd_status	No	Boolean	Password status. true means that the password needs to be changed, and false means that the password is normal.
xuser_type	No	String	Type of the IAM user in the external system. The user type can contain a maximum of 64 characters. xuser_type must be used together with xuser_id and will be verified based on xaccount_type and xdomain_type of the same account. NOTE: An external system refers to an enterprise management system connected to Huawei Cloud. Parameters xaccount_type, xaccount_id, xdomain_type, xdomain_id, xuser_type, and xuser_id cannot be obtained from Huawei Cloud. Please contact your enterprise administrator.
xuser_id	No	String	ID of the IAM user in the external system. The user ID can contain a maximum of 128 characters, and must be used together with xuser_type. Due to the latency, the IAM console may not be able to display the external identity ID you have set in real time. Refresh the page later. NOTE: An external system refers to an enterprise management system connected to Huawei Cloud. Parameters xaccount_type, xaccount_id, xdomain_type, xdomain_id, xuser_type, and xuser_id cannot be obtained from Huawei Cloud. Please contact your enterprise administrator.
access_mode	No	String	Access type of the IAM user. default: programmatic access and management console access. This option is the default access type. programmatic: programmatic access console: management console access
description	No	String	Description of the IAM user.

Response Parameters

**Table 5** Parameters in the response body
Parameter	Type	Description
user	Object	IAM user information.

**Table 6** user
Parameter	Type	Description
pwd_status	Boolean	Password status. true means that the password needs to be changed, and false means that the password is normal.
xuser_id	String	ID of the IAM user in the external system. NOTE: An external system refers to an enterprise management system connected to Huawei Cloud. Parameters xaccount_type, xaccount_id, xdomain_type, xdomain_id, xuser_type, and xuser_id cannot be obtained from Huawei Cloud. Please contact your enterprise administrator.
xuser_type	String	Type of the IAM user in the external system. NOTE: An external system refers to an enterprise management system connected to Huawei Cloud. Parameters xaccount_type, xaccount_id, xdomain_type, xdomain_id, xuser_type, and xuser_id cannot be obtained from Huawei Cloud. Please contact your enterprise administrator.
access_mode	String	Access type of the IAM user. default: programmatic access and management console access. This option is the default access type. programmatic: programmatic access console: management console access
description	String	Description of the IAM user.
name	String	New IAM user name, which consists of 1 to 32 characters. It can contain letters, digits, spaces, hyphens (-), underscores (_), and periods (.) and cannot start with a digit or space.
phone	String	New mobile number, which can contain a maximum of 32 digits. The mobile number must be used together with a country code.
domain_id	String	ID of the account to which the IAM user belongs.
enabled	Boolean	Enabling status of the IAM user. true (default value) indicates that the user is enabled. false indicates that the user is disabled.
areacode	String	Country code.
email	String	New email address.
id	String	IAM user ID.
links	Object	IAM user resource link information.
password_expires_at	String	Password expiration time. This parameter will not be returned if its value is null. NOTE: The value is a UTC time in the YYYY-MM-DDTHH:mm:ss.ssssssZ format, for example, 2023-06-28T08:56:33.710000Z. For details about the date and timestamp formats, see ISO-8601.

**Table 7** user.links
Parameter	Type	Description
self	String	Resource link.

Example Request

Request for an administrator to modify information of an IAM user named IAMUser: change the email address to IAMEmail@huawei.com, the mobile number to 085212345678910, and the password to IAMPassword@

PUT https://iam.myhuaweicloud.com/v3.0/OS-USER/users/{user_id}

{
    "user": {
        "email": "IAMEmail@huawei.com",
        "areacode": "0852",
        "phone": "12345678910",
        "enabled": true,
        "name": "IAMUser",
        "password": "IAMPassword@",
        "pwd_status": false,
        "xuser_type": "",
        "xuser_id": "",
        "access_mode" : "default",
        "description": "IAMDescription"
    }
}

Example Response

Status code: 200

The request is successful.

{
    "user": {
        "description": "IAMDescription",
        "areacode": "0852",
        "enabled": true,
        "pwd_status": false,
        "xuser_id": "",
        "access_mode" : "default",
        "domain_id": "d78cbac186b744899480f25bd0...",
        "phone": "12345678910",
        "name": "IAMUser",
        "links": {
            "self": "https://iam.myhuaweicloud.com/3.0/OS-USER/users/076934ff9f0010cd1f0bc003..."
        },
        "id": "076934ff9f0010cd1f0bc0031019...",
        "xuser_type": "",
        "email": "IAMEmail@huawei.com"
    }
}

Status Codes

Status Code	Description
200	The request is successful.
400	Invalid parameters.
401	Authentication failed.
403	Access denied.
404	The requested resource cannot be found.
405	The method specified in the request is not allowed for the requested resource.
409	A resource conflict occurs.
413	The request entity is too large.
500	Internal server error.
503	Service unavailable.