用户指南

商用案例

API 文档

数据结构

最近更新时间:2020-07-22 08:06:10

AccessKey

访问密钥列表

被如下接口引用:ListAccessKeys。

名称 类型 描述
AccessKeyId String 访问密钥标识
Status String 密钥状态,激活(Active)或未激活(Inactive)
CreateTime Timestamp 创建时间

AttachEntityOfPolicy

策略关联的实体信息

被如下接口引用:ListEntitiesForPolicy。

名称 类型 描述
Id String 实体ID
Name String 实体名称
注意:此字段可能返回 null,表示取不到有效值。
Uin Integer 实体Uin
注意:此字段可能返回 null,表示取不到有效值。
RelatedType Integer 关联类型。1 用户关联 ; 2 用户组关联

AttachPolicyInfo

关联策略信息

被如下接口引用:ListAttachedGroupPolicies, ListAttachedUserPolicies。

名称 类型 描述
PolicyId Integer 策略id
PolicyName String 策略名称
注意:此字段可能返回 null,表示取不到有效值。
AddTime Timestamp 创建时间
注意:此字段可能返回 null,表示取不到有效值。
CreateMode Integer 创建来源,1 通过控制台创建, 2 通过策略语法创建。
注意:此字段可能返回 null,表示取不到有效值。
PolicyType String 取值为user和QCS
注意:此字段可能返回 null,表示取不到有效值。
Remark String 策略备注
注意:此字段可能返回 null,表示取不到有效值。
OperateOwnerUin String 策略关联操作者主帐号
注意:此字段可能返回 null,表示取不到有效值。
OperateUin String 策略关联操作者ID,如果UinType为0表示子帐号Uin,如果UinType为1表示角色ID
注意:此字段可能返回 null,表示取不到有效值。
OperateUinType Integer UinType为0表示OperateUin字段是子帐号Uin,如果UinType为1表示OperateUin字段是角色ID
注意:此字段可能返回 null,表示取不到有效值。
Deactived Integer 是否已下线
注意:此字段可能返回 null,表示取不到有效值。
DeactivedDetail Array of String 已下线的产品列表
注意:此字段可能返回 null,表示取不到有效值。

AttachedPolicyOfRole

角色关联的策略信息

被如下接口引用:ListAttachedRolePolicies。

名称 类型 描述
PolicyId Integer 策略ID
PolicyName String 策略名称
AddTime String 绑定时间
PolicyType String 策略类型,User表示自定义策略,QCS表示预设策略
注意:此字段可能返回 null,表示取不到有效值。
CreateMode Integer 策略创建方式,1表示按产品功能或项目权限创建,其他表示按策略语法创建
Deactived Integer 是否已下线(0:否 1:是)
注意:此字段可能返回 null,表示取不到有效值。
DeactivedDetail Array of String 已下线的产品列表
注意:此字段可能返回 null,表示取不到有效值。
Description String 策略描述
注意:此字段可能返回 null,表示取不到有效值。

GroupIdOfUidInfo

子用户和用户组关联信息

被如下接口引用:AddUserToGroup, RemoveUserFromGroup。

名称 类型 必选 描述
Uid Integer 子用户 UID
GroupId Integer 用户组 ID

GroupInfo

用户组信息

被如下接口引用:ListGroups, ListGroupsForUser。

名称 类型 描述
GroupId Integer 用户组 ID。
GroupName String 用户组名称。
CreateTime String 用户组创建时间。
Remark String 用户组描述。

GroupMemberInfo

用户组用户信息

被如下接口引用:GetGroup, ListUsersForGroup。

名称 类型 描述
Uid Integer 子用户 Uid。
Uin Integer 子用户 Uin。
Name String 子用户名称。
PhoneNum String 手机号。
CountryCode String 手机区域代码。
PhoneFlag Integer 是否已验证手机。
Email String 邮箱地址。
EmailFlag Integer 是否已验证邮箱。
UserType Integer 用户类型。
CreateTime String 创建时间。
IsReceiverOwner Integer 是否为主消息接收人。

