数据结构

最近更新时间: 2024-09-03 18:50:08

RoleInfo

角色详细信息

被如下接口引用:DescribeRoleList、GetRole

名称 必选 允许NULL 类型 描述
RoleId String 角色ID
RoleName String 角色名称
PolicyDocument String 角色的策略文档
Description String 角色描述
AddTime String 角色的创建时间
UpdateTime String 角色的最近一次时间
DeletionTaskId String 兼容公有云字段,无含义
ConsoleLogin Uint64 角色是否允许登录
RoleType String 角色类型,取user、system或service_linked
SessionDuration Uint64 有效时间

PermList

API信息列表

被如下接口引用:DescribeCamServiceAndPerm

名称 必选 允许NULL 类型 描述
PermId String Id
ApiZhName String API中文名
ApiEnName Array of ApiEnNameList API英文名信息列表
IsNeedObject String 是否需要关联对象
IsSpResource String 是否支持实例级鉴权
PmService String pmService

GroupData

用户组相关信息

被如下接口引用:GetAllSubUser

名称 必选 允许NULL 类型 描述
GroupId Int64 用户组id
GroupName String 用户组名称
GroupNum Int64 用户组成员数量
Channel Int64 创建渠道
GroupMem Array of Uint64 组成员uid

RolePolicyList

角色策略列表

被如下接口引用:GetServiceRoleInfo

名称 必选 允许NULL 类型 描述
IsHidden Uint64 状态
PolicyId Uint64 策略Id
PolicyName String 策略名

PrincipalServiceRoleCases

服务角色案例

被如下接口引用:GetPrincipalService

名称 必选 允许NULL 类型 描述
RoleName String 角色名
ServiceName String 服务载体名
CaseName String 场景中文名
CaseEnName String 场景英文名
RoleDesc String 角色描述
RoleEnDesc String 角色英文描述

Name

名称

被如下接口引用:GetPrincipalService

名称 必选 允许NULL 类型 描述
Zh String 中文
En String 英文

AccountDetail

账号详情

被如下接口引用:AddSubAccount

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

UserData

用户信息数据

被如下接口引用:GetAllSubUser

名称 必选 允许NULL 类型 描述
Uid Uint64 子用户id
Uin Uint64 账号唯一序列号
Name String 用户名称
PhoneNum String 电话号码
CountryCode String 区号
PhoneFlag Int64 电话认证标志
Email String 邮箱地址
EmailFlag Int64 邮箱是否认证
UserType Int64 用户类型
CreateTime String 创建时间
WechatFlag Int64 微信标识
SystemType String 账号系统类型
IsReceiverOwner Int64 是否为主账号

SubAccountInfo

子账户用户信息

被如下接口引用:UpdateSubAccount

名称 必选 允许NULL 类型 描述
CanLogin String 能否登陆,0-否,1-可
ConsoleLogin String 是否是控制台登陆,1-是
CountryCode String 国家编码
Name String 用户名
NeedResetPassword String 是否需要重置密码,1-是
PhoneNum String 手机号
Remark String 备注
SystemType String 账户类型
Uid String 接收者用户ID
Uin String 账户唯一id
Password String 密码
WxzsStatus Int64 微信消息状态
UserType Int64 用户类型
Email String 联系邮箱
Account String 用户名
Lang String 语言
NickName String 昵称

GroupMemberInfo

用户组用户信息

被如下接口引用:DescribeGroups、GetGroupList、GetSubsGroup、ListGroups

名称 必选 允许NULL 类型 描述
Uid Uint64 子用户 Uid。
Uin Uint64 子用户 Uin。
Name String 子用户名称。
PhoneNum String 手机号。
CountryCode String 手机区域代码。
PhoneFlag Uint64 是否已验证手机。
Email String 邮箱地址。
EmailFlag Uint64 是否已验证邮箱。
UserType Uint64 用户类型。
CreateTime String 创建时间。
IsReceiverOwner Uint64 是否为主消息接收人。
QywxUserId String 企业微信id

ServiceItem

