GenAuth DocsDocuments
Concepts
User Guide
Development Integration
AgentAuth
Metadata
Development Integration
Multi-tenant (beta)
Console Documentation
Multi-tenant Console
Tenant Console
Saas Application Demo
Concepts
User Guide
Development Integration
AgentAuth
Metadata
Development Integration
Multi-tenant (beta)
Console Documentation
Multi-tenant Console
Tenant Console
Saas Application Demo
Old version
  • Single Page Web Application

  • Mobile and Client Applications

  • Standard Web Application

    • Java

    • Node.js

      • Installation and Usage
      • User Authentication Module
      • Management Module

        • User Management

        • Group Management

        • Role Management

          • Get Role Details
          • Assign Role
          • Remove Assigned Role
          • Get Role Authorized Resource List
          • Get Role Member List
          • Get Role Department List
          • Create Role
          • Get Role List
          • Delete Role
          • Batch Create Roles
          • Modify Role
        • Organization Management

        • 访问控制管理

        • 外部身份源管理

        • 自定义字段管理

    • Python

  • Framework Integration

  • Others

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

  8. /
  9. Role Management

  10. /
  11. Get Role Details

¶ 获取角色详情

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

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

¶ 请求参数

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

¶ 示例代码

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.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
Previous article: Get Group Authorized Resource List Next article: Assign Role
  • 请求参数
  • 示例代码
  • 请求响应
  • 数据结构

User identity management

Integrated third-party login
Customized authentication process

Enterprise internal management

Single sign-on
Multi-factor authentication
Permission management

Developer

Development Documentation
GitHub (opens new window)

Company

official@genauth.ai
16th Floor, Building B, Beichen Century Center, Chaoyang District, Beijing (Total)
Room 406, 4th Floor, Block B, No. 200, Tianfu Fifth Street, High-tech Zone, Chengdu (Branch)

© Beijing Steamory Technology Co., Ltd.