数据结构

最近更新时间:2024-08-14 02:14:09

我的收藏

AuthNode

互信主体主要信息

被如下接口引用:DescribeOrganizationAuthNode。

名称 类型 描述
RelationId Integer 互信主体关系ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AuthName String 互信主体名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:腾讯云
Manager MemberMainInfo 主体管理员
注意:此字段可能返回 null,表示取不到有效值。

EffectivePolicy

有效策略。

被如下接口引用:DescribeEffectivePolicy。

名称 类型 描述
TargetId Integer 目标ID。
示例值:111111111111
PolicyContent String 有效策略内容。
LastUpdatedTimestamp Integer 有效策略更新时间。
示例值:1668394639

GroupInfo

用户组信息。

被如下接口引用:CreateGroup, GetGroup, ListGroups, UpdateGroup。

名称 类型 必选 描述
GroupName String 用户组的名称。
示例值:TestGroup
Description String 用户组的描述。
示例值:This is a group.
CreateTime String 用户组的创建时间。
示例值:2024-01-01 12:12:12
GroupType String 用户组的类型 Manual:手动创建,Synchronized:外部导入。
示例值:Manual
UpdateTime String 用户组的修改时间。
示例值:2024-01-01 12:12:12
GroupId String 用户组的 ID。
示例值:g-3x3s34fr2***
MemberCount Integer 组员数量。
示例值:10
IsSelected Boolean 如果有入参FilterUsers,用户在用户组返回true,否则返回false
示例值:true

GroupMembers

用户信息

被如下接口引用:ListGroupMembers。

名称 类型 必选 描述
UserName String 查询username。
示例值:Alice
DisplayName String 用户的显示名称。
示例值:Alice
Description String 用户的描述。
示例值:this is user.
Email String 用户的电子邮箱。目录内必须唯一。
示例值:Alice@example.com
UserStatus String 用户状态 Enabled:启用, Disabled:禁用。
示例值:Enabled
UserType String 用户类型 Manual:手动创建,Synchronized:外部导入。
示例值:Manual
UserId String 用户 ID
示例值:u-a34wsd32
JoinTime String 用户加入用户组的时间
示例值:2021-12-12 12:12:12

IdentityPolicy

组织身份策略

被如下接口引用:CreateOrganizationIdentity, ListOrganizationIdentity, UpdateOrganizationIdentity。

名称 类型 必选 描述
PolicyId Integer CAM预设策略ID。PolicyType 为预设策略时有效且必选
示例值:1
PolicyName String CAM预设策略名称。PolicyType 为预设策略时有效且必选
示例值:AdministratorAccess
PolicyType Integer 策略类型。取值 1-自定义策略 2-预设策略;默认值2
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
PolicyDocument String 自定义策略内容,遵循CAM策略语法。PolicyType 为自定义策略时有效且必选
注意:此字段可能返回 null,表示取不到有效值。
示例值:{ "version": "2.0", "statement": [ { "effect": "allow", "action": [ "vpc:*" ], "resource": [ "*" ] } ] }

JoinedGroups

用户加入的用户组

被如下接口引用:ListJoinedGroupsForUser。

名称 类型 必选 描述
GroupName String 用户组的名称。
示例值:测试组
Description String 用户组的描述。
示例值:这个是测试组
GroupId String 用户组 ID。
示例值:g-asnwuwi**
GroupType String 用户组的类型。取值:

Manual:手动创建。
Synchronized:外部同步。
示例值:Manual
JoinTime String 加入用户组的时间
示例值:2021-01-01 12:12:12

ListPoliciesForTarget

查询目标关联的SCP策略列表

被如下接口引用:ListPoliciesForTarget。

名称 类型 描述
StrategyId Integer 策略Id
示例值:1000
StrategyName String 策略名称
示例值:FullQcloudAccess
Remark String 备注信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:自测专用
Uin Integer 关联的账号或节点
示例值:15440611
Type Integer 关联类型 1-节点 2-用户
示例值:1
AddTime String 策略创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-08-08 14:49:59
UpdateTime String 策略更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-08-08 14:49:59
Name String 部门名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:二级部门
AttachTime String 策略绑定时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-08-08 14:49:59

ListPolicyNode

企业组织策略列表

被如下接口引用:ListPolicies。

名称 类型 描述
AddTime String 策略创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-08-02 19:40:09
AttachedTimes Integer 策略绑定次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:3
Description String 策略描述信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:测试策略1
PolicyName String 策略名称
示例值:test_bind
PolicyId Integer 策略Id
示例值:12307
UpdateTime String 策略更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-08-02 19:40:09
Type Integer 策略类型 1-自定义 2-预设
示例值:1

