数据结构

AppAssociatedUserGroupIds

用户组删除时关联的应用信息

被如下接口引用：DeleteUserGroups。

名称	类型	描述
UserGroupId	String	用户组id 示例值：6cd22e51****f6f7cb81
ApplicationId	String	应用id 示例值：17c29b8c****c0228c48
ApplicationName	String	应用名称 示例值：WEB应用

ErrorDetails

失败详情

被如下接口引用：CreateApiImportUserJob, CreateFileExportUserJob, ListJobs。

名称	类型	描述
UserId	String	用户信息 示例值：53e25c3****e4eb5bd1
Error	String	失败原因 示例值：error message

ExportPropertyMap

导出属性映射

被如下接口引用：CreateFileExportUserJob。

名称	类型	必选	描述
UserPropertyCode	String	是	用户属性code 示例值：nickname
ColumnName	String	是	用户属性映射名称 示例值：昵称

FailedUsers

失败的用户

被如下接口引用：CreateApiImportUserJob, CreateFileExportUserJob, ListJobs。

名称	类型	描述
FailedUserIdentification	String	失败用户标识 示例值：53e25c3****e4eb5bd1
FailedReason	String	导入的用户失败原因 示例值：error reason

Filter

查询条件

被如下接口引用：CreateFileExportUserJob, ListLogMessageByCondition, ListUser, ListUserGroups。

名称	类型	必选	描述
Key	String	否	key值 示例值：key
Values	Array of String	否	value值 示例值：[value1, value2]
Logic	Boolean	否	逻辑值 示例值：true

ImportUser

导入用户信息
1、UserName，PhoneNumber ，Email ，WechatOpenId ，WechatUnionId ，AlipayUserId ，QqOpenId ，QqUnionId ，WeComUserId 九个属性中，导入时必须包含其中一个属性并遵守初始化自定义属性的正则表达式规则。UserName，PhoneNumber，Email的正则表达式在控制台的自定义属性中可以查询到。
2、对于密码的导入，导入的密码支持明文导入，MD5密文导入，SHA1密文导入，BCRYPT密文导入 ，这个需要在PasswordEncryptTypeEnum 字段中指定。
3、IdentityVerified，IdentityVerificationMethod 支持导入，
IdentityVerified 为true，IdentityVerificationMethod必传；
IdentityVerificationMethod 为nameAndIdCard，Name,ResidentIdentityCard必传
IdentityVerificationMethod 为nameIdCardAndPhone，Name,PhoneNumber,ResidentIdentityCard必传;

被如下接口引用：CreateApiImportUserJob。

名称	类型	必选	描述
UserName	String	否	用户名 示例值：zhangsan
PhoneNumber	String	否	手机号 示例值：132****0000
Email	String	否	邮箱 示例值：132****@qq.com
ResidentIdentityCard	String	否	身份证号 示例值：123456789012345678
Nickname	String	否	昵称 示例值：昵称1
Address	String	否	地址 示例值：北京市海淀区
UserGroup	Array of String	否	用户组ID 示例值：[6cd22e51****f6f7cb81]
QqOpenId	String	否	QQ qqOpenId 示例值：qqopenid
QqUnionId	String	否	QQ qqUnionId 示例值：qqunionid
WechatOpenId	String	否	微信wechatOpenId 示例值：wechatopenid
WechatUnionId	String	否	微信wechatUnionId 示例值：wechatunionid
AlipayUserId	String	否	支付宝alipayUserId 示例值：alipayuserid
WeComUserId	String	否	企业微信weComUserId 示例值：wecomuserid
Description	String	否	描述 示例值：用户1
Birthdate	Date	否	生日 示例值：1722420973329
Name	String	否	姓名 示例值：姓名
Locale	String	否	坐标 示例值：地理位置
Gender	String	否	性别（MALE;FEMALE;UNKNOWN） 示例值：男
IdentityVerificationMethod	String	否	实名核验方式 示例值：nameAndIdCard
IdentityVerified	Boolean	否	是否已实名核验 示例值：true
Job	String	否	工作 示例值：员工
Nationality	String	否	国家 示例值：汉族
Zone	String	否	时区 示例值：时区
Password	String	否	密码密文 示例值：password
CustomizationAttributes	Array of MemberMap	否	自定义属性
Salt	Salt	否	密码盐
PasswordEncryptTypeEnum	String	否	密码加密方式（SHA1;BCRYPT） 示例值：SHA1
IndexedAttribute1	String	否	索引字段1 示例值：value1
IndexedAttribute2	String	否	索引字段2 示例值：value2
IndexedAttribute3	String	否	索引字段3 示例值：value3
IndexedAttribute4	String	否	索引字段4 示例值：value4
IndexedAttribute5	String	否	索引字段5 示例值：value5

