租户端 基础平台 基础平台 数据结构

数据结构

最近更新时间: 2024-10-18 10:38:27

ApiKeyDetail

持久密钥详情

被如下接口引用：GetSelfApiKey

名称 必选 允许NULL 类型 描述
SecretId 否 否 String 密钥ID
SecretKey 否 否 String 密钥Key
CreateTime 否 否 Uint64 创建时间(时间戳)
Status 否 否 Uint64 状态(2:有效, 3:禁用)
Remark 否 否 String 备注
Source 否 否 Uint64 数据源

AttributeUserInfo

用户信息

被如下接口引用：GetUserByAttributeValue

名称 必选 允许NULL 类型 描述
Uin 否 否 Uint64 uin
UserName 否 否 String 用户名称
NickName 否 否 String 用户名称

AccountAttributeAndValue

扩展属性值

被如下接口引用：GetAttributeValues

名称 必选 允许NULL 类型 描述
AttributeName 否 否 String 属性名称
Attribute 否 否 String 属性
AttributeId 否 否 Int64 属性id
ValueId 否 否 Int64 值id
Uin 否 否 Int64 uin
Value 否 否 String 值

AccountAttributeValue

扩展属性值

被如下接口引用：SetAttributeValues

名称 必选 允许NULL 类型 描述
Attribute 否 否 String 属性
AttributeName 否 否 String 属性名称
AttributeValue 否 否 String 属性值
AttributeId 否 否 Int64 属性id

SafeAuthFlag

安全认证标识

被如下接口引用：GetSafeAuthConfig、SetSafeAuthFlag

名称 必选 允许NULL 类型 描述
Phone 是 否 Int64 是否进行手机号认证，0-否，1-是
Token 是 否 Int64 是否进行token认证，0-否，1-是
Stoken 是 否 Int64 是否进行stoken认证，0-否，1-是
Ukey 否 否 Int64 是否进行ukey检查

LoginMfa

登陆多因子认证

被如下接口引用：GetMasterList、GetMasterListV2、GetMasterListWithStatus

名称 必选 允许NULL 类型 描述
NeedAuth 是 否 Int64 是否需要认证
AuthType 是 否 Int64 认证类型
AuthPhone 是 否 String 认证手机号

SafeAuthFlagInfo

安全认证信息

被如下接口引用：GetSafeAuthConfig

名称 必选 允许NULL 类型 描述
LoginFlag 是 是 SafeAuthFlag 登陆标识
ActionFlag 是 是 SafeAuthFlag action标识
OffsiteFlag 是 是 SafeAuthOffsiteFlag 外围标识

LoginInfo

登录信息

被如下接口引用：GetLastLoginInfo

名称 必选 允许NULL 类型 描述
ClientIP 否 否 String 客户端ip
ClientUA 否 否 String 客户端代理
DeviceId 否 否 String 设备id
Id 否 否 Int64 id
Location 否 否 String 登录地址
LoginFlag 否 否 Int64 登录标识
LoginTime 否 否 String 登录时间
OwnerUin 否 否 Uint64 主账户uin
Uin 否 否 Uint64 uin
UpdateTime 否 否 String 更新时间

ExtAttr

额外属性

被如下接口引用：DescribeSubAccounts、GetMasterList、GetMasterListV2、GetMasterListWithStatus

名称 必选 允许NULL 类型 描述
NeedResetToken 是 是 Int64 需要重置mfa的token
NeedResetStoken 是 是 Int64 需要重置mfa的token

ApiKey

API密钥数据列表

被如下接口引用：CreateSelfApiKey、QuerySelfApiKey

名称 必选 允许NULL 类型 描述
SecretId 否 否 String 密钥ID
CreateTime 否 否 Uint64 创建时间(时间戳)
Status 否 否 Uint64 状态(2:有效, 3:禁用)
Remark 否 否 String 备注
Source 否 否 Uint64 数据源

AccountExistData

账户存在时的账户信息

被如下接口引用：

名称 必选 允许NULL 类型 描述
Uin 是 否 Uint64 账户唯一id
Account 是 否 String 用户名
Nick 是 否 String 昵称
Status 是 否 Int64 账户状态
TypeBind 是 否 Int64 账户绑定类型
IsRegAccount 是 否 Int64 是否为注册账户
UpdateTime 是 否 String 最近一次更新时间

AccountDetail

账号详情

被如下接口引用：AddSubAccount

名称 必选 允许NULL 类型 描述
ActionFlag 否 否 ActionLoginFlag 敏感操作标识
ConsoleLogin 否 否 String 是否允许控制台登录
LoginFlag 否 否 ActionLoginFlag 登录保护
NeedResetPassword 否 否 String 是否需要重置密码
Password 否 否 String 用户密码
UseApi 否 否 String 使用Api

SubAccountUser

子账号列表

被如下接口引用：DescribeSubAccounts

