1. 开发集成
  2. /
  3. 标准 Web 应用
  4. /
  5. Node.js
  6. /

  7. 管理模块

  8. /

  9. 角色管理

  10. /
  11. 获取角色详情

获取角色详情

更新时间: 2025-02-18 09:00:47
编辑

通过权限分组内角色 code，获取角色详情。

请求参数

名称类型必填默认值描述示例值
codestring是-权限分组内角色的唯一标识符。manager
namespacestring否-所属权限分组的 code。default

示例代码

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.getRole({

    code: 'manager',

    namespace: 'default',
 });
})();

请求响应

类型： RoleSingleRespDto

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

示例结果：

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

数据结构

RoleDto

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