Job

任务详情

被如下接口引用：CreateApiImportUserJob, CreateFileExportUserJob, ListJobs。

名称	类型	描述
Id	String	任务ID 示例值：c29f2c0f****405ec698
Status	String	任务状态 PENDING 待执行 PROCESSING 执行中 COMPLETED 完成 FAILED 失败 示例值：PENDING
Type	String	任务类型 IMPORT_USER 用户导入 EXPORT_USER 用户导出 示例值：IMPORT_USER
CreatedDate	Integer	任务创建时间 示例值：1715156770024
Format	String	任务的数据类型 NDJSON New-line Delimited JSON CSV Comma-Separated Values 注意：此字段可能返回 null，表示取不到有效值。 示例值：NDJSON
Location	String	任务结果下载地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://aa.com/bb.csv
ErrorDetails	Array of ErrorDetails	失败详情 示例值：[{"UserId":"53e25c3****e4eb5bd1","Error":""}]
FailedUsers	Array of FailedUsers	失败的用户 注意：此字段可能返回 null，表示取不到有效值。

LogMessage

日志详情

被如下接口引用：ListLogMessageByCondition。

名称	类型	描述
LogId	String	日志标识 示例值：a23039fd****44a78adc
TenantId	String	租户ID 示例值：tenantId
UserStoreId	String	用户池ID 示例值：2c3aca3b****a7efe88e
EventCode	String	事件编码 示例值：FORGET_USERNAME
EventDate	Integer	事件发生时间戳，单位：毫秒 示例值：1703385600000
Description	String	描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：忘记用户名日志
Participant	String	事件参与者 TENANT 租户 USER 用户 示例值：TENANT
ApplicationClientId	String	应用clientId 示例值：YmFiZTk5****3ZGZiZmY
ApplicationName	String	应用名称 示例值：应用1
AuthSourceId	String	认证源ID 示例值：5c7df28a****2a3dbbae
AuthSourceName	String	认证源名称 示例值：账号密码认证源1
AuthSourceType	String	认证源类型 示例值：USERNAME_PASSWORD
AuthSourceCategory	String	认证源类别 示例值：UNIVERSAL
Ip	String	IP地址 示例值：127...1
UserAgent	String	用户代理 示例值：agent1
UserId	String	用户ID 示例值：53e25c3****e4eb5bd1
Detail	String	详情 注意：此字段可能返回 null，表示取不到有效值。 示例值：error detail
ActionResult	String	日志结果 注意：此字段可能返回 null，表示取不到有效值。 示例值：FAIL

MemberMap

Map数据类型

被如下接口引用：CreateApiImportUserJob, CreateUser, DescribeUser, DescribeUserById, ListUser, ListUserByProperty, UpdateUser。

名称	类型	必选	描述
Name	String	是	健 示例值：name
Value	String	是	值 示例值：value
Type	String	否	类型 示例值：STRING

Pageable

分页对象

被如下接口引用：DescribeUser, ListLogMessageByCondition, ListUser, ListUserGroups。