ListTargetsForPolicyNode

查询某个指定SCP策略关联的目标列表

被如下接口引用:ListTargetsForPolicy。

名称 类型 描述
Uin Integer scp账号uin或节点Id
示例值:100022242314
RelatedType Integer 关联类型 1-节点关联 2-用户关联
示例值:2
Name String 账号或者节点名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:T1-Node
AddTime String 绑定时间
示例值:2022-08-09 17:11:54

ManagerShareUnit

我的共享单元列表详情

被如下接口引用:DescribeShareUnits。

名称 类型 描述
UnitId String 共享单元ID。
示例值:shareUnit-xhre**ra2p
Name String 共享单元名称。
示例值:myShareUnit
Uin Integer 共享单元管理员Uin。
示例值:222222222222
OwnerUin Integer 共享单元管理员OwnerUin。
示例值:111111111111
Area String 共享单元地域。
示例值:ap-guangzhou
Description String 描述。
注意:此字段可能返回 null,表示取不到有效值。
示例值:share unit
CreateTime String 创建时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-03-05 12:21:21
ShareResourceNum Integer 共享单元资源数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
ShareMemberNum Integer 共享单元成员数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ShareScope Integer 共享范围。取值:1-仅允许集团组织内共享 2-允许共享给任意账号
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

MemberIdentity

成员管理身份

被如下接口引用:DescribeOrganizationMembers。

名称 类型 描述
IdentityId Integer 身份ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
IdentityAliasName String 身份名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test

MemberMainInfo

成员主要信息

被如下接口引用:DescribeOrganizationAuthNode, ListOrgServiceAssignMember。

名称 类型 描述
MemberUin Integer 成员uin
注意:此字段可能返回 null,表示取不到有效值。
示例值:100000006533
MemberName String 成员名称j
注意:此字段可能返回 null,表示取不到有效值。
示例值:testa

NodeMainInfo

部门主要信息

被如下接口引用:ListOrgServiceAssignMember。

名称 类型 描述
NodeId Integer 部门ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
NodeName String 部门名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:运营部

NotAllowReason

不允许删除的原因。

被如下接口引用:CheckAccountDelete。

名称 类型 描述
IsCreateMember Boolean 是否创建的成员。true-是、false-否;成员不是创建的成员不允许删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
DeletionPermission Boolean 成员删除许可。true-开启、false-关闭;成员删除许可关闭时不允许删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
IsAssignManager Boolean 是否可信服务委派管理员。true-是、false-否;成员是可信服务委派管理员不允许删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
IsAuthManager Boolean 是否主体管理员。true-是、false-否;成员是主体管理员不允许删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
IsShareManager Boolean 是否共享资源管理员。true-是、false-否;成员是共享资源管理员不允许删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
OperateProcess Boolean 成员是否设置了操作审批。true-是、false-否;成员设置了操作审批时不允许删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
BillingPermission Boolean 是否允许解除成员财务权限。true-是、false-否;成员不能解除财务权限时不允许删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
ExistResources Array of String 存在的资源列表。账号存在资源时不允许删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
DetectFailedResources Array of String 检测失败的资源列表。账号有资源检测失败时不允许删除。
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]

OrgFinancialByMonth

按月获取组织财务信息

被如下接口引用:DescribeOrganizationFinancialByMonth。

名称 类型 描述
Id Integer 记录ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Month String 月份,格式:yyyy-mm,示例:2021-01。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-01
TotalCost Float 消耗金额,单元:元。
注意:此字段可能返回 null,表示取不到有效值。
示例值:12.23
GrowthRate String 比上月增长率%。正数增长,负数下降,空值无法统计。
注意:此字段可能返回 null,表示取不到有效值。
示例值:24

OrgIdentity

组织身份

被如下接口引用:ListOrganizationIdentity。

名称 类型 描述
IdentityId Integer 身份ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
IdentityAliasName String 身份名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
Description String 描述。
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
IdentityPolicy Array of IdentityPolicy 身份策略。
注意:此字段可能返回 null,表示取不到有效值。
IdentityType Integer 身份类型。 1-预设、 2-自定义
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UpdateTime String 更新时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-02-12 12:12:10

OrgMember

企业组织成员

被如下接口引用:DescribeOrganizationMembers。

