用户指南

支持CAM的业务接口

商用案例

API 文档

有奖征文|投稿上云技术实践,赢取价值5000元大奖> HOT

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 用户组关联
AttachmentTime String 策略关联时间
注意:此字段可能返回 null,表示取不到有效值。

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,表示取不到有效值。

AttachedUserPolicy

用户关联的策略详情

被如下接口引用:ListAttachedUserAllPolicies。

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

AttachedUserPolicyGroupInfo

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

被如下接口引用:ListAttachedUserAllPolicies。

名称 类型 描述
GroupId Integer 分组ID
GroupName String 分组名称

GroupIdOfUidInfo

子用户和用户组关联信息

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

名称 类型 必选 描述
GroupId Integer 用户组 ID
Uid Integer 子用户 UID
Uin Integer 子用户 Uin,Uid和Uin至少有一个必填

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 是否已验证手机。0-未验证 1-验证
Email String 邮箱地址。
EmailFlag Integer 是否已验证邮箱。0-未验证 1-验证
UserType Integer 用户类型。1-全局协作者 2-项目协作者 3-消息接收者
CreateTime String 创建时间。
IsReceiverOwner Integer 是否为主消息接收人。0-否 1-是

ListGrantServiceAccessActionNode

ListGrantServiceAccessAction节点

被如下接口引用:ListPoliciesGrantingServiceAccess。

名称 类型 描述
Name String 接口名
Description String 接口描述

ListGrantServiceAccessNode

用于ListPoliciesGrantingServiceAccess接口的List节点

被如下接口引用:ListPoliciesGrantingServiceAccess。

名称 类型 描述
Service ListGrantServiceAccessService 服务
Action Array of ListGrantServiceAccessActionNode 接口信息
Policy Array of ListGrantServiceAccessPolicy 授权的策略

ListGrantServiceAccessPolicy

用于ListPoliciesGrantingServiceAccess接口的Policy节点

被如下接口引用:ListPoliciesGrantingServiceAccess。

名称 类型 描述
PolicyId String 策略ID
PolicyName String 策略名
PolicyType String 策略类型: Custom自定义策略,Presetting预设策略
PolicyDescription String 策略描述

ListGrantServiceAccessService

用于ListPoliciesGrantingServiceAccess接口的Service节点

被如下接口引用:ListPoliciesGrantingServiceAccess。

名称 类型 描述
ServiceType String 服务
ServiceName String 服务名

LoginActionFlag

登录和敏感操作flag

被如下接口引用:DescribeSafeAuthFlag, DescribeSafeAuthFlagColl。

名称 类型 必选 描述
Phone Integer 手机
Token Integer 硬token
Stoken Integer 软token
Wechat Integer 微信
Custom Integer 自定义

LoginActionFlagIntl

登录和敏感操作flag

被如下接口引用:DescribeSafeAuthFlagIntl。

名称 类型 必选 描述
Phone Integer 手机
Token Integer 硬token
Stoken Integer 软token
Wechat Integer 微信
Custom Integer 自定义
Mail Integer 邮件

LoginActionMfaFlag

登录和敏感操作flag

被如下接口引用:SetMfaFlag。

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

OffsiteFlag

异地登录设置

被如下接口引用:DescribeSafeAuthFlag, DescribeSafeAuthFlagColl, DescribeSafeAuthFlagIntl。

名称 类型 必选 描述
VerifyFlag Integer 验证标识
NotifyPhone Integer 手机通知
NotifyEmail Integer 邮箱通知
NotifyWechat Integer 微信通知
Tips 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,表示取不到有效值。
Tags Array of RoleTags 标签
注意:此字段可能返回 null,表示取不到有效值。

RoleTags

角色标签类型

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

名称 类型 必选 描述
Key String 标签键
Value String 标签值

SAMLProviderInfo

SAML身份提供商

被如下接口引用:ListSAMLProviders。

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

SecretIdLastUsed

密钥最后使用时间

被如下接口引用:GetSecurityLastUsed。

名称 类型 描述
SecretId String 密钥ID
LastUsedDate Date 最后访问日期(有1天延迟)
注意:此字段可能返回 null,表示取不到有效值。

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,表示取不到有效值。
AttachEntityCount Integer 关联策略实体数
注意:此字段可能返回 null,表示取不到有效值。
AttachEntityBoundaryCount Integer 关联权限边界实体数
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime Timestamp 最后编辑时间
注意:此字段可能返回 null,表示取不到有效值。

SubAccountInfo

子用户信息

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

名称 类型 描述
Uin Integer 子用户用户 ID
Name String 子用户用户名
Uid Integer 子用户 UID
Remark String 子用户备注
ConsoleLogin Integer 子用户能否登录控制台
PhoneNum String 手机号
CountryCode String 区号
Email String 邮箱
CreateTime Timestamp 创建时间
注意:此字段可能返回 null,表示取不到有效值。
NickName String 昵称
注意:此字段可能返回 null,表示取不到有效值。

SubAccountUser

子用户信息

被如下接口引用:DescribeSubAccounts。

名称 类型 描述
Uin Integer 子用户用户 ID
Name String 子用户用户名
Uid Integer 子用户 UID,UID是用户作为消息接收人时的唯一标识,和 UIN 一样可以唯一标识一个用户,可通过接口https://cloud.tencent.com/document/api/598/53486 获取
Remark String 子用户备注
CreateTime Timestamp 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UserType Integer 用户类型(2:子用户;3:企业微信子用户;4:协作者;5:消息接收人)
LastLoginIp String 最近登录IP
LastLoginTime String 最近登录时间
注意:此字段可能返回 null,表示取不到有效值。

WeChatWorkSubAccount

企业微信子用户

被如下接口引用:ListWeChatWorkSubAccounts。

名称 类型 描述
Uin Integer 子用户用户 ID
Name String 子用户用户名
Uid Integer 子用户 UID
Remark String 备注
ConsoleLogin Integer 子用户能否登录控制台
PhoneNum String 手机号
CountryCode String 区号
Email String 邮箱
WeChatWorkUserId String 企业微信UserId
注意:此字段可能返回 null,表示取不到有效值。
CreateTime Timestamp 创建时间
注意:此字段可能返回 null,表示取不到有效值。
目录