API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 账号风控平台 > 数据结构

数据结构

最近更新时间：2023-08-17 01:49:06

我的收藏

本页目录：

AppAssociatedUserGroupIds

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

被如下接口引用：DeleteUserGroups。

名称 类型 描述
UserGroupId String 用户组id
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx
ApplicationId String 应用id
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx
ApplicationName String 应用名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx

ErrorDetails

失败详情

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

名称 类型 描述
UserId String 用户信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx
Error String 失败原因
示例值：xxx

ExportPropertyMap

导出属性映射

被如下接口引用：CreateFileExportUserJob。

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

FailedUsers

失败的用户

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

名称 类型 描述
FailedUserIdentification String 失败用户标识
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx
FailedReason String 导入的用户失败原因
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx

Filter

查询条件

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

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

ImportUser

导入用户信息
1、UserName，PhoneNumber ，Email ，WechatOpenId ，WechatUnionId ，AlipayUserId ，QqOpenId ，QqUnionId 八个属性中，导入时必须包含其中一个属性并遵守初始化自定义属性的正则表达式规则。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 否 用户名
示例值：xxx
PhoneNumber String 否 手机号
示例值：xxx
Email String 否 邮箱
示例值：xxx
ResidentIdentityCard String 否 身份证号
示例值：xxx
Nickname String 否 昵称
示例值：xxx
Address String 否 地址
示例值：xxx
UserGroup Array of String 否 用户组ID
示例值：[xxx]
QqOpenId String 否 QQ qqOpenId
示例值：xxx
QqUnionId String 否 QQ qqUnionId
示例值：xxx
WechatOpenId String 否 微信wechatOpenId
示例值：xxx
WechatUnionId String 否 微信wechatUnionId
示例值：xxx
AlipayUserId String 否 支付宝alipayUserId
示例值：xxx
Description String 否 描述
示例值：xxx
Birthdate Date 否 生日
示例值：xxx
Name String 否 姓名
示例值：xxx
Locale String 否 坐标
示例值：xxx
Gender String 否 性别（MALE;FEMALE;UNKNOWN）
示例值：xxx
IdentityVerificationMethod String 否 实名核验方式
示例值：xxx
IdentityVerified Boolean 否 是否已实名核验
示例值：xxx
Job String 否 工作
示例值：xxx
Nationality String 否 国家
示例值：xxx
Zone String 否 时区
示例值：xxx
Password String 否 密码密文
示例值：xxx
CustomizationAttributes Array of MemberMap 否 自定义属性
Salt Salt 否 密码盐
PasswordEncryptTypeEnum String 否 密码加密方式（SHA1;BCRYPT）
示例值：xxx
IndexedAttribute1 String 否 索引字段1
示例值：xxx
IndexedAttribute2 String 否 索引字段2
示例值：xxx
IndexedAttribute3 String 否 索引字段3
示例值：xxx
IndexedAttribute4 String 否 索引字段4
示例值：xxx
IndexedAttribute5 String 否 索引字段5
示例值：xxx

Job

任务详情

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