名称 必选 允许NULL 类型 描述
Uid 否 是 Uint64 子用户 UID
Uin 否 是 Int64 子用户用户 ID
OwnerUin 否 是 Uint64 主账号ID
Name 否 是 String 账号名称
PhoneNum 否 是 String 联系手机
PhoneFlag 否 是 Int64 电话号码是否验证
Email 否 是 String 联系邮箱
EmailFlag 否 是 Int64 邮箱是否验证
CountryCode 否 是 String 区号
CanLogin 否 是 Int64 是否允许登录
ConsoleLogin 否 是 Int64 是否允许控制台登录
SystemType 否 是 String 类型
WxzsStatus 否 是 Int64 微信公众号关注状态
NeedResetPassword 否 是 Int64 是否需要重置密码
ExtAttr 否 是 ExtAttr 额外属性

SafeAuthOffsiteFlag

安全认证外围标识

被如下接口引用：GetSafeAuthConfig

名称 必选 允许NULL 类型 描述
VerifyFlag 是 否 Int64 验证标识
NotifyPhone 是 否 Int64 是否进行电话通知
NotifyEmail 是 否 Int64 是否进行

AccountAttribute

扩展属性

被如下接口引用：GetAttributeName

名称 必选 允许NULL 类型 描述
AttributeId 否 否 Int64 id
AttributeName 否 否 String 属性名称
Attribute 否 否 String 属性

ActionLoginFlag

登录操作敏感标识

被如下接口引用：AddSubAccount

名称 必选 允许NULL 类型 描述
Phone 否 否 String 电话
Stoken 否 否 String 软Token
Token 否 否 String 硬Token

UserProductUsableInfo

用户可用产品信息

被如下接口引用：GetUserProductUsable

名称 必选 允许NULL 类型 描述
Unit 否 否 String 单位
ProductId 否 否 String 产品id
IsOpen 否 否 Int64 是否打开
Nums 否 否 Int64 总量
DeadNums 否 否 Int64 DeadNums
Prefix 否 否 String 前缀
RegionId 否 否 String 区域id

UserInfo

用户信息

被如下接口引用：AddSubAccount

名称 必选 允许NULL 类型 描述
CanLogin 否 否 String 子账号类型
CountryCode 否 否 String 区号
Detail 否 否 AccountDetail 详情
Name 否 否 String 名称
PhoneNum 否 否 String 电话号码
SyStemType 否 否 String 系统类型

SafeAuthTokenInfo

安全认证token信息

被如下接口引用：GetSafeAuthConfig

名称 必选 允许NULL 类型 描述
Status 否 否 Int64 状态，0-未分配，1-已分配，2-已绑定，3-已解绑
TokenSn 否 否 String token序列号
TokenType 否 否 Int64 token类型，1-hard token, 2-soft token，3-ukey
TokenSource 否 否 String 设备厂商来源

SubAccounts

子用户信息

被如下接口引用：AddSubAccount

名称 必选 允许NULL 类型 描述
Name 否 是 String 名字
Token 否 是 String Token
Password 否 是 String 密码
SecretId 否 是 String 秘钥Id
SecretKey 否 是 String 秘钥Key

OwnerInfo

主账户信息

被如下接口引用：GetMasterList、GetMasterListV2、GetMasterListWithStatus

名称 必选 允许NULL 类型 描述
Uin 否 是 Uint64 账户唯一id
UserName 否 是 String 用户名
DisplayName 否 是 String 显示名称
CheckStatus 否 是 Int64 账户状态
Account 否 是 String 用户名
IsDefaultOwner 否 是 Bool 是否为该子账户的默认主账户
Phone 否 是 String 手机号，打掩码处理
Email 否 是 String 邮箱，掩码处理
ExtAttr 否 是 ExtAttr 扩展属性
LoginMfa 否 是 LoginMfa 多因子认证

AccountRequest

getInfoByFields中账户信息参数

被如下接口引用：GetInfoByFields

名称 必选 允许NULL 类型 描述
Type 是 否 String 账户类型
Id 是 否 String 账户id
OwnerUin 是 否 String 主账户id
SubAccountList 否 否 String 子账户id列表
UidList 否 否 String uid列表
RoleList 否 否 String 角色列表
GroupList 否 否 String 用户组列表

MultIFactor

多因子配置

被如下接口引用：GetMultiFactorParas

名称 必选 允许NULL 类型 描述
MultiFactorChoices 否 否 Int64 MultiFactorChoices
MultiFactorcChangable 否 否 Int64 MultiFactorcChangable
MultiActionChoices 否 否 Int64 MultiActionChoices
MultiActionChangable 否 否 Int64 MultiActionChangable
MfaHardTokenSource 否 否 String MfaHardTokenSource

CategoryList

账号类别

被如下接口引用：DescribeUserCategory

名称 必选 允许NULL 类型 描述
CategoryId 否 否 String 类别Id
CategoryKey 否 否 String 类别键
CategoryValue 否 否 String 类别值