修改IAM用户信息
功能介绍
该接口可以用于修改IAM用户信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
PUT /v5/users/{user_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
user_id |
是 |
String |
IAM用户ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
new_user_name |
否 |
String |
IAM用户名，长度为1到64个字符，只包含字母、数字、"_"、"-"、"."和空格的字符串，且首位不能为数字。 |
|
new_description |
否 |
String |
IAM用户描述信息，长度为0到255个字符，不能包含特定字符"@"、"#"、"%"、"&"、"<"、">"、"\"、"$"、"^"和"*"的字符串。 |
|
enabled |
否 |
Boolean |
IAM用户是否启用。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user |
User object |
IAM用户。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
description |
String |
IAM用户描述信息，长度为0到255个字符，不能包含特定字符"@"、"#"、"%"、"&"、"<"、">"、"\"、"$"、"^"和"*"的字符串。 |
|
user_name |
String |
IAM用户名，长度为1到64个字符，只包含字母、数字、"_"、"-"、"."和空格的字符串，且首位不能为数字。 |
|
is_root_user |
Boolean |
IAM用户是否为根用户。 |
|
created_at |
String |
IAM用户创建时间。 |
|
user_id |
String |
IAM用户ID。 |
|
urn |
String |
统一资源名称。 |
|
enabled |
Boolean |
IAM用户是否启用。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
|
request_id |
String |
请求ID。 |
|
encoded_authorization_message |
String |
加密后的认证失败信息，可以通过STS5解密接口进行解密。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
|
request_id |
String |
请求ID。 |
状态码：409
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误信息。 |
|
request_id |
String |
请求ID。 |
请求示例
修改IAM用户信息。
PUT https://{endpoint}/v5/users/{user_id}
{
"new_user_name" : "name",
"new_description" : "description",
"enabled" : true
}
响应示例
状态码：200
请求成功。
{
"user" : {
"description" : "description",
"user_name" : "name",
"is_root_user" : false,
"created_at" : "2023-04-26T03:49:42Z",
"user_id" : "string",
"urn" : "iam::accountid:user:name",
"enabled" : true,
"tags" : [ {
"tag_key" : "key",
"tag_value" : "value"
} ]
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
|
400 |
请求体异常。 |
|
403 |
没有操作权限。 |
|
404 |
未找到相应的资源。 |
|
409 |
请求冲突。 |
错误码
请参见错误码。
