1. Development Integration
  2. /
  3. Standard Web Application
  4. /
  5. Node.js
  6. /

  7. Management Module

  8. /

  9. Role Management

  10. /
  11. Get Role List

获取角色列表

Update time: 2025-07-23 07:34:21
Edit

获取角色列表，支持分页。

请求参数

名称类型必填默认值描述示例值
namespacestring否default所属权限分组的 code。default
pagenumber否1当前页数，从 1 开始。1
limitnumber否10每页数目，最大不能超过 50，默认为 10。10

示例代码

import { ManagementClient } from "@genauth/nodejs";
// 在 Node.js 中引用：
// const { ManagementClient } = require('@genauth/nodejs');

const managementClient = new ManagementClient({
  accessKeyId: "GEN_AUTH_USERPOOL_ID",
  accessKeySecret: "GEN_AUTH_USERPOOL_SECRET",
});

(async () => {
  const result = await managementClient.listRoles({
    namespace: "default",

    page: 1,

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

请求响应

类型： RolePaginatedRespDto

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

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "list": {
      "code": "role1",
      "description": "this is description",
      "namespace": "default"
    }
  }
}

数据结构

RolePagingDto

名称类型必填描述
totalCountnumber是记录总数。
listarray是响应数据。嵌套类型：RoleDto。

RoleDto

名称类型必填描述
codestring是权限分组内角色的唯一标识符。 示例值： role1
descriptionstring是角色描述。 示例值： this is description
namespacestring是所属权限分组的 code。 示例值： default