flow-doc-deleted/api/ModulePermission.md

1109 lines
28 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

### PermissionApi
[toc]
#### getPrivileges(param)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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>