名称 类型 描述
MemberUin Integer 成员Uin
注意:此字段可能返回 null,表示取不到有效值。
示例值:1000001
Name String 成员名
注意:此字段可能返回 null,表示取不到有效值。
示例值:tt
MemberType String 成员类型,邀请:Invite, 创建:Create
注意:此字段可能返回 null,表示取不到有效值。
示例值:Invite
OrgPolicyType String 关系策略类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:Finical
OrgPolicyName String 关系策略名
注意:此字段可能返回 null,表示取不到有效值。
示例值:财务管理
OrgPermission Array of OrgPermission 关系策略权限
注意:此字段可能返回 null,表示取不到有效值。
NodeId Integer 所属节点ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1002
NodeName String 所属节点名
注意:此字段可能返回 null,表示取不到有效值。
示例值:Root
Remark String 备注
注意:此字段可能返回 null,表示取不到有效值。
示例值:tt
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-03-12 12:12:22
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-03-12 12:12:22
IsAllowQuit String 是否允许成员退出。允许:Allow,不允许:Denied。
注意:此字段可能返回 null,表示取不到有效值。
示例值:Allow
PayUin String 代付者Uin
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
PayName String 代付者名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
OrgIdentity Array of MemberIdentity 管理身份
注意:此字段可能返回 null,表示取不到有效值。
BindStatus String 安全信息绑定状态 未绑定:Unbound,待激活:Valid,绑定成功:Success,绑定失败:Failed
注意:此字段可能返回 null,表示取不到有效值。
示例值:Unbound
PermissionStatus String 成员权限状态 已确认:Confirmed ,待确认:UnConfirmed
注意:此字段可能返回 null,表示取不到有效值。
示例值:Confirmed

OrgMemberAuthAccount

成员和子账号的授权关系

被如下接口引用:DescribeOrganizationMemberAuthAccounts。

名称 类型 描述
OrgSubAccountUin Integer 组织子账号Uin。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1000001
PolicyId Integer 策略ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:11
PolicyName String 策略名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
IdentityId Integer 身份ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:12
IdentityRoleName String 身份角色名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test1
IdentityRoleAliasName String 身份角色别名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:策略管理
CreateTime String 创建时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-02-12 12:12:10
UpdateTime String 更新时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-02-12 12:12:10
OrgSubAccountName String 子账号名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test

OrgMemberAuthIdentity

组织成员可授权的身份

被如下接口引用:DescribeOrganizationMemberAuthIdentities。

名称 类型 描述
IdentityId Integer 身份ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:111
IdentityRoleName String 身份的角色名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
IdentityRoleAliasName String 身份的角色别名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
Description String 身份描述。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
CreateTime String 首次配置成功的时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-02-12 12:12:10
UpdateTime String 最后一次配置成功的时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-02-12 12:12:10
IdentityType Integer 身份类型。取值: 1-预设身份 2-自定义身份
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Status Integer 配置状态。取值:1-配置完成 2-需重新配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
MemberUin Integer 成员Uin。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1111111111111
MemberName String 成员名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:member_test

OrgMemberFinancial

组织成员财务信息。

被如下接口引用:DescribeOrganizationFinancialByMember。

名称 类型 描述
MemberUin Integer 成员Uin。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1000001
MemberName String 成员名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
TotalCost Float 消耗金额,单位:元。
注意:此字段可能返回 null,表示取不到有效值。
示例值:20.23
Ratio String 占比%。
注意:此字段可能返回 null,表示取不到有效值。
示例值:23

OrgMemberPolicy

组织成员被授权的策略

被如下接口引用:DescribeOrganizationMemberPolicies。

名称 类型 描述
PolicyId Integer 策略ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
PolicyName String 策略名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
IdentityId Integer 身份ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
IdentityRoleName String 身份角色名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
IdentityRoleAliasName String 身份角色别名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
Description String 描述。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
CreateTime String 创建时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-02-12 12:12:10
UpdateTime String 更新时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-02-12 12:12:10

OrgNode

企业组织单元

被如下接口引用:DescribeOrganizationNodes。

名称 类型 描述
NodeId Integer 组织节点ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1001
Name String 名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
ParentNodeId Integer 父节点ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1000
Remark String 备注
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-03-12 12:12:11
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-03-12 12:12:11

OrgPermission

关系策略权限

被如下接口引用:DescribeOrganization, DescribeOrganizationMembers。

名称 类型 描述
Id Integer 权限Id
示例值:1
Name String 权限名
示例值:允许主账号对子账号合并出账单

OrgProductFinancial

组织产品财务信息

被如下接口引用:DescribeOrganizationFinancialByProduct。

名称 类型 描述
ProductName String 产品Code。
注意:此字段可能返回 null,表示取不到有效值。
示例值:p_cos
ProductCode String 产品名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:COS对象存储
TotalCost Float 产品消耗,单位:元。
注意:此字段可能返回 null,表示取不到有效值。
示例值:23.22
Ratio String 占比%。
注意:此字段可能返回 null,表示取不到有效值。
示例值:34

