管理角色

更新时间: 2021-05-07 06:26:05

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

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

use Authing\Mgmt\ManagementClient;

$manageClient = new ManagementClient('YOUR_USERPOOL_ID', 'YOUR_USERPOOL_SECRET');

$rolesManagementClient = $managementClient->roles();
$rolesManagementClient->paginate // 获取角色列表
$rolesManagementClient->create   // 创建角色
$rolesManagementClient->delete // 删除角色

创建角色

RolesManagementClient->create(string $code, string $description = null, string $namespace = null)

创建角色

参数

• code <string> 角色唯一标志符
• description <string> 描述
• namespace <string> 权限分组 code

示例

$role = $managementClient->roles()->create("code");

删除角色

RolesManagementClient->delete(string $code)

删除角色

参数

• code <string> 角色唯一标志符

示例

$message = $managementClient->roles()->delete("code");

批量删除角色

RolesManagementClient->deleteMany(array $codeList)

批量删除角色

参数

• codeList <string[]> 角色唯一标志符列表

示例

$message = $managementClient->roles()->deleteMany(
  [
    "code"
  ]
);

修改角色

RolesManagementClient->update(string $code, array $input)

修改角色

参数

• code <string> 角色唯一标志符
• input <array>
• input.description <string> 描述信息
• input.newCode <string> 新的唯一标志符

示例

$role = $managementClient->roles()->update("code", [
  'description' => 'desc'
]);

获取角色详情

RolesManagementClient->detail(string $code)

获取角色详情

参数

• code <string> 角色唯一标志符

示例

$role = $managementClient->roles()->detail("code");

获取角色列表

RolesManagementClient->paginate(int $page = 1, int $limit = 10)

获取角色列表

参数

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

示例

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

获取用户列表

RolesManagementClient->listUsers(string $code)

获取用户列表

参数

• code <string> 角色唯一标志符

示例

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

添加用户

RolesManagementClient->addUsers(string $code, array $userIds)

添加用户

参数

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

示例

$message = $managementClient->roles()->addUsers(
  "code", 
  [
    "userId"
  ]
);

移除用户

RolesManagementClient->removeUsers(string $code, array $userIds)

移除用户

参数

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

示例

$message = $managementClient->roles()->removeUsers(
  "code", 
  [
    "userId"
  ]
);

获取角色被授权的所有资源列表

RolesManagementClient->listAuthorizedResources(string $roleCode, string $namespace, array $opts = [])

获取某个角色被授权的所有资源。

参数

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

示例

use Authing\Mgmt\RolesManagementClient;
use Authing\Mgmt\ManagementClient;

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

$rolesManagementClient = $managementClient->roles();

$data = $rolesManagementClient->listAuthorizedResources(
  'roleCode', 
  '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"]
    }
  ]
}

获取某个角色扩展字段列表

RolesManagementClient->getUdfValue(string $roleId)

获取某个角色扩展字段列表

参数

• roleId <string> 角色 ID；

示例

$rolesManagementClient->getUdfValue('roleId')

示例数据

获取某个角色某个扩展字段

RolesManagementClient->getSpecificUdfValue(string $roleId, string $udfKey)

获取某个角色某个扩展字段

参数

• roleId <string> 角色 ID；
• udfKey <string> 扩展字段 Key；

示例

$rolesManagementClient->getSpecificUdfValue('roleId', 'udfKey');

示例数据

获取多个角色扩展字段列表

RolesManagementClient->getUdfValueBatch(array $roleId)

获取多个角色扩展字段列表

参数

• roleId <string []> 角色 ID 列表；

示例

$rolesManagementClient->getUdfValueBatch(
  [
    'roleId1', 
    'roleId2'
  ]
);

示例数据

设置某个角色扩展字段列表

RolesManagementClient->setUdfValue(string $roleId, array $data)

设置某个角色扩展字段列表

参数

• roleId <string> 角色 ID；
• data <KeyValuePair> 扩展字段，key: value；

示例

$rolesManagementClient->setUdfValue(
  'roleId1', 
  [
    'key1' => 'value1',
    'key2' => 'value2'
  ]
)

示例数据

设置多个角色扩展字段列表

RolesManagementClient->setUdfValueBatch(array $input)

设置多个角色扩展字段列表

参数

• input <object> 数据输入；
• input.data <KeyValuePair []> 扩展字段数组；
• input.roleId <string]> 角色 ID 列表；

示例

$rolesManagementClient->setUdfValueBatch([
  'roleId' => 'role id',
  'data' => [
              'key1' => 'value1',
              'key2' => 'value2'
            ]
])

示例数据

删除用户的扩展字段

RolesManagementClient->removeUdfValue(string $roleId, string $key)

删除用户的扩展字段

参数

• roleId <string> 角色 ID；
• key <string> 扩展字段名；

示例

$rolesManagementClient->removeUdfValue('roleId1', 'key1');

示例数据