服务

被如下接口引用:GetServiceList

名称 必选 允许NULL 类型 描述
AddTime Datetime 创建时间
ArnDocument String ArnDocument
ColConf String ColConf
DefAddr String DefAddr
DefaultStrategyList String 默认策略
IsAllowDefProj String IsAllowDefProj
IsDisProject String IsDisProject
IsDisZone String IsDisZone
IsSeen String 是否可见
Online String Online
QueryAddr String QueryAddr
QueryInterface String QueryInterface
ServiceEnName String 服务英文名
ServiceName String 服务名
ServiceType String 服务类型
SynInterface String SynInterface
UpdateTime Datetime 变更时间
Weight String Weight
WhiteKey String WhiteKey
Writter String 创建人
ResourceTypeList ResourceTypeItem 资源类型数组
Type String 类型

AttachedStrategyInfo

策略信息

被如下接口引用:DescribeAttachedEntityPolicies

名称 必选 允许NULL 类型 描述
PolicyId Uint64 策略ID。
PolicyName String 策略名称。
AddTime Datetime 策略创建时间。
CreateMode Uint64 创建来源,1 通过控制台创建, 2 通过策略语法创建。
Description String 策略描述。

PrinciPalService

服务账号详情

被如下接口引用:GetPrincipalService

名称 必选 允许NULL 类型 描述
Domain String 域名
Name Name 名称
ServiceLinkedRole Uint64 是否存在服务相关角色
RoleCases PrincipalServiceRoleCases 角色场景信息
ServiceType String 业务模块名

GroupMeta

用户组元信息

被如下接口引用:GetUserGroupList、ListAllUserGroup

名称 必选 允许NULL 类型 描述
GroupId Int64 用户组id
GroupName String 用户组名称

GroupUserInfo

用户组下用户信息

被如下接口引用:GetGroupsSubAccount、ListUsersForGroup

名称 必选 允许NULL 类型 描述
Uid Uint64 接收者用户id
Uin Uint64 账户唯一id
Name String 用户名
PhoneNum String 手机号
CountryCode String 国家编码
PhoneFlag String 手机号标识
Email String 邮箱
EmailFlag String 邮箱标识
UserType Int64 用户类型
CreateTime String 创建时间
IsReceiverOwner String 是否是主账户
SystemType String 账户类型
NickName String 昵称

ListOpenPlatform

第三方平台详细信息

被如下接口引用:ListOpenPlatforms

名称 必选 允许NULL 类型 描述
OpenId Int64 openid
AppId String app id
OpenName String app name
OpenLogo String open logo
OpenHome String 第三方平台主页
OpenType Int64 授权类型
Uin Uint64 申请账号
Status Int64 状态
Domain String 第三方平台域名
State Int64 冻结状态,0-非冻结,1-冻结
Modifier String 修改人
ModifyTime String 更新时间
CreateTime String 创建时间
Memo String 备注

OwnerInfo

主账号信息

被如下接口引用:ListSubAccounts

名称 必选 允许NULL 类型 描述
Uin Uint64 主帐号Uin
UserName String 用户名
CheckStatus Uint64 校验状态

AttachedUserPolicy

用户关联的策略详情

被如下接口引用:ListAttachedUserAllPolicies

名称 必选 允许NULL 类型 描述
PolicyId String 策略ID
PolicyName String 策略名
Description String 策略描述
AddTime String 创建时间
StrategyType String 策略类型(1表示自定义策略,2表示预设策略)
CreateMode String 创建模式(1表示按产品或项目权限创建的策略,其他表示策略语法创建的策略)
Groups Array of AttachedUserPolicyGroupInfo 随组关联信息

StrategyInfo

策略信息

被如下接口引用:ListPolicies、ListPoliciesByAction

