2023-12-03 15:59:54 +08:00
|
|
|
|
# IDaasApi
|
2023-11-16 18:03:05 +08:00
|
|
|
|
[toc]
|
|
|
|
|
|
2023-12-03 15:59:54 +08:00
|
|
|
|
## init(ak, sk)
|
|
|
|
|
|
2023-11-16 18:03:05 +08:00
|
|
|
|
初始化
|
2023-12-03 15:59:54 +08:00
|
|
|
|
|
2023-11-16 18:03:05 +08:00
|
|
|
|
* ak accessKey 编程者账号key
|
|
|
|
|
* sk secretKey 编程者账号密钥
|
|
|
|
|
|
2023-12-03 15:59:54 +08:00
|
|
|
|
## api
|
|
|
|
|
|
|
|
|
|
### user
|
|
|
|
|
|
|
|
|
|
#### create(param)
|
|
|
|
|
|
|
|
|
|
创建用户
|
|
|
|
|
|
|
|
|
|
POST /v1/users
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>username</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用户名,唯一,不传后台自动生成</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>password</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>密码,不传后台生成默认密码</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>display_name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>显示名称</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>firstname</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>名</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>lastname</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>姓</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>realname</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>真实姓名</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>pinyin</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>拼音</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>nickname</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>昵称</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>user_type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用户类型,不传后台设置系统默认类型</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>mobile</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>手机</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>email</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>邮箱</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>gender</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>性别</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>cert_type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>证件类型</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>cert_number</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>证件号</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>region</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>区域</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>work_time</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>加入时间</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>work_title</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>职位</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>ext_prop</td>
|
|
|
|
|
<td>json</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>扩展信息,json对象{"age": 18, "love": "足球"}</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>status</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>状态:1正常,0禁用,后期扩展:离职、休假、借调。</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>password_status</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>密码状态(valid/invalid)</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>idp_config_id</td>
|
|
|
|
|
<td>number</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>身份源ID,作为创建时记录,不做更新</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>is_notify</td>
|
|
|
|
|
<td>boolean</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>是否通知:默认不传false不通知,true通知</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### disable(param)
|
|
|
|
|
|
|
|
|
|
锁定用户
|
|
|
|
|
|
|
|
|
|
PATCH /v1/users/{id}/disable
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### enable(param)
|
|
|
|
|
|
|
|
|
|
解锁用户
|
|
|
|
|
|
|
|
|
|
PATCH /v1/users/{id}/enable
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### batchDisable(param)
|
|
|
|
|
|
|
|
|
|
批量锁定用户
|
|
|
|
|
|
|
|
|
|
POST /v1/jobs/users-disable
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>ids</td>
|
|
|
|
|
<td>array</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### batchEnable(param)
|
|
|
|
|
|
|
|
|
|
批量解锁用户
|
|
|
|
|
|
|
|
|
|
POST /v1/jobs/users-enable
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>ids</td>
|
|
|
|
|
<td>array</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### modify(param)
|
|
|
|
|
|
|
|
|
|
编辑用户
|
|
|
|
|
|
|
|
|
|
PATCH /v1/users/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>username</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用户名,验证唯一</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>display_name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>显示名称</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>firstname</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>名</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>lastname</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>姓</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>realname</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>真实姓名</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>pinyin</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>拼音</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>nickname</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>昵称</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>mobile</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>手机</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>email</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>邮箱</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>gender</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>性别:1男,0女</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>cert_type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>证件类型</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>cert_number</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>证件号</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>region</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>区域</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>work_time</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>加入时间</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>work_title</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>职位</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>ext_prop</td>
|
|
|
|
|
<td>json</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>扩展信息,json对象{"age": 18, "love": "足球"}</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>last_login_ipaddr</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>上次登录IP</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>last_login_time</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>上次登录时间</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### delete(param)
|
|
|
|
|
|
|
|
|
|
删除用户
|
|
|
|
|
|
|
|
|
|
DELETE /v1/users/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### batchDelete(param)
|
|
|
|
|
|
|
|
|
|
批量删除用户
|
|
|
|
|
|
|
|
|
|
DELETE /v1/users
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>ids</td>
|
|
|
|
|
<td>array</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### list(param)
|
|
|
|
|
|
|
|
|
|
查询用户列表
|
|
|
|
|
|
|
|
|
|
GET /v1/users
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_size</td>
|
|
|
|
|
<td>integer</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_num</td>
|
|
|
|
|
<td>integer</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>search_type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>默认按用户字段搜索,当值为:generic时,全文检索</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>keyword</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>检索值</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### get(param)
|
|
|
|
|
|
|
|
|
|
查询用户详情
|
|
|
|
|
|
|
|
|
|
GET /v1/users/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### modifyPassword(param)
|
|
|
|
|
|
|
|
|
|
修改密码
|
|
|
|
|
|
|
|
|
|
PATCH /v1/users/{id}/passwords
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>old_password</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>new_password</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getStoredCredentials(param)
|
|
|
|
|
|
|
|
|
|
查询用户存储凭证列表
|
|
|
|
|
|
|
|
|
|
GET /v1/user-stored-credentials
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>user_id</td>
|
|
|
|
|
<td>number</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用户id标识</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>provider_code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>社会化登录提供者的code</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>idp_config_id</td>
|
|
|
|
|
<td>number</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>社会化登录配置的ID</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id1</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>社会化身份标识1,约定此字段保存用户唯一标识,如openid</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id2</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>社会化身份标识2,如unionid</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>metadata</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>更多社会化身份标识</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>status</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>状态</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>username</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用户名</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>display_name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>显示名</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_size</td>
|
|
|
|
|
<td>integer</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_num</td>
|
|
|
|
|
<td>integer</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### createStoreCredential(param)
|
|
|
|
|
|
|
|
|
|
创建用户存储凭证
|
|
|
|
|
|
|
|
|
|
POST /v1/user-stored-credentials
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>provider_code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>社会化身份源code</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id1</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>社会化身份标识1,如openid</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id2</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>社会化身份标识2,如unionid</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>metadata</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>更多社会化身份标识</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>status</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>状态</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>nickname</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>昵称</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>avatar</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>头像</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id_provider_connection</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>idp_config_id</td>
|
|
|
|
|
<td>number</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>社会化登录配置的ID</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>realname</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>真实姓名</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>mobile</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>手机</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>email</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>邮箱</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>gender</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>性别</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
### authentication
|
|
|
|
|
### app
|
|
|
|
|
|
|
|
|
|
#### create(param)
|
|
|
|
|
|
|
|
|
|
创建应用
|
|
|
|
|
|
|
|
|
|
POST /v1/applications
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用名称</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用类型1,自建应用,2模板应用(市场应用)</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>template_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>模板id,不填写则代表自建应用</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>category</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用分类,1 标准web应用,2单页web应用,3客户端应用,4后端服务</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>descr</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用描述</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>logo</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>logo路径,格式为:http://ip:port/logo.png</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>login_url</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>登录路径</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>redirect_url</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>重定向路径</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>logout_url</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>登出路径</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>sub_account_policy</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>子账号策略,1启用,0不启用,启用后单点登录返回</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>prop</td>
|
|
|
|
|
<td>object</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>kv字典数据</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>protocol_type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>如果不传默认是oidc</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>protocol_prop</td>
|
|
|
|
|
<td>object</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>单点登录协议属性,如果不存在则为oidc的配置</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>config_prop</td>
|
|
|
|
|
<td>object</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用配置属性</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>domain_sn</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>域名</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### modify(param)
|
|
|
|
|
|
|
|
|
|
更新应用基本信息
|
|
|
|
|
|
|
|
|
|
PATCH /v1/applications/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用名称</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用类型,1自建应用,2市场应用</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用key</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_secret</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用secret,拥有管理员权限时返回</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>category</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用分类</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>descr</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用描述</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>logo</td>
|
|
|
|
|
<td>null</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>logo路径</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>login_url</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>登录路径</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>redirect_url</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>重定向路径</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>logout_url</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>登出路径</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>sub_account_policy</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>子账号策略</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>prop</td>
|
|
|
|
|
<td>object</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>扩展属性</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>status</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>状态,0禁用,1启用</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>domain_sn</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用 Domain SN</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getTemplate(param)
|
|
|
|
|
|
|
|
|
|
查询应用模板列表
|
|
|
|
|
|
|
|
|
|
GET /v1/application-templates
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用名称</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### list(param)
|
|
|
|
|
|
|
|
|
|
查询应用列表
|
|
|
|
|
|
|
|
|
|
GET /v1/applications
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用名称</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用类型</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_sort</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>排序,格式:字段名[顺序]</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>types</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用类型列表,逗号分隔</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getByDomain(param)
|
|
|
|
|
|
|
|
|
|
按条件查询应用
|
|
|
|
|
|
|
|
|
|
GET /v1/application
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>domain</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>域名</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>domain_sn</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>域名简写</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### get(param)
|
|
|
|
|
|
|
|
|
|
按 ID 查询应用
|
|
|
|
|
|
|
|
|
|
GET /v1/applications/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>唯一标识</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### enable(param)
|
|
|
|
|
|
|
|
|
|
启用应用
|
|
|
|
|
|
|
|
|
|
POST /v1/applications/{id}/enable
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用标识</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### disable(param)
|
|
|
|
|
|
|
|
|
|
禁用应用
|
|
|
|
|
|
|
|
|
|
POST /v1/applications/{id}/disable
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用标识</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### delete(param)
|
|
|
|
|
|
|
|
|
|
删除应用
|
|
|
|
|
|
|
|
|
|
DELETE /v1/applications/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### createSecrets(param)
|
|
|
|
|
|
|
|
|
|
刷新应用安全码
|
|
|
|
|
|
|
|
|
|
POST /v1/applications/{id}/secrets
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getConfig(param)
|
|
|
|
|
|
|
|
|
|
查询应用配置信息
|
|
|
|
|
|
|
|
|
|
GET /v1/applications/{id}/configs
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用ID</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### modifyConfig(param)
|
|
|
|
|
|
|
|
|
|
更新应用配置
|
|
|
|
|
|
|
|
|
|
PATCH /v1/applications/{id}/configs
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>allowed_login_method</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>允许的登录方式,格式为:["password", "vercode"]</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>default_login_method</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>默认登录方式,格式为:password</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>allowed_reg_method</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>允许注册方式,格式为:["mobile", "email"]</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>default_reg_method</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>默认注册方式,格式为:mobile</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>default_protocol</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>默认登录协议</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>access_policy</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用级访问控制权限,all: 所有人可访问 permitted: 拒绝未授权访问</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>reg_policy</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>新用户注册策略(是否允许自动注册,注册验证方式等),1是,2否,</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### disableSSO(param)
|
|
|
|
|
|
|
|
|
|
禁用应用单点登录
|
|
|
|
|
|
|
|
|
|
POST /v1/applications/{id}/sso/disable
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用标识</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### enableSSO(param)
|
|
|
|
|
|
|
|
|
|
启用应用单点登录
|
|
|
|
|
|
|
|
|
|
POST /v1/applications/{id}/sso/enable
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用标识</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### createMFA(param)
|
|
|
|
|
|
|
|
|
|
创建应用多因素认证配置
|
|
|
|
|
|
|
|
|
|
POST /v1/applications/{id}/mfa
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>config_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>已配置的idp conn id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### deleteMFA(param)
|
|
|
|
|
|
|
|
|
|
删除应用多因素认证配置
|
|
|
|
|
|
|
|
|
|
DELETE /v1/applications/{app_id}/mfa/{config_id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>config_id</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### createIDP(param)
|
|
|
|
|
|
|
|
|
|
创建应用认证源
|
|
|
|
|
|
|
|
|
|
POST /v1/applications/{id}/idp
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>config_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>已配置的idp conn id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### deleteIDPConfig(param)
|
|
|
|
|
|
|
|
|
|
删除应用认证源
|
|
|
|
|
|
|
|
|
|
DELETE /v1/applications/{app_id}/idp/{config_id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>config_id</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### enableProtocol(param)
|
|
|
|
|
|
|
|
|
|
启用应用认证协议
|
|
|
|
|
|
|
|
|
|
POST /v1/applications/{app_id}/protocols/{protocol_type}/enable
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用 id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>protocol_type</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>协议名称,如 oidc</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### disableProtocol(param)
|
|
|
|
|
|
|
|
|
|
禁用应用认证协议
|
|
|
|
|
|
|
|
|
|
POST /v1/applications/{app_id}/protocols/{protocol_type}/disable
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用 id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>protocol_type</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>协议名称,如 oidc</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getProtocols(param)
|
|
|
|
|
|
|
|
|
|
查询应用认证协议列表
|
|
|
|
|
|
|
|
|
|
GET /v1/applications/{id}/protocols
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用唯一标识ID</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>status</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>启用状态 1, 0</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getProtocol(param)
|
|
|
|
|
|
|
|
|
|
查询应用认证协议
|
|
|
|
|
|
|
|
|
|
GET /v1/applications/{app_id}/protocols/{protocol_type}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>protocol_type</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>单点类型,cas、oauth2、saml、oidc、sxp</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### modifyProtocol(param)
|
|
|
|
|
|
|
|
|
|
更新应用认证协议
|
|
|
|
|
|
|
|
|
|
PUT /v1/applications/{app_id}/protocols/{protocol_type}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>protocol_type</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>单点类型,cas、oauth2、saml、oidc、sxp</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>config_content</td>
|
|
|
|
|
<td>object</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>配置参数</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### createAccount(param)
|
|
|
|
|
|
|
|
|
|
创建应用子账号
|
|
|
|
|
|
|
|
|
|
POST /v1/applications/{id}/accounts
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>user_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用户唯一标识</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用唯一标识</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>帐号名</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_name_displayed</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>显示名</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_source</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>帐号来源</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_password</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>帐号密码</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_status</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>帐号状态,1启用,0禁用</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_prop</td>
|
|
|
|
|
<td>object</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>扩展属性</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>usernmae</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用户名称</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### modifyAccount(param)
|
|
|
|
|
|
|
|
|
|
更新应用子账号
|
|
|
|
|
|
|
|
|
|
PUT /v1/applications/{app_id}/accounts/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>子账号id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>user_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用户唯一标识</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用唯一标识</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>帐号名</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_name_displayed</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>显示名</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_source</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>帐号来源</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_password</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>密码</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_status</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>状态,1启用,0禁用</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_prop</td>
|
|
|
|
|
<td>object</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>扩展属性</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### enableAccount(param)
|
|
|
|
|
|
|
|
|
|
启用应用子账号
|
|
|
|
|
|
|
|
|
|
POST /v1/applications/{app_id}/accounts/{id}/enable
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>子账号id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### disableAccount(param)
|
|
|
|
|
|
|
|
|
|
禁用应用子账号
|
|
|
|
|
|
|
|
|
|
POST /v1/applications/{app_id}/accounts/{id}/disable
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>子账号id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### deleteAccount(param)
|
|
|
|
|
|
|
|
|
|
删除应用子账号
|
|
|
|
|
|
|
|
|
|
DELETE /v1/applications/{app_id}/accounts/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>子账号id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getAccountsByApp(param)
|
|
|
|
|
|
|
|
|
|
按 APP ID 查询应用子账号列表
|
|
|
|
|
|
|
|
|
|
GET /v1/applications/{app_id}/accounts
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>user_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用户id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_status</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>账号状态 1-活跃 0-冻结</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>账号名称</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_num</td>
|
|
|
|
|
<td>integer</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>页数</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_size</td>
|
|
|
|
|
<td>integer</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>页大小</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_sort</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>排序字段</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getAccounts(param)
|
|
|
|
|
|
|
|
|
|
查询应用子账号列表
|
|
|
|
|
|
|
|
|
|
GET /v1/application-accounts
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>user_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用户id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_status</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>账号状态 1-活跃 0-冻结</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>acc_name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>账号名称</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_num</td>
|
|
|
|
|
<td>integer</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>页数</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_size</td>
|
|
|
|
|
<td>integer</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>页大小</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_sort</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>排序字段</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getAccount(param)
|
|
|
|
|
|
|
|
|
|
按 ID 查询应用子账号
|
|
|
|
|
|
|
|
|
|
GET /v1/applications/{app_id}/accounts/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>app_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>子账号id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
### permission
|
|
|
|
|
|
|
|
|
|
#### getPrivileges(param)
|
|
|
|
|
|
|
|
|
|
获取权限列表
|
|
|
|
|
|
|
|
|
|
GET /v1/privileges
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>identity_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>主体id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>identity_type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>主体类型</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>identity_name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>主体名称</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>application_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>object_type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>对象类型(可选值: data, api, ui, res_set, app)</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>object_code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>对象代码</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>affect</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>作用方式(affect,deny)</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_num</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>起始页,默认1</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_size</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>页大小,默认20</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_sort</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>排序方式,格式:字段[排序方式]</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getAuthUnits(param)
|
|
|
|
|
|
|
|
|
|
获取授权单元列表
|
|
|
|
|
|
|
|
|
|
GET /v1/auth-units
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>identity_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>主体id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>identity_type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>主体类型</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>identity_name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>主体名称</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_num</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>起始页,默认1</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_size</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>页大小,默认20</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_sort</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>排序方式,格式:字段[排序方式]</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getAuthUnit(param)
|
|
|
|
|
|
|
|
|
|
按 ID 查询授权单元
|
|
|
|
|
|
|
|
|
|
GET /v1/auth-units/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>au id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### createAuthUnitRules(param)
|
|
|
|
|
|
|
|
|
|
批量创建授权规则
|
|
|
|
|
|
|
|
|
|
POST /v1/batch/auth-unit-rules
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>identities</td>
|
|
|
|
|
<td>array</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>rules</td>
|
|
|
|
|
<td>array</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### modifyAuthUnit(param)
|
|
|
|
|
|
|
|
|
|
更新授权规则
|
|
|
|
|
|
|
|
|
|
PUT /v1/auth-units/{rid}/rules/{tid}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>rid</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>AU id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>tid</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>规则id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getAuthUnitsRules(param)
|
|
|
|
|
|
|
|
|
|
查询授权单元下的授权规则列表
|
|
|
|
|
|
|
|
|
|
GET /v1/auth-units/{rid}/rules
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>rid</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>AU id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>application_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>规则类型</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>资源或资源集合code</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>self_only</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>只查询指定主体下的授权</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>resource_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>资源id,当type=api,ui,data时有效</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>resource_match_all_resources</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>匹配所有资源,当type=res时有效</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>resource_match_all_actions</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>匹配所有资源操作,当type=res时有效</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>resource_set_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>资源集合id,当type=res_set</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### queryAuthUnitsRules(param)
|
|
|
|
|
|
|
|
|
|
查询授权规则列表
|
|
|
|
|
|
|
|
|
|
GET /v1/auth-unit-rules
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>application_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>规则类型</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>资源或资源集合code</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>identity_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>主体id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>identity_type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>主体类型</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>identity_name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>主体名称</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>self_only</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>只查询指定主体下的授权</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>resource_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>资源id,当type=api,ui,data时有效</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>resource_match_all_resources</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>匹配所有资源,当type=res时有效</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>resource_match_all_actions</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>匹配所有资源操作,当type=res时有效</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>resource_set_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>资源集合id,当type=res_set</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### deleteAuthUnitRules(param)
|
|
|
|
|
|
|
|
|
|
批量删除授权规则
|
|
|
|
|
|
|
|
|
|
DELETE /v1/batch/auth-unit-rules
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>ids</td>
|
|
|
|
|
<td>array</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### createResource(param)
|
|
|
|
|
|
|
|
|
|
创建资源
|
|
|
|
|
|
|
|
|
|
POST /v1/resources
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>description</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>描述</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>资源代码</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>application_id</td>
|
|
|
|
|
<td>number</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>资源类型,data/api/ui</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>uri</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>资源URI, 当type=api/ui 时有效</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>actions</td>
|
|
|
|
|
<td>array</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### modifyResource(param)
|
|
|
|
|
|
|
|
|
|
更新资源
|
|
|
|
|
|
|
|
|
|
PUT /v1/resources/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>资源id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>description</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>描述</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>uri</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>资源URI, 当type=api/ui 时有效</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>actions</td>
|
|
|
|
|
<td>array</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getResources(param)
|
|
|
|
|
|
|
|
|
|
查询资源列表
|
|
|
|
|
|
|
|
|
|
GET /v1/resources
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>application_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>资源类型</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>资源代码</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>include_global</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>是否查询包含全局资源</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_num</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>起始页,默认1</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_size</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>页大小,默认20</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_sort</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>排序方式,格式:字段[排序方式]</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getResource(param)
|
|
|
|
|
|
|
|
|
|
按 ID 查询资源
|
|
|
|
|
|
|
|
|
|
GET /v1/resources/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>资源id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>application_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### deleteResources(param)
|
|
|
|
|
|
|
|
|
|
删除资源
|
|
|
|
|
|
|
|
|
|
DELETE /v1/batch/resources
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>ids</td>
|
|
|
|
|
<td>array</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### createResourceSet(param)
|
|
|
|
|
|
|
|
|
|
创建资源集合
|
|
|
|
|
|
|
|
|
|
POST /v1/resource-sets
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>集合代码</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>description</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>描述</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>application_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### modifyResourceSet(param)
|
|
|
|
|
|
|
|
|
|
更新资源集合
|
|
|
|
|
|
|
|
|
|
PUT /v1/resource-sets/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>集合id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>集合代码</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>description</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>描述</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getResourceSets(param)
|
|
|
|
|
|
|
|
|
|
查询资源集合列表
|
|
|
|
|
|
|
|
|
|
GET /v1/resource-sets
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>集合代码</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>application_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>应用id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>include_global</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>查询是否包含全局资源集合</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_num</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>起始页,默认1</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_size</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>页大小,默认20</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_sort</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>排序方式,格式:字段[排序方式]</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getResourceSet(param)
|
|
|
|
|
|
|
|
|
|
按 ID 查询资源集合
|
|
|
|
|
|
|
|
|
|
GET /v1/resource-sets/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>资源集合id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### createResourceSetMember(param)
|
|
|
|
|
|
|
|
|
|
创建资源集合成员
|
|
|
|
|
|
|
|
|
|
POST /v1/resource-sets/{id}/members
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>集合id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>resource_id</td>
|
|
|
|
|
<td>number</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>resource_scope</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>resource_actions</td>
|
|
|
|
|
<td>array</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>match_all_actions</td>
|
|
|
|
|
<td>boolean</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### modifyResourceSetMember(param)
|
|
|
|
|
|
|
|
|
|
更新资源集合成员
|
|
|
|
|
|
|
|
|
|
PUT /v1/resource-sets/{sid}/members/{mid}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>sid</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>资源集合id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>mid</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>资源集合成员id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>resource_id</td>
|
|
|
|
|
<td>number</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>resource_scope</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>ResourceActions</td>
|
|
|
|
|
<td>array</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>match_all_actions</td>
|
|
|
|
|
<td>boolean</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getResourceMembers(param)
|
|
|
|
|
|
|
|
|
|
查询资源集合成员列表
|
|
|
|
|
|
|
|
|
|
GET /v1/resource-sets/{sid}/members
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>sid</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>资源集合id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>resource_code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>资源代码</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>resource_type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>资源类型</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_num</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>起始页,默认1</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_size</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>页大小,默认20</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_sort</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>排序方式,格式:字段[排序方式]</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getResourceMember(param)
|
|
|
|
|
|
|
|
|
|
按 ID 查询资源集合成员
|
|
|
|
|
|
|
|
|
|
GET /v1/resource-sets/{sid}/members/{mid}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>sid</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>资源集合id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>mid</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>成员id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### authorizeApplications(param)
|
|
|
|
|
|
|
|
|
|
授权应用
|
|
|
|
|
|
|
|
|
|
POST /v1/batch/authz-apps
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>identities</td>
|
|
|
|
|
<td>array</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>application_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>affect</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>allow, deny</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### listAuthorizedApplications(param)
|
|
|
|
|
|
|
|
|
|
查询已授权应用列表
|
|
|
|
|
|
|
|
|
|
GET /v1/authz-apps
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>identity_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>授权主体 id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>identity_type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>授权主体类型</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>应用类型: 0-默认应用 1-自建应用 2-模板应用 3-组件应用</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
### organization
|
|
|
|
|
|
|
|
|
|
#### createOrganization(param)
|
|
|
|
|
|
|
|
|
|
创建组织关系
|
|
|
|
|
|
|
|
|
|
POST /v1/core-objects
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getNodeParent(param)
|
|
|
|
|
|
|
|
|
|
查询父节点
|
|
|
|
|
|
|
|
|
|
GET /v1/tree-nodes/{id}/parent
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### deleteNode(param)
|
|
|
|
|
|
|
|
|
|
删除节点
|
|
|
|
|
|
|
|
|
|
DELETE /v1/tree-nodes/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>object_code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>树对象code</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getOrganizations(param)
|
|
|
|
|
|
|
|
|
|
获取组织关系列表
|
|
|
|
|
|
|
|
|
|
GET /v1/core-objects
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### updateOrganization(param)
|
|
|
|
|
|
|
|
|
|
修改组织关系基本信息
|
|
|
|
|
|
|
|
|
|
PATCH /v1/core-objects/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getOrganization(param)
|
|
|
|
|
|
|
|
|
|
获取组织关系基本信息
|
|
|
|
|
|
|
|
|
|
GET /v1/core-objects/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### deleteOrganization(param)
|
|
|
|
|
|
|
|
|
|
删除组织关系
|
|
|
|
|
|
|
|
|
|
DELETE /v1/core-objects/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### addUserToNode(param)
|
|
|
|
|
|
|
|
|
|
添加用户到节点
|
|
|
|
|
|
|
|
|
|
POST /v1/tree-users
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>relation_data</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>关联扩展信息</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>relation_type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用于区分多重关联</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>is_default</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>1是,0否</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>node_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>user_ids</td>
|
|
|
|
|
<td>array</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### updateMember(param)
|
|
|
|
|
|
|
|
|
|
更新用户节点
|
|
|
|
|
|
|
|
|
|
PATCH /v1/tree-users/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>is_default</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>1是,0否</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>action</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>移动节点move, 设置为默认关系as-default</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>source_node_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>移动前节点ID</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>dest_node_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>移动后节点ID</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getMembers(param)
|
|
|
|
|
|
|
|
|
|
获取与用户关联的组织关系列表
|
|
|
|
|
|
|
|
|
|
GET /v1/tree-users
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>user_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>用户ID</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getNodeMembers(param)
|
|
|
|
|
|
|
|
|
|
获取成员信息列表
|
|
|
|
|
|
|
|
|
|
GET /v1/tree-nodes/{id}/tree-users
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>node id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>relation_type</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>关联类型,用于区分多重关联</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>is_default</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>是否默认关系 1是,0否</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>display_name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用户显示名</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>username</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用户名,支持模糊搜索(仅前缀)</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>mode</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>// mode - 低->高 bit
|
|
|
|
|
// 第1位:是否获得指针节点所对应的真实结点,1-是,0-否
|
|
|
|
|
// 第2位:是否展开WeakNode,即节点中类型不同的节点,1-展开,0-不展开
|
|
|
|
|
// 第3位:是否递归地展开节点(不建议)</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_num</td>
|
|
|
|
|
<td>integer</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>起始页,默认1</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_size</td>
|
|
|
|
|
<td>integer</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>页大小,默认10</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>page_sort</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>排序方式,格式:字段[排序方式]</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### deleteNodeMembers(param)
|
|
|
|
|
|
|
|
|
|
批量从组织关系中移除用户-内部使用
|
|
|
|
|
|
|
|
|
|
DELETE /v1/tree-nodes/{node_id}/tree-users
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>node_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>node id</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>ids</td>
|
|
|
|
|
<td>array</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### deleteMember(param)
|
|
|
|
|
|
|
|
|
|
从组织关系中移除用户-内部使用
|
|
|
|
|
|
|
|
|
|
DELETE /v1/tree-users/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>用户节点ID</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>ids</td>
|
|
|
|
|
<td>array</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用户与组织的关系ID</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>node_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>节点ID</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>user_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用户原始ID</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### deleteMembers(param)
|
|
|
|
|
|
|
|
|
|
从节点移除用户
|
|
|
|
|
|
|
|
|
|
DELETE /v1/tree-users
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>node_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>节点ID</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>user_id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>用户原始ID</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### createNode(param)
|
|
|
|
|
|
|
|
|
|
创建节点
|
|
|
|
|
|
|
|
|
|
POST /v1/tree-nodes
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### updateNode(param)
|
|
|
|
|
|
|
|
|
|
编辑节点
|
|
|
|
|
|
|
|
|
|
PATCH /v1/tree-nodes/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>更新树节点</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### deleteChildrenNodes(param)
|
|
|
|
|
|
|
|
|
|
删除节点
|
|
|
|
|
|
|
|
|
|
DELETE /v1/tree-nodes/{id}/children
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>object_code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>树对象code</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getNodes(param)
|
|
|
|
|
|
|
|
|
|
查询节点信息列表
|
|
|
|
|
|
|
|
|
|
GET /v1/tree-nodes
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>object_code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>创建树时的object_code</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>name</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>名字,支持前缀搜索</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>编号</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>tag</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>false</td>
|
|
|
|
|
<td>标签</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getNode(param)
|
|
|
|
|
|
|
|
|
|
查询节点信息
|
|
|
|
|
|
|
|
|
|
GET /v1/tree-nodes/{id}
|
|
|
|
|
|
|
|
|
|
##### param properties
|
|
|
|
|
|
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### getChildrenNodes(param)
|
2023-11-16 19:38:44 +08:00
|
|
|
|
|
2023-12-03 15:59:54 +08:00
|
|
|
|
获取子节点列表
|
2023-11-16 19:38:44 +08:00
|
|
|
|
|
2023-12-03 15:59:54 +08:00
|
|
|
|
GET /v1/tree-nodes/{id}/children
|
2023-11-16 19:38:44 +08:00
|
|
|
|
|
2023-12-03 15:59:54 +08:00
|
|
|
|
##### param properties
|
2023-11-16 19:38:44 +08:00
|
|
|
|
|
2023-12-03 15:59:54 +08:00
|
|
|
|
<table class="param-table">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr>
|
|
|
|
|
<th>名称</th>
|
|
|
|
|
<th>类型</th>
|
|
|
|
|
<th>是否必须</th>
|
|
|
|
|
<th>描述</th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<!-- path 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>id</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- query 参数 -->
|
|
|
|
|
<tr>
|
|
|
|
|
<td>mode</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>// mode - 低->高 bit
|
|
|
|
|
// 第1位:是否获得指针节点所对应的真实结点,1-是,0-否
|
|
|
|
|
// 第2位:是否展开WeakNode,即节点中类型不同的节点,1-展开,0-不展开
|
|
|
|
|
// 第3位:是否递归地展开节点(不建议)</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>object_code</td>
|
|
|
|
|
<td>string</td>
|
|
|
|
|
<td>true</td>
|
|
|
|
|
<td>当id = 0时必填,创建树时的object_code</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<!-- body 参数 -->
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|