Authing 文档

# 组织机构管理

# 开始前请阅读

接入组织机构管理

# 初始化

使用以下接口时，请先完成初始化工作，请参考：

Authing - Node/JavaScript

# 创建组织机构

在 Authing 中，组织机构树中的每个节点对应一个 Group。如在创建组织机构时，需要指定根节点对应 Group 的 ID，即需要先创建 Group 再创建节点。

Authing.org.createOrg(input)

  • 参数：
    • input: <Object>
      • rootGroupId：<string> 必填，根节点 Group ID（每个节点对应一个 Group）。
  • 使用方法
const root = await authing.authz.createGroup({
  name: "非凡科技有限公司",
  description: "非凡科技有限公司",
});
const org = await authing.org.createOrg({
  rootGroupId: root._id,
});
  • 返回数据
    • _id: 组织结构 ID
    • nodes: 组织机构节点列表
      • _id: Group ID
      • children: Array<String> 子节点 Group ID
      • root: <boolean> 是否为根节点
    • tree: 组织结构树状结构
      • _id: Group ID
{
  "_id": "5e355dd1af15ce8b5cc39386",
  "nodes": [
    {
      "_id": "5e355dd1af15ce8b5cc39385",
      "children": [],
      "createdAt": "2020-02-01T19:15:29+08:00",
      "description": "描述信息",
      "name": "分组58kb1ly6je3",
      "root": true,
      "updatedAt": "2020-02-01T19:15:29+08:00"
    }
  ],
  "tree": {
    "_id": "5e355dd1af15ce8b5cc39385",
    "children": [],
    "createdAt": "2020-02-01T19:15:29+08:00",
    "description": "描述信息",
    "name": "分组58kb1ly6je3",
    "root": true,
    "updatedAt": "2020-02-01T19:15:29+08:00"
  }
}

# 添加节点

一个组织机构是一棵树，其每个节点对应一个 Group。

Authing.org.addNode(input)

  • 参数
    • input <Object>
      • orgId: 必填，组织机构 ID
      • groupId: 必填，该节点对应 Group ID
      • parentGroupId: 必填，父节点对应 Group ID
  • 使用方法
const org = await authing.org.addNode({
  orgId: "组织机构 ID",
  parentGroupId: "父节点对应 Group ID",
  groupId: "该节点对应 Group ID",
});
  • 返回数据：同创建组织机构接口。

# 删除节点

Authing.org.removeNode(input)

  • 参数
    • input <Object>
      • orgId: 必填，组织机构 ID
      • groupId: 必填，节点对应的 group ID
  • 使用方法
let org = await authing.org.removeNode({
  orgId: "xxx",
  groupId: "xxxx",
});
  • 返回参数：同创建组织机构接口。

# 删除组织机构

Authing.org.dropById(_id)

  • 参数
    • _id: 组织结构 ID
  • 使用方法
const res = await authing.org.dropById(org._id);
  • 返回数据
{
  "code": 200,
  "message": "操作成功！"
}

# 查询组织机构 - 通过 ID

Authing.org.findById(_id)

  • 参数
    • _id: 组织机构 ID
  • 使用方法
const org = await authing.org.findById(org._id);
  • 返回参数：同创建组织机构接口。

# 查询用户池所有组织机构

Authing.org.all()

  • 参数：无
  • 使用方法
const { totalCount, list: orgs } = await authing.org.all();
  • 返回数据
    • totalCount: 组织机构总数。
    • list: 组织机构列表，其中的元素为一个组织结构，具体见创建组织机构方法。

# 判断某节点是否为根节点

Authing.org.isRootNode(input)

  • 参数
    • input: <Object>
      • orgId: 组织机构 ID
      • groupId: Group ID
  • 使用方法
const isRoot = await authing.org.isRootNode({
  groupId: "xxx",
  orgId: "xxx",
});
  • 返回数据：布尔值。

# 查询某组织机构的根节点

Authing.org.rootNode(_id)

  • 参数
    • _id: 组织机构 ID
  • 使用方法
const group = await authing.org.rootNode(org._id);
  • 返回数据：根节点对应的 Group
{
  "_id": "5e356424004e528e9c834f8a",
  "createdAt": "2020-02-01T19:42:28+08:00",
  "description": "非凡技术有限公司",
  "name": "非凡技术有限公司",
  "updatedAt": "2020-02-01T19:42:28+08:00"
}

# 查询某节点的子节点列表

Authing.org.childrenNodes(input)

  • 参数
    • input: <Object>
      • orgId: 组织机构 ID
      • groupId: Group ID
  • 使用方法
const children = await authing.org.childrenNodes({
  orgId: "xxx",
  groupId: "xxx",
});
  • 返回数据, 列表元素含义：
    • depth: 距该节点的深度，1 表示为直接子节点。
    • group: 子节点对应的 Group
[
  {
    "depth": 1,
    "group": {
      "_id": "5e356242af15ce8b5cc393bd",
      "createdAt": "2020-02-01T19:34:26+08:00",
      "description": "描述信息",
      "name": "分组sxvtd3unrxe",
      "updatedAt": "2020-02-01T19:34:26+08:00"
    }
  },
  {
    "depth": 1,
    "group": {
      "_id": "5e356243af15ce8b5cc393c0",
      "createdAt": "2020-02-01T19:34:27+08:00",
      "description": "描述信息",
      "name": "分组04h9vdiee0vd",
      "updatedAt": "2020-02-01T19:34:27+08:00"
    }
  }
]

# 搜索节点下的用户

Authing.org.searchUser(input)

  • 参数

    • input: <Object>
      • orgId: 组织机构 ID
      • nodeId: 节点 ID
      • query: 查询字符串
      • includeChildrenNodes: 布尔值，是否一起搜索子部门的用户，默认为 false

  • 使用方法

    const users = await authing.org.searchUser({
  orgId: "xxx",
  nodeId: "xxx",
  query: "王",
  includeChildrenNodes: true,
});

  • 返回数据

{
  totalCount: 222,
  list: [
    {
      "_id": "59e5ff4935eebf1913cfe8a1",
      "email": "86700229ww6ss@163.com",
      "emailVerified": false,
      "username": "86700229ww6ss@163.com",
      "nickname": "",
      "company": "",
      "photo": "http://www.xiaohehe.net/uploads/allimg/150305/304-1503051H136.png",
      "browser": "",
      "token": null,
      "tokenExpiredAt": null,
      "loginsCount": 0,
      "lastLogin": "Tue Oct 17 2017 21:02:01 GMT+0800 (CST)",
      "lastIP": null,
      "signedUp": "Tue Oct 17 2017 21:02:01 GMT+0800 (CST)",
      "blocked": false,
      "isDeleted": false,
      "group": {
        "_id": "59e374332023830871913ebd",
        "name": "default",
        "descriptions": "default",
        "createdAt": "Sun Oct 15 2017 22:44:03 GMT+0800 (CST)"
      }
   },
          ...
  ]
}

← 老版权限控制（deprecated） →