OrganizationServiceAssign

集团服务设置

被如下接口引用:ListOrganizationService。

名称 类型 描述
ServiceId Integer 集团服务ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ProductName String 集团服务产品名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:CloudAudit
IsAssign Integer 是否支持委派。取值: 1-是 2-否
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Description String 集团服务描述。
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
MemberNum String 当前委派管理员数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Document String 帮助文档。
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
ConsoleUrl String 集团服务产品控制台路径。
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
IsUsageStatus Integer 是否接入使用状态。取值: 1-是
2-否
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
CanAssignCount Integer 委派管理员数量限制。
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
Product String 集团服务产品标识。
注意:此字段可能返回 null,表示取不到有效值。
示例值:cloudaudit
ServiceGrant Integer 是否支持集团服务授权。取值 1-是、2-否
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
GrantStatus String 集团服务授权启用状态。ServiceGrant值为1时该字段有效 ,取值:Enabled-开启 Disabled-关闭
注意:此字段可能返回 null,表示取不到有效值。
示例值:Disabled
IsSetManagementScope Integer 是否支持设置委派管理范围。取值: 1-是 2-否
注意:此字段可能返回 null,表示取不到有效值。
示例值:2

OrganizationServiceAssignMember

集团服务委派成员信息

被如下接口引用:ListOrgServiceAssignMember。

名称 类型 描述
ServiceId Integer 集团服务ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ProductName String 集团服务产品名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:CloudAudit
MemberUin Integer 委派管理员Uin。
注意:此字段可能返回 null,表示取不到有效值。
示例值:111111111111
MemberName String 委派管理员名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:mamber_name
UsageStatus Integer 启用状态 。取值:0-服务无启用状态 1-已启用 2-未启用
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreateTime String 委派时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-03-12 12:19:12
ManagementScope Integer 委派管理员管理范围。取值: 1-全部成员 2-部分成员
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ManagementScopeMembers Array of MemberMainInfo 管理的成员Uin列表。ManagementScope值为2时该参数有效
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
ManagementScopeNodes Array of NodeMainInfo 管理的部门ID列表。ManagementScope值为2时该参数有效
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]

PolicyDetail

策略详情

被如下接口引用:AddPermissionPolicyToRoleConfiguration。

名称 类型 必选 描述
PolicyId Integer 策略ID。
示例值:426322
PolicyName String 策略名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:QcloudAccessForOceanusRole

ProductResource

产品资源

被如下接口引用:AddShareUnitResources。

名称 类型 必选 描述
ProductResourceId String 产品资源ID。
示例值:sec***002

ResourceTagMapping

资源及关联的标签

被如下接口引用:ListNonCompliantResource。

名称 类型 描述
Resource String 资源六段式。腾讯云使用资源六段式描述一个资源。
例如:qcs::${ServiceType}:${Region}:${Account}:${ResourcePreifx}/${ResourceId}。
注意:此字段可能返回 null,表示取不到有效值。
ComplianceDetails TagComplianceDetails 合规详情。
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of Tags 资源标签。
注意:此字段可能返回 null,表示取不到有效值。

RoleAssignmentInfo

授权成员账号信息

被如下接口引用:CreateRoleAssignment。

名称 类型 必选 描述
PrincipalId String CAM 用户同步的身份 ID。取值:
当PrincipalType取值为Group时,该值为CIC用户组 ID(g-****)。
当PrincipalType取值为User时,该值为CIC用户 ID(u-****)。
示例值:u-xuec8dnd
PrincipalType String CAM 用户同步的身份类型。取值:

User:表示该 CAM 用户同步的身份是CIC用户。
Group:表示该 CAM 用户同步的身份是CIC用户组。
示例值:User
TargetUin Integer 同步集团账号目标账号的UIN。
示例值:100003829343
TargetType String 同步集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号
示例值:MemberUin
RoleConfigurationId String 权限配置ID。
示例值:rc-s82nd93ne***

RoleAssignments

成员账号的授权详情

被如下接口引用:ListRoleAssignments。

