获取用户组列表

接口描述

GET /v1/groups 获取用户组列表

请求头（Request Header）

参考认证（authentication）

请求参数（Request Parameters）

名称	位置	类型	必须	描述
filter	query	string	false	过滤条件
order_by	query	string	false	排序信息
page_size	query	integer(int32)	false	每页数量
page_token	query	string	false	分页标识

请求体（Request Body）

无

请求示例（Request Example）

curl --request GET \
  --url https://example.com/v1/groups \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {access-token}'

响应参数（Response Parameters）

Status	Meaning	Description	Schema
200	OK	OK	ListGroupsResponse

响应示例（Response Example）

200 Response

{
  "groups": [
    {
      "id": "string",
      "name": "string",
      "display_name": "string",
      "user_count": 0,
      "remark": "string",
      "create_time": "2019-08-24T14:15:22Z",
      "update_time": "2019-08-24T14:15:22Z",
      "join_time": "2019-08-24T14:15:22Z",
      "tenant_id": "string"
    }
  ],
  "next_page_token": "string",
  "total_size": 0
}

数据结构（Schemas）

Group

名称	类型	必须	限制	描述
id	string	false	none	用户组id
name	string	true	none	用户组名称
display_name	string	true	none	用户组显示名称
user_count	integer(int32)	false	none	用户组成员数
remark	string	false	none	备注
create_time	string(date-time)	false	read-only	用户组创建时间
update_time	string(date-time)	false	read-only	用户组更新时间
join_time	string(date-time)	false	read-only	某用户加入组的时间
tenant_id	string	false	none	租户id

ListGroupsResponse

名称	类型	必须	限制	描述
groups	[Group]	false	none	用户组列表
next_page_token	string	false	none	分页标识
total_size	integer(int32)	false	none	条目总数