diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/eds-user | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/en_us/eds-user')
| -rw-r--r-- | data/en_us/eds-user/2021-03-08/api-docs.php | 8734 | ||||
| -rw-r--r-- | data/en_us/eds-user/2021-06-22/api-docs.php | 77 |
2 files changed, 4399 insertions, 4412 deletions
diff --git a/data/en_us/eds-user/2021-03-08/api-docs.php b/data/en_us/eds-user/2021-03-08/api-docs.php index d56dba7..5b5d9ca 100644 --- a/data/en_us/eds-user/2021-03-08/api-docs.php +++ b/data/en_us/eds-user/2021-03-08/api-docs.php @@ -1,222 +1,728 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'eds-user', - 'version' => '2021-03-08', - ], + 'info' => ['style' => 'RPC', 'product' => 'eds-user', 'version' => '2021-03-08'], 'directories' => [ [ - 'id' => 205232, - 'title' => 'Login', + 'children' => ['InitTenantAlias'], 'type' => 'directory', - 'children' => [ - 'InitTenantAlias', - ], + 'title' => 'Login', ], [ - 'id' => 165074, - 'title' => 'User', + 'children' => ['CreateUsers', 'RemoveUsers', 'ModifyUser', 'ResetUserPassword', 'LockUsers', 'UnlockUsers', 'DescribeUsers', 'FilterUsers', 'BatchSetDesktopManager'], 'type' => 'directory', - 'children' => [ - 'CreateUsers', - 'RemoveUsers', - 'ModifyUser', - 'ResetUserPassword', - 'LockUsers', - 'UnlockUsers', - 'DescribeUsers', - 'FilterUsers', - 'GetManagerInfoByAuthCode', - 'BatchSetDesktopManager', - ], + 'title' => 'User', ], [ - 'id' => 165068, - 'title' => 'User property', + 'children' => ['CreateProperty', 'RemoveProperty', 'DeleteUserPropertyValue', 'UpdateProperty', 'SetUserPropertyValue', 'ListProperty', 'ListPropertyValue', 'CheckUsedProperty', 'CheckUsedPropertyValue'], 'type' => 'directory', - 'children' => [ - 'CreateProperty', - 'RemoveProperty', - 'DeleteUserPropertyValue', - 'UpdateProperty', - 'SetUserPropertyValue', - 'ListProperty', - 'ListPropertyValue', - 'CheckUsedProperty', - 'CheckUsedPropertyValue', - ], + 'title' => 'User property', ], [ - 'id' => 188957, - 'title' => 'Organisation', + 'children' => ['CreateOrg', 'DescribeOrgs', 'DescribeOrgByLayer', 'RemoveOrg', 'MoveOrg', 'ModifyOrg', 'MoveUserOrg'], 'type' => 'directory', - 'children' => [ - 'CreateOrg', - 'DescribeOrgs', - 'DescribeOrgByLayer', - 'RemoveOrg', - 'MoveOrg', - 'ModifyOrg', - 'MoveUserOrg', - ], + 'title' => 'Organisation', ], [ - 'id' => 222270, - 'title' => 'User Group', + 'children' => ['DescribeGroups', 'UserBatchQuitGroup', 'UserBatchJoinGroup', 'RemoveGroup', 'ModifyGroup', 'DescribeGroupUser'], 'type' => 'directory', - 'children' => [ - 'CreateGroup', - 'DescribeGroups', - 'UserBatchQuitGroup', - 'UserBatchJoinGroup', - 'RemoveGroup', - 'ModifyGroup', - 'DescribeGroupUser', - ], + 'title' => 'User Group', ], [ - 'id' => 165058, - 'title' => 'MFA', + 'children' => ['RemoveMfaDevice', 'LockMfaDevice', 'UnlockMfaDevice', 'DescribeMfaDevices'], 'type' => 'directory', - 'children' => [ - 'RemoveMfaDevice', - 'LockMfaDevice', - 'UnlockMfaDevice', - 'DescribeMfaDevices', - ], + 'title' => 'MFA', ], [ - 'id' => 205378, - 'title' => 'Resource Group', + 'children' => ['CreateResourceGroup', 'DeleteResourceGroup', 'DescribeResourceGroups'], 'type' => 'directory', - 'children' => [ - 'CreateResourceGroup', - 'DeleteResourceGroup', - 'DescribeResourceGroups', - ], + 'title' => 'Resource Group', ], [ - 'id' => 168203, - 'title' => 'Other', + 'children' => ['ChangeUserPassword', 'CreateGroup', 'DescribeUser', 'GetManagerInfoByAuthCode', 'QuerySyncStatusByAliUid', 'SyncAllEduInfo', 'TransferResourcesIntoGroup', 'TransferResourcesOutofGroup'], + 'title' => 'Others', 'type' => 'directory', - 'children' => [ - 'SyncAllEduInfo', - 'QuerySyncStatusByAliUid', - 'ChangeUserPassword', - ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'InitTenantAlias' => [ - 'summary' => 'Initializes an organization ID.', - 'methods' => [ - 'get', - 'post', + 'BatchSetDesktopManager' => [ + 'summary' => 'Add or remove local administrator permissions on a cloud computer for a convenience account.', + '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' => 'The convenience accounts.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The convenience account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'alice', 'title' => ''], + 'required' => true, + 'maxItems' => 500, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'IsDesktopManager', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Whether the convenience account has the local administrator permissions on cloud computers.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0: no'."\n" + .'* 1 (default): yes'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['', ''], + 'example' => '1', + 'title' => '', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '868B8926-2E7A-5BE7-9897-E811E994****'], + ], + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\"\\n}","type":"json"}]', + 'title' => 'Add or remove local administrator permissions for a convenience account', + 'description' => 'A convenience account with local administrator permissions can install software or modify certain system settings on the cloud computer.', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-04T15:17:46.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchSetDesktopManager'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:BatchSetDesktopManager', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ChangeUserPassword' => [ + 'summary' => 'When the administrator activates the mode, you can use this API to modify the user logon password. ', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'EndUserId', + 'in' => 'formData', + 'schema' => ['description' => 'The username of the convenience account whose password is to be modified. ', 'type' => 'string', 'required' => false, 'example' => 'alice***', 'title' => ''], + ], + [ + 'name' => 'NewPassword', + 'in' => 'formData', + 'schema' => ['description' => 'The new password for the user. ', 'type' => 'string', 'required' => false, 'example' => 'Admin@12***', 'title' => ''], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => ['description' => 'Channel ', 'title' => 'Channel ', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'A collection of return messages. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****'], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA8D67CB-345D-5CDA-986E-FFAC7D0****\\"\\n}","type":"json"}]', + 'title' => 'Modify User Password ', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeUserPassword'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ChangeUserPassword', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CheckUsedProperty' => [ + 'summary' => 'Query the number of convenience accounts associated with a specified custom property.', + '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' => 'The ID of the property. You can call the [ListProperty](~~410890~~) operation to query the property ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '390', 'title' => ''], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'A collection of response information.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '22C97624-2405-54AC-BD44-A63FBE97****'], + 'UseCount' => ['description' => 'The number of convenience users that are associated with the property.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97624-2405-54AC-BD44-A63FBE97****\\",\\n \\"UseCount\\": 2\\n}","type":"json"}]', + 'title' => 'Query the number of users associated with a specified property', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-02T06:24:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckUsedProperty'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:CheckUsedProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CheckUsedPropertyValue' => [ + 'summary' => 'Query the number of convenience accounts associated with a specified custom attribute value.', + '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' => 'The property ID. You can call the [ListProperty](~~ListProperty~~) operation to query property ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '380', 'title' => ''], + ], + [ + 'name' => 'PropertyValueId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the property value. You can call the [ListProperty](~~ListProperty~~) operation to query the ID of the property value.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '978', 'title' => ''], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'UseCount' => ['description' => 'The number of convenience accounts that are associated with the specified custom property value.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"UseCount\\": 1\\n}","type":"json"}]', + 'title' => 'Query the User Count Associated with a Specified Attribute Value', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckUsedPropertyValue'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:CheckUsedPropertyValue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateGroup' => [ + 'summary' => 'Create a group.', + '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' => 'The group name.', 'type' => 'string', 'required' => false, 'example' => '开发组', 'title' => ''], + ], + [ + 'name' => 'ParentGroupId', + 'in' => 'query', + 'schema' => ['description' => '> This parameter is not publicly available.'."\n", 'type' => 'string', 'required' => false, 'example' => 'root', 'title' => ''], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => ['description' => '> This parameter is not publicly available for use.', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'title' => ''], + ], + [ + 'name' => 'SolutionId', + 'in' => 'query', + 'schema' => ['description' => '> This parameter is not publicly available.'."\n", 'type' => 'string', 'required' => false, 'example' => 'co-0esnf80jab***', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the user group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestGroup', 'title' => ''], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****'], + 'GroupId' => ['description' => 'The ID of the user group.'."\n", 'type' => 'string', 'example' => 'ug-eld7uv7vtgqsz****', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA8D67CB-345D-5CDA-986E-FFAC7D0****\\",\\n \\"GroupId\\": \\"ug-eld7uv7vtgqsz****\\"\\n}","type":"json"}]', + 'title' => 'Create a group', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-30T14:09:42.000Z', 'description' => 'Request parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'CreateOrg' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '147035', + 'abilityTreeNodes' => ['FEATUREgwsJIXGV5'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ + 'name' => 'OrgName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the organization.'."\n", 'type' => 'string', 'required' => true, 'example' => '设计部门', 'title' => ''], + ], + [ + 'name' => 'ParentOrgId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the parent organization.'."\n", 'type' => 'string', 'required' => true, 'example' => 'org-evk12ozjvmlxl****', 'title' => ''], + ], + [ 'name' => 'BusinessChannel', 'in' => 'query', + 'schema' => ['description' => 'Channel', 'title' => '', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '渠道', - 'type' => 'string', + 'title' => '', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7A2C3803-C975-5871-A232-80A91009****'], + 'OrgId' => ['description' => 'The organization ID.'."\n", 'type' => 'string', 'example' => 'org-evk12ozjvmlxl****', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'title' => 'Create Organization', + 'summary' => 'Create an organization.', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrg'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateOrg', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A2C3803-C975-5871-A232-80A91009****\\",\\n \\"OrgId\\": \\"org-evk12ozjvmlxl****\\"\\n}","type":"json"}]', + ], + 'CreateProperty' => [ + 'summary' => 'Create a user attribute. ', + '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' => 'The property name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'department', 'title' => ''], + ], + [ + 'name' => 'PropertyValues', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The values of the property. You can specify up to 50 values for a property.', + 'type' => 'array', + 'items' => ['description' => 'The value of the property.', 'type' => 'string', 'required' => false, 'example' => 'HR', 'title' => ''], 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'A collection of response messages. ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Data' => [ - 'description' => 'The generated ID of the organization.'."\n", - 'type' => 'string', - 'example' => 'WY23***', - ], - 'AliasInfo' => [ - 'description' => 'The data returned.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'CreateResult' => [ + 'description' => 'The result of creating the property.', 'type' => 'object', 'properties' => [ - 'AliasSourceType' => [ - 'description' => 'The source of the organization ID.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Generated: auto-generated.'."\n" - .'* Customized: user-defined.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Generated' => '', - 'Customized' => '', + 'PropertyId' => ['description' => 'The ID of the property.', 'type' => 'integer', 'format' => 'int64', 'example' => '390', 'title' => ''], + 'PropertyKey' => ['description' => 'The name of the property.', 'type' => 'string', 'example' => 'department', 'title' => ''], + 'SavePropertyValueModel' => [ + 'description' => 'The result of creating the property value.', + 'type' => 'object', + 'properties' => [ + 'SavePropertyValues' => [ + 'description' => 'Details of the property values that were created.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the property value that was created.', + 'type' => 'object', + 'properties' => [ + 'PropertyValueId' => ['description' => 'The ID of the property value.', 'type' => 'integer', 'format' => 'int64', 'example' => '978', 'title' => ''], + 'PropertyValue' => ['description' => 'The value of the property.', 'type' => 'string', 'example' => 'HR', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'FailedPropertyValues' => [ + 'description' => 'The property values that failed to be created.', + 'type' => 'array', + 'items' => [ + 'description' => 'The property values that failed to be modified.', + 'type' => 'object', + 'properties' => [ + 'PropertyId' => ['description' => 'The ID of the property value.', 'type' => 'integer', 'format' => 'int64', 'example' => '390', 'title' => ''], + 'PropertyValue' => ['description' => 'The value of the property.', 'type' => 'string', 'example' => 'HR', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'ExistedPropertyValue', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The property value is used by another property.', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - 'example' => 'Customized', - ], - 'AliasEditable' => [ - 'description' => 'Indicates whether modification is allowed.'."\n", - 'type' => 'boolean', - 'example' => 'False', - ], - 'AliasEditDisabledReason' => [ - 'description' => 'The reason why modification is not allowed.'."\n", - 'type' => 'string', - 'example' => 'FrequencyExceedsLimit', - ], - 'NextModifyTime' => [ - 'description' => 'The time window during which modification is allowed.'."\n", - 'type' => 'string', - 'example' => '2025-04-17 20:31:48', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Create User Custom Property', + 'description' => '- You can create up to 10 different properties under one Alibaba Cloud account. Each property includes a property name (PropertyKey) and multiple attribute values (PropertyValue). '."\n" + .'- You can add up to 50 different attribute values to a single property. ', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-02T06:24:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProperty'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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' => 'InitTenantAlias', ], - 'CreateUsers' => [ - 'summary' => 'Creates a convenience user.', - 'methods' => [ - 'get', - 'post', + 'CreateResourceGroup' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the resource group.', 'type' => 'string', 'required' => false, 'example' => '部门A资源组', 'title' => ''], + ], + [ + 'name' => 'IsResourceGroupWithOfficeSite', + 'in' => 'query', + 'schema' => ['description' => '> This parameter is not publicly available.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Platform', + 'in' => 'query', + 'schema' => [ + 'description' => 'For WUYING Workspace Enterprise Edition, set this parameter to `AliyunConsole`. Other platforms are not supported.', + 'enumValueTitles' => ['AliyunConsole' => 'WUYING Workspace Enterprise Edition.'], + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunConsole', + 'title' => '', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The channel.', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], + ], + [ + 'name' => 'EnableAliyunResourceGroup', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ResourceClassification', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'enum' => ['Default', 'DesktopAgent'], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'AgentType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '868B8926-2E7A-5BE7-9897-E811E994****'], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-ckf3cx7isinhk***', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'title' => 'Create a WUYING resource group', + 'summary' => 'Creates a resource group.', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\",\\n \\"ResourceGroupId\\": \\"rg-ckf3cx7isinhk***\\"\\n}","type":"json"}]', + ], + 'CreateUsers' => [ + 'summary' => 'Easily create accounts for your end users.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -229,9 +735,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '18911', - 'abilityTreeNodes' => [ - 'FEATUREgwsZABQI3', - ], + 'abilityTreeNodes' => ['FEATUREgwsZABQI3'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -240,254 +744,207 @@ 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The information about the convenience user.'."\n", + 'description' => 'Details about the convenience users.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the convenience user.'."\n", + 'description' => 'Details about the convenience user.', 'type' => 'object', 'properties' => [ - 'EndUserId' => [ - 'description' => 'The username of the convenience user. The name can contain lowercase letters, digits, and underscores (\\_), and must be 3 to 24 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test1', - ], - 'Email' => [ - 'description' => 'The email address of the convenience user. The email address is used to receive notifications about events such as desktop assignment. You must specify an email address or a mobile number to receive notifications.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'username@example.com', - ], - 'Phone' => [ - 'description' => 'Mobile numbers are not supported on the international site (alibabacloud.com).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1381111****', - ], - 'Password' => [ - 'description' => 'The user password.'."\n" - ."\n" - .'> The password must be at least 10 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (excluding spaces).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'password1', - ], + 'EndUserId' => ['description' => 'The user name. The user name must be 3 to 24 characters long and can contain lowercase letters, digits, and underscores (\\_).', 'type' => 'string', 'required' => true, 'example' => 'alice', 'title' => ''], + 'Email' => ['description' => 'The email address of the convenience user. This email address is used for notifications, such as an alert when a cloud computer is assigned. You must specify either this parameter or the `Phone` parameter.', 'type' => 'string', 'required' => false, 'example' => 'username@example.com', 'title' => ''], + 'Phone' => ['description' => '<props="china">'."\n" + ."\n" + .'The phone number of the convenience user. This phone number is used for notifications, such as a text message when a cloud computer is assigned. You must specify either this parameter or the `Email` parameter.'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'Phone numbers are not supported on the international site.'."\n" + ."\n" + .'</props>', 'type' => 'string', 'required' => false, 'example' => '1381111****', 'title' => ''], + 'Password' => ['description' => 'The password for the convenience user.'."\n" + ."\n" + .'> The password must be at least 10 characters long and contain characters from at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (excluding spaces).', 'type' => 'string', 'required' => false, 'example' => 'Wuying1234', 'title' => ''], 'OwnerType' => [ - 'description' => 'The type of the account ownership.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CreateFromManager: administrator-activated'."\n" - .'* Normal: user-activated', + 'description' => 'The account activation type.', + 'enumValueTitles' => ['CreateFromManager' => 'Administrator activation', 'Normal' => 'User activation'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'CreateFromManager' => '', - 'Normal' => '', - ], 'example' => 'Normal', + 'title' => '', ], - 'OrgId' => [ - 'description' => 'The organization to which the convenience user belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1111****', - ], - 'Remark' => [ - 'description' => 'The remarks on the convenience user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'remark1', - ], - 'RealNickName' => [ - 'description' => 'The display name of the end user.', - 'type' => 'string', - 'required' => false, - 'example' => 'Bean', - ], + 'OrgId' => ['description' => 'The ID of the organization to which the convenience user belongs.', 'type' => 'string', 'required' => false, 'example' => 'design', 'title' => ''], + 'Remark' => ['description' => 'A remark for the convenience user.', 'type' => 'string', 'required' => false, 'example' => 'remark1', 'title' => ''], + 'RealNickName' => ['description' => 'The display name of the convenience user.', 'type' => 'string', 'required' => false, 'example' => 'Bean', 'title' => ''], 'GroupIdList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], 'maxItems' => 100, + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, 'example' => 'CreateUsers', 'maxItems' => 100, + 'title' => '', ], ], [ 'name' => 'Password', 'in' => 'formData', - 'schema' => [ - 'description' => 'The initial password. If this parameter is left empty, an email for password reset is sent to the specified email address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test123****', - 'maxLength' => 256, - ], + 'schema' => ['description' => 'The initial password. If you do not specify this parameter, the system sends a password reset email to the convenience user\'s email address.', 'type' => 'string', 'maxLength' => 256, 'required' => false, 'example' => 'Test123****', 'title' => ''], ], [ 'name' => 'AutoLockTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The date on which the convenience users are automatically locked.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-03-03', - ], + 'schema' => ['description' => 'The date and time when the system automatically locks the convenience user\'s account. The value must be in the `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'required' => false, 'example' => '2025-11-28 00:00:00', 'title' => ''], ], [ 'name' => 'IsLocalAdmin', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Specifies whether to set the convenience user as a local administrator.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'PasswordExpireDays', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'By default, a convenience user\'s password does not expire. You can use this parameter to specify a password validity period of 30 to 365 days. After the password expires, the user must reset it to log in again.'."\n" + ."\n" + .'> This feature is in invited preview. To use this feature, submit a ticket.', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['title' => 'Channel', 'description' => 'The business channel.', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The information that is returned.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], 'CreateResult' => [ - 'description' => 'The result of user creation.'."\n", + 'description' => 'The result of creating convenience accounts.', 'type' => 'object', 'properties' => [ 'CreatedUsers' => [ - 'description' => 'Details of the created convenience users.'."\n", + 'description' => 'The convenience accounts that were successfully created.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the created convenience user.'."\n", + 'description' => 'A convenience account that was successfully created.', 'type' => 'object', 'properties' => [ - 'EndUserId' => [ - 'description' => 'The name of the end user.'."\n", - 'type' => 'string', - 'example' => 'test1', - ], - 'Email' => [ - 'description' => 'The email address of the end user.'."\n", - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'Phone' => [ - 'description' => 'The mobile number of the end user.'."\n", - 'type' => 'string', - 'example' => '1381111****', - ], - 'Remark' => [ - 'description' => 'The remarks of the end user.'."\n", - 'type' => 'string', - 'example' => 'remark1', - ], - 'RealNickName' => [ - 'description' => 'The display name of the end user.', - 'type' => 'string', - 'example' => 'Bean', - ], + 'EndUserId' => ['description' => 'The user name.', 'type' => 'string', 'example' => 'test1', 'title' => ''], + 'Email' => ['description' => 'The email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'Phone' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '1381111****', 'title' => ''], + 'Remark' => ['description' => 'The user\'s remark.', 'type' => 'string', 'example' => 'remark1', 'title' => ''], + 'RealNickName' => ['description' => 'The display name.', 'type' => 'string', 'example' => 'Bean', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'FailedUsers' => [ - 'description' => 'Details of the convenience users that failed to be created.'."\n", + 'description' => 'The convenience accounts that failed to be created.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the convenience user that failed to be created.'."\n", + 'description' => 'A convenience account that failed to be created.', 'type' => 'object', 'properties' => [ - 'EndUserId' => [ - 'description' => 'The name of the end user.'."\n", - 'type' => 'string', - 'example' => 'test2', - ], - 'Email' => [ - 'description' => 'The email address of the end user.'."\n", - 'type' => 'string', - 'example' => 'username2@example.com', - ], - 'Phone' => [ - 'description' => 'The mobile number of the end user.'."\n", - 'type' => 'string', - 'example' => '1390000****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'ExistedEndUserId', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The username test is used by another user.', - ], + 'EndUserId' => ['description' => 'The user name.', 'type' => 'string', 'example' => 'test2', 'title' => ''], + 'Email' => ['description' => 'The email address.', 'type' => 'string', 'example' => 'username2@example.com', 'title' => ''], + 'Phone' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '1390000****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'ExistedEndUserId', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The username test is used by another user.', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'AllSucceed' => [ - 'type' => 'boolean', - ], + 'AllSucceed' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], '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' => 'CreateUsers', - 'description' => 'Convenience users are dedicated Elastic Desktop Service (EDS) user accounts and are suitable for scenarios in which you do not need to connect to enterprise Active Directory (AD) systems. The information about a convenience user includes the username, email address, and mobile number. You must specify the username or email address.'."\n", + ['errorCode' => 'INTERNAL_ERROR', 'errorMessage' => 'Internal error.', 'description' => ''], + ], + ], + 'title' => 'Create convenience account ', + 'description' => '<props="china">'."\n" + ."\n" + .'A convenience account is a dedicated account system in Wuying Workspace for simple use cases that do not require enterprise AD integration. Accounts require a username, and either an email or a phone number.'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">'."\n" + ."\n" + .'A convenience account is a dedicated account system in Wuying Workspace for simple use cases that do not require enterprise AD integration. Accounts require both a username and an email.'."\n" + ."\n" + .'</props>', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RemoveUsers' => [ - 'summary' => 'Removes one or more convenience users.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-11-27T07:00:44.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-24T12:29:23.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-03T11:44:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-09T12:00:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-16T11:08:16.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-08-31T01:58:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-02T06:24:28.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-09-08T12:07:49.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-07-28T09:03:19.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-06-01T12:53:02.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-04-23T06:50:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-04-23T06:50:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-04-02T06:14:21.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUsers'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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\\": false\\n}","type":"json"}]', + ], + 'DeleteResourceGroup' => [ + 'summary' => 'Delete a resource group.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -495,385 +952,726 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Users', - 'in' => 'formData', - 'style' => 'repeatList', + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '> The ID of the resource group that you want to delete.'."\n" + ."\n" + .'* If you also specify ResourceGroupIds, both parameters take effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-aj01tck67a0szp***', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupIds', + 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'The usernames of the convenience users that you want to remove.'."\n", + 'description' => '> The IDs of the resource groups that you want to delete.'."\n" + ."\n" + .'* If you also specify ResourceGroupId, both parameters take effect.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The username of the convenience user that you want to remove. You can call the [DescribeUsers](~~DescribeUsers~~) operation to query the username.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test1', + 'items' => ['description' => 'The ID of the resource group. You can call the [DescribeResourceGroups](~~2882825~~) operation to query IDs of resource groups.', 'type' => 'string', 'required' => false, 'example' => 'rg-eoakjtfdxkk0l***', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2463A343-BD32-5803-959E-9A8472A1***'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2463A343-BD32-5803-959E-9A8472A1***\\"\\n}","type":"json"}]', + 'title' => 'Delete an Elastic Desktop Service resource group', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => true, - 'example' => 'test1', - 'maxItems' => 500, - 'minItems' => 1, ], ], + ], + ], + 'DeleteUserPropertyValue' => [ + 'summary' => 'Detach a user from a user attribute.', + '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' => 'The user ID. You can call the [DescribeUsers](~~DescribeUsers~~) operation to query the user ID, which is the return value of the `Id` parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'PropertyId', + 'in' => 'formData', + 'schema' => ['description' => 'The property ID. You can call the [ListProperty](~~ListProperty~~) operation to query the property ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '390', 'title' => ''], + ], + [ + 'name' => 'PropertyValueId', + 'in' => 'formData', + 'schema' => ['description' => 'The property value ID. You can call the [ListProperty](~~ListProperty~~) operation to query the property value ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '978', 'title' => ''], + ], [ 'name' => 'BusinessChannel', 'in' => 'formData', + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D6C62E40-F937-5803-B008-92E813399BA5'], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6C62E40-F937-5803-B008-92E813399BA5\\"\\n}","type":"json"}]', + 'title' => 'Remove Custom Properties from a User', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-02T06:24:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserPropertyValue'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteUserPropertyValue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'DescribeGroupUser' => [ + 'summary' => 'Query group members. ', + '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' => 'The ID of the user group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ug-12341234****', 'title' => ''], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => ['description' => '> This parameter is not available for public use.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'title' => ''], + ], + [ + 'name' => 'SolutionId', + 'in' => 'query', + 'schema' => ['description' => '> This parameter is not available for public use.'."\n", 'type' => 'string', 'required' => false, 'example' => 'co-0esnf80jab***', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token for the next query. You can obtain this parameter from the response parameters of the last call to this operation.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK****', 'title' => ''], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => ['description' => 'The fuzzy search string that matches the username (EndUserId) and email address (Email) of the regular user.'."\n", 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => ['description' => 'Channel ', 'title' => 'Channel ', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'RemoveUsersResult' => [ - 'description' => 'The result of removing the convenience user.', - 'type' => 'object', - 'properties' => [ - 'RemovedUsers' => [ - 'description' => 'The convenience users that were removed.', - 'type' => 'array', - 'items' => [ - 'description' => 'The convenience user that was removed.', - 'type' => 'string', - 'example' => 'test1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****'], + 'Groups' => [ + 'description' => '> This field is deprecated.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the user group.'."\n", + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['description' => 'The name of the user group.'."\n", 'type' => 'string', 'example' => '开发组', 'title' => ''], + 'GroupId' => ['description' => 'The user group ID.'."\n", 'type' => 'string', 'example' => 'ug-91mvbosdjsdfh****', 'title' => ''], + 'UserCount' => ['description' => 'The number of members in the user group.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], ], - 'FailedUsers' => [ - 'description' => 'The convenience users that failed to be removed.', - 'type' => 'array', - 'items' => [ - 'description' => 'The convenience user that failed to be removed.', - 'type' => 'object', - 'properties' => [ - 'EndUserId' => [ - 'description' => 'The ID of the convenience user that failed to be removed.', - 'type' => 'string', - 'example' => 'test2', - ], - 'ErrorCode' => [ - 'description' => 'The error code.', - 'type' => 'string', - 'example' => 'InvalidUsername', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.', - 'type' => 'string', - 'example' => 'test2 is an invalid username.', - ], - ], - ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Users' => [ + 'description' => 'The members.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the member.'."\n", + 'type' => 'object', + 'properties' => [ + 'EndUserId' => ['description' => 'The user name.'."\n", 'type' => 'string', 'example' => 'alex****', 'title' => ''], + 'Avatar' => ['description' => '> This field is deprecated.'."\n", 'type' => 'string', 'example' => 'https://avatar.****.com', 'title' => ''], + 'Address' => ['description' => '> This field is deprecated.'."\n", 'type' => 'string', 'example' => 'xx-xx-xx', 'title' => ''], + 'Phone' => ['description' => 'The mobile number.'."\n", 'type' => 'string', 'example' => '138****1111', 'title' => ''], + 'Email' => ['description' => 'The email address.'."\n", 'type' => 'string', 'example' => 'alex****@example.com', 'title' => ''], + 'NickName' => ['description' => 'The display name.'."\n", 'type' => 'string', 'example' => 'alex', 'title' => ''], + 'JobNumber' => ['description' => '> This field is deprecated.'."\n", 'type' => 'string', 'example' => '123', 'title' => ''], + 'GmtJoinGroup' => ['description' => 'The time when the user was added to the user group.'."\n", 'type' => 'string', 'example' => '2024-08-26T02:59:22.000+00:00', 'title' => ''], + 'GmtCreated' => ['description' => 'The time when the user was created.'."\n", 'type' => 'string', 'example' => '2024-08-26T02:59:22.000+00:00', 'title' => ''], + 'Remark' => ['description' => 'The remarks on the user.'."\n", 'type' => 'string', 'example' => 'remark', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'NextToken' => ['description' => 'The token for the next query. If NextToken is empty, all results have been queried.'."\n", 'type' => 'string', 'example' => 'AAAAAV3MpHK****', 'title' => ''], ], + 'example' => '', ], ], ], - '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":"<RemoveUsersResponse>\\n <RequestId>45341120-2560-4087-8359-B936E58DDB90</RequestId>\\n <RemoveUsersResult>\\n <FailedUsers>\\n <EndUserId>test2</EndUserId>\\n <ErrorCode>InvalidUsername</ErrorCode>\\n <ErrorMessage>test2 is invalid username</ErrorMessage>\\n </FailedUsers>\\n <RemovedUsers>test1</RemovedUsers>\\n </RemoveUsersResult>\\n</RemoveUsersResponse>","errorExample":""}]', - 'title' => 'RemoveUsers', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyUser' => [ - 'summary' => 'Updates the contact information of a convenience account.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Query group members ', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-30T14:09:42.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeGroupUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeGroups' => [ + 'summary' => 'Query user groups.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'EndUserId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the user.', - 'type' => 'string', - 'required' => true, - 'example' => 'Alice', - ], + 'schema' => ['description' => 'The ID of the user group.', 'type' => 'string', 'required' => false, 'example' => 'ug-16nf7xxh4o9gc****', 'title' => ''], ], [ - 'name' => 'Email', + 'name' => 'BizType', 'in' => 'query', - 'schema' => [ - 'description' => 'The email address of the convenience user. For a user-activated convenience user, the email address or mobile number must be verified. You can choose to verify the email address or the mobile number. For an administrator-activated convenience user, the email address and mobile number can be left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'username@example.com', - ], + 'schema' => ['description' => '> This parameter is for internal use only.', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'title' => ''], ], [ - 'name' => 'Phone', + 'name' => 'SolutionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The mobile number of the convenience user. For a user-activated convenience user, the email address or mobile number must be verified. You can choose to verify the email address or the mobile number. For an administrator-activated convenience user, the email address and mobile number can be left empty.'."\n" - ."\n" - .'> Accounts created on the International site (alibabacloud.com) do not support mobile number-based authentication.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1381111****', - ], + 'schema' => ['description' => '> This parameter is for internal use only.', 'type' => 'string', 'required' => false, 'example' => 'co-0esnf80jab***', 'title' => ''], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the user group.', 'type' => 'string', 'required' => false, 'example' => 'TestGroup', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'default' => '20', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'TransferFileNeedApproval', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether file approval is enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'LoginPolicyId', + 'in' => 'query', + 'schema' => ['title' => '指定关联的登录策略筛选。'."\n", 'description' => 'The ID of a logon policy. If you specify this parameter, the call returns only user groups associated with the policy.', 'type' => 'string', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'ExcludeAttachedLoginPolicyGroups', + 'in' => 'query', + 'schema' => ['title' => '是否排除已关联登录策略的用户组。', 'description' => 'Specifies whether to exclude user groups that are already associated with a logon policy.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'IdpId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'Groups' => [ + 'description' => 'A list of user groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details about a user group.', + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['description' => 'The name of the user group.', 'type' => 'string', 'example' => 'TestGroup', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the user group.', 'type' => 'string', 'example' => 'ug-2412ojkwtybd****', 'title' => ''], + 'Description' => ['description' => 'The description of the user group.', 'type' => 'string', 'example' => 'A test group.', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the user group was created.', 'type' => 'string', 'example' => '2025-08-07T13:40:40+08:00', 'title' => ''], + 'UserCount' => ['description' => 'The number of members in the user group.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TransferFileNeedApproval' => ['description' => 'Indicates whether file transfer approval is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'AttachedLoginPolicy' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => ['description' => 'The ID of the logon policy.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Name' => ['description' => 'The name of the logon policy.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => 'The logon policy attached to the user group.', + 'title' => '', + 'example' => '', + ], + 'AuthedResources' => [ + 'description' => 'A list of authorized resources.', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'The type of the authorized resource.', + 'enumValueTitles' => ['DesktopGroup' => 'A desktop group.'], + 'type' => 'string', + 'example' => 'DesktopGroup', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Count' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ModifyUser', - ], - 'ResetUserPassword' => [ - 'summary' => 'Resets the password for a convenience user. If you call this operation, a token that is used to reset the password is generated, and the system sends a password reset email that includes the token to the email address of the convenience user.', - 'methods' => [ - 'get', - 'post', + 'title' => 'Query groups', + 'changeSet' => [ + ['createdAt' => '2025-12-29T02:53:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-11-27T07:00:44.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-11T07:57:42.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-07-30T14:09:42.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + '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"}]', + ], + 'DescribeMfaDevices' => [ + 'summary' => 'Lists virtual MFA devices bound to directory accounts.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Users', - 'in' => 'formData', + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return per page. Valid range: 1–500.<br>Default value: 100.<br>', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token for the next page of results. This value is the `NextToken` returned from a previous call.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'EndUserIds', + 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The names of the convenience users whose passwords you want to reset.', + 'description' => 'An array of end user usernames.', 'type' => 'array', - 'items' => [ - 'description' => 'The name of the convenience user whose password you want to reset.', - 'type' => 'string', - 'required' => true, - 'example' => 'test1', - ], - 'required' => true, - 'example' => 'test1', + 'items' => ['description' => 'The username of an end user.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + 'required' => false, + 'example' => 'test', 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'NotifyType', - 'in' => 'formData', + 'name' => 'SerialNumbers', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The method to notify the user after the password is reset.'."\n" - ."\n" - .'> Alibaba Cloud accounts of the international site do not support sending notification through text messages.', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'An array of serial numbers for virtual MFA devices.', + 'type' => 'array', + 'items' => ['description' => 'The serial number of a virtual MFA device.', 'type' => 'string', 'required' => false, 'example' => 'c2d9ae94-a64b-4a0d-8024-9519ca50****', 'title' => ''], 'required' => false, - 'enumValueTitles' => [ - 1 => 'email', - 'text message', - 'both', - ], - 'example' => '1', + 'example' => 'c2d9ae94-a64b-4a0d-8024-9519ca50****', + 'maxItems' => 100, + 'title' => '', ], ], [ + 'name' => 'AdDomain', + 'in' => 'query', + 'schema' => ['description' => 'The AD domain name.', 'type' => 'string', 'required' => false, 'example' => 'cn.misumi.pri', 'title' => ''], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ 'name' => 'BusinessChannel', - 'in' => 'formData', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'in' => 'query', + 'schema' => ['title' => 'Channel', 'description' => 'The business channel.', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The information that is returned.', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '32D05B39-E6EE-4D7A-9FD0-762A26859D0D', - ], - 'ResetUsersResult' => [ - 'description' => 'The result of resetting the password of the convenience user.', - 'type' => 'object', - 'properties' => [ - 'ResetUsers' => [ - 'description' => 'The convenience users to which the system sent a password reset email.', - 'type' => 'array', - 'items' => [ - 'description' => 'The convenience user to which the system sent a password reset email.', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '33DBB8EC-6E68-4726-91C4-E09C59D9A7D8'], + 'NextToken' => ['description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp', 'title' => ''], + 'MfaDevices' => [ + 'title' => 'mfa device list', + 'description' => 'A list of virtual MFA devices.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the virtual MFA device.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the virtual MFA device.', 'type' => 'integer', 'format' => 'int64', 'example' => '36', 'title' => ''], + 'EndUserId' => ['description' => 'The username of the convenience user who uses the virtual MFA device.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'Email' => ['description' => '> This parameter is not in use.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'GmtEnabled' => ['description' => 'The time when the virtual MFA device was enabled. The time is displayed in UTC and is formatted as `yyyy-MM-ddTHH:mm:ssZ`.', 'type' => 'string', 'example' => '2021-06-22T06:20:49Z', 'title' => ''], + 'GmtUnlock' => ['description' => 'The time when the locked virtual MFA device is automatically unlocked. The time is displayed in UTC and is formatted as `yyyy-MM-ddTHH:mm:ssZ`.', 'type' => 'string', 'example' => '2021-06-23T06:20:49Z', 'title' => ''], + 'ConsecutiveFails' => ['description' => 'The number of consecutive failed attempts to bind or authenticate the virtual MFA device.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'SerialNumber' => ['description' => 'The serial number of the virtual MFA device.', 'type' => 'string', 'example' => 'dc856334-446b-4035-bfbc-18af261e****', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the virtual MFA device.', + 'enumValueTitles' => ['LOCKED' => 'The device is locked.', 'UNBOUND' => 'The device is not bound to a user.', 'NORMAL' => 'The device is working as expected.'], 'type' => 'string', - 'example' => 'test1', + 'example' => 'NORMAL', + 'title' => '', ], - ], - 'FailedUsers' => [ - 'description' => 'The information about the convenience users whose passwords failed to be reset.', - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the convenience user whose password failed to be reset.', + 'DeviceType' => [ + 'description' => 'The type of the virtual MFA device. Set the value to `TOTP_VIRTUAL`, which indicates a virtual MFA device that complies with the Time-based One-time Password (TOTP) algorithm.', + 'enumValueTitles' => ['TOTP_VIRTUAL' => 'A virtual MFA device that uses the TOTP algorithm.'], + 'type' => 'string', + 'example' => 'TOTP_VIRTUAL', + 'title' => '', + ], + 'AdUser' => [ 'type' => 'object', 'properties' => [ - 'EndUserId' => [ - 'description' => 'The ID of the convenience user whose password failed to be reset.', - 'type' => 'string', - 'example' => 'test123', - ], - 'ErrorCode' => [ - 'description' => 'The error code.', - 'type' => 'string', - 'example' => 'InvalidUsername', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.', - 'type' => 'string', - 'example' => 'test123 is an invalid username.', - ], + 'EndUser' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DisplayNameNew' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserPrincipalName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - '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":"<ResetUserPasswordResponse>\\n <RequestId>32D05B39-E6EE-4D7A-9FD0-762A26859D0D</RequestId>\\n <ResetUsersResult>\\n <ResetUsers>test1</ResetUsers>\\n </ResetUsersResult>\\n</ResetUserPasswordResponse>","errorExample":""}]', - 'title' => 'ResetUserPassword', + 'title' => 'Query virtual MFA devices attached to convenience accounts ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'LockUsers' => [ - 'summary' => 'Locks one or more convenience users.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-25T01:40:52.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-08-21T09:00:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-04-23T06:50:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-04-23T06:50:16.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMfaDevices'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeMfaDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'DescribeOrgByLayer' => [ + 'summary' => 'Find subordinate organizations.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Users', + 'name' => 'ParentOrgId', 'in' => 'formData', - 'style' => 'repeatList', + 'schema' => ['description' => 'The ID of the parent organization.'."\n", 'type' => 'string', 'required' => false, 'example' => 'org-11fs****', 'title' => ''], + ], + [ + 'name' => 'OrgName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the organization.'."\n", 'type' => 'string', 'required' => false, 'example' => '产品部', 'title' => ''], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The usernames of the convenience users that you want to lock.', - 'type' => 'array', - 'items' => [ - 'description' => 'The username of the convenience user that you want to lock.', - 'type' => 'string', - 'required' => true, - 'example' => 'test1', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'Orgs' => [ + 'description' => 'The organizations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The organization.'."\n", + 'type' => 'object', + 'properties' => [ + 'OrgName' => ['description' => 'The name of the organization.'."\n", 'type' => 'string', 'example' => '开发部', 'title' => ''], + 'OrgId' => ['description' => 'The ID of the organization.'."\n", 'type' => 'string', 'example' => 'org-1mox****', 'title' => ''], + 'ParentOrgId' => ['description' => 'The ID of the parent organization.'."\n", 'type' => 'string', 'example' => 'org-ezqr****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - 'required' => true, - 'example' => 'test1', - 'maxItems' => 500, + 'example' => '', ], ], + ], + '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' => 'Find subordinate organizations by specifying a parent organization.', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOrgByLayer'], + ], + ], + 'ramActions' => [ [ - 'name' => 'LogoutSession', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeOrgByLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeOrgs' => [ + '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' => 'The maximum number of entries to return. Valid values: 1 to 100.<br>'."\n" + .'Default value: 100.<br>', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'default' => '500', 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token. To retrieve the next page of results, set this parameter to the `NextToken` value that was returned from a previous request.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK****', 'title' => ''], + ], + [ + 'name' => 'OrgName', 'in' => 'query', + 'schema' => ['description' => 'The organization name.', 'type' => 'string', 'required' => false, 'example' => '产品部', 'title' => ''], + ], + [ + 'name' => 'ParentOrgId', + 'in' => 'query', + 'schema' => ['description' => 'The parent organization ID.', 'type' => 'string', 'required' => false, 'example' => 'org-11fs****', 'title' => ''], + ], + [ + 'name' => 'ShowExtras', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'boolean', + 'description' => '', + 'additionalProperties' => ['type' => 'any', 'description' => '', 'title' => '', 'example' => ''], + 'type' => 'object', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'BusinessChannel', 'in' => 'query', + 'schema' => ['title' => 'Channel', 'description' => 'The channel.', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], + ], + [ + 'name' => 'IncludeOrgIds', + 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], @@ -881,205 +1679,423 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'LockUsersResult' => [ - 'description' => 'The result of the locking the convenience user.', - 'type' => 'object', - 'properties' => [ - 'LockedUsers' => [ - 'description' => 'The convenience users that were locked.', - 'type' => 'array', - 'items' => [ - 'description' => 'The convenience user that was locked.', - 'type' => 'string', - 'example' => 'test1', - ], - ], - 'FailedUsers' => [ - 'description' => 'The convenience users that failed to be locked.', - 'type' => 'array', - 'items' => [ - 'description' => 'The convenience user that failed to be locked.', - 'type' => 'object', - 'properties' => [ - 'EndUserId' => [ - 'description' => 'The ID of the convenience user that failed to be locked.', - 'type' => 'string', - 'example' => 'test123', - ], - 'ErrorCode' => [ - 'description' => 'The error code.', - 'type' => 'string', - 'example' => 'InvalidUsername', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.', - 'type' => 'string', - 'example' => 'test123 is an invalid username.', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0B4BB****'], + 'NextToken' => ['description' => 'The token used to retrieve the next page of results. If this parameter is not empty, more results are available. To retrieve the next page, pass this value in the `NextToken` parameter of a subsequent request.', 'type' => 'string', 'example' => 'AAAAAV3MpHK****', 'title' => ''], + 'Orgs' => [ + 'description' => 'The organization list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The organization details.', + 'type' => 'object', + 'properties' => [ + 'OrgName' => ['description' => 'The organization name.', 'type' => 'string', 'example' => '设计部****', 'title' => ''], + 'OrgId' => ['description' => 'The organization ID.', 'type' => 'string', 'example' => 'org-1mox****', 'title' => ''], + 'ParentOrgId' => ['description' => 'The parent organization ID.', 'type' => 'string', 'example' => 'org-ezqr****', 'title' => ''], + 'OrgNamePath' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ResourcePolicyList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PolicyName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => 'Query Organization List', + 'summary' => 'Queries a list of organizations.', + 'description' => 'Organizations are arranged in a tree-like structure. The root organization ID is org-aliyun-wy-org-id.', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-12T13:09:08.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - '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":"<LockUsersResponse>\\n <LockUsersResult>\\n <LockedUsers>test1</LockedUsers>\\n </LockUsersResult>\\n <RequestId>EC4A8495-3323-4364-A374-FEE8584644F8</RequestId>\\n</LockUsersResponse>","errorExample":""}]', - 'title' => 'LockUsers', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UnlockUsers' => [ - 'summary' => 'Unlocks one or more convenience users.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOrgs'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeOrgs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + '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 \\"ResourcePolicyList\\": [\\n {\\n \\"PolicyId\\": \\"\\",\\n \\"PolicyName\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeResourceGroups' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Users', - 'in' => 'formData', - 'style' => 'repeatList', + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the resource group.', 'type' => 'string', 'required' => false, 'example' => '部门A资源组', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupIds', + 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'The usernames of the convenience users that you want to unlock.', + 'description' => 'The list of resource group IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'The username of the convenience user that you want to unlock.', - 'type' => 'string', - 'required' => true, - 'example' => 'test1', - ], - 'required' => true, - 'example' => 'test1', - 'maxItems' => 500, + 'items' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-9th3k8twp3ox2***', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AutoLockTime', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'NeedContainResourceGroupWithOfficeSite', + 'in' => 'query', + 'schema' => ['description' => '> This parameter is not publicly available.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Platform', + 'in' => 'query', + 'schema' => ['description' => '> Fixed value: AliyunConsole.'."\n" + .'> - For Elastic Desktop Service Enterprise Edition, set this parameter to AliyunConsole. Other platforms are not publicly available.', 'type' => 'string', 'required' => false, 'example' => 'AliyunConsole', 'title' => ''], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The channel tag.', 'type' => 'string', 'example' => 'ENTERPRISE', 'required' => false], + ], + [ + 'name' => 'AliyunResourceGroupIds', 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'The date on which the convenience users are automatically locked.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The cloud platform resource group ID.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-as8nlsbsxsldk***', 'required' => false], 'required' => false, - 'example' => '2023-03-03', + 'example' => '', ], ], [ - 'name' => 'BusinessChannel', + 'name' => 'ResourceClassification', 'in' => 'query', 'schema' => [ - 'title' => '渠道', 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', + 'enum' => ['Default', 'DesktopAgent'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'AgentType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The information that is returned.', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '023F4EC4-3602-4A3E-A514-4970847D59DB', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '68BA1DF7-8814-5AED-B844-F8F7F7****'], + 'ResourceGroup' => [ + 'description' => 'The list of resource groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'The resource group information.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-cyo0il2pzge1***', 'title' => ''], + 'ResourceGroupName' => ['description' => 'The name of the resource group.', 'type' => 'string', 'example' => '测试资源组', 'title' => ''], + 'ResourceCount' => ['description' => 'The resource count in the resource group.', 'type' => 'string', 'example' => '119', 'title' => ''], + 'AuthCount' => ['description' => 'The number of administrators authorized for the resource group.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2022-11-29T17:25:40.000000000Z', 'title' => ''], + 'Policies' => [ + 'description' => '> The policies associated with the resource group.'."\n" + .'> - Associated policies take effect on cloud desktops in the resource group. If multiple policies are associated, they take effect based on policy priority.'."\n" + .'> - If a cloud desktop in the resource group already has other policies specified, the policies associated with the resource group take precedence.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The policy ID.', 'type' => 'string', 'example' => 'pl-a8jnatl8kjasb***', 'title' => ''], + 'Name' => ['description' => 'The policy name.', 'type' => 'string', 'example' => '测试策略123', 'title' => ''], + 'IsDefault' => ['description' => 'Indicates whether the policy is the default policy.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Timers' => [ + 'description' => '> The associated scheduled tasks.'."\n" + .'> - Associated scheduled tasks take effect on cloud desktops in the resource group. If a cloud desktop in the resource group already has other scheduled tasks associated, the tasks associated with the resource group take precedence.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The scheduled task ID.', 'type' => 'string', 'example' => 't-asdzx0mbjhg***', 'title' => ''], + 'Name' => ['description' => 'The scheduled task name.', 'type' => 'string', 'example' => '测试任务123', 'title' => ''], + 'TimerStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'BindStatus' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'AppRules' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Type' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'AliyunResourceGroupId' => ['title' => '', 'description' => 'The Alibaba Cloud resource group ID.', 'type' => 'string', 'example' => 'rg-123456'], + 'AgentType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'UnlockUsersResult' => [ - 'description' => 'The result of unlocking the convenience user.', + 'TotalCount' => ['description' => 'The total number of resource groups.', 'type' => 'string', 'example' => '7', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'View resource group information', + 'summary' => 'Queries resource groups.', + 'changeSet' => [ + ['createdAt' => '2025-12-29T02:53:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-05-22T11:11:36.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeResourceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + '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 \\"AgentType\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": \\"7\\"\\n}","type":"json"}]', + ], + 'DescribeUser' => [ + 'summary' => 'Query user basic information ', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => ['description' => 'Username.', 'type' => 'string', 'required' => false, 'example' => 'alex', 'title' => ''], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => ['description' => 'Business type.', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], + ], + [ + 'name' => 'RequireExtraAttributes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'List of attributes to query.', + 'type' => 'array', + 'items' => [ + 'enumValueTitles' => ['OrgPaths' => 'organization', 'ExternalInfo' => 'External Account Information', 'Properties' => 'property'], + 'description' => 'The properties to query.', + 'type' => 'string', + 'required' => false, + 'example' => 'Org', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Return data structure. ', + 'title' => 'Schema of Response ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID. ', 'title' => 'Id of the request ', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'User' => [ + 'description' => 'User information. ', 'type' => 'object', 'properties' => [ - 'UnlockedUsers' => [ - 'description' => 'The convenience users that were unlocked.', + 'EndUserId' => ['description' => 'Username. ', 'type' => 'string', 'example' => 'alex', 'title' => ''], + 'Email' => ['description' => 'Mailbox. ', 'type' => 'string', 'example' => 'alex@test-email.com', 'title' => ''], + 'Phone' => ['description' => 'Phone number. ', 'type' => 'string', 'example' => '1888888****', 'title' => ''], + 'Remark' => ['description' => 'Remarks. ', 'type' => 'string', 'example' => 'remark', 'title' => ''], + 'WyId' => ['description' => 'Unique ID of the Wuying user. ', 'type' => 'string', 'example' => 'aisdfumj****', 'title' => ''], + 'Status' => ['description' => 'User status. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Extras' => [ + 'description' => 'Extension information. ', + 'additionalProperties' => ['description' => 'Extension information. ', 'type' => 'string', 'example' => '{"assignedResourceount":1}', 'title' => ''], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'GmtCreate' => ['description' => 'Creation Time. ', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-01-01 12:00:00', 'title' => ''], + 'OrgIds' => [ + 'description' => 'List of organization IDs. ', 'type' => 'array', - 'items' => [ - 'description' => 'The convenience user that was unlocked.', - 'type' => 'string', - 'example' => 'test1', - ], + 'items' => ['description' => 'Organization ID. ', 'type' => 'string', 'example' => 'org-1nsdf8a****', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'FailedUsers' => [ - 'description' => 'The convenience users that failed to be unlocked.', + 'OrgPaths' => [ + 'description' => 'List of organizations. ', + 'type' => 'array', + 'items' => ['description' => 'Organization name. ', 'type' => 'string', 'example' => 'org1/org2', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Properties' => [ + 'description' => 'User attributes. ', 'type' => 'array', 'items' => [ - 'description' => 'The convenience user that failed to be unlocked.', + 'description' => '', 'type' => 'object', 'properties' => [ - 'EndUserId' => [ - 'description' => 'The ID of the convenience user that failed to be unlocked.', - 'type' => 'string', - 'example' => 'test123', - ], - 'ErrorCode' => [ - 'description' => 'The error code.', - 'type' => 'string', - 'example' => 'InvalidUsername', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.', - 'type' => 'string', - 'example' => 'test123 is an invalid username.', - ], + 'Key' => ['description' => 'Attribute key. ', 'type' => 'string', 'example' => 'role', 'title' => ''], + 'Value' => ['description' => 'Attribute value. ', 'type' => 'string', 'example' => 'teacher', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'ExternalInfo' => [ + 'description' => 'Associated external user information. ', + 'type' => 'object', + 'properties' => [ + 'ExternalName' => ['description' => 'External information name. ', 'type' => 'string', 'example' => 'Alex', 'title' => ''], + 'JobNumber' => ['description' => 'Employee ID. ', 'type' => 'string', 'example' => '15412***', 'title' => ''], + 'SsoType' => ['description' => 'SSO logon type. ', 'type' => 'string', 'example' => 'OIDC', 'title' => ''], + 'ExternalId' => ['description' => 'External User ID. ', 'type' => 'string', 'example' => 'oijjnabsf****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'NickName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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":"<UnlockUsersResponse>\\n <RequestId>023F4EC4-3602-4A3E-A514-4970847D59DB</RequestId>\\n <UnlockUsersResult>\\n <UnlockedUsers>test1</UnlockedUsers>\\n </UnlockUsersResult>\\n</UnlockUsersResponse>","errorExample":""}]', - 'title' => 'UnlockUsers', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeUsers' => [ - 'summary' => 'Queries the information about convenience users. The information of a convenience user includes a username, an email address, and a description.', - 'methods' => [ - 'get', - 'post', + 'title' => 'Query user information ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"User\\": {\\n \\"EndUserId\\": \\"alex\\",\\n \\"Email\\": \\"alex@test-email.com\\",\\n \\"Phone\\": \\"1888888****\\",\\n \\"Remark\\": \\"remark\\",\\n \\"WyId\\": \\"aisdfumj****\\",\\n \\"Status\\": 0,\\n \\"Extras\\": {\\n \\"key\\": \\"{\\\\\\"assignedResourceount\\\\\\":1}\\"\\n },\\n \\"GmtCreate\\": 0,\\n \\"OrgIds\\": [\\n \\"org-1nsdf8a****\\"\\n ],\\n \\"OrgPaths\\": [\\n \\"org1/org2\\"\\n ],\\n \\"Properties\\": [\\n {\\n \\"Key\\": \\"role\\",\\n \\"Value\\": \\"teacher\\"\\n }\\n ],\\n \\"ExternalInfo\\": {\\n \\"ExternalName\\": \\"Alex\\",\\n \\"JobNumber\\": \\"15412***\\",\\n \\"SsoType\\": \\"OIDC\\",\\n \\"ExternalId\\": \\"oijjnabsf****\\"\\n },\\n \\"NickName\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeUsers' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1087,51 +2103,37 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => [ - 'description' => 'The maximum number of entries per page.'."\n" + 'description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'- Valid values: 1 to 500.'."\n" ."\n" - .'* Valid values: 1 to 500.'."\n" - .'* Default value: 500.'."\n", + .'- Default value: 200.', + 'enumValueTitles' => [], 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '500', 'minimum' => '1', - 'enumValueTitles' => [], - 'example' => '10', 'default' => '500', + 'example' => '10', + 'title' => '', ], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.\\'."\n" - .'If not all results are returned in a query, a value is returned for the NextToken parameter. In this case, you can use the return value of NextToken to perform the next query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a****', - ], + 'schema' => ['description' => 'The token that is used to start the next query. If the number of entries returned exceeds the value of MaxResults, a token is returned. You can use this token in the next query to continue the query.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a****', 'title' => ''], ], [ 'name' => 'Filter', 'in' => 'query', - 'schema' => [ - 'description' => 'The string that is used for fuzzy search. You perform fuzzy search by username (EndUserId) and email address (Email). Wildcard characters (\\*) are supported. For example, if you set this parameter to `a*m`, usernames or email addresses that start with `a` and end with `m` are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a*m', - ], + 'schema' => ['description' => 'The filter for a fuzzy search. The filter matches usernames (EndUserId) and email addresses (Email). This parameter supports the wildcard character (\\*). For example, if you set this parameter to `a*m`, all results whose usernames or email addresses start with `a` and end with `m` are returned.', 'type' => 'string', 'required' => false, 'example' => 'a*m', 'title' => ''], ], [ 'name' => 'FilterMap', @@ -1139,9 +2141,10 @@ 'style' => 'json', 'schema' => [ 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - ], + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ @@ -1149,16 +2152,13 @@ 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The usernames that must be exactly matched.'."\n", + 'description' => 'The list of usernames (EndUserId) that you want to exactly match.', 'type' => 'array', - 'items' => [ - 'description' => 'The username that must be exactly matched.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alice', - ], + 'items' => ['description' => 'Performs an exact match by username (EndUserId) to query the information of the account that has the same username.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], 'required' => false, 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], [ @@ -1166,51 +2166,40 @@ 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The usernames that must be exactly excluded.'."\n", + 'description' => 'The list of usernames (EndUserId) that you want to exactly exclude.', 'type' => 'array', - 'items' => [ - 'description' => 'The username that must be exactly excluded.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tony', - ], + 'items' => ['description' => 'Excludes the specified username (EndUserId) from a query to obtain a list of accounts that do not contain the username.', 'type' => 'string', 'required' => false, 'example' => 'tony', 'title' => ''], 'required' => false, 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'OrgId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the organization in which you want to query users.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'org-4mdgc1cocc59z****', - ], + 'schema' => ['description' => 'Performs an exact match by organization ID to query the list of accounts that belong to the organization.', 'type' => 'string', 'required' => false, 'example' => 'org-4mdgc1cocc59z****', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the organization in which you want to query convenience users.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ug-12341234****', - ], + 'schema' => ['description' => 'Performs an exact match by user group ID to query the list of accounts that belong to the user group.', 'type' => 'string', 'required' => false, 'example' => 'ug-12341234****', 'title' => ''], ], [ 'name' => 'ShowExtras', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => '> This parameter is not available to the public.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'ResourcesCount: true', - 'description' => '', - ], + 'additionalProperties' => ['description' => 'The key is one of the following types, and the value is a boolean. Passing true indicates that you want to query the specified information. Membership in groups and departments is returned by default.'."\n" + .'\\- `Group`: groups that the user belongs to.'."\n" + .'\\- `Org`: departments that the user belongs to.'."\n" + .'\\- `ResourcesCount`: number of assigned resources.'."\n" + .'\\- `Properties`: user attributes.', 'type' => 'any', 'example' => 'ResourcesCount: true', 'title' => ''], + 'title' => '', + 'example' => '', ], ], [ @@ -1218,25 +2207,22 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => '> This parameter is not available to the public.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'boolean', - 'example' => 'DesktopGroup: true', - 'description' => '', - ], + 'additionalProperties' => ['description' => 'The key is one of the following types, and the value is a boolean. Passing true filters users who are assigned the specified cloud resource.'."\n" + .'\\- `Desktop`: a cloud desktop.'."\n" + .'\\- `DesktopGroup`: a shared cloud desktop.'."\n" + .'\\- `CloudDrive`: an enterprise cloud drive (user\'s personal drive).'."\n" + .'\\- `App`: a cloud application.', 'type' => 'boolean', 'example' => 'DesktopGroup: true', 'title' => ''], + 'title' => '', + 'example' => '', ], ], [ 'name' => 'IsQueryAllSubOrgs', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Queries extended information about the user.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'FilterWithAssignedResource', @@ -1245,323 +2231,248 @@ 'schema' => [ 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'App:aig-jfgmanbo****', - 'description' => '', - ], + 'additionalProperties' => ['description' => 'The key is one of the following types, and the value is a boolean. Passing true filters users who are assigned the specified cloud resource.'."\n" + ."\n" + .'- `Desktop`: a cloud desktop.'."\n" + ."\n" + .'- `DesktopGroup`: a shared cloud desktop.'."\n" + ."\n" + .'- `CloudDrive`: an enterprise cloud drive (user\'s personal drive).'."\n" + ."\n" + .'- `App`: a cloud application.', 'type' => 'string', 'example' => 'App:aig-jfgmanbo****', 'title' => ''], + 'description' => 'Filters users by whether a cloud resource is assigned.', + 'title' => '', + 'example' => '', ], ], [ 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'title' => '状态', - 'description' => 'The status.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['description' => 'Specifies whether to query users in suborganizations.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => ''], ], [ 'name' => 'ExcludeGroupId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the user group to exclude. If specified, the query returns users who are not in this user group.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['title' => 'Channel', 'description' => 'Status', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'NextToken' => [ - 'description' => 'The token that determines the start point of the next query. If this parameter is left empty, all results are returned.', - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'NextToken' => ['description' => 'The token to start the next query. If this parameter is empty, all results have been returned.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], 'Users' => [ 'title' => 'users', - 'description' => 'The information about the convenience accounts.'."\n", + 'description' => 'The details of the convenience accounts.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the convenience account.'."\n", + 'description' => 'The details of the convenience accounts.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the convenience user.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4205**', - ], - 'EndUserId' => [ - 'description' => 'The username of the convenience user.'."\n", - 'type' => 'string', - 'example' => 'alice', - ], - 'Email' => [ - 'description' => 'The email address of the convenience user.'."\n", - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'Phone' => [ - 'description' => 'The mobile number of the convenience user. If you leave this parameter empty, the value of this parameter is not returned.'."\n", - 'type' => 'string', - 'example' => '1381111****', - ], + 'Id' => ['description' => 'The ID of the convenience account.', 'type' => 'integer', 'format' => 'int64', 'example' => '4205**', 'title' => ''], + 'EndUserId' => ['description' => 'The end user ID.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'Email' => ['description' => 'The email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'Phone' => ['description' => 'The phone number. This parameter is returned only if a phone number is set.', 'type' => 'string', 'example' => '1381111****', 'title' => ''], 'Status' => [ - 'description' => 'The status of the convenience user.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: The convenience user is normal.'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* 9: The convenience user is locked.'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", + 'description' => 'The status of the convenience account.', + 'enumValueTitles' => ['Enabled', 9 => 'Locked'], 'type' => 'integer', 'format' => 'int64', - 'enumValueTitles' => [ - 'The user status is normal.', - 9 => 'The user is locked.', - ], 'example' => '0', + 'title' => '', ], 'OwnerType' => [ - 'description' => 'The type of the convenience account.'."\n" - ."\n" - .'* Administrator-activated type: The administrator specifies the username and password of the convenience account. User notifications such as password reset notifications are sent to the email address or mobile number of the administrator.'."\n" - .'* User-activated type: The administrator specifies the username and the email address or mobile number of a convenience user. Notifications such as activation notifications that contain the default password are sent to the email address or mobile number of the convenience user.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CreateFromManager'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' administrator-activated'."\n" + 'description' => 'The type of the convenience account. The account can be activated in one of the following ways:'."\n" ."\n" - .' <!-- -->'."\n" + .'- Tenant manager-activated: The tenant manager sets the username and password. Notifications such as password resets are sent to the tenant manager\'s email address or mobile phone.'."\n" ."\n" - .'* Normal'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' user-activated'."\n" - ."\n" - .' <!-- -->'."\n", + .'- End user-activated: The tenant manager sets the username and the end user\'s email address or mobile phone. Notifications for the end user, such as the initial password for the cloud desktop, are sent to the end user\'s email address or mobile phone.', + 'enumValueTitles' => ['CreateFromManager' => 'The convenience account is activated by a tenant manager.', 'Normal' => 'The convenience account is activated by an end user.'], 'type' => 'string', - 'enumValueTitles' => [ - 'CreateFromManager' => '', - 'Normal' => '', - ], 'example' => 'Normal', + 'title' => '', ], - 'Remark' => [ - 'description' => 'The remarks on the convenience user.'."\n", - 'type' => 'string', - 'example' => 'TestUser', - ], - 'OrgId' => [ - 'description' => 'The ID of the organization to which the convenience user belongs.'."\n" - ."\n" - .'> This parameter will be deprecated in the future.'."\n", - 'type' => 'string', - 'example' => 'org-4mdgc1cocc59z****', - ], - 'WyId' => [ - 'description' => 'The globally unique ID of the convenience user.'."\n", - 'type' => 'string', - 'example' => '41fd1254d8f7****', - ], - 'IsTenantManager' => [ - 'description' => 'Indicates whether the convenience user is an administrator. If the convenience user is of the administrator-activated type, you must specify a user administrator. Notifications such as password reset on a client are sent to the email address or mobile number of the user administrator. For more information, see [Create a convenience user](~~214472~~).'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Remark' => ['description' => 'The note about the convenience account.', 'type' => 'string', 'example' => 'Test user.', 'title' => ''], + 'OrgId' => ['description' => 'The ID of the organization to which the convenience account belongs.'."\n" + ."\n" + .'> This parameter is deprecated and may be removed in a future release.', 'type' => 'string', 'example' => 'org-4mdgc1cocc59z****', 'title' => ''], + 'WyId' => ['description' => 'The globally unique ID of the convenience account.', 'type' => 'string', 'example' => '41fd1254d8f7****', 'title' => ''], + 'IsTenantManager' => ['description' => 'Indicates whether the user is a tenant manager. When you create a convenience account of the `CreateFromManager` type, you must specify a tenant manager. Notifications, such as password resets initiated by an end user from a client, are sent to the tenant manager\'s email or mobile phone. For more information, see [Create a convenience account](~~214472~~).', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Groups' => [ - 'description' => 'The user groups to which the convenience user belongs.'."\n", + 'description' => 'The user groups to which the convenience account belongs.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Details of a user group to which the convenience account belongs.', 'type' => 'object', 'properties' => [ - 'GroupId' => [ - 'description' => 'The ID of the user group.'."\n", - 'type' => 'string', - 'example' => 'ug-12341234****', - ], - 'GroupName' => [ - 'description' => 'The name of the user group.'."\n", - 'type' => 'string', - 'example' => 'User Group 1'."\n", - ], + 'GroupId' => ['description' => 'The ID of the user group.', 'type' => 'string', 'example' => 'ug-12341234****', 'title' => ''], + 'GroupName' => ['description' => 'The name of the user group.', 'type' => 'string', 'example' => '用户组1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'Orgs' => [ - 'description' => 'The organizations to which the convenience user belongs.'."\n", + 'description' => 'The organizations to which the convenience account belongs.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Details of an organization to which the convenience account belongs.', 'type' => 'object', 'properties' => [ - 'OrgId' => [ - 'description' => 'The organization ID.'."\n", - 'type' => 'string', - 'example' => 'org-4mdgc1cocc59z****', - ], - 'OrgName' => [ - 'description' => 'The organization name.'."\n", - 'type' => 'string', - 'example' => 'Organization 1'."\n", - ], - 'OrgNamePath' => [ - 'type' => 'string', - ], + 'OrgId' => ['description' => 'The ID of the organization.', 'type' => 'string', 'example' => 'org-4mdgc1cocc59z****', 'title' => ''], + 'OrgName' => ['description' => 'The name of the organization.', 'type' => 'string', 'example' => '部门1', 'title' => ''], + 'OrgNamePath' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'Avatar' => [ - 'description' => 'The profile picture of the convenience user.'."\n", - 'type' => 'string', - 'example' => 'https://cdn.*****', - ], - 'Address' => [ - 'description' => 'The work address of the convenience user.'."\n", - 'type' => 'string', - 'example' => 'Hangzhou \\*\\*\\*'."\n", - ], - 'NickName' => [ - 'description' => 'The nickname of the convenience user.'."\n", - 'type' => 'string', - 'example' => 'Lee'."\n", - ], - 'RealNickName' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], - 'JobNumber' => [ - 'description' => 'The employee number of the convenience user.'."\n", - 'type' => 'string', - 'example' => 'A10000**', - ], + 'Avatar' => ['description' => 'The URL of the user\'s avatar.', 'type' => 'string', 'example' => 'https://cdn.*****', 'title' => ''], + 'Address' => ['description' => 'The work address of the user.', 'type' => 'string', 'example' => '杭州市***', 'title' => ''], + 'NickName' => ['description' => 'The nickname of the user.<br>'."\n" + .'The value is determined from the following parameters, in order of priority:<br>'."\n" + ."\n" + .'- `RealNickName`'."\n" + ."\n" + .'- `Remark`'."\n" + ."\n" + .'- `EndUserId`', 'type' => 'string', 'example' => '李**', 'title' => ''], + 'RealNickName' => ['description' => 'The display name of the user.', 'type' => 'string', 'example' => '李**', 'title' => ''], + 'JobNumber' => ['description' => 'The employee ID.', 'type' => 'string', 'example' => 'A10000**', 'title' => ''], 'Extras' => [ - 'description' => '', + 'description' => 'The extended properties of the user.', 'type' => 'object', 'properties' => [ 'AssignedResourceCount' => [ - 'description' => '', + 'description' => 'The number of assigned cloud resources.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => 'Desktop: 3', + 'additionalProperties' => ['description' => 'The key specifies the resource type, and the value specifies the resource count. The following resource types are supported:'."\n" + ."\n" + .'- `Desktop`: cloud desktops.'."\n" + ."\n" + .'- `DesktopGroup`: desktop groups.'."\n" + ."\n" + .'- `CloudDrive`: cloud drives (personal drives for end users).'."\n" + ."\n" + .'- `APP`: cloud applications.', 'type' => 'any', 'example' => 'Desktop: 3', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ResourcePolicyList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PolicyName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'ExternalName' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], + 'ExternalName' => ['description' => 'The name of the user imported from an external system.'."\n" + ."\n" + .'> This parameter is for internal use only.', 'type' => 'string', 'example' => '马**', 'title' => ''], 'Properties' => [ - 'description' => '', + 'description' => 'A list of custom properties for the user.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A key-value pair that represents a custom property.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Role', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Student', - ], + 'Key' => ['description' => 'The property key.', 'type' => 'string', 'example' => 'Role', 'title' => ''], + 'Value' => ['description' => 'The property value.', 'type' => 'string', 'example' => 'Student', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'EnableAdminAccess' => [ - 'title' => '启用管理员访问权限', - 'description' => 'Enables the administrator permissions.'."\n", - 'type' => 'boolean', - ], - 'PasswordExpireDays' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PasswordExpireRestDays' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'EnableAdminAccess' => ['description' => 'Indicates whether administrator access is enabled.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'PasswordExpireDays' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PasswordExpireRestDays' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - '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":"<DescribeUsersResponse>\\n <RequestId>BA75EDC9-8A5F-40C2-ABD5-EBAE56A4D67C</RequestId>\\n <Users>\\n <Status>0</Status>\\n <Email>test1@example***.com</Email>\\n <EndUserId>test1</EndUserId>\\n <Id>12345</Id>\\n </Users>\\n</DescribeUsersResponse>","errorExample":""}]', - 'title' => 'DescribeUsers', + 'title' => 'Query convenience account information ', + 'summary' => 'Retrieves directory account information, including the username, email address, and display name.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-11-27T07:00:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-10-20T04:15:55.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-07-30T14:09:42.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-06-07T08:23:01.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-04-01T11:55:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-27T12:03:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-01-02T11:15:32.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-24T06:16:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-07-19T11:27:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-24T10:00:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-11T13:20:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-23T23:11:19.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-08-06T01:47:45.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-08T12:07:49.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-08-12T08:48:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-12T08:48:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-04-23T06:50:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-04-23T06:50:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-04-02T06:14:21.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUsers'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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 \\"ResourcePolicyList\\": [\\n {\\n \\"PolicyId\\": \\"\\",\\n \\"PolicyName\\": \\"\\"\\n }\\n ]\\n },\\n \\"ExternalName\\": \\"马**\\",\\n \\"Properties\\": [\\n {\\n \\"Key\\": \\"Role\\",\\n \\"Value\\": \\"Student\\"\\n }\\n ],\\n \\"EnableAdminAccess\\": false,\\n \\"PasswordExpireDays\\": 0,\\n \\"PasswordExpireRestDays\\": 0\\n }\\n ]\\n}","type":"json"}]', ], 'FilterUsers' => [ - 'summary' => 'Filters convenience accounts by property.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1574,75 +2485,47 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '36913', - 'abilityTreeNodes' => [ - 'FEATUREgwsZABQI3', - ], + 'abilityTreeNodes' => ['FEATUREgwsZABQI3'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. If you set this parameter to a value greater than 100, the system resets the value to 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. If you specify a value greater than 100, the system automatically sets this parameter to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. If not all results are returned in a query, a value is returned for the NextToken parameter. In this case, you can use the returned NextToken value to start the next query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. If the number of results exceeds the value of the `MaxResults` parameter, a `NextToken` is returned. You can use the `NextToken` to query the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a****', 'title' => ''], ], [ 'name' => 'Filter', 'in' => 'query', - 'schema' => [ - 'description' => 'The string that is used for fuzzy search. You can use usernames and email addresses to perform fuzzy search. Wildcard characters (\\*) are supported for this parameter. For example, if you set this parameter to a\\*m, the usernames or an email addresses that start with a or end with m are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The string for a fuzzy search on the username (`EndUserId`) and email address (`Email`). The wildcard character (`*`) is supported. For example, if you set this parameter to `a*m`, the query returns all results where the username or email address starts with `a` and ends with `m`.', 'type' => 'string', 'required' => false, 'example' => 'a*m', 'title' => ''], ], [ 'name' => 'PropertyFilterParam', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The list of properties for fuzzy search.'."\n", + 'description' => 'The user properties for a fuzzy search.', 'type' => 'array', 'items' => [ - 'description' => 'The custom parameter that is configured by the user.'."\n", + 'description' => 'The user property for a fuzzy search.', 'type' => 'object', 'properties' => [ - 'PropertyId' => [ - 'description' => 'The ID of the property.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'PropertyValueIds' => [ - 'description' => 'The IDs of the property values.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - 'maxItems' => 100, - ], + 'PropertyId' => ['description' => 'The property ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '328', 'title' => ''], + 'PropertyValueIds' => ['description' => 'The property value ID.', 'type' => 'string', 'maxItems' => 100, 'required' => false, 'example' => '1255', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ @@ -1650,123 +2533,64 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The list of property names and property values.'."\n", + 'description' => 'The information about property keys and property values.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the property and property value.'."\n", + 'description' => 'The information about the property key and property value.', 'type' => 'object', 'properties' => [ - 'PropertyKey' => [ - 'description' => 'The property name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'job', - ], - 'PropertyValues' => [ - 'description' => 'The property values.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dev', - 'maxItems' => 100, - ], + 'PropertyKey' => ['description' => 'The property key.', 'type' => 'string', 'required' => false, 'example' => 'job', 'title' => ''], + 'PropertyValues' => ['description' => 'The property value.', 'type' => 'string', 'maxItems' => 100, 'required' => false, 'example' => 'dev', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'IncludeDesktopCount', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to return the number of cloud desktops that are assigned to the convenience user.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", + 'description' => 'Specifies whether to return the number of cloud desktops that are assigned to the user.', + 'enumValueTitles' => ['true' => 'Returns the number of allocated cloud desktops', 'false' => 'Does not return the number of allocated cloud desktops.'], 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], 'example' => 'true', + 'title' => '', ], ], [ 'name' => 'IncludeDesktopGroupCount', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to return the number of cloud desktop pools that are assigned to the convenience user.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", + 'description' => 'Specifies whether to return the number of desktop groups that are assigned to the user.', + 'enumValueTitles' => ['true' => 'Returns the number of assigned desktop groups', 'false' => 'Does not return the number of allocated desktop groups.'], 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], 'example' => 'false', + 'title' => '', ], ], [ 'name' => 'OrgId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the organization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'org-aliyun-wy-org-id', - ], + 'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'example' => 'org-aliyun-wy-org-id', 'title' => ''], ], [ 'name' => 'OwnerType', 'in' => 'query', 'schema' => [ - 'description' => 'The activation type of the convenience account.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CreateFromManager: administrator-activated.'."\n" - .'* Normal: user-activated.'."\n", + 'description' => 'The account activation type.', + 'enumValueTitles' => ['CreateFromManager' => 'CreateFromManager', 'Normal' => 'Normal'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'CreateFromManager' => '', - 'Normal' => '', - ], 'example' => 'Normal', + 'title' => '', ], ], [ @@ -1775,10 +2599,11 @@ 'style' => 'repeatList', 'schema' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'maxItems' => 500, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ @@ -1786,16 +2611,13 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The list of usernames to be precisely excluded.'."\n", + 'description' => 'The usernames (`EndUserId`) to exclude by exact match.', 'type' => 'array', - 'items' => [ - 'description' => 'The username (EndUserId) that you want to exactly exclude during the query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'end_user_id', - ], + 'items' => ['description' => 'The username (`EndUserId`) to exclude. The query does not return users with this username.', 'type' => 'string', 'required' => false, 'example' => 'tony', 'title' => ''], 'required' => false, 'maxItems' => 2000, + 'title' => '', + 'example' => '', ], ], [ @@ -1803,101 +2625,63 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The parameter that might affect the sorting logic.'."\n", + 'description' => 'The sorting parameters.', 'type' => 'object', 'properties' => [ 'OrderField' => [ - 'description' => 'The field that you want to sort by.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* EndUserId: the username.'."\n" - .'* id: the ID of the primary key.'."\n" - .'* gmt_created: the creation time.'."\n", + 'description' => 'The field by which to sort the results.', + 'enumValueTitles' => ['EndUserId' => 'User name', 'id' => 'User primary key ID', 'gmt_created' => 'creation time'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'EndUserId' => '', - 'id' => 'id', - 'gmt_created' => '', - ], 'example' => 'id', + 'title' => '', ], 'OrderType' => [ - 'description' => 'The direction of the sort.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ASC: the ascending order.'."\n" - .'* DESC (default): the descending order.'."\n", + 'description' => 'The sort order.', + 'enumValueTitles' => ['ASC' => 'Ascending order', 'DESC' => 'Descending order \\[Default]'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'ASC' => '', - 'DESC' => '', - ], - 'example' => 'ASC', + 'example' => 'DESC', + 'title' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'title' => '状态', - 'description' => 'The status.'."\n", + 'description' => 'The user status by which to filter the results.', + 'enumValueTitles' => ['Normal status', 11 => 'Separated'], 'type' => 'integer', 'format' => 'int32', + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - '正常状态', - 11 => '已离职', - ], 'example' => '0', ], ], [ 'name' => 'IsQueryAllSubOrgs', 'in' => 'query', - 'schema' => [ - 'title' => '是否查询所有子组织', - 'description' => 'Specifies whether to query all sub-organizations.'."\n", - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['description' => 'Specifies whether to query all sub-organizations.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => ''], ], [ 'name' => 'IncludeOrgInfo', 'in' => 'query', - 'schema' => [ - 'title' => '是否包含组织信息', - 'description' => 'Specifies whether to return the organization information.'."\n", - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['description' => 'Specifies whether to include organization information in the response.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => ''], ], [ 'name' => 'IncludeSupportIdps', 'in' => 'query', - 'schema' => [ - 'title' => '包含支持的登录类型', - 'description' => 'Specifies whether to return the supported logon types.'."\n", - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['description' => 'Specifies whether to include the supported logon types in the response.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['title' => 'Channel', 'description' => 'The channel.', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], [ 'name' => 'FilterMap', @@ -1905,9 +2689,22 @@ 'style' => 'json', 'schema' => [ 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - ], + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ShowExtras', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], @@ -1915,355 +2712,240 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'DBD276B5-00FF-5E04-8EF7-5CBA09BF112A', - ], - 'NextToken' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. If not all results are returned in a query, a value is returned for the NextToken parameter. In this case, you can use the returned NextToken value to start the next query.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'NextToken' => ['description' => 'The token for paginated results. If the response is truncated, this parameter is returned. To retrieve the next page of results, include this value in a subsequent request.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a****', 'title' => ''], 'Users' => [ 'title' => 'users', - 'description' => 'The information about the convenience accounts.'."\n", + 'description' => 'A list of convenience accounts.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the convenience account.'."\n", + 'description' => 'A convenience account.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the convenience user.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'EndUserId' => [ - 'description' => 'The username of the convenience user.'."\n", - 'type' => 'string', - 'example' => 'testName', - ], - 'Email' => [ - 'description' => 'The email address of the convenience user.'."\n", - 'type' => 'string', - 'example' => 'testName@example.com', - ], - 'Phone' => [ - 'description' => 'The mobile number of the convenience user.'."\n", - 'type' => 'string', - 'example' => '1381111****', - ], + 'Id' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '4205**', 'title' => ''], + 'EndUserId' => ['description' => 'The user name.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'Email' => ['description' => 'The email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], + 'Phone' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '1381111****', 'title' => ''], 'Status' => [ - 'description' => 'The remarks on the convenience account.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: The convenience account is normal.'."\n" - .'* 9: The convenience account is locked.'."\n", + 'description' => 'The status of the convenience account.', + 'enumValueTitles' => ['Normal', 9 => 'Locked', 11 => 'Resigned'], 'type' => 'integer', 'format' => 'int64', - 'enumValueTitles' => [ - '', - 9 => '', - 11 => '', - ], 'example' => '0', + 'title' => '', ], 'UserSetPropertiesModels' => [ - 'description' => 'The information about the properties.'."\n", + 'description' => 'A list of user properties.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the user property.'."\n", + 'description' => 'A user property.', 'type' => 'object', 'properties' => [ - 'UserId' => [ - 'description' => 'The ID of the convenience user that is bound to the property.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'UserName' => [ - 'description' => 'The username of the convenience user that is bound to the property.'."\n", - 'type' => 'string', - 'example' => 'testName', - ], - 'PropertyId' => [ - 'description' => 'The property ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'PropertyKey' => [ - 'description' => 'The property name.'."\n", - 'type' => 'string', - 'example' => 'department', - ], - 'PropertyType' => [ - 'description' => 'The property type.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'UserId' => ['description' => 'The ID of the user associated with the property.', 'type' => 'integer', 'format' => 'int64', 'example' => '4205**', 'title' => ''], + 'UserName' => ['description' => 'The user name associated with the property.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'PropertyId' => ['description' => 'The ID of the user property.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'PropertyKey' => ['description' => 'The name of the user property.', 'type' => 'string', 'example' => 'department', 'title' => ''], + 'PropertyType' => ['description' => 'The type of the user property.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'PropertyValues' => [ - 'description' => 'The property values.'."\n", + 'description' => 'The property values.', 'type' => 'array', 'items' => [ - 'description' => 'Details of the property value.'."\n", + 'description' => 'A property value.', 'type' => 'object', 'properties' => [ - 'PropertyValueId' => [ - 'description' => 'The ID of the property value.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'PropertyValue' => [ - 'description' => 'The property value.'."\n", - 'type' => 'string', - 'example' => 'A', - ], + 'PropertyValueId' => ['description' => 'The ID of the property value.', 'type' => 'integer', 'format' => 'int64', 'example' => '42', 'title' => ''], + 'PropertyValue' => ['description' => 'The property value.', 'type' => 'string', 'example' => 'dev', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'DesktopCount' => [ - 'description' => 'The number of cloud desktops that are assigned to the convenience user.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'DesktopCount' => ['description' => 'The number of cloud desktops assigned to the user.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'ExternalInfo' => [ - 'description' => 'The additional information about the convenience user.'."\n", + 'description' => 'External user information.', 'type' => 'object', 'properties' => [ - 'ExternalName' => [ - 'description' => 'The account that is associated with the convenience user.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'JobNumber' => [ - 'description' => 'The account, student ID, or employee ID that is associated with the convenience user.'."\n", - 'type' => 'string', - 'example' => '030801', - ], + 'ExternalName' => ['description' => 'The name of the mapped external account.', 'type' => 'string', 'example' => 'account', 'title' => ''], + 'JobNumber' => ['description' => 'The ID of the external account, such as a student ID or an employee ID.', 'type' => 'string', 'example' => '030801', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'DesktopGroupCount' => [ - 'description' => 'The number of cloud desktop pools that are assigned to the convenience user. This value is returned if you set `IncludeDesktopGroupCount` to `true`.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], + 'DesktopGroupCount' => ['description' => 'The number of desktop groups the user can access. This parameter is returned only when `IncludeDesktopGroupCount` is set to `true`.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'OwnerType' => [ - 'description' => 'The type of the account ownership.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CreateFromManager: administrator-activated'."\n" - .'* Normal: user-activated', + 'description' => 'The account ownership type.', + 'enumValueTitles' => ['CreateFromManager' => 'Administrator-activated', 'Normal' => 'User-activated'], 'type' => 'string', - 'enumValueTitles' => [ - 'CreateFromManager' => '', - 'Normal' => '', - ], 'example' => 'Normal', + 'title' => '', ], - 'Remark' => [ - 'description' => 'The remarks on the convenience user.'."\n", - 'type' => 'string', - 'example' => '1', - ], + 'Remark' => ['description' => 'The remark about the user.', 'type' => 'string', 'example' => '测试专用', 'title' => ''], 'IsTenantManager' => [ - 'description' => 'Indicates whether the convenience user is a tenant administrator.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", + 'description' => 'Indicates whether the user is a tenant administrator.', + 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'], 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], 'example' => 'true', + 'title' => '', ], 'EnableAdminAccess' => [ - 'description' => 'Indicates whether the convenience user is a local administrator.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", + 'description' => 'Indicates whether the user has local administrator permissions.', + 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'], 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], 'example' => 'true', + 'title' => '', ], - 'RealNickName' => [ - 'description' => 'The nickname of the convenience user.'."\n", - 'type' => 'string', - 'example' => 'Oliver'."\n", - ], - 'AutoLockTime' => [ - 'description' => 'The date when a convenience account is automatically locked.'."\n", - 'type' => 'string', - 'example' => '2023-03-03', - ], - 'PasswordExpireDays' => [ - 'description' => 'By default, user account passwords do not expire. However, you can set a validity period between 30 and 365 days. Once the period expires, end users must change their password before they can log on to terminals.'."\n" - ."\n" - .'> The feature is in invitational preview. If you want to use this feature, submit a ticket.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PasswordExpireRestDays' => [ - 'description' => 'The number of days remaining until the account password expires.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'RealNickName' => ['description' => 'The user\'s nickname.', 'type' => 'string', 'example' => '小明', 'title' => ''], + 'AutoLockTime' => ['description' => 'The date the account will be automatically locked.', 'type' => 'string', 'example' => '2023-03-03', 'title' => ''], + 'PasswordExpireDays' => ['description' => 'The password validity period in days. By default, passwords do not expire. Set this to a value from 30 to 365 to enforce an expiration policy. When a password expires, the user must change it before logging on again.'."\n" + ."\n" + .'> This feature is in preview and available by invitation only. To use this feature, submit a ticket.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'PasswordExpireRestDays' => ['description' => 'The number of days until the password expires.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'OrgList' => [ - 'title' => '用户所属组织列表', - 'description' => 'The organizations to which the user belongs.'."\n", + 'title' => '', + 'description' => 'A list of organizations the user belongs to.', 'type' => 'array', 'items' => [ - 'title' => '用户所属组织列表', - 'description' => 'The organizations to which the user belongs.'."\n", + 'title' => '', + 'description' => 'An organization the user belongs to.', 'type' => 'object', 'properties' => [ - 'OrgId' => [ - 'title' => '组织结构ID', - 'description' => 'The organization ID.'."\n", - 'type' => 'string', - ], - 'OrgName' => [ - 'title' => '组织结构名称', - 'description' => 'The organization name.'."\n", - 'type' => 'string', - ], - 'OrgNamePath' => [ - 'title' => '组织结构名称路径', - 'description' => 'The organization name path.'."\n", - 'type' => 'string', - ], + 'OrgId' => ['description' => 'The organization ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'OrgName' => ['description' => 'The organization name.', 'type' => 'string', 'title' => '', 'example' => ''], + 'OrgNamePath' => ['description' => 'The organization name path.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'example' => '', ], + 'example' => '', ], 'SupportLoginIdps' => [ - 'title' => '支持的登录身份源方式', - 'description' => 'The supported identity provider logon methods.'."\n", + 'title' => '', + 'description' => 'A list of identity providers (IdPs) that the user can use to log on.', 'type' => 'array', 'items' => [ - 'title' => '支持的登录身份源方式', - 'description' => 'The supported identity provider logon method.'."\n", + 'title' => '', + 'description' => 'An identity provider (IdP) that the user can use to log on.', 'type' => 'object', 'properties' => [ - 'IdpId' => [ - 'title' => '企业身份源ID', - 'description' => 'The enterprise identity provider ID.'."\n", - 'type' => 'string', - ], - 'IdpName' => [ - 'title' => '企业身份源名称', - 'description' => 'The enterprise identity provider name.'."\n", - 'type' => 'string', - ], + 'IdpId' => ['description' => 'The ID of the identity provider (IdP).', 'type' => 'string', 'title' => '', 'example' => ''], + 'IdpName' => ['description' => 'The name of the identity provider (IdP).', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'example' => '', ], + 'example' => '', ], 'Groups' => [ + 'description' => '', 'type' => 'array', 'items' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'GroupId' => [ - 'type' => 'string', - ], - 'GroupName' => [ - 'type' => 'string', - ], + 'GroupId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'GroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ResourcePolicyList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PolicyId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PolicyName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - '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":"<FilterUsersResponse>\\n <RequestId>DBD276B5-00FF-5E04-8EF7-5CBA09BF112A</RequestId>\\n <Users>\\n <Status>0</Status>\\n <EndUserId>testName</EndUserId>\\n <Email>testName@example.com</Email>\\n <Phone/>\\n <Id>12345</Id>\\n <UserSetPropertiesModels>\\n <PropertyValues>\\n <PropertyValueId>184</PropertyValueId>\\n <PropertyValue>true</PropertyValue>\\n </PropertyValues>\\n <UserId>12345</UserId>\\n <PropertyType>1</PropertyType>\\n <PropertyKey>enableAdminAccess</PropertyKey>\\n <PropertyId>145</PropertyId>\\n </UserSetPropertiesModels>\\n <UserSetPropertiesModels>\\n <PropertyValues>\\n <PropertyValueId>42</PropertyValueId>\\n <PropertyValue>A</PropertyValue>\\n </PropertyValues>\\n <UserId>12345</UserId>\\n <PropertyType>2</PropertyType>\\n <PropertyKey>department</PropertyKey>\\n <PropertyId>30</PropertyId>\\n </UserSetPropertiesModels>\\n </Users>\\n</FilterUsersResponse>","errorExample":""}]', - 'title' => 'FilterUsers', + 'title' => 'Filtered query for convenience account information ', + 'summary' => 'Filter account information by user attribute.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-11-27T07:00:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-10-20T04:15:55.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-06-07T08:23:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-24T09:53:19.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-12-11T07:38:32.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-15T11:59:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-09T12:00:07.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-10-25T11:42:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-05T05:02:35.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-08T12:07:49.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FilterUsers'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:FilterUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","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 \\"ResourcePolicyList\\": [\\n {\\n \\"PolicyId\\": \\"\\",\\n \\"PolicyName\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], 'GetManagerInfoByAuthCode' => [ 'summary' => 'Obtains the information about the current logon administrator based on the authorization code.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'AuthCode', 'in' => 'query', - 'schema' => [ - 'title' => '授权码', - 'description' => 'The authorization code.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'e49cd070452f0044813a467d4743****', - ], + 'schema' => ['title' => '', 'description' => 'The authorization code.'."\n", 'type' => 'string', 'required' => true, 'example' => 'e49cd070452f0044813a467d4743****'], ], ], 'responses' => [ @@ -2273,61 +2955,42 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'WaId' => [ - 'title' => '租户无影账号ID', - 'description' => 'The ID of the Elastic Desktop Service account.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345678901234****', - ], - 'OrgId' => [ - 'title' => '组织ID', - 'description' => 'The organization ID.'."\n", - 'type' => 'string', - 'example' => '12345678901234****', - ], - 'UserName' => [ - 'title' => '租户名称', - 'description' => 'The tenant name.'."\n", - 'type' => 'string', - 'example' => 'zhangsan', - ], - 'Phone' => [ - 'title' => '手机号', - 'description' => 'The mobile number.'."\n", - 'type' => 'string', - 'example' => '1301234****', - ], - 'TeamName' => [ - 'title' => '团队名称', - 'description' => 'The team name.'."\n", - 'type' => 'string', - 'example' => 'devteam', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'WaId' => ['title' => '', 'description' => 'The ID of the Elastic Desktop Service account.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345678901234****'], + 'OrgId' => ['title' => '', 'description' => 'The organization ID.'."\n", 'type' => 'string', 'example' => '12345678901234****'], + 'UserName' => ['title' => '', 'description' => 'The tenant name.'."\n", 'type' => 'string', 'example' => 'zhangsan'], + 'Phone' => ['title' => '', 'description' => 'The mobile number.'."\n", 'type' => 'string', 'example' => '1301234****'], + 'TeamName' => ['title' => '', 'description' => 'The team name.'."\n", 'type' => 'string', 'example' => 'devteam'], ], + 'example' => '', ], ], [], ], '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' => 'GetManagerInfoByAuthCode', - ], - 'BatchSetDesktopManager' => [ - 'summary' => 'Grants or revokes the local administrator permissions on cloud computers for convenience accounts.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:GetManagerInfoByAuthCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'InitTenantAlias' => [ + 'summary' => 'Initialize the organization ID.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2335,370 +2998,268 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'Users', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The convenience accounts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The convenience account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'alice', - ], - 'required' => true, - 'maxItems' => 500, - ], - ], - [ - 'name' => 'IsDesktopManager', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Whether the convenience account has the local administrator permissions on cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: no'."\n" - .'* 1 (default): yes'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '1', - ], - ], - [ 'name' => 'BusinessChannel', - 'in' => 'formData', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'in' => 'query', + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '868B8926-2E7A-5BE7-9897-E811E994****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'Data' => ['description' => 'The generated ID of the organization.'."\n", 'type' => 'string', 'example' => 'WY23***', 'title' => ''], + 'AliasInfo' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'AliasSourceType' => [ + 'description' => 'The source of the organization ID.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Generated: auto-generated.'."\n" + .'* Customized: user-defined.'."\n", + 'type' => 'string', + 'enumValueTitles' => ['Generated' => '', 'Customized' => ''], + 'example' => 'Customized', + 'title' => '', + ], + 'AliasEditable' => ['description' => 'Indicates whether modification is allowed.'."\n", 'type' => 'boolean', 'example' => 'False', 'title' => ''], + 'AliasEditDisabledReason' => ['description' => 'The reason why modification is not allowed.'."\n", 'type' => 'string', 'example' => 'FrequencyExceedsLimit', 'title' => ''], + 'NextModifyTime' => ['description' => 'The time window during which modification is allowed.'."\n", 'type' => 'string', 'example' => '2025-04-17 20:31:48', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\"\\n}","type":"json"}]', - 'title' => 'BatchSetDesktopManager', - 'description' => 'Convenience accounts with the local administrator permissions on cloud computers can install software and modify system settings on cloud computers.'."\n", - ], - 'CreateProperty' => [ - 'summary' => 'Creates a user property.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Initialize organization ID', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:InitTenantAlias', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListProperty' => [ + 'summary' => 'Query the list of existing user attributes under the current account.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PropertyKey', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The property name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'department', - ], - ], - [ - 'name' => 'PropertyValues', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The values of the property. You can specify up to 50 values for a property.', - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the property.', - 'type' => 'string', - 'required' => false, - 'example' => 'HR', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ 'name' => 'BusinessChannel', - 'in' => 'formData', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'in' => 'query', + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'A collection of response information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'CreateResult' => [ - 'description' => 'The result of creating the property.', - 'type' => 'object', - 'properties' => [ - 'PropertyId' => [ - 'description' => 'The ID of the property.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '390', - ], - 'PropertyKey' => [ - 'description' => 'The name of the property.', - 'type' => 'string', - 'example' => 'department', - ], - 'SavePropertyValueModel' => [ - 'description' => 'The result of creating the property value.', - 'type' => 'object', - 'properties' => [ - 'SavePropertyValues' => [ - 'description' => 'Details of the property values that were created.', - 'type' => 'array', - 'items' => [ - 'description' => 'Details of the property value that was created.', - 'type' => 'object', - 'properties' => [ - 'PropertyValueId' => [ - 'description' => 'The ID of the property value.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '978', - ], - 'PropertyValue' => [ - 'description' => 'The value of the property.', - 'type' => 'string', - 'example' => 'HR', - ], - ], - ], - ], - 'FailedPropertyValues' => [ - 'description' => 'The property values that failed to be created.', - 'type' => 'array', - 'items' => [ - 'description' => 'The property values that failed to be modified.', - 'type' => 'object', - 'properties' => [ - 'PropertyId' => [ - 'description' => 'The ID of the property value.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '390', - ], - 'PropertyValue' => [ - 'description' => 'The value of the property.', - 'type' => 'string', - 'example' => 'HR', - ], - 'ErrorCode' => [ - 'description' => 'The error code.', - 'type' => 'string', - 'example' => 'ExistedPropertyValue', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.', - 'type' => 'string', - 'example' => 'The property value is used by another property.', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'NextToken' => ['description' => 'The token that is used for the next query. If this parameter is empty, all results have been returned.'."\n", 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'Properties' => [ + 'title' => 'users', + 'description' => 'The information about the properties.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Property information.', + 'type' => 'object', + 'properties' => [ + 'PropertyId' => ['description' => 'The ID of the property.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'PropertyKey' => ['description' => 'The name of the property.'."\n", 'type' => 'string', 'example' => 'department', 'title' => ''], + 'PropertyValues' => [ + 'description' => 'Details about the property values.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Attribute value information.', + 'type' => 'object', + 'properties' => [ + 'PropertyValueId' => ['description' => 'The ID of the property value.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '42', 'title' => ''], + 'PropertyValue' => ['description' => 'The value of the property.'."\n", 'type' => 'string', 'example' => 'A', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - '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":"<CreatePropertyResponse>\\n <RequestId>499B0E01-8AE3-5099-95CE-E69CF4DBE177</RequestId>\\n <CreateResult>\\n <PropertyId>390</PropertyId>\\n <PropertyKey>department</PropertyKey>\\n <SavePropertyValueModel>\\n <SavePropertyValues>\\n <PropertyValueId>978</PropertyValueId>\\n <PropertyValue>HR</PropertyValue>\\n </SavePropertyValues>\\n <FailedPropertyValues>\\n <PropertyId>390</PropertyId>\\n <PropertyValue>HR</PropertyValue>\\n <ErrorCode>ExistedPropertyValue</ErrorCode>\\n <ErrorMessage>property value is used by other property</ErrorMessage>\\n </FailedPropertyValues>\\n </SavePropertyValueModel>\\n </CreateResult>\\n</CreatePropertyResponse>","errorExample":""}]', - 'title' => 'CreateProperty', - ], - 'RemoveProperty' => [ - 'summary' => 'Deletes a user property.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query Properties', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProperty'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:ListProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListPropertyValue' => [ + 'summary' => 'Query the list of attribute values for a specific user attribute. ', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'PropertyId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the property. You can call the [ListProperty](~~410890~~) operation to query the property ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '390', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the property. You can call the [ListProperty](~~410890~~) operation to query the property ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '390', 'title' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['description' => 'Channel ', 'title' => 'Channel ', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'A collection of response information. ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'C52013A5-3422-5D1F-B22C-A57110972AD9'], + 'PropertyValueInfos' => [ + 'title' => 'users', + 'description' => 'Details about property values.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Information about an attribute value. ', + 'type' => 'object', + 'properties' => [ + 'PropertyValueId' => ['description' => 'The ID of the property value.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '978', 'title' => ''], + 'PropertyValue' => ['description' => 'The value of the property.'."\n", 'type' => 'string', 'example' => 'HR', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<RemovePropertyResponse>\\n <RequestId>D6C62E40-F937-5803-B008-92E813399BA5</RequestId>\\n</RemovePropertyResponse>","errorExample":""}]', - 'title' => 'RemoveProperty', - ], - 'DeleteUserPropertyValue' => [ - 'summary' => 'Dissociates a user property from a user.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C52013A5-3422-5D1F-B22C-A57110972AD9\\",\\n \\"PropertyValueInfos\\": [\\n {\\n \\"PropertyValueId\\": 978,\\n \\"PropertyValue\\": \\"HR\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Custom User Attribute Values ', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPropertyValue'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:ListPropertyValue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'LockMfaDevice' => [ + 'summary' => 'Lock the virtual MFA device attached to a convenience account. ', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'UserId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The user ID. You can call the [DescribeUsers](~~DescribeUsers~~) operation to query the user ID, which is the return value of the `Id` parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - ], - [ - 'name' => 'PropertyId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The property ID. You can call the [ListProperty](~~ListProperty~~) operation to query the property ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '390', - ], + 'name' => 'SerialNumber', + 'in' => 'query', + 'schema' => ['description' => 'The serial number of the virtual MFA device. The serial number is unique for each device.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dc856334-446b-4035-bfbc-18af261e****', 'title' => ''], ], [ - 'name' => 'PropertyValueId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The property value ID. You can call the [ListProperty](~~ListProperty~~) operation to query the property value ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '978', - ], + 'name' => 'AdDomain', + 'in' => 'query', + 'schema' => ['description' => 'The domain of the Active Directory (AD) workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'upower.vip', 'title' => ''], ], [ 'name' => 'BusinessChannel', - 'in' => 'formData', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'in' => 'query', + 'schema' => ['description' => 'Channel ', 'title' => 'Channel ', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ @@ -2708,30 +3269,46 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D6C62E40-F937-5803-B008-92E813399BA5', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '42FE70D8-4336-471B-8314-CCCFCE4159FD'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6C62E40-F937-5803-B008-92E813399BA5\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteUserPropertyValueResponse>\\n <RequestId>D6C62E40-F937-5803-B008-92E813399BA5</RequestId>\\n</DeleteUserPropertyValueResponse>","errorExample":""}]', - 'title' => 'DeleteUserPropertyValue', - 'description' => 'Before you call this operation, you can call the FilterUsers operation to query the users that are associated with user properties.'."\n", - ], - 'UpdateProperty' => [ - 'summary' => 'Modifies a user property.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42FE70D8-4336-471B-8314-CCCFCE4159FD\\"\\n}","type":"json"}]', + 'title' => 'Lock a virtual MFA device ', + 'description' => 'After locking, the status of the virtual MFA device changes to LOCKED. When the associated convenience account attempts to log on to a WUYING Terminal through an office network with MFA enabled, authentication will fail due to the locked MFA device, preventing successful logon. You can invoke [UnlockMfaDevice](~~UnlockMfaDevice~~) to unlock it. ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-21T09:00:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-08T12:35:42.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockMfaDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:LockMfaDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'LockUsers' => [ + 'summary' => 'Locks one or more convenience accounts. Locked convenience accounts cannot be used to sign in to Wuying clients.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2739,626 +3316,262 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PropertyId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the property that you want to modify. You can call the [ListProperty](~~410890~~) operation to query the property ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '390', - ], - ], - [ - 'name' => 'PropertyKey', + 'name' => 'Users', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The new property name.'."\n", - 'type' => 'string', + 'description' => 'The usernames of the convenience accounts to lock.', + 'type' => 'array', + 'items' => ['description' => 'The username of the convenience account to lock.', 'type' => 'string', 'required' => true, 'example' => 'alice', 'title' => ''], 'required' => true, - 'example' => 'testkey', + 'example' => 'test1', + 'maxItems' => 500, + 'title' => '', ], ], [ - 'name' => 'PropertyValues', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The values of property.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PropertyValueId' => [ - 'description' => 'The ID of property value that you want to modify. You can call the [ListProperty](~~410890~~) operation to query the property value ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '978', - ], - 'PropertyValue' => [ - 'description' => 'The new property value.', - 'type' => 'string', - 'required' => false, - 'example' => 'testvalue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'name' => 'LogoutSession', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['title' => 'Channel ', 'description' => 'The channel.', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'UpdateResult' => [ - 'description' => 'The result of the modification.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'LockUsersResult' => [ + 'description' => 'The result of the LockUsers operation.', 'type' => 'object', 'properties' => [ - 'PropertyId' => [ - 'description' => 'The ID of the property.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '390', - ], - 'PropertyKey' => [ - 'description' => 'The name of the property.'."\n", - 'type' => 'string', - 'example' => 'testkey2', + 'LockedUsers' => [ + 'description' => 'A list of successfully locked convenience accounts.', + 'type' => 'array', + 'items' => ['description' => 'A successfully locked convenience account.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'SavePropertyValueModel' => [ - 'description' => 'The result of the property value modification.'."\n", - 'type' => 'object', - 'properties' => [ - 'SavePropertyValues' => [ - 'description' => 'The property values that were modified.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PropertyValueId' => [ - 'description' => 'The ID of the property value.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '978', - ], - 'PropertyValue' => [ - 'description' => 'The value of the property.'."\n", - 'type' => 'string', - 'example' => 'testvalue2', - ], - ], - ], - ], - 'FailedPropertyValues' => [ - 'description' => 'The property values that failed to be modified.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PropertyId' => [ - 'description' => 'The ID of the property.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '390', - ], - 'PropertyValue' => [ - 'description' => 'The value of the property.'."\n", - 'type' => 'string', - 'example' => 'testvalue', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'ExistedPropertyValue', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The property value is used by another property.', - ], - ], - ], + 'FailedUsers' => [ + 'description' => 'A list of convenience accounts that failed to lock.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a convenience account that failed to lock.', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => ['description' => 'The username of the convenience account that failed to lock.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidUsername', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'test123 is an invalid username.', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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":"<UpdatePropertyResponse>\\n <RequestId>FF3CE680-7710-5ECD-8565-8B103C5301F1</RequestId>\\n <UpdateResult>\\n <SavePropertyValueModel>\\n <SavePropertyValues>\\n <PropertyValueId>978</PropertyValueId>\\n <PropertyValue>testvalue</PropertyValue>\\n </SavePropertyValues>\\n </SavePropertyValueModel>\\n <PropertyKey>testkey</PropertyKey>\\n <PropertyId>390</PropertyId>\\n </UpdateResult>\\n</UpdatePropertyResponse>","errorExample":""}]', - 'title' => 'UpdateProperty', - ], - 'SetUserPropertyValue' => [ - 'summary' => 'Associates a user property with a convenience user.', - 'methods' => [ - 'get', - 'post', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Lock Convenience Account ', + 'description' => 'For security purposes, you can lock convenience accounts. Locked convenience users cannot sign in to Wuying clients, and therefore cannot access any Wuying cloud resources.'."\n" + ."\n" + .'> Call the [DescribeUsers](~~283609~~) operation to check the lock status of convenience accounts. The `Status` value in the response is 0 for unlocked accounts and 9 for locked accounts.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-04T15:17:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-06T11:10:00.000Z', 'description' => 'Request parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockUsers'], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'UserId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the convenience user. You can call the [DescribeUsers](~~DescribeUsers~~) operation to query the user ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11', - ], - ], - [ - 'name' => 'UserName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The username of the convenience user.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'PropertyId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The property ID. You can call the [ListProperty](~~ListProperty~~) operation to query the property ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '390', - ], - ], - [ - 'name' => 'PropertyValueId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the property value. You can call the [ListProperty](~~ListProperty~~) operation to query the ID of the property value.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '978', - ], - ], + 'ramActions' => [ [ - 'name' => 'BusinessChannel', - 'in' => 'formData', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:LockUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetUserPropertyValueResponse>\\n <RequestId>D6C62E40-F937-5803-B008-92E813399BA5</RequestId>\\n</SetUserPropertyValueResponse>","errorExample":""}]', - 'title' => 'SetUserPropertyValue', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], - 'ListProperty' => [ - 'summary' => 'Queries all user properties within an Alibaba Cloud account.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyGroup' => [ + 'summary' => 'Modify the name and description of a group.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'BusinessChannel', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['description' => 'The ID of the user group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ug-dzjax1ez5qgph****', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'NextToken' => [ - 'description' => 'The token that is used for the next query. If this parameter is empty, all results have been returned.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'Properties' => [ - 'title' => 'users', - 'description' => 'The information about the properties.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PropertyId' => [ - 'description' => 'The ID of the property.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'PropertyKey' => [ - 'description' => 'The name of the property.'."\n", - 'type' => 'string', - 'example' => 'department', - ], - 'PropertyValues' => [ - 'description' => 'Details about the property values.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PropertyValueId' => [ - 'description' => 'The ID of the property value.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'PropertyValue' => [ - 'description' => 'The value of the property.'."\n", - '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":"<ListPropertyResponse>\\n <RequestId>2F4FD101-8D7B-5C97-96D6-8ACB711A7EAA</RequestId>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <Properties>\\n <PropertyId>30</PropertyId>\\n <PropertyKey>department</PropertyKey>\\n <PropertyValues>\\n <PropertyValueId>42</PropertyValueId>\\n <PropertyValue>A</PropertyValue>\\n </PropertyValues>\\n </Properties>\\n</ListPropertyResponse>","errorExample":""}]', - 'title' => 'ListProperty', - ], - 'ListPropertyValue' => [ - 'summary' => 'Queries property values of a user property.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'NewGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the new user group.'."\n", 'type' => 'string', 'required' => true, 'example' => '开发组', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'PropertyId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the property. You can call the [ListProperty](~~410890~~) operation to query the property ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '390', - ], + 'schema' => ['description' => 'The new description of the user group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestGroup', 'title' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C52013A5-3422-5D1F-B22C-A57110972AD9', - ], - 'PropertyValueInfos' => [ - 'title' => 'users', - 'description' => 'Details about property values.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PropertyValueId' => [ - 'description' => 'The ID of the property value.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '978', - ], - 'PropertyValue' => [ - 'description' => 'The value of the property.'."\n", - 'type' => 'string', - 'example' => 'HR', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '868B8926-2E7A-5BE7-9897-E811E994****'], ], + 'example' => '', ], ], ], - '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":"<ListPropertyValueResponse>\\n <RequestId>C52013A5-3422-5D1F-B22C-A57110972AD9</RequestId>\\n <PropertyValueInfos>\\n <PropertyValueId>978</PropertyValueId>\\n <PropertyValue>HR</PropertyValue>\\n </PropertyValueInfos>\\n</ListPropertyValueResponse>","errorExample":""}]', - 'title' => 'ListPropertyValue', - ], - 'CheckUsedProperty' => [ - 'summary' => 'Queries whether a property is associated with one or more convenience users.', - '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' => 'The ID of the property. You can call the [ListProperty](~~410890~~) operation to query the property ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '390', - ], - ], - [ - 'name' => 'BusinessChannel', - 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - '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' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '22C97624-2405-54AC-BD44-A63FBE97CC2D', - ], - 'UseCount' => [ - 'description' => 'The number of convenience users that are associated with the property.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\"\\n}","type":"json"}]', + 'title' => 'Modify a group', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-30T14:09:42.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"22C97624-2405-54AC-BD44-A63FBE97****\\",\\n \\"UseCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"<CheckUsedPropertyResponse>\\n <RequestId>22C97624-2405-54AC-BD44-A63FBE97CC2D</RequestId>\\n <UseCount>7</UseCount>\\n</CheckUsedPropertyResponse>","errorExample":""}]', - 'title' => 'CheckUsedProperty', ], - 'CheckUsedPropertyValue' => [ - 'summary' => 'Queries the number of convenience accounts that are associated with the specified custom property value.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyOrg' => [ + 'summary' => 'Modify an organization.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '147038', + 'abilityTreeNodes' => ['FEATUREgwsJIXGV5'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'PropertyId', + 'name' => 'OrgName', 'in' => 'query', - 'schema' => [ - 'description' => 'The property ID. You can call the [ListProperty](~~ListProperty~~) operation to query property ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '380', - ], + 'schema' => ['description' => 'The name of the organization.'."\n", 'type' => 'string', 'required' => true, 'example' => '开发部。', 'title' => ''], ], [ - 'name' => 'PropertyValueId', + 'name' => 'OrgId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the property value. You can call the [ListProperty](~~ListProperty~~) operation to query the ID of the property value.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '978', - ], + 'schema' => ['description' => 'The ID of the organization.'."\n", 'type' => 'string', 'required' => true, 'example' => 'org-76joc57khvnhdh***', 'title' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['description' => 'Channel', 'title' => '', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'UseCount' => [ - 'description' => 'The number of convenience accounts that are associated with the specified custom property value.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0296EDF8-3C8A-5128-8682-27B29C99****'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"UseCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"<CheckUsedPropertyValueResponse>\\n <RequestId>9E7F03BD-8DA9-5130-A675-0191DC1D8910</RequestId>\\n <UseCount>1</UseCount>\\n</CheckUsedPropertyValueResponse>","errorExample":""}]', - 'title' => 'CheckUsedPropertyValue', - 'description' => 'Before you call the operation, you can call the [ListProperty](~~410890~~) operation to query the existing user properties and their IDs (PropertyId) and values (PropertyValueId).', - ], - 'CreateOrg' => [ - 'summary' => 'Creates an organization.', - 'methods' => [ - 'get', - 'post', + 'title' => 'Modify an organization', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyOrg'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:ModifyOrg', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0296EDF8-3C8A-5128-8682-27B29C99****\\"\\n}","type":"json"}]', + ], + 'ModifyUser' => [ + 'summary' => 'Modify the contact information of a convenience account. ', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3366,329 +3579,216 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '147035', - 'abilityTreeNodes' => [ - 'FEATUREgwsJIXGV5', - ], - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'OrgName', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the organization.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The name of the user.', 'type' => 'string', 'required' => true, 'example' => 'alice', 'title' => ''], ], [ - 'name' => 'ParentOrgId', + 'name' => 'Email', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the parent organization.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'org-evk12ozjvmlxl****', - ], + 'schema' => ['description' => 'The email address of the convenience user. For a user-activated convenience user, the email address or mobile number must be verified. You can choose to verify the email address or the mobile number. For an administrator-activated convenience user, the email address and mobile number can be left empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'username@example.com', 'title' => ''], + ], + [ + 'name' => 'Phone', + 'in' => 'query', + 'schema' => ['description' => 'The mobile number of the convenience user. For a user-activated convenience user, the email address or mobile number must be verified. You can choose to verify the email address or the mobile number. For an administrator-activated convenience user, the email address and mobile number can be left empty.'."\n" + ."\n" + .'> Accounts created on the International site (alibabacloud.com) do not support mobile number-based authentication.'."\n", 'type' => 'string', 'required' => false, 'example' => '1381111****', 'title' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['description' => 'Channel ', 'title' => 'Channel ', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'A collection of return messages. ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7A2C3803-C975-5871-A232-80A91009****', - ], - 'OrgId' => [ - 'description' => 'The organization ID.'."\n", - 'type' => 'string', - 'example' => 'org-evk12ozjvmlxl****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A2C3803-C975-5871-A232-80A91009****\\",\\n \\"OrgId\\": \\"org-evk12ozjvmlxl****\\"\\n}","type":"json"}]', - 'title' => 'CreateOrg', - ], - 'DescribeOrgs' => [ - 'summary' => 'Queries organizations.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'Modify the contact information of a convenience account ', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-22T09:02:22.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUser'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'MoveOrg' => [ + 'summary' => 'Shift organization.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of entries to return. Valid values: 1 to 100.\\'."\n" - .'Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '500', - 'minimum' => '1', - 'example' => '20', - 'default' => '500', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The token that determines the start point of the query. The return value is the value of the NextToken response parameter that was returned last time the DescribeOrgs operation was called.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAAAAV3MpHK****', - ], - ], - [ - 'name' => 'OrgName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the organization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'org****', - ], - ], - [ - 'name' => 'ParentOrgId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The parent organization ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'org-****', - ], + 'name' => 'OrgId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the organization that you want to move.'."\n", 'type' => 'string', 'required' => true, 'example' => 'org-5yy5icj981xe5****', 'title' => ''], ], [ - 'name' => 'ShowExtras', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - ], - ], + 'name' => 'NewParentOrgId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the parent organization.'."\n", 'type' => 'string', 'required' => true, 'example' => 'org-5yy5icj981xe5****'."\n", 'title' => ''], ], [ 'name' => 'BusinessChannel', - 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'in' => 'formData', + 'schema' => ['description' => 'Channel', 'title' => '', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0B4BB****', - ], - 'NextToken' => [ - 'description' => 'The token that determines the start point of the query. The return value is the value of the NextToken response parameter that was returned last time the DescribeOrgs operation was called.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK****', - ], - 'Orgs' => [ - 'description' => 'The organizations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OrgName' => [ - 'description' => 'The name of the organizational unit.'."\n", - 'type' => 'string', - 'example' => 'org****', - ], - 'OrgId' => [ - 'description' => 'The organization ID.'."\n", - 'type' => 'string', - 'example' => 'org-****', - ], - 'ParentOrgId' => [ - 'description' => 'The parent organization ID.'."\n", - 'type' => 'string', - 'example' => 'org-****', - ], - 'OrgNamePath' => [ - 'type' => 'string', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], ], + 'example' => '', ], ], ], - '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' => 'DescribeOrgs', - 'description' => 'An organization is in a tree structure. The root organization ID is in the following format: org-aliyun-wy-org-id.'."\n", - ], - 'DescribeOrgByLayer' => [ - 'summary' => 'Queries subordinate organizations.', - 'methods' => [ - 'get', - 'post', + 'title' => 'Shift organization', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveOrg'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:MoveOrg', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'MoveUserOrg' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ParentOrgId', + 'name' => 'OrgId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the parent organization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'org-11fs****', - ], + 'schema' => ['description' => 'The organization ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'org-4mdgc1cocc59z****', 'title' => ''], ], [ - 'name' => 'OrgName', + 'name' => 'EndUserIds', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the organization.'."\n", - 'type' => 'string', - 'required' => false, + 'description' => 'The user IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alex', 'title' => ''], + 'required' => true, + 'maxItems' => 500, + 'minItems' => 1, + 'title' => '', 'example' => '', ], ], [ 'name' => 'BusinessChannel', 'in' => 'formData', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['description' => 'Channel', 'title' => '', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Orgs' => [ - 'description' => 'The organizations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The organization.'."\n", - 'type' => 'object', - 'properties' => [ - 'OrgName' => [ - 'description' => 'The name of the organization.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'OrgId' => [ - 'description' => 'The ID of the organization.'."\n", - 'type' => 'string', - 'example' => 'org-1mox****', - ], - 'ParentOrgId' => [ - 'description' => 'The ID of the parent organization.'."\n", - 'type' => 'string', - 'example' => 'org-ezqr****', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], ], + 'example' => '', ], ], ], - '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' => 'DescribeOrgByLayer', - ], - 'RemoveOrg' => [ - 'summary' => 'Removes an organization.', - 'methods' => [ - 'get', - 'post', + 'title' => 'Shift users to the target organization architecture', + 'summary' => 'Shift users to the target organization architecture.', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveUserOrg'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:MoveUserOrg', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'QuerySyncStatusByAliUid' => [ + 'summary' => 'Query the user synchronization status.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3696,65 +3796,76 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'OrgId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The organization ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'org-5yy5icj981xe5****', - ], - ], - [ 'name' => 'BusinessChannel', - 'in' => 'formData', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'in' => 'query', + 'schema' => ['description' => 'Channel ', 'title' => 'Channel ', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => 'PlainResult<UserSyncHistoryDo>', + 'description' => 'A collection of returned information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6C352609-EE7F-5603-B5E6-57C3EDDD****', + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'auto-increased id', 'description' => 'Auto increment ID. ', 'type' => 'integer', 'format' => 'int64', 'example' => '18500'], + 'GmtCreated' => ['title' => 'created time', 'description' => 'Creation Time. ', 'type' => 'string', 'example' => '2020-06-30 07:50:42'], + 'GmtModified' => ['title' => 'modified time', 'description' => 'The updated at time.', 'type' => 'string', 'example' => '2022-03-02 14:27:39'], + 'AliUid' => ['title' => 'aliUid of the customer', 'description' => 'Alibaba Cloud account ID. ', 'type' => 'integer', 'format' => 'int64', 'example' => '131239236086****'], + 'Status' => ['title' => 'user sync status', 'description' => 'The user synchronization status.', 'type' => 'string', 'example' => 'success'], + 'CorpId' => ['title' => 'corp id', 'description' => 'The enterprise ID.', 'type' => 'string', 'example' => 'cdrs948144195608****'], + 'LatestBeginTime' => ['title' => 'latestBeginTime', 'description' => 'The latest start time.', 'type' => 'string', 'example' => '2022-03-02 14:31:39'], + 'LatestEndTime' => ['title' => 'atest_end_time,Whether it is success or failure', 'description' => 'The latest end time, regardless of whether the operation succeeded or failed.', 'type' => 'string', 'example' => '2022-03-02 16:13:12'], + 'LatestSuccessTime' => ['title' => 'latestSuccessTime', 'description' => 'The latest success time.', 'type' => 'string', 'example' => '2022-03-02 18:24:01'], + ], + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request succeeded. ', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'System status code. ', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned when the request fails.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C352609-EE7F-5603-B5E6-57C3EDDD****\\"\\n}","type":"json"}]', - 'title' => 'RemoveOrg', - ], - 'MoveOrg' => [ - 'summary' => 'Moves an organization.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + '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' => 'Query user synchronization status ', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-14T09:43:54.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2022-03-14T09:43:54.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:QuerySyncStatusByAliUid', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'RemoveGroup' => [ + 'summary' => 'Delete a group. Supports batch operations. ', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3762,123 +3873,96 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'OrgId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the organization that you want to move.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'org-5yy5icj981xe5****', - ], + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the user group to be deleted.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ug-dzjax1ez5qgph****', 'title' => ''], ], [ - 'name' => 'NewParentOrgId', - 'in' => 'formData', + 'name' => 'GroupIds', + 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'The ID of the parent organization.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'org-5yy5icj981xe5****'."\n", + 'description' => 'The IDs of the user groups to be deleted.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the user group to be deleted.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ug-eld7uv7vtgqsz****', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'BusinessChannel', - 'in' => 'formData', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'in' => 'query', + 'schema' => ['description' => 'Channel ', 'title' => 'Channel ', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data structure. ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. ', 'type' => 'string', 'example' => '42FE70D8-4336-471B-8314-CCCFCE41****'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'MoveOrg', - ], - 'ModifyOrg' => [ - 'summary' => 'Modifies an organization.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42FE70D8-4336-471B-8314-CCCFCE41****\\"\\n}","type":"json"}]', + 'title' => 'Delete a group ', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-30T14:09:42.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:RemoveGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'RemoveMfaDevice' => [ + 'summary' => 'Delete the virtual MFA device attached to a convenience account. ', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '147038', - 'abilityTreeNodes' => [ - 'FEATUREgwsJIXGV5', - ], - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'OrgName', + 'name' => 'SerialNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the organization.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The serial number of the virtual MFA device. You can call the [DescribeMfaDevices](~~DescribeMfaDevices~~) operation to get this information.'."\n", 'type' => 'string', 'required' => true, 'example' => 'dc856334-446b-4035-bfbc-18af261e****', 'title' => ''], ], [ - 'name' => 'OrgId', + 'name' => 'AdDomain', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the organization.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'org-76joc57khvnhdh***', - ], + 'schema' => ['description' => 'The address of the AD office network.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alpha.lftltd.net', 'title' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['description' => 'Channel ', 'title' => 'Channel ', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ @@ -3888,453 +3972,278 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0296EDF8-3C8A-5128-8682-27B29C99****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FB550AAB-FB36-4A91-93F6-F4374AF65403'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0296EDF8-3C8A-5128-8682-27B29C99****\\"\\n}","type":"json"}]', - 'title' => 'ModifyOrg', - ], - 'MoveUserOrg' => [ - 'summary' => 'Moves users to a specific organization.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FB550AAB-FB36-4A91-93F6-F4374AF65403\\"\\n}","type":"json"}]', + 'title' => 'Delete the virtual MFA device attached to a convenience account ', + 'description' => 'Deleting the virtual MFA device attached to a convenience account unbinds the MFA device, which is equivalent to resetting or disabling it. The corresponding convenience account must reattach a new virtual MFA device when logging on to a WUYING Terminal. ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-21T09:00:53.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-01-06T06:24:11.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveMfaDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:RemoveMfaDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'RemoveOrg' => [ + 'summary' => 'Remove an organization.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'OrgId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The organization ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'org-4mdgc1cocc59z****', - ], - ], - [ - 'name' => 'EndUserIds', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The user IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alex', - ], - 'required' => true, - 'maxItems' => 500, - 'minItems' => 1, - ], + 'schema' => ['description' => 'The organization ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'org-5yy5icj981xe5****', 'title' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'formData', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['description' => 'Channel', 'title' => '', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned data.'."\n", + 'title' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6C352609-EE7F-5603-B5E6-57C3EDDD****'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'MoveUserOrg', - ], - 'CreateGroup' => [ - 'summary' => 'Creates a user group.', - 'methods' => [ - 'get', - 'post', + 'title' => 'Remove an organization', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveOrg'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:RemoveOrg', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C352609-EE7F-5603-B5E6-57C3EDDD****\\"\\n}","type":"json"}]', + ], + 'RemoveProperty' => [ + 'summary' => 'Delete a set of user attributes.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'ParentGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'root', - ], - ], - [ - 'name' => 'BizType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - ], - ], - [ - 'name' => 'SolutionId', - 'in' => 'query', - 'schema' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'co-0esnf80jab***', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the user group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestGroup', - ], + 'name' => 'PropertyId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the property. You can call the [ListProperty](~~410890~~) operation to query the property ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '390', 'title' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'A collection of response messages.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****', - ], - 'GroupId' => [ - 'description' => 'The ID of the user group.'."\n", - 'type' => 'string', - 'example' => 'ug-12341234****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'Delete Custom User Properties', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveProperty'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:RemoveProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA8D67CB-345D-5CDA-986E-FFAC7D0****\\",\\n \\"GroupId\\": \\"ug-eld7uv7vtgqsz****\\"\\n}","type":"json"}]', - 'title' => 'CreateGroup', ], - 'DescribeGroups' => [ - 'summary' => 'Queries user groups.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RemoveUsers' => [ + 'summary' => 'Delete one or more convenience accounts.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ug-12341234****', - ], - ], - [ - 'name' => 'BizType', - 'in' => 'query', - 'schema' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - ], - ], - [ - 'name' => 'SolutionId', - 'in' => 'query', - 'schema' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'co-0esnf80jab***', - ], - ], - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the user group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestGroup', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '10', - 'default' => '20', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'TransferFileNeedApproval', - 'in' => 'query', - 'schema' => [ - 'description' => 'Indicates whether the file approval feature is enabled.'."\n", - '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', + 'name' => 'Users', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'The usernames of the convenience users that you want to remove.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The username of the convenience user that you want to remove. You can call the [DescribeUsers](~~DescribeUsers~~) operation to query the username.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test1', 'title' => ''], + 'required' => true, + 'example' => 'test1', + 'maxItems' => 500, + 'minItems' => 1, + 'title' => '', ], ], [ 'name' => 'BusinessChannel', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'in' => 'formData', + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'A collection of response messages.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Groups' => [ - 'description' => 'The user groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the user group.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'description' => 'The name of the user group.'."\n", - 'type' => 'string', - 'example' => 'TestGroup', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ug-2412ojkwtybd****', - ], - 'Description' => [ - 'description' => 'The description of the user group.'."\n", - 'type' => 'string', - 'example' => 'A test group.', - ], - 'CreateTime' => [ - 'description' => 'The time when the user group is created.'."\n", - 'type' => 'string', - 'example' => '2025-08-07T13:40:40+08:00', - ], - 'UserCount' => [ - 'description' => 'The number of users in the user group.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TransferFileNeedApproval' => [ - 'description' => 'Indicates whether the file approval feature is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'AttachedLoginPolicy' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'RemoveUsersResult' => [ + 'description' => 'The result of removing the convenience user.', + 'type' => 'object', + 'properties' => [ + 'RemovedUsers' => [ + 'description' => 'The convenience users that were removed.', + 'type' => 'array', + 'items' => ['description' => 'The convenience user that was removed.', 'type' => 'string', 'example' => 'test1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'FailedUsers' => [ + 'description' => 'The convenience users that failed to be removed.', + 'type' => 'array', + 'items' => [ + 'description' => 'The convenience user that failed to be removed.', 'type' => 'object', 'properties' => [ - 'PolicyId' => [ - 'type' => 'string', - ], - 'Name' => [ - 'type' => 'string', - ], - ], - ], - 'AuthedResources' => [ - 'description' => 'The type of the resource assigned to the user group.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The type of the resource assigned to the user group.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* DesktopGroup: shared cloud computers'."\n", - 'enumValueTitles' => [ - 'DesktopGroup' => '', - ], - 'example' => 'DesktopGroup', + 'EndUserId' => ['description' => 'The ID of the convenience user that failed to be removed.', 'type' => 'string', 'example' => 'test2', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidUsername', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'test2 is an invalid username.', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'Count' => [ - 'description' => 'The number of the entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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' => 'DescribeGroups', - ], - 'UserBatchQuitGroup' => [ - 'summary' => 'Removes multiple users from a user group at a time.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Delete Convenience Accounts', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-06-30T11:24:19.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-18T11:14:57.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-02T06:24:28.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsers'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:RemoveUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ResetUserPassword' => [ + 'summary' => 'Reset the password of a convenience account, including generating a password reset token and sending a password reset email to the mailbox of the convenience account.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4342,84 +4251,120 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'Users', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the user group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ug-lkuvalovhnlxvv****', + 'description' => 'The names of the convenience users whose passwords you want to reset.', + 'type' => 'array', + 'items' => ['description' => 'The name of the convenience user whose password you want to reset.', 'type' => 'string', 'required' => true, 'example' => 'alice', 'title' => ''], + 'required' => true, + 'example' => 'test1', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'EndUserIds', + 'name' => 'NotifyType', 'in' => 'formData', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The user IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alex***', - ], + 'description' => 'The method to notify the user after the password is reset.'."\n" + ."\n" + .'> Alibaba Cloud accounts of the international site do not support sending notification through text messages.', + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'maxItems' => 100, + 'enumValueTitles' => [1 => 'email', 'text message', 'both'], + 'example' => '1', + 'title' => '', ], ], [ 'name' => 'BusinessChannel', 'in' => 'formData', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['description' => 'Channel ', 'title' => 'Channel ', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The returned data.'."\n", + 'description' => 'The information that is returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '890JNJNF-SADASSDFS-SDFSDF****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '32D05B39-E6EE-4D7A-9FD0-762A26859D0D'], + 'ResetUsersResult' => [ + 'description' => 'The result of resetting the password of the convenience user.', + 'type' => 'object', + 'properties' => [ + 'ResetUsers' => [ + 'description' => 'The convenience users to which the system sent a password reset email.', + 'type' => 'array', + 'items' => ['description' => 'The convenience user to which the system sent a password reset email.', 'type' => 'string', 'example' => 'test1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'FailedUsers' => [ + 'description' => 'The information about the convenience users whose passwords failed to be reset.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the convenience user whose password failed to be reset.', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => ['description' => 'The ID of the convenience user whose password failed to be reset.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidUsername', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'test123 is an invalid username.', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Reset the Password of a Convenience Account', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-08T12:07:49.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"890JNJNF-SADASSDFS-SDFSDF****\\"\\n}","type":"json"}]', - 'title' => 'UserBatchQuitGroup', - ], - 'UserBatchJoinGroup' => [ - 'summary' => 'Add multiple users to a user group at a time.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetUserPassword'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ResetUserPassword', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'SetUserPropertyValue' => [ + 'summary' => 'Associate a user attribute with a specific user.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4427,463 +4372,307 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the user group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ug-12341234****', - ], + 'schema' => ['description' => 'The ID of the convenience user. You can call the [DescribeUsers](~~DescribeUsers~~) operation to query the user ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '111****', 'title' => ''], ], [ - 'name' => 'EndUserIds', + 'name' => 'UserName', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The list of user IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alex****', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The username of the convenience user.'."\n", 'type' => 'string', 'required' => true, 'example' => 'alice', 'title' => ''], + ], + [ + 'name' => 'PropertyId', + 'in' => 'formData', + 'schema' => ['description' => 'The property ID. You can call the [ListProperty](~~ListProperty~~) operation to query the property ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '240**', 'title' => ''], + ], + [ + 'name' => 'PropertyValueId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the property value. You can call the [ListProperty](~~ListProperty~~) operation to query the ID of the property value.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2251**', 'title' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'formData', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7A2C3803-C975-5871-A232-80A91009****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'Set Custom Properties for a User', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-02T06:24:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUserPropertyValue'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:SetUserPropertyValue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A2C3803-C975-5871-A232-80A91009****\\"\\n}","type":"json"}]', - 'title' => 'UserBatchJoinGroup', ], - 'RemoveGroup' => [ - 'summary' => 'Deletes a single user group or multiple user groups at a time.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SyncAllEduInfo' => [ + 'summary' => 'Synchronize all education information.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user group to be deleted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ug-12341234****', - ], - ], - [ - 'name' => 'GroupIds', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => 'The IDs of the user groups to be deleted.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the user group to be deleted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ug-eld7uv7vtgqsz****', - ], - 'required' => false, - ], - ], - [ - 'name' => 'BusinessChannel', - 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], - ], - ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => 'BaseResult', + 'description' => 'Returns a collection of messages.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '42FE70D8-4336-471B-8314-CCCFCE41****', - ], + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'Status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => 'Synchronize all education information', + 'changeSet' => [ + ['createdAt' => '2022-03-14T09:43:55.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42FE70D8-4336-471B-8314-CCCFCE41****\\"\\n}","type":"json"}]', - 'title' => 'RemoveGroup', - ], - 'ModifyGroup' => [ - 'summary' => 'Modifies the name and description of a user group.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncAllEduInfo'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:SyncAllEduInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'TransferResourcesIntoGroup' => [ + 'summary' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ug-12341234****', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'rg-ckf3cx7isinhk***', 'title' => ''], ], [ - 'name' => 'NewGroupName', + 'name' => 'Resources', 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'The name of the new user group.'."\n", - 'type' => 'string', - 'required' => true, + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], + 'ResourceType' => [ + 'type' => 'string', + 'description' => '', + 'required' => false, + 'enumValueTitles' => ['CLOUD_PHONE' => '云手机', 'DESKTOP' => '云电脑'], + 'example' => 'DESKTOP', + 'title' => '', + ], + 'ResourceId' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'ecd-0jl0dwz61hn59tto****', 'title' => ''], + ], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'required' => false, + 'title' => '', 'example' => '', ], ], [ - 'name' => 'Description', + 'name' => 'Platform', 'in' => 'query', 'schema' => [ - 'description' => 'The new description of the user group.'."\n", 'type' => 'string', + 'description' => '', 'required' => false, - 'example' => 'TestGroup', + 'enumValueTitles' => ['CloudPhoneConsole' => '无影云手机', 'AliyunConsole' => '无影云电脑企业版'], + 'example' => 'AliyunConsole', + 'title' => '', ], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE', 'title' => '', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '868B8926-2E7A-5BE7-9897-E811E994****', - ], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****'], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\"\\n}","type":"json"}]', - 'title' => 'ModifyGroup', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA8D67CB-345D-5CDA-986E-FFAC7D0****\\"\\n}","type":"json"}]', ], - 'DescribeGroupUser' => [ - 'summary' => 'Queries the members of a user group.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'TransferResourcesOutofGroup' => [ + 'summary' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ug-12341234****', - ], - ], - [ - 'name' => 'BizType', - 'in' => 'query', - 'schema' => [ - 'description' => '> This parameter is not available for public use.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - ], - ], - [ - 'name' => 'SolutionId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '> This parameter is not available for public use.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'co-0esnf80jab***', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'rg-66konqltcpx43****', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'Resources', 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'ResourceType' => [ + 'type' => 'string', + 'description' => '', + 'required' => false, + 'enumValueTitles' => ['CLOUD_PHONE' => '云手机', 'DESKTOP' => '云桌面'], + 'example' => 'DESKTOP', + 'title' => '', + ], + 'ResourceId' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'ecd-1shc5sk0vo****', 'title' => ''], + ], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'description' => '', 'required' => false, - 'example' => '10', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'TargetResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The token for the next query. You can obtain this parameter from the response parameters of the last call to this operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAAAAV3MpHK****', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'rg-hcjo6dugpo1****', 'title' => ''], ], [ - 'name' => 'Filter', + 'name' => 'Platform', 'in' => 'query', - 'schema' => [ - 'description' => 'The fuzzy search string that matches the username (EndUserId) and email address (Email) of the regular user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'AliyunConsole', 'title' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE', 'title' => '', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****', - ], - 'Groups' => [ - 'description' => '> This field is deprecated.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the user group.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'description' => 'The name of the user group.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'GroupId' => [ - 'description' => 'The user group ID.'."\n", - 'type' => 'string', - 'example' => 'ug-91mvbosdjsdfh****', - ], - 'UserCount' => [ - 'description' => 'The number of members in the user group.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], - ], - ], - 'Users' => [ - 'description' => 'The members.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the member.'."\n", - 'type' => 'object', - 'properties' => [ - 'EndUserId' => [ - 'description' => 'The user name.'."\n", - 'type' => 'string', - 'example' => 'alex****', - ], - 'Avatar' => [ - 'description' => '> This field is deprecated.'."\n", - 'type' => 'string', - 'example' => 'https://avatar.****.com', - ], - 'Address' => [ - 'description' => '> This field is deprecated.'."\n", - 'type' => 'string', - 'example' => 'xx-xx-xx', - ], - 'Phone' => [ - 'description' => 'The mobile number.'."\n", - 'type' => 'string', - 'example' => '188888****', - ], - 'Email' => [ - 'description' => 'The email address.'."\n", - 'type' => 'string', - 'example' => 'alex****@aliyun.com', - ], - 'NickName' => [ - 'description' => 'The display name.'."\n", - 'type' => 'string', - 'example' => 'alex', - ], - 'JobNumber' => [ - 'description' => '> This field is deprecated.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'GmtJoinGroup' => [ - 'description' => 'The time when the user was added to the user group.'."\n", - 'type' => 'string', - 'example' => '2024-08-26T02:59:22.000+00:00', - ], - 'GmtCreated' => [ - 'description' => 'The time when the user was created.'."\n", - 'type' => 'string', - 'example' => '2024-08-26T02:59:22.000+00:00', - ], - 'Remark' => [ - 'description' => 'The remarks on the user.'."\n", - 'type' => 'string', - 'example' => 'remark', - ], - ], - ], - ], - 'NextToken' => [ - 'description' => 'The token for the next query. If NextToken is empty, all results have been queried.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK****', - ], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'D2B1DF9E-576B-5B91-BAF6-2C3DD1****'], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - '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' => 'DescribeGroupUser', - ], - 'RemoveMfaDevice' => [ - 'summary' => 'Removes a virtual multi-factor authentication (MFA) device that is bound to a convenience account.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2B1DF9E-576B-5B91-BAF6-2C3DD1****\\"\\n}","type":"json"}]', + ], + 'UnlockMfaDevice' => [ + 'summary' => 'Unlock the virtual MFA device attached to a convenience account. ', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4891,42 +4680,22 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'SerialNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The serial number of the virtual MFA device. You can call the [DescribeMfaDevices](~~DescribeMfaDevices~~) operation to get this information.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dc856334-446b-4035-bfbc-18af261e****', - ], + 'schema' => ['description' => 'The serial number of the virtual MFA device. The serial number is unique for each device.'."\n", 'type' => 'string', 'required' => true, 'example' => 'dc856334-446b-4035-bfbc-18af261e****', 'title' => ''], ], [ 'name' => 'AdDomain', 'in' => 'query', - 'schema' => [ - 'description' => 'The address of the AD office network.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alpha.lftltd.net', - ], + 'schema' => ['description' => 'The domain of the Active Directory (AD) workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'welab.co.id', 'title' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['description' => 'Channel ', 'title' => 'Channel ', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ @@ -4936,113 +4705,45 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FB550AAB-FB36-4A91-93F6-F4374AF65403', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9BD39C60-4E38-43BE-BA2F-69136C6C5190'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FB550AAB-FB36-4A91-93F6-F4374AF65403\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveMfaDeviceResponse>\\r\\n <RequestId>FB550AAB-FB36-4A91-93F6-F4374AF65403</RequestId>\\r\\n</RemoveMfaDeviceResponse>","errorExample":""}]', - 'title' => 'RemoveMfaDevice', - 'description' => 'If you remove a virtual MFA device that is bound to a convenience account, the convenience account can no longer use the virtual MFA device to log on to cloud computers. Before the convenience account can log on to Alibaba Cloud Workspace terminals again, a new virtual MFA device must be bound to the convenience account.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9BD39C60-4E38-43BE-BA2F-69136C6C5190\\"\\n}","type":"json"}]', + 'title' => 'Unlock a virtual MFA device ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'LockMfaDevice' => [ - 'summary' => 'Locks a virtual multi-factor authentication (MFA) device that is bound to a convenience user.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-21T09:00:53.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-01-06T06:24:11.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockMfaDevice'], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'SerialNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The serial number of the virtual MFA device. The serial number is unique for each device.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dc856334-446b-4035-bfbc-18af261e****', - ], - ], + 'ramActions' => [ [ - 'name' => 'AdDomain', - 'in' => 'query', - 'schema' => [ - 'description' => 'The domain of the Active Directory (AD) workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pg-jifenn.com', - ], - ], - [ - 'name' => 'BusinessChannel', - 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '42FE70D8-4336-471B-8314-CCCFCE4159FD', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:UnlockMfaDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"42FE70D8-4336-471B-8314-CCCFCE4159FD\\"\\n}","errorExample":""},{"type":"xml","example":"<LockMfaDeviceResponse>\\r\\n <RequestId>42FE70D8-4336-471B-8314-CCCFCE4159FD</RequestId>\\r\\n</LockMfaDeviceResponse>","errorExample":""}]', - 'title' => 'LockMfaDevice', - 'description' => 'After a virtual MFA device is locked, the status of the virtual MFA device changes to LOCKED. The convenience user to which the MFA device is bound cannot log on to the cloud desktop that resides in the workspace with the MFA feature enabled because the identity of the convenience user cannot be verified based on the virtual MFA device. You can call the [UnlockMfaDevice](~~286534~~) operation to unlock the virtual MFA device.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UnlockMfaDevice' => [ - 'summary' => 'Unlocks a virtual multi-factor authentication (MFA) device that is bound to a convenience user.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UnlockUsers' => [ + 'summary' => 'Unlock one or more convenience accounts. After being unlocked, the convenience accounts can log on to WUYING Terminal. ', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5050,327 +4751,257 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'SerialNumber', - 'in' => 'query', + 'name' => 'Users', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The serial number of the virtual MFA device. The serial number is unique for each device.'."\n", - 'type' => 'string', + 'description' => 'The usernames of the convenience users that you want to unlock.', + 'type' => 'array', + 'items' => ['description' => 'The username of the convenience user that you want to unlock.', 'type' => 'string', 'required' => true, 'example' => 'alice', 'title' => ''], 'required' => true, - 'example' => 'dc856334-446b-4035-bfbc-18af261e****', + 'example' => 'test1', + 'maxItems' => 500, + 'title' => '', ], ], [ - 'name' => 'AdDomain', + 'name' => 'AutoLockTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The domain of the Active Directory (AD) workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'welab.co.id', - ], + 'schema' => ['description' => 'The date on which the convenience users are automatically locked.'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-03-03', 'title' => ''], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The information that is returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9BD39C60-4E38-43BE-BA2F-69136C6C5190', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '023F4EC4-3602-4A3E-A514-4970847D59DB'], + 'UnlockUsersResult' => [ + 'description' => 'The result of unlocking the convenience user.', + 'type' => 'object', + 'properties' => [ + 'UnlockedUsers' => [ + 'description' => 'The convenience users that were unlocked.', + 'type' => 'array', + 'items' => ['description' => 'The convenience user that was unlocked.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'FailedUsers' => [ + 'description' => 'The convenience users that failed to be unlocked.', + 'type' => 'array', + 'items' => [ + 'description' => 'The convenience user that failed to be unlocked.', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => ['description' => 'The ID of the convenience user that failed to be unlocked.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidUsername', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'test123 is an invalid username.', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9BD39C60-4E38-43BE-BA2F-69136C6C5190\\"\\n}","errorExample":""},{"type":"xml","example":"<UnlockMfaDeviceResponse>\\r\\n <RequestId>9BD39C60-4E38-43BE-BA2F-69136C6C5190</RequestId>\\r\\n</UnlockMfaDeviceResponse>","errorExample":""}]', - 'title' => 'UnlockMfaDevice', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Unlock Convenience Accounts', + 'description' => 'Locked convenience accounts cannot log on to WUYING Terminal and therefore cannot access any WUYING cloud resources. To allow a convenience account to log on to WUYING Terminal, you must first unlock it. '."\n" + ."\n" + .'> You can invoke [DescribeUsers](~~283609~~) to query convenience account information. If the value of `Status` in the returned data is 0, the convenience account is not locked. If the value of `Status` is 9, the convenience account is locked. ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeMfaDevices' => [ - 'summary' => 'Queries the information about virtual multi-factor authentication (MFA) devices that are bound to convenience accounts.', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-04T15:17:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-31T01:58:25.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockUsers'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:UnlockUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateProperty' => [ + 'summary' => 'Modify User Attributes. ', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of entries to return. Valid values: 1 to 500.\\'."\n" - .'Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '100', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. Set the value to the token that is obtained from the previous query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'name' => 'PropertyId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the property that you want to modify. You can call the [ListProperty](~~410890~~) operation to query the property ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '390', 'title' => ''], ], [ - 'name' => 'EndUserIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The usernames of the convenience accounts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The username of the convenience account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'required' => false, - 'example' => 'test', - 'maxItems' => 100, - ], + 'name' => 'PropertyKey', + 'in' => 'formData', + 'schema' => ['description' => 'The new property name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testkey', 'title' => ''], ], [ - 'name' => 'SerialNumbers', - 'in' => 'query', + 'name' => 'PropertyValues', + 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The serial numbers of the virtual MFA devices.'."\n", + 'description' => 'The values of property.', 'type' => 'array', 'items' => [ - 'description' => 'The serial number of the virtual MFA device.'."\n", - 'type' => 'string', + 'description' => 'All attribute values for this property after modification.', + 'type' => 'object', + 'properties' => [ + 'PropertyValueId' => ['description' => 'The ID of property value that you want to modify. You can call the [ListProperty](~~410890~~) operation to query the property value ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '978', 'title' => ''], + 'PropertyValue' => ['description' => 'The new property value.', 'type' => 'string', 'required' => false, 'example' => 'testvalue', 'title' => ''], + ], 'required' => false, - 'example' => 'c2d9ae94-a64b-4a0d-8024-9519ca50****', + 'title' => '', + 'example' => '', ], 'required' => false, - 'example' => 'c2d9ae94-a64b-4a0d-8024-9519ca50****', 'maxItems' => 100, - ], - ], - [ - 'name' => 'AdDomain', - 'in' => 'query', - 'schema' => [ - 'description' => 'The address of the AD office network.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn.misumi.pri', - ], - ], - [ - 'name' => 'Filter', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'BusinessChannel', 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'A collection of response information. ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '33DBB8EC-6E68-4726-91C4-E09C59D9A7D8', - ], - 'NextToken' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp', - ], - 'MfaDevices' => [ - 'title' => 'mfa device list', - 'description' => 'The information about the virtual MFA devices.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the virtual MFA device.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the virtual MFA device.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '36', - ], - 'EndUserId' => [ - 'description' => 'The username of the convenience account that uses the virtual MFA device.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Email' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'GmtEnabled' => [ - 'description' => 'The time when the virtual MFA device was enabled. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2021-06-22T06:20:49Z', - ], - 'GmtUnlock' => [ - 'description' => 'The time when the locked virtual MFA device was automatically unlocked. The time follows the ISO 8601 standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2021-06-23T06:20:49Z', - ], - 'ConsecutiveFails' => [ - 'description' => 'The number of consecutive failures to bind the virtual MFA device, or the number of authentication failures based on the virtual MFA device.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'SerialNumber' => [ - 'description' => 'The serial number of the virtual MFA device.'."\n", - 'type' => 'string', - 'example' => 'dc856334-446b-4035-bfbc-18af261e****', - ], - 'Status' => [ - 'description' => 'The status of the virtual MFA device.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* LOCKED'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* UNBOUND'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* NORMAL'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'LOCKED' => '', - 'UNBOUND' => '', - 'NORMAL' => '', - ], - 'example' => 'NORMAL', - ], - 'DeviceType' => [ - 'description' => 'The type of the virtual MFA device. The value can only be `TOTP_VIRTUAL`. This value indicates that the virtual MFA device follows the Time-based One-time Password (TOTP) algorithm.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'TOTP_VIRTUAL' => '', - ], - 'example' => 'TOTP_VIRTUAL', - ], - 'AdUser' => [ - 'type' => 'object', - 'properties' => [ - 'EndUser' => [ - 'type' => 'string', - ], - 'DisplayName' => [ - 'type' => 'string', - ], - 'DisplayNameNew' => [ - 'type' => 'string', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'UpdateResult' => [ + 'description' => 'The result of the modification.'."\n", + 'type' => 'object', + 'properties' => [ + 'PropertyId' => ['description' => 'The ID of the property.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '390', 'title' => ''], + 'PropertyKey' => ['description' => 'The name of the property.'."\n", 'type' => 'string', 'example' => 'testkey2', 'title' => ''], + 'SavePropertyValueModel' => [ + 'description' => 'The result of the property value modification.'."\n", + 'type' => 'object', + 'properties' => [ + 'SavePropertyValues' => [ + 'description' => 'The property values that were modified.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Modified property values that succeeded.', + 'type' => 'object', + 'properties' => [ + 'PropertyValueId' => ['description' => 'The ID of the property value.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '978', 'title' => ''], + 'PropertyValue' => ['description' => 'The value of the property.'."\n", 'type' => 'string', 'example' => 'testvalue2', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'UserPrincipalName' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', + ], + 'FailedPropertyValues' => [ + 'description' => 'The property values that failed to be modified.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The Attribute Values that failed to be modified. ', + 'type' => 'object', + 'properties' => [ + 'PropertyId' => ['description' => 'The ID of the property.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '390', 'title' => ''], + 'PropertyValue' => ['description' => 'The value of the property.'."\n", 'type' => 'string', 'example' => 'testvalue', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'ExistedPropertyValue', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The property value is used by another property.', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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":"<DescribeMfaDevicesResponse>\\n <NextToken>AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp</NextToken>\\n <RequestId>8C09C087-99C3-43F0-BFEA-03E651E04696</RequestId>\\n <MfaDevices>\\n <Status>NORMAL</Status>\\n <DeviceType>TOTP_VIRTUAL</DeviceType>\\n <GmtEnabled>2021-06-22T06:20:49Z</GmtEnabled>\\n <EndUserId>test</EndUserId>\\n <SerialNumber>dc856334-446b-4035-bfbc-18af261e****</SerialNumber>\\n <ConsecutiveFails>0</ConsecutiveFails>\\n <Id>36</Id>\\n </MfaDevices>\\n</DescribeMfaDevicesResponse>","errorExample":""}]', - 'title' => 'DescribeMfaDevices', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateResourceGroup' => [ - 'summary' => 'Creates a resource group.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Modify Custom Properties', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProperty'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:UpdateProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UserBatchJoinGroup' => [ + 'summary' => 'Add users to a group in batch.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5378,96 +5009,73 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ResourceGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'IsResourceGroupWithOfficeSite', - 'in' => 'query', - 'schema' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the user group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ug-12341234****', 'title' => ''], ], [ - 'name' => 'Platform', - 'in' => 'query', + 'name' => 'EndUserIds', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '> Set the value to AliyunConsole.'."\n" - ."\n" - .'* This parameter is not publicly available in other platforms.'."\n", - 'type' => 'string', + 'description' => 'The list of user IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the user.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alex****', 'title' => ''], 'required' => false, - 'enumValueTitles' => [ - 'AliyunConsole' => '无影云电脑企业版', - ], - 'example' => 'AliyunConsole', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'BusinessChannel', - 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'in' => 'formData', + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '868B8926-2E7A-5BE7-9897-E811E994****', - ], - 'ResourceGroupId' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => 'rg-ckf3cx7isinhk***', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7A2C3803-C975-5871-A232-80A91009****'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\",\\n \\"ResourceGroupId\\": \\"rg-ckf3cx7isinhk***\\"\\n}","type":"json"}]', - 'title' => 'CreateResourceGroup', - ], - 'DeleteResourceGroup' => [ - 'summary' => 'Deletes a resource group.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A2C3803-C975-5871-A232-80A91009****\\"\\n}","type":"json"}]', + 'title' => 'Add users to a group in batch', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:UserBatchJoinGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UserBatchQuitGroup' => [ + 'summary' => 'Remove users from a group in batch.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5475,621 +5083,1045 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '> The ID of the resource group that you want to delete.'."\n" - ."\n" - .'* If you also specify ResourceGroupIds, both parameters take effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aj01tck67a0szp***', - ], + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the user group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ug-lkuvalovhnlxvv****', 'title' => ''], ], [ - 'name' => 'ResourceGroupIds', - 'in' => 'query', - 'style' => 'flat', + 'name' => 'EndUserIds', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '> The IDs of the resource groups that you want to delete.'."\n" - ."\n" - .'* If you also specify ResourceGroupId, both parameters take effect.'."\n", + 'description' => 'The user IDs.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the resource group. You can call the [DescribeResourceGroups](~~2882825~~) operation to query IDs of resource groups.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-eoakjtfdxkk0l***', - ], + 'items' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alex***', 'title' => ''], 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'BusinessChannel', - 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', - ], + 'in' => 'formData', + 'schema' => ['description' => 'Channel', 'title' => 'Channel', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2463A343-BD32-5803-959E-9A8472A1***', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '890JNJNF-SADASSDFS-SDFSDF****'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"890JNJNF-SADASSDFS-SDFSDF****\\"\\n}","type":"json"}]', + 'title' => 'Batch Remove Users from Group', + 'changeSet' => [ + ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:UserBatchQuitGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2463A343-BD32-5803-959E-9A8472A1***\\"\\n}","type":"json"}]', - 'title' => 'DeleteResourceGroup', ], - 'DescribeResourceGroups' => [ - 'summary' => 'Queries resource groups.', - 'methods' => [ - 'get', - 'post', + ], + 'endpoints' => [ + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'eds-user.ap-southeast-1.aliyuncs.com', 'endpoint' => 'eds-user.ap-southeast-1.aliyuncs.com', 'vpc' => 'eds-user-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'eds-user.cn-shanghai.aliyuncs.com', 'endpoint' => 'eds-user.cn-shanghai.aliyuncs.com', 'vpc' => 'eds-user-vpc.cn-shanghai.aliyuncs.com'], + ], + 'errorCodes' => [], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeGroups'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeResourceGroups'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2025-12-29T02:53:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'BatchSetDesktopManager'], + ['description' => 'Request parameters changed', 'api' => 'ChangeUserPassword'], + ['description' => 'Request parameters changed', 'api' => 'CheckUsedProperty'], + ['description' => 'Request parameters changed', 'api' => 'CheckUsedPropertyValue'], + ['description' => 'Request parameters changed', 'api' => 'CreateGroup'], + ['description' => 'Request parameters changed', 'api' => 'CreateOrg'], + ['description' => 'Request parameters changed', 'api' => 'CreateProperty'], + ['description' => 'Request parameters changed', 'api' => 'CreateResourceGroup'], + ['description' => 'Request parameters changed', 'api' => 'CreateUsers'], + ['description' => 'Request parameters changed', 'api' => 'DeleteResourceGroup'], + ], + 'createdAt' => '2025-12-22T06:39:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateUsers'], + ['description' => 'Request parameters changed', 'api' => 'DescribeGroups'], + ['description' => 'Response parameters changed', 'api' => 'DescribeUsers'], + ['description' => 'Response parameters changed', 'api' => 'FilterUsers'], + ], + 'createdAt' => '2025-11-27T07:01:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeUsers'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'FilterUsers'], ], - 'security' => [ - [ - 'AK' => [], + 'createdAt' => '2025-10-20T04:16:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeUsers'], + ], + 'createdAt' => '2025-04-01T11:55:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'FilterUsers'], + ], + 'createdAt' => '2025-03-24T09:53:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeUsers'], + ], + 'createdAt' => '2025-02-27T12:03:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeUsers'], + ], + 'createdAt' => '2025-01-02T11:15:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'FilterUsers'], + ], + 'createdAt' => '2024-12-11T07:38:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateUsers'], + ], + 'createdAt' => '2024-12-03T11:44:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'LockUsers'], + ], + 'createdAt' => '2024-11-06T11:10:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeUsers'], + ], + 'createdAt' => '2024-09-24T06:17:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'FilterUsers'], + ], + 'createdAt' => '2024-08-15T11:59:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeUsers'], + ], + 'createdAt' => '2024-07-19T11:27:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateUsers'], + ['description' => 'Response parameters changed', 'api' => 'FilterUsers'], + ], + 'createdAt' => '2024-04-09T12:00:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeUsers'], + ], + 'createdAt' => '2024-01-24T10:01:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateUsers'], + ], + 'createdAt' => '2024-01-16T11:08:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'RemoveUsers'], + ], + 'createdAt' => '2023-12-18T11:15:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeUsers'], + ], + 'createdAt' => '2023-12-11T13:20:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'FilterUsers'], + ], + 'createdAt' => '2023-10-25T11:43:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeUsers'], + ], + 'createdAt' => '2023-09-23T23:11:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateUsers'], + ['description' => 'Request parameters changed', 'api' => 'UnlockUsers'], + ], + 'createdAt' => '2023-08-31T01:58:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeMfaDevices'], + ['description' => 'Request parameters changed', 'api' => 'LockMfaDevice'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'RemoveMfaDevice'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UnlockMfaDevice'], + ], + 'createdAt' => '2023-08-21T09:01:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeUsers'], + ], + 'createdAt' => '2023-08-06T01:48:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'RemoveMfaDevice'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UnlockMfaDevice'], + ], + 'createdAt' => '2023-01-06T06:24:30.000Z', + 'description' => '修改参数说明', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'FilterUsers'], + ], + 'createdAt' => '2022-12-05T05:03:01.000Z', + 'description' => '优化属性管理,新增批量操作接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CheckUsedProperty'], + ['description' => 'Request parameters changed', 'api' => 'CreateProperty'], + ['description' => 'Error codes changed', 'api' => 'CreateUsers'], + ['description' => 'Request parameters changed', 'api' => 'DeleteUserPropertyValue'], + ['description' => 'Request parameters changed', 'api' => 'RemoveUsers'], + ['description' => 'Request parameters changed', 'api' => 'SetUserPropertyValue'], + ], + 'createdAt' => '2022-11-02T06:24:51.000Z', + 'description' => '更新接口参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateUsers'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeUsers'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'FilterUsers'], + ['description' => 'Request parameters changed', 'api' => 'ResetUserPassword'], + ], + 'createdAt' => '2022-09-08T12:08:43.000Z', + 'description' => '目前不对外开放', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'LockMfaDevice'], + ], + 'createdAt' => '2022-06-08T12:36:16.000Z', + 'description' => '修改文档是否必填', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'RemoveProperty'], + ], + 'createdAt' => '2022-05-10T11:41:13.000Z', + 'description' => '修改下参数必填属性', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateUsers'], + ], + 'createdAt' => '2022-05-10T11:40:21.000Z', + 'description' => '修改password参数的最大长度', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'FilterUsers'], + ['description' => 'Response parameters changed', 'api' => 'QuerySyncStatusByAliUid'], + ], + 'createdAt' => '2022-04-29T08:00:10.000Z', + 'description' => '添加filterusers的入参类型。根据属性查询详情。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'FilterUsers'], + ], + 'createdAt' => '2022-03-23T09:19:05.000Z', + 'description' => '获取用户:FilterUsers,增加入参IncludeDesktopGroupCount,增加出参DesktopGroupCount', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ModifyUser'], + ], + 'createdAt' => '2022-03-22T09:03:07.000Z', + 'description' => '支持修改用户邮箱和手机号', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'FilterUsers'], + ['description' => 'OpenAPI offline', 'api' => 'QuerySyncStatusByAliUid'], + ['description' => 'OpenAPI offline', 'api' => 'SyncAllEduInfo'], + ], + 'createdAt' => '2022-03-14T10:04:42.000Z', + 'description' => '少年云二期增加同步接口。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeUsers'], + ], + 'createdAt' => '2022-01-13T07:51:34.000Z', + 'description' => '查询用户增加过滤条件', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeUsers'], + ], + 'createdAt' => '2021-08-13T04:08:16.000Z', + 'description' => 'DescribeUsers和ListUsers默认MaxResults调整为500', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CheckUsedProperty'], + ['description' => 'OpenAPI offline', 'api' => 'CheckUsedPropertyValue'], + ['description' => 'OpenAPI offline', 'api' => 'CreateProperty'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteUserPropertyValue'], + ['description' => 'OpenAPI offline', 'api' => 'FilterUsers'], + ['description' => 'OpenAPI offline', 'api' => 'ListProperty'], + ['description' => 'OpenAPI offline', 'api' => 'ListPropertyValue'], + ['description' => 'OpenAPI offline', 'api' => 'RemoveProperty'], + ['description' => 'OpenAPI offline', 'api' => 'SetUserPropertyValue'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateProperty'], + ], + 'createdAt' => '2021-08-10T06:35:45.000Z', + 'description' => '无影云桌面用户自定义属性api', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateUsers'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ImportUsers'], + ], + 'createdAt' => '2021-06-01T12:56:06.000Z', + 'description' => 'ImportUsers现在改成异步操作;CreateUsers对于创建失败的用户会返回其邮箱', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateUsers'], + ['description' => 'Request parameters changed', 'api' => 'CreateUsers'], + ['description' => 'Request parameters changed', 'api' => 'DescribeMfaDevices'], + ['description' => 'Request parameters changed', 'api' => 'DescribeMfaDevices'], + ['description' => 'Request parameters changed', 'api' => 'DescribeUsers'], + ['description' => 'Request parameters changed', 'api' => 'DescribeUsers'], + ['description' => 'Request parameters changed', 'api' => 'ImportUsers'], + ['description' => 'Request parameters changed', 'api' => 'ImportUsers'], + ], + 'createdAt' => '2021-04-25T07:57:07.000Z', + 'description' => '弹性云桌面便捷账号用户管理OpenAPI发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateUsers'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeUsers'], + ['description' => 'OpenAPI offline', 'api' => 'ImportUsers'], + ], + 'createdAt' => '2021-04-02T06:16:12.000Z', + 'description' => '添加遗漏的API, DescribeUsers, CreateUsers,ImportUsers', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProperty'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FilterUsers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProperty'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveOrg'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyOrg'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUser'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockUsers'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckUsedPropertyValue'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockUsers'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeUserPassword'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveMfaDevice'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUserPropertyValue'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOrgByLayer'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveProperty'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchSetDesktopManager'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsers'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncAllEduInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOrgs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPropertyValue'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckUsedProperty'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveUserOrg'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetUserPassword'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMfaDevices'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveOrg'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUsers'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockMfaDevice'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserPropertyValue'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProperty'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrg'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockMfaDevice'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUsers'], + ], + ], + 'ram' => [ + 'productCode' => 'ECD', + 'productName' => 'Elastic Desktop Service', + 'ramCodes' => ['ecd', 'eds-user', 'gws', 'wss'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'DeleteResourceGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeMfaDevices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeMfaDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeResourceGroups', + 'description' => '', 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'ecd:DescribeResourceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ResourceGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + [ + 'apiName' => 'ModifyGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ResourceGroupIds', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => 'The IDs of the resource groups that you want to query.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the resource group that you want to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-9th3k8twp3ox2***', - ], - 'required' => false, + ], + [ + 'apiName' => 'FilterUsers', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:FilterUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + ], + [ + 'apiName' => 'DescribeGroups', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DescribeGroupUser', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeGroupUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'NeedContainResourceGroupWithOfficeSite', - 'in' => 'query', - 'schema' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', + ], + [ + 'apiName' => 'UserBatchQuitGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:UserBatchQuitGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Platform', - 'in' => 'query', - 'schema' => [ - 'description' => '> Set the value to AliyunConsole.'."\n" - ."\n" - .'* This parameter is not publicly available on other platforms.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AliyunConsole', + ], + [ + 'apiName' => 'DescribeOrgByLayer', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeOrgByLayer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'BusinessChannel', - 'in' => 'query', - 'schema' => [ - 'title' => '渠道标记', - 'type' => 'string', - 'example' => 'ENTERPRISE', + ], + [ + 'apiName' => 'ListProperty', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:ListProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AliyunResourceGroupIds', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'title' => '云平台资源组ID。', - 'type' => 'array', - 'items' => [ - 'title' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-as8nlsbsxsldk***', - ], + ], + [ + 'apiName' => 'SetUserPropertyValue', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:SetUserPropertyValue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '68BA1DF7-8814-5AED-B844-F8F7F7****', - ], - 'ResourceGroup' => [ - 'description' => 'The resource groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource group.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-cyo0il2pzge1***', - ], - 'ResourceGroupName' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'ResourceCount' => [ - 'description' => 'The number of resources in the resource group.'."\n", - 'type' => 'string', - 'example' => '119', - ], - 'AuthCount' => [ - 'description' => 'The number of administrators that are authorized to access the resource group.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'CreateTime' => [ - 'description' => 'The time when the resource group was created.'."\n", - 'type' => 'string', - 'example' => '2022-11-29T17:25:40.000000000Z', - ], - 'Policies' => [ - 'description' => '> The policy that is associated with the resource group.'."\n" - ."\n" - .'* The policy applies to cloud computers in the resource group. If multiple policies exist, they are enforced in order of priority.'."\n" - ."\n" - .'* If any of these cloud computers are already associated with other policies, the resource group\'s policy takes precedence.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The policy ID.'."\n", - 'type' => 'string', - 'example' => 'pl-a8jnatl8kjasb***', - ], - 'Name' => [ - 'description' => 'The policy name.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'IsDefault' => [ - 'description' => 'Specifies whether to use the default policy.'."\n", - 'type' => 'boolean', - 'example' => 'False', - ], - ], - 'description' => '', - ], - ], - 'Timers' => [ - 'description' => '> The associated scheduled task.'."\n" - ."\n" - .'* The scheduled task applies to all cloud computers in the resource group. If any of these cloud computers are already associated with other scheduled tasks, the resource group\'s scheduled task takes precedence.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the scheduled task.'."\n", - 'type' => 'string', - 'example' => 't-asdzx0mbjhg***', - ], - 'Name' => [ - 'description' => 'The name of the scheduled task.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'TimerStatus' => [ - 'type' => 'string', - ], - 'BindStatus' => [ - 'type' => 'string', - ], - ], - 'description' => '', - ], - ], - 'AppRules' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'type' => 'string', - ], - 'Name' => [ - 'type' => 'string', - ], - 'Type' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], - 'AliyunResourceGroupId' => [ - 'title' => '阿里云资源组ID', - 'type' => 'string', - 'example' => 'rg-123456', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => 'The total number of resource groups.'."\n", - 'type' => 'string', - 'example' => '7', - ], - ], + [ + 'apiName' => 'RemoveOrg', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:RemoveOrg', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'BatchSetDesktopManager', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:BatchSetDesktopManager', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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' => 'DescribeResourceGroups', - ], - 'SyncAllEduInfo' => [ - 'summary' => 'Synchronizes all education information.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'RemoveUsers', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:RemoveUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreateGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CheckUsedPropertyValue', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:CheckUsedPropertyValue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'MoveOrg', + 'description' => '', 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:MoveOrg', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + [ + 'apiName' => 'UnlockUsers', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:UnlockUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => 'SyncAllEduInfo', - ], - 'QuerySyncStatusByAliUid' => [ - 'summary' => 'Queries user synchronization status.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'UnlockMfaDevice', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:UnlockMfaDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetManagerInfoByAuthCode', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:GetManagerInfoByAuthCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateOrg', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateOrg', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DeleteUserPropertyValue', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteUserPropertyValue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CheckUsedProperty', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'ecd:CheckUsedProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'BusinessChannel', - 'in' => 'query', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', + [ + 'apiName' => 'QuerySyncStatusByAliUid', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:QuerySyncStatusByAliUid', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'PlainResult<UserSyncHistoryDo>', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => 'auto-increased id', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '131239236086****', - ], - 'Status' => [ - 'title' => 'user sync status', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'CorpId' => [ - 'title' => 'corp id', - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + [ + 'apiName' => 'ResetUserPassword', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ResetUserPassword', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => 'QuerySyncStatusByAliUid', - ], - 'ChangeUserPassword' => [ - 'summary' => 'If the user is in administrator-activated mode, you can change the user logon password through this operation.', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'ChangeUserPassword', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ChangeUserPassword', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'RemoveGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:RemoveGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateProperty', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:UpdateProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'RemoveProperty', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:RemoveProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateProperty', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeUsers', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateResourceGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateUsers', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'LockUsers', + 'description' => '', 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'ecd:LockUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'EndUserId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'alice***', + [ + 'apiName' => 'ListPropertyValue', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:ListPropertyValue', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'NewPassword', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Admin@12***', + ], + [ + 'apiName' => 'RemoveMfaDevice', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:RemoveMfaDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'BusinessChannel', - 'in' => 'formData', - 'schema' => [ - 'title' => '渠道', - 'type' => 'string', - 'required' => false, - 'example' => 'ENTERPRISE', - 'default' => 'ENTERPRISE', + ], + [ + 'apiName' => 'DescribeUser', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****', - ], - ], + [ + 'apiName' => 'LockMfaDevice', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:LockMfaDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UserBatchJoinGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:UserBatchJoinGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'MoveUserOrg', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:MoveUserOrg', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyUser', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'InitTenantAlias', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:InitTenantAlias', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyOrg', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:ModifyOrg', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SyncAllEduInfo', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:SyncAllEduInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeOrgs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeOrgs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA8D67CB-345D-5CDA-986E-FFAC7D0****\\"\\n}","type":"json"}]', - 'title' => 'ChangeUserPassword', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'eds-user.cn-shanghai.aliyuncs.com', ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'eds-user.ap-southeast-1.aliyuncs.com', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'User', 'arn' => 'acs:ecd::{#accountId}:*'], ], ], ]; diff --git a/data/en_us/eds-user/2021-06-22/api-docs.php b/data/en_us/eds-user/2021-06-22/api-docs.php index cde0f75..31522b6 100644 --- a/data/en_us/eds-user/2021-06-22/api-docs.php +++ b/data/en_us/eds-user/2021-06-22/api-docs.php @@ -1,18 +1,12 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'eds-user', - 'version' => '2021-06-22', - ], + 'info' => ['style' => 'RPC', 'product' => 'eds-user', 'version' => '2021-06-22'], 'directories' => [ [ 'id' => 0, 'title' => '其它', 'type' => 'directory', - 'children' => [ - 'GetUserByToken', - ], + 'children' => ['GetUserByToken'], ], ], 'components' => [ @@ -21,35 +15,20 @@ 'apis' => [ 'GetUserByToken' => [ 'summary' => '根据登录token获取用户信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'Token', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'maximum' => '100', - 'minimum' => '1', - 'maxLength' => 9999999999999, - ], + 'schema' => ['type' => 'string', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'maxLength' => 9999999999999], ], ], 'responses' => [ @@ -58,35 +37,17 @@ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], + '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', - ], + 'Id' => ['type' => 'integer', 'format' => 'int64'], + 'Name' => ['type' => 'string'], + 'Email' => ['type' => 'string'], + 'TenantId' => ['type' => 'string'], + 'Type' => ['type' => 'string'], + 'OfficeSiteId' => ['type' => 'string'], + 'AdDomain' => ['type' => 'string'], ], ], ], @@ -101,13 +62,7 @@ ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'eds-user.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'eds-user.ap-southeast-1.aliyuncs.com', - ], + ['regionId' => 'cn-shanghai', 'endpoint' => 'eds-user.cn-shanghai.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'endpoint' => 'eds-user.ap-southeast-1.aliyuncs.com'], ], ]; |