名称 类型 必选 描述
RoleConfigurationId String 权限配置ID。
示例值:rc-sksom***
RoleConfigurationName String 权限配置名称。
示例值:test
TargetUin Integer 集团账号目标账号的UIN。
示例值:1000029322
TargetType String 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号。
示例值:MemberUin
PrincipalId String CAM 用户同步的身份 ID。取值: 当PrincipalType取值为Group时,该值为CIC 用户组 ID(g-****)。 当PrincipalType取值为User时,该值为CIC 用户 ID(u-****)。
示例值:u-dwidn***
PrincipalType String CAM 用户同步的身份类型。取值: User:表示该 CAM 用户同步的身份是CIC用户。 Group:表示该 CAM 用户同步的身份是CIC用户组。
示例值:User
PrincipalName String 用户名称或者用户组名称
示例值:test
CreateTime String 创建时间。
示例值:2024-01-01 12:12:12
UpdateTime String 更新时间。
示例值:2024-01-01 12:12:12
TargetName String 集团账号目标账号的名称。
示例值:test

RoleConfiguration

CIC权限配置

被如下接口引用:CreateRoleConfiguration, GetRoleConfiguration, ListRoleConfigurations, UpdateRoleConfiguration。

名称 类型 必选 描述
RoleConfigurationId String 权限配置配置ID。
示例值:rc-3334342dws****
RoleConfigurationName String 权限配置配名称。
示例值:test
Description String 权限配置的描述。
示例值:this is role configuration
SessionDuration Integer 会话持续时间。CIC 用户使用访问配置访问成员账号时,会话最多保持的时间。
单位:秒。
示例值:900
RelayState String 初始访问页面。CIC 用户使用访问配置访问成员账号时,初始访问的页面地址。
示例值:https://console.cloud.tencent.com/
CreateTime String 权限配置的创建时间。
示例值:2019-01-01 12:12:12
UpdateTime String 权限配置的更新时间。
示例值:2019-01-01 12:12:12
IsSelected Boolean 如果有入参FilterTargets查询成员账号是否配置过权限,配置了返回true,否则返回false。
示例值:false

RoleConfigurationProvisionings

权限配置同步

被如下接口引用:ListRoleConfigurationProvisionings。

名称 类型 必选 描述
DeploymentStatus String Deployed: 部署成功 DeployedRequired:需要重新部署 DeployFailed:部署失败
示例值:DeployedRequired
RoleConfigurationId String 权限配置ID。
示例值:rc-sk9mwq**
RoleConfigurationName String 权限配置名称。
示例值:test
TargetUin Integer 集团账号目标账号的UIN
示例值:100003921
TargetName String 集团账号目标账号的名称。
示例值:test
CreateTime String 创建时间,
示例值:2021-01-01 13:12:12
UpdateTime String 修改时间,
示例值:权限配置ID。
TargetType String 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号
示例值:ManagerUin

RolePolicie

CIC的权限策略

被如下接口引用:ListPermissionPoliciesInRoleConfiguration。

名称 类型 必选 描述
RolePolicyId Integer 策略ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:426322
RolePolicyName String 权限策略名称
示例值:AdminPolicy
RolePolicyType String 权限策略类型
示例值:Custom
RolePolicyDocument String 自定义策略内容。仅自定义策略返回该参数。
示例值:{"Statement": [{"Action": "","Effect": "Allow","Resource": ""}],"Version": "1"}
AddTime String 权限策略被添加到权限配置的时间。
示例值:2019-01-01 12:12:12

RoleProvisioningsTask

同步部署角色任务状态信息。

被如下接口引用:DismantleRoleConfiguration, ProvisionRoleConfiguration。

名称 类型 必选 描述
TaskId String 任务ID。
示例值:InProgress
RoleConfigurationId String 权限配置ID。
示例值:t-s8n28n2***
RoleConfigurationName String 权限配置名称。
示例值:ProvisionRoleConfiguration
TargetUin Integer 授权的集团账号目标账号的UIN
示例值:100000232323
TargetType String 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号
注意:此字段可能返回 null,表示取不到有效值。
示例值:MemberUin
TaskType String 任务类型。
注意:此字段可能返回 null,表示取不到有效值。
示例值:CreateRoleAssignment
TaskStatus String 任务状态:InProgress: 进行中,Failed: 失败 3:Success: 成功
注意:此字段可能返回 null,表示取不到有效值。
示例值:InProgress

SAMLIdPCertificate

SAML 签名证书信息

被如下接口引用:ListExternalSAMLIdPCertificates。

