tencentcloud-sdk-nodejs
Version:
2,498 lines (2,496 loc) • 164 kB
TypeScript
/**
* ListTasks请求参数结构体
*/
export interface ListTasksRequest {
/**
* 空间 ID。
*/
ZoneId: string;
/**
* 用户同步 ID。取值: 当PrincipalType取值为Group时,该值为用户组 ID(g-****), 当PrincipalType取值为User时,该值为用户 ID(u-****)。
*/
PrincipalId?: string;
/**
* 查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时,如果返回数据总条数超过MaxResults限制,数据会被截断,只返回MaxResults条数据,同时,返回参数IsTruncated为true,返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API,其他请求参数保持不变,查询被截断的数据。您可以按此方法多次查询,直到IsTruncated为false,表示全部数据查询完毕。
*/
NextToken?: string;
/**
* 每页的最大数据条数。 取值范围:1~100。 默认值:10。
*/
MaxResults?: number;
/**
* CAM 用户同步的身份类型。取值: User:表示同步的身份是用户。 Group:表示同步的身份是用户组。
*/
PrincipalType?: string;
/**
* 同步的集团账号目标账号的UIN。
*/
TargetUin?: number;
/**
* 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号
*/
TargetType?: string;
/**
* 权限配置ID。
*/
RoleConfigurationId?: string;
/**
* InProgress:任务执行中。 Success:任务执行成功。 Failed:任务执行失败。
*/
Status?: string;
/**
* 任务类型。
*/
TaskType?: string;
}
/**
* ListRoleConfigurations请求参数结构体
*/
export interface ListRoleConfigurationsRequest {
/**
* 空间 ID。
*/
ZoneId: string;
/**
* 查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时,如果返回数据总条数超过MaxResults限制,数据会被截断,只返回MaxResults条数据,同时,返回参数IsTruncated为true,返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API,其他请求参数保持不变,查询被截断的数据。您可以按此方法多次查询,直到IsTruncated为false,表示全部数据查询完毕。
*/
NextToken?: string;
/**
* 每页的最大数据条数。 取值范围:1~100。 默认值:10。
*/
MaxResults?: number;
/**
* 过滤文本。不区分大小写。目前,支持 RoleConfigurationName和Description. 示例:Filter = "test",表示查询名称或描述里包含 test 的权限配置。
*/
Filter?: string;
/**
* 检索成员账号是否配置过权限,如果配置过返回IsSelected: true, 否则返回false。
*/
FilterTargets?: Array<number | bigint>;
/**
* 授权的用户UserId或者用户组的GroupId,必须和入参数FilterTargets一起设置
*/
PrincipalId?: string;
}
/**
* DeleteSCIMCredential请求参数结构体
*/
export interface DeleteSCIMCredentialRequest {
/**
* 空间ID。z-前缀开头,后面是12位随机数字/小写字母
*/
ZoneId: string;
/**
* SCIM密钥ID。scimcred-前缀开头,后面是12位随机数字/小写字母。
*/
CredentialId: string;
}
/**
* ListGroupMembers返回参数结构体
*/
export interface ListGroupMembersResponse {
/**
* 查询返回结果下一页的令牌。 说明 只有IsTruncated为true时,才显示该参数。
*/
NextToken?: string;
/**
* 符合请求参数条件的数据总条数。
*/
TotalCounts?: number;
/**
* 每页的最大数据条数。
*/
MaxResults?: number;
/**
* 返回结果是否被截断。取值: true:已截断。 false:未截断。
*/
IsTruncated?: boolean;
/**
* 用户组的用户列表
*/
GroupMembers?: Array<GroupMembers>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SetExternalSAMLIdentityProvider请求参数结构体
*/
export interface SetExternalSAMLIdentityProviderRequest {
/**
* 空间ID。
*/
ZoneId: string;
/**
* IdP 元数据文档(Base64 编码)。 由支持 SAML 2.0 协议的 IdP 提供。
*/
EncodedMetadataDocument?: string;
/**
* SSO 登录的启用状态。取值: Enabled:启用。 Disabled(默认值):禁用。
*/
SSOStatus?: string;
/**
* IdP 标识。
*/
EntityId?: string;
/**
* IdP 的登录地址。
*/
LoginUrl?: string;
/**
* PEM 格式的 X509 证书。指定该参数会替换所有已经存在的证书。
*/
X509Certificate?: string;
}
/**
* ListGroupMembers请求参数结构体
*/
export interface ListGroupMembersRequest {
/**
* 空间 ID。
*/
ZoneId: string;
/**
* 用户组ID。
*/
GroupId: string;
/**
* 查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时,如果返回数据总条数超过MaxResults限制,数据会被截断,只返回MaxResults条数据,同时,返回参数IsTruncated为true,返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API,其他请求参数保持不变,查询被截断的数据。您可以按此方法多次查询,直到IsTruncated为false,表示全部数据查询完毕。
*/
NextToken?: string;
/**
* 每页的最大数据条数。 取值范围:1~100。 默认值:10。
*/
MaxResults?: number;
/**
* 用户类型 Manual:手动创建,Synchronized:外部导入。
*/
UserType?: string;
}
/**
* 权限配置同步
*/
export 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;
}
/**
* UpdatePolicy请求参数结构体
*/
export interface UpdatePolicyRequest {
/**
* 需要编辑的策略ID。可以调用[ListPolicies](https://cloud.tencent.com/document/product/850/105311)获取
*/
PolicyId: number;
/**
* 策略描述。
*/
Description?: string;
/**
* 策略内容。参考CAM策略语法
*/
Content?: string;
/**
* 策略名。长度为1~128个字符,可以包含汉字、英文字母、数字和下划线(_)
*/
Name?: string;
/**
* 策略类型。默认值SERVICE_CONTROL_POLICY,取值范围:SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略
*/
Type?: string;
}
/**
* DescribeShareUnitResources返回参数结构体
*/
export interface DescribeShareUnitResourcesResponse {
/**
* 总数目。
*/
Total?: number;
/**
* 共享单元资源列表。
*/
Items?: Array<ShareUnitResource>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CIC权限配置
*/
export interface RoleConfiguration {
/**
* 权限配置配置ID。
*/
RoleConfigurationId?: string;
/**
* 权限配置配名称。
*/
RoleConfigurationName?: string;
/**
* 权限配置的描述。
*/
Description?: string;
/**
* 会话持续时间。CIC 用户使用访问配置访问成员账号时,会话最多保持的时间。
单位:秒。
*/
SessionDuration?: number;
/**
* 初始访问页面。CIC 用户使用访问配置访问成员账号时,初始访问的页面地址。
*/
RelayState?: string;
/**
* 权限配置的创建时间。
*/
CreateTime?: string;
/**
* 权限配置的更新时间。
*/
UpdateTime?: string;
/**
* 如果有入参FilterTargets查询成员账号是否配置过权限,配置了返回true,否则返回false。
*/
IsSelected?: boolean;
}
/**
* DescribeOrganizationMemberEmailBind返回参数结构体
*/
export 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)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* EnablePolicyType返回参数结构体
*/
export interface EnablePolicyTypeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListTargetsForPolicy返回参数结构体
*/
export interface ListTargetsForPolicyResponse {
/**
* 总数。
*/
TotalNum?: number;
/**
* 指定SCP策略关联目标列表。
*/
List?: Array<ListTargetsForPolicyNode>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteUser请求参数结构体
*/
export interface DeleteUserRequest {
/**
* 空间 ID。
*/
ZoneId: string;
/**
* 用户 ID。
*/
UserId: string;
}
/**
* 同步部署角色任务状态信息。
*/
export interface RoleProvisioningsTask {
/**
* 任务ID。
*/
TaskId?: string;
/**
* 权限配置ID。
*/
RoleConfigurationId?: string;
/**
* 权限配置名称。
*/
RoleConfigurationName?: string;
/**
* 授权的集团账号目标账号的UIN
*/
TargetUin?: number;
/**
* 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号
注意:此字段可能返回 null,表示取不到有效值。
*/
TargetType?: string;
/**
* 任务类型。
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskType?: string;
/**
* 任务状态:InProgress: 进行中,Failed: 失败 3:Success: 成功
注意:此字段可能返回 null,表示取不到有效值。
*/
TaskStatus?: string;
}
/**
* ProvisionRoleConfiguration请求参数结构体
*/
export interface ProvisionRoleConfigurationRequest {
/**
* 空间 ID。
*/
ZoneId: string;
/**
* 权限配置ID。
*/
RoleConfigurationId: string;
/**
* 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号。
*/
TargetType: string;
/**
* 集团账号目标账号的UIN。
*/
TargetUin: number;
}
/**
* ListNonCompliantResource返回参数结构体
*/
export interface ListNonCompliantResourceResponse {
/**
* 资源及标签合规信息。
*/
Items?: Array<ResourceTagMapping>;
/**
* 获取的下一页的Token值。
*/
PaginationToken?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteUser返回参数结构体
*/
export interface DeleteUserResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateZone返回参数结构体
*/
export interface UpdateZoneResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteOrganization请求参数结构体
*/
export declare type DeleteOrganizationRequest = null;
/**
* 标签合规信息
*/
export interface TagComplianceDetails {
/**
* 合规状态。true-合规,false-不合规
*/
ComplianceStatus?: boolean;
/**
* 值不合规的标签键列表。
*/
KeysWithNonCompliantValues?: Array<string>;
/**
* 键不合规的标签键列表。
*/
NonCompliantKeys?: Array<string>;
}
/**
* RejectJoinShareUnitInvitation请求参数结构体
*/
export interface RejectJoinShareUnitInvitationRequest {
/**
* 共享单元ID。
*/
UnitId: string;
}
/**
* DescribeIdentityCenter返回参数结构体
*/
export 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)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePolicyConfig返回参数结构体
*/
export interface DescribePolicyConfigResponse {
/**
* 开启状态。0-未开启、1-开启
*/
Status?: number;
/**
* 策略类型。SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略
*/
Type?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetExternalSAMLIdentityProvider返回参数结构体
*/
export interface GetExternalSAMLIdentityProviderResponse {
/**
* saml 身份提供商配置信息。
*/
SAMLIdentityProviderConfiguration?: SAMLIdentityProviderConfiguration;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListOrganizationIdentity请求参数结构体
*/
export interface ListOrganizationIdentityRequest {
/**
* 偏移量。取值是limit的整数倍。默认值 : 0。
*/
Offset: number;
/**
* 限制数目。取值范围:1~50。默认值:10。
*/
Limit: number;
/**
* 名称搜索关键字。
*/
SearchKey?: string;
/**
* 身份ID。可以通过身份ID搜索
*/
IdentityId?: number;
/**
* 身份类型。取值范围 1-预设, 2-自定义
*/
IdentityType?: number;
}
/**
* DeleteOrganizationMembers请求参数结构体
*/
export interface DeleteOrganizationMembersRequest {
/**
* 被删除成员的Uin列表。
*/
MemberUin: Array<number | bigint>;
}
/**
* CreateOrganization返回参数结构体
*/
export interface CreateOrganizationResponse {
/**
* 企业组织ID
*/
OrgId?: number;
/**
* 创建者昵称
*/
NickName?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddShareUnitResources返回参数结构体
*/
export interface AddShareUnitResourcesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 组织身份策略
*/
export interface IdentityPolicy {
/**
* CAM预设策略ID。PolicyType 为预设策略时有效且必选
*/
PolicyId?: number;
/**
* CAM预设策略名称。PolicyType 为预设策略时有效且必选
*/
PolicyName?: string;
/**
* 策略类型。取值 1-自定义策略 2-预设策略;默认值2
*/
PolicyType?: number;
/**
* 自定义策略内容,遵循CAM策略语法。PolicyType 为自定义策略时有效且必选
*/
PolicyDocument?: string;
}
/**
* AddOrganizationNode返回参数结构体
*/
export interface AddOrganizationNodeResponse {
/**
* 节点ID。
*/
NodeId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeOrganizationFinancialByMonth返回参数结构体
*/
export interface DescribeOrganizationFinancialByMonthResponse {
/**
* 产品消耗详情。
*/
Items?: Array<OrgFinancialByMonth>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListPermissionPoliciesInRoleConfiguration返回参数结构体
*/
export interface ListPermissionPoliciesInRoleConfigurationResponse {
/**
* 权限策略总个数。
*/
TotalCounts?: number;
/**
* 权限策略列表。
*/
RolePolicies?: Array<RolePolicie>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 按月获取组织财务信息
*/
export interface OrgFinancialByMonth {
/**
* 记录ID。
*/
Id?: number;
/**
* 月份,格式:yyyy-mm,示例:2021-01。
*/
Month?: string;
/**
* 消耗金额,单元:元。
*/
TotalCost?: number;
/**
* 比上月增长率%。正数增长,负数下降,空值无法统计。
*/
GrowthRate?: string;
}
/**
* MoveOrganizationNodeMembers返回参数结构体
*/
export interface MoveOrganizationNodeMembersResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AttachPolicy请求参数结构体
*/
export interface AttachPolicyRequest {
/**
* 绑定策略目标ID。成员Uin或部门ID
*/
TargetId: number;
/**
* 目标类型。取值范围:NODE-部门、MEMBER-成员
*/
TargetType: string;
/**
* 策略ID。
*/
PolicyId: number;
/**
* 策略类型。默认值SERVICE_CONTROL_POLICY,取值范围:SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略
*/
Type?: string;
}
/**
* DeleteShareUnit返回参数结构体
*/
export interface DeleteShareUnitResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateShareUnit请求参数结构体
*/
export interface UpdateShareUnitRequest {
/**
* 共享单元ID。
*/
UnitId: string;
/**
* 共享单元名称。仅支持大小写字母、数字、-、以及_的组合,3-128个字符。
*/
Name?: string;
/**
* 共享单元描述。最大128个字符。
*/
Description?: string;
/**
* 共享范围。取值:1-仅允许集团组织内共享 2-允许共享给任意账号,默认值:1
*/
ShareScope?: number;
}
/**
* RemoveExternalSAMLIdPCertificate返回参数结构体
*/
export interface RemoveExternalSAMLIdPCertificateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateGroup请求参数结构体
*/
export interface CreateGroupRequest {
/**
* 空间 ID。
*/
ZoneId: string;
/**
* 用户组的名称。 格式:允许英文字母、数字和特殊字符-。 长度:最大 128 个字符。
*/
GroupName: string;
/**
* 用户组的描述。 长度:最大 1024 个字符。
*/
Description?: string;
/**
* 用户组类型 Manual:手动创建,Synchronized:外部导入
*/
GroupType?: string;
}
/**
* ListUsers返回参数结构体
*/
export interface ListUsersResponse {
/**
* 符合请求参数条件的数据总条数。
*/
TotalCounts?: number;
/**
* 每页的最大数据条数。
*/
MaxResults?: number;
/**
* 用户列表。
*/
Users?: Array<UserInfo>;
/**
* 查询返回结果下一页的令牌。只有IsTruncated为true时,才显示该参数。
*/
NextToken?: string;
/**
* 返回结果是否被截断。取值: true:已截断。 false:未截断。
*/
IsTruncated?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteRoleConfiguration请求参数结构体
*/
export interface DeleteRoleConfigurationRequest {
/**
* 空间 ID
*/
ZoneId: string;
/**
* 权限配置 ID
*/
RoleConfigurationId: string;
}
/**
* CreateOrganizationIdentity请求参数结构体
*/
export interface CreateOrganizationIdentityRequest {
/**
* 身份名称
*/
IdentityAliasName: string;
/**
* 身份策略
*/
IdentityPolicy: Array<IdentityPolicy>;
/**
* 身份描述
*/
Description?: string;
}
/**
* ListOrganizationService返回参数结构体
*/
export interface ListOrganizationServiceResponse {
/**
* 总数。
*/
Total?: number;
/**
* 集团服务列表。
*/
Items?: Array<OrganizationServiceAssign>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteUserSyncProvisioning返回参数结构体
*/
export interface DeleteUserSyncProvisioningResponse {
/**
* 任务详情。
*/
Tasks?: UserProvisioningsTask;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ProvisionRoleConfiguration返回参数结构体
*/
export interface ProvisionRoleConfigurationResponse {
/**
* 任务详情。
*/
Task?: RoleProvisioningsTask;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListUserSyncProvisionings返回参数结构体
*/
export interface ListUserSyncProvisioningsResponse {
/**
* 查询返回结果下一页的令牌。 说明 只有IsTruncated为true时,才显示该参数。
*/
NextToken?: string;
/**
* 符合请求参数条件的数据总条数。
*/
TotalCounts?: number;
/**
* 每页的最大数据条数。
*/
MaxResults?: number;
/**
* 返回结果是否被截断。取值: true:已截断。 false:未截断。
*/
IsTruncated?: boolean;
/**
* CAM同步的用户列表。
*/
UserProvisionings?: Array<UserProvisioning>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeletePolicy返回参数结构体
*/
export interface DeletePolicyResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeOrganization返回参数结构体
*/
export interface DescribeOrganizationResponse {
/**
* 企业组织ID。
*/
OrgId?: number;
/**
* 创建者UIN。
*/
HostUin?: number;
/**
* 创建者昵称。
*/
NickName?: string;
/**
* 企业组织类型。
*/
OrgType?: number;
/**
* 是否组织管理员。是:true ,否:false
*/
IsManager?: boolean;
/**
* 策略类型。财务管理:Financial
*/
OrgPolicyType?: string;
/**
* 策略名。
*/
OrgPolicyName?: string;
/**
* 成员财务权限列表。
*/
OrgPermission?: Array<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)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListNonCompliantResource请求参数结构体
*/
export interface ListNonCompliantResourceRequest {
/**
* 限制数目。取值范围:1~50。
*/
MaxResults: number;
/**
* 成员Uin。
*/
MemberUin: number;
/**
* 从上一页的响应中获取的下一页的Token值。
如果是第一次请求,设置为空。
*/
PaginationToken?: string;
/**
* 标签键。
*/
TagKey?: string;
}
/**
* DisablePolicyType返回参数结构体
*/
export interface DisablePolicyTypeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeOrganizationMemberPolicies请求参数结构体
*/
export interface DescribeOrganizationMemberPoliciesRequest {
/**
* 偏移量。取值是limit的整数倍。默认值 : 0。
*/
Offset: number;
/**
* 限制数目。取值范围:1~50。默认值:10。
*/
Limit: number;
/**
* 成员Uin。
*/
MemberUin: number;
/**
* 搜索关键字。可用于策略名或描述搜索
*/
SearchKey?: string;
}
/**
* DescribeEffectivePolicy请求参数结构体
*/
export interface DescribeEffectivePolicyRequest {
/**
* 账号uin或者节点id。
*/
TargetId: number;
}
/**
* CreateOrgServiceAssign请求参数结构体
*/
export interface CreateOrgServiceAssignRequest {
/**
* 委派管理员Uin列表。 最大长度20个
*/
MemberUins: Array<number | bigint>;
/**
* 集团服务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?: Array<number | bigint>;
/**
* 管理的部门ID列表。ManagementScope为2时该参数有效
*/
ManagementScopeNodeIds?: Array<number | bigint>;
}
/**
* 任务状态信息。
*/
export interface TaskStatus {
/**
* 任务状态。取值: InProgress:任务执行中。 Success:任务执行成功。 Failed:任务执行失败。
*/
Status?: string;
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务类型。取值:
ProvisionRoleConfiguration:部署权限配置。
DeprovisionRoleConfiguration:解除权限配置部署。
CreateRoleAssignment:在成员 账号上授权。
DeleteRoleAssignment:移除 成员 账号上的授权。
*/
TaskType?: string;
/**
* 任务失败原因。
说明
只有Status为Failed,才会显示该参数。
*/
FailureReason?: string;
}
/**
* DeleteOrganizationMembersPolicy返回参数结构体
*/
export interface DeleteOrganizationMembersPolicyResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DismantleRoleConfiguration返回参数结构体
*/
export interface DismantleRoleConfigurationResponse {
/**
* 任务详情。
*/
Task?: RoleProvisioningsTask;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ClearExternalSAMLIdentityProvider请求参数结构体
*/
export interface ClearExternalSAMLIdentityProviderRequest {
/**
* 空间ID。
*/
ZoneId: string;
}
/**
* CreateUserSyncProvisioning返回参数结构体
*/
export interface CreateUserSyncProvisioningResponse {
/**
* 任务详细。
*/
Tasks?: Array<UserProvisioningsTask>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListUserSyncProvisionings请求参数结构体
*/
export interface ListUserSyncProvisioningsRequest {
/**
* 空间 ID。
*/
ZoneId: string;
/**
* 用户同步 ID。取值: 当PrincipalType取值为Group时,该值为用户组 ID(g-********)。 当PrincipalType取值为User时,该值为用户 ID(u-********)。
*/
PrincipalId?: string;
/**
* 查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时,如果返回数据总条数超过MaxResults限制,数据会被截断,只返回MaxResults条数据,同时,返回参数IsTruncated为true,返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API,其他请求参数保持不变,查询被截断的数据。您可以按此方法多次查询,直到IsTruncated为false,表示全部数据查询完毕。
*/
NextToken?: string;
/**
* 每页的最大数据条数。 取值范围:1~100。 默认值:10。
*/
MaxResults?: number;
/**
* CAM 用户同步的身份类型。取值: User:表示同步的身份是用户。 Group:表示同步的身份是用户组。
*/
PrincipalType?: string;
/**
* 集团账号目标账号的UIN。
*/
TargetUin?: number;
/**
* 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号
*/
TargetType?: string;
/**
* 检测条件。
*/
Filter?: string;
}
/**
* 共享单元成员
*/
export interface ShareUnitMember {
/**
* 共享成员Uin。
*/
ShareMemberUin?: number;
/**
* 创建时间。
*/
CreateTime?: string;
}
/**
* UpdateUserSyncProvisioning请求参数结构体
*/
export interface UpdateUserSyncProvisioningRequest {
/**
* 空间ID。
*/
ZoneId: string;
/**
* 用户同步的iD
*/
UserProvisioningId: string;
/**
* 用户同步描述。
*/
NewDescription?: string;
/**
* 冲突策略。当CIC 用户同步到 CAM 时,如果 CAM 中存在同名用户时的处理策略。取值: KeepBoth:两者都保留。当CIC 用户被同步到 CAM 时,如果 CAM 已经存在同名用户,则对CIC 用户的用户名添加后缀_cic后尝试创建该用户名的 CAM 用户。 TakeOver:替换。当CIC 用户被同步到 CAM 时,如果 CAM 已经存在同名用户,则直接将已经存在的 CAM 用户替换为CIC 同步用户。
*/
NewDuplicationStateful?: string;
/**
* 删除策略。删除 CAM 用户同步时,对已同步的 CAM 用户的处理策略。取值: Delete:删除。删除 CAM 用户同步时,会删除从CIC 已经同步到 CAM 中的 CAM 用户。 Keep:保留。删除 RAM 用户同步时,会保留从CIC 已经同步到 CAM 中的 CAM 用户。
*/
NewDeletionStrategy?: string;
}
/**
* ListRoleAssignments请求参数结构体
*/
export interface ListRoleAssignmentsRequest {
/**
* 空间 ID。
*/
ZoneId: string;
/**
* 权限配置ID。
*/
RoleConfigurationId?: string;
/**
* 每页的最大数据条数。 取值范围:1~100。 默认值:10。
*/
MaxResults?: number;
/**
* 查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时,如果返回数据总条数超过MaxResults限制,数据会被截断,只返回MaxResults条数据,同时,返回参数IsTruncated为true,返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API,其他请求参数保持不变,查询被截断的数据。您可以按此方法多次查询,直到IsTruncated为false,表示全部数据查询完毕。
*/
NextToken?: string;
/**
* 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号
*/
TargetType?: string;
/**
* 同步的集团账号目标账号的UIN。
*/
TargetUin?: number;
/**
* CAM 用户同步的身份类型。取值: User:表示同步的身份是用户。 Group:表示同步的身份是用户组。
*/
PrincipalType?: string;
/**
* 用户同步 ID。取值: 当PrincipalType取值为Group时,该值为用户组 ID(g-****),当PrincipalType取值为User时,该值为用户 ID (u-****)。
*/
PrincipalId?: string;
/**
* 查询条件,目前只支持权限配置名称查询。
*/
Filter?: string;
}
/**
* CancelOrganizationMemberAuthAccount请求参数结构体
*/
export interface CancelOrganizationMemberAuthAccountRequest {
/**
* 成员Uin。
*/
MemberUin: number;
/**
* 策略ID。可以通过[DescribeOrganizationMemberPolicies](https://cloud.tencent.com/document/product/850/82935)获取
*/
PolicyId: number;
/**
* 组织子账号Uin。
*/
OrgSubAccountUin: number;
}
/**
* UpdateUser请求参数结构体
*/
export interface UpdateUserRequest {
/**
* 空间 ID。
*/
ZoneId: string;
/**
* 用户 ID。
*/
UserId: string;
/**
* 用户的名。
*/
NewFirstName?: string;
/**
* 用户的姓。
*/
NewLastName?: string;
/**
* 用户的显示名称。
*/
NewDisplayName?: string;
/**
* 用户的描述。
*/
NewDescription?: string;
/**
* 用户的电子邮箱。
*/
NewEmail?: string;
}
/**
* GetGroup请求参数结构体
*/
export interface GetGroupRequest {
/**
* 空间 ID。
*/
ZoneId: string;
/**
* 用户组的 ID。
*/
GroupId: string;
}
/**
* 集团服务设置
*/
export 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;
}
/**
* DeleteOrganization返回参数结构体
*/
export interface DeleteOrganizationResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DismantleRoleConfiguration请求参数结构体
*/
export interface DismantleRoleConfigurationRequest {
/**
* 空间 ID。
*/
ZoneId: string;
/**
* 权限配置ID。
*/
RoleConfigurationId: string;
/**
* 同步的集团账号目标账号的类型,ManagerUin管理账号;MemberUin成员账号。
*/
TargetType: string;
/**
* 同步的集团账号目标账号的UIN。
*/
TargetUin: number;
}
/**
* UpdateCustomPolicyForRoleConfiguration返回参数结构体
*/
export interface UpdateCustomPolicyForRoleConfigurationResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeShareUnitMembers返回参数结构体
*/
export interface DescribeShareUnitMembersResponse {
/**
* 总数目。
*/
Total?: number;
/**
* 共享单元成员列表。
*/
Items?: Array<ShareUnitMember>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 成员主要信息
*/
export interface MemberMainInfo {
/**
* 成员uin
*/
MemberUin?: number;
/**
* 成员名称
*/
MemberName?: string;
}
/**
* CreateRoleAssignment请求参数结构体
*/
export interface CreateRoleAssignmentRequest {
/**
* 空间 ID。
*/
ZoneId: string;
/**
* 授权成员账号信息,最多授权50条。
*/
RoleAssignmentInfo?: Array<RoleAssignmentInfo>;
}
/**
* DeleteShareUnitResources请求参数结构体
*/
export interface DeleteShareUnitResourcesRequest {
/**
* 共享单元ID。
*/
UnitId: string;
/**
* 共享单元地域。
*/
Area: string;
/**
* 共享资源类型。支持共享的资源类型,请参见[资源共享概述](https://cloud.tencent.com/document/product/850/59489)
*/
Type: string;
/**
* 共享资源列表。最大10个。
*/
Resources: Array<ShareResource>;
}
/**
* 成员管理身份
*/
export interface MemberIdentity {
/**
* 身份ID。
*/
IdentityId?: number;
/**
* 身份名称。
*/
IdentityAliasName?: string;
}
/**
* RejectJoinShareUnitInvitation返回参数结构体
*/
export interface RejectJoinShareUnitInvitationResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateShareUnit返回参数结构体
*/
export interface UpdateShareUnitResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListRoleAssignments返回参数结构体
*/
export interface ListRoleAssignmentsResponse {
/**
* 查询返回结果下一页的令牌。 说明 只有IsTruncated为true时,才显示该参数。
*/
NextToken?: string;
/**
* 符合请求参数条件的数据总条数。
*/
TotalCounts?: number;
/**
* 每页的最大数据条数。
*/
MaxResults?: number;
/**
* 返回结果是否被截断。取值: true:已截断。 false:未截断。
*/
IsTruncated?: boolean;
/**
* 集团账号目标账号的授权列表。
*/
RoleAssignments?: Array<RoleAssignments>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateUser返回参数结构体
*/
export interface UpdateUserResponse {
/**
* 用户信息
*/
UserInfo?: UserInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RemoveUserFromGroup请求参数结构体
*/
export interface RemoveUserFromGroupRequest {
/**
* 空间ID。
*/
ZoneId: string;
/**
* 用户组ID。
*/
GroupId: string;
/**
* 用户ID。
*/
UserId: string;
}
/**
* AddPermissionPolicyToRoleConfiguration请求参数结构体
*/
export interface AddPermissionPolicyToRoleConfigurationRequest {
/**
* 空间 ID
*/
ZoneId: string;
/**
* 权限配置 ID
*/
RoleConfigurationId: string;
/**
* 权限策略类型。取值: System:系统策略。复用 CAM 的系统策略。 Custom: 自定义策略。按照 CAM 权限策略语法和结构编写的自定义策略。
*/
RolePolicyType: string;
/**
* 权限策略名称,长度最大为 20策略,每个策略长度最大32个字符。如果要添加系统策略,建议使用RolePolicies参数。自定义策略时,数组长度最大为1。
*/
RolePolicyNames?: Array<string>;
/**
* 添加的系统策略详情。
*/
RolePolicies?: Array<PolicyDetail>;
/**
* 自定义策略内容。长度:最大 4096 个字符。当RolePolicyType为Inline时,该参数必须配置。关于权限策略的语法和结构,请参见权限策略语法和结构。
*/
CustomPolicyDocument?: string;
/**
* 自定义策略内容列表(跟RolePolicyNames一一对应)
*/
CustomPolicyDocuments?: Array<string>;
}
/**
* DescribeOrganizationAuthNode返回参数结构体
*/
export interface DescribeOrganizationAuthNodeResponse {
/**
* 总数。
*/
Total?: number;
/**
* 条目详情。
*/
Items?: Array<AuthNode>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 关系策略权限
*/
export interface OrgPermission {
/**
* 权限Id
*/
Id: number;
/**
* 权限名
*/
Name: string;
}
/**
* ListPolicies返回参数结构体
*/
export interface ListPoliciesResponse {
/**
* 策略总数
*/
TotalNum?: number;
/**
* 策略列表数据
*/
List?: Array<ListPolicyNode>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* BindOrganizationMemberAuthAccount请求参数结构体
*/
export interface BindOrganizationMemberAuthAccountRequest {
/**
* 成员Uin。
*/
MemberUin: number;
/**
* 策略ID。可以调用[DescribeOrganizationMemberPolicies](https://cloud.tencent.com/document/product/850/82935)获取
*/
PolicyId: number;
/**
* 组织管理员子账号Uin列表。最大5个
*/
OrgSubAccountUins: Array<number | bigint>;
}
/**
* DescribeShareUnits返回参数结构体
*/
export interface DescribeShareUnitsResponse {
/**
* 总数目。
*/
Total?: number;
/**
* 共享单元列表。
*/
Items?: Array<ManagerShareUnit>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateOrganizationMemberEmailBind返回参数结构体
*/
export interface UpdateOrganizationMemberEmailBindResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetZoneSAMLServiceProviderInfo返回参数结构体
*/
export interface GetZoneSAMLServiceProviderInfoResponse {
/**
* saml服务提供商配置信息
*/
SAMLServiceProvider?: SAMLServiceProvider;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteOrganizationMembers返回参数结构体
*/
export interface DeleteOrganizationMembersResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 我的共享单元列表详情
*/
export 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;
}
/**
* UpdateSCIMCredentialStatus返回参数结构体
*/
export interface UpdateSCIMCredentialStatusResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateOrganizationMembersPolicy请求参数结构体
*/
export interface UpdateOrganizationMembersPolicyRequest {
/**
* 成员Uin列表。最多10个
*/
MemberUins: Array<number | bigint>;
/**
* 成员访问策略Id。可通过DescribeOrganizationMemberPolicies获取
*/
PolicyId: number;
/**
* 成员访问身份ID。可通过ListOrganizationIdentity获取
*/
IdentityId: number;
/**
* 策略描述。最大长度为128个字符
*/
Description?: string;
}
/**
* 共享单元资源
*/
export interface ShareUnitResource {
/**
* 共享资源ID。
*/
ResourceId?: string;
/**
* 共享资源类型。
*/
Type?: string;
/**
* 创建时间。
*/
CreateTime?: string;
/**
* 产品资源ID。
*/
ProductResourceId?: string;
/**
* 共享单元成员数。
*/
SharedMemberNum?: number;
/**
* 使用中共享单元成员数。
*/
SharedMemberUseNum?: number;
/**
* 共享管理员OwnerUin。
*/
ShareManagerUin?: number;
}
/**
* DescribeOrganizationMemberAuthIdentities请求参数结构体
*/
export 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;
}
/**
* CreateOrganizationMemberAuthIdentity返回参数结构体
*/
export interface CreateOrganizationMemberAuthIdentityResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteOrgServiceAssign请求参数结构体
*/
export 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;
}
/**
* DescribeOrganization请求参数结构体
*/
export interface DescribeOrganizationRequest {
/**
* 国际站:en,国内站:zh
*/
Lang?: string;
/**
* 可信服务产品简称。查询是否该可信服务管理员时必须指定
*/
Product?: string;
}
/**
* ListPermissionPoliciesInRoleConfiguration请求参数结构体
*/
export interface ListPermissionPoliciesInRoleConfigurationRequest {
/**
* 空间 ID
*/
ZoneId: string;
/**
* 权限配置 ID
*/
RoleConfigurationId: string;
/**
* 权限策略类型。取值: System:系统策略。复用 CAM 的系统策略。 Custom: 自定义策略。按照 CAM 权限策略语法和结构编写的自定义策略。
*/
RolePolicyType?: string;
/**
* 按策略名称搜索
*/
Filter?: string;
}
/**
* ClearExternalSAMLIdentityProvider返回参数结构体
*/
export interface ClearExternalSAMLIdentityProviderResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddExternalSAMLIdPCertificate返回参数结构体
*/
export interface AddExternalSAMLIdPCertificateResponse {
/**
* SAML 签名证书 ID。
*/
CertificateId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateOrganizationMember返回参数结构体
*/
export interface CreateOrganizationMemberResponse {
/**
* 成员Uin。
*/
Uin?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 成员账号的授权详情
*/
export 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;
}
/**
* MoveOrganizationNodeMembers请求参数结构体
*/
export interface MoveOrganizationNodeMembersRequest {
/**
* 组织节点ID。可以通过[DescribeOrganizationNodes](https://cloud.tencent.com/document/product/850/82926)获取
*/
NodeId: number;
/**
* 成员Uin列表。
*/
MemberUin: Array<number | bigint>;
}
/**
* GetTaskStatus返回参数结构体
*/
export interface GetTaskStatusResponse {
/**
* 任务状态信息。
*/
TaskStatus?: TaskStatus;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CAM用户同步信息
*/
export 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;
}
/**
* UpdateOrganizationMember返回参数结构体
*/
export interface UpdateOrganizationMemberResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 互信主体主要信息
*/
export interface AuthNode {
/**
* 互信主体关系ID
*/
RelationId?: number;
/**
* 互信主体名称
*/
AuthName?: string;
/**
* 主体管理员
*/
Manager?: MemberMainInfo;
}
/**
* DeleteGroup请求参数结构体
*/
export interface DeleteGroupRequest {
/**
* 空间 ID。
*/
ZoneId: string;
/**
* 用户组的 ID。
*/
GroupId: string;
}
/**
* GetUser返回参数结构体
*/
export interface GetUserResponse {
/**
* 用户信息。
*/
UserInfo?: UserInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteOrganizationNodes请求参数结构体
*/
export interface DeleteOrganizationNodesRequest {
/**
* 节点ID列表。可以通过[DescribeOrganizationNodes](https://cloud.tencent.com/document/product/850/82926)获取
*/
NodeId: Array<number | bigint>;
}
/**
* EnablePolicyType请求参数结构体
*/
export interface EnablePolicyTypeRequest {
/**
* 企业组织Id。可以调用[DescribeOrganization](https://cloud.tencent.com/document/product/850/67059)获取
*/
OrganizationId: number;
/**
* 策略类型。默认值SERVICE_CONTROL_POLICY,取值范围:SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略
*/
PolicyType: string;
}
/**
* CreatePolicy返回参数结构体
*/
export interface CreatePolicyResponse {
/**
* 策略ID
*/
PolicyId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 有效策略。
*/
export interface EffectivePolicy {
/**
* 目标ID。
*/
TargetId?: number;
/**
* 有效策略内容。
*/
PolicyContent?: string;
/**
* 有效策略更新时间。
*/
LastUpdatedTimestamp?: number;
}
/**
* 标签键值对
*/
export interface Tag {
/**
* 标签键
*/
TagKey: string;
/**
* 标签值
*/
TagValue: string;
}
/**
* AddOrganizationMemberEmail请求参数结构体
*/
export interface AddOrganizationMemberEmailRequest {
/**
* 成员Uin。
*/
MemberUin: number;
/**
* 邮箱地址。
*/
Email: string;
/**
* 国际区号。
*/
CountryCode: string;
/**
* 手机号。
*/
Phone: string;
}
/**
* ListOrganizationIdentity返回参数结构体
*/
export interface ListOrganizationIdentityResponse {
/**
* 总数。
*/
Total?: number;
/**
* 条目详情。
*/
Items?: Array<OrgIdentity>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CancelOrganizationPolicySubAccount请求参数结构体
*/
export interface CancelOrganizationPolicySubAccountRequest {
/**
* 策略ID。
*/
PolicyId: number;
/**
* 组织管理员子账号Uin列表。最大5个
*/
OrgSubAccountUins: Array<number | bigint>;
}
/**
* 共享地域
*/
export interface ShareArea {
/**
* 地域名称。
*/
Name?: string;
/**
* 地域标识。
*/
Area?: string;
/**
* 地域ID。
*/
AreaId?: number;
}
/**
* DeletePolicy请求参数结构体
*/
export interface DeletePolicyRequest {
/**
* 需要删除的策略ID。可以调用[ListPolicies](https://cloud.tencent.com/document/product/850/105311)获取
*/
PolicyId: number;
/**
* 策略类型。默认值SERVICE_CONTROL_POLICY,取值范围:SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略
*/
Type?: string;
}
/**
* CancelOrganizationPolicySubAccount返回参数结构体
*/
export interface CancelOrganizationPolicySubAccountResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetUserSyncProvisioning返回参数结构体
*/
export interface GetUserSyncProvisioningResponse {
/**
* CAM 用户同步信息。
*/
UserProvisioning?: UserProvisioning;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 用户组信息。
*/
export interface GroupInfo {
/**
* 用户组的名称。
*/
GroupName?: string;
/**
* 用户组的描述。
*/
Description?: string;
/**
* 用户组的创建时间。
*/
CreateTime?: string;
/**
* 用户组的类型 Manual:手动创建,Synchronized:外部导入。
*/
GroupType?: string;
/**
* 用户组的修改时间。
*/
UpdateTime?: string;
/**
* 用户组的 ID。
*/
GroupId?: string;
/**
* 组员数量。
*/
MemberCount?: number;
/**
* 如果有入参FilterUsers,用户在用户组返回true,否则返回false
*/
IsSelected?: boolean;
}
/**
* GetSCIMSynchronizationStatus返回参数结构体
*/
export interface GetSCIMSynchronizationStatusResponse {
/**
* SCIM 同步状态。Enabled:启用。 Disabled:禁用。
*/
SCIMSynchronizationStatus?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GetZoneStatistics请求参数结构体
*/
export interface GetZoneStatisticsRequest {
/**
* 空间ID
*/
ZoneId: string;
}
/**
* 部门主要信息
*/
export interface NodeMainInfo {
/**
* 部门ID
*/
NodeId?: number;
/**
* 部门名称
*/
NodeName?: string;
}
/**
* RemovePermissionPolicyFromRoleConfiguration请求参数结构体
*/
export interface RemovePermissionPolicyFromRoleConfigurationRequest {
/**
* 空间 ID
*/
ZoneId: string;
/**
* 权限配置 ID
*/
RoleConfigurationId: string;
/**
* 权限策略类型。取值: System:系统策略。复用 CAM 的系统策略。 Custom: 自定义策略。按照 CAM 权限策略语法和结构编写的自定义策略。
*/
RolePolicyType: string;
/**
* 权限策略名称,长度最大为 32 个字符。
*/
RolePolicyName?: string;
/**
* 策略ID。
*/
RolePolicyId?: number;
}
/**
* InviteOrganizationMember请求参数结构体
*/
export interface InviteOrganizationMemberRequest {
/**
* 被邀请账号Uin。
*/
MemberUin: number;
/**
* 成员名称。最大长度为25个字符,支持英文字母、数字、汉字、符号+@、&._[]-:,
*/
Name: string;
/**
* 关系策略。取值:Financial
*/
PolicyType: string;
/**
* 成员财务权限ID列表。取值:1-查看账单、2-查看余额、3-资金划拨、4-合并出账、5-开票、6-优惠继承、7-代付费,1、2 默认必须
*/
PermissionIds: Array<number | bigint>;
/**
* 成员所属部门的节点ID。可以通过[DescribeOrganizationNodes](https://cloud.tencent.com/document/product/850/82926)获取
*/
NodeId: number;
/**
* 备注。
*/
Remark?: string;
/**
* 是否允许成员退出。允许:Allow,不允许:Denied。
*/
IsAllowQuit?: string;
/**
* 代付者Uin。成员代付费时需要
*/
PayUin?: string;
/**
* 互信实名主体名称。
*/
RelationAuthName?: string;
/**
* 互信主体证明文件列表。
*/
AuthFile?: Array<AuthRelationFile>;
/**
* 成员标签列表。最大10个
*/
Tags?: Array<Tag>;
}
/**
* QuitOrganization请求参数结构体
*/
export interface QuitOrganizationRequest {
/**
* 企业组织ID
*/
OrgId: number;
}
/**
* ListTasks返回参数结构体
*/
export interface ListTasksResponse {
/**
* 查询返回结果下一页的令牌。 说明 只有IsTruncated为true时,才显示该参数。
*/
NextToken?: string;
/**
* 符合请求参数条件的数据总条数。
*/
TotalCounts?: number;
/**
* 每页的最大数据条数。
*/
MaxResults?: number;
/**
* 返回结果是否被截断。取值: true:已截断。 false:未截断。
*/
IsTruncated?: boolean;
/**
* 任务详情
*/
Tasks?: Array<TaskInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddOrganizationNode请求参数结构体
*/
export interface AddOrganizationNodeRequest {
/**
* 父节点ID。可以通过[DescribeOrganizationNodes](https://cloud.tencent.com/document/product/850/82926)获取
*/
ParentNodeId: number;
/**
* 节点名称。最大长度为40个字符,支持英文字母、数字、汉字、符号+@、&._[]-
*/
Name: string;
/**
* 备注。
*/
Remark?: string;
/**
* 部门标签列表。最大10个
*/
Tags?: Array<Tag>;