名称 必选 允许NULL 类型 描述
PolicyId Uint64 策略ID。
PolicyName String 策略名称。
AddTime Datetime 策略创建时间。
Type Uint64 策略类型。1 表示自定义策略,2 表示预设策略。
Description String 策略描述。
CreateMode Uint64 创建来源,1 通过控制台创建, 2 通过策略语法创建。
Attachments Uint64 关联的用户数
ServiceType String 策略关联的产品
IsAttached Uint64 当需要查询标记实体是否已经关联策略时不为null。0表示未关联策略,1表示已关联策略
Deactived Uint64 是否已下线
DeactivedDetail Array of String 已下线产品列表
IsCheck Uint64 是否进行安全性校验

ProviderList

cas身份提供商列表

被如下接口引用:

名称 必选 允许NULL 类型 描述
Id Uint64 cas Id号
CreateUin Uint64 创建者uin
OwnerUin Uint64 主账号
Name String 身份提供商名称
Desc String 身份提供商描述
ProviderType Uint64 身份提供商类型
Status Uint64 身份提供商状态
ModifyTime Datetime 修改时间
CreateTime Datetime 创建时间
Cas String Cas属性

ResourceTypeItem

资源类型

被如下接口引用:GetServiceList

名称 必选 允许NULL 类型 描述
ResourceEnName String 英文名
ResourceName String 中文名
ResourceType String 资源类型
ServiceType String 服务类型

ServiceAndPerm

业务信息与相关的接口信息

被如下接口引用:DescribeCamServiceAndPerm

名称 必选 允许NULL 类型 描述
ServiceType String 业务ID
ServiceName String 业务名
IsDisZone String 是否分地域、分区
IsDisProject String 是否分项目
IsAllowDefProj String 是否允许关联默认项目
WhiteKey String 灰度白名单 key
PermList Array of PermList 相关API列表

ActionLoginFlag

登录操作敏感标识

被如下接口引用:AddSubAccount

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

CasProviderItem

cas server 配置信息

被如下接口引用:DescribeCasProvider

名称 必选 允许NULL 类型 描述
Id Int64 provider id
CreateUin Uint64 创建账户uin
OwnerUin Uint64 主账户uin
Name String 名称
Desc String 描述
ProviderType Int64 provider类型
Status Int64 状态
ModifyTime String 修改时间
CreateTime String 创建时间
SAMLMetadata String SAML元数据
SAMLEntityId String SAML实例id
SAMLSingleSignOn String SAML登陆跳转
SAMLSingleLogout String SAML登出跳转
SAMLKeys String SAML关键字
Cas String Cas
CasRoot String cas根地址
CasLoginUrl String cas登陆url
CasValidateUrl String cas校验url
CasLogoutUrl String cas登出url
Oauth String oauth配置

OwnerAccountAttribute

主账户属性

被如下接口引用:UpdateOwnerAccount

名称 必选 允许NULL 类型 描述
Remark String 属性

AddSubAccountDetail

新增用户详情

被如下接口引用:AddSubAccount

名称 必选 允许NULL 类型 描述
Name String 用户名
Token String token
Password String 密码
SecretId String secretid
SecretKey String secretKey
NickName String 昵称
Uin Uint64 uin

AttachEntityOfPolicy

策略关联的实体信息

被如下接口引用:ListEntitiesForPolicy

名称 必选 允许NULL 类型 描述
Id String 实体ID
Name String 实体名称
Uin Uint64 实体Uin
RelatedType Uint64 关联类型。1 用户关联 ; 2 用户组关联

AttachedStrategyInfoPack

策略信息包

被如下接口引用:DescribeAttachedEntityPolicies

名称 必选 允许NULL 类型 描述
List Array of AttachedStrategyInfo 策略数组,数组每个成员包括 policyId、policyName、addTime、type、description、 createMode 字段。其中:
TotalNum Uint64 策略数
Id Uint64 入参Type=1时表示uin,2时表示groupId

AttributeInfo

属性

被如下接口引用:AddAttributeValues

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

AttachedUserPolicyGroupInfo

用户关联策略(随组管理)信息

被如下接口引用:ListAttachedUserAllPolicies

名称 必选 允许NULL 类型 描述
GroupId Uint64 分组ID
GroupName String 分组名称