名称	类型	必选	描述
PageSize	Integer	是	每页数量 示例值：10
PageNumber	Integer	是	当前页码 示例值：1

QueryUserFilter

查询用户信息条件

被如下接口引用：DescribeUser。

名称	类型	必选	描述
PropertyKey	String	否	属性key 示例值：username
PropertyValue	String	否	属性value 示例值：zhangsan
Logic	Boolean	否	逻辑值，等于true，不等于false 示例值：true
OperateLogic	String	否	操作逻辑符（支持> < = >= <= != between） 示例值：!=

Salt

密码盐

被如下接口引用：CreateApiImportUserJob。

名称	类型	必选	描述
SaltValue	String	否	盐值 示例值：salt****
SaltLocation	SaltLocation	否	盐值位置

SaltLocation

盐位

被如下接口引用：CreateApiImportUserJob。

名称	类型	必选	描述
SaltLocationTypeEnum	String	否	密码加盐的类型（HEAD，TAIL，OTHER） 示例值：HEAD
SaltLocationRule	SaltLocationRule	否	加盐规则

SaltLocationRule

盐位规则

被如下接口引用：CreateApiImportUserJob。

名称	类型	必选	描述
Regex	String	否	表达式 示例值：passwordabc123

Sort

查询用户排序

被如下接口引用：DescribeUser。

名称	类型	必选	描述
PropertyKey	String	否	排序字段的key，参考自定义属性 示例值：name
Order	String	否	升序或者降序，ASC/DESC 示例值：DESC

User

用户信息

被如下接口引用：CreateUser, DescribeUser, DescribeUserById, ListUser, ListUserByProperty, UpdateUser。

名称	类型	描述
UserId	String	用户ID 示例值：53e25c3****e4eb5bd1
UserName	String	用户名 注意：此字段可能返回 null，表示取不到有效值。 示例值：zhangsan
PhoneNumber	String	手机号 注意：此字段可能返回 null，表示取不到有效值。 示例值：132****0000
Email	String	邮箱 注意：此字段可能返回 null，表示取不到有效值。 示例值：132****@qq.com
LastSignOn	Integer	上次登录时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1711002933442
CreatedDate	Integer	创建时间 示例值：1718332940956
Status	String	状态 示例值：NORMAL
UserDataSourceEnum	String	用户来源 示例值：管理员添加
Nickname	String	昵称 注意：此字段可能返回 null，表示取不到有效值。 示例值：昵称1
Address	String	地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：北京市海淀区
Birthdate	Integer	生日 注意：此字段可能返回 null，表示取不到有效值。 示例值：1706682491339
UserGroups	Array of String	用户组ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：[6cd22e51****f6f7cb81]
LastModifiedDate	Integer	上次修改时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1722420973329
CustomAttributes	Array of MemberMap	自定义属性 示例值：[{"Name":"test_name","Value":"test_value","Type":"test_type"}]
ResidentIdentityCard	String	身份证号 注意：此字段可能返回 null，表示取不到有效值。 示例值：123456789012345678
QqOpenId	String	QQ的OpenId 注意：此字段可能返回 null，表示取不到有效值。 示例值：qqopenid
QqUnionId	String	QQ的UnionId 注意：此字段可能返回 null，表示取不到有效值。 示例值：qqunionid
WechatOpenId	String	微信的WechatOpenId 注意：此字段可能返回 null，表示取不到有效值。 示例值：wechatopenid
WechatUnionId	String	微信的WechatUnionId 注意：此字段可能返回 null，表示取不到有效值。 示例值：wechatunionid
AlipayUserId	String	支付宝的AlipayUserId 注意：此字段可能返回 null，表示取不到有效值。 示例值：alipayuserid
WeComUserId	String	企业微信的WeComUserId 注意：此字段可能返回 null，表示取不到有效值。 示例值：wecomuserid
Description	String	描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：用户1
Name	String	姓名 注意：此字段可能返回 null，表示取不到有效值。 示例值：姓名
Locale	String	坐标 注意：此字段可能返回 null，表示取不到有效值。 示例值：地理位置
Gender	String	性别 注意：此字段可能返回 null，表示取不到有效值。 示例值：男
IdentityVerificationMethod	String	实名核验方式 注意：此字段可能返回 null，表示取不到有效值。 示例值：nameAndIdCard
IdentityVerified	Boolean	是否已经实名核验 示例值：true
Job	String	工作 注意：此字段可能返回 null，表示取不到有效值。 示例值：员工
Nationality	String	国家 注意：此字段可能返回 null，表示取不到有效值。 示例值：汉族
Primary	Boolean	是否主账号（进行过账号融合后，主账号为true，从账号为false） 示例值：true
Zone	String	时区 注意：此字段可能返回 null，表示取不到有效值。 示例值：时区
AlreadyFirstLogin	Boolean	是否已经首次登录 示例值：true
TenantId	String	租户id 示例值：tenantId
UserStoreId	String	用户目录id 示例值：2c3aca3b****a7efe88e
Version	Integer	版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
LockType	String	锁定类型（分为管理员锁定，和登录策略锁定） 注意：此字段可能返回 null，表示取不到有效值。 示例值：failureLock
LockTime	Integer	锁定时间点 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
IndexedAttribute1	String	索引字段1 注意：此字段可能返回 null，表示取不到有效值。 示例值：value1
IndexedAttribute2	String	索引字段2 注意：此字段可能返回 null，表示取不到有效值。 示例值：value2
IndexedAttribute3	String	索引字段3 注意：此字段可能返回 null，表示取不到有效值。 示例值：value3
IndexedAttribute4	String	索引字段4 注意：此字段可能返回 null，表示取不到有效值。 示例值：value4
IndexedAttribute5	String	索引字段5 注意：此字段可能返回 null，表示取不到有效值。 示例值：value5

