liuyafei
/
flow-doc-deleted
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
flow-doc-deleted/api/ModuleApplication.md

1270 lines
32 KiB
Markdown
Raw Normal View History

feat::rocket: op api模块完成
2023-11-16 19:38:44 +08:00
### AppApi
[toc]
#### create(param)
feat::sparkles: giegie 吃糖吗？
2023-11-16 18:03:05 +08:00
feat::rocket: op api模块完成
2023-11-16 19:38:44 +08:00
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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>允许的登录方式，格式为：[&#34;password&#34;, &#34;vercode&#34;]</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>允许注册方式，格式为：[&#34;mobile&#34;, &#34;email&#34;]</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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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)
##### 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>
#### getAccounts(param)
##### 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>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>