名称 类型 必选 描述
SerialNumber String 证书序列号。
示例值:1347934239****
Issuer String 证书颁发者。
示例值:5.6.54.22.1.9.1=#dj39dj39e3w9rm3e2e3****,CN=dev-xxxxxx,OU=SSOProvider,O=Okta
Version Integer 证书版本。
示例值:1
CertificateId String 证书ID。
示例值:idp-c-2jd8923je29****
PublicKey String PEM 格式的公钥证书(Base64 编码)。
示例值:nMIIBtjCCAVugAwIBAgITBmyf1XSXNmY****
SignatureAlgorithm String 证书的签名算法。
示例值:SHA256withRSA
NotAfter String 证书的过期时间。
示例值:2030-06-23 07:04:37
NotBefore String 证书的创建时间。
示例值:2013-06-23 07:04:37
Subject String 证书的主体。
示例值:5.6.54.22.1.9.1=#dj39dj39e3w9rm3e2e3****,CN=dev-xxxxxx,OU=SSOProvider,O=Okta
X509Certificate String PEM 格式的 X509 证书。
示例值:nMIIBtjCCAVugAwIBAgITBmyf1XSXNmY****

SAMLIdentityProviderConfiguration

saml 身份提供商配置信息。

被如下接口引用:GetExternalSAMLIdentityProvider。

名称 类型 必选 描述
EntityId String IdP 标识。
示例值:http://www.okta.com/2jd83ne9m*
SSOStatus String SSO 登录的启用状态。取值: Enabled:启用。 Disabled(默认值):禁用。
示例值:Enbaled
EncodedMetadataDocument String IdP 元数据文档(Base64 编码)。
示例值:PD94bWwgdmVyc2lvbj0iMS4****
CertificateIds Array of String X509证书ID。
示例值:["idp-c-2jd8923je29****"]
LoginUrl String IdP 的登录地址。
示例值:https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/2jd83ne9m****/sso/saml
CreateTime String 创建时间。
示例值:2024-01-01 12:12:12
UpdateTime String 更新时间。
示例值:2024-01-01 12:12:12

SAMLServiceProvider

SAML服务提供商信息

被如下接口引用:GetZoneSAMLServiceProviderInfo。

名称 类型 必选 描述
EntityId String https://tencentcloudsso.com/saml/sp/z-sjw8ensa**
示例值:SP 标识。
ZoneId String 空间ID。
示例值:z-sjw8ensa**
EncodedMetadataDocument String SP 元数据文档(Base64 编码)。
示例值:JTNDJTNGeG1sJTIwdmVyc2lvbiUzRCUyMjEuMCUyMiUyMGVuY29kaW5nJTNEJTIy*
AcsUrl String SP 的 ACS URL。
示例值:https://tencentcloudsso.com/saml/acs/swedx-22a20du2-x2je9****

ShareArea

共享地域

被如下接口引用:DescribeShareAreas。

名称 类型 描述
Name String 地域名称。
示例值:广州
Area String 地域标识。
示例值:ap-guangzhou
AreaId Integer 地域ID。
示例值:1

ShareMember

共享成员信息

被如下接口引用:AddShareUnitMembers, DeleteShareUnitMembers。

名称 类型 必选 描述
ShareMemberUin Integer 共享成员Uin。
示例值:333333333333

ShareResource

共享资源

被如下接口引用:DeleteShareUnitResources。

名称 类型 必选 描述
ProductResourceId String 产品资源ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:sec***002

ShareUnitMember

共享单元成员

被如下接口引用:DescribeShareUnitMembers。

名称 类型 描述
ShareMemberUin Integer 共享成员Uin。
示例值:333333333333
CreateTime String 创建时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-03-05 12:12:01

ShareUnitResource

共享单元资源

被如下接口引用:DescribeShareUnitResources。

名称 类型 描述
ResourceId String 共享资源ID。
示例值:shareResource-12**erte
Type String 共享资源类型。
示例值:secret
CreateTime String 创建时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-02-12 23:32:23
ProductResourceId String 产品资源ID。
示例值:sec***002
SharedMemberNum Integer 共享单元成员数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
SharedMemberUseNum Integer 使用中共享单元成员数。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ShareManagerUin Integer 共享管理员OwnerUin。
注意:此字段可能返回 null,表示取不到有效值。
示例值:111111111111

TagComplianceDetails

标签合规信息

被如下接口引用:ListNonCompliantResource。

名称 类型 描述
ComplianceStatus Boolean 合规状态。true-合规,false-不合规
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
KeysWithNonCompliantValues Array of String 值不合规的标签键列表。
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
NonCompliantKeys Array of String 键不合规的标签键列表。
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]

Tags

标签键值对

被如下接口引用:ListNonCompliantResource。

名称 类型 描述
TagKey String 标签键。
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
TagValue String 标签值。
注意:此字段可能返回 null,表示取不到有效值。
示例值:""

TaskInfo

任务状态信息。

被如下接口引用:CreateRoleAssignment, DeleteRoleAssignment, ListTasks。

