¶ 管理分组

此模块用于管理 Authing 分组，可以进行分组的增删改查、分组添加/删除用户、分组添加/删除策略 等操作。

请使用以下方式使用该模块，而不要直接初始化该模块：

$managementClient = new ManagementClient('userPoolId', 'secret');
$managementClient->requestToken();
$groupsClient = $managementClient->groups();
$groupsClient->create // 创建分组
$groupsClient->paginate //  获取分组列表

¶ 创建分组

GroupsManagementClient->create($code, $name, $description)

创建分组

¶ 参数

• code <string> 分组唯一标志符
• name <string> 分组名称
• description <string> 描述

¶ 示例

$group = $managementClient->groups()->create("code", "group name");

¶ 删除分组

GroupsManagementClient->delete(string $code)

删除分组

¶ 参数

• code <string> 分组唯一标志符

¶ 示例

$managementClient->groups()->delete("code");

¶ 修改分组

GroupsManagementClient->update($code, $input)

修改分组

¶ 参数

• code <string> 分组唯一标志符
• input <array>
• input.name <string> 新的名称
• input.description <string> 新的描述信息
• input.newCode <string> 新的唯一标志符

¶ 示例

$group = $managementClient->groups()->update("code", "group name");

¶ 获取分组详情

GroupsManagementClient->detail($code)

获取分组详情

¶ 参数

• code <string> 分组唯一标志符

¶ 示例

$group = $managementClient->groups()->detail("code");

¶ 获取分组列表

GroupsManagementClient->paginate($page, $limit)

获取分组列表

¶ 参数

• page <number> 页码数 默认值为 : 1。
• limit <number> 每页个数 默认值为 : 10。

¶ 示例

$groups = $managementClient->groups()->paginate();

¶ 批量删除分组

GroupsManagementClient->deleteMany($codeList)

批量删除分组

¶ 参数

• codeList <string[]> 分组唯一标志符列表

¶ 示例

$managementClient->groups()->deleteMany(["code"]);

¶ 获取分组用户列表

GroupsManagementClient->listUsers($code, $page, $limit)

获取分组用户列表

¶ 参数

• code <string> 分组唯一标志符
• page <number> 页码数 默认值为 : 1。
• limit <number> 每页个数 默认值为 : 10。

¶ 示例

$users = $managementClient->groups()->listUsers("code");

¶ 添加用户

GroupsManagementClient->addUsers($code, $userIds)

添加用户

¶ 参数

• code <string> 分组唯一标志符
• userIds <string[]> 用户 ID 列表

¶ 示例

$managementClient->groups()->addUsers("code", ["userId"]);

¶ 移除用户

GroupsManagementClient->removeUsers($code, $userIds)

移除用户

¶ 参数

• code <string> 分组唯一标志符
• userIds <string[]> 用户 ID 列表

¶ 示例

$managementClient->groups()->removeUsers("code", ["userId"]);

¶ 获取分组被授权的所有资源列表

GroupsManagementClient->listAuthorizedResources(string $groupCode, string $namespace, array $opts = [])

获取某个分组被授权的所有资源。

¶ 参数

• roleCode <string> 角色 code；
• namespace <string> 权限分组的 code，详情请见使用权限分组管理权限资源；
• resourceType <string> 可选，资源类型，默认会返回所有有权限的资源，现有资源类型如下：
  • DATA: 数据类型；
  • API: API 类型数据；
  • MENU: 菜单类型数据；
  • BUTTON: 按钮类型数据。

¶ 示例

use Authing\Mgmt\GroupsManagementClient;
use Authing\Mgmt\ManagementClient;

$managementClient = new ManagementClient('USERPOOL_ID', 'SECRET');
$managementClient->requestToken();

$groupsManagementClient = new GroupsManagementClient($managementClient);

$data = $groupsManagementClient->listAuthorizedResources('groupCode', "default");

¶ 示例数据

• type 为资源类型；
• code: 资源描述符，如果是 DATA 类型资源，格式为 resourceType:resourceId，如 books:* 表示所有书籍，books:1 表示 ID 为 1 的书籍。
• actions: 用户被授权对该资源的操作。

{
  "totalCount": 12,
  "list": [
    {
      "code": "menu_a",
      "type": "MENU"
    },
    {
      "code": "menu_b",
      "type": "MENU"
    },
    {
      "code": "books:1",
      "type": "DATA",
      "actions": ["books:delete", "books:update"]
    }
  ]
}