flow-doc-deleted/api/ModuleIdentity.md

UserApi

[toc]

create(param)

param properties

名称	类型	是否必须	描述
username	string	false	用户名，唯一，不传后台自动生成
password	string	false	密码，不传后台生成默认密码
display_name	string	false	显示名称
firstname	string	false	名
lastname	string	false	姓
realname	string	false	真实姓名
pinyin	string	false	拼音
nickname	string	false	昵称
user_type	string	false	用户类型，不传后台设置系统默认类型
mobile	string	false	手机
email	string	false	邮箱
gender	string	false	性别
cert_type	string	false	证件类型
cert_number	string	false	证件号
region	string	false	区域
work_time	string	false	加入时间
work_title	string	false	职位
ext_prop	json	false	扩展信息，json对象{"age": 18, "love": "足球"}
status	string	false	状态：1正常，0禁用，后期扩展：离职、休假、借调。
password_status	string	false	密码状态（valid/invalid）
idp_config_id	number	true	身份源ID，作为创建时记录，不做更新

disable(param)

param properties

名称	类型	是否必须	描述
id	string	true

enable(param)

param properties

名称	类型	是否必须	描述
id	string	true

batchDisable(param)

param properties

名称	类型	是否必须	描述
ids	array	true

batchEnable(param)

param properties

名称	类型	是否必须	描述
ids	array	true

modify(param)

param properties

名称	类型	是否必须	描述
id	string	true
username	string	false	用户名，验证唯一
password	string	false	密码
display_name	string	false	显示名称
firstname	string	false	名
lastname	string	false	姓
realname	string	false	真实姓名
pinyin	string	false	拼音
nickname	string	false	昵称
mobile	string	false	手机
email	string	false	邮箱
gender	string	false	性别：1男，0女
cert_type	string	false	证件类型
cert_number	string	false	证件号
region	string	false	区域
work_time	string	false	加入时间
work_title	string	false	职位
ext_prop	json	false	扩展信息，json对象{"age": 18, "love": "足球"}
last_login_ipaddr	string	false	上次登录IP
last_login_time	string	false	上次登录时间
status	string	false	状态，正常、禁用，后期扩展：离职、休假、借调。

delete(param)

param properties

名称	类型	是否必须	描述
id	string	true

batchDelete(param)

param properties

名称	类型	是否必须	描述
ids	array	true

list(param)

param properties

名称	类型	是否必须	描述
page_size	integer	false
page_num	integer	false
search_type	string	false	默认按用户字段搜索，当值为：generic时，全文检索
keyword	string	false	检索值

get(param)

param properties

名称	类型	是否必须	描述
id	string	true

modifyPassword(param)

param properties

名称	类型	是否必须	描述
id	string	true
old_password	string	false
new_password	string	false

getStoredCredentials(param)

param properties

名称	类型	是否必须	描述
user_id	number	false	用户id标识
provider_code	string	false	社会化登录提供者的code
idp_config_id	number	false	社会化登录配置的ID
id1	string	false	社会化身份标识1，约定此字段保存用户唯一标识，如openid
id2	string	false	社会化身份标识2，如unionid
metadata	string	false	更多社会化身份标识
status	string	false	状态
username	string	false	用户名
display_name	string	false	显示名
page_size	integer	false
page_num	integer	false

createStoreCredential(param)

param properties

名称	类型	是否必须	描述
provider_code	string	false	社会化身份源code
id1	string	false	社会化身份标识1，如openid
id2	string	false	社会化身份标识2，如unionid
metadata	string	false	更多社会化身份标识
status	string	false	状态
nickname	string	false	昵称
avatar	string	false	头像
id_provider_connection	string	false
idp_config_id	number	false	社会化登录配置的ID
realname	string	false	真实姓名
mobile	string	false	手机
email	string	false	邮箱
gender	string	false	性别