tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
2,043 lines (1,825 loc) • 79.2 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 访问密钥列表 */
declare interface AccessKey {
/** 访问密钥标识 */
AccessKeyId?: string;
/** 密钥状态,激活(Active)或未激活(Inactive) */
Status?: string;
/** 创建时间 */
CreateTime?: string;
/** 密钥描述 */
Description?: string | null;
}
/** 访问密钥 */
declare interface AccessKeyDetail {
/** 访问密钥标识 */
AccessKeyId?: string;
/** 访问密钥(密钥仅创建时可见,请妥善保存) */
SecretAccessKey?: string;
/** 密钥状态,激活(Active)或未激活(Inactive) */
Status?: string;
/** 创建时间 */
CreateTime?: string;
/** 描述 */
Description?: string | null;
}
/** 策略关联的实体信息 */
declare interface AttachEntityOfPolicy {
/** 实体ID */
Id?: string;
/** 实体名称 */
Name?: string;
/** 实体Uin */
Uin?: number;
/** 关联类型。1 用户关联 ; 2 用户组关联 3 角色关联 */
RelatedType?: number;
/** 策略关联时间 */
AttachmentTime?: string;
}
/** 关联策略信息 */
declare interface AttachPolicyInfo {
/** 策略id */
PolicyId?: number;
/** 策略名称 */
PolicyName?: string;
/** 创建时间 */
AddTime?: string;
/** 创建来源,1 通过控制台创建, 2 通过策略语法创建 */
CreateMode?: number;
/** 取值为User和QCS。User代表自定义策略,QCS代表系统策略 */
PolicyType?: string;
/** 策略备注 */
Remark?: string;
/** 策略关联操作者主账号 */
OperateOwnerUin?: string | null;
/** 策略关联操作者ID,如果UinType为0表示子账号Uin,如果UinType为1表示角色ID */
OperateUin?: string | null;
/** 取值为0和1。OperateUinType为0表示OperateUin字段是子账号Uin。如果OperateUinType为1表示OperateUin字段是角色ID */
OperateUinType?: number | null;
/** 是否已下线,1代表已下线,0代表未下线 */
Deactived?: number;
/** 已下线的产品列表 */
DeactivedDetail?: string[];
}
/** 角色关联的策略信息 */
declare interface AttachedPolicyOfRole {
/** 策略ID */
PolicyId?: number;
/** 策略名称 */
PolicyName?: string;
/** 绑定时间 */
AddTime?: string;
/** 策略类型,User表示自定义策略,QCS表示预设策略 */
PolicyType?: string;
/** 策略创建方式,1表示按产品功能或项目权限创建,其他表示按策略语法创建 */
CreateMode?: number;
/** 是否已下线(0:否 1:是) */
Deactived?: number;
/** 已下线的产品列表 */
DeactivedDetail?: string[];
/** 策略描述 */
Description?: string;
}
/** 用户关联的策略详情 */
declare interface AttachedUserPolicy {
/** 策略ID */
PolicyId?: string;
/** 策略名 */
PolicyName?: string;
/** 策略描述 */
Description?: string;
/** 创建时间 */
AddTime?: string;
/** 策略类型(1表示自定义策略,2表示预设策略) */
StrategyType?: string;
/** 创建模式(1表示按产品或项目权限创建的策略,其他表示策略语法创建的策略) */
CreateMode?: string;
/** 随组关联信息 */
Groups?: AttachedUserPolicyGroupInfo[];
/** 是否已下线(0:否 1:是) */
Deactived?: number;
/** 已下线的产品列表 */
DeactivedDetail?: string[];
}
/** 用户关联策略(随组关联)信息 */
declare interface AttachedUserPolicyGroupInfo {
/** 分组ID */
GroupId: number;
/** 分组名称 */
GroupName: string;
}
/** 认证凭据Token */
declare interface AuthToken {
/** 认证Token */
Token?: string;
/** 服务器时间戳 */
CurrentTime?: number | null;
/** 毫秒时间戳,根据轮转周期准确计算得到 */
NextRotationTime?: number | null;
/** 毫秒,如果轮转失败则为 -1 */
LastRotationTimeCost?: number | null;
/** 成功:success失败:failed */
RotationStatus?: string | null;
/** 成功:success失败:失败信息 */
RotationMessage?: string | null;
}
/** 子用户和用户组关联信息 */
declare interface GroupIdOfUidInfo {
/** 用户组 ID */
GroupId: number;
/** 子用户 UID */
Uid?: number;
/** 子用户 Uin,Uid和Uin至少有一个必填 */
Uin?: number;
}
/** 用户组信息 */
declare interface GroupInfo {
/** 用户组 ID。 */
GroupId?: number;
/** 用户组名称。 */
GroupName?: string;
/** 用户组创建时间。 */
CreateTime?: string;
/** 用户组描述。 */
Remark?: string;
}
/** 用户组用户信息 */
declare interface GroupMemberInfo {
/** 子用户 Uid。 */
Uid?: number;
/** 子用户 Uin。 */
Uin?: number;
/** 子用户名称。 */
Name?: string;
/** 手机号。 */
PhoneNum?: string;
/** 手机区域代码。 */
CountryCode?: string;
/** 是否已验证手机。0-未验证 1-验证 */
PhoneFlag?: number;
/** 邮箱地址。 */
Email?: string;
/** 是否已验证邮箱。0-未验证 1-验证 */
EmailFlag?: number;
/** 用户类型。1-全局协作者 2-项目协作者 3-消息接收者 */
UserType?: number;
/** 创建时间。 */
CreateTime?: string;
/** 是否为主消息接收人。0-否 1-是 */
IsReceiverOwner?: number;
/** 昵称 */
Remark?: string | null;
}
/** IP限制策略 */
declare interface IpPolicy {
/** IP段 */
IP: string;
/** 策略效力,Allow或Deny */
Effect: string;
}
/** ListGrantServiceAccessAction节点 */
declare interface ListGrantServiceAccessActionNode {
/** 接口名 */
Name: string;
/** 接口描述 */
Description: string;
}
/** 用于ListPoliciesGrantingServiceAccess接口的List节点 */
declare interface ListGrantServiceAccessNode {
/** 服务 */
Service?: ListGrantServiceAccessService;
/** 接口信息 */
Action?: ListGrantServiceAccessActionNode[];
/** 授权的策略 */
Policy?: ListGrantServiceAccessPolicy[];
}
/** 用于ListPoliciesGrantingServiceAccess接口的Policy节点 */
declare interface ListGrantServiceAccessPolicy {
/** 策略ID */
PolicyId: string;
/** 策略名 */
PolicyName: string;
/** 策略类型: Custom自定义策略,Presetting预设策略 */
PolicyType: string;
/** 策略描述 */
PolicyDescription: string;
}
/** 用于ListPoliciesGrantingServiceAccess接口的Service节点 */
declare interface ListGrantServiceAccessService {
/** 服务 */
ServiceType: string;
/** 服务名 */
ServiceName: string;
}
/** 登录和敏感操作flag(校验方式是单选) */
declare interface LoginActionFlag {
/** 0: 非安全手机校验 1: 安全手机校验。 */
Phone?: number;
/** 0: 非硬token校验 1: 硬token校验。 */
Token?: number;
/** 0: 非软token校验 1: 软token校验 */
Stoken?: number;
/** 0: 非微信校验 1: 微信校验 */
Wechat?: number;
/** 0: 非自定义校验 1: 自定义校验 */
Custom?: number;
/** 0: 非邮箱校验 1: 邮箱校验 */
Mail?: number;
/** 0: 非u2f硬件token 1: u2f硬件token */
U2FToken?: number;
}
/** 登录和敏感操作flag */
declare interface LoginActionFlagIntl {
/** 手机 */
Phone?: number;
/** 硬token */
Token?: number;
/** 软token */
Stoken?: number;
/** 微信 */
Wechat?: number;
/** 自定义 */
Custom?: number;
/** 邮件 */
Mail?: number;
/** u2f硬件token */
U2FToken?: number;
}
/** 登录和敏感操作flag */
declare interface LoginActionMfaFlag {
/** 是否设置手机号为登录和敏感操作安全校验方式, 1: 设置,0: 不设置 */
Phone?: number;
/** 是否设置软token为登录和敏感操作安全校验方式, 1: 设置,0: 不设置 */
Stoken?: number;
/** 是否设置微信为登录和敏感操作安全校验方式, 1: 设置,0: 不设置 */
Wechat?: number;
}
/** 异地登录设置 */
declare interface OffsiteFlag {
/** 验证标识 */
VerifyFlag?: number;
/** 手机通知 */
NotifyPhone?: number;
/** 邮箱通知 */
NotifyEmail?: number;
/** 微信通知 */
NotifyWechat?: number;
/** 提示 */
Tips?: number;
}
/** 策略版本详情 */
declare interface PolicyVersionDetail {
/** 策略版本号 */
VersionId?: number | null;
/** 策略版本创建时间 */
CreateDate?: string | null;
/** 是否是正在生效的版本。0表示不是,1表示是 */
IsDefaultVersion?: number | null;
/** 策略语法文本 */
Document?: string | null;
}
/** 策略版本列表元素结构 */
declare interface PolicyVersionItem {
/** 策略版本号 */
VersionId?: number;
/** 策略版本创建时间 */
CreateDate?: string;
/** 是否是正在生效的版本。0表示不是,1表示是 */
IsDefaultVersion?: number;
}
/** 消息接收人信息 */
declare interface Receiver {
/** id */
Uid?: number;
/** 名字 */
Name?: string;
/** 备注 */
Remark?: string | null;
/** 手机号码 */
PhoneNumber?: string;
/** 手机号码是否验证 */
PhoneFlag?: number;
/** 邮箱 */
Email?: string;
/** 邮箱是否验证 */
EmailFlag?: number;
/** 是否主联系人 */
IsReceiverOwner?: number;
/** 是否允许微信接收通知 */
WechatFlag?: number;
/** 账号uin */
Uin?: number;
}
/** 角色详细信息 */
declare interface RoleInfo {
/** 角色ID */
RoleId?: string;
/** 角色名称 */
RoleName?: string;
/** 角色的策略文档 */
PolicyDocument?: string;
/** 角色描述 */
Description?: string;
/** 角色的创建时间 */
AddTime?: string;
/** 角色的最近一次时间 */
UpdateTime?: string;
/** 角色是否允许登录 */
ConsoleLogin?: number;
/** 角色类型,取user、system或service_linked */
RoleType?: string | null;
/** 有效时间 */
SessionDuration?: number | null;
/** 服务相关角色删除TaskId */
DeletionTaskId?: string | null;
/** 标签 */
Tags?: RoleTags[] | null;
/** 角色RoleArn信息 */
RoleArn?: string | null;
}
/** 角色标签类型 */
declare interface RoleTags {
/** 标签键 */
Key: string;
/** 标签值 */
Value: string;
}
/** SAML身份提供商 */
declare interface SAMLProviderInfo {
/** SAML身份提供商名称 */
Name: string;
/** SAML身份提供商描述 */
Description: string;
/** SAML身份提供商创建时间 */
CreateTime: string;
/** SAML身份提供商上次修改时间 */
ModifyTime: string;
}
/** 密钥最后使用时间 */
declare interface SecretIdLastUsed {
/** 密钥ID */
SecretId: string;
/** 最后访问日期(有1天延迟) */
LastUsedDate: string | null;
/** 最后密钥访问日期 */
LastSecretUsedDate: number | null;
}
/** 策略信息 */
declare interface StrategyInfo {
/** 策略ID。 */
PolicyId?: number;
/** 策略名称。 */
PolicyName?: string;
/** 策略创建时间。 */
AddTime?: string | null;
/** 策略类型。1 表示自定义策略,2 表示预设策略。 */
Type?: number;
/** 策略描述。 */
Description?: string | null;
/** 创建来源,1 通过控制台创建, 2 通过策略语法创建。 */
CreateMode?: number;
/** 关联的用户数 */
Attachments?: number;
/** 策略关联的产品 */
ServiceType?: string | null;
/** 当需要查询标记实体是否已经关联策略时不为null。0表示未关联策略,1表示已关联策略 */
IsAttached?: number | null;
/** 是否已下线 */
Deactived?: number | null;
/** 已下线产品列表 */
DeactivedDetail?: string[] | null;
/** 是否是服务相关角色策略 */
IsServiceLinkedPolicy?: number | null;
/** 关联策略实体数 */
AttachEntityCount?: number | null;
/** 关联权限边界实体数 */
AttachEntityBoundaryCount?: number | null;
/** 最后编辑时间 */
UpdateTime?: string | null;
}
/** 子用户信息 */
declare interface SubAccountInfo {
/** 子用户用户 ID */
Uin?: number;
/** 子用户用户名 */
Name?: string;
/** 子用户 UID */
Uid?: number;
/** 子用户备注 */
Remark?: string;
/** 子用户能否登录控制台 */
ConsoleLogin?: number;
/** 手机号 */
PhoneNum?: string;
/** 区号 */
CountryCode?: string;
/** 邮箱 */
Email?: string;
/** 创建时间 */
CreateTime?: string;
/** 昵称 */
NickName?: string;
}
/** 子用户信息 */
declare interface SubAccountUser {
/** 子用户用户 ID */
Uin: number;
/** 子用户用户名 */
Name: string;
/** 子用户 UID,UID是用户作为消息接收人时的唯一标识,和 UIN 一样可以唯一标识一个用户,可通过接口https://cloud.tencent.com/document/api/598/53486 获取 */
Uid: number;
/** 子用户备注 */
Remark: string;
/** 创建时间 */
CreateTime: string | null;
/** 用户类型(2:子用户;3:企业微信子用户;4:协作者;5:消息接收人) */
UserType: number;
/** 最近登录IP */
LastLoginIp: string;
/** 最近登录时间,回参为空,即为未登录过控制台 */
LastLoginTime: string | null;
}
/** 企业微信子用户 */
declare interface WeChatWorkSubAccount {
/** 子用户用户 ID */
Uin?: number;
/** 子用户用户名 */
Name?: string;
/** 子用户 UID */
Uid?: number;
/** 备注 */
Remark?: string;
/** 子用户能否登录控制台 */
ConsoleLogin?: number;
/** 手机号 */
PhoneNum?: string;
/** 区号 */
CountryCode?: string;
/** 邮箱 */
Email?: string;
/** 企业微信UserId */
WeChatWorkUserId?: string;
/** 创建时间 */
CreateTime?: string;
}
declare interface AddUserRequest {
/** 子用户用户名 */
Name: string;
/** 子用户备注 */
Remark?: string;
/** 子用户是否可以登录控制台。传0子用户无法登录控制台,传1子用户可以登录控制台。 */
ConsoleLogin?: number;
/** 是否生成子用户密钥。传0不生成子用户密钥,传1生成子用户密钥。 */
UseApi?: number;
/** 子用户控制台登录密码,若未进行密码规则设置则默认密码规则为8位以上同时包含大小写字母、数字和特殊字符。只有可以登录控制台时才有效,如果传空并且上面指定允许登录控制台,则自动生成随机密码,随机密码规则为32位包含大小写字母、数字和特殊字符。 */
Password?: string;
/** 子用户是否要在下次登录时重置密码。传0子用户下次登录控制台不需重置密码,传1子用户下次登录控制台需要重置密码。 */
NeedResetPassword?: number;
/** 手机号 */
PhoneNum?: string;
/** 区号 */
CountryCode?: string;
/** 邮箱 */
Email?: string;
}
declare interface AddUserResponse {
/** 子用户 UIN */
Uin?: number;
/** 子用户用户名 */
Name?: string;
/** 如果输入参数组合为自动生成随机密码,则返回生成的密码 */
Password?: string;
/** 子用户密钥 ID */
SecretId?: string;
/** 子用户密钥 Key */
SecretKey?: string;
/** 子用户 UID */
Uid?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AddUserToGroupRequest {
/** 添加的子用户 UIN/UID 和用户组 ID 关联关系 */
Info: GroupIdOfUidInfo[];
}
declare interface AddUserToGroupResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AttachGroupPolicyRequest {
/** 策略 id */
PolicyId: number;
/** 用户组 id */
AttachGroupId: number;
}
declare interface AttachGroupPolicyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AttachRolePolicyRequest {
/** 策略ID,入参PolicyId与PolicyName二选一 */
PolicyId?: number;
/** 角色ID,用于指定角色,入参 AttachRoleId 与 AttachRoleName 二选一 */
AttachRoleId?: string;
/** 角色名称,用于指定角色,入参 AttachRoleId 与 AttachRoleName 二选一 */
AttachRoleName?: string;
/** 策略名,入参PolicyId与PolicyName二选一 */
PolicyName?: string;
}
declare interface AttachRolePolicyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AttachUserPolicyRequest {
/** 策略 id */
PolicyId: number;
/** 子账号 uin */
AttachUin: number;
}
declare interface AttachUserPolicyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface BuildDataFlowAuthTokenRequest {
/** 资源ID */
ResourceId: string;
/** 资源地域 */
ResourceRegion: string;
/** 资源用户名 */
ResourceAccount: string;
}
declare interface BuildDataFlowAuthTokenResponse {
/** 认证凭据AuthToken信息 */
Credentials?: AuthToken | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ConsumeCustomMFATokenRequest {
/** 自定义多因子验证Token */
MFAToken: string;
}
declare interface ConsumeCustomMFATokenResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateAccessKeyRequest {
/** 指定用户Uin,不填默认为当前用户创建访问密钥 */
TargetUin?: number;
/** 密钥描述,长度在1到1024之间,可包含大小写字符,数字以及特殊字符:=,.@:/-。 正则为:[\w+=,.@:/-]*。 */
Description?: string;
}
declare interface CreateAccessKeyResponse {
/** 访问密钥 */
AccessKey?: AccessKeyDetail | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateGroupRequest {
/** 用户组名 */
GroupName: string;
/** 用户组描述 */
Remark?: string;
}
declare interface CreateGroupResponse {
/** 用户组 ID */
GroupId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateMessageReceiverRequest {
/** 消息接收人的用户名 */
Name: string;
/** 手机号国际区号,国内为86 */
CountryCode: string;
/** 手机号码, 例如:132****2492 */
PhoneNumber: string;
/** 邮箱,例如:57*****@qq.com */
Email: string;
/** 消息接收人的备注,选填 */
Remark?: string;
}
declare interface CreateMessageReceiverResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateOIDCConfigRequest {
/** 身份提供商URL */
IdentityUrl: string;
/** 客户端ID */
ClientId: string[];
/** 名称 */
Name: string;
/** 签名公钥,需要base64 */
IdentityKey: string;
/** 描述 */
Description?: string;
}
declare interface CreateOIDCConfigResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreatePolicyRequest {
/** 策略名称。长度为1~128个字符,可包含英文字母、数字和+=,.@-_。 */
PolicyName: string;
/** 策略文档 */
PolicyDocument: string;
/** 策略描述 */
Description?: string;
}
declare interface CreatePolicyResponse {
/** 新增策略ID */
PolicyId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreatePolicyVersionRequest {
/** 策略ID */
PolicyId: number;
/** 策略文本信息 */
PolicyDocument: string;
/** 是否设置为当前策略的版本 */
SetAsDefault: boolean;
}
declare interface CreatePolicyVersionResponse {
/** 策略版本号 */
VersionId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateRoleRequest {
/** 角色名称。长度为1~128个字符,可包含英文字母、数字和+=,.@-_。 */
RoleName: string;
/** 策略文档,示例:{"version":"2.0","statement":[{"action":"name/sts:AssumeRole","effect":"allow","principal":{"service":["cloudaudit.cloud.tencent.com","cls.cloud.tencent.com"]}}]},principal用于指定角色的授权对象。获取该参数可参阅 获取角色详情(https://cloud.tencent.com/document/product/598/36221) 输出参数RoleInfo */
PolicyDocument: string;
/** 角色描述 */
Description?: string;
/** 是否允许登录 1 为允许 0 为不允许 */
ConsoleLogin?: number;
/** 申请角色临时密钥的最长有效期限制(范围:0~43200) */
SessionDuration?: number;
/** 角色绑定标签 */
Tags?: RoleTags[];
}
declare interface CreateRoleResponse {
/** 角色ID */
RoleId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateSAMLProviderRequest {
/** SAML身份提供商名称 */
Name: string;
/** SAML身份提供商描述 */
Description: string;
/** SAML身份提供商Base64编码的元数据文档 */
SAMLMetadataDocument: string;
}
declare interface CreateSAMLProviderResponse {
/** SAML身份提供商资源描述符 */
ProviderArn: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateServiceLinkedRoleRequest {
/** 填写此角色的腾讯云服务载体,具体可查询文档(角色载体)字段https://cloud.tencent.com/document/product/598/85165 */
QCSServiceName: string[];
/** 自定义后缀,根据您提供的字符串,与服务提供的前缀组合在一起以形成完整的角色名称。 */
CustomSuffix?: string;
/** 角色说明。 */
Description?: string;
/** 角色绑定标签。 */
Tags?: RoleTags[];
}
declare interface CreateServiceLinkedRoleResponse {
/** 角色ID */
RoleId?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateSubAccountLoginIpPolicyRequest {
/** IP策略集合 */
IpPolicies?: IpPolicy[];
/** 审批人类型,目前支持的类型有:SubAccountLoginLimitApproval(子账号登录限制审批) */
ApproverType?: string;
/** 被添加为协助审批人的账号ID数组 */
ApproverUin?: number[];
/** 是否禁用策略:0:不禁用,1:禁用 */
DisablePolicy?: number;
/** 策略类型:1:更新IP策略,2:设置异地登录校验校验规则 */
PolicyType?: number;
}
declare interface CreateSubAccountLoginIpPolicyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateUserOIDCConfigRequest {
/** 身份提供商URL。OpenID Connect身份提供商标识。对应企业IdP提供的Openid-configuration中"issuer"字段的值。 */
IdentityUrl: string;
/** 客户端ID,在OpenID Connect身份提供商注册的客户端ID。 */
ClientId: string;
/** 授权请求Endpoint,OpenID Connect身份提供商授权地址。对应企业IdP提供的Openid-configuration中"authorization_endpoint"字段的值。 */
AuthorizationEndpoint: string;
/** 授权请求Response type,固定值id_token */
ResponseType: string;
/** 授权请求Response mode。授权请求返回模式,form_post和fragment两种可选模式,推荐选择form_post模式。 */
ResponseMode: string;
/** 映射字段名称。IdP的id_token中哪一个字段映射到子用户的用户名,通常是sub或者name字段 */
MappingFiled: string;
/** 签名公钥,需要base64_encode。验证OpenID Connect身份提供商ID Token签名的公钥。为了您的账号安全,建议您定期轮换签名公钥。 */
IdentityKey: string;
/** 授权请求Scope。openid; email;profile。授权请求信息范围。默认必选openid。 */
Scope?: string[];
/** 描述信息。由用户自行定义。 */
Description?: string;
}
declare interface CreateUserOIDCConfigResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface CreateUserSAMLConfigRequest {
/** SAML元数据文档,需要base64 encode */
SAMLMetadataDocument: string;
/** 辅助域名 */
AuxiliaryDomain?: string;
}
declare interface CreateUserSAMLConfigResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteAccessKeyRequest {
/** 指定需要删除的AccessKeyId */
AccessKeyId: string;
/** 指定用户Uin,不填默认为当前用户删除访问密钥 */
TargetUin?: number;
}
declare interface DeleteAccessKeyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteGroupRequest {
/** 用户组 ID */
GroupId: number;
}
declare interface DeleteGroupResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteMessageReceiverRequest {
/** 消息接受者的名称 */
Name: string;
}
declare interface DeleteMessageReceiverResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteOIDCConfigRequest {
/** OIDC身份提供商名称 */
Name: string;
}
declare interface DeleteOIDCConfigResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeletePolicyRequest {
/** 数组,数组成员是策略 id,支持批量删除策略 */
PolicyId: number[];
}
declare interface DeletePolicyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeletePolicyVersionRequest {
/** 策略ID */
PolicyId: number;
/** 策略版本号 */
VersionId: number[];
}
declare interface DeletePolicyVersionResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteRolePermissionsBoundaryRequest {
/** 角色ID(与角色名至少填一个) */
RoleId?: string;
/** 角色名(与角色ID至少填一个) */
RoleName?: string;
}
declare interface DeleteRolePermissionsBoundaryResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteRoleRequest {
/** 角色ID,用于指定角色,入参 RoleId 与 RoleName 二选一 */
RoleId?: string;
/** 角色名称,用于指定角色,入参 RoleId 与 RoleName 二选一 */
RoleName?: string;
}
declare interface DeleteRoleResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteSAMLProviderRequest {
/** SAML身份提供商名称 */
Name: string;
}
declare interface DeleteSAMLProviderResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteServiceLinkedRoleRequest {
/** 要删除的服务相关角色的名称。 */
RoleName: string;
}
declare interface DeleteServiceLinkedRoleResponse {
/** 删除任务ID,可用于检查删除服务相关角色状态。 */
DeletionTaskId: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteUserPermissionsBoundaryRequest {
/** 子账号Uin */
TargetUin: number;
}
declare interface DeleteUserPermissionsBoundaryResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DeleteUserRequest {
/** 子用户用户名 */
Name: string;
/** 是否强制删除该子用户,默认入参为0。0:若该用户存在未删除API密钥,则不删除用户;1:若该用户存在未删除API密钥,则先删除密钥后删除用户。删除密钥需要您拥有cam:DeleteApiKey权限,您将可以删除该用户下启用或禁用状态的所有密钥,无权限则删除密钥和用户失败 */
Force?: number;
}
declare interface DeleteUserResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeOIDCConfigRequest {
/** 名称 */
Name: string;
}
declare interface DescribeOIDCConfigResponse {
/** 身份提供商类型 11角色身份提供商 */
ProviderType?: number;
/** 身份提供商URL */
IdentityUrl?: string;
/** 签名公钥 */
IdentityKey?: string;
/** 客户端id */
ClientId?: string[];
/** 状态:0:未设置,11:已开启,2:已禁用 */
Status?: number;
/** 描述 */
Description?: string;
/** 名称 */
Name?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeRoleListRequest {
/** 页码,从1开始 */
Page: number;
/** 每页行数,不能大于200 */
Rp: number;
/** 标签筛选 */
Tags?: RoleTags[];
}
declare interface DescribeRoleListResponse {
/** 角色详情列表。 */
List?: RoleInfo[];
/** 角色总数 */
TotalNum?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSafeAuthFlagCollRequest {
/** 子账号 */
SubUin: number;
}
declare interface DescribeSafeAuthFlagCollResponse {
/** 登录保护设置 */
LoginFlag?: LoginActionFlag;
/** 敏感操作保护设置 */
ActionFlag?: LoginActionFlag;
/** 异地登录保护设置 */
OffsiteFlag?: OffsiteFlag;
/** 是否提示信任设备1 :提示 0: 不提示 */
PromptTrust?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSafeAuthFlagIntlRequest {
}
declare interface DescribeSafeAuthFlagIntlResponse {
/** 登录保护设置 */
LoginFlag?: LoginActionFlagIntl;
/** 敏感操作保护设置 */
ActionFlag?: LoginActionFlagIntl;
/** 异地登录保护设置 */
OffsiteFlag?: OffsiteFlag;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSafeAuthFlagRequest {
}
declare interface DescribeSafeAuthFlagResponse {
/** 登录保护设置 */
LoginFlag?: LoginActionFlag;
/** 敏感操作保护设置 */
ActionFlag?: LoginActionFlag;
/** 异地登录保护设置 */
OffsiteFlag?: OffsiteFlag;
/** 是否提示信任设备:1: 提示 0: 不提示 */
PromptTrust?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeSubAccountsRequest {
/** 子用户UIN列表,最多支持50个UIN */
FilterSubAccountUin: number[];
}
declare interface DescribeSubAccountsResponse {
/** 子用户列表 */
SubAccounts?: SubAccountUser[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeUserOIDCConfigRequest {
}
declare interface DescribeUserOIDCConfigResponse {
/** 身份提供商类型。 12:用户OIDC身份提供商 */
ProviderType?: number;
/** 身份提供商URL */
IdentityUrl?: string;
/** 签名公钥 */
IdentityKey?: string;
/** 客户端id */
ClientId?: string;
/** 状态:0:未设置,11:已开启,2:已禁用 */
Status?: number;
/** 授权请求Endpoint */
AuthorizationEndpoint?: string;
/** 授权请求Scope */
Scope?: string[];
/** 授权请求Response type */
ResponseType?: string;
/** 授权请求Response mode */
ResponseMode?: string;
/** 映射字段名称 */
MappingFiled?: string;
/** 描述 */
Description?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DescribeUserSAMLConfigRequest {
}
declare interface DescribeUserSAMLConfigResponse {
/** SAML元数据文档 */
SAMLMetadata?: string;
/** 状态:0:未设置,11:已开启,2:已禁用 */
Status?: number;
/** 辅助域名 */
AuxiliaryDomain?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DetachGroupPolicyRequest {
/** 策略 id */
PolicyId: number;
/** 用户组 id */
DetachGroupId: number;
}
declare interface DetachGroupPolicyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DetachRolePolicyRequest {
/** 策略ID,入参PolicyId与PolicyName二选一 */
PolicyId?: number;
/** 角色ID,用于指定角色,入参 DetachRoleId 与 DetachRoleName 二选一 */
DetachRoleId?: string;
/** 角色名称,用于指定角色,入参 DetachRoleId 与 DetachRoleName 二选一 */
DetachRoleName?: string;
/** 策略名,入参PolicyId与PolicyName二选一 */
PolicyName?: string;
}
declare interface DetachRolePolicyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DetachUserPolicyRequest {
/** 策略 id */
PolicyId: number;
/** 子账号 uin */
DetachUin: number;
}
declare interface DetachUserPolicyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface DisableUserSSORequest {
}
declare interface DisableUserSSOResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetAccountSummaryRequest {
}
declare interface GetAccountSummaryResponse {
/** 策略数 */
Policies?: number;
/** 角色数 */
Roles?: number;
/** 身份提供商数 */
Idps?: number;
/** 子账户数 */
User?: number;
/** 分组数 */
Group?: number;
/** 分组用户总数 */
Member?: number;
/** 身份提供商数。 */
IdentityProviders?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetCustomMFATokenInfoRequest {
/** 自定义多因子验证Token,针对用户自定义的安全校验方式而生成的,以供查询用户安全校验时使用。 */
MFAToken: string;
}
declare interface GetCustomMFATokenInfoResponse {
/** 自定义多因子验证Token对应的账号Id */
Uin?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetGroupRequest {
/** 用户组 ID */
GroupId: number;
}
declare interface GetGroupResponse {
/** 用户组 ID */
GroupId?: number;
/** 用户组名称 */
GroupName?: string;
/** 用户组成员数量 */
GroupNum?: number;
/** 用户组描述 */
Remark?: string;
/** 用户组创建时间 */
CreateTime?: string;
/** 用户组成员信息 */
UserInfo?: GroupMemberInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetPolicyRequest {
/** 策略Id。 */
PolicyId: number;
}
declare interface GetPolicyResponse {
/** 策略名。 */
PolicyName?: string;
/** 策略描述。 */
Description?: string;
/** 1 表示自定义策略,2 表示预设策略。 */
Type?: number;
/** 策略创建时间。 */
AddTime?: string;
/** 策略最近更新时间。 */
UpdateTime?: string;
/** 策略文档。 */
PolicyDocument?: string;
/** 备注。 */
PresetAlias?: string | null;
/** 是否是服务相关策略,0代表不是服务相关策略,1代表是服务相关策略。 */
IsServiceLinkedRolePolicy?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetPolicyVersionRequest {
/** 策略ID */
PolicyId: number;
/** 策略版本号,可由ListPolicyVersions获取 */
VersionId: number;
}
declare interface GetPolicyVersionResponse {
/** 策略版本详情 */
PolicyVersion?: PolicyVersionDetail;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetRolePermissionBoundaryRequest {
/** 角色ID */
RoleId: string;
}
declare interface GetRolePermissionBoundaryResponse {
/** 策略ID */
PolicyId?: number | null;
/** 策略名 */
PolicyName?: string | null;
/** 策略语法 */
PolicyDocument?: string | null;
/** 策略类型:1.自定义策略,2.预设策略 */
PolicyType?: number | null;
/** 创建方式:1.按产品功能或项目权限创建,2.按策略语法创建,3.按策略生成器创建,4.按标签授权创建,5.按权限边界规则创建 */
CreateMode?: number | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetRoleRequest {
/** 角色 ID,用于指定角色,入参 RoleId 与 RoleName 二选一 */
RoleId?: string;
/** 角色名,用于指定角色,入参 RoleId 与 RoleName 二选一 */
RoleName?: string;
}
declare interface GetRoleResponse {
/** 角色详情 */
RoleInfo?: RoleInfo;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetSAMLProviderRequest {
/** SAML身份提供商名称 */
Name: string;
}
declare interface GetSAMLProviderResponse {
/** SAML身份提供商名称 */
Name: string;
/** SAML身份提供商描述 */
Description: string;
/** SAML身份提供商创建时间 */
CreateTime: string;
/** SAML身份提供商上次修改时间 */
ModifyTime: string;
/** SAML身份提供商元数据文档 */
SAMLMetadata: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetSecurityLastUsedRequest {
/** 查询密钥ID列表。最多支持10个。 */
SecretIdList: string[];
}
declare interface GetSecurityLastUsedResponse {
/** 密钥ID最近访问列表 */
SecretIdLastUsedRows?: SecretIdLastUsed[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetServiceLinkedRoleDeletionStatusRequest {
/** 删除任务ID */
DeletionTaskId: string;
}
declare interface GetServiceLinkedRoleDeletionStatusResponse {
/** 状态:NOT_STARTED,IN_PROGRESS,SUCCEEDED,FAILED */
Status?: string;
/** 失败原因 */
Reason?: string;
/** 服务类型 */
ServiceType?: string | null;
/** 服务名称 */
ServiceName?: string | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetUserAppIdRequest {
}
declare interface GetUserAppIdResponse {
/** 当前账号Uin */
Uin?: string;
/** 当前账号OwnerUin */
OwnerUin?: string;
/** 当前账号AppId */
AppId?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetUserPermissionBoundaryRequest {
/** 子账号Uin */
TargetUin: number;
}
declare interface GetUserPermissionBoundaryResponse {
/** 策略ID */
PolicyId?: number | null;
/** 策略名 */
PolicyName?: string | null;
/** 策略语法 */
PolicyDocument?: string | null;
/** 策略类型:1.自定义策略,2.预设策略 */
PolicyType?: number | null;
/** 创建方式:1.按产品功能或项目权限创建,2.按策略语法创建,3.按策略生成器创建,4.按标签授权创建,5.按权限边界规则创建 */
CreateMode?: number | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface GetUserRequest {
/** 子用户用户名 */
Name: string;
}
declare interface GetUserResponse {
/** 子用户用户 UIN */
Uin?: number;
/** 子用户用户名 */
Name?: string;
/** 子用户 UID */
Uid?: number;
/** 子用户备注 */
Remark?: string | null;
/** 子用户能否登录控制台 0-无法登录控制台,1-可以登录控制台 */
ConsoleLogin?: number;
/** 手机号 */
PhoneNum?: string;
/** 区号 */
CountryCode?: string;
/** 邮箱 */
Email?: string;
/** 最近一次登录ip */
RecentlyLoginIP?: string;
/** 最近一次登录时间 */
RecentlyLoginTime?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListAccessKeysRequest {
/** 指定用户Uin,不填默认列出当前用户访问密钥 */
TargetUin?: number;
}
declare interface ListAccessKeysResponse {
/** 访问密钥列表 */
AccessKeys?: AccessKey[] | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListAttachedGroupPoliciesRequest {
/** 用户组ID */
TargetGroupId: number;
/** 页码,默认值是 1,从 1 开始 */
Page?: number;
/** 每页大小,默认值是 20 */
Rp?: number;
/** 搜索关键字 */
Keyword?: string;
}
declare interface ListAttachedGroupPoliciesResponse {
/** 策略总数。取值范围大于等于0。 */
TotalNum?: number;
/** 策略列表 */
List?: AttachPolicyInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListAttachedRolePoliciesRequest {
/** 页码,从 1 开始 */
Page: number;
/** 每页行数,不能大于200 */
Rp: number;
/** 角色 ID。用于指定角色,入参 RoleId 与 RoleName 二选一 */
RoleId?: string;
/** 角色名。用于指定角色,入参 RoleId 与 RoleName 二选一 */
RoleName?: string;
/** 按策略类型过滤,User表示仅查询自定义策略,QCS表示仅查询预设策略 */
PolicyType?: string;
/** 搜索关键字 */
Keyword?: string;
}
declare interface ListAttachedRolePoliciesResponse {
/** 角色关联的策略列表 */
List?: AttachedPolicyOfRole[];
/** 角色关联的策略总数 */
TotalNum?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListAttachedUserAllPoliciesRequest {
/** 目标用户Uin */
TargetUin: number;
/** 每页数量,必须大于 0 且小于等于 200。 */
Rp: number;
/** 页码,从 1开始,不能大于 200。 */
Page: number;
/** 关联类型。0:返回直接关联和随组关联策略,1:只返回直接关联策略,2:只返回随组关联策略。 */
AttachType: number;
/** 策略类型。1表示自定义策略,2表示预设策略。 */
StrategyType?: number;
/** 搜索关键字 */
Keyword?: string;
}
declare interface ListAttachedUserAllPoliciesResponse {
/** 策略列表数据。 */
PolicyList?: AttachedUserPolicy[];
/** 策略总数。 */
TotalNum?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListAttachedUserPoliciesRequest {
/** 子账号 uin */
TargetUin: number;
/** 页码,默认值是 1,从 1 开始 */
Page?: number;
/** 每页大小,默认值是 20 */
Rp?: number;
}
declare interface ListAttachedUserPoliciesResponse {
/** 策略总数 */
TotalNum?: number;
/** 策略列表 */
List?: AttachPolicyInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListCollaboratorsRequest {
/** 分页的条数,默认是20条。 */
Limit?: number;
/** 分页的起始值,默认从0开始。 */
Offset?: number;
}
declare interface ListCollaboratorsResponse {
/** 总数 */
TotalNum?: number;
/** 协作者信息 */
Data?: SubAccountInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListEntitiesForPolicyRequest {
/** 策略 id */
PolicyId: number;
/** 页码,默认值是 1,从 1 开始 */
Page?: number;
/** 每页大小,默认值是 20 */
Rp?: number;
/** 可取值 'All'、'User'、'Group' 和 'Role','All' 表示获取所有实体类型,'User' 表示只获取子账号,'Group' 表示只获取用户组,'Role' 表示只获取角色,默认取 'All' */
EntityFilter?: string;
}
declare interface ListEntitiesForPolicyResponse {
/** 实体总数 */
TotalNum?: number;
/** 实体列表 */
List?: AttachEntityOfPolicy[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListGroupsForUserRequest {
/** 子用户 UID,入参Uid和SubUin二选一 */
Uid?: number;
/** 每页数量。默认为20。 */
Rp?: number;
/** 页码。默认为1。 */
Page?: number;
/** 子账号UIN,入参Uid和SubUin二选一 */
SubUin?: number;
}
declare interface ListGroupsForUserResponse {
/** 子用户加入的用户组总数 */
TotalNum?: number;
/** 用户组信息 */
GroupInfo?: GroupInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListGroupsRequest {
/** 页码。默认为1。 */
Page?: number;
/** 每页数量。默认为20。 */
Rp?: number;
/** 按用户组名称匹配。 */
Keyword?: string;
}
declare interface ListGroupsResponse {
/** 用户组总数。 */
TotalNum?: number;
/** 用户组数组信息。 */
GroupInfo?: GroupInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListPoliciesGrantingServiceAccessRequest {
/** 子账号uin,与RoleId、GroupId三选一必传 */
TargetUin?: number;
/** 角色ID,与TargetUin、GroupId三选一必传 */
RoleId?: number;
/** 用户组ID,与TargetUin、RoleId三选一必传 */
GroupId?: number;
/** 服务名,查看服务授权接口详情时需传该字段 */
ServiceType?: string;
}
declare interface ListPoliciesGrantingServiceAccessResponse {
/** 列表 */
List?: ListGrantServiceAccessNode[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListPoliciesRequest {
/** 每页数量,默认值是 20,必须大于 0 且小于或等于 200 */
Rp?: number;
/** 页码,默认值是 1,从 1开始,不能大于 200 */
Page?: number;
/** 可取值 'All'、'QCS' 和 'Local','All' 获取所有策略,'QCS' 只获取预设策略,'Local' 只获取自定义策略,默认取 'All' */
Scope?: string;
/** 按策略名匹配 */
Keyword?: string;
}
declare interface ListPoliciesResponse {
/** 策略总数 */
TotalNum?: number;
/** 策略数组,数组每个成员包括 policyId、policyName、addTime、type、description、 createMode 字段。其中: policyId:策略 id policyName:策略名addTime:策略创建时间type:1 表示自定义策略,2 表示预设策略 description:策略描述 createMode:1 表示按业务权限创建的策略,其他值表示可以查看策略语法和通过策略语法更新策略Attachments: 关联的用户数ServiceType: 策略关联的产品IsAttached: 当需要查询标记实体是否已经关联策略时不为null。0表示未关联策略,1表示已关联策略 */
List?: StrategyInfo[];
/** 保留字段 */
ServiceTypeList?: string[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListPolicyVersionsRequest {
/** 策略ID */
PolicyId: number;
}
declare interface ListPolicyVersionsResponse {
/** 策略版本列表 */
Versions?: PolicyVersionItem[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListReceiverRequest {
/** 分页偏移量 */
Offset?: number;
/** 分页限制数目 */
Limit?: number;
}
declare interface ListReceiverResponse {
/** 总数目 */
TotalCount?: number;
/** 联系人列表 */
Receivers?: Receiver[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListSAMLProvidersRequest {
}
declare interface ListSAMLProvidersResponse {
/** SAML身份提供商总数 */
TotalCount?: number;
/** SAML身份提供商列表 */
SAMLProviderSet?: SAMLProviderInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListUsersForGroupRequest {
/** 用户组 ID。 */
GroupId: number;
/** 页码。默认为1。 */
Page?: number;
/** 每页数量。默认为20。 */
Rp?: number;
}
declare interface ListUsersForGroupResponse {
/** 用户组关联的用户总数。 */
TotalNum?: number;
/** 子用户信息。 */
UserInfo?: GroupMemberInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListUsersRequest {
}
declare interface ListUsersResponse {
/** 子用户信息 */
Data?: SubAccountInfo[];
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface ListWeChatWorkSubAccountsRequest {
/** 偏移量 */
Offset: number;
/** 限制数目 */
Limit: number;
}
declare interface ListWeChatWorkSubAccountsResponse {
/** 企业微信子用户列表。 */
Data?: WeChatWorkSubAccount[];
/** 总数目。 */
TotalCount?: number;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface PutRolePermissionsBoundaryRequest {
/** 策略ID */
PolicyId: number;
/** 角色ID(与角色名至少填一个) */
RoleId?: string;
/** 角色名(与角色ID至少填一个) */
RoleName?: string;
}
declare interface PutRolePermissionsBoundaryResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface PutUserPermissionsBoundaryRequest {
/** 子账号Uin */
TargetUin: number;
/** 策略ID */
PolicyId: number;
}
declare interface PutUserPermissionsBoundaryResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface RemoveUserFromGroupRequest {
/** 要删除的用户 UIN/UID和用户组 ID对应数组 */
Info: GroupIdOfUidInfo[];
}
declare interface RemoveUserFromGroupResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface SetDefaultPolicyVersionRequest {
/** 策略ID */
PolicyId: number;
/** 策略版本号,可由ListPolicyVersions获取 */
VersionId: number;
}
declare interface SetDefaultPolicyVersionResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface SetMfaFlagRequest {
/** 设置用户的uin */
OpUin?: number;
/** 登录保护设置 */
LoginFlag?: LoginActionMfaFlag;
/** 操作保护设置 */
ActionFlag?: LoginActionMfaFlag;
}
declare interface SetMfaFlagResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface TagRoleRequest {
/** 标签 */
Tags: RoleTags[];
/** 角色名,与角色ID至少输入一个 */
RoleName?: string;
/** 角色ID,与角色名至少输入一个 */
RoleId?: string;
}
declare interface TagRoleResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UntagRoleRequest {
/** 标签键 */
TagKeys: string[];
/** 角色名,与角色ID至少输入一个 */
RoleName?: string;
/** 角色ID,与角色名至少输入一个 */
RoleId?: string;
}
declare interface UntagRoleResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdateAccessKeyRequest {
/** 指定需要更新的AccessKeyId */
AccessKeyId: string;
/** 密钥状态,激活(Active)或未激活(Inactive) */
Status: string;
/** 指定用户Uin,不填默认为当前用户更新访问密钥 */
TargetUin?: number;
}
declare interface UpdateAccessKeyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdateAssumeRolePolicyRequest {
/** 策略文档,示例:{"version":"2.0","statement":[{"action":"name/sts:AssumeRole","effect":"allow","principal":{"service":["cloudaudit.cloud.tencent.com","cls.cloud.tencent.com"]}}]},principal用于指定角色的授权对象。获取该参数可参阅 获取角色详情(https://cloud.tencent.com/document/product/598/36221) 输出参数RoleInfo */
PolicyDocument: string;
/** 角色ID,用于指定角色,入参 RoleId 与 RoleName 二选一 */
RoleId?: string;
/** 角色名称,用于指定角色,入参 RoleId 与 RoleName 二选一 */
RoleName?: string;
}
declare interface UpdateAssumeRolePolicyResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdateGroupRequest {
/** 用户组 ID */
GroupId: number;
/** 用户组名 */
GroupName?: string;
/** 用户组描述 */
Remark?: string;
}
declare interface UpdateGroupResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdateOIDCConfigRequest {
/** 身份提供商URL */
IdentityUrl: string;
/** 客户端ID */
ClientId: string[];
/** 名称 */
Name: string;
/** 签名公钥,需要base64 */
IdentityKey: string;
/** 描述 */
Description?: string;
}
declare interface UpdateOIDCConfigResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdatePolicyRequest {
/** 策略ID,与PolicyName二选一必填 */
PolicyId?: number;
/** 策略名,与PolicyId二选一必填 */
PolicyName?: string;
/** 策略描述 */
Description?: string;
/** 策略文档 */
PolicyDocument?: string;
/** 预设策略备注 */
Alias?: string;
}
declare interface UpdatePolicyResponse {
/** 策略id,入参是PolicyName时,才会返回 */
PolicyId?: number | null;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdateRoleConsoleLoginRequest {
/** 是否可登录,可登录:1,不可登录:0 */
ConsoleLogin: number;
/** 角色ID,入参 RoleId 与 RoleName 二选一 */
RoleId?: number;
/** 角色名,入参 RoleId 与 RoleName 二选一 */
RoleName?: string;
}
declare interface UpdateRoleConsoleLoginResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdateRoleDescriptionRequest {
/** 角色描述 */
Description: string;
/** 角色ID,用于指定角色,入参 RoleId 与 RoleName 二选一 */
RoleId?: string;
/** 角色名称,用于指定角色,入参 RoleId 与 RoleName 二选一 */
RoleName?: string;
}
declare interface UpdateRoleDescriptionResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdateRoleSessionDurationRequest {
/** 时长(秒) */
SessionDuration: number;
/** 角色名(与角色ID必填一个) */
RoleName?: string;
/** 角色ID(与角色名必填一个) */
RoleId?: number;
}
declare interface UpdateRoleSessionDurationResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdateSAMLProviderRequest {
/** SAML身份提供商名称 */
Name: string;
/** SAML身份提供商描述 */
Description?: string;
/** SAML身份提供商Base64编码的元数据文档 */
SAMLMetadataDocument?: string;
}
declare interface UpdateSAMLProviderResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdateUserOIDCConfigRequest {
/** 身份提供商URL。OpenID Connect身份提供商标识。对应企业IdP提供的Openid-configuration中"issuer"字段的值,该URL必须以https开头,符合标准URL格式,不允许带有query参数(以?标识)、fragment片段(以#标识)和登录信息(以@标识)。 */
IdentityUrl: string;
/** 客户端ID,在OpenID Connect身份提供商注册的客户端ID,允许英文字母、数字、特殊字符.-_:/,不能以特殊字符.-_:/开头,单个客户端ID最大64个字符。 */
ClientId: string;
/** 授权请求Endpoint,OpenID Connect身份提供商授权地址。对应企业IdP提供的Openid-configuration中"authorization_endpoint"字段的值,该URL必须以https开头,符合标准URL格式,不允许带有query参数(以?标识)、fragment片段(以#标识)和登录信息(以@标识)。 */
AuthorizationEndpoint: string;
/** 授权请求Response type,有code,id_token,固定值id_token。 */
ResponseType: string;
/** 授权请求Response mode。授权请求返回模式,有form_post和fragment两种可选模式,推荐选择form_post模式。 */
ResponseMode: string;
/** 映射字段名称。IdP的id_token中哪一个字段映射到子用户的用户名,通常是sub或者name字段,仅支持英文字母、数字、汉字、符号@、&_[]-的组合,1-255个中文或英文字符 */
MappingFiled: string;
/** RSA签名公钥,JWKS格式,需要进行base64_encode。验证OpenID Connect身份提供商ID Token签名的公钥。为了您的账号安全,建议您定期轮换签名公钥。 */
IdentityKey: string;
/** 授权请求Scope。有openid; email;profile三种。代表授权请求信息范围openid表示请求访问用户的身份信息,email表示请求访问用户的电子邮件地址,profile表示请求访问用户的基本信息。默认必选openid。 */
Scope?: string[];
/** 描述,长度为1~255个英文或中文字符,默认值为空。 */
Description?: string;
}
declare interface UpdateUserOIDCConfigResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdateUserRequest {
/** 子用户用户名 */
Name: string;
/** 子用户备注 */
Remark?: string;
/** 子用户是否可以登录控制台。传0子用户无法登录控制台,传1子用户可以登录控制台。 */
ConsoleLogin?: number;
/** 子用户控制台登录密码,若未进行密码规则设置则默认密码规则为8位以上同时包含大小写字母、数字和特殊字符。只有可以登录控制台时才有效,如果传空并且上面指定允许登录控制台,则自动生成随机密码,随机密码规则为32位包含大小写字母、数字和特殊字符。 */
Password?: string;
/** 子用户是否要在下次登录时重置密码。传0子用户下次登录控制台不需重置密码,传1子用户下次登录控制台需要重置密码。 */
NeedResetPassword?: number;
/** 手机号 */
PhoneNum?: string;
/** 区号 */
CountryCode?: string;
/** 邮箱 */
Email?: string;
}
declare interface UpdateUserResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface UpdateUserSAMLConfigRequest {
/** 修改的操作类型:enable:启用,disable:禁用,updateSAML:修改元数据文档 */
Operate: string;
/** 元数据文档,需要base64 encode,仅当Operate为updateSAML时需要此参数 */
SAMLMetadataDocument?: string;
/** 辅助域名 */
AuxiliaryDomain?: string;
}
declare interface UpdateUserSAMLConfigResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
/** {@link Cam 访问管理} */
declare interface Cam {
(): Versions;
/** 创建子用户 {@link AddUserRequest} {@link AddUserResponse} */
AddUser(data: AddUserRequest, config?: AxiosRequestConfig): AxiosPromise<AddUserResponse>;
/** 用户加入到用户组 {@link AddUserToGroupRequest} {@link AddUserToGroupResponse} */
AddUserToGroup(data: AddUserToGroupRequest, config?: AxiosRequestConfig): AxiosPromise<AddUserToGroupResponse>;
/** 绑定策略到用户组 {@link AttachGroupPolicyRequest} {@link AttachGroupPolicyResponse} */
AttachGroupPolicy(data: AttachGroupPolicyRequest, config?: AxiosRequestConfig): AxiosPromise<AttachGroupPolicyResponse>;
/** 绑定权限策略到角色 {@link AttachRolePolicyRequest} {@link AttachRolePolicyResponse} */
AttachRolePolicy(data?: AttachRolePolicyRequest, config?: AxiosRequestConfig): AxiosPromise<AttachRolePolicyResponse>;
/** 绑定策略到用户 {@link AttachUserPolicyRequest} {@link AttachUserPolicyResponse} */
AttachUserPolicy(data: AttachUserPolicyRequest, config?: AxiosRequestConfig): AxiosPromise<AttachUserPolicyResponse>;
/** 获取数据流认证Token {@link BuildDataFlowAuthTokenRequest} {@link BuildDataFlowAuthTokenResponse} */
BuildDataFlowAuthToken(data: BuildDataFlowAuthTokenRequest, config?: AxiosRequestConfig): AxiosPromise<BuildDataFlowAuthTokenResponse>;
/** 验证自定义多因子Token {@link ConsumeCustomMFATokenRequest} {@link ConsumeCustomMFATokenResponse} */
ConsumeCustomMFAToken(data: ConsumeCustomMFATokenRequest, config?: AxiosRequestConfig): AxiosPromise<ConsumeCustomMFATokenResponse>;
/** 创建访问密钥 {@link CreateAccessKeyRequest} {@link CreateAccessKeyResponse} */
CreateAccessKey(data?: CreateAccessKeyRequest, config?: AxiosRequestConfig): AxiosPromise<CreateAccessKeyResponse>;
/** 创建用户组 {@link CreateGroupRequest} {@link CreateGroupResponse} */
CreateGroup(data: CreateGroupRequest, config?: AxiosRequestConfig): AxiosPromise<CreateGroupResponse>;
/** 创建消息接收人 {@link CreateMessageReceiverRequest} {@link CreateMessageReceiverResponse} */
CreateMessageReceiver(data: CreateMessageReceiverRequest, config?: AxiosRequestConfig): AxiosPromise<CreateMessageReceiverResponse>;
/** 创建角色OIDC配置 {@link CreateOIDCConfigRequest} {@link CreateOIDCConfigResponse} */
CreateOIDCConfig(data: CreateOIDCConfigRequest, config?: AxiosRequestConfig): AxiosPromise<CreateOIDCConfigResponse>;
/** 创建策略 {@link CreatePolicyRequest} {@link CreatePolicyResponse} */
CreatePolicy(data: CreatePolicyRequest, config?: AxiosRequestConfig): AxiosPromise<CreatePolicyResponse>;
/** 新增策略版本接口 {@link CreatePolicyVersionRequest} {@link CreatePolicyVersionResponse} */
CreatePolicyVersion(data: CreatePolicyVersionRequest, config?: AxiosRequestConfig): AxiosPromise<CreatePolicyVersionResponse>;
/** 创建角色 {@link CreateRoleRequest} {@link CreateRoleResponse} */
CreateRole(data: CreateRoleRequest, config?: AxiosRequestConfig): AxiosPromise<CreateRoleResponse>;
/** 创建SAML身份提供商 {@link CreateSAMLProviderRequest} {@link CreateSAMLProviderResponse} */
CreateSAMLProvider(data: CreateSAMLProviderRequest, config?: AxiosRequestConfig): AxiosPromise<CreateSAMLProviderResponse>;
/** 创建服务相关角色 {@link CreateServiceLinkedRoleRequest} {@link CreateServiceLinkedRoleResponse} */
CreateServiceLinkedRole(data: CreateServiceLinkedRoleRequest, config?: AxiosRequestConfig): AxiosPromise<CreateServiceLinkedRoleResponse>;
/** 增加子账号登录IP策略 {@link CreateSubAccountLoginIpPolicyRequest} {@link CreateSubAccountLoginIpPolicyResponse} */
CreateSubAccountLoginIpPolicy(data?: CreateSubAccountLoginIpPolicyRequest, config?: AxiosRequestConfig): AxiosPromise<CreateSubAccountLoginIpPolicyResponse>;
/** 创建用户OIDC配置 {@link CreateUserOIDCConfigRequest} {@link CreateUserOIDCConfigResponse} */
CreateUserOIDCConfig(data: CreateUserOIDCConfigRequest, config?: AxiosRequestConfig): AxiosPromise<CreateUserOIDCConfigResponse>;
/** 创建用户SAML配置 {@link CreateUserSAMLConfigRequest} {@link CreateUserSAMLConfigResponse} */
CreateUserSAMLConfig(data: CreateUserSAMLConfigRequest, config?: AxiosRequestConfig): AxiosPromise<CreateUserSAMLConfigResponse>;
/** 删除访问密钥 {@link DeleteAccessKeyRequest} {@link DeleteAccessKeyResponse} */
DeleteAccessKey(data: DeleteAccessKeyRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteAccessKeyResponse>;
/** 删除用户组 {@link DeleteGroupRequest} {@link DeleteGroupResponse} */
DeleteGroup(data: DeleteGroupRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteGroupResponse>;
/** 删除消息接收人 {@link DeleteMessageReceiverRequest} {@link DeleteMessageReceiverResponse} */
DeleteMessageReceiver(data: DeleteMessageReceiverRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteMessageReceiverResponse>;
/** 删除OIDC身份提供商 {@link DeleteOIDCConfigRequest} {@link DeleteOIDCConfigResponse} */
DeleteOIDCConfig(data: DeleteOIDCConfigRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteOIDCConfigResponse>;
/** 删除策略 {@link DeletePolicyRequest} {@link DeletePolicyResponse} */
DeletePolicy(data: DeletePolicyRequest, config?: AxiosRequestConfig): AxiosPromise<DeletePolicyResponse>;
/** 删除策略的策略版本 {@link DeletePolicyVersionRequest} {@link DeletePolicyVersionResponse} */
DeletePolicyVersion(data: DeletePolicyVersionRequest, config?: AxiosRequestConfig): AxiosPromise<DeletePolicyVersionResponse>;
/** 删除角色 {@link DeleteRoleRequest} {@link DeleteRoleResponse} */
DeleteRole(data?: DeleteRoleRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteRoleResponse>;
/** 删除角色权限边界 {@link DeleteRolePermissionsBoundaryRequest} {@link DeleteRolePermissionsBoundaryResponse} */
DeleteRolePermissionsBoundary(data?: DeleteRolePermissionsBoundaryRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteRolePermissionsBoundaryResponse>;
/** 删除SAML身份提供商 {@link DeleteSAMLProviderRequest} {@link DeleteSAMLProviderResponse} */
DeleteSAMLProvider(data: DeleteSAMLProviderRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteSAMLProviderResponse>;
/** 删除服务相关角色 {@link DeleteServiceLinkedRoleRequest} {@link DeleteServiceLinkedRoleResponse} */
DeleteServiceLinkedRole(data: DeleteServiceLinkedRoleRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteServiceLinkedRoleResponse>;
/** 删除子用户 {@link DeleteUserRequest} {@link DeleteUserResponse} */
DeleteUser(data: DeleteUserRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteUserResponse>;
/** 删除用户权限边界 {@link DeleteUserPermissionsBoundaryRequest} {@link DeleteUserPermissionsBoundaryResponse} */
DeleteUserPermissionsBoundary(data: DeleteUserPermissionsBoundaryRequest, config?: AxiosRequestConfig): AxiosPromise<DeleteUserPermissionsBoundaryResponse>;
/** 查询角色OIDC配置 {@link DescribeOIDCConfigRequest} {@link DescribeOIDCConfigResponse} */