名称 类型 必选 描述
TaskId String 任务ID。
示例值:InProgress
RoleConfigurationId String 权限配置ID。
示例值:t-s8n28n2***
RoleConfigurationName String 权限配置名称。
示例值:ProvisionRoleConfiguration
TargetUin Integer 授权的目标成员账号的UIN
示例值:100000232323
TargetType String 同步的目标账号的类型,ManagerUin管理账号;MemberUin成员账号
示例值:MemberUin
PrincipalId String 用户授权的身份ID,如果是身份类型是CIC用户,则为用户ID; 如果是用户组,则为用户组ID;
示例值:u-dw2isaw***
PrincipalType String 用户授权的身份类型, User代表CIC用户, Group代表CIC用户组
示例值:User
TaskType String 任务类型。
示例值:CreateRoleAssignment
Status String InProgress:任务执行中。 Success:任务执行成功。 Failed:任务执行失败。
示例值:InProgress
FailureReason String 失败原因
注意:此字段可能返回 null,表示取不到有效值。
示例值:失败

TaskStatus

任务状态信息。

被如下接口引用:GetProvisioningTaskStatus, GetTaskStatus。

名称 类型 必选 描述
Status String 任务状态。取值: InProgress:任务执行中。 Success:任务执行成功。 Failed:任务执行失败。
示例值:InProgress
TaskId String 任务 ID。
示例值:t-s8n28n2***
TaskType String 任务类型。取值:
ProvisionRoleConfiguration:部署权限配置。
DeprovisionRoleConfiguration:解除权限配置部署。
CreateRoleAssignment:在成员 账号上授权。
DeleteRoleAssignment:移除 成员 账号上的授权。
示例值:ProvisionRoleConfiguration
FailureReason String 任务失败原因。
说明
只有Status为Failed,才会显示该参数。
示例值:部署失败

UserInfo

用户信息

被如下接口引用:CreateUser, GetUser, ListUsers, UpdateUser。

名称 类型 必选 描述
UserName String 查询username。
示例值:Alice
FirstName String 用户的名。
示例值:Alice
LastName String 用户的姓。
示例值:Alice
DisplayName String 用户的显示名称。
示例值:Alice
Description String 用户的描述。
示例值:this is user.
Email String 用户的电子邮箱。目录内必须唯一。
示例值:Alice@example.com
UserStatus String 用户状态 Enabled:启用, Disabled:禁用。
示例值:Enabled
UserType String 用户类型 Manual:手动创建,Synchronized:外部导入。
示例值:Manual
UserId String 用户 ID
示例值:u-a34wsd32
CreateTime String 用户的创建时间
示例值:2024-03-26 12:03:42
UpdateTime String 用户的修改时间
示例值:2024-03-26 19:12:17
IsSelected Boolean 是否选中
示例值:false

UserProvisioning

用户同步信息

被如下接口引用:GetUserSyncProvisioning, ListUserSyncProvisionings。

名称 类型 必选 描述
UserProvisioningId String CAM 用户同步的状态。取值:

Enabled:CAM 用户同步已启用。
Disabled:CAM 用户同步未启用。
示例值:up-swns92ns
Description String 描述。
示例值:this is cam user provisioning
Status String CAM 用户同步的状态。取值:
Enabled:CAM 用户同步已启用。
Disabled:CAM 用户同步未启用。
示例值:Enabled
PrincipalId String CAM 用户同步的身份 ID。取值:
当PrincipalType取值为Group时,该值为CIC用户组 ID(g-****)。
当PrincipalType取值为User时,该值为CIC用户 ID(u-****)。
示例值:u-xuec8dnd
PrincipalName String CAM 用户同步的身份名称。取值:
当PrincipalType取值为Group时,该值为CIC用户组名称。
当PrincipalType取值为User时,该值为CIC用户名称。
示例值:testUser
PrincipalType String CAM 用户同步的身份类型。取值:

User:表示该 CAM 用户同步的身份是CIC用户。
Group:表示该 CAM 用户同步的身份是CIC用户组。
示例值:User
TargetUin Integer 集团账号目标账号的UIN。
示例值:100003829343
TargetName String 集团账号目标账号的名称。
示例值:test
DuplicationStrategy String 冲突策略。当CIC 用户同步到 CAM 时,如果 CAM 中存在同名用户时的处理策略。取值: KeepBoth:两者都保留。当CIC 用户被同步到 CAM 时,如果 CAM 已经存在同名用户,则对CIC 用户的用户名添加后缀_cic后尝试创建该用户名的 CAM 用户。 TakeOver:替换。当CIC 用户被同步到 CAM 时,如果 CAM 已经存在同名用户,则直接将已经存在的 CAM 用户替换为CIC 同步用户。
示例值:KeepBoth
DeletionStrategy String 删除策略。删除 CAM 用户同步时,对已同步的 CAM 用户的处理策略。取值: Delete:删除。删除 CAM 用户同步时,会删除从CIC 已经同步到 CAM 中的 CAM 用户。 Keep:保留。删除 RAM 用户同步时,会保留从CIC 已经同步到 CAM 中的 CAM 用户。
示例值:Delete
CreateTime String 创建时间。
示例值:2024-01-01 12:12:12
UpdateTime String 更新时间。
示例值:2024-01-01 12:12:12
TargetType String 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号
示例值:MemberUin

