tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
2,086 lines (1,894 loc) • 161 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 互信主体主要信息 */
declare interface AuthNode {
/** 互信主体关系ID */
RelationId?: number;
/** 互信主体名称 */
AuthName?: string;
/** 主体管理员 */
Manager?: MemberMainInfo;
}
/** 野鹤实名互信申请证明文件 */
declare interface AuthRelationFile {
/** 文件名。 */
Name: string;
/** 文件路径。 */
Url: string;
}
/** 有效策略。 */
declare interface EffectivePolicy {
/** 目标ID。 */
TargetId?: number;
/** 有效策略内容。 */
PolicyContent?: string;
/** 有效策略更新时间。 */
LastUpdatedTimestamp?: number;
}
/** 用户组信息。 */
declare interface GroupInfo {
/** 用户组的名称。 */
GroupName?: string;
/** 用户组的描述。 */
Description?: string;
/** 用户组的创建时间。 */
CreateTime?: string;
/** 用户组的类型 Manual:手动创建,Synchronized:外部导入。 */
GroupType?: string;
/** 用户组的修改时间。 */
UpdateTime?: string;
/** 用户组的 ID。 */
GroupId?: string;
/** 组员数量。 */
MemberCount?: number;
/** 如果有入参FilterUsers,用户在用户组返回true,否则返回false */
IsSelected?: boolean;
}
/** 用户信息 */
declare interface GroupMembers {
/** 查询username。 */
UserName?: string;
/** 用户的显示名称。 */
DisplayName?: string;
/** 用户的描述。 */
Description?: string;
/** 用户的电子邮箱。目录内必须唯一。 */
Email?: string;
/** 用户状态 Enabled:启用, Disabled:禁用。 */
UserStatus?: string;
/** 用户类型 Manual:手动创建,Synchronized:外部导入。 */
UserType?: string;
/** 用户 ID */
UserId?: string;
/** 用户加入用户组的时间 */
JoinTime?: string;
}
/** 组织身份策略 */
declare interface IdentityPolicy {
/** CAM预设策略ID。PolicyType 为预设策略时有效且必选 */
PolicyId?: number;
/** CAM预设策略名称。PolicyType 为预设策略时有效且必选 */
PolicyName?: string;
/** 策略类型。取值 1-自定义策略 2-预设策略;默认值2 */
PolicyType?: number;
/** 自定义策略内容,遵循CAM策略语法。PolicyType 为自定义策略时有效且必选 */
PolicyDocument?: string;
}
/** 用户加入的用户组 */
declare interface JoinedGroups {
/** 用户组的名称。 */
GroupName?: string;
/** 用户组的描述。 */
Description?: string;
/** 用户组 ID。 */
GroupId?: string;
/** 用户组的类型。取值:Manual:手动创建。Synchronized:外部同步。 */
GroupType?: string;
/** 加入用户组的时间 */
JoinTime?: string;
}
/** 查询目标关联的SCP策略列表 */
declare interface ListPoliciesForTarget {
/** 策略Id */
StrategyId?: number;
/** 策略名称 */
StrategyName?: string;
/** 备注信息 */
Remark?: string;
/** 关联的账号或节点 */
Uin?: number;
/** 关联类型 1-节点 2-用户 */
Type?: number;
/** 策略创建时间 */
AddTime?: string;
/** 策略更新时间 */
UpdateTime?: string;
/** 部门名称 */
Name?: string;
/** 策略绑定时间 */
AttachTime?: string;
}
/** 企业组织策略列表 */
declare interface ListPolicyNode {
/** 策略创建时间 */
AddTime?: string;
/** 策略绑定次数 */
AttachedTimes?: number;
/** 策略描述信息 */
Description?: string;
/** 策略名称 */
PolicyName?: string;
/** 策略Id */
PolicyId?: number;
/** 策略更新时间 */
UpdateTime?: string;
/** 策略类型 1-自定义 2-预设 */
Type?: number;
}
/** 查询某个指定SCP策略关联的目标列表 */
declare interface ListTargetsForPolicyNode {
/** scp账号uin或节点Id */
Uin?: number;
/** 关联类型 1-节点关联 2-用户关联 */
RelatedType?: number;
/** 账号或者节点名称 */
Name?: string;
/** 绑定时间 */
AddTime?: string;
}
/** 我的共享单元列表详情 */
declare interface ManagerShareUnit {
/** 共享单元ID。 */
UnitId?: string;
/** 共享单元名称。 */
Name?: string;
/** 共享单元管理员Uin。 */
Uin?: number;
/** 共享单元管理员OwnerUin。 */
OwnerUin?: number;
/** 共享单元地域。 */
Area?: string;
/** 描述。 */
Description?: string;
/** 创建时间。 */
CreateTime?: string;
/** 共享单元资源数。 */
ShareResourceNum?: number;
/** 共享单元成员数。 */
ShareMemberNum?: number;
/** 共享范围。取值:1-仅允许集团组织内共享 2-允许共享给任意账号 */
ShareScope?: number;
}
/** 成员管理身份 */
declare interface MemberIdentity {
/** 身份ID。 */
IdentityId?: number;
/** 身份名称。 */
IdentityAliasName?: string;
}
/** 成员主要信息 */
declare interface MemberMainInfo {
/** 成员uin */
MemberUin?: number;
/** 成员名称 */
MemberName?: string;
}
/** 部门主要信息 */
declare interface NodeMainInfo {
/** 部门ID */
NodeId?: number;
/** 部门名称 */
NodeName?: string;
}
/** 不允许删除的原因。 */
declare interface NotAllowReason {
/** 是否创建的成员。true-是、false-否;成员不是创建的成员不允许删除 */
IsCreateMember?: boolean;
/** 成员删除许可。true-开启、false-关闭;成员删除许可关闭时不允许删除 */
DeletionPermission?: boolean;
/** 是否可信服务委派管理员。true-是、false-否;成员是可信服务委派管理员不允许删除 */
IsAssignManager?: boolean;
/** 是否主体管理员。true-是、false-否;成员是主体管理员不允许删除 */
IsAuthManager?: boolean;
/** 是否共享资源管理员。true-是、false-否;成员是共享资源管理员不允许删除 */
IsShareManager?: boolean;
/** 成员是否设置了操作审批。true-是、false-否;成员设置了操作审批时不允许删除 */
OperateProcess?: boolean;
/** 是否允许解除成员财务权限。true-是、false-否;成员不能解除财务权限时不允许删除 */
BillingPermission?: boolean;
/** 存在的资源列表。账号存在资源时不允许删除 */
ExistResources?: string[];
/** 检测失败的资源列表。账号有资源检测失败时不允许删除。 */
DetectFailedResources?: string[];
}
/** 按月获取组织财务信息 */
declare interface OrgFinancialByMonth {
/** 记录ID。 */
Id?: number;
/** 月份,格式:yyyy-mm,示例:2021-01。 */
Month?: string;
/** 消耗金额,单元:元。 */
TotalCost?: number;
/** 比上月增长率%。正数增长,负数下降,空值无法统计。 */
GrowthRate?: string;
}
/** 组织身份 */
declare interface OrgIdentity {
/** 身份ID。 */
IdentityId?: number;
/** 身份名称。 */
IdentityAliasName?: string;
/** 描述。 */
Description?: string;
/** 身份策略。 */
IdentityPolicy?: IdentityPolicy[];
/** 身份类型。 1-预设、 2-自定义 */
IdentityType?: number;
/** 更新时间。 */
UpdateTime?: string;
}
/** 企业组织成员 */
declare interface OrgMember {
/** 成员Uin */
MemberUin?: number;
/** 成员名 */
Name?: string;
/** 成员类型,邀请:Invite, 创建:Create */
MemberType?: string;
/** 关系策略类型 */
OrgPolicyType?: string;
/** 关系策略名 */
OrgPolicyName?: string;
/** 关系策略权限 */
OrgPermission?: OrgPermission[];
/** 所属节点ID */
NodeId?: number;
/** 所属节点名 */
NodeName?: string;
/** 备注 */
Remark?: string;
/** 创建时间 */
CreateTime?: string;
/** 更新时间 */
UpdateTime?: string;
/** 是否允许成员退出。允许:Allow,不允许:Denied。 */
IsAllowQuit?: string;
/** 代付者Uin */
PayUin?: string;
/** 代付者名称 */
PayName?: string;
/** 管理身份 */
OrgIdentity?: MemberIdentity[];
/** 安全信息绑定状态 未绑定:Unbound,待激活:Valid,绑定成功:Success,绑定失败:Failed */
BindStatus?: string;
/** 成员权限状态 已确认:Confirmed ,待确认:UnConfirmed */
PermissionStatus?: string;
/** 成员标签列表 */
Tags?: Tag[];
/** 腾讯云昵称 */
NickName?: string;
}
/** 成员和子账号的授权关系 */
declare interface OrgMemberAuthAccount {
/** 组织子账号Uin。 */
OrgSubAccountUin?: number;
/** 策略ID。 */
PolicyId?: number;
/** 策略名。 */
PolicyName?: string;
/** 身份ID。 */
IdentityId?: number;
/** 身份角色名。 */
IdentityRoleName?: string;
/** 身份角色别名。 */
IdentityRoleAliasName?: string;
/** 创建时间。 */
CreateTime?: string;
/** 更新时间。 */
UpdateTime?: string;
/** 子账号名称 */
OrgSubAccountName?: string;
}
/** 组织成员可授权的身份 */
declare interface OrgMemberAuthIdentity {
/** 身份ID。 */
IdentityId?: number;
/** 身份的角色名。 */
IdentityRoleName?: string;
/** 身份的角色别名。 */
IdentityRoleAliasName?: string;
/** 身份描述。 */
Description?: string;
/** 首次配置成功的时间。 */
CreateTime?: string;
/** 最后一次配置成功的时间。 */
UpdateTime?: string;
/** 身份类型。取值: 1-预设身份 2-自定义身份 */
IdentityType?: number;
/** 配置状态。取值:1-配置完成 2-需重新配置 */
Status?: number;
/** 成员Uin。 */
MemberUin?: number;
/** 成员名称。 */
MemberName?: string;
}
/** 组织成员财务信息。 */
declare interface OrgMemberFinancial {
/** 成员Uin。 */
MemberUin?: number;
/** 成员名称。 */
MemberName?: string;
/** 消耗金额,单位:元。 */
TotalCost?: number;
/** 占比%。 */
Ratio?: string;
}
/** 组织成员被授权的策略 */
declare interface OrgMemberPolicy {
/** 策略ID。 */
PolicyId?: number;
/** 策略名。 */
PolicyName?: string;
/** 身份ID。 */
IdentityId?: number;
/** 身份角色名。 */
IdentityRoleName?: string;
/** 身份角色别名。 */
IdentityRoleAliasName?: string;
/** 描述。 */
Description?: string;
/** 创建时间。 */
CreateTime?: string;
/** 更新时间。 */
UpdateTime?: string;
}
/** 组织成员访问授权策略 */
declare interface OrgMembersAuthPolicy {
/** 身份Id。 */
IdentityId?: number | null;
/** 身份的角色名。 */
IdentityRoleName?: string | null;
/** 身份的角色别名。 */
IdentityRoleAliasName?: string | null;
/** 创建时间。 */
CreateTime?: string | null;
/** 成员访问策略Id。 */
PolicyId?: number | null;
/** 成员访问策略名称。 */
PolicyName?: string | null;
/** 成员uin。 */
MemberUin?: number | null;
/** 成员名称。 */
MemberName?: string | null;
/** 子账号uin或者用户组Id。 */
OrgSubAccountUin?: number | null;
/** 子账号名称或者用户组名称。 */
OrgSubAccountName?: string | null;
/** 绑定类型。1-子账号、2-用户组 */
BindType?: number | null;
/** 成员信息。 */
Members?: MemberMainInfo[] | null;
}
/** 企业组织单元 */
declare interface OrgNode {
/** 组织节点ID */
NodeId?: number;
/** 名称 */
Name?: string;
/** 父节点ID */
ParentNodeId?: number;
/** 备注 */
Remark?: string;
/** 创建时间 */
CreateTime?: string;
/** 更新时间 */
UpdateTime?: string;
/** 成员标签列表 */
Tags?: Tag[];
}
/** 关系策略权限 */
declare interface OrgPermission {
/** 权限Id */
Id: number;
/** 权限名 */
Name: string;
}
/** 组织产品财务信息 */
declare interface OrgProductFinancial {
/** 产品Code。 */
ProductName?: string;
/** 产品名。 */
ProductCode?: string;
/** 产品消耗,单位:元。 */
TotalCost?: number;
/** 占比%。 */
Ratio?: string;
}
/** 集团服务设置 */
declare interface OrganizationServiceAssign {
/** 集团服务ID。 */
ServiceId?: number;
/** 集团服务产品名称。 */
ProductName?: string;
/** 是否支持委派。取值: 1-是 2-否 */
IsAssign?: number;
/** 集团服务描述。 */
Description?: string;
/** 当前委派管理员数。 */
MemberNum?: string;
/** 帮助文档。 */
Document?: string;
/** 集团服务产品控制台路径。 */
ConsoleUrl?: string;
/** 是否接入使用状态。取值: 1-是 2-否 */
IsUsageStatus?: number;
/** 委派管理员数量限制。 */
CanAssignCount?: number;
/** 集团服务产品标识。 */
Product?: string;
/** 是否支持集团服务授权。取值 1-是、2-否 */
ServiceGrant?: number;
/** 集团服务授权启用状态。ServiceGrant值为1时该字段有效 ,取值:Enabled-开启 Disabled-关闭 */
GrantStatus?: string;
/** 是否支持设置委派管理范围。取值: 1-是 2-否 */
IsSetManagementScope?: number;
}
/** 集团服务委派成员信息 */
declare interface OrganizationServiceAssignMember {
/** 集团服务ID。 */
ServiceId?: number;
/** 集团服务产品名称。 */
ProductName?: string;
/** 委派管理员Uin。 */
MemberUin?: number;
/** 委派管理员名称。 */
MemberName?: string;
/** 启用状态 。取值:0-服务无启用状态 1-已启用 2-未启用 */
UsageStatus?: number;
/** 委派时间。 */
CreateTime?: string;
/** 委派管理员管理范围。取值: 1-全部成员 2-部分成员 */
ManagementScope?: number;
/** 管理的成员Uin列表。ManagementScope值为2时该参数有效 */
ManagementScopeMembers?: MemberMainInfo[];
/** 管理的部门ID列表。ManagementScope值为2时该参数有效 */
ManagementScopeNodes?: NodeMainInfo[];
}
/** 策略详情 */
declare interface PolicyDetail {
/** 策略ID。 */
PolicyId: number;
/** 策略名称。 */
PolicyName?: string;
}
/** 产品资源 */
declare interface ProductResource {
/** 产品资源ID。 */
ProductResourceId: string;
/** 资源六段式最后一节 */
ResourceGrantLast?: string;
}
/** 资源及关联的标签 */
declare interface ResourceTagMapping {
/** 资源六段式。腾讯云使用资源六段式描述一个资源。例如:qcs::${ServiceType}:${Region}:${Account}:${ResourcePreifx}/${ResourceId}。 */
Resource?: string;
/** 合规详情。 */
ComplianceDetails?: TagComplianceDetails;
/** 资源标签。 */
Tags?: Tags[];
}
/** 授权成员账号信息 */
declare interface RoleAssignmentInfo {
/** CAM 用户同步的身份 ID。取值:当PrincipalType取值为Group时,该值为CIC用户组 ID(g-********)。当PrincipalType取值为User时,该值为CIC用户 ID(u-********)。 */
PrincipalId?: string;
/** CAM 用户同步的身份类型。取值:User:表示该 CAM 用户同步的身份是CIC用户。Group:表示该 CAM 用户同步的身份是CIC用户组。 */
PrincipalType?: string;
/** 同步集团账号目标账号的UIN。 */
TargetUin?: number;
/** 同步集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号 */
TargetType?: string;
/** 权限配置ID。 */
RoleConfigurationId?: string;
}
/** 成员账号的授权详情 */
declare interface RoleAssignments {
/** 权限配置ID。 */
RoleConfigurationId?: string;
/** 权限配置名称。 */
RoleConfigurationName?: string;
/** 集团账号目标账号的UIN。 */
TargetUin?: number;
/** 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号。 */
TargetType?: string;
/** CAM 用户同步的身份 ID。取值: 当PrincipalType取值为Group时,该值为CIC 用户组 ID(g-********)。 当PrincipalType取值为User时,该值为CIC 用户 ID(u-********)。 */
PrincipalId?: string;
/** CAM 用户同步的身份类型。取值: User:表示该 CAM 用户同步的身份是CIC用户。 Group:表示该 CAM 用户同步的身份是CIC用户组。 */
PrincipalType?: string;
/** 用户名称或者用户组名称 */
PrincipalName?: string;
/** 创建时间。 */
CreateTime?: string;
/** 更新时间。 */
UpdateTime?: string;
/** 集团账号目标账号的名称。 */
TargetName?: string;
}
/** CIC权限配置 */
declare interface RoleConfiguration {
/** 权限配置配置ID。 */
RoleConfigurationId?: string;
/** 权限配置配名称。 */
RoleConfigurationName?: string;
/** 权限配置的描述。 */
Description?: string;
/** 会话持续时间。CIC 用户使用访问配置访问成员账号时,会话最多保持的时间。单位:秒。 */
SessionDuration?: number;
/** 初始访问页面。CIC 用户使用访问配置访问成员账号时,初始访问的页面地址。 */
RelayState?: string;
/** 权限配置的创建时间。 */
CreateTime?: string;
/** 权限配置的更新时间。 */
UpdateTime?: string;
/** 如果有入参FilterTargets查询成员账号是否配置过权限,配置了返回true,否则返回false。 */
IsSelected?: boolean;
}
/** 权限配置同步 */
declare interface RoleConfigurationProvisionings {
/** Deployed: 部署成功 DeployedRequired:需要重新部署 DeployFailed:部署失败 */
DeploymentStatus?: string;
/** 权限配置ID。 */
RoleConfigurationId?: string;
/** 权限配置名称。 */
RoleConfigurationName?: string;
/** 集团账号目标账号的UIN */
TargetUin?: number;
/** 集团账号目标账号的名称。 */
TargetName?: string;
/** 创建时间, */
CreateTime?: string;
/** 修改时间, */
UpdateTime?: string;
/** 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号 */
TargetType?: string;
}
/** CIC的权限策略 */
declare interface RolePolicie {
/** 策略ID。 */
RolePolicyId?: number;
/** 权限策略名称 */
RolePolicyName?: string;
/** 权限策略类型 */
RolePolicyType?: string;
/** 自定义策略内容。仅自定义策略返回该参数。 */
RolePolicyDocument?: string;
/** 权限策略被添加到权限配置的时间。 */
AddTime?: string;
}
/** 同步部署角色任务状态信息。 */
declare interface RoleProvisioningsTask {
/** 任务ID。 */
TaskId?: string;
/** 权限配置ID。 */
RoleConfigurationId?: string;
/** 权限配置名称。 */
RoleConfigurationName?: string;
/** 授权的集团账号目标账号的UIN */
TargetUin?: number;
/** 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号 */
TargetType?: string;
/** 任务类型。 */
TaskType?: string;
/** 任务状态:InProgress: 进行中,Failed: 失败 3:Success: 成功 */
TaskStatus?: string;
}
/** SAML 签名证书信息 */
declare interface SAMLIdPCertificate {
/** 证书序列号。 */
SerialNumber?: string;
/** 证书颁发者。 */
Issuer?: string;
/** 证书版本。 */
Version?: number;
/** 证书ID。 */
CertificateId?: string;
/** PEM 格式的公钥证书(Base64 编码)。 */
PublicKey?: string;
/** 证书的签名算法。 */
SignatureAlgorithm?: string;
/** 证书的过期时间。 */
NotAfter?: string;
/** 证书的创建时间。 */
NotBefore?: string;
/** 证书的主体。 */
Subject?: string;
/** PEM 格式的 X509 证书。 */
X509Certificate?: string;
}
/** saml 身份提供商配置信息。 */
declare interface SAMLIdentityProviderConfiguration {
/** IdP 标识。 */
EntityId?: string;
/** SSO 登录的启用状态。取值: Enabled:启用。 Disabled(默认值):禁用。 */
SSOStatus?: string;
/** IdP 元数据文档(Base64 编码)。 */
EncodedMetadataDocument?: string;
/** X509证书ID。 */
CertificateIds?: string[];
/** IdP 的登录地址。 */
LoginUrl?: string;
/** 创建时间。 */
CreateTime?: string;
/** 更新时间。 */
UpdateTime?: string;
}
/** SAML服务提供商信息 */
declare interface SAMLServiceProvider {
/** https://tencentcloudsso.com/saml/sp/z-sjw8ensa** */
EntityId?: string;
/** 空间ID。 */
ZoneId?: string;
/** SP 元数据文档(Base64 编码)。 */
EncodedMetadataDocument?: string;
/** SP 的 ACS URL。 */
AcsUrl?: string;
}
/** SCIM密钥 */
declare interface SCIMCredential {
/** 空间ID。z-前缀开头,后面是12位随机数字/小写字母 */
ZoneId?: string;
/** SCIM密钥状态,Enabled已开启,Disabled已关闭。 */
Status?: string;
/** SCIM密钥ID。scimcred-前缀开头,后面是12位随机数字/小写字母。 */
CredentialId?: string;
/** SCIM密钥类型。 */
CredentialType?: string;
/** SCIM 密钥的创建时间。 */
CreateTime?: string;
/** SCIM 密钥的过期时间。 */
ExpireTime?: string;
}
/** 共享地域 */
declare interface ShareArea {
/** 地域名称。 */
Name?: string;
/** 地域标识。 */
Area?: string;
/** 地域ID。 */
AreaId?: number;
}
/** 共享成员信息 */
declare interface ShareMember {
/** 共享成员Uin。 */
ShareMemberUin: number;
}
/** 共享资源 */
declare interface ShareResource {
/** 共享资源ID。 */
ResourceId?: string;
/** 产品资源ID。 */
ProductResourceId?: string;
}
/** 与我共享的资源 */
declare interface ShareResourceToMember {
/** 共享单元资源ID。 */
ResourceId?: string;
/** 资源类型。 */
Type?: string;
/** 共享单元ID。 */
UnitId?: string;
/** 共享单元名称。 */
UnitName?: string;
/** 创建时间。 */
CreateTime?: string;
/** 业务资源ID。 */
ProductResourceId?: string;
/** 共享账号Uin。 */
ShareManagerUin?: number;
}
/** 共享单元成员 */
declare interface ShareUnitMember {
/** 共享成员Uin。 */
ShareMemberUin?: number;
/** 创建时间。 */
CreateTime?: string;
}
/** 共享单元资源 */
declare interface ShareUnitResource {
/** 共享资源ID。 */
ResourceId?: string;
/** 共享资源类型。 */
Type?: string;
/** 创建时间。 */
CreateTime?: string;
/** 产品资源ID。 */
ProductResourceId?: string;
/** 共享单元成员数。 */
SharedMemberNum?: number;
/** 使用中共享单元成员数。 */
SharedMemberUseNum?: number;
/** 共享管理员OwnerUin。 */
ShareManagerUin?: number;
}
/** 标签键值对 */
declare interface Tag {
/** 标签键 */
TagKey: string;
/** 标签值 */
TagValue: string;
}
/** 标签合规信息 */
declare interface TagComplianceDetails {
/** 合规状态。true-合规,false-不合规 */
ComplianceStatus?: boolean;
/** 值不合规的标签键列表。 */
KeysWithNonCompliantValues?: string[];
/** 键不合规的标签键列表。 */
NonCompliantKeys?: string[];
}
/** 标签键值对 */
declare interface Tags {
/** 标签键。 */
TagKey?: string;
/** 标签值。 */
TagValue?: string;
}
/** 任务状态信息。 */
declare interface TaskInfo {
/** 任务ID。 */
TaskId?: string;
/** 权限配置ID。 */
RoleConfigurationId?: string;
/** 权限配置名称。 */
RoleConfigurationName?: string;
/** 授权的目标成员账号的UIN */
TargetUin?: number;
/** 同步的目标账号的类型,ManagerUin管理账号;MemberUin成员账号 */
TargetType?: string;
/** 用户授权的身份ID,如果是身份类型是CIC用户,则为用户ID; 如果是用户组,则为用户组ID; */
PrincipalId?: string;
/** 用户授权的身份类型, User代表CIC用户, Group代表CIC用户组 */
PrincipalType?: string;
/** 任务类型。 */
TaskType?: string;
/** InProgress:任务执行中。 Success:任务执行成功。 Failed:任务执行失败。 */
Status?: string;
/** 失败原因 */
FailureReason?: string;
}
/** 任务状态信息。 */
declare interface TaskStatus {
/** 任务状态。取值: InProgress:任务执行中。 Success:任务执行成功。 Failed:任务执行失败。 */
Status?: string;
/** 任务 ID。 */
TaskId?: string;
/** 任务类型。取值:ProvisionRoleConfiguration:部署权限配置。DeprovisionRoleConfiguration:解除权限配置部署。CreateRoleAssignment:在成员 账号上授权。DeleteRoleAssignment:移除 成员 账号上的授权。 */
TaskType?: string;
/** 任务失败原因。说明只有Status为Failed,才会显示该参数。 */
FailureReason?: string;
}
/** 用户信息 */
declare interface UserInfo {
/** 查询username。 */
UserName?: string;
/** 用户的名。 */
FirstName?: string;
/** 用户的姓。 */
LastName?: string;
/** 用户的显示名称。 */
DisplayName?: string;
/** 用户的描述。 */
Description?: string;
/** 用户的电子邮箱。目录内必须唯一。 */
Email?: string;
/** 用户状态 Enabled:启用, Disabled:禁用。 */
UserStatus?: string;
/** 用户类型 Manual:手动创建,Synchronized:外部导入。 */
UserType?: string;
/** 用户 ID */
UserId?: string;
/** 用户的创建时间 */
CreateTime?: string;
/** 用户的修改时间 */
UpdateTime?: string;
/** 是否选中 */
IsSelected?: boolean;
/** 用户密码 */
Password?: string;
}
/** 用户同步信息 */
declare interface UserProvisioning {
/** CAM 用户同步的状态。取值:Enabled:CAM 用户同步已启用。Disabled:CAM 用户同步未启用。 */
UserProvisioningId?: string;
/** 描述。 */
Description?: string;
/** CAM 用户同步的状态。取值:Enabled:CAM 用户同步已启用。Disabled:CAM 用户同步未启用。 */
Status?: string;
/** CAM 用户同步的身份 ID。取值:当PrincipalType取值为Group时,该值为CIC用户组 ID(g-********)。当PrincipalType取值为User时,该值为CIC用户 ID(u-********)。 */
PrincipalId?: string;
/** CAM 用户同步的身份名称。取值:当PrincipalType取值为Group时,该值为CIC用户组名称。当PrincipalType取值为User时,该值为CIC用户名称。 */
PrincipalName?: string;
/** CAM 用户同步的身份类型。取值:User:表示该 CAM 用户同步的身份是CIC用户。Group:表示该 CAM 用户同步的身份是CIC用户组。 */
PrincipalType?: string;
/** 集团账号目标账号的UIN。 */
TargetUin?: number;
/** 集团账号目标账号的名称。 */
TargetName?: string;
/** 冲突策略。当CIC 用户同步到 CAM 时,如果 CAM 中存在同名用户时的处理策略。取值: KeepBoth:两者都保留。当CIC 用户被同步到 CAM 时,如果 CAM 已经存在同名用户,则对CIC 用户的用户名添加后缀_cic后尝试创建该用户名的 CAM 用户。 TakeOver:替换。当CIC 用户被同步到 CAM 时,如果 CAM 已经存在同名用户,则直接将已经存在的 CAM 用户替换为CIC 同步用户。 */
DuplicationStrategy?: string;
/** 删除策略。删除 CAM 用户同步时,对已同步的 CAM 用户的处理策略。取值: Delete:删除。删除 CAM 用户同步时,会删除从CIC 已经同步到 CAM 中的 CAM 用户。 Keep:保留。删除 RAM 用户同步时,会保留从CIC 已经同步到 CAM 中的 CAM 用户。 */
DeletionStrategy?: string;
/** 创建时间。 */
CreateTime?: string;
/** 更新时间。 */
UpdateTime?: string;
/** 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号 */
TargetType?: string;
}
/** 用户同步任务状态信息。 */
declare interface UserProvisioningsTask {
/** 任务ID。 */
TaskId?: string;
/** 授权的集团账号目标账号的UIN */
TargetUin?: number;
/** 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号 */
TargetType?: string;
/** 任务类型。StartProvisioning:用户同步,DeleteProvisioning:删除用户同步 */
TaskType?: string;
/** 任务状态:InProgress: 进行中,Failed: 失败 3:Success: 成功 */
TaskStatus?: string;
/** 用户同步ID。 */
UserProvisioningId?: string;
/** CAM 用户同步的身份 ID。取值: 当PrincipalType取值为Group时,该值为CIC 用户组 ID(g-********)。 当PrincipalType取值为User时,该值为CIC 用户 ID(u-********)。 */
PrincipalId?: string;
/** CAM 用户同步的身份类型。取值: User:表示该 CAM 用户同步的身份是CIC 用户。 Group:表示该 CAM 用户同步的身份是CIC 用户组。 */
PrincipalType?: string;
/** 用户或者用户组名称。 */
PrincipalName?: string;
/** 冲突策略。KeepBoth:两者都保留;TakeOver:替换 */
DuplicationStrategy?: string;
/** 删除策略。Delete:删除;Keep:保留 */
DeletionStrategy?: string;
}
/** CAM用户同步信息 */
declare interface UserSyncProvisioning {
/** 描述。 */
Description?: string;
/** CAM 用户同步的身份 ID。取值:当PrincipalType取值为Group时,该值为CIC用户组 ID(g-********)。当PrincipalType取值为User时,该值为CIC用户 ID(u-********)。 */
PrincipalId?: string;
/** CAM 用户同步的身份类型。取值:User:表示该 CAM 用户同步的身份是CIC用户。Group:表示该 CAM 用户同步的身份是CIC用户组。 */
PrincipalType?: string;
/** 同步的集团账号目标账号的UIN。 */
TargetUin?: number;
/** 冲突策略。当CIC 用户同步到 CAM 时,如果 CAM 中存在同名用户时的处理策略。取值: KeepBoth:两者都保留。当CIC 用户被同步到 CAM 时,如果 CAM 已经存在同名用户,则对CIC 用户的用户名添加后缀_cic后尝试创建该用户名的 CAM 用户。 TakeOver:替换。当CIC 用户被同步到 CAM 时,如果 CAM 已经存在同名用户,则直接将已经存在的 CAM 用户替换为CIC 同步用户。 */
DuplicationStrategy?: string;
/** 删除策略。删除 CAM 用户同步时,对已同步的 CAM 用户的处理策略。取值: Delete:删除。删除 CAM 用户同步时,会删除从CIC 已经同步到 CAM 中的 CAM 用户。 Keep:保留。删除 RAM 用户同步时,会保留从CIC 已经同步到 CAM 中的 CAM 用户。 */
DeletionStrategy?: string;
/** 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号 */
TargetType?: string;
}
/** CIC的空间统计 */
declare interface ZoneStatistics {
/** 用户配额。 */
UserQuota?: number;
/** 用户组配额。 */
GroupQuota?: number;
/** 权限配置配额。 */
RoleConfigurationQuota?: number;
/** 权限配置绑定的系统策略配额。 */
SystemPolicyPerRoleConfigurationQuota?: number;
/** 用户数。 */
UserCount?: number;
/** 用户组数。 */
GroupCount?: number;
/** 权限配置数 */
RoleConfigurationCount?: number;
/** 同步用户数。 */
UserProvisioningCount?: number;
/** 同步角色数。 */
RoleConfigurationSyncCount?: number;
}
declare interface AcceptJoinShareUnitInvitationRequest {
/** 共享单元ID。 */
UnitId: string;
}
declare interface AcceptJoinShareUnitInvitationResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AddExternalSAMLIdPCertificateRequest {
/** 空间ID。 */
ZoneId: string;
/** PEM 格式的 X509 证书。 由 SAML 身份提供商提供。 */
X509Certificate: string;
}
declare interface AddExternalSAMLIdPCertificateResponse {
/** SAML 签名证书 ID。 */
CertificateId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AddOrganizationMemberEmailRequest {
/** 成员Uin。 */
MemberUin: number;
/** 邮箱地址。 */
Email: string;
/** 国际区号。 */
CountryCode: string;
/** 手机号。 */
Phone: string;
}
declare interface AddOrganizationMemberEmailResponse {
/** 绑定Id */
BindId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AddOrganizationNodeRequest {
/** 父节点ID。可以通过[DescribeOrganizationNodes](https://cloud.tencent.com/document/product/850/82926)获取 */
ParentNodeId: number;
/** 节点名称。最大长度为40个字符,支持英文字母、数字、汉字、符号+@、&._[]- */
Name: string;
/** 备注。 */
Remark?: string;
/** 部门标签列表。最大10个 */
Tags?: Tag[];
}
declare interface AddOrganizationNodeResponse {
/** 节点ID。 */
NodeId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AddPermissionPolicyToRoleConfigurationRequest {
/** 空间 ID */
ZoneId: string;
/** 权限配置 ID */
RoleConfigurationId: string;
/** 权限策略类型。取值: System:系统策略。复用 CAM 的系统策略。 Custom: 自定义策略。按照 CAM 权限策略语法和结构编写的自定义策略。 */
RolePolicyType: string;
/** 权限策略名称,长度最大为 20策略,每个策略长度最大32个字符。如果要添加系统策略,建议使用RolePolicies参数。自定义策略时,数组长度最大为1。 */
RolePolicyNames?: string[];
/** 添加的系统策略详情。 */
RolePolicies?: PolicyDetail[];
/** 自定义策略内容。长度:最大 4096 个字符。当RolePolicyType为Inline时,该参数必须配置。关于权限策略的语法和结构,请参见权限策略语法和结构。 */
CustomPolicyDocument?: string;
/** 自定义策略内容列表(跟RolePolicyNames一一对应) */
CustomPolicyDocuments?: string[];
}
declare interface AddPermissionPolicyToRoleConfigurationResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AddShareUnitMembersRequest {
/** 共享单元ID。 */
UnitId: string;
/** 共享单元地域。 */
Area: string;
/** 共享成员列表。最大10个。 */
Members: ShareMember[];
}
declare interface AddShareUnitMembersResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AddShareUnitRequest {
/** 共享单元名称。仅支持大小写字母、数字、-、以及_的组合,3-128个字符。 */
Name: string;
/** 共享单元地域。可通过接口[DescribeShareAreas](https://cloud.tencent.com/document/product/850/103050)获取支持共享的地域。 */
Area: string;
/** 共享单元描述。最大128个字符。 */
Description?: string;
/** 共享范围。取值:1-仅允许集团组织内共享 2-允许共享给任意账号,默认值:1 */
ShareScope?: number;
}
declare interface AddShareUnitResourcesRequest {
/** 共享单元ID。 */
UnitId: string;
/** 共享单元地域。 */
Area: string;
/** 共享资源类型。支持共享的资源类型,请参见[资源共享概述](https://cloud.tencent.com/document/product/850/59489) */
Type: string;
/** 共享资源列表。最大10个。 */
Resources: ProductResource[];
}
declare interface AddShareUnitResourcesResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AddShareUnitResponse {
/** 共享单元ID。 */
UnitId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AddUserToGroupRequest {
/** 空间 ID。 */
ZoneId: string;
/** 用户组 ID。 */
GroupId: string;
/** 用户 ID。 */
UserId: string;
}
declare interface AddUserToGroupResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AttachPolicyRequest {
/** 绑定策略目标ID。成员Uin或部门ID */
TargetId: number;
/** 目标类型。取值范围:NODE-部门、MEMBER-成员 */
TargetType: string;
/** 策略ID。 */
PolicyId: number;
/** 策略类型。默认值SERVICE_CONTROL_POLICY,取值范围:SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略 */
Type?: string;
}
declare interface AttachPolicyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface BindOrganizationMemberAuthAccountRequest {
/** 成员Uin。 */
MemberUin: number;
/** 策略ID。可以调用[DescribeOrganizationMemberPolicies](https://cloud.tencent.com/document/product/850/82935)获取 */
PolicyId: number;
/** 组织管理员子账号Uin列表。最大5个 */
OrgSubAccountUins: number[];
}
declare interface BindOrganizationMemberAuthAccountResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface BindOrganizationPolicySubAccountRequest {
/** 策略ID。 */
PolicyId: number;
/** 组织管理员子账号Uin列表。最大5个 */
OrgSubAccountUins: number[];
}
declare interface BindOrganizationPolicySubAccountResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CancelOrganizationMemberAuthAccountRequest {
/** 成员Uin。 */
MemberUin: number;
/** 策略ID。可以通过[DescribeOrganizationMemberPolicies](https://cloud.tencent.com/document/product/850/82935)获取 */
PolicyId: number;
/** 组织子账号Uin。 */
OrgSubAccountUin: number;
}
declare interface CancelOrganizationMemberAuthAccountResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CancelOrganizationPolicySubAccountRequest {
/** 策略ID。 */
PolicyId: number;
/** 组织管理员子账号Uin列表。最大5个 */
OrgSubAccountUins: number[];
}
declare interface CancelOrganizationPolicySubAccountResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CheckAccountDeleteRequest {
/** 成员Uin。 */
MemberUin: number;
}
declare interface CheckAccountDeleteResponse {
/** 成员是否允许删除。 true-是、false-否 */
AllowDelete?: boolean;
/** 不允许删除原因。 */
NotAllowReason?: NotAllowReason;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ClearExternalSAMLIdentityProviderRequest {
/** 空间ID。 */
ZoneId: string;
}
declare interface ClearExternalSAMLIdentityProviderResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateGroupRequest {
/** 空间 ID。 */
ZoneId: string;
/** 用户组的名称。 格式:允许英文字母、数字和特殊字符-。 长度:最大 128 个字符。 */
GroupName: string;
/** 用户组的描述。 长度:最大 1024 个字符。 */
Description?: string;
/** 用户组类型 Manual:手动创建,Synchronized:外部导入 */
GroupType?: string;
}
declare interface CreateGroupResponse {
/** 用户组信息。 */
GroupInfo?: GroupInfo;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateOrgServiceAssignRequest {
/** 委派管理员Uin列表。 最大长度20个 */
MemberUins: number[];
/** 集团服务ID。和集团服务产品标识二选一必填,可以通过[ListOrganizationService](https://cloud.tencent.com/document/product/850/109561)获取 */
ServiceId?: number;
/** 集团服务产品标识。和集团服务ID二选一必填,可以通过[ListOrganizationService](https://cloud.tencent.com/document/product/850/109561)获取 */
Product?: string;
/** 委派管理员管理范围。 取值:1-全部成员 2-部分成员,默认值1 */
ManagementScope?: number;
/** 管理的成员Uin列表。ManagementScope为2时该参数有效 */
ManagementScopeUins?: number[];
/** 管理的部门ID列表。ManagementScope为2时该参数有效 */
ManagementScopeNodeIds?: number[];
}
declare interface CreateOrgServiceAssignResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateOrganizationIdentityRequest {
/** 身份名称 */
IdentityAliasName: string;
/** 身份策略 */
IdentityPolicy: IdentityPolicy[];
/** 身份描述 */
Description?: string;
}
declare interface CreateOrganizationIdentityResponse {
/** 身份ID */
IdentityId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateOrganizationMemberAuthIdentityRequest {
/** 成员Uin列表。最多10个 */
MemberUins: number[];
/** 身份Id列表。最多5个,可以通过[ListOrganizationIdentity](https://cloud.tencent.com/document/product/850/82934)获取 */
IdentityIds: number[];
}
declare interface CreateOrganizationMemberAuthIdentityResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateOrganizationMemberPolicyRequest {
/** 成员Uin。 */
MemberUin: number;
/** 策略名。最大长度为128个字符,支持英文字母、数字、符号+=,.@_- */
PolicyName: string;
/** 成员访问身份ID。可以调用[DescribeOrganizationMemberAuthIdentities](https://cloud.tencent.com/document/product/850/82936)获取 */
IdentityId: number;
/** 描述。 */
Description?: string;
}
declare interface CreateOrganizationMemberPolicyResponse {
/** 策略ID。 */
PolicyId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateOrganizationMemberRequest {
/** 成员名称。最大长度为25个字符,支持英文字母、数字、汉字、符号+@、&._[]-:, */
Name: string;
/** 关系策略。取值:Financial */
PolicyType: string;
/** 成员财务权限ID列表。取值:1-查看账单、2-查看余额、3-资金划拨、4-合并出账、5-开票、6-优惠继承、7-代付费,1、2 默认必须 */
PermissionIds: number[];
/** 成员所属部门的节点ID。可以通过[DescribeOrganizationNodes](https://cloud.tencent.com/document/product/850/82926)获取 */
NodeId: number;
/** 账号名称。最大长度为25个字符,支持英文字母、数字、汉字、符号+@、&._[]-:, */
AccountName: string;
/** 备注。 */
Remark?: string;
/** 成员创建记录ID。创建异常重试时需要 */
RecordId?: number;
/** 代付者Uin。成员代付费时需要 */
PayUin?: string;
/** 成员访问身份ID列表。可以调用ListOrganizationIdentity获取,1默认支持 */
IdentityRoleID?: number[];
/** 认证主体关系ID。给不同主体创建成员时需要,可以调用DescribeOrganizationAuthNode获取 */
AuthRelationId?: number;
/** 成员标签列表。最大10个 */
Tags?: Tag[];
}
declare interface CreateOrganizationMemberResponse {
/** 成员Uin。 */
Uin?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateOrganizationMembersPolicyRequest {
/** 成员Uin列表。最多10个 */
MemberUins: number[];
/** 策略名。长度1~128个字符,支持英文字母、数字、符号+=,.@_- */
PolicyName: string;
/** 成员访问身份ID。可以通过[ListOrganizationIdentity](https://cloud.tencent.com/document/product/850/82934)获取 */
IdentityId: number;
/** 策略描述。最大长度为128个字符 */
Description?: string;
}
declare interface CreateOrganizationMembersPolicyResponse {
/** 策略ID。 */
PolicyId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateOrganizationRequest {
}
declare interface CreateOrganizationResponse {
/** 企业组织ID */
OrgId?: number;
/** 创建者昵称 */
NickName?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreatePolicyRequest {
/** 策略名。长度为1~128个字符,可以包含汉字、英文字母、数字和下划线(_) */
Name: string;
/** 策略内容。参考CAM策略语法 */
Content: string;
/** 策略类型。默认值SERVICE_CONTROL_POLICY,取值范围:SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略 */
Type: string;
/** 策略描述。 */
Description?: string;
}
declare interface CreatePolicyResponse {
/** 策略ID */
PolicyId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateRoleAssignmentRequest {
/** 空间 ID。 */
ZoneId: string;
/** 授权成员账号信息,最多授权50条。 */
RoleAssignmentInfo?: RoleAssignmentInfo[];
}
declare interface CreateRoleAssignmentResponse {
/** 任务详情。 */
Tasks?: TaskInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateRoleConfigurationRequest {
/** 空间 ID。 */
ZoneId: string;
/** 权限配置名称。格式:包含英文字母、数字或短划线(-)。 长度:最大 128 个字符。 */
RoleConfigurationName: string;
/** 权限配置的描述。 长度:最大 1024 个字符。 */
Description?: string;
/** 会话持续时间。 CIC用户使用权限配置访问集团账号目标账号时,会话最多保持的时间。 单位:秒。 取值范围:900 ~ 43200(15 分钟~12 小时)。 默认值:3600(1 小时)。 */
SessionDuration?: number;
/** 初始访问页面。 CIC用户使用权限配置访问集团账号目标账号时,初始访问的页面地址。 该页面必须是腾讯云控制台页面。默认为空,表示跳转到腾讯云控制台首页。 */
RelayState?: string;
}
declare interface CreateRoleConfigurationResponse {
/** 配置访问详情 */
RoleConfigurationInfo?: RoleConfiguration;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateSCIMCredentialRequest {
/** 空间ID。z-前缀开头,后面是12位随机数字/小写字母 */
ZoneId: string;
/** 过期时间(秒),最小1小时,最大99年。如果不传则默认一年过期 */
ExpireDuration?: number;
}
declare interface CreateSCIMCredentialResponse {
/** 空间ID。z-前缀开头,后面是12位随机数字/小写字母。 */
ZoneId?: string;
/** SCIM密钥ID。scimcred-前缀开头,后面是12位随机数字/小写字母。 */
CredentialId?: string;
/** SCIM密钥类型。 */
CredentialType?: string;
/** SCIM 密钥的创建时间。 */
CreateTime?: string;
/** SCIM 密钥的过期时间。 */
ExpireTime?: string;
/** SCIM密钥状态,Enabled已开启,Disabled已关闭。 */
CredentialStatus?: string;
/** SCIM密钥。 */
CredentialSecret?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateUserRequest {
/** 空间 ID。 */
ZoneId: string;
/** 用户名称。空间内必须唯一。不支持修改。 格式:包含数字、英文字母和特殊符号+ = , . @ - _ 。 长度:最大 64 个字符 */
UserName: string;
/** 用户的姓。 长度:最大 64 个字符。 */
FirstName?: string;
/** 用户的名。 长度:最大 64 个字符。 */
LastName?: string;
/** 用户的显示名称。 长度:最大 256 个字符。 */
DisplayName?: string;
/** 用户的描述。 长度:最大 1024 个字符。 */
Description?: string;
/** 用户的电子邮箱。目录内必须唯一。 长度:最大 128 个字符。 */
Email?: string;
/** 用户的状态。取值: Enabled(默认值):启用。 Disabled:禁用。 */
UserStatus?: string;
/** 用户类型 Manual:手动创建,Synchronized:外部导入 */
UserType?: string;
}
declare interface CreateUserResponse {
/** 用户详情 */
UserInfo?: UserInfo;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateUserSyncProvisioningRequest {
/** 空间ID。 */
ZoneId: string;
/** CAM用户同步信息。 */
UserSyncProvisionings: UserSyncProvisioning[];
}
declare interface CreateUserSyncProvisioningResponse {
/** 任务详细。 */
Tasks?: UserProvisioningsTask[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteAccountRequest {
/** 成员Uin。 */
MemberUin: number;
}
declare interface DeleteAccountResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteGroupRequest {
/** 空间 ID。 */
ZoneId: string;
/** 用户组的 ID。 */
GroupId: string;
}
declare interface DeleteGroupResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteOrgServiceAssignRequest {
/** 委派管理员Uin。 */
MemberUin: number;
/** 集团服务ID。和集团服务产品标识二选一必填,可以通过[ListOrganizationService](https://cloud.tencent.com/document/product/850/109561)获取 */
ServiceId?: number;
/** 集团服务产品标识。和集团服务ID二选一必填,可以通过[ListOrganizationService](https://cloud.tencent.com/document/product/850/109561)获取 */
Product?: string;
}
declare interface DeleteOrgServiceAssignResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteOrganizationIdentityRequest {
/** 身份ID。可以通过[ListOrganizationIdentity](https://cloud.tencent.com/document/product/850/82934)获取 */
IdentityId: number;
}
declare interface DeleteOrganizationIdentityResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteOrganizationMemberAuthIdentityRequest {
/** 成员Uin。 */
MemberUin: number;
/** 身份ID。可以通过[ListOrganizationIdentity](https://cloud.tencent.com/document/product/850/82934)获取 */
IdentityId: number;
}
declare interface DeleteOrganizationMemberAuthIdentityResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteOrganizationMembersPolicyRequest {
/** 访问策略ID。可以通过[DescribeOrganizationMemberPolicies](https://cloud.tencent.com/document/product/850/82935)获取 */
PolicyId: number;
}
declare interface DeleteOrganizationMembersPolicyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteOrganizationMembersRequest {
/** 被删除成员的Uin列表。 */
MemberUin: number[];
}
declare interface DeleteOrganizationMembersResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteOrganizationNodesRequest {
/** 节点ID列表。可以通过[DescribeOrganizationNodes](https://cloud.tencent.com/document/product/850/82926)获取 */
NodeId: number[];
}
declare interface DeleteOrganizationNodesResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteOrganizationRequest {
}
declare interface DeleteOrganizationResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeletePolicyRequest {
/** 需要删除的策略ID。可以调用[ListPolicies](https://cloud.tencent.com/document/product/850/105311)获取 */
PolicyId: number;
/** 策略类型。默认值SERVICE_CONTROL_POLICY,取值范围:SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略 */
Type?: string;
}
declare interface DeletePolicyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteRoleAssignmentRequest {
/** 空间 ID。 */
ZoneId: string;
/** 权限配置ID。 */
RoleConfigurationId: string;
/** 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号 */
TargetType: string;
/** 集团账号目标账号的UIN */
TargetUin: number;
/** CAM 用户同步的身份类型。取值: User:表示同步的身份是用户。 Group:表示同步的身份是用户组。 */
PrincipalType: string;
/** 用户同步 ID。取值: 当PrincipalType取值为Group时,该值为用户组 ID(g-********), 当PrincipalType取值为User时,该值为用户 ID(u-********)。 */
PrincipalId: string;
/** 当您移除一个集团账号目标账号上使用某权限配置的最后一个授权时,是否同时解除权限配置部署。取值: DeprovisionForLastRoleAssignmentOnAccount:解除权限配置部署。 None(默认值):不解除权限配置部署。 */
DeprovisionStrategy?: string;
}
declare interface DeleteRoleAssignmentResponse {
/** 任务详情 */
Task?: TaskInfo;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteRoleConfigurationRequest {
/** 空间 ID */
ZoneId: string;
/** 权限配置 ID */
RoleConfigurationId: string;
}
declare interface DeleteRoleConfigurationResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteSCIMCredentialRequest {
/** 空间ID。z-前缀开头,后面是12位随机数字/小写字母 */
ZoneId: string;
/** SCIM密钥ID。scimcred-前缀开头,后面是12位随机数字/小写字母。 */
CredentialId: string;
}
declare interface DeleteSCIMCredentialResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteShareUnitMembersRequest {
/** 共享单元ID。 */
UnitId: string;
/** 共享单元地域。 */
Area: string;
/** 成员列表。 */
Members: ShareMember[];
}
declare interface DeleteShareUnitMembersResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteShareUnitRequest {
/** 共享单元ID。 */
UnitId: string;
}
declare interface DeleteShareUnitResourcesRequest {
/** 共享单元ID。 */
UnitId: string;
/** 共享单元地域。 */
Area: string;
/** 共享资源类型。支持共享的资源类型,请参见[资源共享概述](https://cloud.tencent.com/document/product/850/59489) */
Type: string;
/** 共享资源列表。最大10个。 */
Resources: ShareResource[];
}
declare interface DeleteShareUnitResourcesResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteShareUnitResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteUserRequest {
/** 空间 ID。 */
ZoneId: string;
/** 用户 ID。 */
UserId: string;
}
declare interface DeleteUserResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteUserSyncProvisioningRequest {
/** 空间ID。 */
ZoneId: string;
/** 用户同步的ID。 */
UserProvisioningId: string;
}
declare interface DeleteUserSyncProvisioningResponse {
/** 任务详情。 */
Tasks?: UserProvisioningsTask;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeEffectivePolicyRequest {
/** 账号uin或者节点id。 */
TargetId: number;
}
declare interface DescribeEffectivePolicyResponse {
/** 有效策略。 */
EffectivePolicy?: EffectivePolicy;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeIdentityCenterRequest {
}
declare interface DescribeIdentityCenterResponse {
/** 空间ID。z-前缀开头,后面是12位随机数字/小写字母 */
ZoneId?: string;
/** 空间名,必须全局唯一。包含小写字母、数字和短划线(-)。不能以短划线(-)开头或结尾,且不能有两个连续的短划线(-)。长度:2~64 个字符。 */
ZoneName?: string;
/** 服务开启状态,Disabled代表未开通,Enabled代表已开通 */
ServiceStatus?: string;
/** SCIM 同步状态。Enabled:启用。 Disabled:禁用。 */
ScimSyncStatus?: string;
/** 创建时间 */
CreateTime?: string;
/** 更新时间 */
UpdateTime?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeOrganizationAuthNodeRequest {
/** 偏移量。取值是limit的整数倍。默认值 : 0。 */
Offset: number;
/** 限制数目。取值范围:1~50。默认值:10。 */
Limit: number;
/** 互信主体名称。 */
AuthName?: string;
}
declare interface DescribeOrganizationAuthNodeResponse {
/** 总数。 */
Total?: number;
/** 条目详情。 */
Items?: AuthNode[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeOrganizationFinancialByMemberRequest {
/** 查询开始月份。格式:yyyy-mm,例如:2021-01。 */
Month: string;
/** 限制数目。取值范围:1~50,默认值:10 */
Limit?: number;
/** 偏移量。取值是limit的整数倍,默认值 : 0 */
Offset?: number;
/** 查询结束月份。格式:yyyy-mm,例如:2021-01,默认值为查询开始月份。 */
EndMonth?: string;
/** 查询成员列表。 最大100个 */
MemberUins?: number[];
/** 查询产品列表。 最大100个 */
ProductCodes?: string[];
}
declare interface DescribeOrganizationFinancialByMemberResponse {
/** 当月总消耗。 */
TotalCost?: number;
/** 成员消耗详情。 */
Items?: OrgMemberFinancial[];
/** 总数目。 */
Total?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeOrganizationFinancialByMonthRequest {
/** 查询月数。取值范围:1~6,默认值:6 */
Limit?: number;
/** 查询结束月份。格式:yyyy-mm,例如:2021-01 */
EndMonth?: string;
/** 查询成员列表。 最大100个 */
MemberUins?: number[];
/** 查询产品列表。 最大100个 */
ProductCodes?: string[];
}
declare interface DescribeOrganizationFinancialByMonthResponse {
/** 产品消耗详情。 */
Items?: OrgFinancialByMonth[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeOrganizationFinancialByProductRequest {
/** 查询开始月份。格式:yyyy-mm,例如:2021-01 */
Month: string;
/** 限制数目。取值范围:1~50,默认值:10 */
Limit?: number;
/** 偏移量。取值是limit的整数倍,默认值 : 0 */
Offset?: number;
/** 查询结束月份。格式:yyyy-mm,例如:2021-01,默认值为查询开始月份 */
EndMonth?: string;
/** 查询成员列表。 最大100个 */
MemberUins?: number[];
/** 查询产品列表。 最大100个 */
ProductCodes?: string[];
}
declare interface DescribeOrganizationFinancialByProductResponse {
/** 当月总消耗。 */
TotalCost?: number;
/** 产品消耗详情。 */
Items?: OrgProductFinancial[];
/** 总数目。 */
Total?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeOrganizationMemberAuthAccountsRequest {
/** 偏移量。取值是limit的整数倍。默认值 : 0。 */
Offset: number;
/** 限制数目。取值范围:1~50。默认值:10。 */
Limit: number;
/** 成员Uin。 */
MemberUin: number;
/** 策略ID。可以通过[DescribeOrganizationMemberPolicies](https://cloud.tencent.com/document/product/850/82935)获取 */
PolicyId: number;
}
declare interface DescribeOrganizationMemberAuthAccountsResponse {
/** 列表 */
Items?: OrgMemberAuthAccount[];
/** 总数目 */
Total?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeOrganizationMemberAuthIdentitiesRequest {
/** 偏移量。取值是limit的整数倍,默认值 : 0 */
Offset: number;
/** 限制数目。取值范围:1~50,默认值:10 */
Limit: number;
/** 组织成员Uin。入参MemberUin与IdentityId至少填写一个 */
MemberUin?: number;
/** 身份ID。入参MemberUin与IdentityId至少填写一个, 可以通过[ListOrganizationIdentity](https://cloud.tencent.com/document/product/850/82934)获取 */
IdentityId?: number;
}
declare interface DescribeOrganizationMemberAuthIdentitiesResponse {
/** 授权身份列表。 */
Items?: OrgMemberAuthIdentity[];
/** 总数目。 */
Total?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeOrganizationMemberEmailBindRequest {
/** 成员Uin。 */
MemberUin: number;
}
declare interface DescribeOrganizationMemberEmailBindResponse {
/** 绑定ID。 */
BindId?: number;
/** 申请时间。 */
ApplyTime?: string;
/** 邮箱地址。 */
Email?: string;
/** 安全手机号。 */
Phone?: string;
/** 绑定状态。 未绑定:Unbound,待激活:Valid,绑定成功:Success,绑定失败:Failed */
BindStatus?: string;
/** 绑定时间。 */
BindTime?: string;
/** 失败说明。 */
Description?: string;
/** 安全手机绑定状态 。 未绑定:0,已绑定:1 */
PhoneBind?: number;
/** 国际区号。 */
CountryCode?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeOrganizationMemberPoliciesRequest {
/** 偏移量。取值是limit的整数倍。默认值 : 0。 */
Offset: number;
/** 限制数目。取值范围:1~50。默认值:10。 */
Limit: number;
/** 成员Uin。 */
MemberUin: number;
/** 搜索关键字。可用于策略名或描述搜索 */
SearchKey?: string;
}
declare interface DescribeOrganizationMemberPoliciesResponse {
/** 列表。 */
Items?: OrgMemberPolicy[];
/** 总数目。 */
Total?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeOrganizationMembersAuthPolicyRequest {
/** 偏移量。取值是limit的整数倍。默认值 : 0。 */
Offset: number;
/** 限制数目。取值范围:1~50。默认值:10。 */
Limit: number;
/** 成员uin。 */
MemberUin?: number;
/** 集团管理员子账号uin。 */
OrgSubAccountUin?: number;
/** 成员访问策略Id。 */
PolicyId?: number;
}
declare interface DescribeOrganizationMembersAuthPolicyResponse {
/** 访问授权策略列表。 */
Items?: OrgMembersAuthPolicy[] | null;
/** 总数目。 */
Total?: number | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeOrganizationMembersRequest {
/** 偏移量。取值是limit的整数倍,默认值 : 0 */
Offset: number;
/** 限制数目。取值范围:1~50,默认值:10 */
Limit: number;
/** 国际站:en,国内站:zh */
Lang?: string;
/** 成员名称或者成员ID搜索。 */
SearchKey?: string;
/** 主体名称搜索。 */
AuthName?: string;
/** 可信服务产品简称。可信服务管理员查询时必须指定 */
Product?: string;
/** 成员标签搜索列表,最大10个 */
Tags?: Tag[];
/** 组织单元ID */
NodeId?: number;
/** 组织单元名称 */
NodeName?: string;
}
declare interface DescribeOrganizationMembersResponse {
/** 成员列表。 */
Items?: OrgMember[];
/** 总数目。 */
Total?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeOrganizationNodesRequest {
/** 限制数目。最大50 */
Limit: number;
/** 偏移量。取值是limit的整数倍。默认值 : 0。 */
Offset: number;
/** 部门标签搜索列表,最大10个 */
Tags?: Tag[];
}
declare interface DescribeOrganizationNodesResponse {
/** 总数。 */
Total?: number;
/** 列表详情。 */
Items?: OrgNode[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeOrganizationRequest {
/** 国际站:en,国内站:zh */
Lang?: string;
/** 可信服务产品简称。查询是否该可信服务管理员时必须指定 */
Product?: string;
}
declare interface DescribeOrganizationResponse {
/** 企业组织ID。 */
OrgId?: number;
/** 创建者UIN。 */
HostUin?: number;
/** 创建者昵称。 */
NickName?: string;
/** 企业组织类型。 */
OrgType?: number;
/** 是否组织管理员。是:true ,否:false */
IsManager?: boolean;
/** 策略类型。财务管理:Financial */
OrgPolicyType?: string;
/** 策略名。 */
OrgPolicyName?: string;
/** 成员财务权限列表。 */
OrgPermission?: OrgPermission[];
/** 组织根节点ID。 */
RootNodeId?: number;
/** 组织创建时间。 */
CreateTime?: string;
/** 成员加入时间。 */
JoinTime?: string;
/** 成员是否允许退出。允许:Allow,不允许:Denied */
IsAllowQuit?: string;
/** 代付者Uin。 */
PayUin?: string;
/** 代付者名称。 */
PayName?: string;
/** 是否可信服务管理员。是:true,否:false */
IsAssignManager?: boolean;
/** 是否实名主体管理员。是:true,否:false */
IsAuthManager?: boolean;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribePolicyConfigRequest {
/** 企业组织Id。可以调用[DescribeOrganization](https://cloud.tencent.com/document/product/850/67059)获取 */
OrganizationId: number;
/** 策略类型。默认值0,取值范围:0-服务控制策略、1-标签策略 */
Type?: number;
}
declare interface DescribePolicyConfigResponse {
/** 开启状态。0-未开启、1-开启 */
Status?: number;
/** 策略类型。SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略 */
Type?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribePolicyRequest {
/** 策略Id。可以调用[ListPolicies](https://cloud.tencent.com/document/product/850/105311)获取 */
PolicyId: number;
/** 策略类型。默认值SERVICE_CONTROL_POLICY,取值范围:SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略 */
PolicyType?: string;
}
declare interface DescribePolicyResponse {
/** 策略Id。 */
PolicyId?: number;
/** 策略名称。 */
PolicyName?: string;
/** 策略类型。1-自定义 2-预设策略 */
Type?: number;
/** 策略描述。 */
Description?: string;
/** 策略文档。 */
PolicyDocument?: string;
/** 策略更新时间。 */
UpdateTime?: string;
/** 策略创建时间。 */
AddTime?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeResourceToShareMemberRequest {
/** 共享地域。可通过接口[DescribeShareAreas](https://cloud.tencent.com/document/product/850/103050)获取支持共享的地域。 */
Area: string;
/** 偏移量。取值是limit的整数倍。默认值 : 0。 */
Offset: number;
/** 限制数目。取值范围:1~50。 */
Limit: number;
/** 搜索关键字,支持业务资源ID搜索。 */
SearchKey?: string;
/** 共享资源类型。支持共享的资源类型,请参见[资源共享概述](https://cloud.tencent.com/document/product/850/59489) */
Type?: string;
/** 业务资源ID。最大50个 */
ProductResourceIds?: string[];
}
declare interface DescribeResourceToShareMemberResponse {
/** 总数 */
Total?: number | null;
/** 详情 */
Items?: ShareResourceToMember[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeShareAreasRequest {
/** 国际站:en,国内站:zh */
Lang?: string;
}
declare interface DescribeShareAreasResponse {
/** 详情 */
Items?: ShareArea[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeShareUnitMembersRequest {
/** 共享单元ID。 */
UnitId: string;
/** 共享单元地域。 */
Area: string;
/** 偏移量。取值是limit的整数倍,默认值 : 0 */
Offset: number;
/** 限制数目。取值范围:1~50。 */
Limit: number;
/** 搜索关键字。支持成员Uin搜索。 */
SearchKey?: string;
}
declare interface DescribeShareUnitMe