¶ 获取分组列表

更新时间: 2024-10-10 07:28:40

获取分组列表，支持分页。

¶ 请求参数

名称	类型	必填	默认值	描述	示例值
page	number	否	1	当前页数，从 1 开始。	`1`
limit	number	否	10	每页数目，最大不能超过 50，默认为 10。	`10`

¶ 示例代码

import { ManagementClient } from 'authing-node-sdk';
// 在 Node.js 中引用：
// const { ManagementClient } = require('authing-node-sdk');

const managementClient = new ManagementClient({
  accessKeyId: 'AUTHING_USERPOOL_ID',
  accessKeySecret: 'AUTHING_USERPOOL_SECRET',
});

(async () => {
  const result = await managementClient.listGroups({

    page: 1,

    limit: 10,
 });
})();

¶ 请求响应

类型： GroupPaginatedRespDto

名称	类型	描述
statusCode	number	业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。
message	string	描述信息
apiCode	number	细分错误码，可通过此错误码得到具体的错误类型。
data	GroupPagingDto	响应数据

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "list": {
      "code": "developer",
      "name": "开发者",
      "description": "描述内容"
    }
  }
}

¶ 数据结构

¶ GroupPagingDto

名称	类型	必填	描述
totalCount	number	是	记录总数。
list	array	是	响应数据。嵌套类型：ResGroupDto。

¶ ResGroupDto

名称	类型	必填	描述
code	string	是	分组 code。示例值： `developer`
name	string	是	分组名称。示例值： `开发者`
description	string	是	分组描述。示例值： `描述内容`