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

          • Get User Information
          • Batch Get User Information
          • Get User List
          • Get User External Identity Sources
          • Get User Role List
          • Get User Real-name Authentication Information
          • Delete User Real-name Authentication Information
          • Get User Department List
          • Set User Departments
          • Get Group List
          • Delete Users
          • Get User MFA Binding Information
          • Get Archived User List
          • Force User Logout
          • Check if User Exists
          • Create User
          • Batch Create Users
          • Update User Profile
          • Get User Accessible Applications
          • Get User Authorized Applications
          • Check if User Has Role
          • Get User Login History
          • Get Applications User Has Logged Into
          • Get Identity Sources User Has Logged Into
          • Get All Resources Authorized to User
        • Group Management

        • Role Management

        • Organization Management

        • 访问控制管理

        • 外部身份源管理

        • 自定义字段管理

    • Python

  • Framework Integration

  • Others

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

  8. /
  9. User Management

  10. /
  11. Check if User Has Role

¶ 判断用户是否有某个角色

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

通过用户 ID,判断用户是否有某个角色,支持传入多个角色,可以选择指定用户 ID 类型等。

¶ 请求参数

名称类型必填默认值描述示例值
rolesHasRoleRolesDto[]是-角色列表。
userIdstring是-用户 ID。6229ffaxxxxxxxxcade3e3d9
optionsHasAnyRoleOptionsDto否-可选参数。

¶ 示例代码

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.hasAnyRole({
    userId: "6229ffaxxxxxxxxcade3e3d9",
    roles: [
      {
        namespace: "default",
        code: "admin",
      },
    ],
    options: {
      userIdType: "user_id",
    },
  });
})();

¶ 请求响应

类型: HasAnyRoleRespDto

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

示例结果:

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "hasAnyRole": true
  }
}

¶ 数据结构

¶ HasRoleRolesDto

名称类型必填描述
namespacestring否所属权限分组的 code。 示例值: default
codestring是角色 code。 示例值: admin

¶ HasAnyRoleOptionsDto

名称类型必填描述
userIdTypestring否用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:user_id,external_id,phone,email,username

¶ HasAnyRoleDto

名称类型必填描述
hasAnyRoleboolean是是否拥有其中某一个角色。 示例值: true
Previous article: Get User Authorized Applications Next article: Get User Login History
  • 请求参数
  • 示例代码
  • 请求响应
  • 数据结构

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.