From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/zh_cn/eds-user/2021-03-08/api-docs.php | 6183 +++++++++++++++++++++++++++ data/zh_cn/eds-user/2021-06-22/api-docs.php | 113 + 2 files changed, 6296 insertions(+) create mode 100644 data/zh_cn/eds-user/2021-03-08/api-docs.php create mode 100644 data/zh_cn/eds-user/2021-06-22/api-docs.php (limited to 'data/zh_cn/eds-user') diff --git a/data/zh_cn/eds-user/2021-03-08/api-docs.php b/data/zh_cn/eds-user/2021-03-08/api-docs.php new file mode 100644 index 0000000..2bfe86f --- /dev/null +++ b/data/zh_cn/eds-user/2021-03-08/api-docs.php @@ -0,0 +1,6183 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'eds-user', + 'version' => '2021-03-08', + ], + 'directories' => [ + [ + 'id' => 205232, + 'title' => '登录', + 'type' => 'directory', + 'children' => [ + 'InitTenantAlias', + ], + ], + [ + 'id' => 165074, + 'title' => '用户', + 'type' => 'directory', + 'children' => [ + 'CreateUsers', + 'RemoveUsers', + 'ModifyUser', + 'ResetUserPassword', + 'LockUsers', + 'UnlockUsers', + 'DescribeUsers', + 'FilterUsers', + 'GetManagerInfoByAuthCode', + 'BatchSetDesktopManager', + ], + ], + [ + 'id' => 165068, + 'title' => '用户属性', + 'type' => 'directory', + 'children' => [ + 'CreateProperty', + 'RemoveProperty', + 'DeleteUserPropertyValue', + 'UpdateProperty', + 'SetUserPropertyValue', + 'ListProperty', + 'ListPropertyValue', + 'CheckUsedProperty', + 'CheckUsedPropertyValue', + ], + ], + [ + 'id' => 188957, + 'title' => '组织', + 'type' => 'directory', + 'children' => [ + 'CreateOrg', + 'DescribeOrgs', + 'DescribeOrgByLayer', + 'RemoveOrg', + 'MoveOrg', + 'ModifyOrg', + 'MoveUserOrg', + ], + ], + [ + 'id' => 222270, + 'title' => '用户组', + 'type' => 'directory', + 'children' => [ + 'CreateGroup', + 'DescribeGroups', + 'UserBatchQuitGroup', + 'UserBatchJoinGroup', + 'RemoveGroup', + 'ModifyGroup', + 'DescribeGroupUser', + ], + ], + [ + 'id' => 165058, + 'title' => 'MFA设备', + 'type' => 'directory', + 'children' => [ + 'RemoveMfaDevice', + 'LockMfaDevice', + 'UnlockMfaDevice', + 'DescribeMfaDevices', + ], + ], + [ + 'id' => 205378, + 'title' => '资源组', + 'type' => 'directory', + 'children' => [ + 'CreateResourceGroup', + 'DeleteResourceGroup', + 'DescribeResourceGroups', + ], + ], + [ + 'id' => 168203, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'SyncAllEduInfo', + 'QuerySyncStatusByAliUid', + 'ChangeUserPassword', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'GroupResources' => [ + 'title' => 'A short description of struct', + 'description' => '资源组中的资源元数据', + 'type' => 'object', + 'properties' => [ + 'Region' => [ + 'title' => 'Region', + 'type' => 'string', + ], + 'ResourceType' => [ + 'title' => 'ResourceType', + 'type' => 'string', + ], + 'ResourceId' => [ + 'title' => 'ResourceId', + 'type' => 'string', + ], + ], + ], + 'ThirdApp' => [ + 'title' => 'A short description of struct', + 'description' => '三方应用', + 'type' => 'object', + 'properties' => [ + 'AppKey' => [ + 'title' => '应用id', + 'type' => 'string', + ], + 'Name' => [ + 'title' => '应用名称', + 'type' => 'string', + ], + 'Secrets' => [ + 'title' => '密钥', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '是否启用', + 'type' => 'boolean', + ], + 'Secret' => [ + 'title' => '密文', + 'type' => 'string', + ], + ], + ], + ], + 'OidcSsoConfig' => [ + 'title' => 'oidc配置', + 'type' => 'object', + 'properties' => [ + 'EnableAuthLogin' => [ + 'title' => '是否开启授权登录', + 'type' => 'boolean', + ], + 'AccessTokenEffectiveTime' => [ + 'title' => '1', + 'type' => 'integer', + 'format' => 'int32', + ], + 'IdTokenEffectiveTime' => [ + 'title' => '1', + 'type' => 'integer', + 'format' => 'int32', + ], + 'RefreshTokenEffective' => [ + 'title' => '1', + 'type' => 'integer', + 'format' => 'int32', + ], + 'CodeEffectiveTime' => [ + 'title' => '1', + 'type' => 'integer', + 'format' => 'int32', + ], + 'IdTokenAlgorithmType' => [ + 'title' => '签名类型', + 'type' => 'string', + ], + 'RedirectUris' => [ + 'title' => 'uri白名单', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'GrantTypes' => [ + 'title' => '类型', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'GrantScopes' => [ + 'title' => '授权', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'Endpoints' => [ + 'title' => '域名', + 'type' => 'object', + 'properties' => [ + 'Issuer' => [ + 'title' => 'Issuer', + 'type' => 'string', + ], + 'DiscoveryEndpoint' => [ + 'title' => '发现端点', + 'type' => 'string', + ], + 'AuthorizationEndpoint' => [ + 'title' => '授权端点', + 'type' => 'string', + ], + 'GuestAuthorizationEndpoint' => [ + 'title' => 'guest授权端点', + 'type' => 'string', + ], + 'TokenEndpoint' => [ + 'title' => 'token端点', + 'type' => 'string', + ], + 'UserinfoEndpoint' => [ + 'title' => '用户信息端点', + 'type' => 'string', + ], + 'JwksEndpoint' => [ + 'title' => '签名公钥端点', + 'type' => 'string', + ], + 'RevokeEndpoint' => [ + 'title' => '销毁端点', + 'type' => 'string', + ], + 'LogoutEndpoint' => [ + 'title' => '退登端点', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'WaIdPermissions' => [ + 'title' => 'permission', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => 'name', + 'type' => 'string', + ], + 'Type' => [ + 'title' => 'type', + 'type' => 'string', + ], + 'Code' => [ + 'title' => 'code', + 'type' => 'string', + ], + 'SubPermissions' => [ + 'title' => 'subPermissions', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/WaIdPermissions', + ], + ], + 'IsBasicChild' => [ + 'title' => 'basic', + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'apis' => [ + 'InitTenantAlias' => [ + 'summary' => '初始化组织ID。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'Data' => [ + 'description' => '生成的组织ID。', + 'type' => 'string', + 'example' => 'WY23***', + ], + 'AliasInfo' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AliasSourceType' => [ + 'description' => '组织ID来源。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Generated' => '自动生成', + 'Customized' => '用户自定义', + ], + 'example' => 'Customized', + ], + 'AliasEditable' => [ + 'description' => '是否允许编辑。', + 'type' => 'boolean', + 'example' => 'False', + ], + 'AliasEditDisabledReason' => [ + 'description' => '不允许编辑的原因。', + 'type' => 'string', + 'example' => 'FrequencyExceedsLimit', + ], + 'NextModifyTime' => [ + 'description' => '允许编辑的时间。', + 'type' => 'string', + 'example' => '2025-04-17 20:31:48', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": \\"WY23***\\",\\n \\"AliasInfo\\": {\\n \\"AliasSourceType\\": \\"Customized\\",\\n \\"AliasEditable\\": true,\\n \\"AliasEditDisabledReason\\": \\"FrequencyExceedsLimit\\",\\n \\"NextModifyTime\\": \\"2025-04-17 20:31:48\\"\\n }\\n}","type":"json"}]', + 'title' => '初始化组织ID', + ], + 'CreateUsers' => [ + 'summary' => '为终端用户创建便捷账号。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '18911', + 'abilityTreeNodes' => [ + 'FEATUREgwsZABQI3', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Users', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '便捷账号信息。', + 'type' => 'array', + 'items' => [ + 'description' => '便捷账号信息。', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => [ + 'description' => '用户名。自定义设置，由小写字母、数字和下划线组成，长度为3~24个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'alice', + ], + 'Email' => [ + 'description' => '邮箱。用于接收相关邮件，如分配云电脑的通知邮件。邮箱和手机号二选一必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'username@example.com', + ], + 'Phone' => [ + 'description' => '手机号。用于接收相关短信，如分配云电脑的通知短信。邮箱和手机号二选一必填。'."\n" + ."\n" + .'国际站不支持手机号。', + 'type' => 'string', + 'required' => false, + 'example' => '1381111****', + ], + 'Password' => [ + 'description' => '用户密码。'."\n" + ."\n" + .'> 密码长度不少于10位，且至少包含大写字母、小写字母、数字、特殊字符（除空格）中的任意三种。', + 'type' => 'string', + 'required' => false, + 'example' => 'Wuying1234', + ], + 'OwnerType' => [ + 'description' => '账号激活类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CreateFromManager' => '管理员激活', + 'Normal' => '用户激活', + ], + 'example' => 'Normal', + ], + 'OrgId' => [ + 'description' => '用户所属的组织。', + 'type' => 'string', + 'required' => false, + 'example' => 'design', + ], + 'Remark' => [ + 'description' => '用户备注。', + 'type' => 'string', + 'required' => false, + 'example' => 'remark1', + ], + 'RealNickName' => [ + 'description' => '用户的显示名。', + 'type' => 'string', + 'required' => false, + 'example' => 'Bean', + ], + 'GroupIdList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + 'required' => true, + 'example' => 'CreateUsers', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Password', + 'in' => 'formData', + 'schema' => [ + 'description' => '初始密码。如果不设置，将发送重置密码邮件到用户邮箱。', + 'type' => 'string', + 'required' => false, + 'example' => 'Test123****', + 'maxLength' => 256, + ], + ], + [ + 'name' => 'AutoLockTime', + 'in' => 'query', + 'schema' => [ + 'description' => '自动锁定账号的日期。日期格式 yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-11-28 00:00:00', + ], + ], + [ + 'name' => 'IsLocalAdmin', + 'in' => 'query', + 'schema' => [ + 'description' => '是否将该便捷账号设为本地管理员。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PasswordExpireDays', + 'in' => 'query', + 'schema' => [ + 'description' => '用户账号的密码默认为永久有效，可通过此参数设置30\\~365天的密码有效期，当密码到期后，终端用户必须先修改密码才能继续登录。'."\n" + ."\n" + .'> 该功能目前处于邀测中，如需体验，请提交工单申请开通。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'CreateResult' => [ + 'description' => '创建便捷账号操作的结果。', + 'type' => 'object', + 'properties' => [ + 'CreatedUsers' => [ + 'description' => '创建成功的便捷账号信息。', + 'type' => 'array', + 'items' => [ + 'description' => '创建成功的便捷账号信息。', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test1', + ], + 'Email' => [ + 'description' => '邮箱。', + 'type' => 'string', + 'example' => 'username@example.com', + ], + 'Phone' => [ + 'description' => '手机号。', + 'type' => 'string', + 'example' => '1381111****', + ], + 'Remark' => [ + 'description' => '用户备注。', + 'type' => 'string', + 'example' => 'remark1', + ], + 'RealNickName' => [ + 'description' => '用户的显示名。', + 'type' => 'string', + 'example' => 'Bean', + ], + ], + ], + ], + 'FailedUsers' => [ + 'description' => '创建失败的便捷账号信息。', + 'type' => 'array', + 'items' => [ + 'description' => '创建失败的便捷账号信息。', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'test2', + ], + 'Email' => [ + 'description' => '邮箱。', + 'type' => 'string', + 'example' => 'username2@example.com', + ], + 'Phone' => [ + 'description' => '手机号。', + 'type' => 'string', + 'example' => '1390000****', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'ExistedEndUserId', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The username test is used by another user.', + ], + ], + ], + ], + ], + ], + 'AllSucceed' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'INTERNAL_ERROR', + 'errorMessage' => 'Internal error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"CreateResult\\": {\\n \\"CreatedUsers\\": [\\n {\\n \\"EndUserId\\": \\"test1\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Remark\\": \\"remark1\\",\\n \\"RealNickName\\": \\"Bean\\"\\n }\\n ],\\n \\"FailedUsers\\": [\\n {\\n \\"EndUserId\\": \\"test2\\",\\n \\"Email\\": \\"username2@example.com\\",\\n \\"Phone\\": \\"1390000****\\",\\n \\"ErrorCode\\": \\"ExistedEndUserId\\",\\n \\"ErrorMessage\\": \\"The username test is used by another user.\\"\\n }\\n ]\\n },\\n \\"AllSucceed\\": true\\n}","type":"json"}]', + 'title' => '创建便捷账号', + 'description' => '便捷账号是无影专用的账号体系，适用于不希望对接企业AD的简单场景。便捷账号信息包括用户名、邮箱和手机号。其中，用户名为必填信息，邮箱和手机号至少填写一项。'."\n" + ."\n" + .'便捷账号是无影专用的账号体系，适用于不希望对接企业AD的简单场景。便捷账号信息包括用户名和邮箱，均为必填信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveUsers' => [ + 'summary' => '删除一个或者多个便捷账号。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Users', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要删除的便捷账号的用户名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '要删除的便捷账号的用户名。用户名可以通过[DescribeUsers](~~DescribeUsers~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + 'required' => true, + 'example' => 'test1', + 'maxItems' => 500, + 'minItems' => 1, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'RemoveUsersResult' => [ + 'description' => '删除便捷账号操作的结果。', + 'type' => 'object', + 'properties' => [ + 'RemovedUsers' => [ + 'description' => '删除成功的便捷账号。', + 'type' => 'array', + 'items' => [ + 'description' => '删除成功的便捷账号。', + 'type' => 'string', + 'example' => 'test1', + ], + ], + 'FailedUsers' => [ + 'description' => '删除失败的用户信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '删除失败的便捷账号。', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => [ + 'description' => '删除失败的便捷账号。', + 'type' => 'string', + 'example' => 'test2', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'InvalidUsername', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'test2 is an invalid username.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"RemoveUsersResult\\": {\\n \\"RemovedUsers\\": [\\n \\"test1\\"\\n ],\\n \\"FailedUsers\\": [\\n {\\n \\"EndUserId\\": \\"test2\\",\\n \\"ErrorCode\\": \\"InvalidUsername\\",\\n \\"ErrorMessage\\": \\"test2 is an invalid username.\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 45341120-2560-4087-8359-B936E58DDB90\\n \\n \\n test2\\n InvalidUsername\\n test2 is invalid username\\n \\n test1\\n \\n","errorExample":""}]', + 'title' => '删除便捷账号', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyUser' => [ + 'summary' => '修改便捷账号的联系方式。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '便捷账号的用户ID，对应控制台上显示的`用户名`字段。', + 'type' => 'string', + 'required' => true, + 'example' => 'alice', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '便捷账号的邮箱地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'username@example.com', + ], + ], + [ + 'name' => 'Phone', + 'in' => 'query', + 'schema' => [ + 'description' => '编辑账号的手机号码。', + 'type' => 'string', + 'required' => false, + 'example' => '1381111****', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => '修改便捷账号的联系方式', + ], + 'ResetUserPassword' => [ + 'summary' => '重置便捷账号的密码，包括生成重置密码Token，并发送重置密码邮件到便捷账号的邮箱。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Users', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要重置密码的便捷账号的用户名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '要重置密码的便捷账号的用户名。', + 'type' => 'string', + 'required' => true, + 'example' => 'alice', + ], + 'required' => true, + 'example' => 'test1', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'NotifyType', + 'in' => 'formData', + 'schema' => [ + 'description' => '重置密码后通知用户的方式。'."\n" + ."\n" + .'> 国际站账号不支持通过短信通知用户的方式。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + 1 => '通过邮箱通知用户', + '通过短信通知用户', + '邮箱和短信都发送通知', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '32D05B39-E6EE-4D7A-9FD0-762A26859D0D', + ], + 'ResetUsersResult' => [ + 'description' => '重置便捷账号密码操作的结果。', + 'type' => 'object', + 'properties' => [ + 'ResetUsers' => [ + 'description' => '已发送重置密码邮件的便捷账号列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已发送重置密码邮件的便捷账号。', + 'type' => 'string', + 'example' => 'test1', + ], + ], + 'FailedUsers' => [ + 'description' => '重置密码失败的便捷账号列表。', + 'type' => 'array', + 'items' => [ + 'description' => '重置密码失败的便捷账号信息集合。', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => [ + 'description' => '重置密码失败的便捷账号。', + 'type' => 'string', + 'example' => 'alice', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'InvalidUsername', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'test123 is an invalid username.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"32D05B39-E6EE-4D7A-9FD0-762A26859D0D\\",\\n \\"ResetUsersResult\\": {\\n \\"ResetUsers\\": [\\n \\"test1\\"\\n ],\\n \\"FailedUsers\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"ErrorCode\\": \\"InvalidUsername\\",\\n \\"ErrorMessage\\": \\"test123 is an invalid username.\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 32D05B39-E6EE-4D7A-9FD0-762A26859D0D\\n \\n test1\\n \\n","errorExample":""}]', + 'title' => '重置便捷账号的密码', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'LockUsers' => [ + 'summary' => '锁定一个或者多个便捷账号。锁定后的便捷账号无法登录无影终端。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Users', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要锁定的便捷账号的用户名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '要锁定的便捷账号的用户名。', + 'type' => 'string', + 'required' => true, + 'example' => 'alice', + ], + 'required' => true, + 'example' => 'test1', + 'maxItems' => 500, + ], + ], + [ + 'name' => 'LogoutSession', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'LockUsersResult' => [ + 'description' => '锁定便捷账号操作的结果。', + 'type' => 'object', + 'properties' => [ + 'LockedUsers' => [ + 'description' => '锁定成功的便捷账号列表。', + 'type' => 'array', + 'items' => [ + 'description' => '锁定成功的便捷账号。', + 'type' => 'string', + 'example' => 'alice', + ], + ], + 'FailedUsers' => [ + 'description' => '锁定失败的便捷账号列表。', + 'type' => 'array', + 'items' => [ + 'description' => '锁定失败的便捷账号信息集合。', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => [ + 'description' => '锁定失败的便捷账号。', + 'type' => 'string', + 'example' => 'alice', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'InvalidUsername', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'test123 is an invalid username.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"LockUsersResult\\": {\\n \\"LockedUsers\\": [\\n \\"alice\\"\\n ],\\n \\"FailedUsers\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"ErrorCode\\": \\"InvalidUsername\\",\\n \\"ErrorMessage\\": \\"test123 is an invalid username.\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n test1\\n \\n EC4A8495-3323-4364-A374-FEE8584644F8\\n","errorExample":""}]', + 'title' => '锁定便捷账号', + 'description' => '出于安全考虑，您可以锁定便捷账号。被锁定的便捷用户无法登录无影终端，因此也无法访问任何无影云资源。'."\n" + ."\n" + .'> 您可以调用[DescribeUsers](~~283609~~)查询便捷账号信息。若返回数据中`Status`取值为0，表示该便捷账号未被锁定；若`Status`取值为9，表示该便捷账号已被锁定。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UnlockUsers' => [ + 'summary' => '解锁一个或者多个便捷账号。解锁后的便捷账号可以登录无影终端。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Users', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要解锁的便捷账号的用户名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '要解锁的便捷账号的用户名。', + 'type' => 'string', + 'required' => true, + 'example' => 'alice', + ], + 'required' => true, + 'example' => 'test1', + 'maxItems' => 500, + ], + ], + [ + 'name' => 'AutoLockTime', + 'in' => 'query', + 'schema' => [ + 'description' => '自动锁定便捷账号的日期。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-03-03', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '023F4EC4-3602-4A3E-A514-4970847D59DB', + ], + 'UnlockUsersResult' => [ + 'description' => '解锁便捷账号操作的结果。', + 'type' => 'object', + 'properties' => [ + 'UnlockedUsers' => [ + 'description' => '解锁成功的便捷账号列表。', + 'type' => 'array', + 'items' => [ + 'description' => '解锁成功的便捷账号。', + 'type' => 'string', + 'example' => 'alice', + ], + ], + 'FailedUsers' => [ + 'description' => '解锁失败的便捷账号列表。', + 'type' => 'array', + 'items' => [ + 'description' => '解锁失败的便捷账号信息集合。', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => [ + 'description' => '解锁失败的便捷账号。', + 'type' => 'string', + 'example' => 'alice', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'InvalidUsername', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'test123 is an invalid username.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"023F4EC4-3602-4A3E-A514-4970847D59DB\\",\\n \\"UnlockUsersResult\\": {\\n \\"UnlockedUsers\\": [\\n \\"alice\\"\\n ],\\n \\"FailedUsers\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"ErrorCode\\": \\"InvalidUsername\\",\\n \\"ErrorMessage\\": \\"test123 is an invalid username.\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 023F4EC4-3602-4A3E-A514-4970847D59DB\\n \\n test1\\n \\n","errorExample":""}]', + 'title' => '解锁便捷账号', + 'description' => '被锁定的便捷账号无法登录无影终端，因此也无法访问任何无影云资源。如需允许便捷账号登录无影终端，需要先将其解锁。'."\n" + ."\n" + .'> 您可以调用[DescribeUsers](~~283609~~)查询便捷账号信息。若返回数据中`Status`取值为0，表示该便捷账号未被锁定；若`Status`取值为9，表示该便捷账号已被锁定。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeUsers' => [ + 'summary' => '查询便捷账号信息，例如用户名、邮箱地址、备注名称等。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页行数。 '."\n" + ."\n" + .'- 取值范围：1~500。 '."\n" + .'- 默认值：200。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '500', + 'minimum' => '1', + 'enumValueTitles' => [], + 'example' => '10', + 'default' => '500', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一次查询的Token。首次调用接口时无需设置该参数。 '."\n" + .'如果一次查询结果并没有完整返回所有的结果，则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'description' => '模糊搜索字符串，支持匹配用户名（EndUserId）和邮箱（Email）。该字段支持使用通配符（*），例如将该字段设为`a*m`，则返回用户名或邮箱以`a`开头、以`m`结尾的所有结果。', + 'type' => 'string', + 'required' => false, + 'example' => 'a*m', + ], + ], + [ + 'name' => 'FilterMap', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + [ + 'name' => 'EndUserIds', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需精确匹配的用户名（EndUserId）列表。', + 'type' => 'array', + 'items' => [ + 'description' => '按用户名（EndUserId）精确匹配，查询用户名一致的账号信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'alice', + ], + 'required' => false, + 'maxItems' => 500, + ], + ], + [ + 'name' => 'ExcludeEndUserIds', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需精确排除的用户名（EndUserId）列表。', + 'type' => 'array', + 'items' => [ + 'description' => '按用户名（EndUserId）精确排除，查询不包含该用户名的账号列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'tony', + ], + 'required' => false, + 'maxItems' => 500, + ], + ], + [ + 'name' => 'OrgId', + 'in' => 'formData', + 'schema' => [ + 'description' => '按组织ID精确匹配，查询归属该组织的账号列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'org-4mdgc1cocc59z****', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '按用户组ID精确匹配，查询归属该用户组的账号列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'ug-12341234****', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'formData', + 'schema' => [ + 'description' => '> 该参数不对外开放使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'SolutionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '> 该参数不对外开放使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'ShowExtras', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '查询用户扩展信息。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'DesktopGroup: true', + 'description' => 'key为以下类型，值为Boolean类型，传true表示筛选分配该云资源的用户。'."\n" + ."\n" + .'- Desktop: 云电脑。'."\n" + .'- DesktopGroup: 共享型云电脑。'."\n" + .'- CloudDrive: 企业网盘（用户个人盘）。'."\n" + .'- App: 云应用。', + ], + ], + ], + [ + 'name' => 'FilterWithAssignedResources', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '根据否分配云资源筛选用户。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'boolean', + ], + ], + ], + [ + 'name' => 'IsQueryAllSubOrgs', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否查询子组织下的用户。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'FilterWithAssignedResource', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'title' => '状态', + 'description' => '状态', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'ExcludeGroupId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'NextToken' => [ + 'description' => '下一次查询的Token。NextToken为空表示没有下一次。', + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + 'Users' => [ + 'title' => 'users', + 'description' => '便捷账号信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '便捷账号信息集合。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '便捷账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4205**', + ], + 'EndUserId' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'alice', + ], + 'Email' => [ + 'description' => '邮箱。', + 'type' => 'string', + 'example' => 'username@example.com', + ], + 'Phone' => [ + 'description' => '手机号，如未设置该参数则不返回该参数。', + 'type' => 'string', + 'example' => '1381111****', + ], + 'Status' => [ + 'description' => '状态。', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + '正常', + 9 => '锁定', + ], + 'example' => '0', + ], + 'OwnerType' => [ + 'description' => '便捷账号类型，包括：'."\n" + ."\n" + .'* 管理员激活类型，管理员设置用户名及用户密码，重置密码等用户通知将发送到管理员的邮箱或手机。'."\n" + .'* 用户激活类型，管理员设置用户名及用户接收通知的邮件或手机，云电脑开通通知（含初始密码）等用户通知将发送到用户的邮件或手机。', + 'type' => 'string', + 'enumValueTitles' => [ + 'CreateFromManager' => '管理员激活', + 'Normal' => '用户激活', + ], + 'example' => 'Normal', + ], + 'Remark' => [ + 'description' => '便捷账号的备注。', + 'type' => 'string', + 'example' => 'Test user.', + ], + 'OrgId' => [ + 'description' => '便捷账号归属的部门ID。'."\n" + .'> 该参数即将废弃。', + 'type' => 'string', + 'example' => 'org-4mdgc1cocc59z****', + ], + 'WyId' => [ + 'description' => '便捷账号的全局唯一ID。', + 'type' => 'string', + 'example' => '41fd1254d8f7****', + ], + 'IsTenantManager' => [ + 'description' => '是否为用户管理员。如果创建的便捷账号是管理员激活类型，则必须指定一位用户管理员，终端用户通过客户端重置密码等通知将发送到该用户管理员的邮箱或手机，详情参见[创建便捷账号](~~214472~~)。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Groups' => [ + 'description' => '便捷账号归属的用户组集合。', + 'type' => 'array', + 'items' => [ + 'description' => '便捷账号归属的用户组属性。', + 'type' => 'object', + 'properties' => [ + 'GroupId' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'example' => 'ug-12341234****', + ], + 'GroupName' => [ + 'description' => '用户组名称。', + 'type' => 'string', + 'example' => '用户组1', + ], + ], + ], + ], + 'Orgs' => [ + 'description' => '便捷账号归属的部门集合。', + 'type' => 'array', + 'items' => [ + 'description' => '便捷账号归属的部门属性。', + 'type' => 'object', + 'properties' => [ + 'OrgId' => [ + 'description' => '部门ID。', + 'type' => 'string', + 'example' => 'org-4mdgc1cocc59z****', + ], + 'OrgName' => [ + 'description' => '部门名称。', + 'type' => 'string', + 'example' => '部门1', + ], + 'OrgNamePath' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Avatar' => [ + 'description' => '用户头像URL。', + 'type' => 'string', + 'example' => 'https://cdn.*****', + ], + 'Address' => [ + 'description' => '用户工作地址。', + 'type' => 'string', + 'example' => '杭州市***', + ], + 'NickName' => [ + 'description' => '用户昵称。 '."\n" + .'按以下顺序取值：'."\n" + .'- RealNickName'."\n" + .'- Remark'."\n" + .'- EndUserId', + 'type' => 'string', + 'example' => '李**', + ], + 'RealNickName' => [ + 'description' => '用户显示名。', + 'type' => 'string', + 'example' => '李**', + ], + 'JobNumber' => [ + 'description' => '用户工号。', + 'type' => 'string', + 'example' => 'A10000**', + ], + 'Extras' => [ + 'description' => '用户扩展信息。', + 'type' => 'object', + 'properties' => [ + 'AssignedResourceCount' => [ + 'description' => '已分配的云资源个数。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'Desktop: 3', + 'description' => '支持的云资源类型：'."\n" + ."\n" + .'- Desktop：云电脑。'."\n" + .'- DesktopGroup：共享型云电脑。'."\n" + .'- CloudDrive：企业网盘（用户个人盘）。'."\n" + .'- APP：云应用。', + ], + ], + ], + ], + 'ExternalName' => [ + 'description' => '外部导入的用户名称。'."\n" + ."\n" + .'> 该字段暂未对外开放使用。', + 'type' => 'string', + 'example' => '马**', + ], + 'Properties' => [ + 'description' => '用户属性。', + 'type' => 'array', + 'items' => [ + 'description' => '属性列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '属性名。', + 'type' => 'string', + 'example' => 'Role', + ], + 'Value' => [ + 'description' => '属性值。', + 'type' => 'string', + 'example' => 'Student', + ], + ], + ], + ], + 'EnableAdminAccess' => [ + 'title' => '启用管理员访问权限', + 'description' => '启用管理员访问权限', + 'type' => 'boolean', + ], + 'PasswordExpireDays' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PasswordExpireRestDays' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Users\\": [\\n {\\n \\"Id\\": 0,\\n \\"EndUserId\\": \\"alice\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Status\\": 0,\\n \\"OwnerType\\": \\"Normal\\",\\n \\"Remark\\": \\"Test user.\\",\\n \\"OrgId\\": \\"org-4mdgc1cocc59z****\\",\\n \\"WyId\\": \\"41fd1254d8f7****\\",\\n \\"IsTenantManager\\": true,\\n \\"Groups\\": [\\n {\\n \\"GroupId\\": \\"ug-12341234****\\",\\n \\"GroupName\\": \\"用户组1\\"\\n }\\n ],\\n \\"Orgs\\": [\\n {\\n \\"OrgId\\": \\"org-4mdgc1cocc59z****\\",\\n \\"OrgName\\": \\"部门1\\",\\n \\"OrgNamePath\\": \\"\\"\\n }\\n ],\\n \\"Avatar\\": \\"https://cdn.*****\\",\\n \\"Address\\": \\"杭州市***\\",\\n \\"NickName\\": \\"李**\\",\\n \\"RealNickName\\": \\"李**\\",\\n \\"JobNumber\\": \\"A10000**\\",\\n \\"Extras\\": {\\n \\"AssignedResourceCount\\": {\\n \\"key\\": \\"Desktop: 3\\"\\n }\\n },\\n \\"ExternalName\\": \\"马**\\",\\n \\"Properties\\": [\\n {\\n \\"Key\\": \\"Role\\",\\n \\"Value\\": \\"Student\\"\\n }\\n ],\\n \\"EnableAdminAccess\\": true,\\n \\"PasswordExpireDays\\": 0,\\n \\"PasswordExpireRestDays\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n BA75EDC9-8A5F-40C2-ABD5-EBAE56A4D67C\\n \\n 0\\n test1@example***.com\\n test1\\n 12345\\n \\n","errorExample":""}]', + 'title' => '查询便捷账号信息', + 'requestParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'FilterUsers' => [ + 'summary' => '按用户属性筛选查询便捷账号信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '36913', + 'abilityTreeNodes' => [ + 'FEATUREgwsZABQI3', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页行数（大于100时会自动重置为100）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一次查询的Token。首次调用接口时无需设置该参数。如果一次查询结果并没有完整返回所有的结果，则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'description' => '模糊搜索字符串，支持匹配用户名（EndUserId）和邮箱（Email）。该字段支持使用通配符（\\*），例如将该字段设为a*m，则返回用户名或邮箱以a开头、以m结尾的所有结果。', + 'type' => 'string', + 'required' => false, + 'example' => 'a*m', + ], + ], + [ + 'name' => 'PropertyFilterParam', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要模糊查询的用户属性列表。', + 'type' => 'array', + 'items' => [ + 'description' => '要模糊查询的用户属性。', + 'type' => 'object', + 'properties' => [ + 'PropertyId' => [ + 'description' => '属性ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '328', + ], + 'PropertyValueIds' => [ + 'description' => '属性值ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1255', + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PropertyKeyValueFilterParam', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '属性名和属性值信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '属性名和属性值信息。', + 'type' => 'object', + 'properties' => [ + 'PropertyKey' => [ + 'description' => '属性名。', + 'type' => 'string', + 'required' => false, + 'example' => 'job', + ], + 'PropertyValues' => [ + 'description' => '属性值。', + 'type' => 'string', + 'required' => false, + 'example' => 'dev', + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'IncludeDesktopCount', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回已分配给该用户的云电脑数量。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '返回分配的云电脑数量', + 'false' => '不返回分配的云电脑数量', + ], + 'example' => 'true', + ], + ], + [ + 'name' => 'IncludeDesktopGroupCount', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回已分配给该用户的云电脑池数量。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '返回分配的云电脑池数量', + 'false' => '不返回分配的云电脑池数量', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'OrgId', + 'in' => 'query', + 'schema' => [ + 'description' => '企业组织ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'org-aliyun-wy-org-id', + ], + ], + [ + 'name' => 'OwnerType', + 'in' => 'query', + 'schema' => [ + 'description' => '账号激活类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CreateFromManager' => '管理员激活', + 'Normal' => '用户激活', + ], + 'example' => 'Normal', + ], + ], + [ + 'name' => 'IncludeEndUserIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + 'maxItems' => 500, + ], + ], + [ + 'name' => 'ExcludeEndUserIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需精确排除的用户名（EndUserId）列表。', + 'type' => 'array', + 'items' => [ + 'description' => '按用户名（EndUserId）精确排除，查询不包含该用户名的用户列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'tony', + ], + 'required' => false, + 'maxItems' => 2000, + ], + ], + [ + 'name' => 'OrderParam', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '支持的排序参数。', + 'type' => 'object', + 'properties' => [ + 'OrderField' => [ + 'description' => '按此参数排序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'EndUserId' => '用户名', + 'id' => '用户主键ID', + 'gmt_created' => '创建时间', + ], + 'example' => 'id', + ], + 'OrderType' => [ + 'description' => '升序或降序。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ASC' => '升序', + 'DESC' => '降序 [默认值]', + ], + 'example' => 'DESC', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '状态', + 'description' => '筛选用户状态。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [ + '正常状态', + 11 => '已离职', + ], + 'example' => '0', + ], + ], + [ + 'name' => 'IsQueryAllSubOrgs', + 'in' => 'query', + 'schema' => [ + 'title' => '是否查询所有子组织', + 'description' => '是否查询所有子组织', + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'IncludeOrgInfo', + 'in' => 'query', + 'schema' => [ + 'title' => '是否包含组织信息', + 'description' => '是否包含组织信息', + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'IncludeSupportIdps', + 'in' => 'query', + 'schema' => [ + 'title' => '包含支持的登录类型', + 'description' => '包含支持的登录类型', + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + [ + 'name' => 'FilterMap', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'NextToken' => [ + 'description' => '下一次查询的Token。如果一次查询结果并没有完整返回所有的结果，则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。', + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a****', + ], + 'Users' => [ + 'title' => 'users', + 'description' => '便捷账号信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '便捷账号信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4205**', + ], + 'EndUserId' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'alice', + ], + 'Email' => [ + 'description' => '邮箱。', + 'type' => 'string', + 'example' => 'username@example.com', + ], + 'Phone' => [ + 'description' => '手机号。', + 'type' => 'string', + 'example' => '1381111****', + ], + 'Status' => [ + 'description' => '便捷账号的状态。', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + '正常', + 9 => '锁定', + 11 => '已离职', + ], + 'example' => '0', + ], + 'UserSetPropertiesModels' => [ + 'description' => '用户属性集合。', + 'type' => 'array', + 'items' => [ + 'description' => '用户属性。', + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'description' => '绑定属性的用户ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4205**', + ], + 'UserName' => [ + 'description' => '绑定属性的用户名。', + 'type' => 'string', + 'example' => 'alice', + ], + 'PropertyId' => [ + 'description' => '用户属性ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'PropertyKey' => [ + 'description' => '用户属性名称。', + 'type' => 'string', + 'example' => 'department', + ], + 'PropertyType' => [ + 'description' => '用户属性编号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PropertyValues' => [ + 'description' => '用户属性值。', + 'type' => 'array', + 'items' => [ + 'description' => '用户属性值。', + 'type' => 'object', + 'properties' => [ + 'PropertyValueId' => [ + 'description' => '用户属性值ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42', + ], + 'PropertyValue' => [ + 'description' => '用户属性值。', + 'type' => 'string', + 'example' => 'dev', + ], + ], + ], + ], + ], + ], + ], + 'DesktopCount' => [ + 'description' => '分配给该用户的云电脑数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExternalInfo' => [ + 'description' => '用户扩展信息。', + 'type' => 'object', + 'properties' => [ + 'ExternalName' => [ + 'description' => '用户对接的账号名称。', + 'type' => 'string', + 'example' => 'account', + ], + 'JobNumber' => [ + 'description' => '用户对接的账号、学号或工号。', + 'type' => 'string', + 'example' => '030801', + ], + ], + ], + 'DesktopGroupCount' => [ + 'description' => '用户拥有授权的云电脑池数量。当`IncludeDesktopGroupCount`取值为`true`时，返回该值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'OwnerType' => [ + 'description' => '账号归属类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'CreateFromManager' => '管理员激活', + 'Normal' => '用户激活', + ], + 'example' => 'Normal', + ], + 'Remark' => [ + 'description' => '用户备注。', + 'type' => 'string', + 'example' => '测试专用', + ], + 'IsTenantManager' => [ + 'description' => '是否租户管理员。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'true', + ], + 'EnableAdminAccess' => [ + 'description' => '是否本地管理员。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '是', + 'false' => '否', + ], + 'example' => 'true', + ], + 'RealNickName' => [ + 'description' => '用户昵称。', + 'type' => 'string', + 'example' => '小明', + ], + 'AutoLockTime' => [ + 'description' => '自动锁定账号的日期。', + 'type' => 'string', + 'example' => '2023-03-03', + ], + 'PasswordExpireDays' => [ + 'description' => '用户账号的密码默认为永久有效，可通过此参数设置30\\~365天的密码有效期，当密码到期后，终端用户必须先修改密码才能继续登录。'."\n" + ."\n" + .'> 该功能目前处于邀测中，如需体验，请提交工单申请开通。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PasswordExpireRestDays' => [ + 'description' => '账号密码有效期的剩余天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'OrgList' => [ + 'title' => '用户所属组织列表', + 'description' => '用户所属组织列表', + 'type' => 'array', + 'items' => [ + 'title' => '用户所属组织列表', + 'description' => '用户所属组织列表', + 'type' => 'object', + 'properties' => [ + 'OrgId' => [ + 'title' => '组织结构ID', + 'description' => '组织结构ID', + 'type' => 'string', + ], + 'OrgName' => [ + 'title' => '组织结构名称', + 'description' => '组织结构名称', + 'type' => 'string', + ], + 'OrgNamePath' => [ + 'title' => '组织结构名称路径', + 'description' => '组织结构名称路径', + 'type' => 'string', + ], + ], + ], + ], + 'SupportLoginIdps' => [ + 'title' => '支持的登录身份源方式', + 'description' => '支持的登录身份源方式', + 'type' => 'array', + 'items' => [ + 'title' => '支持的登录身份源方式', + 'description' => '支持的登录身份源方式', + 'type' => 'object', + 'properties' => [ + 'IdpId' => [ + 'title' => '企业身份源ID', + 'description' => '企业身份源ID', + 'type' => 'string', + ], + 'IdpName' => [ + 'title' => '企业身份源名称', + 'description' => '企业身份源名称', + 'type' => 'string', + ], + ], + ], + ], + 'Groups' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GroupId' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"Users\\": [\\n {\\n \\"Id\\": 0,\\n \\"EndUserId\\": \\"alice\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Status\\": 0,\\n \\"UserSetPropertiesModels\\": [\\n {\\n \\"UserId\\": 0,\\n \\"UserName\\": \\"alice\\",\\n \\"PropertyId\\": 12,\\n \\"PropertyKey\\": \\"department\\",\\n \\"PropertyType\\": 2,\\n \\"PropertyValues\\": [\\n {\\n \\"PropertyValueId\\": 42,\\n \\"PropertyValue\\": \\"dev\\"\\n }\\n ]\\n }\\n ],\\n \\"DesktopCount\\": 1,\\n \\"ExternalInfo\\": {\\n \\"ExternalName\\": \\"account\\",\\n \\"JobNumber\\": \\"030801\\"\\n },\\n \\"DesktopGroupCount\\": 2,\\n \\"OwnerType\\": \\"Normal\\",\\n \\"Remark\\": \\"测试专用\\",\\n \\"IsTenantManager\\": true,\\n \\"EnableAdminAccess\\": true,\\n \\"RealNickName\\": \\"小明\\",\\n \\"AutoLockTime\\": \\"2023-03-03\\",\\n \\"PasswordExpireDays\\": 30,\\n \\"PasswordExpireRestDays\\": 10,\\n \\"OrgList\\": [\\n {\\n \\"OrgId\\": \\"\\",\\n \\"OrgName\\": \\"\\",\\n \\"OrgNamePath\\": \\"\\"\\n }\\n ],\\n \\"SupportLoginIdps\\": [\\n {\\n \\"IdpId\\": \\"\\",\\n \\"IdpName\\": \\"\\"\\n }\\n ],\\n \\"Groups\\": [\\n {\\n \\"GroupId\\": \\"\\",\\n \\"GroupName\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n DBD276B5-00FF-5E04-8EF7-5CBA09BF112A\\n \\n 0\\n testName\\n testName@example.com\\n \\n 12345\\n \\n \\n 184\\n true\\n \\n 12345\\n 1\\n enableAdminAccess\\n 145\\n \\n \\n \\n 42\\n A\\n \\n 12345\\n 2\\n department\\n 30\\n \\n \\n","errorExample":""}]', + 'title' => '筛选查询便捷账号信息', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetManagerInfoByAuthCode' => [ + 'summary' => '根据authcode获取当前登录的管理员信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'title' => '授权码', + 'description' => '授权码。', + 'type' => 'string', + 'required' => true, + 'example' => 'e49cd070452f0044813a467d4743****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'WaId' => [ + 'title' => '租户无影账号ID', + 'description' => '租户无影账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345678901234****', + ], + 'OrgId' => [ + 'title' => '组织ID', + 'description' => '组织ID。', + 'type' => 'string', + 'example' => '12345678901234****', + ], + 'UserName' => [ + 'title' => '租户名称', + 'description' => '租户名称。', + 'type' => 'string', + 'example' => 'zhangsan', + ], + 'Phone' => [ + 'title' => '手机号', + 'description' => '手机号。', + 'type' => 'string', + 'example' => '1301234****', + ], + 'TeamName' => [ + 'title' => '团队名称', + 'description' => '团队名称。', + 'type' => 'string', + 'example' => 'devteam', + ], + ], + ], + ], + [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"WaId\\": 0,\\n \\"OrgId\\": \\"12345678901234****\\",\\n \\"UserName\\": \\"zhangsan\\",\\n \\"Phone\\": \\"1301234****\\",\\n \\"TeamName\\": \\"devteam\\"\\n}","type":"json"}]', + 'title' => '根据authcode获取当前登录的管理员信息', + ], + 'BatchSetDesktopManager' => [ + 'summary' => '为便捷账号添加或者去除云电脑的本地管理员权限。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Users', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '便捷账号列表。', + 'type' => 'array', + 'items' => [ + 'description' => '便捷账号。', + 'type' => 'string', + 'required' => true, + 'example' => 'alice', + ], + 'required' => true, + 'maxItems' => 500, + ], + ], + [ + 'name' => 'IsDesktopManager', + 'in' => 'formData', + 'schema' => [ + 'description' => '该便捷账号是否具备云电脑的本地管理员权限。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '否', + '是 [默认值]', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '868B8926-2E7A-5BE7-9897-E811E994****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\"\\n}","type":"json"}]', + 'title' => '为便捷账号添加或去除本地管理员权限', + 'description' => '获得本地管理员权限的便捷账号可以在云电脑中自行安装软件，或者修改某些系统设置。', + ], + 'CreateProperty' => [ + 'summary' => '创建一个用户属性。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PropertyKey', + 'in' => 'formData', + 'schema' => [ + 'description' => '属性名。', + 'type' => 'string', + 'required' => true, + 'example' => 'department', + ], + ], + [ + 'name' => 'PropertyValues', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '属性值。一个属性下最多可以添加50个不同的属性值。', + 'type' => 'array', + 'items' => [ + 'description' => '属性值。', + 'type' => 'string', + 'required' => false, + 'example' => 'HR', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'CreateResult' => [ + 'description' => '创建结果。', + 'type' => 'object', + 'properties' => [ + 'PropertyId' => [ + 'description' => '属性ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '390', + ], + 'PropertyKey' => [ + 'description' => '属性名。', + 'type' => 'string', + 'example' => 'department', + ], + 'SavePropertyValueModel' => [ + 'description' => '属性值创建结果。', + 'type' => 'object', + 'properties' => [ + 'SavePropertyValues' => [ + 'description' => '创建成功的属性值。', + 'type' => 'array', + 'items' => [ + 'description' => '创建成功的属性值。', + 'type' => 'object', + 'properties' => [ + 'PropertyValueId' => [ + 'description' => '属性值ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '978', + ], + 'PropertyValue' => [ + 'description' => '属性值。', + 'type' => 'string', + 'example' => 'HR', + ], + ], + ], + ], + 'FailedPropertyValues' => [ + 'description' => '创建失败的属性值。', + 'type' => 'array', + 'items' => [ + 'description' => '修改失败的属性值。', + 'type' => 'object', + 'properties' => [ + 'PropertyId' => [ + 'description' => '属性值ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '390', + ], + 'PropertyValue' => [ + 'description' => '属性值。', + 'type' => 'string', + 'example' => 'HR', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'ExistedPropertyValue', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The property value is used by another property.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"CreateResult\\": {\\n \\"PropertyId\\": 390,\\n \\"PropertyKey\\": \\"department\\",\\n \\"SavePropertyValueModel\\": {\\n \\"SavePropertyValues\\": [\\n {\\n \\"PropertyValueId\\": 978,\\n \\"PropertyValue\\": \\"HR\\"\\n }\\n ],\\n \\"FailedPropertyValues\\": [\\n {\\n \\"PropertyId\\": 390,\\n \\"PropertyValue\\": \\"HR\\",\\n \\"ErrorCode\\": \\"ExistedPropertyValue\\",\\n \\"ErrorMessage\\": \\"The property value is used by another property.\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 499B0E01-8AE3-5099-95CE-E69CF4DBE177\\n \\n 390\\n department\\n \\n \\n 978\\n HR\\n \\n \\n 390\\n HR\\n ExistedPropertyValue\\n property value is used by other property\\n \\n \\n \\n","errorExample":""}]', + 'title' => '创建用户自定义属性', + 'description' => '- 一个阿里云账号下最多可以创建10个不同的属性。每个属性包括一个属性名（PropertyKey）和多个属性值（PropertyValue）。'."\n" + .'- 一个属性下最多可以添加50个不同的属性值。', + ], + 'RemoveProperty' => [ + 'summary' => '删除一组用户属性。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'PropertyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '属性ID。您可以调用[ListProperty](~~410890~~)进行查询。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '390', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D6C62E40-F937-5803-B008-92E813399BA5\\n","errorExample":""}]', + 'title' => '删除用户自定义属性', + ], + 'DeleteUserPropertyValue' => [ + 'summary' => '解除一个用户与某个用户属性的绑定关系。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户ID。可以调用[DescribeUsers](~~DescribeUsers~~)获取该参数，对应返回参数`Id`的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'PropertyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '属性ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '390', + ], + ], + [ + 'name' => 'PropertyValueId', + 'in' => 'formData', + 'schema' => [ + 'description' => '属性值ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '978', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D6C62E40-F937-5803-B008-92E813399BA5', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6C62E40-F937-5803-B008-92E813399BA5\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D6C62E40-F937-5803-B008-92E813399BA5\\n","errorExample":""}]', + 'title' => '为用户移除自定义属性', + ], + 'UpdateProperty' => [ + 'summary' => '修改用户属性。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PropertyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '要修改的属性ID。您可以调用[ListProperty](~~ListProperty~~)进行查询。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '390', + ], + ], + [ + 'name' => 'PropertyKey', + 'in' => 'formData', + 'schema' => [ + 'description' => '修改后的属性名。', + 'type' => 'string', + 'required' => true, + 'example' => 'testkey', + ], + ], + [ + 'name' => 'PropertyValues', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '修改后该属性的所有属性值列表。'."\n" + ."\n" + .'>此处传入的属性值将覆盖原来的属性值，而不是在原有的基础上追加。>', + 'type' => 'array', + 'items' => [ + 'description' => '修改后该属性的所有属性值。', + 'type' => 'object', + 'properties' => [ + 'PropertyValueId' => [ + 'description' => '修改后该属性的属性值ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '978', + ], + 'PropertyValue' => [ + 'description' => '修改后该属性的属性值。', + 'type' => 'string', + 'required' => false, + 'example' => 'testvalue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'UpdateResult' => [ + 'description' => '修改结果。', + 'type' => 'object', + 'properties' => [ + 'PropertyId' => [ + 'description' => '属性ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '390', + ], + 'PropertyKey' => [ + 'description' => '属性名。', + 'type' => 'string', + 'example' => 'testkey2', + ], + 'SavePropertyValueModel' => [ + 'description' => '属性值修改结果。', + 'type' => 'object', + 'properties' => [ + 'SavePropertyValues' => [ + 'description' => '修改成功的属性值。', + 'type' => 'array', + 'items' => [ + 'description' => '修改成功的属性值。', + 'type' => 'object', + 'properties' => [ + 'PropertyValueId' => [ + 'description' => '属性值ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '978', + ], + 'PropertyValue' => [ + 'description' => '属性值。', + 'type' => 'string', + 'example' => 'testvalue2', + ], + ], + ], + ], + 'FailedPropertyValues' => [ + 'description' => '修改失败的属性值。', + 'type' => 'array', + 'items' => [ + 'description' => '修改失败的属性值。', + 'type' => 'object', + 'properties' => [ + 'PropertyId' => [ + 'description' => '属性ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '390', + ], + 'PropertyValue' => [ + 'description' => '属性值。', + 'type' => 'string', + 'example' => 'testvalue', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'ExistedPropertyValue', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'The property value is used by another property.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"UpdateResult\\": {\\n \\"PropertyId\\": 390,\\n \\"PropertyKey\\": \\"testkey2\\",\\n \\"SavePropertyValueModel\\": {\\n \\"SavePropertyValues\\": [\\n {\\n \\"PropertyValueId\\": 978,\\n \\"PropertyValue\\": \\"testvalue2\\"\\n }\\n ],\\n \\"FailedPropertyValues\\": [\\n {\\n \\"PropertyId\\": 390,\\n \\"PropertyValue\\": \\"testvalue\\",\\n \\"ErrorCode\\": \\"ExistedPropertyValue\\",\\n \\"ErrorMessage\\": \\"The property value is used by another property.\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n FF3CE680-7710-5ECD-8565-8B103C5301F1\\n \\n \\n \\n 978\\n testvalue\\n \\n \\n testkey\\n 390\\n \\n","errorExample":""}]', + 'title' => '修改自定义属性', + ], + 'SetUserPropertyValue' => [ + 'summary' => '为某个用户关联一个用户属性。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户ID。可以调用[DescribeUsers](~~DescribeUsers~~)获取该参数，对应返回参数`Id`的值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '111****', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户名。可以调用[DescribeUsers](~~DescribeUsers~~)获取该参数，对应返回参数`EndUserId`的值。', + 'type' => 'string', + 'required' => true, + 'example' => 'alice', + ], + ], + [ + 'name' => 'PropertyId', + 'in' => 'formData', + 'schema' => [ + 'description' => '属性ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '240**', + ], + ], + [ + 'name' => 'PropertyValueId', + 'in' => 'formData', + 'schema' => [ + 'description' => '属性值ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2251**', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D6C62E40-F937-5803-B008-92E813399BA5\\n","errorExample":""}]', + 'title' => '为用户设置自定义属性', + ], + 'ListProperty' => [ + 'summary' => '查询当前账号下已有的用户属性列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'NextToken' => [ + 'description' => '下一个查询开始的Token，NextToken为空表示没有下一个。', + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + 'Properties' => [ + 'title' => 'users', + 'description' => '属性信息。', + 'type' => 'array', + 'items' => [ + 'description' => '属性信息。', + 'type' => 'object', + 'properties' => [ + 'PropertyId' => [ + 'description' => '属性ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'PropertyKey' => [ + 'description' => '属性名。', + 'type' => 'string', + 'example' => 'department', + ], + 'PropertyValues' => [ + 'description' => '属性值信息。', + 'type' => 'array', + 'items' => [ + 'description' => '属性值信息。', + 'type' => 'object', + 'properties' => [ + 'PropertyValueId' => [ + 'description' => '属性值ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42', + ], + 'PropertyValue' => [ + 'description' => '属性值。', + 'type' => 'string', + 'example' => 'A', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Properties\\": [\\n {\\n \\"PropertyId\\": 30,\\n \\"PropertyKey\\": \\"department\\",\\n \\"PropertyValues\\": [\\n {\\n \\"PropertyValueId\\": 42,\\n \\"PropertyValue\\": \\"A\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2F4FD101-8D7B-5C97-96D6-8ACB711A7EAA\\n caeba0bbb2be03f84eb48b699f0a4883\\n \\n 30\\n department\\n \\n 42\\n A\\n \\n \\n","errorExample":""}]', + 'title' => '查询属性', + ], + 'ListPropertyValue' => [ + 'summary' => '查询某一用户属性包含的属性值列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PropertyId', + 'in' => 'query', + 'schema' => [ + 'description' => '属性ID。您可以调用[ListProperty](~~ListProperty~~)进行查询。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '390', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C52013A5-3422-5D1F-B22C-A57110972AD9', + ], + 'PropertyValueInfos' => [ + 'title' => 'users', + 'description' => '属性值列表。', + 'type' => 'array', + 'items' => [ + 'description' => '属性值信息。', + 'type' => 'object', + 'properties' => [ + 'PropertyValueId' => [ + 'description' => '属性值ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '978', + ], + 'PropertyValue' => [ + 'description' => '属性值。', + 'type' => 'string', + 'example' => 'HR', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C52013A5-3422-5D1F-B22C-A57110972AD9\\",\\n \\"PropertyValueInfos\\": [\\n {\\n \\"PropertyValueId\\": 978,\\n \\"PropertyValue\\": \\"HR\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n C52013A5-3422-5D1F-B22C-A57110972AD9\\n \\n 978\\n HR\\n \\n","errorExample":""}]', + 'title' => '查询用户自定义属性值', + ], + 'CheckUsedProperty' => [ + 'summary' => '查询关联了指定自定义属性的便捷账号的数量。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PropertyId', + 'in' => 'query', + 'schema' => [ + 'description' => '属性ID。您可以调用[ListProperty](~~ListProperty~~)进行查询。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '390', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '22C97624-2405-54AC-BD44-A63FBE97****', + ], + 'UseCount' => [ + 'description' => '已关联指定自定义属性的便捷账号的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"22C97624-2405-54AC-BD44-A63FBE97****\\",\\n \\"UseCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"\\n 22C97624-2405-54AC-BD44-A63FBE97CC2D\\n 7\\n","errorExample":""}]', + 'title' => '查询关联指定属性的用户数', + ], + 'CheckUsedPropertyValue' => [ + 'summary' => '查询关联了指定自定义属性值的便捷账号的数量。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PropertyId', + 'in' => 'query', + 'schema' => [ + 'description' => '属性ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '380', + ], + ], + [ + 'name' => 'PropertyValueId', + 'in' => 'query', + 'schema' => [ + 'description' => '属性值ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '978', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'UseCount' => [ + 'description' => '已关联指定自定义属性值的便捷账号的数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"UseCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 9E7F03BD-8DA9-5130-A675-0191DC1D8910\\n 1\\n","errorExample":""}]', + 'title' => '查询关联指定属性值的用户数', + ], + 'CreateOrg' => [ + 'summary' => '创建组织。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147035', + 'abilityTreeNodes' => [ + 'FEATUREgwsJIXGV5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'OrgName', + 'in' => 'query', + 'schema' => [ + 'description' => '组织名称。', + 'type' => 'string', + 'required' => true, + 'example' => '设计部门', + ], + ], + [ + 'name' => 'ParentOrgId', + 'in' => 'query', + 'schema' => [ + 'description' => '上级组织ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'org-evk12ozjvmlxl****', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7A2C3803-C975-5871-A232-80A91009****', + ], + 'OrgId' => [ + 'description' => '组织ID。', + 'type' => 'string', + 'example' => 'org-evk12ozjvmlxl****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A2C3803-C975-5871-A232-80A91009****\\",\\n \\"OrgId\\": \\"org-evk12ozjvmlxl****\\"\\n}","type":"json"}]', + 'title' => '创建组织', + ], + 'DescribeOrgs' => [ + 'summary' => '查询组织列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '返回结果的最大数量。取值范围：1~100。 '."\n" + .'默认值：100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '500', + 'minimum' => '1', + 'example' => '20', + 'default' => '500', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAV3MpHK****', + ], + ], + [ + 'name' => 'OrgName', + 'in' => 'query', + 'schema' => [ + 'description' => '组织名称。', + 'type' => 'string', + 'required' => false, + 'example' => '产品部', + ], + ], + [ + 'name' => 'ParentOrgId', + 'in' => 'query', + 'schema' => [ + 'description' => '父组织ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'org-11fs****', + ], + ], + [ + 'name' => 'ShowExtras', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + ], + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0B4BB****', + ], + 'NextToken' => [ + 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'example' => 'AAAAAV3MpHK****', + ], + 'Orgs' => [ + 'description' => '组织列表。', + 'type' => 'array', + 'items' => [ + 'description' => '组织详情。', + 'type' => 'object', + 'properties' => [ + 'OrgName' => [ + 'description' => '组织名称。', + 'type' => 'string', + 'example' => '设计部****', + ], + 'OrgId' => [ + 'description' => '组织ID。', + 'type' => 'string', + 'example' => 'org-1mox****', + ], + 'ParentOrgId' => [ + 'description' => '父组织ID。', + 'type' => 'string', + 'example' => 'org-ezqr****', + ], + 'OrgNamePath' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B4BB****\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK****\\",\\n \\"Orgs\\": [\\n {\\n \\"OrgName\\": \\"设计部****\\",\\n \\"OrgId\\": \\"org-1mox****\\",\\n \\"ParentOrgId\\": \\"org-ezqr****\\",\\n \\"OrgNamePath\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询组织列表', + 'description' => '组织为树形结构，其根组织ID值为：org-aliyun-wy-org-id。', + ], + 'DescribeOrgByLayer' => [ + 'summary' => '查找下级组织。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ParentOrgId', + 'in' => 'formData', + 'schema' => [ + 'description' => '父组织ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'org-11fs****', + ], + ], + [ + 'name' => 'OrgName', + 'in' => 'formData', + 'schema' => [ + 'description' => '组织名称。', + 'type' => 'string', + 'required' => false, + 'example' => '产品部', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'Orgs' => [ + 'description' => '组织信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '组织信息集合。', + 'type' => 'object', + 'properties' => [ + 'OrgName' => [ + 'description' => '组织名称。', + 'type' => 'string', + 'example' => '开发部', + ], + 'OrgId' => [ + 'description' => '组织ID。', + 'type' => 'string', + 'example' => 'org-1mox****', + ], + 'ParentOrgId' => [ + 'description' => '父组织ID。', + 'type' => 'string', + 'example' => 'org-ezqr****', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Orgs\\": [\\n {\\n \\"OrgName\\": \\"开发部\\",\\n \\"OrgId\\": \\"org-1mox****\\",\\n \\"ParentOrgId\\": \\"org-ezqr****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '指定父组织查找下级组织', + ], + 'RemoveOrg' => [ + 'summary' => '移除组织。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'OrgId', + 'in' => 'formData', + 'schema' => [ + 'description' => '组织ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'org-5yy5icj981xe5****', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6C352609-EE7F-5603-B5E6-57C3EDDD****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C352609-EE7F-5603-B5E6-57C3EDDD****\\"\\n}","type":"json"}]', + 'title' => '移除组织', + ], + 'MoveOrg' => [ + 'summary' => '移动组织。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OrgId', + 'in' => 'formData', + 'schema' => [ + 'description' => '待移动的组织ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'org-5yy5icj981xe5****', + ], + ], + [ + 'name' => 'NewParentOrgId', + 'in' => 'formData', + 'schema' => [ + 'description' => '目标父组织ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'org-5yy5icj981xe5****'."\n", + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => '移动组织', + ], + 'ModifyOrg' => [ + 'summary' => '修改组织。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147038', + 'abilityTreeNodes' => [ + 'FEATUREgwsJIXGV5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'OrgName', + 'in' => 'query', + 'schema' => [ + 'description' => '组织名称。', + 'type' => 'string', + 'required' => true, + 'example' => '开发部。', + ], + ], + [ + 'name' => 'OrgId', + 'in' => 'query', + 'schema' => [ + 'description' => '组织ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'org-76joc57khvnhdh***', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0296EDF8-3C8A-5128-8682-27B29C99****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0296EDF8-3C8A-5128-8682-27B29C99****\\"\\n}","type":"json"}]', + 'title' => '修改组织', + ], + 'MoveUserOrg' => [ + 'summary' => '移动用户到目标组织架构。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'OrgId', + 'in' => 'formData', + 'schema' => [ + 'description' => '组织架构ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'org-4mdgc1cocc59z****', + ], + ], + [ + 'name' => 'EndUserIds', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用户ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'alex', + ], + 'required' => true, + 'maxItems' => 500, + 'minItems' => 1, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => '移动用户到目标组织架构', + ], + 'CreateGroup' => [ + 'summary' => '创建用户组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组名称。', + 'type' => 'string', + 'required' => false, + 'example' => '开发组', + ], + ], + [ + 'name' => 'ParentGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '> 该参数暂不对外开放使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'root', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '> 该参数暂不对外开放使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + ], + ], + [ + 'name' => 'SolutionId', + 'in' => 'query', + 'schema' => [ + 'description' => '> 该参数暂不对外开放使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'co-0esnf80jab***', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组的描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestGroup', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****', + ], + 'GroupId' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'example' => 'ug-eld7uv7vtgqsz****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA8D67CB-345D-5CDA-986E-FFAC7D0****\\",\\n \\"GroupId\\": \\"ug-eld7uv7vtgqsz****\\"\\n}","type":"json"}]', + 'title' => '创建用户组', + ], + 'DescribeGroups' => [ + 'summary' => '查询用户组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ug-16nf7xxh4o9gc****', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '> 该参数暂不对外开放使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + ], + ], + [ + 'name' => 'SolutionId', + 'in' => 'query', + 'schema' => [ + 'description' => '> 该参数暂不对外开放使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'co-0esnf80jab***', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestGroup', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。最大值：100。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '10', + 'default' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TransferFileNeedApproval', + 'in' => 'query', + 'schema' => [ + 'description' => '是否已开启文件审批。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'LoginPolicyId', + 'in' => 'query', + 'schema' => [ + 'title' => '指定关联的登录策略筛选。'."\n", + 'description' => '指定关联的登录策略筛选。'."\n", + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ExcludeAttachedLoginPolicyGroups', + 'in' => 'query', + 'schema' => [ + 'title' => '是否排除已关联登录策略的用户组。', + 'description' => '是否排除已关联登录策略的用户组。', + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'IdpId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'Groups' => [ + 'description' => '用户组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组信息。', + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => '用户组名称。', + 'type' => 'string', + 'example' => 'TestGroup', + ], + 'GroupId' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'example' => 'ug-2412ojkwtybd****', + ], + 'Description' => [ + 'description' => '用户组的描述。', + 'type' => 'string', + 'example' => 'A test group.', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-08-07T13:40:40+08:00', + ], + 'UserCount' => [ + 'description' => '用户组内的成员数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TransferFileNeedApproval' => [ + 'description' => '是否已开启文件审批。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AttachedLoginPolicy' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + ], + ], + 'AuthedResources' => [ + 'description' => '已分配的资源列表。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '已分配的资源。', + 'enumValueTitles' => [ + 'DesktopGroup' => '共享型云电脑', + ], + 'example' => 'DesktopGroup', + ], + ], + ], + ], + ], + 'Count' => [ + 'description' => '查询结果的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Groups\\": [\\n {\\n \\"GroupName\\": \\"TestGroup\\",\\n \\"GroupId\\": \\"ug-2412ojkwtybd****\\",\\n \\"Description\\": \\"A test group.\\",\\n \\"CreateTime\\": \\"2025-08-07T13:40:40+08:00\\",\\n \\"UserCount\\": 20,\\n \\"TransferFileNeedApproval\\": false,\\n \\"AttachedLoginPolicy\\": {\\n \\"PolicyId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"AuthedResources\\": {\\n \\"key\\": \\"DesktopGroup\\"\\n }\\n }\\n ],\\n \\"Count\\": 1\\n}","type":"json"}]', + 'title' => '查询用户组', + ], + 'UserBatchQuitGroup' => [ + 'summary' => '批量移除用户组中的用户。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ug-lkuvalovhnlxvv****', + ], + ], + [ + 'name' => 'EndUserIds', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用户ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'alex***', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '890JNJNF-SADASSDFS-SDFSDF****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"890JNJNF-SADASSDFS-SDFSDF****\\"\\n}","type":"json"}]', + 'title' => '用户组批量移除用户', + ], + 'UserBatchJoinGroup' => [ + 'summary' => '为用户组批量添加用户。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ug-12341234****', + ], + ], + [ + 'name' => 'EndUserIds', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用户ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'alex****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7A2C3803-C975-5871-A232-80A91009****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A2C3803-C975-5871-A232-80A91009****\\"\\n}","type":"json"}]', + 'title' => '用户组批量添加用户', + ], + 'RemoveGroup' => [ + 'summary' => '删除用户组。支持批量操作。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的单个用户组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ug-dzjax1ez5qgph****', + ], + ], + [ + 'name' => 'GroupIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '待删除的用户组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '待删除的用户组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ug-eld7uv7vtgqsz****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '42FE70D8-4336-471B-8314-CCCFCE41****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42FE70D8-4336-471B-8314-CCCFCE41****\\"\\n}","type":"json"}]', + 'title' => '删除用户组', + ], + 'ModifyGroup' => [ + 'summary' => '修改用户组的名称和描述。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ug-dzjax1ez5qgph****', + ], + ], + [ + 'name' => 'NewGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '新的用户组名称。', + 'type' => 'string', + 'required' => true, + 'example' => '开发组', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '新的用户组描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestGroup', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '868B8926-2E7A-5BE7-9897-E811E994****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\"\\n}","type":"json"}]', + 'title' => '修改用户组', + ], + 'DescribeGroupUser' => [ + 'summary' => '查询用户组成员。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ug-12341234****', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '> 该参数暂不对外开放使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + ], + ], + [ + 'name' => 'SolutionId', + 'in' => 'query', + 'schema' => [ + 'description' => '> 该参数暂不对外开放使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'co-0esnf80jab***', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页行数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一次查询的Token。可从上一次调用本接口的返回参数中获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAV3MpHK****', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'description' => '模糊搜索字符串，支持匹配用户名（EndUserId）和邮箱（Email）。', + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****', + ], + 'Groups' => [ + 'description' => '> 废弃字段。', + 'type' => 'array', + 'items' => [ + 'description' => '用户组信息。', + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => '用户组名称。', + 'type' => 'string', + 'example' => '开发组', + ], + 'GroupId' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'example' => 'ug-91mvbosdjsdfh****', + ], + 'UserCount' => [ + 'description' => '成员个数。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + 'Users' => [ + 'description' => '成员列表。', + 'type' => 'array', + 'items' => [ + 'description' => '成员信息。', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'alex****', + ], + 'Avatar' => [ + 'description' => '> 废弃字段。', + 'type' => 'string', + 'example' => 'https://avatar.****.com', + ], + 'Address' => [ + 'description' => '> 废弃字段。', + 'type' => 'string', + 'example' => 'xx-xx-xx', + ], + 'Phone' => [ + 'description' => '手机号。', + 'type' => 'string', + 'example' => '138****1111', + ], + 'Email' => [ + 'description' => '邮箱。', + 'type' => 'string', + 'example' => 'alex****@example.com', + ], + 'NickName' => [ + 'description' => '显示名。', + 'type' => 'string', + 'example' => 'alex', + ], + 'JobNumber' => [ + 'description' => '> 废弃字段。', + 'type' => 'string', + 'example' => '123', + ], + 'GmtJoinGroup' => [ + 'description' => '添加时间。', + 'type' => 'string', + 'example' => '2024-08-26T02:59:22.000+00:00', + ], + 'GmtCreated' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-08-26T02:59:22.000+00:00', + ], + 'Remark' => [ + 'description' => '用户的备注。', + 'type' => 'string', + 'example' => 'remark', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '下一次查询的Token。NextToken为空表示结果已经全部查询到。', + 'type' => 'string', + 'example' => 'AAAAAV3MpHK****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA8D67CB-345D-5CDA-986E-FFAC7D0****\\",\\n \\"Groups\\": [\\n {\\n \\"GroupName\\": \\"开发组\\",\\n \\"GroupId\\": \\"ug-91mvbosdjsdfh****\\",\\n \\"UserCount\\": \\"1\\"\\n }\\n ],\\n \\"Users\\": [\\n {\\n \\"EndUserId\\": \\"alex****\\",\\n \\"Avatar\\": \\"https://avatar.****.com\\",\\n \\"Address\\": \\"xx-xx-xx\\",\\n \\"Phone\\": \\"138****1111\\",\\n \\"Email\\": \\"alex****@example.com\\",\\n \\"NickName\\": \\"alex\\",\\n \\"JobNumber\\": \\"123\\",\\n \\"GmtJoinGroup\\": \\"2024-08-26T02:59:22.000+00:00\\",\\n \\"GmtCreated\\": \\"2024-08-26T02:59:22.000+00:00\\",\\n \\"Remark\\": \\"remark\\"\\n }\\n ],\\n \\"NextToken\\": \\"AAAAAV3MpHK****\\"\\n}","type":"json"}]', + 'title' => '查询用户组成员', + ], + 'RemoveMfaDevice' => [ + 'summary' => '删除便捷账号绑定的虚拟MFA设备。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SerialNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟MFA设备的序列号。可以调用[DescribeMfaDevices](~~DescribeMfaDevices~~)获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'dc856334-446b-4035-bfbc-18af261e****', + ], + ], + [ + 'name' => 'AdDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'AD办公网络地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'alpha.lftltd.net', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FB550AAB-FB36-4A91-93F6-F4374AF65403', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FB550AAB-FB36-4A91-93F6-F4374AF65403\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n FB550AAB-FB36-4A91-93F6-F4374AF65403\\r\\n","errorExample":""}]', + 'title' => '删除便捷账号绑定的虚拟MFA设备', + 'description' => '删除便捷账号绑定的虚拟MFA设备表示解除MFA设备绑定，相当于重置或禁用该MFA设备。对应便捷账号在登录无影终端时，需要重新绑定新的虚拟MFA设备。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'LockMfaDevice' => [ + 'summary' => '锁定便捷账号绑定的虚拟MFA设备。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SerialNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟MFA设备的序列号。可以调用[DescribeMfaDevices](~~DescribeMfaDevices~~)获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'dc856334-446b-4035-bfbc-18af261e****', + ], + ], + [ + 'name' => 'AdDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'AD办公网络地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'upower.vip', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '42FE70D8-4336-471B-8314-CCCFCE4159FD', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"42FE70D8-4336-471B-8314-CCCFCE4159FD\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 42FE70D8-4336-471B-8314-CCCFCE4159FD\\r\\n","errorExample":""}]', + 'title' => '锁定虚拟MFA设备', + 'description' => '锁定后，虚拟MFA设备的状态将变为锁定（LOCKED）。对应的便捷账号通过启用了MFA的办公网络登录无影终端时，将因为无法认证MFA设备而无法登录。您可以调用[UnlockMfaDevice](~~UnlockMfaDevice~~)解锁。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UnlockMfaDevice' => [ + 'summary' => '解锁便捷账号绑定的虚拟MFA设备。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'SerialNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '虚拟MFA设备的序列号。可以调用[DescribeMfaDevices](~~DescribeMfaDevices~~)获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'dc856334-446b-4035-bfbc-18af261e****', + ], + ], + [ + 'name' => 'AdDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'AD办公网络地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'welab.co.id', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9BD39C60-4E38-43BE-BA2F-69136C6C5190', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9BD39C60-4E38-43BE-BA2F-69136C6C5190\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 9BD39C60-4E38-43BE-BA2F-69136C6C5190\\r\\n","errorExample":""}]', + 'title' => '解锁虚拟MFA设备', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMfaDevices' => [ + 'summary' => '查询便捷账号绑定的虚拟MFA设备。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '返回结果的最大数量。取值范围：1~500。 '."\n" + .'默认值：100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '100', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证。取值为上一次API调用时返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'EndUserIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '便捷账号的用户名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '便捷账号的用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'alice', + ], + 'required' => false, + 'example' => 'test', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'SerialNumbers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '虚拟MFA设备的序列号列表。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟MFA设备的序列号。', + 'type' => 'string', + 'required' => false, + 'example' => 'c2d9ae94-a64b-4a0d-8024-9519ca50****', + ], + 'required' => false, + 'example' => 'c2d9ae94-a64b-4a0d-8024-9519ca50****', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AdDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'AD办公网络地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn.misumi.pri', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '33DBB8EC-6E68-4726-91C4-E09C59D9A7D8', + ], + 'NextToken' => [ + 'description' => '下一个查询开始的Token。', + 'type' => 'string', + 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp', + ], + 'MfaDevices' => [ + 'title' => 'mfa device list', + 'description' => '虚拟MFA设备信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟MFA设备信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '虚拟MFA设备的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '36', + ], + 'EndUserId' => [ + 'description' => '使用该虚拟MFA设备的便捷账号用户名。', + 'type' => 'string', + 'example' => 'alice', + ], + 'Email' => [ + 'description' => '> 该参数暂未开放使用。', + 'type' => 'string', + 'example' => 'username@example.com', + ], + 'GmtEnabled' => [ + 'description' => '虚拟MFA设备启用时间。按照ISO8601标准表示，并使用UTC+0时间，格式为`yyyy-MM-ddTHH:mm:ssZ`。', + 'type' => 'string', + 'example' => '2021-06-22T06:20:49Z', + ], + 'GmtUnlock' => [ + 'description' => '虚拟MFA设备被锁定后的自动解锁时间。按照ISO8601标准表示，并使用UTC+0时间，格式为`yyyy-MM-ddTHH:mm:ssZ`。', + 'type' => 'string', + 'example' => '2021-06-23T06:20:49Z', + ], + 'ConsecutiveFails' => [ + 'description' => '连续绑定或者认证虚拟MFA设备失败的次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SerialNumber' => [ + 'description' => '虚拟MFA设备的序列号。', + 'type' => 'string', + 'example' => 'dc856334-446b-4035-bfbc-18af261e****', + ], + 'Status' => [ + 'description' => '虚拟MFA设备状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'LOCKED' => '已锁定', + 'UNBOUND' => '未绑定', + 'NORMAL' => '正常', + ], + 'example' => 'NORMAL', + ], + 'DeviceType' => [ + 'description' => '虚拟MFA设备类型。目前仅支持`TOTP_VIRTUAL`，即遵循TOTP算法的虚拟MFA设备。', + 'type' => 'string', + 'enumValueTitles' => [ + 'TOTP_VIRTUAL' => '遵循TOTP算法的虚拟MFA设备', + ], + 'example' => 'TOTP_VIRTUAL', + ], + 'AdUser' => [ + 'type' => 'object', + 'properties' => [ + 'EndUser' => [ + 'type' => 'string', + ], + 'DisplayName' => [ + 'type' => 'string', + ], + 'DisplayNameNew' => [ + 'type' => 'string', + ], + 'UserPrincipalName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"33DBB8EC-6E68-4726-91C4-E09C59D9A7D8\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp\\",\\n \\"MfaDevices\\": [\\n {\\n \\"Id\\": 36,\\n \\"EndUserId\\": \\"alice\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"GmtEnabled\\": \\"2021-06-22T06:20:49Z\\",\\n \\"GmtUnlock\\": \\"2021-06-23T06:20:49Z\\",\\n \\"ConsecutiveFails\\": 0,\\n \\"SerialNumber\\": \\"dc856334-446b-4035-bfbc-18af261e****\\",\\n \\"Status\\": \\"NORMAL\\",\\n \\"DeviceType\\": \\"TOTP_VIRTUAL\\",\\n \\"AdUser\\": {\\n \\"EndUser\\": \\"\\",\\n \\"DisplayName\\": \\"\\",\\n \\"DisplayNameNew\\": \\"\\",\\n \\"UserPrincipalName\\": \\"\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp\\n 8C09C087-99C3-43F0-BFEA-03E651E04696\\n \\n NORMAL\\n TOTP_VIRTUAL\\n 2021-06-22T06:20:49Z\\n test\\n dc856334-446b-4035-bfbc-18af261e****\\n 0\\n 36\\n \\n","errorExample":""}]', + 'title' => '查询便捷账号绑定的虚拟MFA设备', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateResourceGroup' => [ + 'summary' => '创建资源组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => '部门A资源组', + ], + ], + [ + 'name' => 'IsResourceGroupWithOfficeSite', + 'in' => 'query', + 'schema' => [ + 'description' => '> 该参数不对外开放使用。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Platform', + 'in' => 'query', + 'schema' => [ + 'description' => '对于无影云电脑企业版，固定传入`AliyunConsole`。其他平台暂不支持。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AliyunConsole' => '无影云电脑企业版', + ], + 'example' => 'AliyunConsole', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '868B8926-2E7A-5BE7-9897-E811E994****', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-ckf3cx7isinhk***', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\",\\n \\"ResourceGroupId\\": \\"rg-ckf3cx7isinhk***\\"\\n}","type":"json"}]', + 'title' => '创建无影资源组', + ], + 'DeleteResourceGroup' => [ + 'summary' => '删除资源组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的资源组ID。'."\n" + ."\n" + .'> 如果`ResourceGroupIds`参数不为空，则两个参数同时生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aj01tck67a0szp***', + ], + ], + [ + 'name' => 'ResourceGroupIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '待删除的资源组ID列表。'."\n" + ."\n" + .'> 如果`ResourceGroupIds`参数不为空，则两个参数同时生效。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组ID。可以通过调用[DescribeResourceGroups](~~DescribeResourceGroups~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-eoakjtfdxkk0l***', + ], + 'required' => false, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2463A343-BD32-5803-959E-9A8472A1***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2463A343-BD32-5803-959E-9A8472A1***\\"\\n}","type":"json"}]', + 'title' => '删除无影资源组', + ], + 'DescribeResourceGroups' => [ + 'summary' => '查看资源组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'required' => false, + 'example' => '部门A资源组', + ], + ], + [ + 'name' => 'ResourceGroupIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '资源组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-9th3k8twp3ox2***', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NeedContainResourceGroupWithOfficeSite', + 'in' => 'query', + 'schema' => [ + 'description' => '> 该参数不对外开放使用。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Platform', + 'in' => 'query', + 'schema' => [ + 'description' => '> 固定值：AliyunConsole。'."\n" + .'> - 无影企业版固定传AliyunConsole，其他平台暂不对外开放。', + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunConsole', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道标记', + 'description' => '渠道标记', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + ], + ], + [ + 'name' => 'AliyunResourceGroupIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '云平台资源组ID。', + 'description' => '云平台资源组ID。', + 'type' => 'array', + 'items' => [ + 'title' => '资源组ID。', + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-as8nlsbsxsldk***', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '68BA1DF7-8814-5AED-B844-F8F7F7****', + ], + 'ResourceGroup' => [ + 'description' => '资源组信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源组信息。', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-cyo0il2pzge1***', + ], + 'ResourceGroupName' => [ + 'description' => '资源组名称。', + 'type' => 'string', + 'example' => '测试资源组', + ], + 'ResourceCount' => [ + 'description' => '资源组内的资源数量。', + 'type' => 'string', + 'example' => '119', + ], + 'AuthCount' => [ + 'description' => '资源组授权的管理员数量。', + 'type' => 'string', + 'example' => '3', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-11-29T17:25:40.000000000Z', + ], + 'Policies' => [ + 'description' => '> 资源组关联的策略。'."\n" + .'> - 关联策略会对资源组内的云电脑生效，如果有多个策略，会按策略的优先级生效。'."\n" + .'> - 如果资源组内的云电脑本身已指定其他策略，资源组关联的策略优先生效。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '策略ID。', + 'type' => 'string', + 'example' => 'pl-a8jnatl8kjasb***', + ], + 'Name' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => '测试策略123', + ], + 'IsDefault' => [ + 'description' => '是否默认策略。', + 'type' => 'boolean', + 'example' => 'False', + ], + ], + ], + ], + 'Timers' => [ + 'description' => '> 关联的定时任务。'."\n" + .'> - 关联的定时任务会对资源组内的云电脑生效，如果资源组内的云电脑本身已关联其他定时任务，资源组关联的任务优先生效。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '定时任务ID。', + 'type' => 'string', + 'example' => 't-asdzx0mbjhg***', + ], + 'Name' => [ + 'description' => '定时任务名称。', + 'type' => 'string', + 'example' => '测试任务123', + ], + 'TimerStatus' => [ + 'type' => 'string', + ], + 'BindStatus' => [ + 'type' => 'string', + ], + ], + ], + ], + 'AppRules' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'type' => 'string', + ], + 'Name' => [ + 'type' => 'string', + ], + 'Type' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + 'AliyunResourceGroupId' => [ + 'title' => '阿里云资源组ID', + 'description' => '阿里云资源组ID', + 'type' => 'string', + 'example' => 'rg-123456', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '资源组总个数。', + 'type' => 'string', + 'example' => '7', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68BA1DF7-8814-5AED-B844-F8F7F7****\\",\\n \\"ResourceGroup\\": [\\n {\\n \\"ResourceGroupId\\": \\"rg-cyo0il2pzge1***\\",\\n \\"ResourceGroupName\\": \\"测试资源组\\",\\n \\"ResourceCount\\": \\"119\\",\\n \\"AuthCount\\": \\"3\\",\\n \\"CreateTime\\": \\"2022-11-29T17:25:40.000000000Z\\",\\n \\"Policies\\": [\\n {\\n \\"Id\\": \\"pl-a8jnatl8kjasb***\\",\\n \\"Name\\": \\"测试策略123\\",\\n \\"IsDefault\\": true\\n }\\n ],\\n \\"Timers\\": [\\n {\\n \\"Id\\": \\"t-asdzx0mbjhg***\\",\\n \\"Name\\": \\"测试任务123\\",\\n \\"TimerStatus\\": \\"\\",\\n \\"BindStatus\\": \\"\\"\\n }\\n ],\\n \\"AppRules\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": 0\\n }\\n ],\\n \\"AliyunResourceGroupId\\": \\"rg-123456\\"\\n }\\n ],\\n \\"TotalCount\\": \\"7\\"\\n}","type":"json"}]', + 'title' => '查看资源组信息', + ], + 'SyncAllEduInfo' => [ + 'summary' => '同步所有教育信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => '同步所有教育信息', + ], + 'QuerySyncStatusByAliUid' => [ + 'summary' => '查询用户同步状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => 'auto-increased id', + 'description' => '自增ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '18500', + ], + 'GmtCreated' => [ + 'title' => 'created time', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2020-06-30 07:50:42', + ], + 'GmtModified' => [ + 'title' => 'modified time', + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2022-03-02 14:27:39', + ], + 'AliUid' => [ + 'title' => 'aliUid of the customer', + 'description' => '阿里云账号ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '131239236086****', + ], + 'Status' => [ + 'title' => 'user sync status', + 'description' => '用户同步状态。', + 'type' => 'string', + 'example' => 'success', + ], + 'CorpId' => [ + 'title' => 'corp id', + 'description' => '企业ID。', + 'type' => 'string', + 'example' => 'cdrs948144195608****', + ], + 'LatestBeginTime' => [ + 'title' => 'latestBeginTime', + 'description' => '最后开始时间。', + 'type' => 'string', + 'example' => '2022-03-02 14:31:39', + ], + 'LatestEndTime' => [ + 'title' => 'atest_end_time,Whether it is success or failure', + 'description' => '最后结束时间，不论成功或失败。', + 'type' => 'string', + 'example' => '2022-03-02 16:13:12', + ], + 'LatestSuccessTime' => [ + 'title' => 'latestSuccessTime', + 'description' => '最后成功时间。', + 'type' => 'string', + 'example' => '2022-03-02 18:24:01', + ], + ], + ], + 'Success' => [ + 'description' => '请求是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '系统状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求失败的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 18500,\\n \\"GmtCreated\\": \\"2020-06-30 07:50:42\\",\\n \\"GmtModified\\": \\"2022-03-02 14:27:39\\",\\n \\"AliUid\\": 0,\\n \\"Status\\": \\"success\\",\\n \\"CorpId\\": \\"cdrs948144195608****\\",\\n \\"LatestBeginTime\\": \\"2022-03-02 14:31:39\\",\\n \\"LatestEndTime\\": \\"2022-03-02 16:13:12\\",\\n \\"LatestSuccessTime\\": \\"2022-03-02 18:24:01\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => '查询用户同步状态', + ], + 'ChangeUserPassword' => [ + 'summary' => '当用户为管理员激活模式时，可以通过该接口修改用户登录密码。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'EndUserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '要修改密码的便捷账号的用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'alice***', + ], + ], + [ + 'name' => 'NewPassword', + 'in' => 'formData', + 'schema' => [ + 'description' => '用户的新密码。', + 'type' => 'string', + 'required' => false, + 'example' => 'Admin@12***', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'description' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA8D67CB-345D-5CDA-986E-FFAC7D0****\\"\\n}","type":"json"}]', + 'title' => '修改用户密码', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'eds-user.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'eds-user.ap-southeast-1.aliyuncs.com', + ], + ], +]; diff --git a/data/zh_cn/eds-user/2021-06-22/api-docs.php b/data/zh_cn/eds-user/2021-06-22/api-docs.php new file mode 100644 index 0000000..ae0475a --- /dev/null +++ b/data/zh_cn/eds-user/2021-06-22/api-docs.php @@ -0,0 +1,113 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'eds-user', + 'version' => '2021-06-22', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'GetUserByToken', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'GetUserByToken' => [ + 'summary' => '根据登录token获取用户信息', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Token', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'maximum' => '100', + 'minimum' => '1', + 'maxLength' => 9999999999999, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'User' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Name' => [ + 'type' => 'string', + ], + 'Email' => [ + 'type' => 'string', + ], + 'TenantId' => [ + 'type' => 'string', + ], + 'Type' => [ + 'type' => 'string', + ], + 'OfficeSiteId' => [ + 'type' => 'string', + ], + 'AdDomain' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'eds-user.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'eds-user.ap-southeast-1.aliyuncs.com', + ], + ], +]; -- cgit v1.2.3