GroupUidUinInfo

用户组和用户信息

被如下接口引用:DeleteSubAccount

名称 必选 允许NULL 类型 描述
Uid Uint64 子用户Uid
Uin Uint64 子用户Uin
GroupId Int64 用户组ID 如果没有任何组传递-1,传入指定组id表示将用户从组删除

ServiceApiListInfo

服务的API信息

被如下接口引用:GetServiceApiList

名称 必选 允许NULL 类型 描述
Name String API名称
IsNeedObject String 是否需要关联对象
Desc String 描述
ReadWriteDetail Uint64 接口类别:0.读取,1.写入,2.标记,3.列表
InterfaceLevel Uint64 授权粒度:0.接口级,1.资源级
ResourceExample String 资源六段式范例

Receiver

消息接收人信息

被如下接口引用:DescribeSubAccountContacts

名称 必选 允许NULL 类型 描述
Uid Uint64 id
Name String 名字
Remark String 备注
PhoneNumber String 手机号码
PhoneFlag Int64 手机号码是否验证
Email String 邮箱
EmailFlag Int64 邮箱是否验证
IsReceiverOwner Int64 是否主联系人
WechatFlag Int64 是否允许微信接收通知
Uin Uint64 账号uin

ServicePermItem

接口

被如下接口引用:GetServicePermList

名称 必选 允许NULL 类型 描述
AddTime Datetime 创建时间
ApiAddr String ApiAddr
ApiZhName String 中文描述
AuthFunction String 鉴权接口
CWildcardName String CWildcardName
InterfaceEnName String 接口名
InterfaceLevel String 鉴权粒度,0:接口级别、1:资源级别
IsAuthBusiness String 鉴权方式,0:由云API转发鉴权、1:业务自行调用鉴权接口
IsNeedObject String IsNeedObject
IsSeen String IsSeen
IsSeenAtGenerator String 策略生成器是否可见
IsSpResource String IsSpResource
IsUserSet String IsUserSet
PermId String Id
ReadWriteDetail String 接口类别
ResourceType String 资源类别
UpdateTime String 更新时间
Weight String Weight
Writter String 操作者
ServiceName String 服务名
ProductShortCode String ProductShortCode
ProductShortName String ProductShortName
ServiceType String 服务类型

SubAccountFilter

带过滤条件的子帐号信息

被如下接口引用:ListSubAccounts

名称 必选 允许NULL 类型 描述
Uid Uint64 子用户Uid
Uin Uint64 用户Uin
Name String 用户Name
Remark String 备注
CanLogin Uint64 是都允许登录
PhoneNum String 电话号码
CountryCode String 区号
PhoneFlag Int64 电话号码是否验证
Email String 邮箱
EmailFlag Int64 邮箱是否验证
UserType Int64 用户类型
CreateTime String 创建时间
IsReceiverOwner Int64 是否消息接收人
SystemType String 类型
NeedResetPassword Int64 是否需要重置密码
ConsoleLogin Int64 是否允许控制台登录
WxzsStatus Int64 微信公众号关注状态
PermType Array of String 权限类型
NickName String 昵称
QywxUserId String 企业微信用户id
UserAttributeAndValues Array of AccountAttributeAndValue 扩展属性

ServiceApiInfo

服务及其API信息

被如下接口引用:GetServiceApiList

名称 必选 允许NULL 类型 描述
Name String 服务名称
ServiceType String 服务ID
ArnDocument String 服务介绍文档链接
ApiList Array of ServiceApiListInfo API信息列表
ConditionKeyList Array of String 条件规则列表

AttachPolicyInfo

关联策略信息

被如下接口引用:ListAttachedGroupPolicies

名称 必选 允许NULL 类型 描述
PolicyId Uint64 策略id
PolicyName String 策略名称
AddTime Datetime 创建时间
CreateMode Uint64 创建来源,1 通过控制台创建, 2 通过策略语法创建。

AccountAttributeAndValue

扩展属性值

被如下接口引用:ListSubAccounts

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