名称 类型 描述
Id String 任务ID
示例值：xxx
Status String 任务状态

  • PENDING
    • 待执行
  • PROCESSING
    • 执行中
  • COMPLETED
    • 完成
  • FAILED
    • 失败
    示例值：xxx
    Type String 任务类型

  • IMPORT_USER
    • 用户导入
  • EXPORT_USER
    • 用户导出
    示例值：xxx
    CreatedDate Integer 任务创建时间
    示例值：10
    Format String 任务的数据类型

  • NDJSON
    • New-line Delimited JSON
  • CSV
    • Comma-Separated Values
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    Location String 任务结果下载地址
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    ErrorDetails Array of ErrorDetails 失败详情
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    FailedUsers Array of FailedUsers 失败的用户
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx

    LogMessage

    日志详情

    被如下接口引用：ListLogMessageByCondition。

    名称 类型 描述
    LogId String 日志标识
    示例值：xxx
    TenantId String 租户ID
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    UserStoreId String 用户池ID
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    EventCode String 事件编码
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    EventDate Integer 事件发生时间戳，单位：毫秒
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：10
    Description String 描述
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    Participant String 事件参与者

  • TENANT
    • 租户
  • USER
    • 用户
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    ApplicationClientId String 应用clientId
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    ApplicationName String 应用名称
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    AuthSourceId String 认证源ID
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    AuthSourceName String 认证源名称
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    AuthSourceType String 认证源类型
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    AuthSourceCategory String 认证源类别
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    Ip String IP地址
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    UserAgent String 用户代理
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    UserId String 用户ID
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    Detail String 详情
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx

    MemberMap

    Map数据类型

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

    名称 类型 必选 描述
    Name String 是 健
    示例值：xxx
    Value String 是 值
    示例值：xxx
    Type String 否 类型
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx

    Pageable

    分页对象

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

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

    QueryUserFilter

    查询用户信息条件

    被如下接口引用：DescribeUser。

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

    Salt

    密码盐

    被如下接口引用：CreateApiImportUserJob。

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

    SaltLocation

    盐位

    被如下接口引用：CreateApiImportUserJob。

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

    SaltLocationRule

    盐位规则

    被如下接口引用：CreateApiImportUserJob。

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

    Sort

    查询用户排序

    被如下接口引用：DescribeUser。

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

    User

    用户信息

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

    名称 类型 描述
    UserId String 用户ID
    示例值：xxx
    UserName String 用户名
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    PhoneNumber String 手机号
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    Email String 邮箱
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    LastSignOn Integer 上次登录时间
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    CreatedDate Integer 创建时间
    示例值：xxx
    Status String 状态
    示例值：xxx
    UserDataSourceEnum String 用户来源
    示例值：xxx
    Nickname String 昵称
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    Address String 地址
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    Birthdate Integer 生日
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：0
    UserGroups Array of String 用户组ID
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：[xxx]
    LastModifiedDate Integer 上次修改时间
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：0
    CustomAttributes Array of MemberMap 自定义属性
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：[]
    ResidentIdentityCard String 身份证号
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    QqOpenId String QQ的OpenId
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    QqUnionId String QQ的UnionId
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    WechatOpenId String 微信的WechatOpenId
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    WechatUnionId String 微信的WechatUnionId
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    AlipayUserId String 支付宝的AlipayUserId
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    Description String 描述
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    Name String 姓名
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    Locale String 坐标
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    Gender String 性别
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    IdentityVerificationMethod String 实名核验方式
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    IdentityVerified Boolean 是否已经实名核验
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：true
    Job String 工作
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    Nationality String 国家
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    Primary Boolean 是否主账号（进行过账号融合后，主账号为true，从账号为false）
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：true
    Zone String 时区
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    AlreadyFirstLogin Boolean 是否已经首次登录
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：true
    TenantId String 租户id
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    UserStoreId String 用户目录id
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    Version Integer 版本
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：0
    LockType String 锁定类型（分为管理员锁定，和登录策略锁定）
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    LockTime Integer 锁定时间点
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：0
    IndexedAttribute1 String 索引字段1
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    IndexedAttribute2 String 索引字段2
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    IndexedAttribute3 String 索引字段3
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    IndexedAttribute4 String 索引字段4
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    IndexedAttribute5 String 索引字段5
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx

    UserGroup

    用户组

    被如下接口引用：ListUserGroups。

    名称 类型 描述
    UserGroupId String 用户组ID
    示例值：xxx
    DisplayName String 用户组名称
    示例值：xxx
    Description String 用户组描述
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：XXX
    UserStoreId String 用户目录ID
    示例值：xxx
    TenantId String 租户ID
    示例值：xxx
    CreatedDate Integer 创建时间
    示例值：10
    LastModifyDate Integer 最近更新时间
    示例值：10

    UserGroupDeleteResp

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

    被如下接口引用：DeleteUserGroups。

    名称 类型 描述
    ErrorMessage String 错误详情
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    AppAssociatedUserGroupIds Array of AppAssociatedUserGroupIds 用户组关联的应用信息
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：[]

    UserStore

    用户池

    被如下接口引用：ListUserStore。

    名称 类型 描述
    TenantId String 租户ID
    示例值：xxx
    UserStoreLogo String 用户池logo
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    UserStoreDesc String 用户池描述
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    UserStoreName String 用户池名称
    示例值：xxx
    UserNum Integer 用户数量
    示例值：10
    UserStoreId String 用户池ID
    示例值：xxx
    AppNum Integer 应用数量
    示例值：10
    LastStatus Boolean 上次切换的用户池
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：true
    DefaultStatus Boolean 默认用户池
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：true
    CreateDate Integer 创建时间
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：10
    LastStatusTime Integer 上次切换时间
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：10
    UserStoreProtocolHost String 用户目录域名
    注意：此字段可能返回 null，表示取不到有效值。
    示例值：xxx
    中国站