更新时间:2024-07-25 GMT+08:00

查询用户组列表

功能介绍

该接口提供查询用户组信息的功能。

URI

  • URI格式

    GET /v3/groups{?domain_id,name}

  • 查询参数说明

    属性

    是否必选

    类型

    说明

    domain_id

    String

    用户组所在domain的ID。

    name

    String

    用户组的名称,长度小于等于64字符。

请求

  • Request Header参数说明

    参数

    是否必选

    类型

    说明

    Content-Type

    String

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

    X-Auth-Token

    String

    已认证的拥有Security Administrator权限的token。

  • 请求样例
    curl -i -k -H "X-Auth-Token:$token" -H 'Content-Type:application/json;charset=utf8' -X GET https://sample.domain.com/v3/groups?domain_id=ac7197fd67a24dc5850972854729a762&name=group123

响应

  • Response Body参数说明

    参数

    是否必选

    类型

    说明

    links

    JSONObject

    用户组的资源链接。

    groups

    JSONArray

    用户组列表。

  • group参数说明

    参数

    是否必选

    类型

    说明

    description

    String

    用户组的描述。

    domain_id

    String

    用户组所属domain的ID。

    id

    String

    用户组的ID。

    links

    JSONObject

    用户组的资源链接。

    name

    String

    用户组的名称。

    create_time

    Long

    用户组创建的时间。

  • 响应样例
    {
        "links": {
            "self": "https://sample.domain.com/v3/groups?domain_id=ac7197fd67a24dc5850972854729a762&name=group123",
            "previous": null,
            "next": null
        },
        "groups": [{
            "description": "",
            "links": {
                "self": "https://sample.domain.com/v3/groups/ff74abaeabe34c278a4b7693c7f0dff7"
            },
            "id": "ff74abaeabe34c278a4b7693c7f0dff7",
            "create_time": 1482566254983,
            "domain_id": "ac7197fd67a24dc5850972854729a762",
            "name": "group123"
        }]
    }

状态码

状态码

说明

200

请求成功。

400

参数无效。

401

认证失败。

403

没有操作权限。