1. 授权
1.1. 授权说明
应用或者文件夹的管理者可以把应用或者文件夹把其它用户指定为查看着、编辑者或者管理者
1.1.1. 授权的定义
授权结构说明
字段 |
类型 |
描述 |
grantors |
OBJECT 数组 |
授权的用户信息列表,信息描述见下表 Grantor 描述 |
organizations |
OBJECT 数组 |
授权的用户组信息列表,信息描述见下表 Grantor 描述 |
orgs |
OBJECT 数组 |
授权的组织架构列表,信息描述见下表 Grantor 描述 |
tenants |
OBJECT 数组 |
授权的租户列表列表,信息描述见下表 Grantor 描述 |
Grantor 描述
字段值 |
类型 描述 |
id |
LONG |
授权的实体 id |
action |
STRING |
权限描述, admin |
read |
write 是管理者权限,read |
write 是编辑者权限,read 是查看着权限 |
email |
STRING |
授权的用户邮箱 |
name |
STRING |
授权的实体名 |
1.2. 接口说明
1.2.1. 授权
请求 URL
POST /api/v1/authorize
请求参数
url 参数
字段 |
类型 |
是否必须 |
描述 |
targetType |
STRING |
是 |
授权的对象类型,可选值为 app/folder/kanban/connection/survey/api-set |
targetId |
NUMBER |
是 |
授权的对象 id |
request body 请求体
授权结构说明
返回对象的格式说明
字段 |
类型 |
说明 |
version |
STRING |
当前系统版本哈希值 |
msg |
STRING |
成功返回 success |
接口示例1 给应用 1 授权 用户 test 的管理权限,用户组 test 的编辑权限
- 请求
POST /api/v1/authorize
{
"grantors": [
{
"id": 14,
"action": "admin|read|write"
}
],
"organizations": [
{
"id": 23,
"action": "read|write"
}
],
"orgs": [],
"tenants": []
}
- 响应结果
{"version":"3.2-SNAPSHOT@@git.commit.id.abbrev@#null","code":0,"msg":"success"}
1.2.2. 查询被授权用户/用户组
请求 URL
GET /api/v1/authorize
请求参数
url 参数
字段 |
类型 |
是否必须 |
描述 |
targetType |
STRING |
是 |
授权的对象类型,可选值为 app/folder/kanban/connection/survey/api-set |
targetId |
NUMBER |
是 |
授权的对象 id |
action |
STRING |
否 |
admin |
read |
write 是管理者权限,read |
write 是编辑者权限,read 是查看着权限 |
返回对象的格式说明
授权结构说明