权限
# 列出项目权限项定义
请求
GET /openapi/policy/resource-actions?projectName=<项目标识>&envType=<项目类型>
1
Query 参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
projectName | string | 项目标识 | 是 |
envType | string | 项目类型，自由项目为 pm，其他类型为k8s | 是 |
成功返回说明
| 参数名 | 类型 | 描述 |
|---|---|---|
resource | string | 操作对象 |
alias | string | 操作对象别名 |
rules | []Rules | 操作项 |
操作项参数说明
| 参数名 | 类型 | 描述 |
|---|---|---|
action | string | 操作项定义 |
alias | string | 操作项别名 |
成功返回示例
[
{
"resource": "Workflow",
"alias": "工作流",
"rules": [
{
"action": "get_workflow",
"alias": "查看"
},
{
"action": "create_workflow",
"alias": "新建"
},
{
"action": "edit_workflow",
"alias": "编辑"
},
{
"action": "delete_workflow",
"alias": "删除"
},
{
"action": "run_workflow",
"alias": "执行"
},
{
"action": "debug_workflow",
"alias": "调试"
}
]
},
{
"resource": "Environment",
"alias": "测试环境",
"rules": [
{
"action": "get_environment",
"alias": "查看"
},
{
"action": "create_environment",
"alias": "创建"
},
{
"action": "config_environment",
"alias": "配置"
},
{
"action": "manage_environment",
"alias": "管理服务实例"
},
{
"action": "delete_environment",
"alias": "删除"
},
{
"action": "debug_pod",
"alias": "服务调试"
}
]
},
{
"resource": "ProductionEnvironment",
"alias": "生产环境",
"rules": [
{
"action": "get_production_environment",
"alias": "查看"
},
{
"action": "create_production_environment",
"alias": "创建"
},
{
"action": "config_production_environment",
"alias": "配置"
},
{
"action": "edit_production_environment",
"alias": "管理服务实例"
},
{
"action": "delete_production_environment",
"alias": "删除"
},
{
"action": "production_debug_pod",
"alias": "服务调试"
}
]
},
{
"resource": "Service",
"alias": "测试服务",
"rules": [
{
"action": "get_service",
"alias": "查看"
},
{
"action": "create_service",
"alias": "新建"
},
{
"action": "edit_service",
"alias": "编辑"
},
{
"action": "delete_service",
"alias": "删除"
}
]
},
{
"resource": "ProductionService",
"alias": "生产服务",
"rules": [
{
"action": "get_production_service",
"alias": "查看"
},
{
"action": "create_production_service",
"alias": "新建"
},
{
"action": "edit_production_service",
"alias": "编辑"
},
{
"action": "delete_production_service",
"alias": "删除"
}
]
},
{
"resource": "Build",
"alias": "构建",
"rules": [
{
"action": "get_build",
"alias": "查看"
},
{
"action": "create_build",
"alias": "新建"
},
{
"action": "edit_build",
"alias": "编辑"
},
{
"action": "delete_build",
"alias": "删除"
}
]
},
{
"resource": "Test",
"alias": "测试",
"rules": [
{
"action": "get_test",
"alias": "查看"
},
{
"action": "create_test",
"alias": "新建"
},
{
"action": "edit_test",
"alias": "编辑"
},
{
"action": "delete_test",
"alias": "删除"
},
{
"action": "run_test",
"alias": "执行"
}
]
},
{
"resource": "Scan",
"alias": "代码扫描",
"rules": [
{
"action": "get_scan",
"alias": "查看"
},
{
"action": "create_scan",
"alias": "新建"
},
{
"action": "edit_scan",
"alias": "编辑"
},
{
"action": "delete_scan",
"alias": "删除"
},
{
"action": "run_scan",
"alias": "执行"
}
]
},
{
"resource": "Delivery",
"alias": "版本管理",
"rules": [
{
"action": "get_delivery",
"alias": "查看"
},
{
"action": "create_delivery",
"alias": "创建"
},
{
"action": "delete_delivery",
"alias": "删除"
}
]
}
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# 列出项目角色信息
请求
GET /openapi/policy/roles?namespace=<项目标识>
1
Query 参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
namespace | string | 项目标识 | 是 |
成功返回说明
| 参数名 | 类型 | 描述 |
|---|---|---|
id | int | id |
name | string | 名称 |
namespace | string | 项目唯一标识 |
desc | string | 描述 |
type | string | 类型，值为 custom 时标识为自建类型 |
成功返回示例
[
{
"id": 51,
"name": "dev",
"namespace": "test-k8skv-2",
"desc": "",
"type": "custom"
},
{
"id": 1,
"name": "project-admin",
"namespace": "test-k8skv-2",
"desc": "",
"type": "system"
},
{
"id": 2,
"name": "read-only",
"namespace": "test-k8skv-2",
"desc": "",
"type": "system"
},
{
"id": 3,
"name": "read-project-only",
"namespace": "test-k8skv-2",
"desc": "",
"type": "system"
}
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# 获取项目角色详情
请求
GET /openapi/policy/roles/:name?namespace=<项目标识>
1
路径参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
name | string | 角色名称 | 是 |
Query 参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
namespace | string | 项目标识 | 是 |
成功返回说明
| 参数名 | 类型 | 描述 |
|---|---|---|
id | int | id |
name | string | 名称 |
namespace | string | 项目唯一标识 |
rules | []Rule | 权限列表 |
desc | string | 描述 |
type | string | 类型，值为 custom 时标识为自建类型 |
Rule 参数说明
| 参数名 | 类型 | 描述 |
|---|---|---|
resource | string | 操作对象 |
verbs | []string | 权限项，具体值参考权限定义接口 |
成功返回示例
{
"id": 51,
"name": "dev",
"namespace": "test-k8skv-2",
"desc": "",
"type": "custom",
"rules": [
{
"resource": "Test",
"verbs": [
"get_test"
]
},
{
"resource": "Scan",
"verbs": [
"get_scan"
]
},
{
"resource": "Delivery",
"verbs": [
"get_delivery"
]
},
{
"resource": "Workflow",
"verbs": [
"get_workflow",
"run_workflow"
]
},
{
"resource": "ProductionEnvironment",
"verbs": [
"get_production_environment"
]
},
{
"resource": "Service",
"verbs": [
"get_service"
]
},
{
"resource": "ProductionService",
"verbs": [
"get_production_service"
]
},
{
"resource": "Build",
"verbs": [
"get_build"
]
},
{
"resource": "Environment",
"verbs": [
"get_environment"
]
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# 创建项目角色
请求
POST /openapi/policy/roles?namespace=<项目标识>
1
Query 参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
namespace | string | 项目标识 | 是 |
Body 参数说明
| 参数名 | 说明 | 类型 | 必填 |
|---|---|---|---|
name | 角色名称 | string | 是 |
namespace | 项目标识 | string | 是 |
actions | 权限项 | []string | 是 |
Body 参数示例
{
"name": "test",
"actions":
[
"get_test",
"create_test",
"edit_test"
],
"namespace": "test-k8skv-2"
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
成功返回示例
{
"message": "success"
}
1
2
3
2
3
# 编辑项目角色
请求
PUT /openapi/policy/roles/:name?namespace=<项目标识>
1
路径参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
name | string | 角色名称 | 是 |
Query 参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
namespace | string | 项目标识 | 是 |
Body 参数说明
| 参数名 | 说明 | 类型 | 必填 |
|---|---|---|---|
actions | 权限项 | []string | 是 |
Body 参数示例
{
"actions":
[
"create_test",
"edit_test",
"get_test",
"get_build"
]
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
成功返回示例
{
"message": "success"
}
1
2
3
2
3
# 删除项目角色
请求
DELETE /openapi/policy/roles/:name?namespace=<项目标识>
1
路径参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
name | string | 角色名称 | 是 |
Query 参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
namespace | string | 项目标识 | 是 |
Body 参数说明
| 参数名 | 说明 | 类型 | 必填 |
|---|---|---|---|
actions | 权限项 | []string | 是 |
Body 参数示例
{
"actions":
[
"create_test",
"edit_test",
"get_test",
"get_build"
]
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
成功返回示例
{
"message": "success"
}
1
2
3
2
3
# 列出项目成员
请求
GET /openapi/policy/role-bindings?namespace=<项目标识>
1
Query 参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
namespace | string | 项目标识 | 是 |
成功返回说明
| 参数名 | 类型 | 描述 |
|---|---|---|
binding_type | string | 成员类型，user为用户，group为用户组 |
user_info | UserInfo(#userinfo-1) | 用户成员信息，当binding_type值为user时生效 |
group_info | UserInfo(#groupinfo-1) | 用户组成员信息，当binding_type值为group时生效 |
roles | []string | 拥有的角色 |
用户成员参数说明
| 参数名 | 说明 | 类型 |
|---|---|---|
uid | uid | string |
name | 用户名 | string |
accout | 账户名 | string |
用户组成员参数说明
| 参数名 | 说明 | 类型 |
|---|---|---|
group_id | group_id | string |
name | 用户组名称 | string |
成功返回示例
[
{
"binding_type": "user",
"user_info": {
"identity_type": "system",
"uid": "d456d705-73a9-11ee-98cf-56ef622fc735",
"account": "demo",
"username": "demo"
},
"roles": [
"prod-test",
"read-project-only"
]
},
{
"binding_type": "user",
"user_info": {
"identity_type": "system",
"uid": "290a3f01-73aa-11ee-98cf-56ef622fc735",
"account": "leo",
"username": "leo"
},
"roles": [
"read-project-only"
]
},
{
"binding_type": "group",
"group_info": {
"group_id": "98256be6-6e53-11ee-a205-9653dd3e9c32",
"name": "XX"
},
"roles": [
"read-project-only"
]
},
{
"binding_type": "group",
"group_info": {
"group_id": "cce58580-5131-11ee-b458-4a4088364d94",
"name": "所有用户"
},
"roles": [
"read-project-only"
]
}
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# 增加项目成员
请求
POST /openapi/policy/role-bindings?namespace=<项目标识>
1
Query 参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
namespace | string | 项目标识 | 是 |
Body 参数说明
| 参数名 | 说明 | 类型 | 必填 |
|---|---|---|---|
role | 角色类型 | string | 是 |
identities | 成员数据列表 | []identities | 是 |
Body 参数示例
成员数据参数说明
| 参数名 | 说明 | 类型 | 必填 |
|---|---|---|---|
identity_type | 成员类型 | string user 或者 group | 是 |
gid | 用户组id | string | 添加用户组时必填 |
uid | 用户id | string | 添加用户时必填 |
{
"role": "read-project-only",
"identities":
[
{
"identity_type": "group",
"gid": "98256be6-6e53-11ee-a205-9653dd3e9c32"
},
{
"identity_type": "group",
"gid": "cce58580-5131-11ee-b458-4a4088364d94"
},
{
"identity_type": "user",
"uid": "ddd405d5-5131-11ee-b458-4a4088364d94"
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
成功返回示例
{
"message": "success"
}
1
2
3
2
3
# 更新项目成员角色
请求
POST /openapi/policy/role-bindings/user/:uid?namespace=<项目标识>
1
路径参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
uid | string | 用户id | 是 |
Query 参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
namespace | string | 项目标识 | 是 |
Body 参数说明
| 参数名 | 说明 | 类型 | 必填 |
|---|---|---|---|
roles | 角色列表 | []string | 是 |
Body 参数示例
{
"roles":
[
"prod-test",
"read-project-only",
"lilian"
]
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
成功返回示例
{
"message": "success"
}
1
2
3
2
3
# 删除项目成员
请求
DELETE /openapi/policy/role-bindings/user/:uid?namespace=<项目标识>
1
路径参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
uid | string | 用户id | 是 |
Query 参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
namespace | string | 项目标识 | 是 |
成功返回示例
{
"message": "success"
}
1
2
3
2
3
# 更新项目用户组成员角色
请求
POST /openapi/policy/role-bindings/group/:gid?namespace=<项目标识>
1
路径参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
gid | string | 用户组id | 是 |
Query 参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
namespace | string | 项目标识 | 是 |
Body 参数说明
| 参数名 | 说明 | 类型 | 必填 |
|---|---|---|---|
roles | 角色列表 | []string | 是 |
Body 参数示例
{
"roles":
[
"prod-test",
"read-project-only",
"lilian"
]
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
成功返回示例
{
"message": "success"
}
1
2
3
2
3
# 删除项目用户组成员
请求
DELETE /openapi/policy/role-bindings/group/:gid?namespace=<项目标识>
1
路径参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
gid | string | 用户组id | 是 |
Query 参数说明
| 参数名 | 类型 | 描述 | 必填 |
|---|---|---|---|
namespace | string | 项目标识 | 是 |
成功返回示例
{
"message": "success"
}
1
2
3
2
3