ApiKey

API密钥数据列表

被如下接口引用:CreateApiKey、CreateCollApiKey、QueryApiKey、QueryCollApiKey、QueryKeyBySecretId

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

GroupMember

用户组成员

被如下接口引用:AddUserToGroup、RemoveUserFromGroup、UpdateGroupMember

名称 必选 允许NULL 类型 描述
Uid String 用户id
GroupId String 组id

ApiKeyDetail

持久密钥详情

被如下接口引用:GetApiKey

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

AttachedPolicyOfRole

角色关联的策略信息

被如下接口引用:ListAttachedRolePolicies

名称 必选 允许NULL 类型 描述
PolicyId Uint64 策略ID
PolicyName String 策略名称
AddTime String 绑定时间
PolicyType String 策略类型,User表示自定义策略,QCS表示预设策略
CreateMode Uint64 策略创建方式,1表示按产品功能或项目权限创建,其他表示按策略语法创建

FilterItem

过滤条件数据结构

被如下接口引用:ListSubAccounts

名称 必选 允许NULL 类型 描述
Operator String 操作符
Attr String 属性
Value String 匹配值

UpdateGroupInfo

更新用户组信息

被如下接口引用:UpdateSubAccount

名称 必选 允许NULL 类型 描述
GroupId Uint64 用户组id
Uid Uint64 用户id
GroupName String 用户组名称
Channel Int64 息接收渠道 0:无 1: 短信 2:邮件 3:短信+邮件

ExtAttr

用户属性集合

被如下接口引用:DescribeSubReceiver

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

GroupInfo

用户组信息

被如下接口引用:DescribeGroups、GetGroupList、GetSubsGroup、ListGroups

名称 必选 允许NULL 类型 描述
GroupId Uint64 组id
GroupName String 组名称
Channel Int64 息接收渠道 0:无 1: 短信 2:邮件 3:短信+邮件
Remark String 备注
CreateTime String 创建时间
UserInfo Array of GroupMemberInfo 用户组成员信息
GroupType Int64 用户组类型,0-自定义,1-预设

PasswordRules

密码规则

被如下接口引用:GetPasswordRules、UpdatePasswordRules

名称 必选 允许NULL 类型 描述
MinimumLength Int64 最小密码长度
MustContain String 最少包含
ForcePasswordChange Int64 密码有效期
ReusePasswordLimit Int64 密码重复次数
RetryPasswordLimit Int64 登陆最大密码失败次数
OnlyAdminCanResetPassword Int64 是否只有admin可以重置密码

UserGroup

用户及用户组信息

被如下接口引用:GetUserGroupList、ListAllUserGroup

名称 必选 允许NULL 类型 描述
Uid Uint64 接收者用户id
Uin Uint64 账户唯一id
Name String 用户名
IsReceiverOwner Int64 是否是主账户
Group Array of GroupMeta 用户组信息

ApiEnNameList

API英文名信息列表

被如下接口引用:DescribeCamServiceAndPerm

名称 必选 允许NULL 类型 描述
Name String API名称
IsNeedObject String 是否需要关联对象
IsSeen String 是否可见

UserList

子账号列表

被如下接口引用:ListUsersForPolicy

名称 必选 允许NULL 类型 描述
Name String 子账号名称
SubAccountUin String 子账号uin

Filter

过滤条件组合

被如下接口引用:ListSubAccounts

名称 必选 允许NULL 类型 描述
Keywords Array of FilterItem 过滤条件组合
Operator String 操作符

UserInfo

用户信息

被如下接口引用:AddSubAccount

名称 必选 允许NULL 类型 描述
CanLogin String 子账号类型
CountryCode String 区号
Detail AccountDetail 详情
Name String 名称
PhoneNum String 电话号码
SystemType String 系统类型
Email String 安全邮箱
NickName String 昵称
Remark String 备注
WxzsStatus Int64 微信登陆状态
ContactMail String 联系邮箱
IsReceiverOwner Int64 是否是主账号
IdentifyType Int64 身份类型