LoginActionMfaFlag

登录和敏感操作flag

被如下接口引用:SetMfaFlag。

名称 类型 必选 描述
Phone Integer 手机
Stoken Integer 软token
Wechat Integer 微信

PolicyVersionDetail

策略版本详情

被如下接口引用:GetPolicyVersion。

名称 类型 描述
VersionId Integer 策略版本号
注意:此字段可能返回 null,表示取不到有效值。
CreateDate String 策略版本创建时间
注意:此字段可能返回 null,表示取不到有效值。
IsDefaultVersion Integer 是否是正在生效的版本。0表示不是,1表示是
注意:此字段可能返回 null,表示取不到有效值。
Document String 策略语法文本
注意:此字段可能返回 null,表示取不到有效值。

PolicyVersionItem

策略版本列表元素结构

被如下接口引用:ListPolicyVersions。

名称 类型 描述
VersionId Integer 策略版本号
注意:此字段可能返回 null,表示取不到有效值。
CreateDate String 策略版本创建时间
注意:此字段可能返回 null,表示取不到有效值。
IsDefaultVersion Integer 是否是正在生效的版本。0表示不是,1表示是
注意:此字段可能返回 null,表示取不到有效值。

RoleInfo

角色详细信息

被如下接口引用:DescribeRoleList, GetRole。

名称 类型 描述
RoleId String 角色ID
RoleName String 角色名称
PolicyDocument String 角色的策略文档
Description String 角色描述
AddTime String 角色的创建时间
UpdateTime String 角色的最近一次时间
ConsoleLogin Integer 角色是否允许登录
RoleType String 角色类型,取user、system或service_linked
注意:此字段可能返回 null,表示取不到有效值。
SessionDuration Integer 有效时间
注意:此字段可能返回 null,表示取不到有效值。
DeletionTaskId String 服务相关角色删除TaskId
注意:此字段可能返回 null,表示取不到有效值。

SAMLProviderInfo

SAML身份提供商

被如下接口引用:ListSAMLProviders。

名称 类型 必选 描述
Name String SAML身份提供商名称
Description String SAML身份提供商描述
CreateTime String SAML身份提供商创建时间
ModifyTime String SAML身份提供商上次修改时间

StrategyInfo

策略信息

被如下接口引用:ListPolicies。

名称 类型 描述
PolicyId Integer 策略ID。
PolicyName String 策略名称。
AddTime Timestamp 策略创建时间。
注意:此字段可能返回 null,表示取不到有效值。
Type Integer 策略类型。1 表示自定义策略,2 表示预设策略。
Description String 策略描述。
注意:此字段可能返回 null,表示取不到有效值。
CreateMode Integer 创建来源,1 通过控制台创建, 2 通过策略语法创建。
Attachments Integer 关联的用户数
ServiceType String 策略关联的产品
注意:此字段可能返回 null,表示取不到有效值。
IsAttached Integer 当需要查询标记实体是否已经关联策略时不为null。0表示未关联策略,1表示已关联策略
注意:此字段可能返回 null,表示取不到有效值。
Deactived Integer 是否已下线
注意:此字段可能返回 null,表示取不到有效值。
DeactivedDetail Array of String 已下线产品列表
注意:此字段可能返回 null,表示取不到有效值。
IsServiceLinkedPolicy Integer 是否是服务相关角色策略
注意:此字段可能返回 null,表示取不到有效值。

SubAccountInfo

子用户信息

被如下接口引用:ListCollaborators, ListUsers。

名称 类型 描述
Uin Integer 子用户用户 ID
Name String 子用户用户名
Uid Integer 子用户 UID
Remark String 子用户备注
ConsoleLogin Integer 子用户能否登录控制台
PhoneNum String 手机号
CountryCode String 区号
Email String 邮箱
目录