diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/eds-user/2021-03-08/api-docs.php | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/eds-user/2021-03-08/api-docs.php')
| -rw-r--r-- | data/en_us/eds-user/2021-03-08/api-docs.php | 6095 |
1 files changed, 6095 insertions, 0 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 new file mode 100644 index 0000000..d56dba7 --- /dev/null +++ b/data/en_us/eds-user/2021-03-08/api-docs.php @@ -0,0 +1,6095 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'eds-user', + 'version' => '2021-03-08', + ], + 'directories' => [ + [ + 'id' => 205232, + 'title' => 'Login', + 'type' => 'directory', + 'children' => [ + 'InitTenantAlias', + ], + ], + [ + 'id' => 165074, + 'title' => 'User', + 'type' => 'directory', + 'children' => [ + 'CreateUsers', + 'RemoveUsers', + 'ModifyUser', + 'ResetUserPassword', + 'LockUsers', + 'UnlockUsers', + 'DescribeUsers', + 'FilterUsers', + 'GetManagerInfoByAuthCode', + 'BatchSetDesktopManager', + ], + ], + [ + 'id' => 165068, + 'title' => 'User property', + 'type' => 'directory', + 'children' => [ + 'CreateProperty', + 'RemoveProperty', + 'DeleteUserPropertyValue', + 'UpdateProperty', + 'SetUserPropertyValue', + 'ListProperty', + 'ListPropertyValue', + 'CheckUsedProperty', + 'CheckUsedPropertyValue', + ], + ], + [ + 'id' => 188957, + 'title' => 'Organisation', + 'type' => 'directory', + 'children' => [ + 'CreateOrg', + 'DescribeOrgs', + 'DescribeOrgByLayer', + 'RemoveOrg', + 'MoveOrg', + 'ModifyOrg', + 'MoveUserOrg', + ], + ], + [ + 'id' => 222270, + 'title' => 'User Group', + 'type' => 'directory', + 'children' => [ + 'CreateGroup', + 'DescribeGroups', + 'UserBatchQuitGroup', + 'UserBatchJoinGroup', + 'RemoveGroup', + 'ModifyGroup', + 'DescribeGroupUser', + ], + ], + [ + 'id' => 165058, + 'title' => 'MFA', + 'type' => 'directory', + 'children' => [ + 'RemoveMfaDevice', + 'LockMfaDevice', + 'UnlockMfaDevice', + 'DescribeMfaDevices', + ], + ], + [ + 'id' => 205378, + 'title' => 'Resource Group', + 'type' => 'directory', + 'children' => [ + 'CreateResourceGroup', + 'DeleteResourceGroup', + 'DescribeResourceGroups', + ], + ], + [ + 'id' => 168203, + 'title' => 'Other', + 'type' => 'directory', + 'children' => [ + 'SyncAllEduInfo', + 'QuerySyncStatusByAliUid', + 'ChangeUserPassword', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'InitTenantAlias' => [ + 'summary' => 'Initializes an organization ID.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + '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****', + ], + 'Data' => [ + 'description' => 'The generated ID of the organization.'."\n", + 'type' => 'string', + 'example' => 'WY23***', + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '18911', + 'abilityTreeNodes' => [ + 'FEATUREgwsZABQI3', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Users', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the convenience user.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the convenience user.'."\n", + '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' => '[email protected]', + ], + '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', + ], + 'OwnerType' => [ + 'description' => 'The type of the account ownership.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* CreateFromManager: administrator-activated'."\n" + .'* Normal: user-activated', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CreateFromManager' => '', + 'Normal' => '', + ], + 'example' => 'Normal', + ], + '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', + ], + 'GroupIdList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 100, + ], + ], + 'required' => false, + ], + 'required' => true, + 'example' => 'CreateUsers', + 'maxItems' => 100, + ], + ], + [ + '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, + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'IsLocalAdmin', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'PasswordExpireDays', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The information that is returned.'."\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****', + ], + 'CreateResult' => [ + 'description' => 'The result of user creation.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreatedUsers' => [ + 'description' => 'Details of the created convenience users.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the created convenience user.'."\n", + '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' => '[email protected]', + ], + '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', + ], + ], + ], + ], + 'FailedUsers' => [ + 'description' => 'Details of the convenience users that failed to be created.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the convenience user that failed to be created.'."\n", + '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' => '[email protected]', + ], + '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.', + ], + ], + ], + ], + ], + ], + 'AllSucceed' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'INTERNAL_ERROR', + 'errorMessage' => 'Internal error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"CreateResult\\": {\\n \\"CreatedUsers\\": [\\n {\\n \\"EndUserId\\": \\"test1\\",\\n \\"Email\\": \\"[email protected]\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Remark\\": \\"remark1\\",\\n \\"RealNickName\\": \\"Bean\\"\\n }\\n ],\\n \\"FailedUsers\\": [\\n {\\n \\"EndUserId\\": \\"test2\\",\\n \\"Email\\": \\"[email protected]\\",\\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", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveUsers' => [ + 'summary' => 'Removes one or more convenience users.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Users', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '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', + ], + 'required' => true, + 'example' => 'test1', + 'maxItems' => 500, + 'minItems' => 1, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + '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.', + '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', + ], + ], + '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.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the user.', + 'type' => 'string', + 'required' => true, + 'example' => 'Alice', + ], + ], + [ + 'name' => 'Email', + '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' => '[email protected]', + ], + ], + [ + '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****', + ], + ], + [ + '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.', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Users', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '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' => 'test1', + ], + 'required' => true, + 'example' => 'test1', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'NotifyType', + 'in' => 'formData', + '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', + 'required' => false, + 'enumValueTitles' => [ + 1 => 'email', + 'text message', + 'both', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The information that is returned.', + '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.', + 'type' => 'string', + 'example' => 'test1', + ], + ], + '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' => 'test123', + ], + 'ErrorCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'InvalidUsername', + ], + 'ErrorMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'test123 is an invalid username.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"32D05B39-E6EE-4D7A-9FD0-762A26859D0D\\",\\n \\"ResetUsersResult\\": {\\n \\"ResetUsers\\": [\\n \\"test1\\"\\n ],\\n \\"FailedUsers\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"ErrorCode\\": \\"InvalidUsername\\",\\n \\"ErrorMessage\\": \\"test123 is an invalid username.\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ResetUserPasswordResponse>\\n <RequestId>32D05B39-E6EE-4D7A-9FD0-762A26859D0D</RequestId>\\n <ResetUsersResult>\\n <ResetUsers>test1</ResetUsers>\\n </ResetUsersResult>\\n</ResetUserPasswordResponse>","errorExample":""}]', + 'title' => 'ResetUserPassword', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'LockUsers' => [ + 'summary' => 'Locks one or more convenience users.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Users', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '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', + ], + 'required' => true, + 'example' => 'test1', + 'maxItems' => 500, + ], + ], + [ + 'name' => 'LogoutSession', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + '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.', + '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.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"LockUsersResult\\": {\\n \\"LockedUsers\\": [\\n \\"alice\\"\\n ],\\n \\"FailedUsers\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"ErrorCode\\": \\"InvalidUsername\\",\\n \\"ErrorMessage\\": \\"test123 is an invalid username.\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Users', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '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' => 'test1', + ], + 'required' => true, + 'example' => 'test1', + 'maxItems' => 500, + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The information that is returned.', + 'type' => 'object', + 'properties' => [ + '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' => 'test1', + ], + ], + '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' => 'test123', + ], + 'ErrorCode' => [ + 'description' => 'The error code.', + 'type' => 'string', + 'example' => 'InvalidUsername', + ], + 'ErrorMessage' => [ + 'description' => 'The error message.', + 'type' => 'string', + 'example' => 'test123 is an invalid username.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"023F4EC4-3602-4A3E-A514-4970847D59DB\\",\\n \\"UnlockUsersResult\\": {\\n \\"UnlockedUsers\\": [\\n \\"alice\\"\\n ],\\n \\"FailedUsers\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"ErrorCode\\": \\"InvalidUsername\\",\\n \\"ErrorMessage\\": \\"test123 is an invalid username.\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of entries per page.'."\n" + ."\n" + .'* Valid values: 1 to 500.'."\n" + .'* Default value: 500.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '500', + 'minimum' => '1', + 'enumValueTitles' => [], + 'example' => '10', + 'default' => '500', + ], + ], + [ + '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****', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'FilterMap', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + [ + 'name' => 'EndUserIds', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The usernames that must be exactly matched.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The username that must be exactly matched.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'alice', + ], + 'required' => false, + 'maxItems' => 500, + ], + ], + [ + 'name' => 'ExcludeEndUserIds', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The usernames that must be exactly excluded.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The username that must be exactly excluded.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tony', + ], + 'required' => false, + 'maxItems' => 500, + ], + ], + [ + '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****', + ], + ], + [ + '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****', + ], + ], + [ + 'name' => 'ShowExtras', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'ResourcesCount: true', + 'description' => '', + ], + ], + ], + [ + 'name' => 'FilterWithAssignedResources', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'boolean', + 'example' => 'DesktopGroup: true', + 'description' => '', + ], + ], + ], + [ + 'name' => 'IsQueryAllSubOrgs', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'FilterWithAssignedResource', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'App:aig-jfgmanbo****', + 'description' => '', + ], + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'title' => '状态', + 'description' => 'The status.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'ExcludeGroupId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + '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 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', + ], + 'Users' => [ + 'title' => 'users', + 'description' => 'The information about the convenience accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the convenience account.'."\n", + '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' => '[email protected]', + ], + '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****', + ], + '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", + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + 'The user status is normal.', + 9 => 'The user is locked.', + ], + 'example' => '0', + ], + '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" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* Normal'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' user-activated'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'CreateFromManager' => '', + 'Normal' => '', + ], + 'example' => 'Normal', + ], + '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', + ], + 'Groups' => [ + 'description' => 'The user groups to which the convenience user belongs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + '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", + ], + ], + ], + ], + 'Orgs' => [ + 'description' => 'The organizations to which the convenience user belongs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + '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', + ], + ], + ], + ], + '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', + 'example' => '', + ], + 'JobNumber' => [ + 'description' => 'The employee number of the convenience user.'."\n", + 'type' => 'string', + 'example' => 'A10000**', + ], + 'Extras' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AssignedResourceCount' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => 'Desktop: 3', + 'description' => '', + ], + ], + ], + ], + 'ExternalName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Properties' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Role', + ], + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Student', + ], + ], + ], + ], + 'EnableAdminAccess' => [ + 'title' => '启用管理员访问权限', + 'description' => 'Enables the administrator permissions.'."\n", + 'type' => 'boolean', + ], + 'PasswordExpireDays' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PasswordExpireRestDays' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Users\\": [\\n {\\n \\"Id\\": 0,\\n \\"EndUserId\\": \\"alice\\",\\n \\"Email\\": \\"[email protected]\\",\\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', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'FilterUsers' => [ + 'summary' => 'Filters convenience accounts by property.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '36913', + 'abilityTreeNodes' => [ + 'FEATUREgwsZABQI3', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'PropertyFilterParam', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of properties for fuzzy search.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The custom parameter that is configured by the user.'."\n", + '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, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PropertyKeyValueFilterParam', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of property names and property values.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the property and property value.'."\n", + '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, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + '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", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + [ + '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", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'OrgId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the organization.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'org-aliyun-wy-org-id', + ], + ], + [ + '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", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CreateFromManager' => '', + 'Normal' => '', + ], + 'example' => 'Normal', + ], + ], + [ + 'name' => 'IncludeEndUserIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 500, + ], + ], + [ + 'name' => 'ExcludeEndUserIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of usernames to be precisely excluded.'."\n", + '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', + ], + 'required' => false, + 'maxItems' => 2000, + ], + ], + [ + 'name' => 'OrderParam', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The parameter that might affect the sorting logic.'."\n", + '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", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'EndUserId' => '', + 'id' => 'id', + 'gmt_created' => '', + ], + 'example' => 'id', + ], + 'OrderType' => [ + 'description' => 'The direction of the sort.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ASC: the ascending order.'."\n" + .'* DESC (default): the descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ASC' => '', + 'DESC' => '', + ], + 'example' => 'ASC', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '状态', + 'description' => 'The status.'."\n", + 'type' => 'integer', + 'format' => 'int32', + '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, + ], + ], + [ + 'name' => 'IncludeOrgInfo', + 'in' => 'query', + 'schema' => [ + 'title' => '是否包含组织信息', + 'description' => 'Specifies whether to return the organization information.'."\n", + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'IncludeSupportIdps', + 'in' => 'query', + 'schema' => [ + 'title' => '包含支持的登录类型', + 'description' => 'Specifies whether to return the supported logon types.'."\n", + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + [ + 'name' => 'FilterMap', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + ], + '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' => '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', + ], + 'Users' => [ + 'title' => 'users', + 'description' => 'The information about the convenience accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the convenience account.'."\n", + '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' => '[email protected]', + ], + 'Phone' => [ + 'description' => 'The mobile number of the convenience user.'."\n", + 'type' => 'string', + 'example' => '1381111****', + ], + '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", + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + '', + 9 => '', + 11 => '', + ], + 'example' => '0', + ], + 'UserSetPropertiesModels' => [ + 'description' => 'The information about the properties.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the user property.'."\n", + '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', + ], + 'PropertyValues' => [ + 'description' => 'The property values.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the property value.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + 'DesktopCount' => [ + 'description' => 'The number of cloud desktops that are assigned to the convenience user.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExternalInfo' => [ + 'description' => 'The additional information about the convenience user.'."\n", + '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', + ], + ], + ], + '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', + ], + 'OwnerType' => [ + 'description' => 'The type of the account ownership.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* CreateFromManager: administrator-activated'."\n" + .'* Normal: user-activated', + 'type' => 'string', + 'enumValueTitles' => [ + 'CreateFromManager' => '', + 'Normal' => '', + ], + 'example' => 'Normal', + ], + 'Remark' => [ + 'description' => 'The remarks on the convenience user.'."\n", + 'type' => 'string', + 'example' => '1', + ], + '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", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + '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", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + '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', + ], + 'OrgList' => [ + 'title' => '用户所属组织列表', + 'description' => 'The organizations to which the user belongs.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '用户所属组织列表', + 'description' => 'The organizations to which the user belongs.'."\n", + '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', + ], + ], + ], + ], + 'SupportLoginIdps' => [ + 'title' => '支持的登录身份源方式', + 'description' => 'The supported identity provider logon methods.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '支持的登录身份源方式', + 'description' => 'The supported identity provider logon method.'."\n", + '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', + ], + ], + ], + ], + 'Groups' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GroupId' => [ + 'type' => 'string', + ], + 'GroupName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"Users\\": [\\n {\\n \\"Id\\": 0,\\n \\"EndUserId\\": \\"alice\\",\\n \\"Email\\": \\"[email protected]\\",\\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>[email protected]</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', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetManagerInfoByAuthCode' => [ + 'summary' => 'Obtains the information about the current logon administrator based on the authorization code.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AuthCode', + 'in' => 'query', + 'schema' => [ + 'title' => '授权码', + 'description' => 'The authorization code.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'e49cd070452f0044813a467d4743****', + ], + ], + ], + '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****', + ], + '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', + ], + ], + ], + ], + [], + ], + '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', + ], + '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', + ], + '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', + ], + ], + ], + '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****', + ], + ], + ], + ], + ], + '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', + ], + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + '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.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + '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', + ], + ], + [ + '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' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + ], + ], + ], + ], + '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', + ], + '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', + ], + ], + [ + '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 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' => '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' => 'D6C62E40-F937-5803-B008-92E813399BA5', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + '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', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The new property name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testkey', + ], + ], + [ + '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' => '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' => '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', + ], + 'PropertyKey' => [ + 'description' => 'The name of the property.'."\n", + 'type' => 'string', + 'example' => 'testkey2', + ], + '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.', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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', + ], + ], + [ + '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****', + ], + ], + ], + ], + ], + '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', + ], + 'ListProperty' => [ + 'summary' => 'Queries all user properties within an Alibaba Cloud account.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + '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' => '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' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + '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', + ], + ], + [ + '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', + ], + ], + [ + '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 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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147035', + 'abilityTreeNodes' => [ + 'FEATUREgwsJIXGV5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'OrgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the organization.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'ParentOrgId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the parent organization.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'org-evk12ozjvmlxl****', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + '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' => '7A2C3803-C975-5871-A232-80A91009****', + ], + 'OrgId' => [ + 'description' => 'The organization ID.'."\n", + 'type' => 'string', + 'example' => 'org-evk12ozjvmlxl****', + ], + ], + ], + ], + ], + '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', + ], + '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.\\'."\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' => 'ShowExtras', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + ], + ], + ], + [ + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ParentOrgId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the parent organization.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'org-11fs****', + ], + ], + [ + 'name' => 'OrgName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the organization.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + '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****', + ], + '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****', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'OrgId', + 'in' => 'formData', + 'schema' => [ + 'description' => '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', + ], + ], + ], + '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' => '6C352609-EE7F-5603-B5E6-57C3EDDD****', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + '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' => 'NewParentOrgId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the parent organization.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'org-5yy5icj981xe5****'."\n", + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + '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****', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147038', + 'abilityTreeNodes' => [ + 'FEATUREgwsJIXGV5', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'OrgName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the organization.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'OrgId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the organization.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'org-76joc57khvnhdh***', + ], + ], + [ + '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' => '0296EDF8-3C8A-5128-8682-27B29C99****', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + '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, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'MoveUserOrg', + ], + 'CreateGroup' => [ + 'summary' => 'Creates a user 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' => '', + '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' => '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' => '', + 'type' => 'string', + 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****', + ], + 'GroupId' => [ + 'description' => 'The ID of the user group.'."\n", + 'type' => 'string', + 'example' => 'ug-12341234****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + '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****', + ], + ], + [ + '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', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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' => [ + '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', + ], + ], + ], + ], + ], + 'Count' => [ + 'description' => 'The number of the entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Groups\\": [\\n {\\n \\"GroupName\\": \\"TestGroup\\",\\n \\"GroupId\\": \\"ug-2412ojkwtybd****\\",\\n \\"Description\\": \\"A test group.\\",\\n \\"CreateTime\\": \\"2025-08-07T13:40:40+08:00\\",\\n \\"UserCount\\": 20,\\n \\"TransferFileNeedApproval\\": false,\\n \\"AttachedLoginPolicy\\": {\\n \\"PolicyId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"AuthedResources\\": {\\n \\"key\\": \\"DesktopGroup\\"\\n }\\n }\\n ],\\n \\"Count\\": 1\\n}","type":"json"}]', + 'title' => 'DescribeGroups', + ], + 'UserBatchQuitGroup' => [ + 'summary' => 'Removes multiple users from a user group at a time.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the user group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ug-lkuvalovhnlxvv****', + ], + ], + [ + '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' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '890JNJNF-SADASSDFS-SDFSDF****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the user group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ug-12341234****', + ], + ], + [ + 'name' => 'EndUserIds', + '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, + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + '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' => '7A2C3803-C975-5871-A232-80A91009****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '42FE70D8-4336-471B-8314-CCCFCE41****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42FE70D8-4336-471B-8314-CCCFCE41****\\"\\n}","type":"json"}]', + 'title' => 'RemoveGroup', + ], + 'ModifyGroup' => [ + 'summary' => 'Modifies the name and description of a user group.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the user group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ug-12341234****', + ], + ], + [ + 'name' => 'NewGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the new user group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new description of the user group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestGroup', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + '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****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\"\\n}","type":"json"}]', + 'title' => 'ModifyGroup', + ], + 'DescribeGroupUser' => [ + 'summary' => 'Queries the members of a user group.', + '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****', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '> This parameter is not available for public use.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + ], + ], + [ + 'name' => 'SolutionId', + 'in' => 'query', + 'schema' => [ + 'description' => '> This parameter is not available for public use.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'co-0esnf80jab***', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + '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****', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + '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****', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + '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****', + ], + ], + [ + 'name' => 'AdDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The address of the AD office network.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'alpha.lftltd.net', + ], + ], + [ + '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' => 'FB550AAB-FB36-4A91-93F6-F4374AF65403', + ], + ], + ], + ], + ], + '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", + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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****', + ], + ], + [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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, + 'example' => 'dc856334-446b-4035-bfbc-18af261e****', + ], + ], + [ + 'name' => 'AdDomain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain of the Active Directory (AD) workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'welab.co.id', + ], + ], + [ + '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' => '9BD39C60-4E38-43BE-BA2F-69136C6C5190', + ], + ], + ], + ], + ], + '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', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeMfaDevices' => [ + 'summary' => 'Queries the information about virtual multi-factor authentication (MFA) devices that are bound to convenience accounts.', + '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 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' => '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' => 'SerialNumbers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The serial numbers of the virtual MFA devices.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The serial number of the virtual MFA device.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c2d9ae94-a64b-4a0d-8024-9519ca50****', + ], + 'required' => false, + 'example' => 'c2d9ae94-a64b-4a0d-8024-9519ca50****', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AdDomain', + 'in' => 'query', + 'schema' => [ + 'description' => '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, + ], + ], + [ + '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' => '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' => '[email protected]', + ], + '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', + ], + 'UserPrincipalName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"33DBB8EC-6E68-4726-91C4-E09C59D9A7D8\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp\\",\\n \\"MfaDevices\\": [\\n {\\n \\"Id\\": 36,\\n \\"EndUserId\\": \\"alice\\",\\n \\"Email\\": \\"[email protected]\\",\\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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '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' => 'Platform', + 'in' => 'query', + 'schema' => [ + 'description' => '> Set the value to AliyunConsole.'."\n" + ."\n" + .'* This parameter is not publicly available in other platforms.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AliyunConsole' => '无影云电脑企业版', + ], + 'example' => 'AliyunConsole', + ], + ], + [ + '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' => '868B8926-2E7A-5BE7-9897-E811E994****', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-ckf3cx7isinhk***', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + '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' => 'ResourceGroupIds', + 'in' => 'query', + 'style' => 'flat', + '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", + '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***', + ], + 'required' => false, + ], + ], + [ + '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' => '2463A343-BD32-5803-959E-9A8472A1***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2463A343-BD32-5803-959E-9A8472A1***\\"\\n}","type":"json"}]', + 'title' => 'DeleteResourceGroup', + ], + 'DescribeResourceGroups' => [ + 'summary' => 'Queries resource groups.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + '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, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'NeedContainResourceGroupWithOfficeSite', + 'in' => 'query', + 'schema' => [ + 'description' => '> This parameter is not publicly available.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道标记', + 'type' => 'string', + 'example' => 'ENTERPRISE', + ], + ], + [ + 'name' => 'AliyunResourceGroupIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'title' => '云平台资源组ID。', + 'type' => 'array', + 'items' => [ + 'title' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-as8nlsbsxsldk***', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68BA1DF7-8814-5AED-B844-F8F7F7****\\",\\n \\"ResourceGroup\\": [\\n {\\n \\"ResourceGroupId\\": \\"rg-cyo0il2pzge1***\\",\\n \\"ResourceGroupName\\": \\"测试资源组\\",\\n \\"ResourceCount\\": \\"119\\",\\n \\"AuthCount\\": \\"3\\",\\n \\"CreateTime\\": \\"2022-11-29T17:25:40.000000000Z\\",\\n \\"Policies\\": [\\n {\\n \\"Id\\": \\"pl-a8jnatl8kjasb***\\",\\n \\"Name\\": \\"测试策略123\\",\\n \\"IsDefault\\": true\\n }\\n ],\\n \\"Timers\\": [\\n {\\n \\"Id\\": \\"t-asdzx0mbjhg***\\",\\n \\"Name\\": \\"测试任务123\\",\\n \\"TimerStatus\\": \\"\\",\\n \\"BindStatus\\": \\"\\"\\n }\\n ],\\n \\"AppRules\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": 0\\n }\\n ],\\n \\"AliyunResourceGroupId\\": \\"rg-123456\\"\\n }\\n ],\\n \\"TotalCount\\": \\"7\\"\\n}","type":"json"}]', + 'title' => 'DescribeResourceGroups', + ], + 'SyncAllEduInfo' => [ + 'summary' => 'Synchronizes all education information.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'SyncAllEduInfo', + ], + 'QuerySyncStatusByAliUid' => [ + 'summary' => 'Queries user synchronization status.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道', + 'type' => 'string', + 'required' => false, + 'example' => 'ENTERPRISE', + 'default' => 'ENTERPRISE', + ], + ], + ], + '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****', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'EndUserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'alice***', + ], + ], + [ + 'name' => 'NewPassword', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Admin@12***', + ], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '渠道', + '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' => '', + 'type' => 'string', + 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****', + ], + ], + ], + ], + ], + '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', + ], + ], +]; |