Authing 文档文档
快速开始
概念
使用指南
开发集成 V2 arrow
  • V2 文档
  • V3 文档
应用集成
加入 APN
开发集成
多租户(内测版)
控制台文档
多租户控制台
租户控制台
Saas 应用 Demo
快速开始
概念
使用指南
开发集成 V2 arrow
  • V2 文档
  • V3 文档
应用集成
加入 APN
开发集成
多租户(内测版)
控制台文档
多租户控制台
租户控制台
Saas 应用 Demo
旧版
开发集成
  • JavaScript SDK 索引
  • 单点登录(SSO)
  • 登录组件 (Guard)

  • JavaScript / Node.js

    • 用户认证模块

    • 管理模块

      • 管理用户
      • 管理应用
      • 管理策略
      • 管理角色
      • 管理资源与权限
      • 管理分组
      • 管理组织机构
      • 管理用户自定义字段
      • 管理日志统计信息
      • 管理注册白名单
      • 管理用户池配置
      • 管理 MFA
      • 管理主体认证
      • 管理多租户
  • Java / Kotlin

  • Python

  • C#

  • PHP

  • Go

  • Ruby
  • Delphi
  • Android

  • iOS

  • Flutter

  • 微信小程序
  • 微信网页授权
  • React Native
  • 框架集成

  • Radius
  • 错误代码
  1. 开发集成
  2. /
  3. JavaScript / Node.js
  4. /
  5. 管理模块
  6. /
  7. 管理策略

¶ 管理策略

更新时间: 2022-10-10 11:16:11
编辑

Authing 的访问控制与权限管理模型核心围绕着两个点来设计:资源(Resource)和策略(Policy)。策略定义了对某个(类)资源的某个(些)操作权限,将策略授权给用户(或角色),就能知道用户(或角色)是否具备对某个资源的某个操作具备操作权限。

请使用以下方式使用该模块:

import { ManagementClient } from "authing-js-sdk";
const managementClient = new ManagementClient({
  userPoolId: "YOUR_USERPOOL_ID",
  secret: "YOUR_USERPOOL_SECRET",
});
managementClient.policies.list; // 获取策略列表
managementClient.policies.create; // 创建策略
managementClient.policies.listUsers; // 获取策略授权记录

¶ 添加策略

添加策略

PoliciesManagementClient().create({code,statements,description,namespace})

¶ 参数

  • code <string> 策略唯一标志
  • statements <PolicyStatement[]>
  • description <string> 描述
  • namespace <string> 权限分组

¶ 示例

import { PolicyEffect } from "authing-js-sdk";

const statements = [
  {
    resource: "books:123",
    effect: PolicyEffect.Allow,
    actions: ["books:edit"],
  },
];

const policy = await managementClient.policies.create(code, statements);

¶ 返回值

  • Promise<DeepPartial<Policy>>

¶ 删除策略

删除策略,系统内置策略由 Authing 官方维护,不能修改和删除。

PoliciesManagementClient().delete(code)

¶ 参数

  • code <string> 策略唯一标志

¶ 示例

const { code, message } = await managementClient.policies.delete("CODE"); // 通过 code 是否为 200 判断操作是否成功

¶ 返回值

  • Promise<CommonMessage>

¶ 批量删除策略

批量删除策略,系统内置策略由 Authing 官方维护,不能修改和删除。

PoliciesManagementClient().deleteMany(codeList)

¶ 参数

  • codeList <string> 策略唯一标志列表

¶ 示例

const { code, message } = await managementClient.policies.deleteMany(["CODE"]); // 通过 code 是否为 200 判断操作是否成功

¶ 返回值

  • Promise<CommonMessage>

¶ 修改策略

修改策略,系统内置策略由 Authing 官方维护,不能修改和删除。

PoliciesManagementClient().update(code, updates)

¶ 参数

  • code <string> 策略唯一标志
  • updates <object>
  • updates.description <string> 描述
  • updates.statements <PolicyStatement[]>
  • updates.newCode <string> 新的唯一标志,如果传入,需要保证其在用户池内是唯一的。

¶ 示例

const policy = await managementClient.policies.update("CODE", {
  newCode: "NEWCODE",
});

¶ 返回值

  • Promise<DeepPartial<Policy>>

¶ 获取策略详情

获取策略详情

PoliciesManagementClient().detail(code)

¶ 参数

  • code <string> 策略唯一标志

const policy = await managementClient.policies.detail('CODE');

¶ 示例