UserGroup

用户组

被如下接口引用：ListUserGroups。

名称	类型	描述
UserGroupId	String	用户组ID 示例值：6cd22e51****f6f7cb81
DisplayName	String	用户组名称 示例值：用户组1
Description	String	用户组描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：包含了一组用户
UserStoreId	String	用户目录ID 示例值：2c3aca3b****a7efe88e
TenantId	String	租户ID 示例值：tenantId
CreatedDate	Integer	创建时间 示例值：1651073285427
LastModifyDate	Integer	最近更新时间 示例值：1651073285306

UserGroupDeleteResp

删除用户组信息时返回的详情

被如下接口引用：DeleteUserGroups。

名称	类型	描述
ErrorMessage	String	错误详情 示例值：error message
AppAssociatedUserGroupIds	Array of AppAssociatedUserGroupIds	用户组关联的应用信息 示例值：[6cd22e51****f6f7cb81]

UserStore

用户池

被如下接口引用：ListUserStore。

名称	类型	描述
TenantId	String	租户ID 示例值：tenantId
UserStoreLogo	String	用户池logo 注意：此字段可能返回 null，表示取不到有效值。 示例值：https://aa.com/bb.png
UserStoreDesc	String	用户池描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：管理应用和用户
UserStoreName	String	用户池名称 示例值：目录1
UserNum	Integer	用户数量 示例值：10
UserStoreId	String	用户池ID 示例值：2c3aca3b****a7efe88e
AppNum	Integer	应用数量 示例值：10
LastStatus	Boolean	上次切换的用户池 示例值：true
DefaultStatus	Boolean	默认用户池 示例值：true
CreateDate	Integer	创建时间 示例值：1706682491339
LastStatusTime	Integer	上次切换时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713168583556
UserStoreProtocolHost	String	用户目录域名 注意：此字段可能返回 null，表示取不到有效值。 示例值：leecpn