文档首页/ 统一身份认证服务 IAM/ API参考/ API/ 用户组管理/ 更新用户组
更新时间：2024-07-30 GMT+08:00
查看PDF
分享

更新用户组

功能介绍

该接口可以用于管理员更新用户组信息。

该接口可以使用全局区域的Endpoint和其他区域的Endpoint调用。IAM的Endpoint请参见：地区和终端节点。

调试

您可以在API Explorer中调试该接口。

URI

PATCH /v3/groups/{group_id}

表1 路径参数

参数

是否必选

参数类型

描述

group_id

是

String

待更新的用户组ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

该字段内容填为“application/json;charset=utf8”

X-Auth-Token

是

String

访问令牌，承载用户的身份、权限等信息。

token所需权限请参见授权项。
表3 请求Body参数

参数

是否必选

参数类型

描述

group

是

Object

用户组信息。
表4 group

参数

是否必选

参数类型

描述

description

否

String

用户组描述信息，长度小于等于255字符。name与description至少填写一个。

domain_id

否

String

用户组所属账号ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。

name

否

String

用户组名，长度1~128字符。name与description至少填写一个。

响应参数

表5 响应Body参数

参数

参数类型

描述

group

Object

用户组信息。
表6 group

参数

参数类型

描述

description

String

用户组描述信息。

id

String

用户组ID。

domain_id

String

用户组所属账号ID。

name

String

用户组名。

links

Object

用户组的资源链接信息。

create_time

Long

用户组创建时间。
表7 group.links

参数

参数类型

描述

self

String

资源链接地址。

请求示例

修改用户组的名称为“IAMGroup”，描述修改为“IAMDescription”。

PATCH https://iam.myhuaweicloud.com/v3/groups/{group_id}
{
    "group": {
        "description": "IAMDescription",
        "domain_id": "d78cbac186b744899480f25bd02...",
        "name": "IAMGroup"
    }
}

响应示例

状态码为 200 时:

请求成功。

{
    "group": {
        "description": "IAMDescription",
        "links": {
            "self": "https://iam.myhuaweicloud.com/v3/groups/077a4da48a00251f3f9dc0032103400f"
        },
        "id": "077a4da48a00251f3f9dc0032103400f",
        "create_time": 1578969360636,
        "domain_id": "d78cbac186b744899480f25bd...",
        "name": "IAMGroup"
    }
}

返回值

返回值

描述

200

请求成功。

400

参数无效。

401

认证失败。

403

没有操作权限。

404

未找到相应的资源。

409

资源冲突。

501

接口没有实现。

错误码

无

父主题： 用户组管理