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

  7. 管理模块

  8. /

  9. 用户管理

  10. /
  11. 判断用户是否有某个角色

判断用户是否有某个角色

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

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

请求参数

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

示例代码

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.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