¶ 管理组织机构
更新时间: 2025-08-20 12:33:28
一个 Authing 用户池可以创建多个组织机构。此模块用于管理 Authing 组织机构，可以进行组织机构的增删改查、添加删除移动节点、导入组织机构等操作。
请使用以下方式使用该模块：
use Authing\Mgmt\ManagementClient;
$manageClient = new ManagementClient('YOUR_USERPOOL_ID', 'YOUR_USERPOOL_SECRET');
$orgManagementClient = $managementClient->orgs();
$orgManagementClient->list // 获取用户池组织机构列表
$orgManagementClient->moveNode // 获取组织机构详情
$orgManagementClient->listMembers // 获取节点用户列表
¶ 创建组织机构
OrgManagementClient->create(string $name, string $description, string $code)
创建组织机构，会创建一个只有一个节点的组织机构。 如果你想将一个完整的组织树导入进来，请使用 importByJson 方法。
¶ 参数
name<string> 组织机构名称，该名称会作为该组织机构根节点的名称。description<string> 根节点描述code<string> 根节点唯一标志，必须为合法的英文字符。
¶ 示例
$orgManagementClient->create(
'北京某某公司',
'北京某某公司有限公司',
'example'
);
¶ 删除组织机构
OrgManagementClient->deleteById(string $id)
删除组织机构树
¶ 参数
id<string> 组织机构 ID
¶ 示例
¶ 获取用户池组织机构列表
OrgManagementClient->paginate(int $page = 1, int $limit = 10)
获取用户池组织机构列表
¶ 参数
page<number> 默认值为 :1。limit<number> 默认值为 :10。
¶ 示例
$data = $orgManagementClient->paginate();
¶ 示例数据
null
¶ 添加节点
OrgManagementClient->addNode(string $orgId, string $parentNodeId, array $data)
在组织机构中添加一个节点
¶ 参数
orgId<string> 组织机构 IDparentNodeId<string> 父节点 IDdata<array> 节点数据data.name<string> 节点名称data.code<string> 节点唯一标志data.description<string> 节点描述信息
¶ 示例
$orgManagementClient->addNode(orgId, parentNodeId, [
'name' => '运营部门'
]);
¶ 获取某个节点详情
OrgManagementClient->getNodeById(string $id)
获取节点数据
¶ 参数
id<string> 节点 ID
¶ 示例
$orgManagementClient->getNodeById('NDOEID');
¶ 移动成员到指定节点
OrgManagementClient->moveMembers(array $options)
移动成员节点
¶ 参数
options['userIds']<string[]> 用户 ID 集合options['sourceNodeId']<string> 源节点 IDoptions['targetNodeId']<string> 目标节点 ID
¶ 示例
$orgManagementClient->moveMembers(['userIds' => ['userId'],
'sourceNodeId' => 'sourceNodeId',
'targetNodeId' => 'targetNodeId']);
¶ 模糊搜索组织节点
OrgManagementClient->searchNodes(string $keywords)
搜索组织节点
¶ 参数
keywords<string> 关键字
¶ 示例
$orgManagementClient->searchNodes(‘keywords’);
¶ 修改节点
OrgManagementClient->updateNode(string $id, array $updates)
修改节点数据
¶ 参数
id<string> 节点 IDupdates<array> 修改数据updates.name<string> 节点名称updates.code<string> 节点唯一标志updates.description<string> 节点描述信息
¶ 示例
$orgManagementClient->updateNode('NDOEID', [
'name': '新的节点名称',
]);
¶ 获取组织机构详情
OrgManagementClient->findById(string $id)
通过组织机构 ID 获取组织机构详情
¶ 参数
id<string> 组织机构 ID
¶ 示例
$data = $orgManagementClient->findById(id)
¶ 删除节点
OrgManagementClient->deleteNode(string $orgId, string $nodeId)
删除组织机构树中的某一个节点
¶ 参数
orgId<string> 组织机构 IDnodeId<string> 节点 ID
¶ 示例
$orgManagementClient->deleteNode(orgId, rootNode.id)
¶ 移动节点
OrgManagementClient->moveNode(string $orgId, string $nodeId, string $targetParentId)
移动组织机构节点，移动某节点时需要指定该节点新的父节点。注意不能将一个节点移动到自己的子节点下面。
¶ 参数
orgId<string> 组织机构 IDnodeId<string> 需要移动的节点 IDtargetParentId<string> 目标父节点 ID
¶ 示例
$orgManagementClient->moveNode('ORGID', 'NODEID', 'TRAGET_NODE_ID')
¶ 判断是否为根节点
OrgManagementClient->isRootNode(string $orgId, string $nodeId)
判断一个节点是不是组织树的根节点
¶ 参数
orgId<string> 组织机构 IDnodeId<string> 组织机构 ID
¶ 示例
¶ 获取子节点列表
OrgManagementClient->listChildren(string $orgId, string $nodeId)
查询一个节点的子节点列表
¶ 参数
orgId<string> 组织机构 IDnodeId<string> 组织机构 ID
¶ 示例
// 子节点列表
$orgManagementClient->listChildren("ORGID", "NODEID")
¶ 获取根节点
OrgManagementClient->rootNode(string $orgId)
获取一个组织的根节点
¶ 参数
orgId<string> 组织机构 ID
¶ 示例
$orgManagementClient->rootNode('ORGID')
¶ 通过 JSON 导入
OrgManagementClient->importByJson(string $json)
通过一个 JSON 树结构导入组织机构
¶ 参数
json<Object> JSON 格式的树结构，详细格式请见示例代码。
¶ 示例
$tree = (object)[
'name'=> '北京某某公司有限公司',
'code'=> 'example',
'children': [
(object)[
'code'=> 'operation',
'name'=> '运营',
'description'=> '商业化部门',
],
(object)[
'code'=> 'dev',
'name'=> '研发',
'description'=> '研发部门',
'children'=> [
(object)[
'code'=> 'backend',
'name'=> '后端',
'description'=> '后端研发部门',
],
],
],
],
];
$orgManagementClient->importByJson(tree)
¶ 添加成员
OrgManagementClient->addMembers(string $nodeId, array $userIds)
节点添加成员
¶ 参数
nodeId<string> 节点 IDuserIds<string[]> 用户 ID 列表
¶ 示例
$orgManagementClient->addMembers("NODE_ID", ["USER_ID"])
¶ 获取节点成员
OrgManagementClient->listMembers(string $nodeId, array $options = []);
获取节点成员，可以获取直接添加到该节点中的用户，也可以获取到该节点子节点的用户。
¶ 参数
nodeId<string> 节点 IDoptions<array> 查询参数options.page<number> 默认值为 :1。options.limit<number> 默认值为 :10。options.includeChildrenNodes<boolean> 是否获取所有子节点的成员 默认值为 :false。
¶ 示例
$orgManagementClient->listMembers('NODE_ID');
¶ 删除成员
OrgManagementClient->removeMembers(string $nodeId, array $userIds)
删除节点成员
¶ 参数
nodeId<string> 节点 IDuserIds<string[]> 用户 ID 列表
¶ 示例
$orgManagementClient->removeMembers('NODEID', ['USER_ID'])
¶ 设置用户主部门
OrgManagementClient->setMainDepartment(string $userId, string $departmentId)
设置用户主部门
¶ 参数
userId<string> 用户 IDdepartmentId<string> 部门 ID
¶ 示例
$orgManagementClient->setMainDepartment('NODEID', 'departmentId');
¶ 导出所有组织机构数据
OrgManagementClient->exportAll()
导出所有组织机构，返回的数据结构为一个递归的数结构。
¶ 示例
$orgManagementClient->exportAll();
¶ 示例数据
[
{
"id": "601f59578308478a692a71ea",
"createdAt": "2021-02-07T03:07:03.822Z",
"updatedAt": "2021-02-07T03:07:03.822Z",
"userPoolId": "59f86b4832eb28071bdd9214",
"orgId": "601f59573abea48cceb188c6",
"name": "科技公司",
"nameI18n": null,
"description": null,
"descriptionI18n": null,
"order": null,
"code": null,
"children": [
{
"id": "601f5966800e61428d4190fb",
"createdAt": "2021-02-07T03:07:18.835Z",
"updatedAt": "2021-02-07T03:07:18.835Z",
"userPoolId": "59f86b4832eb28071bdd9214",
"orgId": "601f59573abea48cceb188c6",
"name": "产品",
"nameI18n": null,
"description": null,
"descriptionI18n": null,
"order": null,
"code": null,
"children": [],
"depth": 1,
"root": false,
"members": [
{
"id": "5a597f35085a2000144a10ed",
"createdAt": "2021-02-02T02:36:32.172Z",
"updatedAt": "2021-02-05T11:30:14.050Z",
"userPoolId": "59f86b4832eb28071bdd9214",
"isRoot": true,
"status": "Activated",
"oauth": null,
"email": "root@authing.cn",
"phone": null,
"username": "root",
"unionid": null,
"openid": null,
"nickname": null,
"company": null,
"photo": "https://files.authing.co/authing-console/default-user-avatar.png",
"browser": null,
"device": null,
"token": "",
"tokenExpiredAt": "2021-02-19T11:30:13.927Z",
"loginsCount": 4,
"lastIp": "::1",
"name": null,
"givenName": null,
"familyName": null,
"middleName": null,
"profile": null,
"preferredUsername": null,
"website": null,
"gender": "U",
"birthdate": null,
"zoneinfo": null,
"locale": null,
"address": null,
"formatted": null,
"streetAddress": null,
"locality": null,
"region": null,
"postalCode": null,
"city": null,
"province": null,
"country": null,
"registerSource": ["offcial:import"],
"emailVerified": false,
"phoneVerified": false,
"lastLogin": "2021-02-05T11:30:14.019Z",
"blocked": false,
"isDeleted": false,
"sendSmsCount": 0,
"sendSmsLimitCount": 1000,
"signedUp": "2021-02-02T02:36:32.172Z",
"externalId": null,
"mainDepartmentId": null,
"mainDepartmentCode": null,
"lastMfaTime": null,
"passwordSecurityLevel": null
}
]
},
{
"id": "601f59622a1dea5ae5ada750",
"createdAt": "2021-02-07T03:07:14.163Z",
"updatedAt": "2021-02-07T03:07:14.163Z",
"userPoolId": "59f86b4832eb28071bdd9214",
"orgId": "601f59573abea48cceb188c6",
"name": "研发",
"nameI18n": null,
"description": null,
"descriptionI18n": null,
"order": null,
"code": null,
"children": [
{
"id": "601f597e62eaeda4e17e3352",
"createdAt": "2021-02-07T03:07:42.475Z",
"updatedAt": "2021-02-07T03:07:42.475Z",
"userPoolId": "59f86b4832eb28071bdd9214",
"orgId": "601f59573abea48cceb188c6",
"name": "后端",
"nameI18n": null,
"description": null,
"descriptionI18n": null,
"order": null,
"code": null,
"children": [],
"depth": 2,
"root": false,
"members": []
}
],
"depth": 1,
"root": false,
"members": []
},
{
"id": "601f596e89427f0549daf48f",
"createdAt": "2021-02-07T03:07:26.919Z",
"updatedAt": "2021-02-07T03:07:26.919Z",
"userPoolId": "59f86b4832eb28071bdd9214",
"orgId": "601f59573abea48cceb188c6",
"name": "商业化",
"nameI18n": null,
"description": null,
"descriptionI18n": null,
"order": null,
"code": null,
"children": [],
"depth": 1,
"root": false,
"members": []
}
],
"depth": 0,
"root": true,
"members": []
}
]
¶ 导入某个组织机构数据
OrgManagementClient->exportByOrgId()
¶ 参数
orgId<string> 组织机构 ID
¶ 示例
$orgManagementClient->exportByOrgId('ORG_ID');
¶ 示例数据
{
"id": "601f59578308478a692a71ea",
"createdAt": "2021-02-07T03:07:03.822Z",
"updatedAt": "2021-02-07T03:07:03.822Z",
"userPoolId": "59f86b4832eb28071bdd9214",
"orgId": "601f59573abea48cceb188c6",
"name": "科技公司",
"nameI18n": null,
"description": null,
"descriptionI18n": null,
"order": null,
"code": null,
"children": [
{
"id": "601f5966800e61428d4190fb",
"createdAt": "2021-02-07T03:07:18.835Z",
"updatedAt": "2021-02-07T03:07:18.835Z",
"userPoolId": "59f86b4832eb28071bdd9214",
"orgId": "601f59573abea48cceb188c6",
"name": "产品",
"nameI18n": null,
"description": null,
"descriptionI18n": null,
"order": null,
"code": null,
"children": [],
"depth": 1,
"root": false,
"members": [
{
"id": "5a597f35085a2000144a10ed",
"createdAt": "2021-02-02T02:36:32.172Z",
"updatedAt": "2021-02-05T11:30:14.050Z",
"userPoolId": "59f86b4832eb28071bdd9214",
"isRoot": true,
"status": "Activated",
"oauth": null,
"email": "root@authing.cn",
"phone": null,
"username": "root",
"unionid": null,
"openid": null,
"nickname": null,
"company": null,
"photo": "https://files.authing.co/authing-console/default-user-avatar.png",
"browser": null,
"device": null,
"token": "",
"tokenExpiredAt": "2021-02-19T11:30:13.927Z",
"loginsCount": 4,
"lastIp": "::1",
"name": null,
"givenName": null,
"familyName": null,
"middleName": null,
"profile": null,
"preferredUsername": null,
"website": null,
"gender": "U",
"birthdate": null,
"zoneinfo": null,
"locale": null,
"address": null,
"formatted": null,
"streetAddress": null,
"locality": null,
"region": null,
"postalCode": null,
"city": null,
"province": null,
"country": null,
"registerSource": ["offcial:import"],
"emailVerified": false,
"phoneVerified": false,
"lastLogin": "2021-02-05T11:30:14.019Z",
"blocked": false,
"isDeleted": false,
"sendSmsCount": 0,
"sendSmsLimitCount": 1000,
"signedUp": "2021-02-02T02:36:32.172Z",
"externalId": null,
"mainDepartmentId": null,
"mainDepartmentCode": null,
"lastMfaTime": null,
"passwordSecurityLevel": null
}
]
},
{
"id": "601f59622a1dea5ae5ada750",
"createdAt": "2021-02-07T03:07:14.163Z",
"updatedAt": "2021-02-07T03:07:14.163Z",
"userPoolId": "59f86b4832eb28071bdd9214",
"orgId": "601f59573abea48cceb188c6",
"name": "研发",
"nameI18n": null,
"description": null,
"descriptionI18n": null,
"order": null,
"code": null,
"children": [
{
"id": "601f597e62eaeda4e17e3352",
"createdAt": "2021-02-07T03:07:42.475Z",
"updatedAt": "2021-02-07T03:07:42.475Z",
"userPoolId": "59f86b4832eb28071bdd9214",
"orgId": "601f59573abea48cceb188c6",
"name": "后端",
"nameI18n": null,
"description": null,
"descriptionI18n": null,
"order": null,
"code": null,
"children": [],
"depth": 2,
"root": false,
"members": []
}
],
"depth": 1,
"root": false,
"members": []
},
{
"id": "601f596e89427f0549daf48f",
"createdAt": "2021-02-07T03:07:26.919Z",
"updatedAt": "2021-02-07T03:07:26.919Z",
"userPoolId": "59f86b4832eb28071bdd9214",
"orgId": "601f59573abea48cceb188c6",
"name": "商业化",
"nameI18n": null,
"description": null,
"descriptionI18n": null,
"order": null,
"code": null,
"children": [],
"depth": 1,
"root": false,
"members": []
}
],
"depth": 0,
"root": true,
"members": []
}
¶ 获取组织机构节点被授权的所有资源
OrgManagementClient->listAuthorizedResourcesByNodeId(string $nodeId, string $namespace, array $options = [])
获取组织机构节点被授权的所有资源
¶ 参数
nodeId<string> 分组 ID；namespace<string> 权限分组的 code，详情请见使用权限分组管理权限资源options<array> 资源配置信息。options.resourceType<string> 可选，资源类型，默认会返回所有有权限的资源，现有资源类型如下：DATA: 数据类型；API: API 类型数据；MENU: 菜单类型数据；BUTTON: 按钮类型数据。
¶ 示例
managementClient->orgs()->listAuthorizedResourcesByNodeId(
'nodeId',
'code'
);
¶ 示例数据
¶ 获取组织机构节点被授权的所有资源
OrgManagementClient->listAuthorizedResourcesByNodeCode(string $orgId, string $code, string $namespace, array $options = [])
获取组织机构节点被授权的所有资源
¶ 参数
orgId<string> 组织机构 Id；code<string> 节点 Code；namespace<string> 权限分组的 code，详情请见使用权限分组管理权限资源options<array> 资源配置信息。options.resourceType<string> 可选，资源类型，默认会返回所有有权限的资源，现有资源类型如下：DATA: 数据类型；API: API 类型数据；MENU: 菜单类型数据；BUTTON: 按钮类型数据。
¶ 示例
$managementClient->orgs()->listAuthorizedResourcesByNodeCode('orgId' ,'nodeCode', 'code');