¶ 创建角色
更新时间: 2024-10-10 07:28:40
通过权限分组内角色 code,创建角色,可以选择权限分组、角色描述等。
¶ 请求参数
名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 |
---|---|---|---|---|---|
code | string | 是 | - | 权限分组内角色的唯一标识符。 | manager |
namespace | string | 否 | default | 所属权限分组的 code。 | default |
description | string | 否 | - | 角色描述。 | this is manager |
¶ 示例代码
<?php
require 'vendor/autoload.php';
use Authing\ManagementClient;
$management = new ManagementClient(
"AUTHING_USERPOOL_ID",
"AUTHING_USERPOOL_SECRET"
);
$data = $management->createRole(array(
"code" => "manager",
"namespace" => "default",
"description" => "this is manager",
));
¶ 请求响应
类型: RoleSingleRespDto
名称 | 类型 | 描述 |
---|---|---|
statusCode | number | 业务状态码,可以通过此状态码判断操作是否成功,200 表示成功。 |
message | string | 描述信息 |
apiCode | number | 细分错误码,可通过此错误码得到具体的错误类型。 |
data | RoleDto | 响应数据 |
示例结果:
{
"statusCode": 200,
"message": "操作成功",
"apiCode": 20001,
"data": {
"code": "role1",
"description": "this is description",
"namespace": "default"
}
}
¶ 数据结构
¶ RoleDto
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
code | string | 是 | 权限分组内角色的唯一标识符。 示例值: role1 |
description | string | 是 | 角色描述。 示例值: this is description |
namespace | string | 是 | 所属权限分组的 code。 示例值: default |