UserProvisioningsTask

用户同步任务状态信息。

被如下接口引用:CreateUserSyncProvisioning, DeleteUserSyncProvisioning。

名称 类型 必选 描述
TaskId String 任务ID。
示例值:InProgress
TargetUin Integer 授权的集团账号目标账号的UIN
示例值:100000232323
TargetType String 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号
示例值:MemberUin
TaskType String 任务类型。StartProvisioning:用户同步,DeleteProvisioning:删除用户同步
示例值:StartProvisioning
TaskStatus String 任务状态:InProgress: 进行中,Failed: 失败 3:Success: 成功
示例值:InProgress
UserProvisioningId String 用户同步ID。
示例值:ur-ska9dhw
PrincipalId String CAM 用户同步的身份 ID。取值: 当PrincipalType取值为Group时,该值为CIC 用户组 ID(g-****)。 当PrincipalType取值为User时,该值为CIC 用户 ID(u-****)。
示例值:u-cm9xjsw***
PrincipalType String CAM 用户同步的身份类型。取值: User:表示该 CAM 用户同步的身份是CIC 用户。 Group:表示该 CAM 用户同步的身份是CIC 用户组。
示例值:User
PrincipalName String 用户或者用户组名称。
示例值:test
DuplicationStrategy String 冲突策略。KeepBoth:两者都保留;TakeOver:替换
示例值:KeepBoth
DeletionStrategy String 删除策略。Delete:删除;Keep:保留
示例值:Delete

UserSyncProvisioning

CAM用户同步信息

被如下接口引用:CreateUserSyncProvisioning。

名称 类型 必选 描述
Description String 描述。
示例值:this is cam user provisioning
PrincipalId String CAM 用户同步的身份 ID。取值:
当PrincipalType取值为Group时,该值为CIC用户组 ID(g-****)。
当PrincipalType取值为User时,该值为CIC用户 ID(u-****)。
示例值:u-xuec8dnd
PrincipalType String CAM 用户同步的身份类型。取值:

User:表示该 CAM 用户同步的身份是CIC用户。
Group:表示该 CAM 用户同步的身份是CIC用户组。
示例值:User
TargetUin Integer 同步的集团账号目标账号的UIN。
示例值:100003829343
DuplicationStrategy String 冲突策略。当CIC 用户同步到 CAM 时,如果 CAM 中存在同名用户时的处理策略。取值: KeepBoth:两者都保留。当CIC 用户被同步到 CAM 时,如果 CAM 已经存在同名用户,则对CIC 用户的用户名添加后缀_cic后尝试创建该用户名的 CAM 用户。 TakeOver:替换。当CIC 用户被同步到 CAM 时,如果 CAM 已经存在同名用户,则直接将已经存在的 CAM 用户替换为CIC 同步用户。
示例值:KeepBoth
DeletionStrategy String 删除策略。删除 CAM 用户同步时,对已同步的 CAM 用户的处理策略。取值: Delete:删除。删除 CAM 用户同步时,会删除从CIC 已经同步到 CAM 中的 CAM 用户。 Keep:保留。删除 RAM 用户同步时,会保留从CIC 已经同步到 CAM 中的 CAM 用户。
示例值:Delete
TargetType String 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号
示例值:MemberUin

ZoneStatistics

CIC的空间统计

被如下接口引用:GetZoneStatistics。

名称 类型 必选 描述
UserQuota Integer 用户配额。
示例值:1000
GroupQuota Integer 用户组配额。
示例值:500
RoleConfigurationQuota Integer 权限配置配额。
示例值:1000
SystemPolicyPerRoleConfigurationQuota Integer 权限配置绑定的系统策略配额。
示例值:20
UserCount Integer 用户数。
示例值:12
GroupCount Integer 用户组数。
示例值:10
RoleConfigurationCount Integer 权限配置数
示例值:3
UserProvisioningCount Integer 同步用户数。
示例值:12
RoleConfigurationSyncCount Integer 同步角色数。
示例值:10