¶ 返回值

  • Promise<DeepPartial<Policy>>

¶ 获取策略列表

获取策略列表

PoliciesManagementClient().list(options)

¶ 参数

  • options <object>
  • options.page <number> 默认值为 : 1。
  • options.limit <number> 默认值为 : 10。
  • options.excludeDefault <boolean> 是否排除系统默认资源 默认值为 : true。

¶ 示例

const { list, totalCount } = await managementClient.policies.list({
  excludeDefault: false, // 包含系统默认的策略
});

¶ 返回值

  • Promise<DeepPartial<PaginatedPolicies>>

¶ 获取策略授权记录

获取策略授权记录

PoliciesManagementClient().listAssignments(code, page, limit)

¶ 参数

  • code <string> 策略唯一标志
  • page <number> 默认值为 : 1。
  • limit <number> 默认值为 : 10。

¶ 示例

const { totalCount, list } = await managementClient.policies.listAssignments(
  "CODE"
);

// list 数据示例

[
  {
    code: "PolicyCode", // 策略唯一标志
    targetType: "USER", // 'USER' 表示用户, 'ROLE' 表示角色
    targetIdentifier: "5f8812866795cc0026352fc5", // 用户 ID 或者角色 code
  },
  {
    code: "PolicyCode", // 策略唯一标志
    targetType: "ROLE", // 'USER' 表示用户, 'ROLE' 表示角色
    targetIdentifier: "ROLE_CODE", // 用户 ID 或者角色 code
  },
];

¶ 返回值

  • Promise<PaginatedPolicyAssignments>

¶ 将策略授权给用户、角色、分组、组织机构

将策略授权给用户、角色、分组、组织机构,可以将策略授权给用户和角色,授权给角色的策略会被该角色下的所有用户继承 。此接口可以进行批量操作。

PoliciesManagementClient().addAssignments(policies, targetType, targetIdentifiers)

¶ 参数

  • policies <string[]> 策略 code 列表
  • targetType <PolicyAssignmentTargetType> 可选值为 USER (用户) 和 ROLE (角色)
  • targetIdentifiers <string[]> 用户 id 列表和角色 code 列表

¶ 示例

import { PolicyAssignmentTargetType } from "authing-js-sdk";

await managementClient.policies.addAssignments(
  ["code1", "code2"],
  PolicyAssignmentTargetType.User,
  ["60b4a136d9xxxxcc3d87e55a"]
);

await managementClient.policies.addAssignments(
  ["code1", "code2"],
  PolicyAssignmentTargetType.Role,
  ["ROLE_CODE"]
);

¶ 返回值

  • Promise<CommonMessage>

¶ 撤销策略授权

撤销策略授权,此接口可以进行批量操作。

PoliciesManagementClient().removeAssignments(policies, targetType, targetIdentifiers)

¶ 参数

  • policies <string[]> 策略 code 列表
  • targetType <PolicyAssignmentTargetType> 可选值为 USER (用户) 和 ROLE (角色)
  • targetIdentifiers <string[]> 用户 id 列表和角色 code 列表

¶ 示例

import { PolicyAssignmentTargetType } from "authing-js-sdk";

await managementClient.policies.removeAssignments(
  ["code1", "code2"],
  PolicyAssignmentTargetType.User,
  ["60b4a136d9xxxxcc3d87e55a"]
);

await managementClient.policies.removeAssignments(
  ["code1", "code2"],
  PolicyAssignmentTargetType.Role,
  ["ROLE_CODE"]
);

¶ 返回值

  • Promise<CommonMessage>
上一篇: 管理应用 下一篇: 管理角色
  • 添加策略
  • 删除策略
  • 批量删除策略
  • 修改策略
  • 获取策略详情
  • 获取策略列表
  • 获取策略授权记录
  • 将策略授权给用户、角色、分组、组织机构
  • 撤销策略授权

用户身份管理

集成第三方登录
手机号闪验 (opens new window)
通用登录表单组件
自定义认证流程

企业内部管理

单点登录
多因素认证
权限管理

开发者

开发文档
框架集成
博客 (opens new window)
GitHub (opens new window)
社区用户中心 (opens new window)

公司

400 888 2106
sales@authing.cn
北京市朝阳区北辰世纪中心 B 座 16 层(总)
成都市高新区天府五街 200 号 1 号楼 B 区 4 楼 406 室(分)

京ICP备19051205号

beian京公网安备 11010802035968号

© 北京蒸汽记忆科技有限公司