768 lines
20 KiB
Markdown
768 lines
20 KiB
Markdown
### UserApi
|
||
[toc]
|
||
#### create(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>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>true</td>
|
||
<td>身份源ID，作为创建时记录，不做更新</td>
|
||
</tr>
|
||
</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>
|
||
|
||
#### 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>
|
||
|
||
#### batchDisable(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>
|
||
|
||
#### batchEnable(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>
|
||
|
||
#### 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>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>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>
|
||
<tr>
|
||
<td>status</td>
|
||
<td>string</td>
|
||
<td>false</td>
|
||
<td>状态，正常、禁用，后期扩展：离职、休假、借调。</td>
|
||
</tr>
|
||
</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>
|
||
|
||
#### batchDelete(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>
|
||
|
||
#### 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>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)
|
||
|
||
|
||
|
||
##### 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)
|
||
|
||
|
||
|
||
##### 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)
|
||
|
||
|
||
|
||
##### 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)
|
||
|
||
|
||
|
||
##### 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>
|
||
|