修改用户组
功能介绍
该接口可以用于修改用户组信息。
URI
PUT /v5/groups/{group_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
group_id |
是 |
String |
用户组ID，长度为1到64个字符，只包含字母、数字和"-"的字符串。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
new_group_name |
否 |
String |
用户组名，长度为1到128个字符，可包含中文、英文、数字、空格、"_"、"-"、"{"和"}"的字符串。 |
|
new_group_description |
否 |
String |
用户组描述信息，长度为0到255字符，不能包含特定字符"@"、"#"、"%"、"&"、"<"、">"、"\"、"$"、"^"和"*"的字符串。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
group |
Group object |
用户组。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
group_id |
String |
用户组ID。 |
|
group_name |
String |
用户组名，长度为1到128个字符，可包含中文、英文、数字、空格、"_"、"-"、"{"和"}"的字符串。 |
|
created_at |
String |
用户组创建时间。 |
|
urn |
String |
统一资源名称。 |
|
description |
String |
用户组描述信息，长度为0到255字符，不能包含特定字符"@"、"#"、"%"、"&"、"<"、">"、"\"、"$"、"^"和"*"的字符串。 |
状态码：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。 |
请求示例
修改用户组信息。
PUT https://{endpoint}/v5/groups/{group_id}
{
"new_group_name" : "name",
"new_group_description" : "description"
}
响应示例
状态码：200
请求成功。
{
"group" : {
"group_id" : "string",
"group_name" : "name",
"created_at" : "2023-09-11T10:13:25.414Z",
"urn" : "iam::accountid:group:name",
"description" : "description"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
|
400 |
请求体异常。 |
|
403 |
没有操作权限。 |
|
404 |
未找到相应的资源。 |
|
409 |
请求冲突。 |
错误码
请参见错误码。
