{ "name": "organization", "display_name": "集团账号管理", "description": "介绍如何使用API对企业组织进行操作，包括获取企业组织单元列表、更新企业组织单元等。", "domain": "other", "api_version": "2021-03-31", "endpoint": "organization.tencentcloudapi.com", "actions": [ { "name": "AcceptJoinShareUnitInvitation", "description": "接受加入共享单元邀请。", "status": "online", "parameters": [ { "name": "UnitId", "type": "string", "required": true, "description": "共享单元ID。", "example": "shareUnit-xhreo**2p" } ], "required": [ "UnitId" ] }, { "name": "AddExternalSAMLIdPCertificate", "description": "添加SAML签名证书", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。", "example": "z-2js923necd***" }, { "name": "X509Certificate", "type": "string", "required": true, "description": "PEM 格式的 X509 证书。 由 SAML 身份提供商提供。", "example": "MIIBtjCCAVugAwIBAgITBmyf1XSXNmY/Owua2eiedgPySjAKBggqhkjOPQQDAjA5******" } ], "required": [ "ZoneId", "X509Certificate" ] }, { "name": "AddOrganizationMemberEmail", "description": "添加组织成员邮箱", "status": "online", "parameters": [ { "name": "MemberUin", "type": "integer", "required": true, "description": "成员Uin。", "example": "111111111111" }, { "name": "Email", "type": "string", "required": true, "description": "邮箱地址。", "example": "12***@qq.com" }, { "name": "CountryCode", "type": "string", "required": true, "description": "国际区号。", "example": "86" }, { "name": "Phone", "type": "string", "required": true, "description": "手机号。", "example": "18***11" } ], "required": [ "MemberUin", "Email", "CountryCode", "Phone" ] }, { "name": "AddOrganizationNode", "description": "添加企业组织节点", "status": "online", "parameters": [ { "name": "ParentNodeId", "type": "integer", "required": true, "description": "父节点ID。可以通过[DescribeOrganizationNodes](https://cloud.tencent.com/document/product/850/82926)获取", "example": "101" }, { "name": "Name", "type": "string", "required": true, "description": "节点名称。最大长度为40个字符，支持英文字母、数字、汉字、符号+@、\u0026._[]-", "example": "node_name" }, { "name": "Remark", "type": "string", "required": false, "description": "备注。", "example": "\"root node\"" }, { "name": "Tags", "type": "array", "required": false, "description": "部门标签列表。最大10个", "example": "[{\"TagKey\":\"key\",\"TagValue\":\"value\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] } ], "required": [ "ParentNodeId", "Name" ] }, { "name": "AddPermissionPolicyToRoleConfiguration", "description": "为权限配置添加策略", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID", "example": "z-29n23ien" }, { "name": "RoleConfigurationId", "type": "string", "required": true, "description": "权限配置 ID", "example": "rc-so2msow" }, { "name": "RolePolicyType", "type": "string", "required": true, "description": "权限策略类型。取值： System：系统策略。复用 CAM 的系统策略。 Custom: 自定义策略。按照 CAM 权限策略语法和结构编写的自定义策略。", "example": "System" }, { "name": "RolePolicyNames", "type": "array", "required": false, "description": "权限策略名称，长度最大为 20策略，每个策略长度最大32个字符。如果要添加系统策略，建议使用RolePolicies参数。自定义策略时，数组长度最大为1。", "example": "[\"TestPolicy\",\"Admin\"]", "item_type": "string" }, { "name": "RolePolicies", "type": "array", "required": false, "description": "添加的系统策略详情。", "example": "[{'PolicyId':426322, 'PolicyName':'QcloudAccessForOceanusRole'}]", "item_type": "object", "children": [ { "name": "PolicyId", "type": "integer", "required": true, "description": "策略ID。", "example": "426322" }, { "name": "PolicyName", "type": "string", "required": false, "description": "策略名称。", "example": "QcloudAccessForOceanusRole" } ] }, { "name": "CustomPolicyDocument", "type": "string", "required": false, "description": "自定义策略内容。长度：最大 4096 个字符。当RolePolicyType为Inline时，该参数必须配置。关于权限策略的语法和结构，请参见权限策略语法和结构。", "example": "{\\\"statement\\\":{\\\"action\\\":[\\\"name/cvm:*\\\",\\\"name/vpc:*\\\",\\\"name/cos:*\\\",\\\"name/cmqtopic:*\\\",\\\"name/cmqqueue:*\\\"],\\\"effect\\\":\\\"allow\\\",\\\"resource\\\":\\\"*\\\"},\\\"version\\\":\\\"2.0\\\"}" }, { "name": "CustomPolicyDocuments", "type": "array", "required": false, "description": "自定义策略内容列表（跟RolePolicyNames一一对应）", "example": "[ \"policyContent1\", \"policyContent2\" ]", "item_type": "string" } ], "required": [ "ZoneId", "RoleConfigurationId", "RolePolicyType" ] }, { "name": "AddShareUnit", "description": "创建共享单元。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "共享单元名称。仅支持大小写字母、数字、-、以及_的组合，3-128个字符。", "example": "myShareUnit" }, { "name": "Area", "type": "string", "required": true, "description": "共享单元地域。可通过接口[DescribeShareAreas](https://cloud.tencent.com/document/product/850/103050)获取支持共享的地域。", "example": "ap-guangzhou" }, { "name": "Description", "type": "string", "required": false, "description": "共享单元描述。最大128个字符。", "example": "share unit" }, { "name": "ShareScope", "type": "integer", "required": false, "description": "共享范围。取值：1-仅允许集团组织内共享 2-允许共享给任意账号，默认值：1", "example": "1" } ], "required": [ "Name", "Area" ] }, { "name": "AddShareUnitMembers", "description": "添加共享单元成员", "status": "online", "parameters": [ { "name": "UnitId", "type": "string", "required": true, "description": "共享单元ID。", "example": "shareUnit-xhre**ra2p" }, { "name": "Area", "type": "string", "required": true, "description": "共享单元地域。", "example": "ap-guangzhou" }, { "name": "Members", "type": "array", "required": true, "description": "共享成员列表。最大10个。", "example": "[{\"ShareMemberUin\": 333333333333}]", "item_type": "object", "children": [ { "name": "ShareMemberUin", "type": "integer", "required": true, "description": "共享成员Uin。", "example": "333333333333" } ] } ], "required": [ "UnitId", "Area", "Members" ] }, { "name": "AddShareUnitNode", "description": "添加共享单元部门", "status": "online", "parameters": [ { "name": "UnitId", "type": "string", "required": true, "description": "共享单元ID。", "example": "shareUnit-pj96**f0du" }, { "name": "NodeId", "type": "integer", "required": true, "description": "共享部门ID。", "example": "10001" } ], "required": [ "UnitId", "NodeId" ] }, { "name": "AddShareUnitResources", "description": "添加共享单元资源", "status": "online", "parameters": [ { "name": "UnitId", "type": "string", "required": true, "description": "共享单元ID。", "example": "shareUnit-xhre**ra2p" }, { "name": "Area", "type": "string", "required": true, "description": "共享单元地域。", "example": "ap-guangzhou" }, { "name": "Type", "type": "string", "required": true, "description": "共享资源类型。支持共享的资源类型,请参见[资源共享概述](https://cloud.tencent.com/document/product/850/59489)", "example": "secret" }, { "name": "Resources", "type": "array", "required": true, "description": "共享资源列表。最大10个。", "example": "[{\"ProductResourceId\":\"sec***002\"}]", "item_type": "object", "children": [ { "name": "ProductResourceId", "type": "string", "required": true, "description": "产品资源ID。", "example": "sec***002" } ] } ], "required": [ "UnitId", "Area", "Type", "Resources" ] }, { "name": "AddUserToGroup", "description": "为用户组添加用户", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-2d8shd8***" }, { "name": "GroupId", "type": "string", "required": true, "description": "用户组 ID。", "example": "g-2xdb82n8***" }, { "name": "UserId", "type": "string", "required": true, "description": "用户 ID。", "example": "u-28sh72be" } ], "required": [ "ZoneId", "GroupId", "UserId" ] }, { "name": "AttachPolicy", "description": "绑定策略", "status": "online", "parameters": [ { "name": "TargetId", "type": "integer", "required": true, "description": "绑定策略目标ID。成员Uin或部门ID", "example": "10001" }, { "name": "TargetType", "type": "string", "required": true, "description": "目标类型。取值范围：NODE-部门、MEMBER-成员", "example": "NODE" }, { "name": "PolicyId", "type": "integer", "required": true, "description": "策略Id。可以调用ListPolicies获取", "example": "100001" }, { "name": "Type", "type": "string", "required": false, "description": "策略类型。默认值SERVICE_CONTROL_POLICY，取值范围：SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略", "example": "SERVICE_CONTROL_POLICY" } ], "required": [ "TargetId", "TargetType", "PolicyId" ] }, { "name": "BindOrganizationMemberAuthAccount", "description": "绑定组织成员和组织管理员子账号的授权关系", "status": "online", "parameters": [ { "name": "MemberUin", "type": "integer", "required": true, "description": "成员Uin。", "example": "111111111111" }, { "name": "PolicyId", "type": "integer", "required": true, "description": "策略ID。可以调用[DescribeOrganizationMemberPolicies](https://cloud.tencent.com/document/product/850/82935)获取", "example": "101" }, { "name": "OrgSubAccountUins", "type": "array", "required": true, "description": "组织管理员子账号Uin列表。最大5个", "example": "[222222222222]", "item_type": "integer" } ], "required": [ "MemberUin", "PolicyId", "OrgSubAccountUins" ] }, { "name": "BindOrganizationPolicySubAccount", "description": "绑定成员访问授权策略和组织管理员子账号", "status": "online", "parameters": [ { "name": "PolicyId", "type": "integer", "required": true, "description": "策略ID。", "example": "10" }, { "name": "OrgSubAccountUins", "type": "array", "required": true, "description": "组织管理员子账号Uin列表。最大5个", "example": "[111111111111]", "item_type": "integer" } ], "required": [ "PolicyId", "OrgSubAccountUins" ] }, { "name": "CancelOrganizationMemberAuthAccount", "description": "取消组织成员和组织管理员子账号的授权关系", "status": "online", "parameters": [ { "name": "MemberUin", "type": "integer", "required": true, "description": "成员Uin。", "example": "111111111111" }, { "name": "PolicyId", "type": "integer", "required": true, "description": "策略ID。可以通过[DescribeOrganizationMemberPolicies](https://cloud.tencent.com/document/product/850/82935)获取", "example": "101" }, { "name": "OrgSubAccountUin", "type": "integer", "required": true, "description": "组织子账号Uin。", "example": "222222222222" } ], "required": [ "MemberUin", "PolicyId", "OrgSubAccountUin" ] }, { "name": "CancelOrganizationPolicySubAccount", "description": "解绑成员访问授权策略和组织管理员子账号", "status": "online", "parameters": [ { "name": "PolicyId", "type": "integer", "required": true, "description": "策略ID。", "example": "10" }, { "name": "OrgSubAccountUins", "type": "array", "required": true, "description": "组织管理员子账号Uin列表。最大5个", "example": "[111111111111]", "item_type": "integer" } ], "required": [ "PolicyId", "OrgSubAccountUins" ] }, { "name": "CheckAccountDelete", "description": "成员账号删除检查", "status": "online", "parameters": [ { "name": "MemberUin", "type": "integer", "required": true, "description": "成员Uin。", "example": "111111111111" } ], "required": [ "MemberUin" ] }, { "name": "ClearExternalSAMLIdentityProvider", "description": "清空SAML身份提供商配置信息", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。", "example": "z-2js923necd***" } ], "required": [ "ZoneId" ] }, { "name": "CreateGroup", "description": "创建用户组", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-23c3ad2wa" }, { "name": "GroupName", "type": "string", "required": true, "description": "用户组的名称。 格式：允许英文字母、数字和特殊字符-。 长度：最大 128 个字符。", "example": "TestGroup" }, { "name": "Description", "type": "string", "required": false, "description": "用户组的描述。 长度：最大 1024 个字符。", "example": "This is a group." }, { "name": "GroupType", "type": "string", "required": false, "description": "用户组类型 Manual：手动创建，Synchronized：外部导入", "example": "Manual" } ], "required": [ "ZoneId", "GroupName" ] }, { "name": "CreateOrgServiceAssign", "description": "添加集团服务委派管理员", "status": "online", "parameters": [ { "name": "MemberUins", "type": "array", "required": true, "description": "委派管理员Uin列表。 最大长度20个", "example": "[111111111111]", "item_type": "integer" }, { "name": "ServiceId", "type": "integer", "required": false, "description": "集团服务ID。和集团服务产品标识二选一必填，可以通过[ListOrganizationService](https://cloud.tencent.com/document/product/850/109561)获取", "example": "1" }, { "name": "Product", "type": "string", "required": false, "description": "集团服务产品标识。和集团服务ID二选一必填，可以通过[ListOrganizationService](https://cloud.tencent.com/document/product/850/109561)获取", "example": "cloudaudit" }, { "name": "ManagementScope", "type": "integer", "required": false, "description": "委派管理员管理范围。 取值：1-全部成员 2-部分成员，默认值1", "example": "1" }, { "name": "ManagementScopeUins", "type": "array", "required": false, "description": "管理的成员Uin列表。ManagementScope为2时该参数有效", "example": "[100000000001]", "item_type": "integer" }, { "name": "ManagementScopeNodeIds", "type": "array", "required": false, "description": "管理的部门ID列表。ManagementScope为2时该参数有效", "example": "[101]", "item_type": "integer" } ], "required": [ "MemberUins" ] }, { "name": "CreateOrganization", "description": "创建企业组织", "status": "online", "parameters": [], "required": [] }, { "name": "CreateOrganizationIdentity", "description": "添加组织身份", "status": "online", "parameters": [ { "name": "IdentityAliasName", "type": "string", "required": true, "description": "身份名称", "example": "admin_identity" }, { "name": "IdentityPolicy", "type": "array", "required": true, "description": "身份策略", "example": "[{ \"PolicyId\":1, \"PolicyName\":\"AdministratorAccess\" }]", "item_type": "object", "children": [ { "name": "PolicyId", "type": "integer", "required": false, "description": "CAM预设策略ID。PolicyType 为预设策略时有效且必选", "example": "1" }, { "name": "PolicyName", "type": "string", "required": false, "description": "CAM预设策略名称。PolicyType 为预设策略时有效且必选", "example": "AdministratorAccess" }, { "name": "PolicyType", "type": "integer", "required": false, "description": "策略类型。取值 1-自定义策略 2-预设策略；默认值2", "example": "2" }, { "name": "PolicyDocument", "type": "string", "required": false, "description": "自定义策略内容，遵循CAM策略语法。PolicyType 为自定义策略时有效且必选", "example": "{ \"version\": \"2.0\", \"statement\": [ { \"effect\": \"allow\", \"action\": [ \"vpc:*\" ], \"resource\": [ \"*\" ] } ] }" } ] }, { "name": "Description", "type": "string", "required": false, "description": "身份描述", "example": "\"admin identity\"" } ], "required": [ "IdentityAliasName", "IdentityPolicy" ] }, { "name": "CreateOrganizationMember", "description": "创建组织成员", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "成员名称。最大长度为25个字符，支持英文字母、数字、汉字、符号+@、\u0026._[]-:,", "example": "member_name" }, { "name": "PolicyType", "type": "string", "required": true, "description": "关系策略。取值：Financial", "example": "Financial" }, { "name": "PermissionIds", "type": "array", "required": true, "description": "成员财务权限ID列表。取值：1-查看账单、2-查看余额、3-资金划拨（若需要开启资金划拨权限，请联系您的商务经理内部开通。）、4-合并出账、5-开票、6-优惠继承、7-代付费、8-成本分析、9-预算管理、10-信用额度设置（若需要开启信用额度设置权限，请联系您的商务经理内部开通。），1、2 默认必须", "example": "[1,2]", "item_type": "integer" }, { "name": "NodeId", "type": "integer", "required": true, "description": "成员所属部门的节点ID。可以通过[DescribeOrganizationNodes](https://cloud.tencent.com/document/product/850/82926)获取", "example": "1001" }, { "name": "AccountName", "type": "string", "required": true, "description": "账号名称。最大长度为25个字符，支持英文字母、数字、汉字、符号+@、\u0026._[]-:,", "example": "member_name" }, { "name": "Remark", "type": "string", "required": false, "description": "备注。", "example": "create member" }, { "name": "RecordId", "type": "integer", "required": false, "description": "成员创建记录ID。创建异常重试时需要", "example": "0" }, { "name": "PayUin", "type": "string", "required": false, "description": "代付者Uin。成员代付费时需要", "example": "100000000001" }, { "name": "IdentityRoleID", "type": "array", "required": false, "description": "成员访问身份ID列表。可以调用ListOrganizationIdentity获取，1默认支持", "example": "[1]", "item_type": "integer" }, { "name": "AuthRelationId", "type": "integer", "required": false, "description": "认证主体关系ID。给不同主体创建成员时需要，可以调用DescribeOrganizationAuthNode获取", "example": "0" }, { "name": "Tags", "type": "array", "required": false, "description": "成员标签列表。最大10个", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] } ], "required": [ "Name", "PolicyType", "PermissionIds", "NodeId", "AccountName" ] }, { "name": "CreateOrganizationMemberAuthIdentity", "description": "添加组织成员访问授权", "status": "online", "parameters": [ { "name": "MemberUins", "type": "array", "required": true, "description": "成员Uin列表。最多10个", "example": "[111111111111]", "item_type": "integer" }, { "name": "IdentityIds", "type": "array", "required": true, "description": "身份Id列表。最多5个，可以通过[ListOrganizationIdentity](https://cloud.tencent.com/document/product/850/82934)获取", "example": "[13]", "item_type": "integer" } ], "required": [ "MemberUins", "IdentityIds" ] }, { "name": "CreateOrganizationMemberPolicy", "description": "创建组织成员访问授权策略", "status": "online", "parameters": [ { "name": "MemberUin", "type": "integer", "required": true, "description": "成员Uin。", "example": "111111111111" }, { "name": "PolicyName", "type": "string", "required": true, "description": "策略名。最大长度为128个字符，支持英文字母、数字、符号+=,.@_-", "example": "policy_name" }, { "name": "IdentityId", "type": "integer", "required": true, "description": "成员访问身份ID。可以调用[DescribeOrganizationMemberAuthIdentities](https://cloud.tencent.com/document/product/850/82936)获取", "example": "101" }, { "name": "Description", "type": "string", "required": false, "description": "描述。", "example": "description" } ], "required": [ "MemberUin", "PolicyName", "IdentityId" ] }, { "name": "CreateOrganizationMembersPolicy", "description": "创建组织成员访问策略", "status": "online", "parameters": [ { "name": "MemberUins", "type": "array", "required": true, "description": "成员Uin列表。最多10个", "example": "[111111111111]", "item_type": "integer" }, { "name": "PolicyName", "type": "string", "required": true, "description": "策略名。长度1～128个字符，支持英文字母、数字、符号+=,.@_-", "example": "policy_name" }, { "name": "IdentityId", "type": "integer", "required": true, "description": "成员访问身份ID。可以通过[ListOrganizationIdentity](https://cloud.tencent.com/document/product/850/82934)获取", "example": "101" }, { "name": "Description", "type": "string", "required": false, "description": "策略描述。最大长度为128个字符", "example": "description" } ], "required": [ "MemberUins", "PolicyName", "IdentityId" ] }, { "name": "CreatePolicy", "description": "创建一个特殊类型的策略，您可以关联到企业组织Root节点、企业部门节点或者企业的成员账号。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "策略名。 长度为1~128个字符，可以包含汉字、英文字母、数字和下划线（_）", "example": "FullAccessPolicy" }, { "name": "Content", "type": "string", "required": true, "description": "策略内容。参考CAM策略语法", "example": "{\"version\":\"2.0\",\"statement\":[{\"effect\":\"allow\",\"action\":\"*\",\"resource\":\"*\"}]}" }, { "name": "Type", "type": "string", "required": true, "description": "策略类型。默认值SERVICE_CONTROL_POLICY，取值范围：SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略", "example": "SERVICE_CONTROL_POLICY" }, { "name": "Description", "type": "string", "required": false, "description": "策略描述。", "example": "全读写权限" } ], "required": [ "Name", "Content", "Type" ] }, { "name": "CreateRoleAssignment", "description": "在成员账号上授权", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-00fc2p61****" }, { "name": "RoleAssignmentInfo", "type": "array", "required": false, "description": "授权成员账号信息，最多授权50条。", "example": "无", "item_type": "object", "children": [ { "name": "PrincipalId", "type": "string", "required": false, "description": "CAM 用户同步的身份 ID。取值： 当PrincipalType取值为Group时，该值为CIC用户组 ID（g-********）。 当PrincipalType取值为User时，该值为CIC用户 ID（u-********）。", "example": "u-xuec8dnd" }, { "name": "PrincipalType", "type": "string", "required": false, "description": "CAM 用户同步的身份类型。取值： User：表示该 CAM 用户同步的身份是CIC用户。 Group：表示该 CAM 用户同步的身份是CIC用户组。", "example": "User" }, { "name": "TargetUin", "type": "integer", "required": false, "description": "同步集团账号目标账号的UIN。", "example": "100003829343" }, { "name": "TargetType", "type": "string", "required": false, "description": "同步集团账号目标账号的类型，ManagerUin管理账号;MemberUin成员账号", "example": "MemberUin" }, { "name": "RoleConfigurationId", "type": "string", "required": false, "description": "权限配置ID。", "example": "rc-s82nd93ne***" } ] } ], "required": [ "ZoneId" ] }, { "name": "CreateRoleConfiguration", "description": "创建权限配置", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-232ns223s" }, { "name": "RoleConfigurationName", "type": "string", "required": true, "description": "权限配置名称。格式：包含英文字母、数字或短划线（-）。 长度：最大 128 个字符。", "example": "conf1" }, { "name": "Description", "type": "string", "required": false, "description": "权限配置的描述。 长度：最大 1024 个字符。", "example": "this is role configuration" }, { "name": "SessionDuration", "type": "integer", "required": false, "description": "会话持续时间。 CIC用户使用权限配置访问集团账号目标账号时，会话最多保持的时间。 单位：秒。 取值范围：900 ~ 43200（15 分钟~12 小时）。 默认值：3600（1 小时）。", "example": "900" }, { "name": "RelayState", "type": "string", "required": false, "description": "初始访问页面。 CIC用户使用权限配置访问集团账号目标账号时，初始访问的页面地址。 该页面必须是腾讯云控制台页面。默认为空，表示跳转到腾讯云控制台首页。", "example": "https://console.cloud.tencent.com" } ], "required": [ "ZoneId", "RoleConfigurationName" ] }, { "name": "CreateSCIMCredential", "description": "创建SCIM密钥", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。z-前缀开头，后面是12位随机数字/小写字母", "example": "z-00fdsg****" }, { "name": "ExpireDuration", "type": "integer", "required": false, "description": "过期时间（秒），最小1小时，最大99年。如果不传则默认一年过期", "example": "3600" } ], "required": [ "ZoneId" ] }, { "name": "CreateUser", "description": "创建用户", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-00fc2p61****" }, { "name": "UserName", "type": "string", "required": true, "description": "用户名称。空间内必须唯一。不支持修改。 格式：包含数字、英文字母和特殊符号+ = , . @ - _ 。 长度：最大 64 个字符", "example": "Alice" }, { "name": "FirstName", "type": "string", "required": false, "description": "用户的姓。 长度：最大 64 个字符。", "example": "Alice" }, { "name": "LastName", "type": "string", "required": false, "description": "用户的名。 长度：最大 64 个字符。", "example": "Alice" }, { "name": "DisplayName", "type": "string", "required": false, "description": "用户的显示名称。 长度：最大 256 个字符。", "example": "Alice" }, { "name": "Description", "type": "string", "required": false, "description": "用户的描述。 长度：最大 1024 个字符。", "example": "This is a user." }, { "name": "Email", "type": "string", "required": false, "description": "用户的电子邮箱。目录内必须唯一。 长度：最大 128 个字符。", "example": "Alice@example.com" }, { "name": "UserStatus", "type": "string", "required": false, "description": "用户的状态。取值： Enabled（默认值）：启用。 Disabled：禁用。", "example": "Enabled" }, { "name": "UserType", "type": "string", "required": false, "description": "用户类型 Manual：手动创建，Synchronized：外部导入", "example": "Manual" }, { "name": "NeedResetPassword", "type": "boolean", "required": false, "description": "是否需要重置密码： true: 需要重置 false: 不需要重置密码。 默认false", "example": "true" } ], "required": [ "ZoneId", "UserName" ] }, { "name": "CreateUserSyncProvisioning", "description": "创建子用户同步任务", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。", "example": "z-d8wj832n***" }, { "name": "UserSyncProvisionings", "type": "array", "required": true, "description": "CAM用户同步信息。", "example": "无", "item_type": "object", "children": [ { "name": "Description", "type": "string", "required": false, "description": "描述。", "example": "this is cam user provisioning" }, { "name": "PrincipalId", "type": "string", "required": false, "description": "CAM 用户同步的身份 ID。取值： 当PrincipalType取值为Group时，该值为CIC用户组 ID（g-********）。 当PrincipalType取值为User时，该值为CIC用户 ID（u-********）。", "example": "u-xuec8dnd" }, { "name": "PrincipalType", "type": "string", "required": false, "description": "CAM 用户同步的身份类型。取值： User：表示该 CAM 用户同步的身份是CIC用户。 Group：表示该 CAM 用户同步的身份是CIC用户组。", "example": "User" }, { "name": "TargetUin", "type": "integer", "required": false, "description": "同步的集团账号目标账号的UIN。", "example": "100003829343" }, { "name": "DuplicationStrategy", "type": "string", "required": false, "description": "冲突策略。当CIC 用户同步到 CAM 时，如果 CAM 中存在同名用户时的处理策略。取值： KeepBoth：两者都保留。当CIC 用户被同步到 CAM 时，如果 CAM 已经存在同名用户，则对CIC 用户的用户名添加后缀_cic后尝试创建该用户名的 CAM 用户。 TakeOver：替换。当CIC 用户被同步到 CAM 时，如果 CAM 已经存在同名用户，则直接将已经存在的 CAM 用户替换为CIC 同步用户。", "example": "KeepBoth" }, { "name": "DeletionStrategy", "type": "string", "required": false, "description": "删除策略。删除 CAM 用户同步时，对已同步的 CAM 用户的处理策略。取值： Delete：删除。删除 CAM 用户同步时，会删除从CIC 已经同步到 CAM 中的 CAM 用户。 Keep：保留。删除 RAM 用户同步时，会保留从CIC 已经同步到 CAM 中的 CAM 用户。", "example": "Delete" }, { "name": "TargetType", "type": "string", "required": false, "description": "同步的集团账号目标账号的类型，ManagerUin管理账号;MemberUin成员账号", "example": "MemberUin" } ] } ], "required": [ "ZoneId", "UserSyncProvisionings" ] }, { "name": "DeleteAccount", "description": "删除成员账号", "status": "online", "parameters": [ { "name": "MemberUin", "type": "integer", "required": true, "description": "成员Uin。", "example": "111111111111" } ], "required": [ "MemberUin" ] }, { "name": "DeleteGroup", "description": "删除用户组", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-3ds8dgs8***" }, { "name": "GroupId", "type": "string", "required": true, "description": "用户组的 ID。", "example": "g-2e92j39n" } ], "required": [ "ZoneId", "GroupId" ] }, { "name": "DeleteOrgServiceAssign", "description": "删除集团服务委派管理员", "status": "online", "parameters": [ { "name": "MemberUin", "type": "integer", "required": true, "description": "委派管理员Uin。", "example": "111111111111" }, { "name": "ServiceId", "type": "integer", "required": false, "description": "集团服务ID。和集团服务产品标识二选一必填，可以通过[ListOrganizationService](https://cloud.tencent.com/document/product/850/109561)获取", "example": "1" }, { "name": "Product", "type": "string", "required": false, "description": "集团服务产品标识。和集团服务ID二选一必填，可以通过[ListOrganizationService](https://cloud.tencent.com/document/product/850/109561)获取", "example": "cloudaudit" } ], "required": [ "MemberUin" ] }, { "name": "DeleteOrganization", "description": "删除企业组织", "status": "online", "parameters": [], "required": [] }, { "name": "DeleteOrganizationIdentity", "description": "删除组织身份", "status": "online", "parameters": [ { "name": "IdentityId", "type": "integer", "required": true, "description": "身份ID。可以通过[ListOrganizationIdentity](https://cloud.tencent.com/document/product/850/82934)获取", "example": "1" } ], "required": [ "IdentityId" ] }, { "name": "DeleteOrganizationMemberAuthIdentity", "description": "删除组织成员访问授权", "status": "online", "parameters": [ { "name": "MemberUin", "type": "integer", "required": true, "description": "成员Uin。", "example": "111111111111" }, { "name": "IdentityId", "type": "integer", "required": true, "description": "身份ID。可以通过[ListOrganizationIdentity](https://cloud.tencent.com/document/product/850/82934)获取", "example": "11" } ], "required": [ "MemberUin", "IdentityId" ] }, { "name": "DeleteOrganizationMembers", "description": "从组织中移除成员账号，不会删除账号。", "status": "online", "parameters": [ { "name": "MemberUin", "type": "array", "required": true, "description": "被删除成员的Uin列表。", "example": "[111111111111]", "item_type": "integer" } ], "required": [ "MemberUin" ] }, { "name": "DeleteOrganizationMembersPolicy", "description": "删除组织成员访问策略", "status": "online", "parameters": [ { "name": "PolicyId", "type": "integer", "required": true, "description": "访问策略ID。可以通过[DescribeOrganizationMemberPolicies](https://cloud.tencent.com/document/product/850/82935)获取", "example": "1001" } ], "required": [ "PolicyId" ] }, { "name": "DeleteOrganizationNodes", "description": "批量删除企业组织节点", "status": "online", "parameters": [ { "name": "NodeId", "type": "array", "required": true, "description": "节点ID列表。可以通过[DescribeOrganizationNodes](https://cloud.tencent.com/document/product/850/82926)获取", "example": "[1001]", "item_type": "integer" } ], "required": [ "NodeId" ] }, { "name": "DeletePolicy", "description": "删除策略", "status": "online", "parameters": [ { "name": "PolicyId", "type": "integer", "required": true, "description": "需要删除的策略ID。可以调用[ListPolicies](https://cloud.tencent.com/document/product/850/105311)获取", "example": "100001" }, { "name": "Type", "type": "string", "required": false, "description": "策略类型。默认值SERVICE_CONTROL_POLICY，取值范围：SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略", "example": "SERVICE_CONTROL_POLICY" } ], "required": [ "PolicyId" ] }, { "name": "DeleteRoleAssignment", "description": "移除成员账号上的授权", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-00fc2p61****" }, { "name": "RoleConfigurationId", "type": "string", "required": true, "description": "权限配置ID。", "example": "rc-sisjdia" }, { "name": "TargetType", "type": "string", "required": true, "description": "同步的集团账号目标账号的类型，ManagerUin管理账号;MemberUin成员账号", "example": "MemberUin" }, { "name": "TargetUin", "type": "integer", "required": true, "description": "集团账号目标账号的UIN", "example": "10003i32i2" }, { "name": "PrincipalType", "type": "string", "required": true, "description": "CAM 用户同步的身份类型。取值： User：表示同步的身份是用户。 Group：表示同步的身份是用户组。", "example": "User" }, { "name": "PrincipalId", "type": "string", "required": true, "description": "用户同步 ID。取值： 当PrincipalType取值为Group时，该值为用户组 ID（g-********）， 当PrincipalType取值为User时，该值为用户 ID（u-********）。", "example": "u-sniassda****" }, { "name": "DeprovisionStrategy", "type": "string", "required": false, "description": "当您移除一个集团账号目标账号上使用某权限配置的最后一个授权时，是否同时解除权限配置部署。取值： DeprovisionForLastRoleAssignmentOnAccount：解除权限配置部署。 None（默认值）：不解除权限配置部署。", "example": "None" } ], "required": [ "ZoneId", "RoleConfigurationId", "TargetType", "TargetUin", "PrincipalType", "PrincipalId" ] }, { "name": "DeleteRoleConfiguration", "description": "删除权限配置信息", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID", "example": "z-29n23ien" }, { "name": "RoleConfigurationId", "type": "string", "required": true, "description": "权限配置 ID", "example": "rc-so2msow" } ], "required": [ "ZoneId", "RoleConfigurationId" ] }, { "name": "DeleteSCIMCredential", "description": "删除SCIM密钥", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。z-前缀开头，后面是12位随机数字/小写字母", "example": "z-00fdsg****" }, { "name": "CredentialId", "type": "string", "required": true, "description": "SCIM密钥ID。scimcred-前缀开头，后面是12位随机数字/小写字母。", "example": "scimcred-lkj****" } ], "required": [ "ZoneId", "CredentialId" ] }, { "name": "DeleteShareUnit", "description": "删除共享单元。", "status": "online", "parameters": [ { "name": "UnitId", "type": "string", "required": true, "description": "共享单元ID。", "example": "shareUnit-xhreo**2p" } ], "required": [ "UnitId" ] }, { "name": "DeleteShareUnitMembers", "description": "删除共享单元成员", "status": "online", "parameters": [ { "name": "UnitId", "type": "string", "required": true, "description": "共享单元ID。", "example": "shareUnit-xhre**ra2p" }, { "name": "Area", "type": "string", "required": true, "description": "共享单元地域。", "example": "ap-guangzhou" }, { "name": "Members", "type": "array", "required": true, "description": "成员列表。", "example": "[\"ShareMemberUin\": 333333333333]", "item_type": "object", "children": [ { "name": "ShareMemberUin", "type": "integer", "required": true, "description": "共享成员Uin。", "example": "333333333333" } ] } ], "required": [ "UnitId", "Area", "Members" ] }, { "name": "DeleteShareUnitNode", "description": "删除共享单元部门", "status": "online", "parameters": [ { "name": "UnitId", "type": "string", "required": true, "description": "共享单元ID。", "example": "shareUnit-pj96**f0du" }, { "name": "NodeId", "type": "integer", "required": true, "description": "部门ID。", "example": "10001" } ], "required": [ "UnitId", "NodeId" ] }, { "name": "DeleteShareUnitResources", "description": "删除共享单元资源", "status": "online", "parameters": [ { "name": "UnitId", "type": "string", "required": true, "description": "共享单元ID。", "example": "shareUnit-xhre**ra2p" }, { "name": "Area", "type": "string", "required": true, "description": "共享单元地域。", "example": "ap-guangzhou" }, { "name": "Type", "type": "string", "required": true, "description": "共享资源类型。支持共享的资源类型,请参见[资源共享概述](https://cloud.tencent.com/document/product/850/59489)", "example": "secret" }, { "name": "Resources", "type": "array", "required": true, "description": "共享资源列表。最大10个。", "example": "[{\"ProductResourceId\":\"sec***002\"}]", "item_type": "object", "children": [ { "name": "ProductResourceId", "type": "string", "required": false, "description": "产品资源ID。", "example": "sec***002" } ] } ], "required": [ "UnitId", "Area", "Type", "Resources" ] }, { "name": "DeleteUser", "description": "删除用户", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-33isn3ie**" }, { "name": "UserId", "type": "string", "required": true, "description": "用户 ID。", "example": "u-34nesn3u" } ], "required": [ "ZoneId", "UserId" ] }, { "name": "DeleteUserSyncProvisioning", "description": "删除子用户同步任务", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。", "example": "z-d8wj832n***" }, { "name": "UserProvisioningId", "type": "string", "required": true, "description": "用户同步的ID。", "example": "up-sjisnw8ois" } ], "required": [ "ZoneId", "UserProvisioningId" ] }, { "name": "DescribeEffectivePolicy", "description": "查询目标关联的有效策略", "status": "online", "parameters": [ { "name": "TargetId", "type": "integer", "required": true, "description": "账号uin或者节点id。", "example": "10001" } ], "required": [ "TargetId" ] }, { "name": "DescribeIdentityCenter", "description": "获取集团账号身份中心服务信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeOrganization", "description": "获取企业组织信息", "status": "online", "parameters": [ { "name": "Lang", "type": "string", "required": false, "description": "国际站：en，国内站：zh", "example": "en" }, { "name": "Product", "type": "string", "required": false, "description": "可信服务产品简称。查询是否该可信服务管理员时必须指定", "example": "config" } ], "required": [] }, { "name": "DescribeOrganizationAuthNode", "description": "获取已设置管理员的互信主体关系列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。取值是limit的整数倍。默认值 : 0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目。取值范围：1~50。默认值：10。", "example": "10" }, { "name": "AuthName", "type": "string", "required": false, "description": "互信主体名称。", "example": "auth_name" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeOrganizationFinancialByMember", "description": "以成员维度获取组织财务信息", "status": "online", "parameters": [ { "name": "Month", "type": "string", "required": true, "description": "查询开始月份。格式：yyyy-mm，例如：2021-01。", "example": "2021-01" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制数目。取值范围：1~50，默认值：10", "example": "5" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。取值是limit的整数倍，默认值 : 0", "example": "0" }, { "name": "EndMonth", "type": "string", "required": false, "description": "查询结束月份。格式：yyyy-mm，例如：2021-01,默认值为查询开始月份。", "example": "2021-05" }, { "name": "MemberUins", "type": "array", "required": false, "description": "查询成员列表。 最大100个", "example": "[100000000001]", "item_type": "integer" }, { "name": "ProductCodes", "type": "array", "required": false, "description": "查询产品列表。 最大100个", "example": "[p_cvm]", "item_type": "string" } ], "required": [ "Month" ] }, { "name": "DescribeOrganizationFinancialByMonth", "description": "以月维度获取组织财务信息趋势", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "查询月数。取值范围：1~6，默认值：6", "example": "5" }, { "name": "EndMonth", "type": "string", "required": false, "description": "查询结束月份。格式：yyyy-mm，例如：2021-01", "example": "2023-01" }, { "name": "MemberUins", "type": "array", "required": false, "description": "查询成员列表。 最大100个", "example": "[100000000001]", "item_type": "integer" }, { "name": "ProductCodes", "type": "array", "required": false, "description": "查询产品列表。 最大100个", "example": "[p_cvm]", "item_type": "string" } ], "required": [] }, { "name": "DescribeOrganizationFinancialByProduct", "description": "以产品维度获取组织财务信息", "status": "online", "parameters": [ { "name": "Month", "type": "string", "required": true, "description": "查询开始月份。格式：yyyy-mm，例如：2021-01", "example": "2021-01" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制数目。取值范围：1~50，默认值：10", "example": "5" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。取值是limit的整数倍，默认值 : 0", "example": "0" }, { "name": "EndMonth", "type": "string", "required": false, "description": "查询结束月份。格式：yyyy-mm，例如：2021-01,默认值为查询开始月份", "example": "2021-01" }, { "name": "MemberUins", "type": "array", "required": false, "description": "查询成员列表。 最大100个", "example": "[100000000001]", "item_type": "integer" }, { "name": "ProductCodes", "type": "array", "required": false, "description": "查询产品列表。 最大100个", "example": "[p_cvm]", "item_type": "string" } ], "required": [ "Month" ] }, { "name": "DescribeOrganizationMemberAuthAccounts", "description": "获取组织成员被绑定授权关系的子账号列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。取值是limit的整数倍。默认值 : 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目。取值范围：1~50。默认值：10。", "example": "10" }, { "name": "MemberUin", "type": "integer", "required": true, "description": "成员Uin。", "example": "111111111111" }, { "name": "PolicyId", "type": "integer", "required": true, "description": "策略ID。可以通过[DescribeOrganizationMemberPolicies](https://cloud.tencent.com/document/product/850/82935)获取", "example": "1001" } ], "required": [ "Offset", "Limit", "MemberUin", "PolicyId" ] }, { "name": "DescribeOrganizationMemberAuthIdentities", "description": "获取组织成员访问授权列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。取值是limit的整数倍，默认值 : 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目。取值范围：1~50，默认值：10", "example": "10" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "组织成员Uin。入参MemberUin与IdentityId至少填写一个", "example": "11111111111" }, { "name": "IdentityId", "type": "integer", "required": false, "description": "身份ID。入参MemberUin与IdentityId至少填写一个, 可以通过[ListOrganizationIdentity](https://cloud.tencent.com/document/product/850/82934)获取", "example": "1" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeOrganizationMemberEmailBind", "description": "查询成员邮箱绑定详细信息", "status": "online", "parameters": [ { "name": "MemberUin", "type": "integer", "required": true, "description": "成员Uin。", "example": "111111111111" } ], "required": [ "MemberUin" ] }, { "name": "DescribeOrganizationMemberPolicies", "description": "获取组织成员的授权策略列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。取值是limit的整数倍。默认值 : 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目。取值范围：1~50。默认值：10。", "example": "10" }, { "name": "MemberUin", "type": "integer", "required": true, "description": "成员Uin。", "example": "111111111111" }, { "name": "SearchKey", "type": "string", "required": false, "description": "搜索关键字。可用于策略名或描述搜索", "example": "policy_name" } ], "required": [ "Offset", "Limit", "MemberUin" ] }, { "name": "DescribeOrganizationMembers", "description": "获取企业组织成员列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。取值是limit的整数倍，默认值 : 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目。取值范围：1~50，默认值：10", "example": "10" }, { "name": "Lang", "type": "string", "required": false, "description": "国际站：en，国内站：zh", "example": "zh" }, { "name": "SearchKey", "type": "string", "required": false, "description": "成员名称或者成员ID搜索。", "example": "member_name" }, { "name": "AuthName", "type": "string", "required": false, "description": "主体名称搜索。", "example": "auth_name" }, { "name": "Product", "type": "string", "required": false, "description": "可信服务产品简称。可信服务管理员查询时必须指定", "example": "config" }, { "name": "Tags", "type": "array", "required": false, "description": "成员标签搜索列表，最大10个", "example": "[{\"TagKey\":\"key\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] }, { "name": "NodeId", "type": "integer", "required": false, "description": "组织单元ID", "example": "1001" }, { "name": "NodeName", "type": "string", "required": false, "description": "组织单元名称", "example": "node_name" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeOrganizationMembersAuthPolicy", "description": "查询组织成员访问策略列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。取值是limit的整数倍。默认值 : 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目。取值范围：1~50。默认值：10。", "example": "10" }, { "name": "MemberUin", "type": "integer", "required": false, "description": "成员uin。", "example": "0" }, { "name": "OrgSubAccountUin", "type": "integer", "required": false, "description": "集团管理员子账号uin。", "example": "0" }, { "name": "PolicyId", "type": "integer", "required": false, "description": "成员访问策略Id。", "example": "0" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeOrganizationNodes", "description": "获取组织节点列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "限制数目。最大50", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。取值是limit的整数倍。默认值 : 0。", "example": "0" }, { "name": "Tags", "type": "array", "required": false, "description": "部门标签搜索列表，最大10个", "example": "[\"TagKey\":\"key\"]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribePolicy", "description": "本接口（DescribePolicy）可用于查询查看策略详情。", "status": "online", "parameters": [ { "name": "PolicyId", "type": "integer", "required": true, "description": "策略Id。可以调用[ListPolicies](https://cloud.tencent.com/document/product/850/105311)获取", "example": "10001" }, { "name": "PolicyType", "type": "string", "required": false, "description": "策略类型。默认值SERVICE_CONTROL_POLICY，取值范围：SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略", "example": "SERVICE_CONTROL_POLICY" } ], "required": [ "PolicyId" ] }, { "name": "DescribePolicyConfig", "description": "本接口（DescribePolicyConfig）可用于查询企业组织策略配置", "status": "online", "parameters": [ { "name": "OrganizationId", "type": "integer", "required": true, "description": "企业组织Id。可以调用[DescribeOrganization](https://cloud.tencent.com/document/product/850/67059)获取", "example": "80001" }, { "name": "Type", "type": "integer", "required": false, "description": "策略类型。默认值0，取值范围：0-服务控制策略、1-标签策略", "example": "0" } ], "required": [ "OrganizationId" ] }, { "name": "DescribeResourceToShareMember", "description": "获取与我共享的资源列表。", "status": "online", "parameters": [ { "name": "Area", "type": "string", "required": true, "description": "共享地域。可通过接口[DescribeShareAreas](https://cloud.tencent.com/document/product/850/103050)获取支持共享的地域。", "example": "ap-guangzhou" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。取值是limit的整数倍。默认值 : 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目。取值范围：1~50。", "example": "10" }, { "name": "SearchKey", "type": "string", "required": false, "description": "搜索关键字，支持业务资源ID搜索。", "example": "sec***002" }, { "name": "Type", "type": "string", "required": false, "description": "共享资源类型。支持共享的资源类型,请参见[资源共享概述](https://cloud.tencent.com/document/product/850/59489)", "example": "secret" }, { "name": "ProductResourceIds", "type": "array", "required": false, "description": "业务资源ID。最大50个", "example": "[\"sec***002\"]", "item_type": "string" } ], "required": [ "Area", "Offset", "Limit" ] }, { "name": "DescribeShareAreas", "description": "获取可共享地域列表", "status": "online", "parameters": [ { "name": "Lang", "type": "string", "required": false, "description": "国际站：en，国内站：zh", "example": "zh" } ], "required": [] }, { "name": "DescribeShareUnitMembers", "description": "获取共享单元成员列表。", "status": "online", "parameters": [ { "name": "UnitId", "type": "string", "required": true, "description": "共享单元ID。", "example": "shareUnit-xhre**ra2p" }, { "name": "Area", "type": "string", "required": true, "description": "共享单元地域。", "example": "ap-guangzhou" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。取值是limit的整数倍，默认值 : 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目。取值范围：1~50。", "example": "10" }, { "name": "SearchKey", "type": "string", "required": false, "description": "搜索关键字。支持成员Uin搜索。", "example": "333333333333" } ], "required": [ "UnitId", "Area", "Offset", "Limit" ] }, { "name": "DescribeShareUnitNodes", "description": "获取共享单元部门列表。", "status": "online", "parameters": [ { "name": "UnitId", "type": "string", "required": true, "description": "共享单元ID。", "example": "shareUnit-pj9**1f0du" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。取值是limit的整数倍，默认值 : 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目。取值范围：1~50。", "example": "10" }, { "name": "SearchKey", "type": "string", "required": false, "description": "搜索关键字。支持部门ID搜索。", "example": "10001" } ], "required": [ "UnitId", "Offset", "Limit" ] }, { "name": "DescribeShareUnitResources", "description": "获取共享单元资源列表。", "status": "online", "parameters": [ { "name": "UnitId", "type": "string", "required": true, "description": "共享单元ID。", "example": "shareUnit-xhre**ra2p" }, { "name": "Area", "type": "string", "required": true, "description": "共享单元地域。", "example": "ap-guangzhou" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。取值是limit的整数倍，默认值 : 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目。取值范围：1~50。", "example": "10" }, { "name": "SearchKey", "type": "string", "required": false, "description": "搜索关键字。支持产品资源ID搜索。", "example": "sec***002" }, { "name": "Type", "type": "string", "required": false, "description": "共享资源类型。支持共享的资源类型,请参见[资源共享概述](https://cloud.tencent.com/document/product/850/59489)", "example": "secret" } ], "required": [ "UnitId", "Area", "Offset", "Limit" ] }, { "name": "DescribeShareUnits", "description": "获取共享单元列表。", "status": "online", "parameters": [ { "name": "Area", "type": "string", "required": true, "description": "共享单元地域。可通过接口[DescribeShareAreas](https://cloud.tencent.com/document/product/850/103050)获取支持共享的地域。", "example": "ap-guangzhou" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。取值是limit的整数倍。默认值 : 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目。取值范围：1~50。", "example": "10" }, { "name": "SearchKey", "type": "string", "required": false, "description": "搜索关键字。支持UnitId和Name搜索。", "example": "myShareUnit" } ], "required": [ "Area", "Offset", "Limit" ] }, { "name": "DetachPolicy", "description": "解绑策略", "status": "online", "parameters": [ { "name": "TargetId", "type": "integer", "required": true, "description": "解绑策略目标ID。成员Uin或部门ID", "example": "10001" }, { "name": "TargetType", "type": "string", "required": true, "description": "目标类型。取值范围：NODE-部门、MEMBER-成员", "example": "NODE" }, { "name": "PolicyId", "type": "integer", "required": true, "description": "策略Id。可以调用ListPolicies获取", "example": "100001" }, { "name": "Type", "type": "string", "required": false, "description": "策略类型。默认值SERVICE_CONTROL_POLICY，取值范围：SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略", "example": "SERVICE_CONTROL_POLICY" } ], "required": [ "TargetId", "TargetType", "PolicyId" ] }, { "name": "DisablePolicyType", "description": "禁用策略类型", "status": "online", "parameters": [ { "name": "OrganizationId", "type": "integer", "required": true, "description": "企业组织Id。可以调用[DescribeOrganization](https://cloud.tencent.com/document/product/850/67059)获取", "example": "80001" }, { "name": "PolicyType", "type": "string", "required": true, "description": "策略类型。默认值SERVICE_CONTROL_POLICY，取值范围：SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略", "example": "SERVICE_CONTROL_POLICY" } ], "required": [ "OrganizationId", "PolicyType" ] }, { "name": "DismantleRoleConfiguration", "description": "解除权限配置在成员账号上的部署", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-00fc2p61****" }, { "name": "RoleConfigurationId", "type": "string", "required": true, "description": "权限配置ID。", "example": "rc-sisjdia" }, { "name": "TargetType", "type": "string", "required": true, "description": "同步的集团账号目标账号的类型，ManagerUin管理账号;MemberUin成员账号。", "example": "MemberUin" }, { "name": "TargetUin", "type": "integer", "required": true, "description": "同步的集团账号目标账号的UIN。", "example": "10003i32i2" } ], "required": [ "ZoneId", "RoleConfigurationId", "TargetType", "TargetUin" ] }, { "name": "EnablePolicyType", "description": "启用策略类型", "status": "online", "parameters": [ { "name": "OrganizationId", "type": "integer", "required": true, "description": "企业组织Id。可以调用[DescribeOrganization](https://cloud.tencent.com/document/product/850/67059)获取", "example": "80001" }, { "name": "PolicyType", "type": "string", "required": true, "description": "策略类型。默认值SERVICE_CONTROL_POLICY，取值范围：SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略", "example": "SERVICE_CONTROL_POLICY" } ], "required": [ "OrganizationId", "PolicyType" ] }, { "name": "GetExternalSAMLIdentityProvider", "description": "查询SAML身份提供商配置信息", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。", "example": "z-2js923necd***" } ], "required": [ "ZoneId" ] }, { "name": "GetGroup", "description": "查询用户组信息", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-23s8xh7sd***" }, { "name": "GroupId", "type": "string", "required": true, "description": "用户组的 ID。", "example": "g-sd8sh8sdno***" } ], "required": [ "ZoneId", "GroupId" ] }, { "name": "GetProvisioningTaskStatus", "description": "查询用户同步异步任务的状态", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。", "example": "z-2s9j28****" }, { "name": "TaskId", "type": "string", "required": true, "description": "任务ID。", "example": "t-x8jd983n****" } ], "required": [ "ZoneId", "TaskId" ] }, { "name": "GetRoleConfiguration", "description": "查询权限配置信息", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID", "example": "z-28sn28s***" }, { "name": "RoleConfigurationId", "type": "string", "required": true, "description": "权限配置ID", "example": "rc-2e29scc***" } ], "required": [ "ZoneId", "RoleConfigurationId" ] }, { "name": "GetSCIMSynchronizationStatus", "description": "获取SCIM同步状态", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。z-前缀开头，后面是12位随机数字/小写字母", "example": "z-00fdsg****" } ], "required": [ "ZoneId" ] }, { "name": "GetTaskStatus", "description": "查询异步任务的状态", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。", "example": "z-2s9j28****" }, { "name": "TaskId", "type": "string", "required": true, "description": "任务ID。", "example": "t-x8jd983n****" } ], "required": [ "ZoneId", "TaskId" ] }, { "name": "GetUser", "description": "查询用户信息", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "用户 ID。", "example": "u-23w3nwlsa" }, { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-hfp2qqncfthb" } ], "required": [ "UserId", "ZoneId" ] }, { "name": "GetUserSyncProvisioning", "description": "查询CAM用户同步", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。", "example": "z-d8wj832n***" }, { "name": "UserProvisioningId", "type": "string", "required": true, "description": "CAM 用户同步的 ID。", "example": "up-xe93jd93je" } ], "required": [ "ZoneId", "UserProvisioningId" ] }, { "name": "GetZoneSAMLServiceProviderInfo", "description": "查询SAML服务提供商配置信息", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。", "example": "z-2js923necd***" } ], "required": [ "ZoneId" ] }, { "name": "GetZoneStatistics", "description": "查询空间的统计信息", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID", "example": "z-2d2nq982n***" } ], "required": [ "ZoneId" ] }, { "name": "InviteOrganizationMember", "description": "邀请组织成员", "status": "online", "parameters": [ { "name": "MemberUin", "type": "integer", "required": true, "description": "被邀请账号Uin。", "example": "111111111111" }, { "name": "Name", "type": "string", "required": true, "description": "成员名称。最大长度为25个字符，支持英文字母、数字、汉字、符号+@、\u0026._[]-:,", "example": "member_name" }, { "name": "PolicyType", "type": "string", "required": true, "description": "关系策略。取值：Financial", "example": "Financial" }, { "name": "PermissionIds", "type": "array", "required": true, "description": "成员财务权限ID列表。取值：1-查看账单、2-查看余额、3-资金划拨（若需要开启资金划拨权限，请联系您的商务经理内部开通。）、4-合并出账、5-开票、6-优惠继承、7-代付费、8-成本分析、9-预算管理、10-信用额度设置（若需要开启信用额度设置权限，请联系您的商务经理内部开通。），1、2 默认必须", "example": "[1,2]", "item_type": "integer" }, { "name": "NodeId", "type": "integer", "required": true, "description": "成员所属部门的节点ID。可以通过[DescribeOrganizationNodes](https://cloud.tencent.com/document/product/850/82926)获取", "example": "1001" }, { "name": "Remark", "type": "string", "required": false, "description": "备注。", "example": "invitation member" }, { "name": "IsAllowQuit", "type": "string", "required": false, "description": "是否允许成员退出。允许：Allow，不允许：Denied。", "example": "Allow" }, { "name": "PayUin", "type": "string", "required": false, "description": "代付者Uin。成员代付费时需要", "example": "100000000001" }, { "name": "RelationAuthName", "type": "string", "required": false, "description": "互信实名主体名称。", "example": "company_name" }, { "name": "AuthFile", "type": "array", "required": false, "description": "互信主体证明文件列表。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "文件名。", "example": "file_name" }, { "name": "Url", "type": "string", "required": true, "description": "文件路径。", "example": "file/file_name.txt" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "成员标签列表。最大10个", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值", "example": "value" } ] } ], "required": [ "MemberUin", "Name", "PolicyType", "PermissionIds", "NodeId" ] }, { "name": "ListExternalSAMLIdPCertificates", "description": "查询SAML签名证书列表", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。", "example": "z-2js923necd***" } ], "required": [ "ZoneId" ] }, { "name": "ListGroupMembers", "description": "查询用户组中的用户列表", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-2d8shd8***" }, { "name": "GroupId", "type": "string", "required": true, "description": "用户组ID。", "example": "g-28sn23n***" }, { "name": "NextToken", "type": "string", "required": false, "description": "查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法多次查询，直到IsTruncated为false，表示全部数据查询完毕。", "example": "OTM0YzE4MzY2ZjdhMWM0MYZDhnYaxsiYTLI=" }, { "name": "MaxResults", "type": "integer", "required": false, "description": "每页的最大数据条数。 取值范围：1~100。 默认值：10。", "example": "10" }, { "name": "UserType", "type": "string", "required": false, "description": "用户类型 Manual：手动创建，Synchronized：外部导入。", "example": "Manual" } ], "required": [ "ZoneId", "GroupId" ] }, { "name": "ListGroups", "description": "查询用户组列表", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-3ds73bs****" }, { "name": "NextToken", "type": "string", "required": false, "description": "查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法多次查询，直到IsTruncated为false，表示全部数据查询完毕。", "example": "OTM0YzE4MzY2ZjdhMWM0MYZDhnYaxsiYTLI=" }, { "name": "MaxResults", "type": "integer", "required": false, "description": "每页的最大数据条数。 取值范围：1~100。 默认值：10。", "example": "20" }, { "name": "Filter", "type": "string", "required": false, "description": "过滤条件。 格式： ，不区分大小写。目前，只支持GroupName，只支持eq（Equals）和sw（Start With）。 示例：Filter = \"GroupName sw test\"，表示查询名称以 test 开头的全部用户组。Filter = \"GroupName eq testgroup\"，表示查询名称为 testgroup 的用户组。", "example": "GroupName eq testGroup" }, { "name": "GroupType", "type": "string", "required": false, "description": "用户组的类型 Manual：手动创建，Synchronized：外部导入。", "example": "Manual" }, { "name": "FilterUsers", "type": "array", "required": false, "description": "筛选的用户，该用户关联的用户组会返回IsSelected=1", "example": "[\"u-dnjw8dndjde\",\"u-dniwsnsas\"]", "item_type": "string" }, { "name": "SortField", "type": "string", "required": false, "description": "排序的字段，目前只支持CreateTime，默认是CreateTime字段", "example": "CreateTime" }, { "name": "SortType", "type": "string", "required": false, "description": "排序类型：Desc 倒序 Asc 正序，需要您和SortField一起设置", "example": "Desc" }, { "name": "Offset", "type": "integer", "required": false, "description": "翻页offset. 不要与NextToken同时使用，优先使用NextToken", "example": "0" } ], "required": [ "ZoneId" ] }, { "name": "ListJoinedGroupsForUser", "description": "查询用户加入的用户组", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-2d8shd8***" }, { "name": "UserId", "type": "string", "required": true, "description": "用户ID", "example": "u-28sn23n***" }, { "name": "NextToken", "type": "string", "required": false, "description": "查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法多次查询，直到IsTruncated为false，表示全部数据查询完毕。", "example": "OTM0YzE4MzY2ZjdhMWM0MYZDhnYaxsiYTLI=" }, { "name": "MaxResults", "type": "integer", "required": false, "description": "每页的最大数据条数。 取值范围：1~100。 默认值：10。", "example": "10" } ], "required": [ "ZoneId", "UserId" ] }, { "name": "ListNonCompliantResource", "description": "获取成员标签检测不合规资源列表", "status": "online", "parameters": [ { "name": "MaxResults", "type": "integer", "required": true, "description": "限制数目。取值范围：1~50。", "example": "10" }, { "name": "MemberUin", "type": "integer", "required": true, "description": "成员Uin。", "example": "111111111111" }, { "name": "PaginationToken", "type": "string", "required": false, "description": "从上一页的响应中获取的下一页的Token值。 如果是第一次请求，设置为空。", "example": "fgh363" }, { "name": "TagKey", "type": "string", "required": false, "description": "标签键。", "example": "key" } ], "required": [ "MaxResults", "MemberUin" ] }, { "name": "ListOrgServiceAssignMember", "description": "获取集团服务委派管理员列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。取值是limit的整数倍，默认值 : 0", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目。取值范围：1~50，默认值：10", "example": "10" }, { "name": "ServiceId", "type": "integer", "required": false, "description": "集团服务ID。和集团服务产品标识二选一必填，可以通过[ListOrganizationService](https://cloud.tencent.com/document/product/850/109561)获取", "example": "1" }, { "name": "Product", "type": "string", "required": false, "description": "集团服务产品标识。和集团服务ID二选一必填，可以通过[ListOrganizationService](https://cloud.tencent.com/document/product/850/109561)获取", "example": "cloudaudit" } ], "required": [ "Offset", "Limit" ] }, { "name": "ListOrganizationIdentity", "description": "获取组织成员访问身份列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。取值是limit的整数倍。默认值 : 0。", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目。取值范围：1~50。默认值：10。", "example": "10" }, { "name": "SearchKey", "type": "string", "required": false, "description": "名称搜索关键字。", "example": "identity_name" }, { "name": "IdentityId", "type": "integer", "required": false, "description": "身份ID。可以通过身份ID搜索", "example": "1" }, { "name": "IdentityType", "type": "integer", "required": false, "description": "身份类型。取值范围 1-预设, 2-自定义", "example": "1" } ], "required": [ "Offset", "Limit" ] }, { "name": "ListOrganizationService", "description": "获取集团服务设置列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量。取值是limit的整数倍，默认值 : 0", "example": "1" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数目。取值范围：1~50，默认值：10", "example": "10" }, { "name": "SearchKey", "type": "string", "required": false, "description": "名称搜索关键字。", "example": "cloudaudit" } ], "required": [ "Offset", "Limit" ] }, { "name": "ListPermissionPoliciesInRoleConfiguration", "description": "获取权限配置中的策略列表", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID", "example": "z-289s28wn***" }, { "name": "RoleConfigurationId", "type": "string", "required": true, "description": "权限配置 ID", "example": "rc-si2e3i3me" }, { "name": "RolePolicyType", "type": "string", "required": false, "description": "权限策略类型。取值： System：系统策略。复用 CAM 的系统策略。 Custom: 自定义策略。按照 CAM 权限策略语法和结构编写的自定义策略。", "example": "System" }, { "name": "Filter", "type": "string", "required": false, "description": "按策略名称搜索", "example": "QcloudPolicyTest" } ], "required": [ "ZoneId", "RoleConfigurationId" ] }, { "name": "ListPolicies", "description": "本接口（ListPolicies）可用于查询查看策略列表数据", "status": "online", "parameters": [ { "name": "Rp", "type": "integer", "required": false, "description": "每页数量。默认值是 20，必须大于 0 且小于或等于 200", "example": "1" }, { "name": "Page", "type": "integer", "required": false, "description": "页码。默认值是 1，从 1开始，不能大于 200", "example": "10" }, { "name": "Scope", "type": "string", "required": false, "description": "查询范围。取值范围： All-获取所有策略、QCS-只获取预设策略、Local-只获取自定义策略，默认值：All", "example": "All" }, { "name": "Keyword", "type": "string", "required": false, "description": "搜索关键字。按照策略名搜索", "example": "policy_name" }, { "name": "PolicyType", "type": "string", "required": false, "description": "策略类型。默认值SERVICE_CONTROL_POLICY，取值范围：SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略", "example": "SERVICE_CONTROL_POLICY" } ], "required": [] }, { "name": "ListPoliciesForTarget", "description": "本接口（ListPoliciesForTarget）查询目标关联的策略列表", "status": "online", "parameters": [ { "name": "TargetId", "type": "integer", "required": true, "description": "账号uin或者节点id。", "example": "10083" }, { "name": "Rp", "type": "integer", "required": false, "description": "每页数量。默认值是 20，必须大于 0 且小于或等于 200", "example": "1" }, { "name": "Page", "type": "integer", "required": false, "description": "页码。默认值是 1，从 1开始，不能大于 200", "example": "10" }, { "name": "PolicyType", "type": "string", "required": false, "description": "策略类型。默认值SERVICE_CONTROL_POLICY，取值范围：SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略", "example": "SERVICE_CONTROL_POLICY" }, { "name": "Keyword", "type": "string", "required": false, "description": "搜索关键字。按照策略名称搜索", "example": "policy_name" } ], "required": [ "TargetId" ] }, { "name": "ListRoleAssignments", "description": "查询授权列表", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-2d8shd8***" }, { "name": "RoleConfigurationId", "type": "string", "required": false, "description": "权限配置ID。", "example": "rc-sd8sdn8sns" }, { "name": "MaxResults", "type": "integer", "required": false, "description": "每页的最大数据条数。 取值范围：1~100。 默认值：10。", "example": "10" }, { "name": "NextToken", "type": "string", "required": false, "description": "查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法多次查询，直到IsTruncated为false，表示全部数据查询完毕。", "example": "OTM0YzE4MzY2ZjdhMWM0MYZDhnYaxsiYTLI=" }, { "name": "TargetType", "type": "string", "required": false, "description": "同步的集团账号目标账号的类型，ManagerUin管理账号;MemberUin成员账号", "example": "MemberUin" }, { "name": "TargetUin", "type": "integer", "required": false, "description": "同步的集团账号目标账号的UIN。", "example": "1000038292" }, { "name": "PrincipalType", "type": "string", "required": false, "description": "CAM 用户同步的身份类型。取值： User：表示同步的身份是用户。 Group：表示同步的身份是用户组。", "example": "User" }, { "name": "PrincipalId", "type": "string", "required": false, "description": "用户同步 ID。取值： 当PrincipalType取值为Group时，该值为用户组 ID（g-****)，当PrincipalType取值为User时，该值为用户 ID （u-****）。", "example": "u-djwismoa***" }, { "name": "Filter", "type": "string", "required": false, "description": "查询条件，目前只支持权限配置名称查询。", "example": "conf1" } ], "required": [ "ZoneId" ] }, { "name": "ListRoleConfigurationProvisionings", "description": "查询权限配置部署列表", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-2d8shd8***" }, { "name": "RoleConfigurationId", "type": "string", "required": false, "description": "权限配置ID。", "example": "r-sd8sdn8sns" }, { "name": "MaxResults", "type": "integer", "required": false, "description": "每页的最大数据条数。 取值范围：1~100。 默认值：10。", "example": "10" }, { "name": "NextToken", "type": "string", "required": false, "description": "查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法多次查询，直到IsTruncated为false，表示全部数据查询完毕。", "example": "OTM0YzE4MzY2ZjdhMWM0MYZDhnYaxsiYTLI=" }, { "name": "TargetType", "type": "string", "required": false, "description": "同步的集团账号目标账号的类型，ManagerUin管理账号;MemberUin成员账号", "example": "MemberUin" }, { "name": "TargetUin", "type": "integer", "required": false, "description": "同步的集团账号目标账号的UIN。", "example": "1000038292" }, { "name": "DeploymentStatus", "type": "string", "required": false, "description": "Deployed: 部署成功 DeployedRequired：需要重新部署 DeployFailed：部署失败", "example": "Deployed" }, { "name": "Filter", "type": "string", "required": false, "description": "支持配置名称搜索。", "example": "conf1" } ], "required": [ "ZoneId" ] }, { "name": "ListRoleConfigurations", "description": "查询权限配置列表", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-3ds73bs****" }, { "name": "NextToken", "type": "string", "required": false, "description": "查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法多次查询，直到IsTruncated为false，表示全部数据查询完毕。", "example": "OTM0YzE4MzY2ZjdhMWM0MYZDhnYaxsiYTLI=" }, { "name": "MaxResults", "type": "integer", "required": false, "description": "每页的最大数据条数。 取值范围：1~100。 默认值：10。", "example": "20" }, { "name": "Filter", "type": "string", "required": false, "description": "过滤文本。不区分大小写。目前，支持 RoleConfigurationName和Description. 示例：Filter = \"test\"，表示查询名称或描述里包含 test 的权限配置。", "example": "conf1" }, { "name": "FilterTargets", "type": "array", "required": false, "description": "检索成员账号是否配置过权限，如果配置过返回IsSelected: true, 否则返回false。", "example": "[100002322,1000033232]", "item_type": "integer" }, { "name": "PrincipalId", "type": "string", "required": false, "description": "授权的用户UserId或者用户组的GroupId，必须和入参数FilterTargets一起设置", "example": "u-s9wme92ne" } ], "required": [ "ZoneId" ] }, { "name": "ListSCIMCredentials", "description": "查询用户SCIM密钥列表", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。z-前缀开头，后面是12位随机数字/小写字母", "example": "z-00fdsg****" }, { "name": "CredentialId", "type": "string", "required": false, "description": "SCIM密钥ID", "example": "scimcred-lkj****" } ], "required": [ "ZoneId" ] }, { "name": "ListTargetsForPolicy", "description": "本接口（ListTargetsForPolicy）查询某个指定策略关联的目标列表", "status": "online", "parameters": [ { "name": "PolicyId", "type": "integer", "required": true, "description": "策略Id。", "example": "1001" }, { "name": "Rp", "type": "integer", "required": false, "description": "每页数量。默认值是 20，必须大于 0 且小于或等于 200", "example": "1" }, { "name": "Page", "type": "integer", "required": false, "description": "页码。默认值是 1，从 1开始，不能大于 200", "example": "10" }, { "name": "TargetType", "type": "string", "required": false, "description": "策略类型。取值范围：All-全部、User-用户、Node-节点", "example": "All" }, { "name": "PolicyType", "type": "string", "required": false, "description": "策略类型。默认值SERVICE_CONTROL_POLICY，取值范围：SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略", "example": "SERVICE_CONTROL_POLICY" }, { "name": "Keyword", "type": "string", "required": false, "description": "按照多个策略id搜索，空格隔开。", "example": "10001 10002" } ], "required": [ "PolicyId" ] }, { "name": "ListTasks", "description": "查询异步任务列表", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-2d8shd8***" }, { "name": "PrincipalId", "type": "string", "required": false, "description": "用户同步 ID。取值： 当PrincipalType取值为Group时，该值为用户组 ID（g-****）， 当PrincipalType取值为User时，该值为用户 ID（u-****）。", "example": "u-siws8sn***" }, { "name": "NextToken", "type": "string", "required": false, "description": "查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法多次查询，直到IsTruncated为false，表示全部数据查询完毕。", "example": "OTM0YzE4MzY2ZjdhMWM0MYZDhnYaxsiYTLI=" }, { "name": "MaxResults", "type": "integer", "required": false, "description": "每页的最大数据条数。 取值范围：1~100。 默认值：10。", "example": "10" }, { "name": "PrincipalType", "type": "string", "required": false, "description": "CAM 用户同步的身份类型。取值： User：表示同步的身份是用户。 Group：表示同步的身份是用户组。", "example": "User" }, { "name": "TargetUin", "type": "integer", "required": false, "description": "同步的集团账号目标账号的UIN。", "example": "10000229322" }, { "name": "TargetType", "type": "string", "required": false, "description": "同步的集团账号目标账号的类型，ManagerUin管理账号;MemberUin成员账号", "example": "MemberUin" }, { "name": "RoleConfigurationId", "type": "string", "required": false, "description": "权限配置ID。", "example": "rc-s92jd93je" }, { "name": "Status", "type": "string", "required": false, "description": "InProgress：任务执行中。 Success：任务执行成功。 Failed：任务执行失败。", "example": "InProgress" }, { "name": "TaskType", "type": "string", "required": false, "description": "任务类型。", "example": "CreateRoleAssignment" } ], "required": [ "ZoneId" ] }, { "name": "ListUserSyncProvisionings", "description": "查询CAM用户同步列表", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-2d8shd8***" }, { "name": "PrincipalId", "type": "string", "required": false, "description": "用户同步 ID。取值： 当PrincipalType取值为Group时，该值为用户组 ID（g-********）。 当PrincipalType取值为User时，该值为用户 ID（u-********）。", "example": "u-siws8sn***" }, { "name": "NextToken", "type": "string", "required": false, "description": "查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法多次查询，直到IsTruncated为false，表示全部数据查询完毕。", "example": "OTM0YzE4MzY2ZjdhMWM0MYZDhnYaxsiYTLI=" }, { "name": "MaxResults", "type": "integer", "required": false, "description": "每页的最大数据条数。 取值范围：1~100。 默认值：10。", "example": "10" }, { "name": "PrincipalType", "type": "string", "required": false, "description": "CAM 用户同步的身份类型。取值： User：表示同步的身份是用户。 Group：表示同步的身份是用户组。", "example": "User" }, { "name": "TargetUin", "type": "integer", "required": false, "description": "集团账号目标账号的UIN。", "example": "10000229322" }, { "name": "TargetType", "type": "string", "required": false, "description": "同步的集团账号目标账号的类型，ManagerUin管理账号;MemberUin成员账号", "example": "MemberUin" }, { "name": "Filter", "type": "string", "required": false, "description": "检测条件。", "example": "up-aiwn9inss" } ], "required": [ "ZoneId" ] }, { "name": "ListUsers", "description": "查询用户列表", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-00fc2p61****" }, { "name": "UserStatus", "type": "string", "required": false, "description": "用户状态 Enabled：启用， Disabled：禁用。", "example": "Enabled" }, { "name": "UserType", "type": "string", "required": false, "description": "用户类型 Manual：手动创建，Synchronized：外部导入。", "example": "Manual" }, { "name": "Filter", "type": "string", "required": false, "description": "过滤条件。 目前仅支持用户名，邮箱，用户userId，描述", "example": "user1" }, { "name": "MaxResults", "type": "integer", "required": false, "description": "每页的最大数据条数。 取值范围：1~100。 默认值：10。", "example": "10" }, { "name": "NextToken", "type": "string", "required": false, "description": "查询返回结果下一页的令牌。首次调用 API 不需要NextToken。 当您首次调用 API 时，如果返回数据总条数超过MaxResults限制，数据会被截断，只返回MaxResults条数据，同时，返回参数IsTruncated为true，返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API，其他请求参数保持不变，查询被截断的数据。您可以按此方法经过多次查询，直到IsTruncated为false时，表示全部数据查询完\ufffd\ufffd...", "example": "OTM0YzE4MzY2ZjdhMWM0MYZDhnYaxsiYTLI=" }, { "name": "FilterGroups", "type": "array", "required": false, "description": "筛选的用户组，该用户组关联的子用户会返回IsSelected=1", "example": "[\"g-sjwidjssd\", \"g-djsiendidmd\"]", "item_type": "string" }, { "name": "SortField", "type": "string", "required": false, "description": "排序的字段，目前只支持CreateTime，默认是CreateTime字段", "example": "CreateTime" }, { "name": "SortType", "type": "string", "required": false, "description": "排序类型：Desc 倒序 Asc 正序，需要您和SortField一起设置", "example": "Desc" }, { "name": "Offset", "type": "integer", "required": false, "description": "翻页offset. 不要与NextToken同时使用，优先使用NextToken", "example": "0" } ], "required": [ "ZoneId" ] }, { "name": "MoveOrganizationNodeMembers", "description": "移动成员到指定企业组织节点", "status": "online", "parameters": [ { "name": "NodeId", "type": "integer", "required": true, "description": "组织节点ID。可以通过[DescribeOrganizationNodes](https://cloud.tencent.com/document/product/850/82926)获取", "example": "1001" }, { "name": "MemberUin", "type": "array", "required": true, "description": "成员Uin列表。", "example": "[111111111111]", "item_type": "integer" } ], "required": [ "NodeId", "MemberUin" ] }, { "name": "OpenIdentityCenter", "description": "开通身份中心服务（CIC）", "status": "online", "parameters": [ { "name": "ZoneName", "type": "string", "required": true, "description": "空间名，必须全局唯一。包含小写字母、数字和短划线（-）。不能以短划线（-）开头或结尾，且不能有两个连续的短划线（-）。长度：2~64 个字符。", "example": "testName" } ], "required": [ "ZoneName" ] }, { "name": "ProvisionRoleConfiguration", "description": "将权限配置部署到成员账号上", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-00fc2p61****" }, { "name": "RoleConfigurationId", "type": "string", "required": true, "description": "权限配置ID。", "example": "rc-sisjdia" }, { "name": "TargetType", "type": "string", "required": true, "description": "同步的集团账号目标账号的类型，ManagerUin管理账号;MemberUin成员账号。", "example": "MemberUin" }, { "name": "TargetUin", "type": "integer", "required": true, "description": "集团账号目标账号的UIN。", "example": "10003i32i2" } ], "required": [ "ZoneId", "RoleConfigurationId", "TargetType", "TargetUin" ] }, { "name": "QuitOrganization", "description": "退出企业组织", "status": "online", "parameters": [ { "name": "OrgId", "type": "integer", "required": true, "description": "企业组织ID", "example": "101" } ], "required": [ "OrgId" ] }, { "name": "RejectJoinShareUnitInvitation", "description": "拒绝加入共享单元邀请。", "status": "online", "parameters": [ { "name": "UnitId", "type": "string", "required": true, "description": "共享单元ID。", "example": "shareUnit-xhreo**2p" } ], "required": [ "UnitId" ] }, { "name": "RemoveExternalSAMLIdPCertificate", "description": "移除SAML签名证书", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。", "example": "z-2js923necd***" }, { "name": "CertificateId", "type": "string", "required": true, "description": "PEM 格式的 X509 证书。 由 SAML 身份提供商提供。", "example": "dp-c-2jd8923je29****" } ], "required": [ "ZoneId", "CertificateId" ] }, { "name": "RemovePermissionPolicyFromRoleConfiguration", "description": "为权限配置移除策略", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID", "example": "z-29n23ien" }, { "name": "RoleConfigurationId", "type": "string", "required": true, "description": "权限配置 ID", "example": "rc-so2msow" }, { "name": "RolePolicyType", "type": "string", "required": true, "description": "权限策略类型。取值： System：系统策略。复用 CAM 的系统策略。 Custom: 自定义策略。按照 CAM 权限策略语法和结构编写的自定义策略。", "example": "System" }, { "name": "RolePolicyName", "type": "string", "required": false, "description": "权限策略名称，长度最大为 32 个字符。", "example": "TestPolicy" }, { "name": "RolePolicyId", "type": "integer", "required": false, "description": "策略ID。", "example": "426322" } ], "required": [ "ZoneId", "RoleConfigurationId", "RolePolicyType" ] }, { "name": "RemoveUserFromGroup", "description": "从用户组中移除用户", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。", "example": "z-28sjh238n" }, { "name": "GroupId", "type": "string", "required": true, "description": "用户组ID。", "example": "g-28sh28ne" }, { "name": "UserId", "type": "string", "required": true, "description": "用户ID。", "example": "u-0su23n9nd" } ], "required": [ "ZoneId", "GroupId", "UserId" ] }, { "name": "SendOrgMemberAccountBindEmail", "description": "重新发送成员绑定邮箱激活邮件", "status": "online", "parameters": [ { "name": "MemberUin", "type": "integer", "required": true, "description": "成员Uin。", "example": "111111111111" }, { "name": "BindId", "type": "integer", "required": true, "description": "绑定ID。可以通过[DescribeOrganizationMemberEmailBind](https://cloud.tencent.com/document/product/850/93332)获取", "example": "12" } ], "required": [ "MemberUin", "BindId" ] }, { "name": "SetExternalSAMLIdentityProvider", "description": "配置SAML身份提供商信息", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。", "example": "z-2js923necd***" }, { "name": "EncodedMetadataDocument", "type": "string", "required": false, "description": "IdP 元数据文档（Base64 编码）。 由支持 SAML 2.0 协议的 IdP 提供。", "example": "PD94bWwgdmVyc2lvbj0iMS4****" }, { "name": "SSOStatus", "type": "string", "required": false, "description": "SSO 登录的启用状态。取值： Enabled：启用。 Disabled（默认值）：禁用。", "example": "Enabled" }, { "name": "EntityId", "type": "string", "required": false, "description": "IdP 标识。", "example": "http://www.okta.com/2jd83ne9m*****" }, { "name": "LoginUrl", "type": "string", "required": false, "description": "IdP 的登录地址。", "example": "https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/2jd83ne9m****/sso/saml" }, { "name": "X509Certificate", "type": "string", "required": false, "description": "PEM 格式的 X509 证书。指定该参数会替换所有已经存在的证书。", "example": "MIIBtjCCAVugAwIBAgITBmyf1XSXNmY/Owua2eiedgPySjAKBggqhkjOPQQDAjA5***" } ], "required": [ "ZoneId" ] }, { "name": "UpdateCustomPolicyForRoleConfiguration", "description": "为权限配置修改自定义策略", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID", "example": "z-29n23ien" }, { "name": "RoleConfigurationId", "type": "string", "required": true, "description": "权限配置 ID", "example": "rc-so2msow" }, { "name": "CustomPolicyName", "type": "string", "required": true, "description": "权限策略名称，长度最大为 32 个字符。", "example": "TestPolicy" }, { "name": "NewCustomPolicyDocument", "type": "string", "required": false, "description": "自定义策略内容。长度：最大 4096 个字符。当RolePolicyType为Inline时，该参数必须配置。关于权限策略的语法和结构，请参见权限策略语法和结构。", "example": "{\\\"statement\\\":{\\\"action\\\":[\\\"name/cvm:*\\\",\\\"name/vpc:*\\\",\\\"name/cos:*\\\",\\\"name/cmqtopic:*\\\",\\\"name/cmqqueue:*\\\"],\\\"effect\\\":\\\"allow\\\",\\\"resource\\\":\\\"*\\\"},\\\"version\\\":\\\"2.0\\\"}" } ], "required": [ "ZoneId", "RoleConfigurationId", "CustomPolicyName" ] }, { "name": "UpdateGroup", "description": "修改用户组信息", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-d8hssis****" }, { "name": "GroupId", "type": "string", "required": true, "description": "用户组ID。", "example": "g-s8sidnid" }, { "name": "NewGroupName", "type": "string", "required": false, "description": "新的用户组名称。", "example": "testGroup" }, { "name": "NewDescription", "type": "string", "required": false, "description": "新的用户组描述。", "example": "this is group" } ], "required": [ "ZoneId", "GroupId" ] }, { "name": "UpdateOrganizationIdentity", "description": "更新组织身份", "status": "online", "parameters": [ { "name": "IdentityId", "type": "integer", "required": true, "description": "身份ID。可以通过[ListOrganizationIdentity](https://cloud.tencent.com/document/product/850/82934)获取", "example": "1" }, { "name": "Description", "type": "string", "required": true, "description": "身份描述。", "example": "admin identity" }, { "name": "IdentityPolicy", "type": "array", "required": true, "description": "身份策略。", "example": "[{\"PolicyId\":1,\"PolicyName\":\"AdministratorAccess\"}]", "item_type": "object", "children": [ { "name": "PolicyId", "type": "integer", "required": false, "description": "CAM预设策略ID。PolicyType 为预设策略时有效且必选", "example": "1" }, { "name": "PolicyName", "type": "string", "required": false, "description": "CAM预设策略名称。PolicyType 为预设策略时有效且必选", "example": "AdministratorAccess" }, { "name": "PolicyType", "type": "integer", "required": false, "description": "策略类型。取值 1-自定义策略 2-预设策略；默认值2", "example": "2" }, { "name": "PolicyDocument", "type": "string", "required": false, "description": "自定义策略内容，遵循CAM策略语法。PolicyType 为自定义策略时有效且必选", "example": "{ \"version\": \"2.0\", \"statement\": [ { \"effect\": \"allow\", \"action\": [ \"vpc:*\" ], \"resource\": [ \"*\" ] } ] }" } ] } ], "required": [ "IdentityId", "Description", "IdentityPolicy" ] }, { "name": "UpdateOrganizationMember", "description": "更新组织成员信息", "status": "online", "parameters": [ { "name": "MemberUin", "type": "integer", "required": true, "description": "成员Uin。", "example": "111111111111" }, { "name": "Name", "type": "string", "required": false, "description": "成员名称。最大长度为25个字符，支持英文字母、数字、汉字、符号+@、\u0026._[]-:,", "example": "member_name" }, { "name": "Remark", "type": "string", "required": false, "description": "备注。最大长度为40个字符", "example": "create member" }, { "name": "PolicyType", "type": "string", "required": false, "description": "关系策略类型。PolicyType不为空，PermissionIds不能为空。取值：Financial", "example": "Financial" }, { "name": "PermissionIds", "type": "array", "required": false, "description": "成员财务权限ID列表。PermissionIds不为空，PolicyType不能为空。 取值：1-查看账单、2-查看余额、3-资金划拨（若需要开启资金划拨权限，请联系您的商务经理内部开通。）、4-合并出账、5-开票、6-优惠继承、7-代付费、8-成本分析、9-预算管理、10-信用额度设置（若需要开启信用额度设置权限，请联系您的商务经理内部开通。），1、2 默认必须", "example": "[1,2]", "item_type": "integer" }, { "name": "IsAllowQuit", "type": "string", "required": false, "description": "是否允许成员退出组织。取值：Allow-允许、Denied-不允许", "example": "allow" }, { "name": "PayUin", "type": "string", "required": false, "description": "代付者Uin。成员财务权限有代付费时需要，取值为成员对应主体的主体管理员Uin", "example": "100000000001" }, { "name": "IsModifyNickName", "type": "integer", "required": false, "description": "是否同步组织成员名称到成员账号昵称。取值： 1-同步 0-不同步", "example": "0" } ], "required": [ "MemberUin" ] }, { "name": "UpdateOrganizationMemberEmailBind", "description": "修改绑定成员邮箱", "status": "online", "parameters": [ { "name": "MemberUin", "type": "integer", "required": true, "description": "成员Uin。", "example": "111111111111" }, { "name": "BindId", "type": "integer", "required": true, "description": "绑定ID。可以通过[DescribeOrganizationMemberEmailBind](https://cloud.tencent.com/document/product/850/93332)获取", "example": "12" }, { "name": "Email", "type": "string", "required": true, "description": "邮箱地址。", "example": "12***@qq.com" }, { "name": "CountryCode", "type": "string", "required": true, "description": "国际区号。", "example": "86" }, { "name": "Phone", "type": "string", "required": true, "description": "手机号。", "example": "18***32" } ], "required": [ "MemberUin", "BindId", "Email", "CountryCode", "Phone" ] }, { "name": "UpdateOrganizationMembersPolicy", "description": "修改组织成员访问策略", "status": "online", "parameters": [ { "name": "MemberUins", "type": "array", "required": true, "description": "成员Uin列表。最多10个", "example": "[111111111111]", "item_type": "integer" }, { "name": "PolicyId", "type": "integer", "required": true, "description": "成员访问策略Id。可通过DescribeOrganizationMemberPolicies获取", "example": "101" }, { "name": "IdentityId", "type": "integer", "required": true, "description": "成员访问身份ID。可通过ListOrganizationIdentity获取", "example": "11" }, { "name": "Description", "type": "string", "required": false, "description": "策略描述。最大长度为128个字符", "example": "admin policy" } ], "required": [ "MemberUins", "PolicyId", "IdentityId" ] }, { "name": "UpdateOrganizationNode", "description": "更新企业组织节点", "status": "online", "parameters": [ { "name": "NodeId", "type": "integer", "required": true, "description": "节点ID。可以通过[DescribeOrganizationNodes](https://cloud.tencent.com/document/product/850/82926)获取", "example": "1001" }, { "name": "Name", "type": "string", "required": false, "description": "节点名称。最大长度为40个字符，支持英文字母、数字、汉字、符号+@、\u0026._[]-", "example": "name" }, { "name": "Remark", "type": "string", "required": false, "description": "备注。", "example": "remark" } ], "required": [ "NodeId" ] }, { "name": "UpdatePolicy", "description": "编辑策略", "status": "online", "parameters": [ { "name": "PolicyId", "type": "integer", "required": true, "description": "需要编辑的策略ID。可以调用[ListPolicies](https://cloud.tencent.com/document/product/850/105311)获取", "example": "100001" }, { "name": "Description", "type": "string", "required": false, "description": "策略描述。", "example": "全读写权限" }, { "name": "Content", "type": "string", "required": false, "description": "策略内容。参考CAM策略语法", "example": "{\"version\":\"2.0\",\"statement\":[{\"effect\":\"allow\",\"action\":\"*\",\"resource\":\"*\"}]}" }, { "name": "Name", "type": "string", "required": false, "description": "策略名。长度为1~128个字符，可以包含汉字、英文字母、数字和下划线（_）", "example": "FullAccessPolicy" }, { "name": "Type", "type": "string", "required": false, "description": "策略类型。默认值SERVICE_CONTROL_POLICY，取值范围：SERVICE_CONTROL_POLICY-服务控制策略、TAG_POLICY-标签策略", "example": "SERVICE_CONTROL_POLICY" } ], "required": [ "PolicyId" ] }, { "name": "UpdateRoleConfiguration", "description": "修改权限配置信息", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID", "example": "z-29n23ien" }, { "name": "RoleConfigurationId", "type": "string", "required": true, "description": "权限配置 ID", "example": "rc-so2msow" }, { "name": "NewDescription", "type": "string", "required": false, "description": "新的权限配置描述。 长度：最大 1024 个字符。", "example": "this is role configuration" }, { "name": "NewSessionDuration", "type": "integer", "required": false, "description": "新的会话持续时间。 CIC 用户使用权限配置访问集团账号目标账号时，会话最多保持的时间。 单位：秒。 取值范围：900-43200（15 分钟-12 小时）。", "example": "900" }, { "name": "NewRelayState", "type": "string", "required": false, "description": "新的初始访问页面。 CIC 用户使用权限配置访问集团账号目标账号时，初始访问的页面地址。 该页面必须是腾讯云控制台页面。", "example": "https://console.cloud.tencent.com" } ], "required": [ "ZoneId", "RoleConfigurationId" ] }, { "name": "UpdateSCIMCredentialStatus", "description": "启用/禁用SCIM密钥", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。z-前缀开头，后面是12位随机数字/小写字母", "example": "z-00fdsg****" }, { "name": "CredentialId", "type": "string", "required": true, "description": "SCIM密钥ID。scimcred-前缀开头，后面是12位随机数字/小写字母。", "example": "scimcred-lkj****" }, { "name": "NewStatus", "type": "string", "required": true, "description": "SCIM密钥状态。Enabled：启用。 Disabled：禁用。", "example": "Enabled" } ], "required": [ "ZoneId", "CredentialId", "NewStatus" ] }, { "name": "UpdateSCIMSynchronizationStatus", "description": "启用/禁用用户SCIM同步", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。z-前缀开头，后面是12位随机数字/小写字母", "example": "z-00fdsg****" }, { "name": "SCIMSynchronizationStatus", "type": "string", "required": true, "description": "SCIM 同步状态。Enabled：启用。Disabled：禁用。", "example": "Enabled" } ], "required": [ "ZoneId", "SCIMSynchronizationStatus" ] }, { "name": "UpdateShareUnit", "description": "更新共享单元。", "status": "online", "parameters": [ { "name": "UnitId", "type": "string", "required": true, "description": "共享单元ID。", "example": "shareUnit-xhreo**2p" }, { "name": "Name", "type": "string", "required": false, "description": "共享单元名称。仅支持大小写字母、数字、-、以及_的组合，3-128个字符。", "example": "myShareUnit" }, { "name": "Description", "type": "string", "required": false, "description": "共享单元描述。最大128个字符。", "example": "share unit" }, { "name": "ShareScope", "type": "integer", "required": false, "description": "共享范围。取值：1-仅允许集团组织内共享 2-允许共享给任意账号，默认值：1", "example": "1" } ], "required": [ "UnitId" ] }, { "name": "UpdateUser", "description": "修改用户信息", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-22b2usba2" }, { "name": "UserId", "type": "string", "required": true, "description": "用户 ID。", "example": "u-33ks8w9n3" }, { "name": "NewFirstName", "type": "string", "required": false, "description": "用户的名。", "example": "John" }, { "name": "NewLastName", "type": "string", "required": false, "description": "用户的姓。", "example": "White" }, { "name": "NewDisplayName", "type": "string", "required": false, "description": "用户的显示名称。", "example": "John White" }, { "name": "NewDescription", "type": "string", "required": false, "description": "用户的描述。", "example": "this is user." }, { "name": "NewEmail", "type": "string", "required": false, "description": "用户的电子邮箱。", "example": "test@example.com" }, { "name": "NeedResetPassword", "type": "boolean", "required": false, "description": "是否需要重置密码", "example": "true" } ], "required": [ "ZoneId", "UserId" ] }, { "name": "UpdateUserStatus", "description": "修改用户状态", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间 ID。", "example": "z-3ks9b3kdm**" }, { "name": "UserId", "type": "string", "required": true, "description": "用户 ID。", "example": "u-ds9sbs823**" }, { "name": "NewUserStatus", "type": "string", "required": true, "description": "用户的状态。取值： Enabled：启用。 Disabled：禁用。", "example": "Enabled" } ], "required": [ "ZoneId", "UserId", "NewUserStatus" ] }, { "name": "UpdateUserSyncProvisioning", "description": "创建子用户同步任务", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。", "example": "z-d8wj832n***" }, { "name": "UserProvisioningId", "type": "string", "required": true, "description": "用户同步的iD", "example": "up-sjisnw8ois" }, { "name": "NewDescription", "type": "string", "required": false, "description": "用户同步描述。", "example": "this is cam sync provisioning" }, { "name": "NewDuplicationStateful", "type": "string", "required": false, "description": "冲突策略。当CIC 用户同步到 CAM 时，如果 CAM 中存在同名用户时的处理策略。取值： KeepBoth：两者都保留。当CIC 用户被同步到 CAM 时，如果 CAM 已经存在同名用户，则对CIC 用户的用户名添加后缀_cic后尝试创建该用户名的 CAM 用户。 TakeOver：替换。当CIC 用户被同步到 CAM 时，如果 CAM 已经存在同名用户，则直接将已经存在的 CAM 用户替换为CIC 同步用户。", "example": "KeepBoth" }, { "name": "NewDeletionStrategy", "type": "string", "required": false, "description": "删除策略。删除 CAM 用户同步时，对已同步的 CAM 用户的处理策略。取值： Delete：删除。删除 CAM 用户同步时，会删除从CIC 已经同步到 CAM 中的 CAM 用户。 Keep：保留。删除 RAM 用户同步时，会保留从CIC 已经同步到 CAM 中的 CAM 用户。", "example": "Delete" } ], "required": [ "ZoneId", "UserProvisioningId" ] }, { "name": "UpdateZone", "description": "更新用户空间名", "status": "online", "parameters": [ { "name": "ZoneId", "type": "string", "required": true, "description": "空间ID。z-前缀开头，后面是12位随机数字/小写字母", "example": "z-00fdsg****" }, { "name": "NewZoneName", "type": "string", "required": true, "description": "空间名，必须全局唯一。包含小写字母、数字和短划线（-）。不能以短划线（-）开头或结尾，且不能有两个连续的短划线（-）。长度：2~64 个字符。", "example": "testName" } ], "required": [ "ZoneId", "NewZoneName" ] } ] }