summaryrefslogtreecommitdiff
path: root/data/zh_cn/eds-user/2021-03-08
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/eds-user/2021-03-08
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/eds-user/2021-03-08')
-rw-r--r--data/zh_cn/eds-user/2021-03-08/api-docs.php8198
1 files changed, 3889 insertions, 4309 deletions
diff --git a/data/zh_cn/eds-user/2021-03-08/api-docs.php b/data/zh_cn/eds-user/2021-03-08/api-docs.php
index 2bfe86f..5f2c4e0 100644
--- a/data/zh_cn/eds-user/2021-03-08/api-docs.php
+++ b/data/zh_cn/eds-user/2021-03-08/api-docs.php
@@ -1,330 +1,524 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'eds-user',
- 'version' => '2021-03-08',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'eds-user', 'version' => '2021-03-08'],
'directories' => [
[
- 'id' => 205232,
- 'title' => '登录',
+ 'children' => ['InitTenantAlias'],
'type' => 'directory',
- 'children' => [
- 'InitTenantAlias',
- ],
+ 'title' => '登录',
+ 'id' => 435334,
],
[
- 'id' => 165074,
- 'title' => '用户',
+ 'children' => ['CreateUsers', 'RemoveUsers', 'ModifyUser', 'ResetUserPassword', 'LockUsers', 'UnlockUsers', 'DescribeUsers', 'FilterUsers', 'DescribeUser', 'GetManagerInfoByAuthCode', 'BatchSetDesktopManager'],
'type' => 'directory',
- 'children' => [
- 'CreateUsers',
- 'RemoveUsers',
- 'ModifyUser',
- 'ResetUserPassword',
- 'LockUsers',
- 'UnlockUsers',
- 'DescribeUsers',
- 'FilterUsers',
- 'GetManagerInfoByAuthCode',
- 'BatchSetDesktopManager',
- ],
+ 'title' => '用户',
+ 'id' => 435335,
],
[
- 'id' => 165068,
- 'title' => '用户属性',
+ 'children' => ['CreateProperty', 'RemoveProperty', 'DeleteUserPropertyValue', 'UpdateProperty', 'SetUserPropertyValue', 'ListProperty', 'ListPropertyValue', 'CheckUsedProperty', 'CheckUsedPropertyValue'],
'type' => 'directory',
- 'children' => [
- 'CreateProperty',
- 'RemoveProperty',
- 'DeleteUserPropertyValue',
- 'UpdateProperty',
- 'SetUserPropertyValue',
- 'ListProperty',
- 'ListPropertyValue',
- 'CheckUsedProperty',
- 'CheckUsedPropertyValue',
- ],
+ 'title' => '用户属性',
+ 'id' => 435339,
],
[
- 'id' => 188957,
- 'title' => '组织',
+ 'children' => ['CreateOrg', 'DescribeOrgs', 'DescribeOrgByLayer', 'RemoveOrg', 'MoveOrg', 'ModifyOrg', 'MoveUserOrg'],
'type' => 'directory',
- 'children' => [
- 'CreateOrg',
- 'DescribeOrgs',
- 'DescribeOrgByLayer',
- 'RemoveOrg',
- 'MoveOrg',
- 'ModifyOrg',
- 'MoveUserOrg',
- ],
+ 'title' => '组织',
+ 'id' => 435340,
],
[
- 'id' => 222270,
- 'title' => '用户组',
+ 'children' => ['DescribeGroups', 'UserBatchQuitGroup', 'UserBatchJoinGroup', 'RemoveGroup', 'ModifyGroup', 'DescribeGroupUser'],
'type' => 'directory',
- 'children' => [
- 'CreateGroup',
- 'DescribeGroups',
- 'UserBatchQuitGroup',
- 'UserBatchJoinGroup',
- 'RemoveGroup',
- 'ModifyGroup',
- 'DescribeGroupUser',
- ],
+ 'title' => '用户组',
+ 'id' => 435341,
],
[
- 'id' => 165058,
- 'title' => 'MFA设备',
+ 'children' => ['RemoveMfaDevice', 'LockMfaDevice', 'UnlockMfaDevice', 'DescribeMfaDevices'],
'type' => 'directory',
- 'children' => [
- 'RemoveMfaDevice',
- 'LockMfaDevice',
- 'UnlockMfaDevice',
- 'DescribeMfaDevices',
- ],
+ 'title' => 'MFA设备',
+ 'id' => 435343,
],
[
- 'id' => 205378,
- 'title' => '资源组',
+ 'children' => ['CreateResourceGroup', 'DeleteResourceGroup', 'DescribeResourceGroups'],
'type' => 'directory',
- 'children' => [
- 'CreateResourceGroup',
- 'DeleteResourceGroup',
- 'DescribeResourceGroups',
- ],
+ 'title' => '资源组',
+ 'id' => 435344,
],
[
- 'id' => 168203,
- 'title' => '其他',
+ 'children' => ['SyncAllEduInfo', 'QuerySyncStatusByAliUid', 'ChangeUserPassword', 'CreateGroup', 'TransferResourcesIntoGroup', 'TransferResourcesOutofGroup'],
'type' => 'directory',
- 'children' => [
- 'SyncAllEduInfo',
- 'QuerySyncStatusByAliUid',
- 'ChangeUserPassword',
- ],
+ 'title' => '其他',
+ 'id' => 435345,
],
],
'components' => [
- 'schemas' => [
- 'GroupResources' => [
- 'title' => 'A short description of struct',
- 'description' => '资源组中的资源元数据',
- 'type' => 'object',
- 'properties' => [
- 'Region' => [
- 'title' => 'Region',
- 'type' => 'string',
- ],
- 'ResourceType' => [
- 'title' => 'ResourceType',
- 'type' => 'string',
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'BatchSetDesktopManager' => [
+ 'summary' => '为便捷账号添加或者去除云电脑的本地管理员权限。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
+ [
+ 'name' => 'Users',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '便捷账号列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '便捷账号。', 'type' => 'string', 'required' => true, 'example' => 'alice'],
+ 'required' => true,
+ 'maxItems' => 500,
],
- 'ResourceId' => [
- 'title' => 'ResourceId',
+ ],
+ [
+ 'name' => 'IsDesktopManager',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '该便捷账号是否具备云电脑的本地管理员权限。',
'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['否', '是 [默认值]'],
+ 'example' => '1',
],
],
+ [
+ 'name' => 'BusinessChannel',
+ 'in' => 'formData',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
+ ],
],
- 'ThirdApp' => [
- 'title' => 'A short description of struct',
- 'description' => '三方应用',
- 'type' => 'object',
- 'properties' => [
- 'AppKey' => [
- 'title' => '应用id',
- 'type' => 'string',
- ],
- 'Name' => [
- 'title' => '应用名称',
- 'type' => 'string',
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '868B8926-2E7A-5BE7-9897-E811E994****'],
+ ],
],
- 'Secrets' => [
- 'title' => '密钥',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Enable' => [
- 'title' => '是否启用',
- 'type' => 'boolean',
- ],
- 'Secret' => [
- 'title' => '密文',
- 'type' => 'string',
- ],
- ],
+ ],
+ ],
+ 'title' => '为便捷账号添加或去除本地管理员权限',
+ 'description' => '获得本地管理员权限的便捷账号可以在云电脑中自行安装软件，或者修改某些系统设置。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-08-04T15:17:46.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchSetDesktopManager'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:BatchSetDesktopManager',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- 'OidcSsoConfig' => [
- 'title' => 'oidc配置',
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\"\\n}","type":"json"}]',
+ ],
+ 'ChangeUserPassword' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '要修改密码的便捷账号的用户名。', 'type' => 'string', 'required' => false, 'example' => 'alice***'],
+ ],
+ [
+ 'name' => 'NewPassword',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用户的新密码。', 'type' => 'string', 'required' => false, 'example' => 'Admin@12***'],
+ ],
+ [
+ 'name' => 'BusinessChannel',
+ 'in' => 'formData',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'EnableAuthLogin' => [
- 'title' => '是否开启授权登录',
- 'type' => 'boolean',
- ],
- 'AccessTokenEffectiveTime' => [
- 'title' => '1',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'IdTokenEffectiveTime' => [
- 'title' => '1',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'RefreshTokenEffective' => [
- 'title' => '1',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'CodeEffectiveTime' => [
- 'title' => '1',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'IdTokenAlgorithmType' => [
- 'title' => '签名类型',
- 'type' => 'string',
- ],
- 'RedirectUris' => [
- 'title' => 'uri白名单',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'GrantTypes' => [
- 'title' => '类型',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'GrantScopes' => [
- 'title' => '授权',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'Endpoints' => [
- 'title' => '域名',
- 'type' => 'object',
- 'properties' => [
- 'Issuer' => [
- 'title' => 'Issuer',
- 'type' => 'string',
- ],
- 'DiscoveryEndpoint' => [
- 'title' => '发现端点',
- 'type' => 'string',
- ],
- 'AuthorizationEndpoint' => [
- 'title' => '授权端点',
- 'type' => 'string',
- ],
- 'GuestAuthorizationEndpoint' => [
- 'title' => 'guest授权端点',
- 'type' => 'string',
- ],
- 'TokenEndpoint' => [
- 'title' => 'token端点',
- 'type' => 'string',
- ],
- 'UserinfoEndpoint' => [
- 'title' => '用户信息端点',
- 'type' => 'string',
- ],
- 'JwksEndpoint' => [
- 'title' => '签名公钥端点',
- 'type' => 'string',
- ],
- 'RevokeEndpoint' => [
- 'title' => '销毁端点',
- 'type' => 'string',
- ],
- 'LogoutEndpoint' => [
- 'title' => '退登端点',
- 'type' => 'string',
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****'],
],
],
],
],
- 'WaIdPermissions' => [
- 'title' => 'permission',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => 'name',
- 'type' => 'string',
+ 'title' => '修改用户密码',
+ 'summary' => '当用户为管理员激活模式时，可以通过该接口修改用户登录密码。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeUserPassword'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:ChangeUserPassword',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
- 'Type' => [
- 'title' => 'type',
- 'type' => 'string',
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA8D67CB-345D-5CDA-986E-FFAC7D0****\\"\\n}","type":"json"}]',
+ ],
+ 'CheckUsedProperty' => [
+ 'summary' => '查询关联了指定自定义属性的便捷账号的数量。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'PropertyId',
+ 'in' => 'query',
+ 'schema' => ['description' => '属性ID。您可以调用[ListProperty](~~ListProperty~~)进行查询。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '390'],
+ ],
+ [
+ 'name' => 'BusinessChannel',
+ 'in' => 'query',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '22C97624-2405-54AC-BD44-A63FBE97****'],
+ 'UseCount' => ['description' => '已关联指定自定义属性的便捷账号的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ ],
],
- 'Code' => [
- 'title' => 'code',
- 'type' => 'string',
+ ],
+ ],
+ 'title' => '查询关联指定属性的用户数',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-11-02T06:24:28.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckUsedProperty'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:CheckUsedProperty',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
- 'SubPermissions' => [
- 'title' => 'subPermissions',
- 'type' => 'array',
- 'items' => [
- '$ref' => '#/components/schemas/WaIdPermissions',
+ ],
+ ],
+ '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":""}]',
+ ],
+ 'CheckUsedPropertyValue' => [
+ 'summary' => '查询关联了指定自定义属性值的便捷账号的数量。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'PropertyId',
+ 'in' => 'query',
+ 'schema' => ['description' => '属性ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '380'],
+ ],
+ [
+ 'name' => 'PropertyValueId',
+ 'in' => 'query',
+ 'schema' => ['description' => '属性值ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '978'],
+ ],
+ [
+ 'name' => 'BusinessChannel',
+ 'in' => 'query',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'UseCount' => ['description' => '已关联指定自定义属性值的便捷账号的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
- 'IsBasicChild' => [
- 'title' => 'basic',
- 'type' => 'boolean',
+ ],
+ ],
+ 'title' => '查询关联指定属性值的用户数',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckUsedPropertyValue'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:CheckUsedPropertyValue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
+ '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":""}]',
],
- ],
- 'apis' => [
- 'InitTenantAlias' => [
- 'summary' => '初始化组织ID。',
- 'methods' => [
- 'get',
- 'post',
+ 'CreateGroup' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
+ [
+ 'name' => 'GroupName',
+ 'in' => 'query',
+ 'schema' => ['description' => '用户组名称。', 'type' => 'string', 'required' => false, 'example' => '开发组'],
+ ],
+ [
+ 'name' => 'ParentGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '> 该参数暂不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'root'],
+ ],
+ [
+ 'name' => 'BizType',
+ 'in' => 'query',
+ 'schema' => ['description' => '> 该参数暂不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE'],
+ ],
+ [
+ 'name' => 'SolutionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '> 该参数暂不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'co-0esnf80jab***'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '用户组的描述。', 'type' => 'string', 'required' => false, 'example' => 'TestGroup'],
+ ],
+ [
+ 'name' => 'BusinessChannel',
+ 'in' => 'query',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回数据结构。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****'],
+ 'GroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => 'ug-eld7uv7vtgqsz****'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建用户组',
+ 'summary' => '创建用户组。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-30T14:09:42.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ecd:CreateGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA8D67CB-345D-5CDA-986E-FFAC7D0****\\",\\n \\"GroupId\\": \\"ug-eld7uv7vtgqsz****\\"\\n}","type":"json"}]',
+ ],
+ 'CreateOrg' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '147035',
+ 'abilityTreeNodes' => ['FEATUREgwsJIXGV5'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
+ 'name' => 'OrgName',
+ 'in' => 'query',
+ 'schema' => ['description' => '组织名称。', 'type' => 'string', 'required' => true, 'example' => '设计部门'],
+ ],
+ [
+ 'name' => 'ParentOrgId',
+ 'in' => 'query',
+ 'schema' => ['description' => '上级组织ID。', 'type' => 'string', 'required' => true, 'example' => 'org-evk12ozjvmlxl****'],
+ ],
+ [
'name' => 'BusinessChannel',
'in' => 'query',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7A2C3803-C975-5871-A232-80A91009****'],
+ 'OrgId' => ['description' => '组织ID。', 'type' => 'string', 'example' => 'org-evk12ozjvmlxl****'],
+ ],
+ ],
+ ],
+ ],
+ 'title' => '创建组织',
+ 'summary' => '创建组织。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrg'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ecd:CreateOrg',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A2C3803-C975-5871-A232-80A91009****\\",\\n \\"OrgId\\": \\"org-evk12ozjvmlxl****\\"\\n}","type":"json"}]',
+ ],
+ 'CreateProperty' => [
+ 'summary' => '创建一个用户属性。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
+ [
+ 'name' => 'PropertyKey',
+ 'in' => 'formData',
+ 'schema' => ['description' => '属性名。', 'type' => 'string', 'required' => true, 'example' => 'department'],
+ ],
+ [
+ 'name' => 'PropertyValues',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '属性值。一个属性下最多可以添加50个不同的属性值。',
+ 'type' => 'array',
+ 'items' => ['description' => '属性值。', 'type' => 'string', 'required' => false, 'example' => 'HR'],
'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
+ 'maxItems' => 100,
],
],
+ [
+ 'name' => 'BusinessChannel',
+ 'in' => 'formData',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
+ ],
],
'responses' => [
200 => [
@@ -333,44 +527,44 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'Data' => [
- 'description' => '生成的组织ID。',
- 'type' => 'string',
- 'example' => 'WY23***',
- ],
- 'AliasInfo' => [
- 'description' => '返回数据。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'CreateResult' => [
+ 'description' => '创建结果。',
'type' => 'object',
'properties' => [
- 'AliasSourceType' => [
- 'description' => '组织ID来源。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'Generated' => '自动生成',
- 'Customized' => '用户自定义',
+ 'PropertyId' => ['description' => '属性ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '390'],
+ 'PropertyKey' => ['description' => '属性名。', 'type' => 'string', 'example' => 'department'],
+ 'SavePropertyValueModel' => [
+ 'description' => '属性值创建结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'SavePropertyValues' => [
+ 'description' => '创建成功的属性值。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '创建成功的属性值。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PropertyValueId' => ['description' => '属性值ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '978'],
+ 'PropertyValue' => ['description' => '属性值。', 'type' => 'string', 'example' => 'HR'],
+ ],
+ ],
+ ],
+ 'FailedPropertyValues' => [
+ 'description' => '创建失败的属性值。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '修改失败的属性值。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PropertyId' => ['description' => '属性值ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '390'],
+ 'PropertyValue' => ['description' => '属性值。', 'type' => 'string', 'example' => 'HR'],
+ 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'ExistedPropertyValue'],
+ 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The property value is used by another property.'],
+ ],
+ ],
+ ],
],
- 'example' => 'Customized',
- ],
- 'AliasEditable' => [
- 'description' => '是否允许编辑。',
- 'type' => 'boolean',
- 'example' => 'False',
- ],
- 'AliasEditDisabledReason' => [
- 'description' => '不允许编辑的原因。',
- 'type' => 'string',
- 'example' => 'FrequencyExceedsLimit',
- ],
- 'NextModifyTime' => [
- 'description' => '允许编辑的时间。',
- 'type' => 'string',
- 'example' => '2025-04-17 20:31:48',
],
],
],
@@ -378,19 +572,131 @@
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": \\"WY23***\\",\\n \\"AliasInfo\\": {\\n \\"AliasSourceType\\": \\"Customized\\",\\n \\"AliasEditable\\": true,\\n \\"AliasEditDisabledReason\\": \\"FrequencyExceedsLimit\\",\\n \\"NextModifyTime\\": \\"2025-04-17 20:31:48\\"\\n }\\n}","type":"json"}]',
- 'title' => '初始化组织ID',
+ 'title' => '创建用户自定义属性',
+ 'description' => '- 一个阿里云账号下最多可以创建10个不同的属性。每个属性包括一个属性名（PropertyKey）和多个属性值（PropertyValue）。'."\n"
+ .'- 一个属性下最多可以添加50个不同的属性值。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-11-02T06:24:28.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProperty'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ecd:CreateProperty',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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":""}]',
],
- 'CreateUsers' => [
- 'summary' => '为终端用户创建便捷账号。',
- 'methods' => [
- 'get',
- 'post',
+ 'CreateResourceGroup' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
+ [
+ 'name' => 'ResourceGroupName',
+ 'in' => 'query',
+ 'schema' => ['description' => '资源组名称。', 'type' => 'string', 'required' => false, 'example' => '部门A资源组'],
+ ],
+ [
+ 'name' => 'IsResourceGroupWithOfficeSite',
+ 'in' => 'query',
+ 'schema' => ['description' => '> 该参数不对外开放使用。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'Platform',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '对于无影云电脑企业版，固定传入`AliyunConsole`。其他平台暂不支持。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['AliyunConsole' => '无影云电脑企业版'],
+ 'example' => 'AliyunConsole',
+ ],
+ ],
+ [
+ 'name' => 'BusinessChannel',
+ 'in' => 'query',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
+ ],
+ [
+ 'name' => 'EnableAliyunResourceGroup',
+ 'in' => 'query',
+ 'schema' => ['type' => 'boolean'],
+ ],
+ [
+ 'name' => 'ResourceClassification',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'enum' => ['Default', 'DesktopAgent'],
+ ],
+ ],
+ [
+ 'name' => 'AgentType',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '868B8926-2E7A-5BE7-9897-E811E994****'],
+ 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-ckf3cx7isinhk***'],
+ ],
+ ],
+ ],
+ ],
+ 'title' => '创建无影资源组',
+ 'summary' => '创建资源组。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ecd:CreateResourceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\",\\n \\"ResourceGroupId\\": \\"rg-ckf3cx7isinhk***\\"\\n}","type":"json"}]',
+ ],
+ 'CreateUsers' => [
+ 'summary' => '为终端用户创建便捷账号。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -403,9 +709,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '18911',
- 'abilityTreeNodes' => [
- 'FEATUREgwsZABQI3',
- ],
+ 'abilityTreeNodes' => ['FEATUREgwsZABQI3'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
@@ -420,70 +724,30 @@
'description' => '便捷账号信息。',
'type' => 'object',
'properties' => [
- 'EndUserId' => [
- 'description' => '用户名。自定义设置，由小写字母、数字和下划线组成，长度为3~24个字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'alice',
- ],
- 'Email' => [
- 'description' => '邮箱。用于接收相关邮件，如分配云电脑的通知邮件。邮箱和手机号二选一必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'username@example.com',
- ],
- 'Phone' => [
- 'description' => '<props="china">手机号。用于接收相关短信，如分配云电脑的通知短信。邮箱和手机号二选一必填。</props>'."\n"
- ."\n"
- .'<props="intl">国际站不支持手机号。</props>',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1381111****',
- ],
- 'Password' => [
- 'description' => '用户密码。'."\n"
- ."\n"
- .'> 密码长度不少于10位，且至少包含大写字母、小写字母、数字、特殊字符（除空格）中的任意三种。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Wuying1234',
- ],
+ 'EndUserId' => ['description' => '用户名。自定义设置，由小写字母、数字和下划线组成，长度为3~24个字符。', 'type' => 'string', 'required' => true, 'example' => 'alice'],
+ 'Email' => ['description' => '邮箱。用于接收相关邮件，如分配云电脑的通知邮件。邮箱和手机号二选一必填。', 'type' => 'string', 'required' => false, 'example' => 'username@example.com'],
+ 'Phone' => ['description' => '<props="china">手机号。用于接收相关短信，如分配云电脑的通知短信。邮箱和手机号二选一必填。</props>'."\n"
+ ."\n"
+ .'<props="intl">国际站不支持手机号。</props>', 'type' => 'string', 'required' => false, 'example' => '1381111****'],
+ 'Password' => ['description' => '用户密码。'."\n"
+ ."\n"
+ .'> 密码长度不少于10位，且至少包含大写字母、小写字母、数字、特殊字符（除空格）中的任意三种。', 'type' => 'string', 'required' => false, 'example' => 'Wuying1234'],
'OwnerType' => [
'description' => '账号激活类型。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'CreateFromManager' => '管理员激活',
- 'Normal' => '用户激活',
- ],
+ 'enumValueTitles' => ['CreateFromManager' => '管理员激活', 'Normal' => '用户激活'],
'example' => 'Normal',
],
- 'OrgId' => [
- 'description' => '用户所属的组织。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'design',
- ],
- 'Remark' => [
- 'description' => '用户备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'remark1',
- ],
- 'RealNickName' => [
- 'description' => '用户的显示名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Bean',
- ],
+ 'OrgId' => ['description' => '用户所属的组织。', 'type' => 'string', 'required' => false, 'example' => 'design'],
+ 'Remark' => ['description' => '用户备注。', 'type' => 'string', 'required' => false, 'example' => 'remark1'],
+ 'RealNickName' => ['description' => '用户的显示名。', 'type' => 'string', 'required' => false, 'example' => 'Bean'],
'GroupIdList' => [
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'items' => ['type' => 'string', 'required' => false, 'description' => ''],
'required' => false,
'maxItems' => 100,
+ 'description' => '',
],
],
'required' => false,
@@ -496,57 +760,29 @@
[
'name' => 'Password',
'in' => 'formData',
- 'schema' => [
- 'description' => '初始密码。如果不设置，将发送重置密码邮件到用户邮箱。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Test123****',
- 'maxLength' => 256,
- ],
+ 'schema' => ['description' => '初始密码。如果不设置，将发送重置密码邮件到用户邮箱。', 'type' => 'string', 'required' => false, 'example' => 'Test123****', 'maxLength' => 256],
],
[
'name' => 'AutoLockTime',
'in' => 'query',
- 'schema' => [
- 'description' => '自动锁定账号的日期。日期格式 yyyy-MM-dd HH:mm:ss。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-11-28 00:00:00',
- ],
+ 'schema' => ['description' => '自动锁定账号的日期。日期格式 yyyy-MM-dd HH:mm:ss。', 'type' => 'string', 'required' => false, 'example' => '2025-11-28 00:00:00'],
],
[
'name' => 'IsLocalAdmin',
'in' => 'query',
- 'schema' => [
- 'description' => '是否将该便捷账号设为本地管理员。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否将该便捷账号设为本地管理员。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'PasswordExpireDays',
'in' => 'query',
- 'schema' => [
- 'description' => '用户账号的密码默认为永久有效，可通过此参数设置30\\~365天的密码有效期，当密码到期后，终端用户必须先修改密码才能继续登录。'."\n"
- ."\n"
- .'> 该功能目前处于邀测中，如需体验，请提交工单申请开通。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '30',
- ],
+ 'schema' => ['description' => '用户账号的密码默认为永久有效，可通过此参数设置30\\~365天的密码有效期，当密码到期后，终端用户必须先修改密码才能继续登录。'."\n"
+ ."\n"
+ .'> 该功能目前处于邀测中，如需体验，请提交工单申请开通。', 'type' => 'string', 'required' => false, 'example' => '30'],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -556,12 +792,7 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'CreateResult' => [
'description' => '创建便捷账号操作的结果。',
'type' => 'object',
@@ -573,31 +804,11 @@
'description' => '创建成功的便捷账号信息。',
'type' => 'object',
'properties' => [
- 'EndUserId' => [
- 'description' => '用户名。',
- 'type' => 'string',
- 'example' => 'test1',
- ],
- 'Email' => [
- 'description' => '邮箱。',
- 'type' => 'string',
- 'example' => 'username@example.com',
- ],
- 'Phone' => [
- 'description' => '手机号。',
- 'type' => 'string',
- 'example' => '1381111****',
- ],
- 'Remark' => [
- 'description' => '用户备注。',
- 'type' => 'string',
- 'example' => 'remark1',
- ],
- 'RealNickName' => [
- 'description' => '用户的显示名。',
- 'type' => 'string',
- 'example' => 'Bean',
- ],
+ 'EndUserId' => ['description' => '用户名。', 'type' => 'string', 'example' => 'test1'],
+ 'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username@example.com'],
+ 'Phone' => ['description' => '手机号。', 'type' => 'string', 'example' => '1381111****'],
+ 'Remark' => ['description' => '用户备注。', 'type' => 'string', 'example' => 'remark1'],
+ 'RealNickName' => ['description' => '用户的显示名。', 'type' => 'string', 'example' => 'Bean'],
],
],
],
@@ -608,52 +819,26 @@
'description' => '创建失败的便捷账号信息。',
'type' => 'object',
'properties' => [
- 'EndUserId' => [
- 'description' => '用户名。',
- 'type' => 'string',
- 'example' => 'test2',
- ],
- 'Email' => [
- 'description' => '邮箱。',
- 'type' => 'string',
- 'example' => 'username2@example.com',
- ],
- 'Phone' => [
- 'description' => '手机号。',
- 'type' => 'string',
- 'example' => '1390000****',
- ],
- 'ErrorCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'ExistedEndUserId',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'The username test is used by another user.',
- ],
+ 'EndUserId' => ['description' => '用户名。', 'type' => 'string', 'example' => 'test2'],
+ 'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username2@example.com'],
+ 'Phone' => ['description' => '手机号。', 'type' => 'string', 'example' => '1390000****'],
+ 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'ExistedEndUserId'],
+ 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The username test is used by another user.'],
],
],
],
],
],
- 'AllSucceed' => [
- 'type' => 'boolean',
- ],
+ 'AllSucceed' => ['type' => 'boolean', 'description' => ''],
],
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'INTERNAL_ERROR',
- 'errorMessage' => 'Internal error.',
- ],
+ ['errorCode' => 'INTERNAL_ERROR', 'errorMessage' => 'Internal error.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"CreateResult\\": {\\n \\"CreatedUsers\\": [\\n {\\n \\"EndUserId\\": \\"test1\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Remark\\": \\"remark1\\",\\n \\"RealNickName\\": \\"Bean\\"\\n }\\n ],\\n \\"FailedUsers\\": [\\n {\\n \\"EndUserId\\": \\"test2\\",\\n \\"Email\\": \\"username2@example.com\\",\\n \\"Phone\\": \\"1390000****\\",\\n \\"ErrorCode\\": \\"ExistedEndUserId\\",\\n \\"ErrorMessage\\": \\"The username test is used by another user.\\"\\n }\\n ]\\n },\\n \\"AllSucceed\\": true\\n}","type":"json"}]',
'title' => '创建便捷账号',
'description' => '<props="china">便捷账号是无影专用的账号体系，适用于不希望对接企业AD的简单场景。便捷账号信息包括用户名、邮箱和手机号。其中，用户名为必填信息，邮箱和手机号至少填写一项。</props>'."\n"
."\n"
@@ -661,17 +846,46 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'RemoveUsers' => [
- 'summary' => '删除一个或者多个便捷账号。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-11-27T07:00:44.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-04-24T12:29:23.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-12-03T11:44:41.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-04-09T12:00:07.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-01-16T11:08:16.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2023-08-31T01:58:25.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-11-02T06:24:28.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2022-09-08T12:07:49.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2021-07-28T09:03:19.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-06-01T12:53:02.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2021-04-23T06:50:16.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-04-23T06:50:16.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-04-02T06:14:21.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUsers'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ecd:CreateUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"CreateResult\\": {\\n \\"CreatedUsers\\": [\\n {\\n \\"EndUserId\\": \\"test1\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Remark\\": \\"remark1\\",\\n \\"RealNickName\\": \\"Bean\\"\\n }\\n ],\\n \\"FailedUsers\\": [\\n {\\n \\"EndUserId\\": \\"test2\\",\\n \\"Email\\": \\"username2@example.com\\",\\n \\"Phone\\": \\"1390000****\\",\\n \\"ErrorCode\\": \\"ExistedEndUserId\\",\\n \\"ErrorMessage\\": \\"The username test is used by another user.\\"\\n }\\n ]\\n },\\n \\"AllSucceed\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteResourceGroup' => [
+ 'summary' => '删除资源组。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -679,264 +893,464 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
- 'name' => 'Users',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '待删除的资源组ID。'."\n"
+ ."\n"
+ .'> 如果`ResourceGroupIds`参数不为空，则两个参数同时生效。', 'type' => 'string', 'required' => false, 'example' => 'rg-aj01tck67a0szp***'],
+ ],
+ [
+ 'name' => 'ResourceGroupIds',
+ 'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '要删除的便捷账号的用户名列表。',
+ 'description' => '待删除的资源组ID列表。'."\n"
+ ."\n"
+ .'> 如果`ResourceGroupIds`参数不为空，则两个参数同时生效。',
'type' => 'array',
- 'items' => [
- 'description' => '要删除的便捷账号的用户名。用户名可以通过[DescribeUsers](~~DescribeUsers~~)接口获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test1',
+ 'items' => ['description' => '资源组ID。可以通过调用[DescribeResourceGroups](~~DescribeResourceGroups~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => 'rg-eoakjtfdxkk0l***'],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'BusinessChannel',
+ 'in' => 'query',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2463A343-BD32-5803-959E-9A8472A1***'],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除无影资源组',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ecd:DeleteResourceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => true,
- 'example' => 'test1',
- 'maxItems' => 500,
- 'minItems' => 1,
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2463A343-BD32-5803-959E-9A8472A1***\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteUserPropertyValue' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'UserId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用户ID。可以调用[DescribeUsers](~~DescribeUsers~~)获取该参数，对应返回参数`Id`的值。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'],
+ ],
+ [
+ 'name' => 'PropertyId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '属性ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '390'],
+ ],
+ [
+ 'name' => 'PropertyValueId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '属性值ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '978'],
+ ],
[
'name' => 'BusinessChannel',
'in' => 'formData',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
+ 'title' => 'Schema of Response',
+ 'description' => '返回信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D6C62E40-F937-5803-B008-92E813399BA5'],
+ ],
],
],
],
+ 'title' => '为用户移除自定义属性',
+ 'summary' => '解除一个用户与某个用户属性的绑定关系。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-11-02T06:24:28.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserPropertyValue'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ecd:DeleteUserPropertyValue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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":""}]',
+ ],
+ 'DescribeGroupUser' => [
+ 'summary' => '查询用户组成员。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '用户组ID。', 'type' => 'string', 'required' => false, 'example' => 'ug-12341234****'],
+ ],
+ [
+ 'name' => 'BizType',
+ 'in' => 'query',
+ 'schema' => ['description' => '> 该参数暂不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE'],
+ ],
+ [
+ 'name' => 'SolutionId',
+ 'in' => 'query',
+ 'schema' => ['description' => '> 该参数暂不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'co-0esnf80jab***'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时每页行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '下一次查询的Token。可从上一次调用本接口的返回参数中获取。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK****'],
+ ],
+ [
+ 'name' => 'Filter',
+ 'in' => 'query',
+ 'schema' => ['description' => '模糊搜索字符串，支持匹配用户名（EndUserId）和邮箱（Email）。', 'type' => 'string', 'required' => false, 'example' => 'user'],
+ ],
+ [
+ 'name' => 'BusinessChannel',
+ 'in' => 'query',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回信息集合。',
+ 'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'RemoveUsersResult' => [
- 'description' => '删除便捷账号操作的结果。',
- 'type' => 'object',
- 'properties' => [
- 'RemovedUsers' => [
- 'description' => '删除成功的便捷账号。',
- 'type' => 'array',
- 'items' => [
- 'description' => '删除成功的便捷账号。',
- 'type' => 'string',
- 'example' => 'test1',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****'],
+ 'Groups' => [
+ 'description' => '> 废弃字段。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '用户组信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupName' => ['description' => '用户组名称。', 'type' => 'string', 'example' => '开发组'],
+ 'GroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => 'ug-91mvbosdjsdfh****'],
+ 'UserCount' => ['description' => '成员个数。', 'type' => 'string', 'example' => '1'],
],
- 'FailedUsers' => [
- 'description' => '删除失败的用户信息集合。',
- 'type' => 'array',
- 'items' => [
- 'description' => '删除失败的便捷账号。',
- 'type' => 'object',
- 'properties' => [
- 'EndUserId' => [
- 'description' => '删除失败的便捷账号。',
- 'type' => 'string',
- 'example' => 'test2',
- ],
- 'ErrorCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidUsername',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'test2 is an invalid username.',
- ],
- ],
- ],
+ ],
+ ],
+ 'Users' => [
+ 'description' => '成员列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '成员信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EndUserId' => ['description' => '用户名。', 'type' => 'string', 'example' => 'alex****'],
+ 'Avatar' => ['description' => '> 废弃字段。', 'type' => 'string', 'example' => 'https://avatar.****.com'],
+ 'Address' => ['description' => '> 废弃字段。', 'type' => 'string', 'example' => 'xx-xx-xx'],
+ 'Phone' => ['description' => '手机号。', 'type' => 'string', 'example' => '138****1111'],
+ 'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'alex****@example.com'],
+ 'NickName' => ['description' => '显示名。', 'type' => 'string', 'example' => 'alex'],
+ 'JobNumber' => ['description' => '> 废弃字段。', 'type' => 'string', 'example' => '123'],
+ 'GmtJoinGroup' => ['description' => '添加时间。', 'type' => 'string', 'example' => '2024-08-26T02:59:22.000+00:00'],
+ 'GmtCreated' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-08-26T02:59:22.000+00:00'],
+ 'Remark' => ['description' => '用户的备注。', 'type' => 'string', 'example' => 'remark'],
],
],
],
+ 'NextToken' => ['description' => '下一次查询的Token。NextToken为空表示结果已经全部查询到。', 'type' => 'string', 'example' => 'AAAAAV3MpHK****'],
],
],
],
],
- 'responseDemo' => '[{"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' => '删除便捷账号',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ModifyUser' => [
- 'summary' => '修改便捷账号的联系方式。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '查询用户组成员',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-30T14:09:42.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeGroupUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'DescribeGroups' => [
+ 'summary' => '查询用户组。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'EndUserId',
+ 'name' => 'GroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '便捷账号的用户ID，对应控制台上显示的`用户名`字段。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'alice',
- ],
+ 'schema' => ['description' => '用户组ID。', 'type' => 'string', 'required' => false, 'example' => 'ug-16nf7xxh4o9gc****'],
],
[
- 'name' => 'Email',
+ 'name' => 'BizType',
'in' => 'query',
- 'schema' => [
- 'description' => '便捷账号的邮箱地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'username@example.com',
- ],
+ 'schema' => ['description' => '> 该参数暂不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE'],
],
[
- 'name' => 'Phone',
+ 'name' => 'SolutionId',
'in' => 'query',
- 'schema' => [
- 'description' => '编辑账号的手机号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1381111****',
- ],
+ 'schema' => ['description' => '> 该参数暂不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'co-0esnf80jab***'],
+ ],
+ [
+ 'name' => 'GroupName',
+ 'in' => 'query',
+ 'schema' => ['description' => '用户组名称。', 'type' => 'string', 'required' => false, 'example' => 'TestGroup'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时设置的每页行数。最大值：100。默认值：10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '10', 'default' => '20'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页查询时的页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'TransferFileNeedApproval',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否已开启文件审批。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'LoginPolicyId',
+ 'in' => 'query',
+ 'schema' => ['title' => '指定关联的登录策略筛选。'."\n", 'description' => '指定关联的登录策略筛选。'."\n", 'type' => 'string', 'required' => false],
+ ],
+ [
+ 'name' => 'ExcludeAttachedLoginPolicyGroups',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否排除已关联登录策略的用户组。', 'description' => '是否排除已关联登录策略的用户组。', 'type' => 'boolean', 'required' => false],
+ ],
+ [
+ 'name' => 'IdpId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回信息集合。',
+ 'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Groups' => [
+ 'description' => '用户组列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '用户组信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'GroupName' => ['description' => '用户组名称。', 'type' => 'string', 'example' => 'TestGroup'],
+ 'GroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => 'ug-2412ojkwtybd****'],
+ 'Description' => ['description' => '用户组的描述。', 'type' => 'string', 'example' => 'A test group.'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-08-07T13:40:40+08:00'],
+ 'UserCount' => ['description' => '用户组内的成员数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'TransferFileNeedApproval' => ['description' => '是否已开启文件审批。', 'type' => 'boolean', 'example' => 'false'],
+ 'AttachedLoginPolicy' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PolicyId' => ['type' => 'string', 'description' => ''],
+ 'Name' => ['type' => 'string', 'description' => ''],
+ ],
+ 'description' => '',
+ ],
+ 'AuthedResources' => [
+ 'description' => '已分配的资源列表。',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'description' => '已分配的资源。',
+ 'enumValueTitles' => ['DesktopGroup' => '共享型云电脑'],
+ 'example' => 'DesktopGroup',
+ ],
+ ],
+ ],
+ ],
],
+ 'Count' => ['description' => '查询结果的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => '修改便捷账号的联系方式',
- ],
- 'ResetUserPassword' => [
- 'summary' => '重置便捷账号的密码，包括生成重置密码Token，并发送重置密码邮件到便捷账号的邮箱。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '查询用户组',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-29T02:53:02.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-11-27T07:00:44.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-09-11T07:57:42.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-07-30T14:09:42.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Groups\\": [\\n {\\n \\"GroupName\\": \\"TestGroup\\",\\n \\"GroupId\\": \\"ug-2412ojkwtybd****\\",\\n \\"Description\\": \\"A test group.\\",\\n \\"CreateTime\\": \\"2025-08-07T13:40:40+08:00\\",\\n \\"UserCount\\": 20,\\n \\"TransferFileNeedApproval\\": false,\\n \\"AttachedLoginPolicy\\": {\\n \\"PolicyId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"AuthedResources\\": {\\n \\"key\\": \\"DesktopGroup\\"\\n }\\n }\\n ],\\n \\"Count\\": 1\\n}","type":"json"}]',
+ ],
+ 'DescribeMfaDevices' => [
+ 'summary' => '查询便捷账号绑定的虚拟MFA设备。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'Users',
- 'in' => 'formData',
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '返回结果的最大数量。取值范围：1~500。 '."\n"
+ .'默认值：100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '100'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '查询凭证。取值为上一次API调用时返回的NextToken参数值。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
+ ],
+ [
+ 'name' => 'EndUserIds',
+ 'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => '要重置密码的便捷账号的用户名列表。',
+ 'description' => '便捷账号的用户名列表。',
'type' => 'array',
- 'items' => [
- 'description' => '要重置密码的便捷账号的用户名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'alice',
- ],
- 'required' => true,
- 'example' => 'test1',
+ 'items' => ['description' => '便捷账号的用户名。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
+ 'required' => false,
+ 'example' => 'test',
'maxItems' => 100,
],
],
[
- 'name' => 'NotifyType',
- 'in' => 'formData',
+ 'name' => 'SerialNumbers',
+ 'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '重置密码后通知用户的方式。'."\n"
- ."\n"
- .'> 国际站账号不支持通过短信通知用户的方式。',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '虚拟MFA设备的序列号列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '虚拟MFA设备的序列号。', 'type' => 'string', 'required' => false, 'example' => 'c2d9ae94-a64b-4a0d-8024-9519ca50****'],
'required' => false,
- 'enumValueTitles' => [
- 1 => '通过邮箱通知用户',
- '通过短信通知用户',
- '邮箱和短信都发送通知',
- ],
- 'example' => '1',
+ 'example' => 'c2d9ae94-a64b-4a0d-8024-9519ca50****',
+ 'maxItems' => 100,
],
],
[
+ 'name' => 'AdDomain',
+ 'in' => 'query',
+ 'schema' => ['description' => 'AD办公网络地址。', 'type' => 'string', 'required' => false, 'example' => 'cn.misumi.pri'],
+ ],
+ [
+ 'name' => 'Filter',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ [
'name' => 'BusinessChannel',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'in' => 'query',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -946,48 +1360,44 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '32D05B39-E6EE-4D7A-9FD0-762A26859D0D',
- ],
- 'ResetUsersResult' => [
- 'description' => '重置便捷账号密码操作的结果。',
- 'type' => 'object',
- 'properties' => [
- 'ResetUsers' => [
- 'description' => '已发送重置密码邮件的便捷账号列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '已发送重置密码邮件的便捷账号。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '33DBB8EC-6E68-4726-91C4-E09C59D9A7D8'],
+ 'NextToken' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp'],
+ 'MfaDevices' => [
+ 'title' => 'mfa device list',
+ 'description' => '虚拟MFA设备信息集合。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '虚拟MFA设备信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => '虚拟MFA设备的ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '36'],
+ 'EndUserId' => ['description' => '使用该虚拟MFA设备的便捷账号用户名。', 'type' => 'string', 'example' => 'alice'],
+ 'Email' => ['description' => '> 该参数暂未开放使用。', 'type' => 'string', 'example' => 'username@example.com'],
+ 'GmtEnabled' => ['description' => '虚拟MFA设备启用时间。按照ISO8601标准表示，并使用UTC+0时间，格式为`yyyy-MM-ddTHH:mm:ssZ`。', 'type' => 'string', 'example' => '2021-06-22T06:20:49Z'],
+ 'GmtUnlock' => ['description' => '虚拟MFA设备被锁定后的自动解锁时间。按照ISO8601标准表示，并使用UTC+0时间，格式为`yyyy-MM-ddTHH:mm:ssZ`。', 'type' => 'string', 'example' => '2021-06-23T06:20:49Z'],
+ 'ConsecutiveFails' => ['description' => '连续绑定或者认证虚拟MFA设备失败的次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'SerialNumber' => ['description' => '虚拟MFA设备的序列号。', 'type' => 'string', 'example' => 'dc856334-446b-4035-bfbc-18af261e****'],
+ 'Status' => [
+ 'description' => '虚拟MFA设备状态。',
'type' => 'string',
- 'example' => 'test1',
+ 'enumValueTitles' => ['LOCKED' => '已锁定', 'UNBOUND' => '未绑定', 'NORMAL' => '正常'],
+ 'example' => 'NORMAL',
],
- ],
- 'FailedUsers' => [
- 'description' => '重置密码失败的便捷账号列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '重置密码失败的便捷账号信息集合。',
+ 'DeviceType' => [
+ 'description' => '虚拟MFA设备类型。目前仅支持`TOTP_VIRTUAL`，即遵循TOTP算法的虚拟MFA设备。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['TOTP_VIRTUAL' => '遵循TOTP算法的虚拟MFA设备'],
+ 'example' => 'TOTP_VIRTUAL',
+ ],
+ 'AdUser' => [
'type' => 'object',
'properties' => [
- 'EndUserId' => [
- 'description' => '重置密码失败的便捷账号。',
- 'type' => 'string',
- 'example' => 'alice',
- ],
- 'ErrorCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidUsername',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'test123 is an invalid username.',
- ],
+ 'EndUser' => ['type' => 'string', 'description' => ''],
+ 'DisplayName' => ['type' => 'string', 'description' => ''],
+ 'DisplayNameNew' => ['type' => 'string', 'description' => ''],
+ 'UserPrincipalName' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
],
@@ -996,71 +1406,171 @@
],
],
],
- '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' => '重置便捷账号的密码',
+ 'title' => '查询便捷账号绑定的虚拟MFA设备',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'LockUsers' => [
- 'summary' => '锁定一个或者多个便捷账号。锁定后的便捷账号无法登录无影终端。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-08-25T01:40:52.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2023-08-21T09:00:53.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-04-23T06:50:16.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-04-23T06:50:16.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMfaDevices'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeMfaDevices',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"33DBB8EC-6E68-4726-91C4-E09C59D9A7D8\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp\\",\\n \\"MfaDevices\\": [\\n {\\n \\"Id\\": 36,\\n \\"EndUserId\\": \\"alice\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"GmtEnabled\\": \\"2021-06-22T06:20:49Z\\",\\n \\"GmtUnlock\\": \\"2021-06-23T06:20:49Z\\",\\n \\"ConsecutiveFails\\": 0,\\n \\"SerialNumber\\": \\"dc856334-446b-4035-bfbc-18af261e****\\",\\n \\"Status\\": \\"NORMAL\\",\\n \\"DeviceType\\": \\"TOTP_VIRTUAL\\",\\n \\"AdUser\\": {\\n \\"EndUser\\": \\"\\",\\n \\"DisplayName\\": \\"\\",\\n \\"DisplayNameNew\\": \\"\\",\\n \\"UserPrincipalName\\": \\"\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeMfaDevicesResponse>\\n <NextToken>AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp</NextToken>\\n <RequestId>8C09C087-99C3-43F0-BFEA-03E651E04696</RequestId>\\n <MfaDevices>\\n <Status>NORMAL</Status>\\n <DeviceType>TOTP_VIRTUAL</DeviceType>\\n <GmtEnabled>2021-06-22T06:20:49Z</GmtEnabled>\\n <EndUserId>test</EndUserId>\\n <SerialNumber>dc856334-446b-4035-bfbc-18af261e****</SerialNumber>\\n <ConsecutiveFails>0</ConsecutiveFails>\\n <Id>36</Id>\\n </MfaDevices>\\n</DescribeMfaDevicesResponse>","errorExample":""}]',
+ ],
+ 'DescribeOrgByLayer' => [
+ 'summary' => '查找下级组织。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'Users',
+ 'name' => 'ParentOrgId',
'in' => 'formData',
- 'style' => 'repeatList',
+ 'schema' => ['description' => '父组织ID。', 'type' => 'string', 'required' => false, 'example' => 'org-11fs****'],
+ ],
+ [
+ 'name' => 'OrgName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '组织名称。', 'type' => 'string', 'required' => false, 'example' => '产品部'],
+ ],
+ [
+ 'name' => 'BusinessChannel',
+ 'in' => 'formData',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '要锁定的便捷账号的用户名列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '要锁定的便捷账号的用户名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'alice',
+ 'title' => 'Schema of Response',
+ 'description' => '返回信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Orgs' => [
+ 'description' => '组织信息列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '组织信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrgName' => ['description' => '组织名称。', 'type' => 'string', 'example' => '开发部'],
+ 'OrgId' => ['description' => '组织ID。', 'type' => 'string', 'example' => 'org-1mox****'],
+ 'ParentOrgId' => ['description' => '父组织ID。', 'type' => 'string', 'example' => 'org-ezqr****'],
+ ],
+ ],
+ ],
],
- 'required' => true,
- 'example' => 'test1',
- 'maxItems' => 500,
],
],
+ ],
+ 'title' => '指定父组织查找下级组织',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOrgByLayer'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'LogoutSession',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeOrgByLayer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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"}]',
+ ],
+ 'DescribeOrgs' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '返回结果的最大数量。取值范围：1~100。 '."\n"
+ .'默认值：100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'example' => '20', 'default' => '500'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK****'],
+ ],
+ [
+ 'name' => 'OrgName',
+ 'in' => 'query',
+ 'schema' => ['description' => '组织名称。', 'type' => 'string', 'required' => false, 'example' => '产品部'],
+ ],
+ [
+ 'name' => 'ParentOrgId',
+ 'in' => 'query',
+ 'schema' => ['description' => '父组织ID。', 'type' => 'string', 'required' => false, 'example' => 'org-11fs****'],
+ ],
+ [
+ 'name' => 'ShowExtras',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'type' => 'boolean',
+ 'type' => 'object',
'required' => false,
+ 'additionalProperties' => ['type' => 'any', 'description' => ''],
+ 'description' => '',
],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
+ ],
+ [
+ 'name' => 'IncludeOrgIds',
+ 'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
+ 'type' => 'array',
+ 'items' => ['type' => 'string'],
],
],
],
@@ -1071,46 +1581,26 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'LockUsersResult' => [
- 'description' => '锁定便捷账号操作的结果。',
- 'type' => 'object',
- 'properties' => [
- 'LockedUsers' => [
- 'description' => '锁定成功的便捷账号列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '锁定成功的便捷账号。',
- 'type' => 'string',
- 'example' => 'alice',
- ],
- ],
- 'FailedUsers' => [
- 'description' => '锁定失败的便捷账号列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '锁定失败的便捷账号信息集合。',
- 'type' => 'object',
- 'properties' => [
- 'EndUserId' => [
- 'description' => '锁定失败的便捷账号。',
- 'type' => 'string',
- 'example' => 'alice',
- ],
- 'ErrorCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidUsername',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'test123 is an invalid username.',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0B4BB****'],
+ 'NextToken' => ['description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。', 'type' => 'string', 'example' => 'AAAAAV3MpHK****'],
+ 'Orgs' => [
+ 'description' => '组织列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '组织详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'OrgName' => ['description' => '组织名称。', 'type' => 'string', 'example' => '设计部****'],
+ 'OrgId' => ['description' => '组织ID。', 'type' => 'string', 'example' => 'org-1mox****'],
+ 'ParentOrgId' => ['description' => '父组织ID。', 'type' => 'string', 'example' => 'org-ezqr****'],
+ 'OrgNamePath' => ['type' => 'string', 'description' => ''],
+ 'ResourcePolicyList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PolicyId' => ['type' => 'string'],
+ 'PolicyName' => ['type' => 'string'],
],
],
],
@@ -1121,82 +1611,112 @@
],
],
],
- 'eventInfo' => [
- 'enable' => false,
- 'eventNames' => [],
+ 'title' => '查询组织列表',
+ 'summary' => '查询组织列表。',
+ 'description' => '组织为树形结构，其根组织ID值为：org-aliyun-wy-org-id。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-08-12T13:09:08.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- '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' => '锁定便捷账号',
- 'description' => '出于安全考虑，您可以锁定便捷账号。被锁定的便捷用户无法登录无影终端，因此也无法访问任何无影云资源。'."\n"
- ."\n"
- .'> 您可以调用[DescribeUsers](~~283609~~)查询便捷账号信息。若返回数据中`Status`取值为0，表示该便捷账号未被锁定；若`Status`取值为9，表示该便捷账号已被锁定。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'UnlockUsers' => [
- 'summary' => '解锁一个或者多个便捷账号。解锁后的便捷账号可以登录无影终端。',
- 'methods' => [
- 'get',
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOrgs'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeOrgs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B4BB****\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK****\\",\\n \\"Orgs\\": [\\n {\\n \\"OrgName\\": \\"设计部****\\",\\n \\"OrgId\\": \\"org-1mox****\\",\\n \\"ParentOrgId\\": \\"org-ezqr****\\",\\n \\"OrgNamePath\\": \\"\\",\\n \\"ResourcePolicyList\\": [\\n {\\n \\"PolicyId\\": \\"\\",\\n \\"PolicyName\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'DescribeResourceGroups' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'Users',
- 'in' => 'formData',
- 'style' => 'repeatList',
+ 'name' => 'ResourceGroupName',
+ 'in' => 'query',
+ 'schema' => ['description' => '资源组名称。', 'type' => 'string', 'required' => false, 'example' => '部门A资源组'],
+ ],
+ [
+ 'name' => 'ResourceGroupIds',
+ 'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '要解锁的便捷账号的用户名列表。',
+ 'description' => '资源组ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '要解锁的便捷账号的用户名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'alice',
- ],
- 'required' => true,
- 'example' => 'test1',
- 'maxItems' => 500,
+ 'items' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-9th3k8twp3ox2***'],
+ 'required' => false,
],
],
[
- 'name' => 'AutoLockTime',
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'NeedContainResourceGroupWithOfficeSite',
+ 'in' => 'query',
+ 'schema' => ['description' => '> 该参数不对外开放使用。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'Platform',
+ 'in' => 'query',
+ 'schema' => ['description' => '> 固定值：AliyunConsole。'."\n"
+ .'> - 无影企业版固定传AliyunConsole，其他平台暂不对外开放。', 'type' => 'string', 'required' => false, 'example' => 'AliyunConsole'],
+ ],
+ [
+ 'name' => 'BusinessChannel',
'in' => 'query',
+ 'schema' => ['title' => '渠道标记', 'description' => '渠道标记', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE'],
+ ],
+ [
+ 'name' => 'AliyunResourceGroupIds',
+ 'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '自动锁定便捷账号的日期。',
- 'type' => 'string',
+ 'title' => '云平台资源组ID。',
+ 'description' => '云平台资源组ID。',
+ 'type' => 'array',
+ 'items' => ['title' => '资源组ID。', 'description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-as8nlsbsxsldk***'],
'required' => false,
- 'example' => '2023-03-03',
],
],
[
- 'name' => 'BusinessChannel',
+ 'name' => 'ResourceClassification',
'in' => 'query',
'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
+ 'enum' => ['Default', 'DesktopAgent'],
],
],
+ [
+ 'name' => 'AgentType',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string'],
+ ],
],
'responses' => [
200 => [
@@ -1205,75 +1725,224 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '023F4EC4-3602-4A3E-A514-4970847D59DB',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '68BA1DF7-8814-5AED-B844-F8F7F7****'],
+ 'ResourceGroup' => [
+ 'description' => '资源组信息列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '资源组信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-cyo0il2pzge1***'],
+ 'ResourceGroupName' => ['description' => '资源组名称。', 'type' => 'string', 'example' => '测试资源组'],
+ 'ResourceCount' => ['description' => '资源组内的资源数量。', 'type' => 'string', 'example' => '119'],
+ 'AuthCount' => ['description' => '资源组授权的管理员数量。', 'type' => 'string', 'example' => '3'],
+ 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-11-29T17:25:40.000000000Z'],
+ 'Policies' => [
+ 'description' => '> 资源组关联的策略。'."\n"
+ .'> - 关联策略会对资源组内的云电脑生效，如果有多个策略，会按策略的优先级生效。'."\n"
+ .'> - 如果资源组内的云电脑本身已指定其他策略，资源组关联的策略优先生效。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => '策略ID。', 'type' => 'string', 'example' => 'pl-a8jnatl8kjasb***'],
+ 'Name' => ['description' => '策略名称。', 'type' => 'string', 'example' => '测试策略123'],
+ 'IsDefault' => ['description' => '是否默认策略。', 'type' => 'boolean', 'example' => 'False'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'Timers' => [
+ 'description' => '> 关联的定时任务。'."\n"
+ .'> - 关联的定时任务会对资源组内的云电脑生效，如果资源组内的云电脑本身已关联其他定时任务，资源组关联的任务优先生效。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => '定时任务ID。', 'type' => 'string', 'example' => 't-asdzx0mbjhg***'],
+ 'Name' => ['description' => '定时任务名称。', 'type' => 'string', 'example' => '测试任务123'],
+ 'TimerStatus' => ['type' => 'string', 'description' => ''],
+ 'BindStatus' => ['type' => 'string', 'description' => ''],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'AppRules' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['type' => 'string', 'description' => ''],
+ 'Name' => ['type' => 'string', 'description' => ''],
+ 'Type' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ ],
+ 'description' => '',
+ ],
+ 'description' => '',
+ ],
+ 'AliyunResourceGroupId' => ['title' => '阿里云资源组ID', 'description' => '阿里云资源组ID', 'type' => 'string', 'example' => 'rg-123456'],
+ 'AgentType' => ['type' => 'string'],
+ ],
+ ],
],
- 'UnlockUsersResult' => [
- 'description' => '解锁便捷账号操作的结果。',
+ 'TotalCount' => ['description' => '资源组总个数。', 'type' => 'string', 'example' => '7'],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查看资源组信息',
+ 'summary' => '查看资源组。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-29T02:53:02.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-05-22T11:11:36.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeResourceGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68BA1DF7-8814-5AED-B844-F8F7F7****\\",\\n \\"ResourceGroup\\": [\\n {\\n \\"ResourceGroupId\\": \\"rg-cyo0il2pzge1***\\",\\n \\"ResourceGroupName\\": \\"测试资源组\\",\\n \\"ResourceCount\\": \\"119\\",\\n \\"AuthCount\\": \\"3\\",\\n \\"CreateTime\\": \\"2022-11-29T17:25:40.000000000Z\\",\\n \\"Policies\\": [\\n {\\n \\"Id\\": \\"pl-a8jnatl8kjasb***\\",\\n \\"Name\\": \\"测试策略123\\",\\n \\"IsDefault\\": true\\n }\\n ],\\n \\"Timers\\": [\\n {\\n \\"Id\\": \\"t-asdzx0mbjhg***\\",\\n \\"Name\\": \\"测试任务123\\",\\n \\"TimerStatus\\": \\"\\",\\n \\"BindStatus\\": \\"\\"\\n }\\n ],\\n \\"AppRules\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": 0\\n }\\n ],\\n \\"AliyunResourceGroupId\\": \\"rg-123456\\",\\n \\"AgentType\\": \\"\\"\\n }\\n ],\\n \\"TotalCount\\": \\"7\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeUser' => [
+ 'summary' => '查询用户基础信息',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => ['description' => '用户名。', 'type' => 'string', 'required' => false, 'example' => 'alex'],
+ ],
+ [
+ 'name' => 'BusinessChannel',
+ 'in' => 'query',
+ 'schema' => ['title' => '渠道', 'description' => '业务类型。', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
+ ],
+ [
+ 'name' => 'RequireExtraAttributes',
+ 'in' => 'query',
+ 'style' => 'flat',
+ 'schema' => [
+ 'description' => '需要查询的属性列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '需要查询的属性。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['OrgPaths' => '组织', 'ExternalInfo' => '外部账号信息', 'Properties' => '属性'],
+ 'example' => 'Org',
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '返回数据结构。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'User' => [
+ 'description' => '用户信息。',
'type' => 'object',
'properties' => [
- 'UnlockedUsers' => [
- 'description' => '解锁成功的便捷账号列表。',
+ 'EndUserId' => ['description' => '用户名。', 'type' => 'string', 'example' => 'alex'],
+ 'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'alex@test-email.com'],
+ 'Phone' => ['description' => '手机号。', 'type' => 'string', 'example' => '1888888****'],
+ 'Remark' => ['description' => '备注。', 'type' => 'string', 'example' => 'remark'],
+ 'WyId' => ['description' => '无影用户唯一ID。', 'type' => 'string', 'example' => 'aisdfumj****'],
+ 'Status' => ['description' => '用户状态。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Extras' => [
+ 'description' => '扩展信息。',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'example' => '{"assignedResourceount":1}', 'description' => '扩展信息。'],
+ ],
+ 'GmtCreate' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '2025-01-01 12:00:00'],
+ 'OrgIds' => [
+ 'description' => '组织ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '解锁成功的便捷账号。',
- 'type' => 'string',
- 'example' => 'alice',
- ],
+ 'items' => ['description' => '组织ID。', 'type' => 'string', 'example' => 'org-1nsdf8a****'],
],
- 'FailedUsers' => [
- 'description' => '解锁失败的便捷账号列表。',
+ 'OrgPaths' => [
+ 'description' => '组织列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '组织名。', 'type' => 'string', 'example' => 'org1/org2'],
+ ],
+ 'Properties' => [
+ 'description' => '用户属性。',
'type' => 'array',
'items' => [
- 'description' => '解锁失败的便捷账号信息集合。',
'type' => 'object',
'properties' => [
- 'EndUserId' => [
- 'description' => '解锁失败的便捷账号。',
- 'type' => 'string',
- 'example' => 'alice',
- ],
- 'ErrorCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'InvalidUsername',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'test123 is an invalid username.',
- ],
+ 'Key' => ['description' => '属性Key。', 'type' => 'string', 'example' => 'role'],
+ 'Value' => ['description' => '属性值。', 'type' => 'string', 'example' => 'teacher'],
],
+ 'description' => '',
+ ],
+ ],
+ 'ExternalInfo' => [
+ 'description' => '关联的外部用户信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ExternalName' => ['description' => '外部信息名称。', 'type' => 'string', 'example' => 'Alex'],
+ 'JobNumber' => ['description' => '工号。', 'type' => 'string', 'example' => '15412***'],
+ 'SsoType' => ['description' => 'SSO登录类型。', 'type' => 'string', 'example' => 'OIDC'],
+ 'ExternalId' => ['description' => '外部用户ID。', 'type' => 'string', 'example' => 'oijjnabsf****'],
],
],
+ 'NickName' => ['type' => 'string'],
],
],
],
],
],
],
- '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' => '解锁便捷账号',
- 'description' => '被锁定的便捷账号无法登录无影终端，因此也无法访问任何无影云资源。如需允许便捷账号登录无影终端，需要先将其解锁。'."\n"
- ."\n"
- .'> 您可以调用[DescribeUsers](~~283609~~)查询便捷账号信息。若返回数据中`Status`取值为0，表示该便捷账号未被锁定；若`Status`取值为9，表示该便捷账号已被锁定。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DescribeUsers' => [
- 'summary' => '查询便捷账号信息，例如用户名、邮箱地址、备注名称等。',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => '查询用户信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"User\\": {\\n \\"EndUserId\\": \\"alex\\",\\n \\"Email\\": \\"alex@test-email.com\\",\\n \\"Phone\\": \\"1888888****\\",\\n \\"Remark\\": \\"remark\\",\\n \\"WyId\\": \\"aisdfumj****\\",\\n \\"Status\\": 0,\\n \\"Extras\\": {\\n \\"key\\": \\"{\\\\\\"assignedResourceount\\\\\\":1}\\"\\n },\\n \\"GmtCreate\\": 0,\\n \\"OrgIds\\": [\\n \\"org-1nsdf8a****\\"\\n ],\\n \\"OrgPaths\\": [\\n \\"org1/org2\\"\\n ],\\n \\"Properties\\": [\\n {\\n \\"Key\\": \\"role\\",\\n \\"Value\\": \\"teacher\\"\\n }\\n ],\\n \\"ExternalInfo\\": {\\n \\"ExternalName\\": \\"Alex\\",\\n \\"JobNumber\\": \\"15412***\\",\\n \\"SsoType\\": \\"OIDC\\",\\n \\"ExternalId\\": \\"oijjnabsf****\\"\\n },\\n \\"NickName\\": \\"\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'DescribeUsers' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1281,12 +1950,7 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'MaxResults',
@@ -1309,23 +1973,13 @@
[
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '下一次查询的Token。首次调用接口时无需设置该参数。 '."\n"
- .'如果一次查询结果并没有完整返回所有的结果，则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'caeba0bbb2be03f84eb48b699f0a****',
- ],
+ 'schema' => ['description' => '下一次查询的Token。首次调用接口时无需设置该参数。 '."\n"
+ .'如果一次查询结果并没有完整返回所有的结果，则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a****'],
],
[
'name' => 'Filter',
'in' => 'query',
- 'schema' => [
- 'description' => '模糊搜索字符串，支持匹配用户名（EndUserId）和邮箱（Email）。该字段支持使用通配符（*），例如将该字段设为`a*m`，则返回用户名或邮箱以`a`开头、以`m`结尾的所有结果。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a*m',
- ],
+ 'schema' => ['description' => '模糊搜索字符串，支持匹配用户名（EndUserId）和邮箱（Email）。该字段支持使用通配符（*），例如将该字段设为`a*m`，则返回用户名或邮箱以`a`开头、以`m`结尾的所有结果。', 'type' => 'string', 'required' => false, 'example' => 'a*m'],
],
[
'name' => 'FilterMap',
@@ -1333,10 +1987,7 @@
'style' => 'json',
'schema' => [
'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- ],
+ 'additionalProperties' => ['type' => 'string'],
],
],
[
@@ -1346,12 +1997,7 @@
'schema' => [
'description' => '需精确匹配的用户名（EndUserId）列表。',
'type' => 'array',
- 'items' => [
- 'description' => '按用户名（EndUserId）精确匹配，查询用户名一致的账号信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'alice',
- ],
+ 'items' => ['description' => '按用户名（EndUserId）精确匹配，查询用户名一致的账号信息。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => false,
'maxItems' => 500,
],
@@ -1363,12 +2009,7 @@
'schema' => [
'description' => '需精确排除的用户名（EndUserId）列表。',
'type' => 'array',
- 'items' => [
- 'description' => '按用户名（EndUserId）精确排除，查询不包含该用户名的账号列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tony',
- ],
+ 'items' => ['description' => '按用户名（EndUserId）精确排除，查询不包含该用户名的账号列表。', 'type' => 'string', 'required' => false, 'example' => 'tony'],
'required' => false,
'maxItems' => 500,
],
@@ -1376,42 +2017,22 @@
[
'name' => 'OrgId',
'in' => 'formData',
- 'schema' => [
- 'description' => '按组织ID精确匹配，查询归属该组织的账号列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'org-4mdgc1cocc59z****',
- ],
+ 'schema' => ['description' => '按组织ID精确匹配，查询归属该组织的账号列表。', 'type' => 'string', 'required' => false, 'example' => 'org-4mdgc1cocc59z****'],
],
[
'name' => 'GroupId',
'in' => 'formData',
- 'schema' => [
- 'description' => '按用户组ID精确匹配，查询归属该用户组的账号列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ug-12341234****',
- ],
+ 'schema' => ['description' => '按用户组ID精确匹配，查询归属该用户组的账号列表。', 'type' => 'string', 'required' => false, 'example' => 'ug-12341234****'],
],
[
'name' => 'BizType',
'in' => 'formData',
- 'schema' => [
- 'description' => '> 该参数不对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '> 该参数不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'SolutionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '> 该参数不对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '> 该参数不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'ShowExtras',
@@ -1421,16 +2042,11 @@
'description' => '查询用户扩展信息。',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => 'DesktopGroup: true',
- 'description' => 'key为以下类型，值为Boolean类型，传true表示筛选分配该云资源的用户。'."\n"
- ."\n"
- .'- Desktop: 云电脑。'."\n"
- .'- DesktopGroup: 共享型云电脑。'."\n"
- .'- CloudDrive: 企业网盘（用户个人盘）。'."\n"
- .'- App: 云应用。',
- ],
+ 'additionalProperties' => ['type' => 'any', 'example' => 'ResourcesCount: true', 'description' => 'key为以下类型，值为Boolean类型，传true表示查询指定的信息。其中归属用户组和部门默认返回。'."\n"
+ .'- Group: 归属的用户组。'."\n"
+ .'- Org: 归属的部门。'."\n"
+ .'- ResourcesCount: 已分配的资源个数。'."\n"
+ .'- Properties: 用户属性。'],
],
],
[
@@ -1441,20 +2057,18 @@
'description' => '根据否分配云资源筛选用户。',
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'boolean',
- ],
+ 'additionalProperties' => ['type' => 'boolean', 'example' => 'DesktopGroup: true', 'description' => 'key为以下类型，值为Boolean类型，传true表示筛选分配该云资源的用户。'."\n"
+ ."\n"
+ .'- Desktop: 云电脑。'."\n"
+ .'- DesktopGroup: 共享型云电脑。'."\n"
+ .'- CloudDrive: 企业网盘（用户个人盘）。'."\n"
+ .'- App: 云应用。'],
],
],
[
'name' => 'IsQueryAllSubOrgs',
'in' => 'formData',
- 'schema' => [
- 'description' => '是否查询子组织下的用户。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否查询子组织下的用户。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'FilterWithAssignedResource',
@@ -1463,41 +2077,28 @@
'schema' => [
'type' => 'object',
'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- ],
+ 'additionalProperties' => ['type' => 'string', 'example' => 'App:aig-jfgmanbo****', 'description' => 'key为以下类型，值为该云资源的ID。'."\n"
+ ."\n"
+ .'- DesktopGroup: 共享型云电脑。'."\n"
+ ."\n"
+ .'- App: 云应用交付组。'],
+ 'description' => '',
],
],
[
'name' => 'Status',
'in' => 'formData',
- 'schema' => [
- 'title' => '状态',
- 'description' => '状态',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
+ 'schema' => ['title' => '状态', 'description' => '状态', 'type' => 'integer', 'format' => 'int32', 'required' => false],
],
[
'name' => 'ExcludeGroupId',
'in' => 'formData',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -1507,17 +2108,8 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'NextToken' => [
- 'description' => '下一次查询的Token。NextToken为空表示没有下一次。',
- 'type' => 'string',
- 'example' => 'caeba0bbb2be03f84eb48b699f0a4883',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'NextToken' => ['description' => '下一次查询的Token。NextToken为空表示没有下一次。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'Users' => [
'title' => 'users',
'description' => '便捷账号信息集合。',
@@ -1526,35 +2118,15 @@
'description' => '便捷账号信息集合。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'description' => '便捷账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4205**',
- ],
- 'EndUserId' => [
- 'description' => '用户名。',
- 'type' => 'string',
- 'example' => 'alice',
- ],
- 'Email' => [
- 'description' => '邮箱。',
- 'type' => 'string',
- 'example' => 'username@example.com',
- ],
- 'Phone' => [
- 'description' => '手机号，如未设置该参数则不返回该参数。',
- 'type' => 'string',
- 'example' => '1381111****',
- ],
+ 'Id' => ['description' => '便捷账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '4205**'],
+ 'EndUserId' => ['description' => '用户名。', 'type' => 'string', 'example' => 'alice'],
+ 'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username@example.com'],
+ 'Phone' => ['description' => '手机号，如未设置该参数则不返回该参数。', 'type' => 'string', 'example' => '1381111****'],
'Status' => [
'description' => '状态。',
'type' => 'integer',
'format' => 'int64',
- 'enumValueTitles' => [
- '正常',
- 9 => '锁定',
- ],
+ 'enumValueTitles' => ['正常', 9 => '锁定'],
'example' => '0',
],
'OwnerType' => [
@@ -1563,33 +2135,14 @@
.'* 管理员激活类型，管理员设置用户名及用户密码，重置密码等用户通知将发送到管理员的邮箱或手机。'."\n"
.'* 用户激活类型，管理员设置用户名及用户接收通知的邮件或手机，云电脑开通通知（含初始密码）等用户通知将发送到用户的邮件或手机。',
'type' => 'string',
- 'enumValueTitles' => [
- 'CreateFromManager' => '管理员激活',
- 'Normal' => '用户激活',
- ],
+ 'enumValueTitles' => ['CreateFromManager' => '管理员激活', 'Normal' => '用户激活'],
'example' => 'Normal',
],
- 'Remark' => [
- 'description' => '便捷账号的备注。',
- 'type' => 'string',
- 'example' => 'Test user.',
- ],
- 'OrgId' => [
- 'description' => '便捷账号归属的部门ID。'."\n"
- .'> 该参数即将废弃。',
- 'type' => 'string',
- 'example' => 'org-4mdgc1cocc59z****',
- ],
- 'WyId' => [
- 'description' => '便捷账号的全局唯一ID。',
- 'type' => 'string',
- 'example' => '41fd1254d8f7****',
- ],
- 'IsTenantManager' => [
- 'description' => '是否为用户管理员。如果创建的便捷账号是管理员激活类型，则必须指定一位用户管理员，终端用户通过客户端重置密码等通知将发送到该用户管理员的邮箱或手机，详情参见[创建便捷账号](~~214472~~)。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Remark' => ['description' => '便捷账号的备注。', 'type' => 'string', 'example' => 'Test user.'],
+ 'OrgId' => ['description' => '便捷账号归属的部门ID。'."\n"
+ .'> 该参数即将废弃。', 'type' => 'string', 'example' => 'org-4mdgc1cocc59z****'],
+ 'WyId' => ['description' => '便捷账号的全局唯一ID。', 'type' => 'string', 'example' => '41fd1254d8f7****'],
+ 'IsTenantManager' => ['description' => '是否为用户管理员。如果创建的便捷账号是管理员激活类型，则必须指定一位用户管理员，终端用户通过客户端重置密码等通知将发送到该用户管理员的邮箱或手机，详情参见[创建便捷账号](~~214472~~)。', 'type' => 'boolean', 'example' => 'true'],
'Groups' => [
'description' => '便捷账号归属的用户组集合。',
'type' => 'array',
@@ -1597,16 +2150,8 @@
'description' => '便捷账号归属的用户组属性。',
'type' => 'object',
'properties' => [
- 'GroupId' => [
- 'description' => '用户组ID。',
- 'type' => 'string',
- 'example' => 'ug-12341234****',
- ],
- 'GroupName' => [
- 'description' => '用户组名称。',
- 'type' => 'string',
- 'example' => '用户组1',
- ],
+ 'GroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => 'ug-12341234****'],
+ 'GroupName' => ['description' => '用户组名称。', 'type' => 'string', 'example' => '用户组1'],
],
],
],
@@ -1617,51 +2162,21 @@
'description' => '便捷账号归属的部门属性。',
'type' => 'object',
'properties' => [
- 'OrgId' => [
- 'description' => '部门ID。',
- 'type' => 'string',
- 'example' => 'org-4mdgc1cocc59z****',
- ],
- 'OrgName' => [
- 'description' => '部门名称。',
- 'type' => 'string',
- 'example' => '部门1',
- ],
- 'OrgNamePath' => [
- 'type' => 'string',
- ],
+ 'OrgId' => ['description' => '部门ID。', 'type' => 'string', 'example' => 'org-4mdgc1cocc59z****'],
+ 'OrgName' => ['description' => '部门名称。', 'type' => 'string', 'example' => '部门1'],
+ 'OrgNamePath' => ['type' => 'string', 'description' => ''],
],
],
],
- 'Avatar' => [
- 'description' => '用户头像URL。',
- 'type' => 'string',
- 'example' => 'https://cdn.*****',
- ],
- 'Address' => [
- 'description' => '用户工作地址。',
- 'type' => 'string',
- 'example' => '杭州市***',
- ],
- 'NickName' => [
- 'description' => '用户昵称。 '."\n"
- .'按以下顺序取值：'."\n"
- .'- RealNickName'."\n"
- .'- Remark'."\n"
- .'- EndUserId',
- 'type' => 'string',
- 'example' => '李**',
- ],
- 'RealNickName' => [
- 'description' => '用户显示名。',
- 'type' => 'string',
- 'example' => '李**',
- ],
- 'JobNumber' => [
- 'description' => '用户工号。',
- 'type' => 'string',
- 'example' => 'A10000**',
- ],
+ 'Avatar' => ['description' => '用户头像URL。', 'type' => 'string', 'example' => 'https://cdn.*****'],
+ 'Address' => ['description' => '用户工作地址。', 'type' => 'string', 'example' => '杭州市***'],
+ 'NickName' => ['description' => '用户昵称。 '."\n"
+ .'按以下顺序取值：'."\n"
+ .'- RealNickName'."\n"
+ .'- Remark'."\n"
+ .'- EndUserId', 'type' => 'string', 'example' => '李**'],
+ 'RealNickName' => ['description' => '用户显示名。', 'type' => 'string', 'example' => '李**'],
+ 'JobNumber' => ['description' => '用户工号。', 'type' => 'string', 'example' => 'A10000**'],
'Extras' => [
'description' => '用户扩展信息。',
'type' => 'object',
@@ -1669,26 +2184,28 @@
'AssignedResourceCount' => [
'description' => '已分配的云资源个数。',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'any',
- 'example' => 'Desktop: 3',
- 'description' => '支持的云资源类型：'."\n"
- ."\n"
- .'- Desktop：云电脑。'."\n"
- .'- DesktopGroup：共享型云电脑。'."\n"
- .'- CloudDrive：企业网盘（用户个人盘）。'."\n"
- .'- APP：云应用。',
+ 'additionalProperties' => ['type' => 'any', 'example' => 'Desktop: 3', 'description' => '支持的云资源类型：'."\n"
+ ."\n"
+ .'- Desktop：云电脑。'."\n"
+ .'- DesktopGroup：共享型云电脑。'."\n"
+ .'- CloudDrive：企业网盘（用户个人盘）。'."\n"
+ .'- APP：云应用。'],
+ ],
+ 'ResourcePolicyList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PolicyId' => ['type' => 'string'],
+ 'PolicyName' => ['type' => 'string'],
+ ],
],
],
],
],
- 'ExternalName' => [
- 'description' => '外部导入的用户名称。'."\n"
- ."\n"
- .'> 该字段暂未对外开放使用。',
- 'type' => 'string',
- 'example' => '马**',
- ],
+ 'ExternalName' => ['description' => '外部导入的用户名称。'."\n"
+ ."\n"
+ .'> 该字段暂未对外开放使用。', 'type' => 'string', 'example' => '马**'],
'Properties' => [
'description' => '用户属性。',
'type' => 'array',
@@ -1696,32 +2213,14 @@
'description' => '属性列表。',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => '属性名。',
- 'type' => 'string',
- 'example' => 'Role',
- ],
- 'Value' => [
- 'description' => '属性值。',
- 'type' => 'string',
- 'example' => 'Student',
- ],
+ 'Key' => ['description' => '属性名。', 'type' => 'string', 'example' => 'Role'],
+ 'Value' => ['description' => '属性值。', 'type' => 'string', 'example' => 'Student'],
],
],
],
- 'EnableAdminAccess' => [
- 'title' => '启用管理员访问权限',
- 'description' => '启用管理员访问权限',
- 'type' => 'boolean',
- ],
- 'PasswordExpireDays' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'PasswordExpireRestDays' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'EnableAdminAccess' => ['title' => '启用管理员访问权限', 'description' => '启用管理员访问权限', 'type' => 'boolean'],
+ 'PasswordExpireDays' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ 'PasswordExpireRestDays' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
],
],
],
@@ -1729,21 +2228,57 @@
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Users\\": [\\n {\\n \\"Id\\": 0,\\n \\"EndUserId\\": \\"alice\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Status\\": 0,\\n \\"OwnerType\\": \\"Normal\\",\\n \\"Remark\\": \\"Test user.\\",\\n \\"OrgId\\": \\"org-4mdgc1cocc59z****\\",\\n \\"WyId\\": \\"41fd1254d8f7****\\",\\n \\"IsTenantManager\\": true,\\n \\"Groups\\": [\\n {\\n \\"GroupId\\": \\"ug-12341234****\\",\\n \\"GroupName\\": \\"用户组1\\"\\n }\\n ],\\n \\"Orgs\\": [\\n {\\n \\"OrgId\\": \\"org-4mdgc1cocc59z****\\",\\n \\"OrgName\\": \\"部门1\\",\\n \\"OrgNamePath\\": \\"\\"\\n }\\n ],\\n \\"Avatar\\": \\"https://cdn.*****\\",\\n \\"Address\\": \\"杭州市***\\",\\n \\"NickName\\": \\"李**\\",\\n \\"RealNickName\\": \\"李**\\",\\n \\"JobNumber\\": \\"A10000**\\",\\n \\"Extras\\": {\\n \\"AssignedResourceCount\\": {\\n \\"key\\": \\"Desktop: 3\\"\\n }\\n },\\n \\"ExternalName\\": \\"马**\\",\\n \\"Properties\\": [\\n {\\n \\"Key\\": \\"Role\\",\\n \\"Value\\": \\"Student\\"\\n }\\n ],\\n \\"EnableAdminAccess\\": true,\\n \\"PasswordExpireDays\\": 0,\\n \\"PasswordExpireRestDays\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeUsersResponse>\\n <RequestId>BA75EDC9-8A5F-40C2-ABD5-EBAE56A4D67C</RequestId>\\n <Users>\\n <Status>0</Status>\\n <Email>test1@example***.com</Email>\\n <EndUserId>test1</EndUserId>\\n <Id>12345</Id>\\n </Users>\\n</DescribeUsersResponse>","errorExample":""}]',
'title' => '查询便捷账号信息',
+ 'summary' => '查询便捷账号信息，例如用户名、邮箱地址、备注名称等。',
'requestParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-11-27T07:00:44.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-10-20T04:15:55.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-07-30T14:09:42.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-06-07T08:23:01.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-04-01T11:55:24.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-02-27T12:03:51.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-01-02T11:15:32.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-09-24T06:53:53.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-09-24T06:16:51.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T11:27:16.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-01-24T10:00:50.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2023-12-11T13:20:38.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2023-09-23T23:11:19.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2023-08-06T01:47:45.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-09-08T12:07:49.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2021-08-12T08:48:31.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-08-12T08:48:31.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-04-23T06:50:16.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-04-23T06:50:16.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-04-02T06:14:21.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUsers'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Users\\": [\\n {\\n \\"Id\\": 0,\\n \\"EndUserId\\": \\"alice\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Status\\": 0,\\n \\"OwnerType\\": \\"Normal\\",\\n \\"Remark\\": \\"Test user.\\",\\n \\"OrgId\\": \\"org-4mdgc1cocc59z****\\",\\n \\"WyId\\": \\"41fd1254d8f7****\\",\\n \\"IsTenantManager\\": true,\\n \\"Groups\\": [\\n {\\n \\"GroupId\\": \\"ug-12341234****\\",\\n \\"GroupName\\": \\"用户组1\\"\\n }\\n ],\\n \\"Orgs\\": [\\n {\\n \\"OrgId\\": \\"org-4mdgc1cocc59z****\\",\\n \\"OrgName\\": \\"部门1\\",\\n \\"OrgNamePath\\": \\"\\"\\n }\\n ],\\n \\"Avatar\\": \\"https://cdn.*****\\",\\n \\"Address\\": \\"杭州市***\\",\\n \\"NickName\\": \\"李**\\",\\n \\"RealNickName\\": \\"李**\\",\\n \\"JobNumber\\": \\"A10000**\\",\\n \\"Extras\\": {\\n \\"AssignedResourceCount\\": {\\n \\"key\\": \\"Desktop: 3\\"\\n },\\n \\"ResourcePolicyList\\": [\\n {\\n \\"PolicyId\\": \\"\\",\\n \\"PolicyName\\": \\"\\"\\n }\\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":""}]',
],
'FilterUsers' => [
'summary' => '按用户属性筛选查询便捷账号信息。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1756,44 +2291,24 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '36913',
- 'abilityTreeNodes' => [
- 'FEATUREgwsZABQI3',
- ],
+ 'abilityTreeNodes' => ['FEATUREgwsZABQI3'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页行数（大于100时会自动重置为100）。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '200',
- 'minimum' => '1',
- 'example' => '10',
- ],
+ 'schema' => ['description' => '分页查询时每页行数（大于100时会自动重置为100）。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => '下一次查询的Token。首次调用接口时无需设置该参数。如果一次查询结果并没有完整返回所有的结果，则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'caeba0bbb2be03f84eb48b699f0a****',
- ],
+ 'schema' => ['description' => '下一次查询的Token。首次调用接口时无需设置该参数。如果一次查询结果并没有完整返回所有的结果，则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a****'],
],
[
'name' => 'Filter',
'in' => 'query',
- 'schema' => [
- 'description' => '模糊搜索字符串，支持匹配用户名（EndUserId）和邮箱（Email）。该字段支持使用通配符（\\*），例如将该字段设为a*m，则返回用户名或邮箱以a开头、以m结尾的所有结果。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a*m',
- ],
+ 'schema' => ['description' => '模糊搜索字符串，支持匹配用户名（EndUserId）和邮箱（Email）。该字段支持使用通配符（\\*），例如将该字段设为a*m，则返回用户名或邮箱以a开头、以m结尾的所有结果。', 'type' => 'string', 'required' => false, 'example' => 'a*m'],
],
[
'name' => 'PropertyFilterParam',
@@ -1806,20 +2321,8 @@
'description' => '要模糊查询的用户属性。',
'type' => 'object',
'properties' => [
- 'PropertyId' => [
- 'description' => '属性ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '328',
- ],
- 'PropertyValueIds' => [
- 'description' => '属性值ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1255',
- 'maxItems' => 100,
- ],
+ 'PropertyId' => ['description' => '属性ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '328'],
+ 'PropertyValueIds' => ['description' => '属性值ID。', 'type' => 'string', 'required' => false, 'example' => '1255', 'maxItems' => 100],
],
'required' => false,
],
@@ -1838,19 +2341,8 @@
'description' => '属性名和属性值信息。',
'type' => 'object',
'properties' => [
- 'PropertyKey' => [
- 'description' => '属性名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'job',
- ],
- 'PropertyValues' => [
- 'description' => '属性值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'dev',
- 'maxItems' => 100,
- ],
+ 'PropertyKey' => ['description' => '属性名。', 'type' => 'string', 'required' => false, 'example' => 'job'],
+ 'PropertyValues' => ['description' => '属性值。', 'type' => 'string', 'required' => false, 'example' => 'dev', 'maxItems' => 100],
],
'required' => false,
],
@@ -1865,10 +2357,7 @@
'description' => '是否返回已分配给该用户的云电脑数量。',
'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 'true' => '返回分配的云电脑数量',
- 'false' => '不返回分配的云电脑数量',
- ],
+ 'enumValueTitles' => ['true' => '返回分配的云电脑数量', 'false' => '不返回分配的云电脑数量'],
'example' => 'true',
],
],
@@ -1879,22 +2368,14 @@
'description' => '是否返回已分配给该用户的云电脑池数量。',
'type' => 'boolean',
'required' => false,
- 'enumValueTitles' => [
- 'true' => '返回分配的云电脑池数量',
- 'false' => '不返回分配的云电脑池数量',
- ],
+ 'enumValueTitles' => ['true' => '返回分配的云电脑池数量', 'false' => '不返回分配的云电脑池数量'],
'example' => 'false',
],
],
[
'name' => 'OrgId',
'in' => 'query',
- 'schema' => [
- 'description' => '企业组织ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'org-aliyun-wy-org-id',
- ],
+ 'schema' => ['description' => '企业组织ID。', 'type' => 'string', 'required' => false, 'example' => 'org-aliyun-wy-org-id'],
],
[
'name' => 'OwnerType',
@@ -1903,10 +2384,7 @@
'description' => '账号激活类型。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'CreateFromManager' => '管理员激活',
- 'Normal' => '用户激活',
- ],
+ 'enumValueTitles' => ['CreateFromManager' => '管理员激活', 'Normal' => '用户激活'],
'example' => 'Normal',
],
],
@@ -1916,11 +2394,7 @@
'style' => 'repeatList',
'schema' => [
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'required' => false,
+ 'items' => ['type' => 'string'],
'maxItems' => 500,
],
],
@@ -1931,12 +2405,7 @@
'schema' => [
'description' => '需精确排除的用户名（EndUserId）列表。',
'type' => 'array',
- 'items' => [
- 'description' => '按用户名（EndUserId）精确排除，查询不包含该用户名的用户列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tony',
- ],
+ 'items' => ['description' => '按用户名（EndUserId）精确排除，查询不包含该用户名的用户列表。', 'type' => 'string', 'required' => false, 'example' => 'tony'],
'required' => false,
'maxItems' => 2000,
],
@@ -1953,21 +2422,14 @@
'description' => '按此参数排序。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'EndUserId' => '用户名',
- 'id' => '用户主键ID',
- 'gmt_created' => '创建时间',
- ],
+ 'enumValueTitles' => ['EndUserId' => '用户名', 'id' => '用户主键ID', 'gmt_created' => '创建时间'],
'example' => 'id',
],
'OrderType' => [
'description' => '升序或降序。',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'ASC' => '升序',
- 'DESC' => '降序 [默认值]',
- ],
+ 'enumValueTitles' => ['ASC' => '升序', 'DESC' => '降序 [默认值]'],
'example' => 'DESC',
],
],
@@ -1983,54 +2445,29 @@
'type' => 'integer',
'format' => 'int32',
'required' => false,
- 'enumValueTitles' => [
- '正常状态',
- 11 => '已离职',
- ],
+ 'enumValueTitles' => ['正常状态', 11 => '已离职'],
'example' => '0',
],
],
[
'name' => 'IsQueryAllSubOrgs',
'in' => 'query',
- 'schema' => [
- 'title' => '是否查询所有子组织',
- 'description' => '是否查询所有子组织',
- 'type' => 'boolean',
- 'required' => false,
- ],
+ 'schema' => ['title' => '是否查询所有子组织', 'description' => '是否查询所有子组织', 'type' => 'boolean', 'required' => false],
],
[
'name' => 'IncludeOrgInfo',
'in' => 'query',
- 'schema' => [
- 'title' => '是否包含组织信息',
- 'description' => '是否包含组织信息',
- 'type' => 'boolean',
- 'required' => false,
- ],
+ 'schema' => ['title' => '是否包含组织信息', 'description' => '是否包含组织信息', 'type' => 'boolean', 'required' => false],
],
[
'name' => 'IncludeSupportIdps',
'in' => 'query',
- 'schema' => [
- 'title' => '包含支持的登录类型',
- 'description' => '包含支持的登录类型',
- 'type' => 'boolean',
- 'required' => false,
- ],
+ 'schema' => ['title' => '包含支持的登录类型', 'description' => '包含支持的登录类型', 'type' => 'boolean', 'required' => false],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
[
'name' => 'FilterMap',
@@ -2038,10 +2475,16 @@
'style' => 'json',
'schema' => [
'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- ],
+ 'additionalProperties' => ['type' => 'string'],
+ ],
+ ],
+ [
+ 'name' => 'ShowExtras',
+ 'in' => 'query',
+ 'style' => 'flat',
+ 'schema' => [
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string'],
],
],
],
@@ -2052,17 +2495,8 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'NextToken' => [
- 'description' => '下一次查询的Token。如果一次查询结果并没有完整返回所有的结果，则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。',
- 'type' => 'string',
- 'example' => 'caeba0bbb2be03f84eb48b699f0a****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'NextToken' => ['description' => '下一次查询的Token。如果一次查询结果并没有完整返回所有的结果，则返回的NextToken不为空。您可以在查询中上传返回的NextToken继续查询。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a****'],
'Users' => [
'title' => 'users',
'description' => '便捷账号信息集合。',
@@ -2071,36 +2505,15 @@
'description' => '便捷账号信息。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'description' => '用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4205**',
- ],
- 'EndUserId' => [
- 'description' => '用户名。',
- 'type' => 'string',
- 'example' => 'alice',
- ],
- 'Email' => [
- 'description' => '邮箱。',
- 'type' => 'string',
- 'example' => 'username@example.com',
- ],
- 'Phone' => [
- 'description' => '手机号。',
- 'type' => 'string',
- 'example' => '1381111****',
- ],
+ 'Id' => ['description' => '用户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '4205**'],
+ 'EndUserId' => ['description' => '用户名。', 'type' => 'string', 'example' => 'alice'],
+ 'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'username@example.com'],
+ 'Phone' => ['description' => '手机号。', 'type' => 'string', 'example' => '1381111****'],
'Status' => [
'description' => '便捷账号的状态。',
'type' => 'integer',
'format' => 'int64',
- 'enumValueTitles' => [
- '正常',
- 9 => '锁定',
- 11 => '已离职',
- ],
+ 'enumValueTitles' => ['正常', 9 => '锁定', 11 => '已离职'],
'example' => '0',
],
'UserSetPropertiesModels' => [
@@ -2110,34 +2523,11 @@
'description' => '用户属性。',
'type' => 'object',
'properties' => [
- 'UserId' => [
- 'description' => '绑定属性的用户ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4205**',
- ],
- 'UserName' => [
- 'description' => '绑定属性的用户名。',
- 'type' => 'string',
- 'example' => 'alice',
- ],
- 'PropertyId' => [
- 'description' => '用户属性ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'PropertyKey' => [
- 'description' => '用户属性名称。',
- 'type' => 'string',
- 'example' => 'department',
- ],
- 'PropertyType' => [
- 'description' => '用户属性编号。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
+ 'UserId' => ['description' => '绑定属性的用户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '4205**'],
+ 'UserName' => ['description' => '绑定属性的用户名。', 'type' => 'string', 'example' => 'alice'],
+ 'PropertyId' => ['description' => '用户属性ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
+ 'PropertyKey' => ['description' => '用户属性名称。', 'type' => 'string', 'example' => 'department'],
+ 'PropertyType' => ['description' => '用户属性编号。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'PropertyValues' => [
'description' => '用户属性值。',
'type' => 'array',
@@ -2145,107 +2535,49 @@
'description' => '用户属性值。',
'type' => 'object',
'properties' => [
- 'PropertyValueId' => [
- 'description' => '用户属性值ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '42',
- ],
- 'PropertyValue' => [
- 'description' => '用户属性值。',
- 'type' => 'string',
- 'example' => 'dev',
- ],
+ 'PropertyValueId' => ['description' => '用户属性值ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '42'],
+ 'PropertyValue' => ['description' => '用户属性值。', 'type' => 'string', 'example' => 'dev'],
],
],
],
],
],
],
- 'DesktopCount' => [
- 'description' => '分配给该用户的云电脑数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'DesktopCount' => ['description' => '分配给该用户的云电脑数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ExternalInfo' => [
'description' => '用户扩展信息。',
'type' => 'object',
'properties' => [
- 'ExternalName' => [
- 'description' => '用户对接的账号名称。',
- 'type' => 'string',
- 'example' => 'account',
- ],
- 'JobNumber' => [
- 'description' => '用户对接的账号、学号或工号。',
- 'type' => 'string',
- 'example' => '030801',
- ],
+ 'ExternalName' => ['description' => '用户对接的账号名称。', 'type' => 'string', 'example' => 'account'],
+ 'JobNumber' => ['description' => '用户对接的账号、学号或工号。', 'type' => 'string', 'example' => '030801'],
],
],
- 'DesktopGroupCount' => [
- 'description' => '用户拥有授权的云电脑池数量。当`IncludeDesktopGroupCount`取值为`true`时，返回该值。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
+ 'DesktopGroupCount' => ['description' => '用户拥有授权的云电脑池数量。当`IncludeDesktopGroupCount`取值为`true`时，返回该值。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'OwnerType' => [
'description' => '账号归属类型。',
'type' => 'string',
- 'enumValueTitles' => [
- 'CreateFromManager' => '管理员激活',
- 'Normal' => '用户激活',
- ],
+ 'enumValueTitles' => ['CreateFromManager' => '管理员激活', 'Normal' => '用户激活'],
'example' => 'Normal',
],
- 'Remark' => [
- 'description' => '用户备注。',
- 'type' => 'string',
- 'example' => '测试专用',
- ],
+ 'Remark' => ['description' => '用户备注。', 'type' => 'string', 'example' => '测试专用'],
'IsTenantManager' => [
'description' => '是否租户管理员。',
'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '是',
- 'false' => '否',
- ],
+ 'enumValueTitles' => ['true' => '是', 'false' => '否'],
'example' => 'true',
],
'EnableAdminAccess' => [
'description' => '是否本地管理员。',
'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => '是',
- 'false' => '否',
- ],
+ 'enumValueTitles' => ['true' => '是', 'false' => '否'],
'example' => 'true',
],
- 'RealNickName' => [
- 'description' => '用户昵称。',
- 'type' => 'string',
- 'example' => '小明',
- ],
- 'AutoLockTime' => [
- 'description' => '自动锁定账号的日期。',
- 'type' => 'string',
- 'example' => '2023-03-03',
- ],
- 'PasswordExpireDays' => [
- 'description' => '用户账号的密码默认为永久有效，可通过此参数设置30\\~365天的密码有效期，当密码到期后，终端用户必须先修改密码才能继续登录。'."\n"
- ."\n"
- .'> 该功能目前处于邀测中，如需体验，请提交工单申请开通。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'PasswordExpireRestDays' => [
- 'description' => '账号密码有效期的剩余天数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'RealNickName' => ['description' => '用户昵称。', 'type' => 'string', 'example' => '小明'],
+ 'AutoLockTime' => ['description' => '自动锁定账号的日期。', 'type' => 'string', 'example' => '2023-03-03'],
+ 'PasswordExpireDays' => ['description' => '用户账号的密码默认为永久有效，可通过此参数设置30\\~365天的密码有效期，当密码到期后，终端用户必须先修改密码才能继续登录。'."\n"
+ ."\n"
+ .'> 该功能目前处于邀测中，如需体验，请提交工单申请开通。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'PasswordExpireRestDays' => ['description' => '账号密码有效期的剩余天数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'OrgList' => [
'title' => '用户所属组织列表',
'description' => '用户所属组织列表',
@@ -2255,21 +2587,9 @@
'description' => '用户所属组织列表',
'type' => 'object',
'properties' => [
- 'OrgId' => [
- 'title' => '组织结构ID',
- 'description' => '组织结构ID',
- 'type' => 'string',
- ],
- 'OrgName' => [
- 'title' => '组织结构名称',
- 'description' => '组织结构名称',
- 'type' => 'string',
- ],
- 'OrgNamePath' => [
- 'title' => '组织结构名称路径',
- 'description' => '组织结构名称路径',
- 'type' => 'string',
- ],
+ 'OrgId' => ['title' => '组织结构ID', 'description' => '组织结构ID', 'type' => 'string'],
+ 'OrgName' => ['title' => '组织结构名称', 'description' => '组织结构名称', 'type' => 'string'],
+ 'OrgNamePath' => ['title' => '组织结构名称路径', 'description' => '组织结构名称路径', 'type' => 'string'],
],
],
],
@@ -2282,16 +2602,8 @@
'description' => '支持的登录身份源方式',
'type' => 'object',
'properties' => [
- 'IdpId' => [
- 'title' => '企业身份源ID',
- 'description' => '企业身份源ID',
- 'type' => 'string',
- ],
- 'IdpName' => [
- 'title' => '企业身份源名称',
- 'description' => '企业身份源名称',
- 'type' => 'string',
- ],
+ 'IdpId' => ['title' => '企业身份源ID', 'description' => '企业身份源ID', 'type' => 'string'],
+ 'IdpName' => ['title' => '企业身份源名称', 'description' => '企业身份源名称', 'type' => 'string'],
],
],
],
@@ -2300,12 +2612,20 @@
'items' => [
'type' => 'object',
'properties' => [
- 'GroupId' => [
- 'type' => 'string',
- ],
- 'GroupName' => [
- 'type' => 'string',
- ],
+ 'GroupId' => ['type' => 'string', 'description' => ''],
+ 'GroupName' => ['type' => 'string', 'description' => ''],
+ ],
+ 'description' => '',
+ ],
+ 'description' => '',
+ ],
+ 'ResourcePolicyList' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'PolicyId' => ['type' => 'string'],
+ 'PolicyName' => ['type' => 'string'],
],
],
],
@@ -2316,42 +2636,63 @@
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"Users\\": [\\n {\\n \\"Id\\": 0,\\n \\"EndUserId\\": \\"alice\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Status\\": 0,\\n \\"UserSetPropertiesModels\\": [\\n {\\n \\"UserId\\": 0,\\n \\"UserName\\": \\"alice\\",\\n \\"PropertyId\\": 12,\\n \\"PropertyKey\\": \\"department\\",\\n \\"PropertyType\\": 2,\\n \\"PropertyValues\\": [\\n {\\n \\"PropertyValueId\\": 42,\\n \\"PropertyValue\\": \\"dev\\"\\n }\\n ]\\n }\\n ],\\n \\"DesktopCount\\": 1,\\n \\"ExternalInfo\\": {\\n \\"ExternalName\\": \\"account\\",\\n \\"JobNumber\\": \\"030801\\"\\n },\\n \\"DesktopGroupCount\\": 2,\\n \\"OwnerType\\": \\"Normal\\",\\n \\"Remark\\": \\"测试专用\\",\\n \\"IsTenantManager\\": true,\\n \\"EnableAdminAccess\\": true,\\n \\"RealNickName\\": \\"小明\\",\\n \\"AutoLockTime\\": \\"2023-03-03\\",\\n \\"PasswordExpireDays\\": 30,\\n \\"PasswordExpireRestDays\\": 10,\\n \\"OrgList\\": [\\n {\\n \\"OrgId\\": \\"\\",\\n \\"OrgName\\": \\"\\",\\n \\"OrgNamePath\\": \\"\\"\\n }\\n ],\\n \\"SupportLoginIdps\\": [\\n {\\n \\"IdpId\\": \\"\\",\\n \\"IdpName\\": \\"\\"\\n }\\n ],\\n \\"Groups\\": [\\n {\\n \\"GroupId\\": \\"\\",\\n \\"GroupName\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<FilterUsersResponse>\\n <RequestId>DBD276B5-00FF-5E04-8EF7-5CBA09BF112A</RequestId>\\n <Users>\\n <Status>0</Status>\\n <EndUserId>testName</EndUserId>\\n <Email>testName@example.com</Email>\\n <Phone/>\\n <Id>12345</Id>\\n <UserSetPropertiesModels>\\n <PropertyValues>\\n <PropertyValueId>184</PropertyValueId>\\n <PropertyValue>true</PropertyValue>\\n </PropertyValues>\\n <UserId>12345</UserId>\\n <PropertyType>1</PropertyType>\\n <PropertyKey>enableAdminAccess</PropertyKey>\\n <PropertyId>145</PropertyId>\\n </UserSetPropertiesModels>\\n <UserSetPropertiesModels>\\n <PropertyValues>\\n <PropertyValueId>42</PropertyValueId>\\n <PropertyValue>A</PropertyValue>\\n </PropertyValues>\\n <UserId>12345</UserId>\\n <PropertyType>2</PropertyType>\\n <PropertyKey>department</PropertyKey>\\n <PropertyId>30</PropertyId>\\n </UserSetPropertiesModels>\\n </Users>\\n</FilterUsersResponse>","errorExample":""}]',
'title' => '筛选查询便捷账号信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-11-27T07:00:44.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-10-20T04:15:55.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-06-07T08:23:01.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-03-24T09:53:19.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-12-11T07:38:32.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-08-15T11:59:41.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-04-09T12:00:07.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2023-10-25T11:42:59.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-12-05T05:02:35.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-09-08T12:07:49.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FilterUsers'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:FilterUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"Users\\": [\\n {\\n \\"Id\\": 0,\\n \\"EndUserId\\": \\"alice\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Status\\": 0,\\n \\"UserSetPropertiesModels\\": [\\n {\\n \\"UserId\\": 0,\\n \\"UserName\\": \\"alice\\",\\n \\"PropertyId\\": 12,\\n \\"PropertyKey\\": \\"department\\",\\n \\"PropertyType\\": 2,\\n \\"PropertyValues\\": [\\n {\\n \\"PropertyValueId\\": 42,\\n \\"PropertyValue\\": \\"dev\\"\\n }\\n ]\\n }\\n ],\\n \\"DesktopCount\\": 1,\\n \\"ExternalInfo\\": {\\n \\"ExternalName\\": \\"account\\",\\n \\"JobNumber\\": \\"030801\\"\\n },\\n \\"DesktopGroupCount\\": 2,\\n \\"OwnerType\\": \\"Normal\\",\\n \\"Remark\\": \\"测试专用\\",\\n \\"IsTenantManager\\": true,\\n \\"EnableAdminAccess\\": true,\\n \\"RealNickName\\": \\"小明\\",\\n \\"AutoLockTime\\": \\"2023-03-03\\",\\n \\"PasswordExpireDays\\": 30,\\n \\"PasswordExpireRestDays\\": 10,\\n \\"OrgList\\": [\\n {\\n \\"OrgId\\": \\"\\",\\n \\"OrgName\\": \\"\\",\\n \\"OrgNamePath\\": \\"\\"\\n }\\n ],\\n \\"SupportLoginIdps\\": [\\n {\\n \\"IdpId\\": \\"\\",\\n \\"IdpName\\": \\"\\"\\n }\\n ],\\n \\"Groups\\": [\\n {\\n \\"GroupId\\": \\"\\",\\n \\"GroupName\\": \\"\\"\\n }\\n ],\\n \\"ResourcePolicyList\\": [\\n {\\n \\"PolicyId\\": \\"\\",\\n \\"PolicyName\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<FilterUsersResponse>\\n <RequestId>DBD276B5-00FF-5E04-8EF7-5CBA09BF112A</RequestId>\\n <Users>\\n <Status>0</Status>\\n <EndUserId>testName</EndUserId>\\n <Email>testName@example.com</Email>\\n <Phone/>\\n <Id>12345</Id>\\n <UserSetPropertiesModels>\\n <PropertyValues>\\n <PropertyValueId>184</PropertyValueId>\\n <PropertyValue>true</PropertyValue>\\n </PropertyValues>\\n <UserId>12345</UserId>\\n <PropertyType>1</PropertyType>\\n <PropertyKey>enableAdminAccess</PropertyKey>\\n <PropertyId>145</PropertyId>\\n </UserSetPropertiesModels>\\n <UserSetPropertiesModels>\\n <PropertyValues>\\n <PropertyValueId>42</PropertyValueId>\\n <PropertyValue>A</PropertyValue>\\n </PropertyValues>\\n <UserId>12345</UserId>\\n <PropertyType>2</PropertyType>\\n <PropertyKey>department</PropertyKey>\\n <PropertyId>30</PropertyId>\\n </UserSetPropertiesModels>\\n </Users>\\n</FilterUsersResponse>","errorExample":""}]',
],
'GetManagerInfoByAuthCode' => [
'summary' => '根据authcode获取当前登录的管理员信息。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'AuthCode',
'in' => 'query',
- 'schema' => [
- 'title' => '授权码',
- 'description' => '授权码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'e49cd070452f0044813a467d4743****',
- ],
+ 'schema' => ['title' => '授权码', 'description' => '授权码。', 'type' => 'string', 'required' => true, 'example' => 'e49cd070452f0044813a467d4743****'],
],
],
'responses' => [
@@ -2361,465 +2702,41 @@
'description' => '响应结果。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'WaId' => [
- 'title' => '租户无影账号ID',
- 'description' => '租户无影账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12345678901234****',
- ],
- 'OrgId' => [
- 'title' => '组织ID',
- 'description' => '组织ID。',
- 'type' => 'string',
- 'example' => '12345678901234****',
- ],
- 'UserName' => [
- 'title' => '租户名称',
- 'description' => '租户名称。',
- 'type' => 'string',
- 'example' => 'zhangsan',
- ],
- 'Phone' => [
- 'title' => '手机号',
- 'description' => '手机号。',
- 'type' => 'string',
- 'example' => '1301234****',
- ],
- 'TeamName' => [
- 'title' => '团队名称',
- 'description' => '团队名称。',
- 'type' => 'string',
- 'example' => 'devteam',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'WaId' => ['title' => '租户无影账号ID', 'description' => '租户无影账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '12345678901234****'],
+ 'OrgId' => ['title' => '组织ID', 'description' => '组织ID。', 'type' => 'string', 'example' => '12345678901234****'],
+ 'UserName' => ['title' => '租户名称', 'description' => '租户名称。', 'type' => 'string', 'example' => 'zhangsan'],
+ 'Phone' => ['title' => '手机号', 'description' => '手机号。', 'type' => 'string', 'example' => '1301234****'],
+ 'TeamName' => ['title' => '团队名称', 'description' => '团队名称。', 'type' => 'string', 'example' => 'devteam'],
],
],
],
[],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"WaId\\": 0,\\n \\"OrgId\\": \\"12345678901234****\\",\\n \\"UserName\\": \\"zhangsan\\",\\n \\"Phone\\": \\"1301234****\\",\\n \\"TeamName\\": \\"devteam\\"\\n}","type":"json"}]',
'title' => '根据authcode获取当前登录的管理员信息',
- ],
- 'BatchSetDesktopManager' => [
- 'summary' => '为便捷账号添加或者去除云电脑的本地管理员权限。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'Users',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '便捷账号列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '便捷账号。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'alice',
- ],
- 'required' => true,
- 'maxItems' => 500,
- ],
- ],
- [
- 'name' => 'IsDesktopManager',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '该便捷账号是否具备云电脑的本地管理员权限。',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- '否',
- '是 [默认值]',
- ],
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'BusinessChannel',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '868B8926-2E7A-5BE7-9897-E811E994****',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\"\\n}","type":"json"}]',
- 'title' => '为便捷账号添加或去除本地管理员权限',
- 'description' => '获得本地管理员权限的便捷账号可以在云电脑中自行安装软件，或者修改某些系统设置。',
- ],
- 'CreateProperty' => [
- 'summary' => '创建一个用户属性。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'PropertyKey',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '属性名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'department',
- ],
- ],
- [
- 'name' => 'PropertyValues',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '属性值。一个属性下最多可以添加50个不同的属性值。',
- 'type' => 'array',
- 'items' => [
- 'description' => '属性值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'HR',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:GetManagerInfoByAuthCode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
- 'maxItems' => 100,
- ],
- ],
- [
- 'name' => 'BusinessChannel',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回信息集合。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'CreateResult' => [
- 'description' => '创建结果。',
- 'type' => 'object',
- 'properties' => [
- 'PropertyId' => [
- 'description' => '属性ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '390',
- ],
- 'PropertyKey' => [
- 'description' => '属性名。',
- 'type' => 'string',
- 'example' => 'department',
- ],
- 'SavePropertyValueModel' => [
- 'description' => '属性值创建结果。',
- 'type' => 'object',
- 'properties' => [
- 'SavePropertyValues' => [
- 'description' => '创建成功的属性值。',
- 'type' => 'array',
- 'items' => [
- 'description' => '创建成功的属性值。',
- 'type' => 'object',
- 'properties' => [
- 'PropertyValueId' => [
- 'description' => '属性值ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '978',
- ],
- 'PropertyValue' => [
- 'description' => '属性值。',
- 'type' => 'string',
- 'example' => 'HR',
- ],
- ],
- ],
- ],
- 'FailedPropertyValues' => [
- 'description' => '创建失败的属性值。',
- 'type' => 'array',
- 'items' => [
- 'description' => '修改失败的属性值。',
- 'type' => 'object',
- 'properties' => [
- 'PropertyId' => [
- 'description' => '属性值ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '390',
- ],
- 'PropertyValue' => [
- 'description' => '属性值。',
- 'type' => 'string',
- 'example' => 'HR',
- ],
- 'ErrorCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'ExistedPropertyValue',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'The property value is used by another property.',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"CreateResult\\": {\\n \\"PropertyId\\": 390,\\n \\"PropertyKey\\": \\"department\\",\\n \\"SavePropertyValueModel\\": {\\n \\"SavePropertyValues\\": [\\n {\\n \\"PropertyValueId\\": 978,\\n \\"PropertyValue\\": \\"HR\\"\\n }\\n ],\\n \\"FailedPropertyValues\\": [\\n {\\n \\"PropertyId\\": 390,\\n \\"PropertyValue\\": \\"HR\\",\\n \\"ErrorCode\\": \\"ExistedPropertyValue\\",\\n \\"ErrorMessage\\": \\"The property value is used by another property.\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<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' => '创建用户自定义属性',
- 'description' => '- 一个阿里云账号下最多可以创建10个不同的属性。每个属性包括一个属性名（PropertyKey）和多个属性值（PropertyValue）。'."\n"
- .'- 一个属性下最多可以添加50个不同的属性值。',
- ],
- 'RemoveProperty' => [
- 'summary' => '删除一组用户属性。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
- 'parameters' => [
- [
- 'name' => 'PropertyId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '属性ID。您可以调用[ListProperty](~~410890~~)进行查询。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '390',
- ],
- ],
- [
- 'name' => 'BusinessChannel',
- 'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回信息集合。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<RemovePropertyResponse>\\n <RequestId>D6C62E40-F937-5803-B008-92E813399BA5</RequestId>\\n</RemovePropertyResponse>","errorExample":""}]',
- 'title' => '删除用户自定义属性',
- ],
- 'DeleteUserPropertyValue' => [
- 'summary' => '解除一个用户与某个用户属性的绑定关系。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'UserId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '用户ID。可以调用[DescribeUsers](~~DescribeUsers~~)获取该参数，对应返回参数`Id`的值。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '123',
- ],
- ],
- [
- 'name' => 'PropertyId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '属性ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '390',
- ],
- ],
- [
- 'name' => 'PropertyValueId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '属性值ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '978',
- ],
- ],
- [
- 'name' => 'BusinessChannel',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回信息集合。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'D6C62E40-F937-5803-B008-92E813399BA5',
- ],
- ],
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6C62E40-F937-5803-B008-92E813399BA5\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteUserPropertyValueResponse>\\n <RequestId>D6C62E40-F937-5803-B008-92E813399BA5</RequestId>\\n</DeleteUserPropertyValueResponse>","errorExample":""}]',
- 'title' => '为用户移除自定义属性',
+ '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"}]',
],
- 'UpdateProperty' => [
- 'summary' => '修改用户属性。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'InitTenantAlias' => [
+ 'summary' => '初始化组织ID。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2827,77 +2744,12 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
- 'name' => 'PropertyId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '要修改的属性ID。您可以调用[ListProperty](~~ListProperty~~)进行查询。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '390',
- ],
- ],
- [
- 'name' => 'PropertyKey',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '修改后的属性名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'testkey',
- ],
- ],
- [
- 'name' => 'PropertyValues',
- 'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '修改后该属性的所有属性值列表。'."\n"
- ."\n"
- .'><notice>此处传入的属性值将覆盖原来的属性值，而不是在原有的基础上追加。></notice>',
- 'type' => 'array',
- 'items' => [
- 'description' => '修改后该属性的所有属性值。',
- 'type' => 'object',
- 'properties' => [
- 'PropertyValueId' => [
- 'description' => '修改后该属性的属性值ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '978',
- ],
- 'PropertyValue' => [
- 'description' => '修改后该属性的属性值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testvalue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
- ],
- [
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -2907,203 +2759,52 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'UpdateResult' => [
- 'description' => '修改结果。',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'Data' => ['description' => '生成的组织ID。', 'type' => 'string', 'example' => 'WY23***'],
+ 'AliasInfo' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'PropertyId' => [
- 'description' => '属性ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '390',
- ],
- 'PropertyKey' => [
- 'description' => '属性名。',
+ 'AliasSourceType' => [
+ 'description' => '组织ID来源。',
'type' => 'string',
- 'example' => 'testkey2',
- ],
- 'SavePropertyValueModel' => [
- 'description' => '属性值修改结果。',
- 'type' => 'object',
- 'properties' => [
- 'SavePropertyValues' => [
- 'description' => '修改成功的属性值。',
- 'type' => 'array',
- 'items' => [
- 'description' => '修改成功的属性值。',
- 'type' => 'object',
- 'properties' => [
- 'PropertyValueId' => [
- 'description' => '属性值ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '978',
- ],
- 'PropertyValue' => [
- 'description' => '属性值。',
- 'type' => 'string',
- 'example' => 'testvalue2',
- ],
- ],
- ],
- ],
- 'FailedPropertyValues' => [
- 'description' => '修改失败的属性值。',
- 'type' => 'array',
- 'items' => [
- 'description' => '修改失败的属性值。',
- 'type' => 'object',
- 'properties' => [
- 'PropertyId' => [
- 'description' => '属性ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '390',
- ],
- 'PropertyValue' => [
- 'description' => '属性值。',
- 'type' => 'string',
- 'example' => 'testvalue',
- ],
- 'ErrorCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'ExistedPropertyValue',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'The property value is used by another property.',
- ],
- ],
- ],
- ],
- ],
+ 'enumValueTitles' => ['Generated' => '自动生成', 'Customized' => '用户自定义'],
+ 'example' => 'Customized',
],
+ 'AliasEditable' => ['description' => '是否允许编辑。', 'type' => 'boolean', 'example' => 'False'],
+ 'AliasEditDisabledReason' => ['description' => '不允许编辑的原因。', 'type' => 'string', 'example' => 'FrequencyExceedsLimit'],
+ 'NextModifyTime' => ['description' => '允许编辑的时间。', 'type' => 'string', 'example' => '2025-04-17 20:31:48'],
],
],
],
],
],
],
- 'responseDemo' => '[{"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' => '修改自定义属性',
- ],
- 'SetUserPropertyValue' => [
- 'summary' => '为某个用户关联一个用户属性。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
+ 'title' => '初始化组织ID',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => '请求参数发生变更'],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'parameters' => [
- [
- 'name' => 'UserId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '用户ID。可以调用[DescribeUsers](~~DescribeUsers~~)获取该参数，对应返回参数`Id`的值。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '111****',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'UserName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '用户名。可以调用[DescribeUsers](~~DescribeUsers~~)获取该参数，对应返回参数`EndUserId`的值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'alice',
- ],
- ],
- [
- 'name' => 'PropertyId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '属性ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '240**',
- ],
- ],
- [
- 'name' => 'PropertyValueId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '属性值ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '2251**',
- ],
- ],
- [
- 'name' => 'BusinessChannel',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回信息集合。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ecd:InitTenantAlias',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetUserPropertyValueResponse>\\n <RequestId>D6C62E40-F937-5803-B008-92E813399BA5</RequestId>\\n</SetUserPropertyValueResponse>","errorExample":""}]',
- 'title' => '为用户设置自定义属性',
+ '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"}]',
],
'ListProperty' => [
- 'summary' => '查询当前账号下已有的用户属性列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3111,23 +2812,12 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -3137,17 +2827,8 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'NextToken' => [
- 'description' => '下一个查询开始的Token，NextToken为空表示没有下一个。',
- 'type' => 'string',
- 'example' => 'caeba0bbb2be03f84eb48b699f0a4883',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'NextToken' => ['description' => '下一个查询开始的Token，NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'Properties' => [
'title' => 'users',
'description' => '属性信息。',
@@ -3156,17 +2837,8 @@
'description' => '属性信息。',
'type' => 'object',
'properties' => [
- 'PropertyId' => [
- 'description' => '属性ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '30',
- ],
- 'PropertyKey' => [
- 'description' => '属性名。',
- 'type' => 'string',
- 'example' => 'department',
- ],
+ 'PropertyId' => ['description' => '属性ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
+ 'PropertyKey' => ['description' => '属性名。', 'type' => 'string', 'example' => 'department'],
'PropertyValues' => [
'description' => '属性值信息。',
'type' => 'array',
@@ -3174,17 +2846,8 @@
'description' => '属性值信息。',
'type' => 'object',
'properties' => [
- 'PropertyValueId' => [
- 'description' => '属性值ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '42',
- ],
- 'PropertyValue' => [
- 'description' => '属性值。',
- 'type' => 'string',
- 'example' => 'A',
- ],
+ 'PropertyValueId' => ['description' => '属性值ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '42'],
+ 'PropertyValue' => ['description' => '属性值。', 'type' => 'string', 'example' => 'A'],
],
],
],
@@ -3195,19 +2858,36 @@
],
],
],
- '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' => '查询属性',
+ 'summary' => '查询当前账号下已有的用户属性列表。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProperty'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:ListProperty',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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":""}]',
],
'ListPropertyValue' => [
'summary' => '查询某一用户属性包含的属性值列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3215,34 +2895,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PropertyId',
'in' => 'query',
- 'schema' => [
- 'description' => '属性ID。您可以调用[ListProperty](~~ListProperty~~)进行查询。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '390',
- ],
+ 'schema' => ['description' => '属性ID。您可以调用[ListProperty](~~ListProperty~~)进行查询。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '390'],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -3252,12 +2915,7 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'C52013A5-3422-5D1F-B22C-A57110972AD9',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'C52013A5-3422-5D1F-B22C-A57110972AD9'],
'PropertyValueInfos' => [
'title' => 'users',
'description' => '属性值列表。',
@@ -3266,17 +2924,8 @@
'description' => '属性值信息。',
'type' => 'object',
'properties' => [
- 'PropertyValueId' => [
- 'description' => '属性值ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '978',
- ],
- 'PropertyValue' => [
- 'description' => '属性值。',
- 'type' => 'string',
- 'example' => 'HR',
- ],
+ 'PropertyValueId' => ['description' => '属性值ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '978'],
+ 'PropertyValue' => ['description' => '属性值。', 'type' => 'string', 'example' => 'HR'],
],
],
],
@@ -3284,54 +2933,58 @@
],
],
],
- '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' => '查询用户自定义属性值',
- ],
- 'CheckUsedProperty' => [
- 'summary' => '查询关联了指定自定义属性的便捷账号的数量。',
- 'methods' => [
- 'get',
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPropertyValue'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ecd:ListPropertyValue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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":""}]',
+ ],
+ 'LockMfaDevice' => [
+ 'summary' => '锁定便捷账号绑定的虚拟MFA设备。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'PropertyId',
+ 'name' => 'SerialNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '属性ID。您可以调用[ListProperty](~~ListProperty~~)进行查询。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '390',
- ],
+ 'schema' => ['description' => '虚拟MFA设备的序列号。可以调用[DescribeMfaDevices](~~DescribeMfaDevices~~)获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dc856334-446b-4035-bfbc-18af261e****'],
+ ],
+ [
+ 'name' => 'AdDomain',
+ 'in' => 'query',
+ 'schema' => ['description' => 'AD办公网络地址。', 'type' => 'string', 'required' => false, 'example' => 'upower.vip'],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -3341,81 +2994,76 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '22C97624-2405-54AC-BD44-A63FBE97****',
- ],
- 'UseCount' => [
- 'description' => '已关联指定自定义属性的便捷账号的数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '42FE70D8-4336-471B-8314-CCCFCE4159FD'],
],
],
],
],
- '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' => '查询关联指定属性的用户数',
- ],
- 'CheckUsedPropertyValue' => [
- 'summary' => '查询关联了指定自定义属性值的便捷账号的数量。',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => '锁定虚拟MFA设备',
+ 'description' => '锁定后，虚拟MFA设备的状态将变为锁定（LOCKED）。对应的便捷账号通过启用了MFA的办公网络登录无影终端时，将因为无法认证MFA设备而无法登录。您可以调用[UnlockMfaDevice](~~UnlockMfaDevice~~)解锁。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2023-08-21T09:00:53.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-06-08T12:35:42.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockMfaDevice'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:LockMfaDevice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"42FE70D8-4336-471B-8314-CCCFCE4159FD\\"\\n}","errorExample":""},{"type":"xml","example":"<LockMfaDeviceResponse>\\r\\n <RequestId>42FE70D8-4336-471B-8314-CCCFCE4159FD</RequestId>\\r\\n</LockMfaDeviceResponse>","errorExample":""}]',
+ ],
+ 'LockUsers' => [
+ 'summary' => '锁定一个或者多个便捷账号。锁定后的便捷账号无法登录无影终端。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'PropertyId',
- 'in' => 'query',
+ 'name' => 'Users',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '属性ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'description' => '要锁定的便捷账号的用户名列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '要锁定的便捷账号的用户名。', 'type' => 'string', 'required' => true, 'example' => 'alice'],
'required' => true,
- 'example' => '380',
+ 'example' => 'test1',
+ 'maxItems' => 500,
],
],
[
- 'name' => 'PropertyValueId',
+ 'name' => 'LogoutSession',
'in' => 'query',
- 'schema' => [
- 'description' => '属性值ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '978',
- ],
+ 'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -3425,35 +3073,75 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'UseCount' => [
- 'description' => '已关联指定自定义属性值的便捷账号的数量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'LockUsersResult' => [
+ 'description' => '锁定便捷账号操作的结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'LockedUsers' => [
+ 'description' => '锁定成功的便捷账号列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '锁定成功的便捷账号。', 'type' => 'string', 'example' => 'alice'],
+ ],
+ 'FailedUsers' => [
+ 'description' => '锁定失败的便捷账号列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '锁定失败的便捷账号信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EndUserId' => ['description' => '锁定失败的便捷账号。', 'type' => 'string', 'example' => 'alice'],
+ 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidUsername'],
+ 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'test123 is an invalid username.'],
+ ],
+ ],
+ ],
+ ],
],
],
],
],
],
- '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' => '查询关联指定属性值的用户数',
- ],
- 'CreateOrg' => [
- 'summary' => '创建组织。',
- 'methods' => [
- 'get',
- 'post',
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '锁定便捷账号',
+ 'description' => '出于安全考虑，您可以锁定便捷账号。被锁定的便捷用户无法登录无影终端，因此也无法访问任何无影云资源。'."\n"
+ ."\n"
+ .'> 您可以调用[DescribeUsers](~~283609~~)查询便捷账号信息。若返回数据中`Status`取值为0，表示该便捷账号未被锁定；若`Status`取值为9，表示该便捷账号已被锁定。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-08-04T15:17:46.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-11-06T11:10:00.000Z', 'description' => '请求参数发生变更'],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockUsers'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:LockUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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":""}]',
+ ],
+ 'ModifyGroup' => [
+ 'summary' => '修改用户组的名称和描述。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3461,166 +3149,99 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '147035',
- 'abilityTreeNodes' => [
- 'FEATUREgwsJIXGV5',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'OrgName',
+ 'name' => 'GroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '组织名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '设计部门',
- ],
+ 'schema' => ['description' => '用户组ID。', 'type' => 'string', 'required' => true, 'example' => 'ug-dzjax1ez5qgph****'],
],
[
- 'name' => 'ParentOrgId',
+ 'name' => 'NewGroupName',
'in' => 'query',
- 'schema' => [
- 'description' => '上级组织ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'org-evk12ozjvmlxl****',
- ],
+ 'schema' => ['description' => '新的用户组名称。', 'type' => 'string', 'required' => true, 'example' => '开发组'],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => '新的用户组描述。', 'type' => 'string', 'required' => false, 'example' => 'TestGroup'],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '7A2C3803-C975-5871-A232-80A91009****',
- ],
- 'OrgId' => [
- 'description' => '组织ID。',
- 'type' => 'string',
- 'example' => 'org-evk12ozjvmlxl****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '868B8926-2E7A-5BE7-9897-E811E994****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A2C3803-C975-5871-A232-80A91009****\\",\\n \\"OrgId\\": \\"org-evk12ozjvmlxl****\\"\\n}","type":"json"}]',
- 'title' => '创建组织',
- ],
- 'DescribeOrgs' => [
- 'summary' => '查询组织列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '修改用户组',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-30T14:09:42.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:ModifyGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyOrg' => [
+ 'summary' => '修改组织。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '147038',
+ 'abilityTreeNodes' => ['FEATUREgwsJIXGV5'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '返回结果的最大数量。取值范围：1~100。 '."\n"
- .'默认值：100。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '500',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '500',
- ],
- ],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AAAAAV3MpHK****',
- ],
- ],
- [
'name' => 'OrgName',
'in' => 'query',
- 'schema' => [
- 'description' => '组织名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '产品部',
- ],
+ 'schema' => ['description' => '组织名称。', 'type' => 'string', 'required' => true, 'example' => '开发部。'],
],
[
- 'name' => 'ParentOrgId',
+ 'name' => 'OrgId',
'in' => 'query',
- 'schema' => [
- 'description' => '父组织ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'org-11fs****',
- ],
- ],
- [
- 'name' => 'ShowExtras',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'any',
- ],
- ],
+ 'schema' => ['description' => '组织ID。', 'type' => 'string', 'required' => true, 'example' => 'org-76joc57khvnhdh***'],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -3630,107 +3251,66 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0B4BB****',
- ],
- 'NextToken' => [
- 'description' => '查询凭证（Token），取值为上一次API调用返回的NextToken参数值。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK****',
- ],
- 'Orgs' => [
- 'description' => '组织列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '组织详情。',
- 'type' => 'object',
- 'properties' => [
- 'OrgName' => [
- 'description' => '组织名称。',
- 'type' => 'string',
- 'example' => '设计部****',
- ],
- 'OrgId' => [
- 'description' => '组织ID。',
- 'type' => 'string',
- 'example' => 'org-1mox****',
- ],
- 'ParentOrgId' => [
- 'description' => '父组织ID。',
- 'type' => 'string',
- 'example' => 'org-ezqr****',
- ],
- 'OrgNamePath' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0296EDF8-3C8A-5128-8682-27B29C99****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B4BB****\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK****\\",\\n \\"Orgs\\": [\\n {\\n \\"OrgName\\": \\"设计部****\\",\\n \\"OrgId\\": \\"org-1mox****\\",\\n \\"ParentOrgId\\": \\"org-ezqr****\\",\\n \\"OrgNamePath\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询组织列表',
- 'description' => '组织为树形结构，其根组织ID值为：org-aliyun-wy-org-id。',
- ],
- 'DescribeOrgByLayer' => [
- 'summary' => '查找下级组织。',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => '修改组织',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyOrg'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ecd:ModifyOrg',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0296EDF8-3C8A-5128-8682-27B29C99****\\"\\n}","type":"json"}]',
+ ],
+ 'ModifyUser' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'ParentOrgId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '父组织ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'org-11fs****',
- ],
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => ['description' => '便捷账号的用户ID，对应控制台上显示的`用户名`字段。', 'type' => 'string', 'required' => true, 'example' => 'alice'],
],
[
- 'name' => 'OrgName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '组织名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '产品部',
- ],
+ 'name' => 'Email',
+ 'in' => 'query',
+ 'schema' => ['description' => '便捷账号的邮箱地址。', 'type' => 'string', 'required' => false, 'example' => 'username@example.com'],
+ ],
+ [
+ 'name' => 'Phone',
+ 'in' => 'query',
+ 'schema' => ['description' => '编辑账号的手机号码。', 'type' => 'string', 'required' => false, 'example' => '1381111****'],
],
[
'name' => 'BusinessChannel',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'in' => 'query',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -3740,121 +3320,41 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'Orgs' => [
- 'description' => '组织信息列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '组织信息集合。',
- 'type' => 'object',
- 'properties' => [
- 'OrgName' => [
- 'description' => '组织名称。',
- 'type' => 'string',
- 'example' => '开发部',
- ],
- 'OrgId' => [
- 'description' => '组织ID。',
- 'type' => 'string',
- 'example' => 'org-1mox****',
- ],
- 'ParentOrgId' => [
- 'description' => '父组织ID。',
- 'type' => 'string',
- 'example' => 'org-ezqr****',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Orgs\\": [\\n {\\n \\"OrgName\\": \\"开发部\\",\\n \\"OrgId\\": \\"org-1mox****\\",\\n \\"ParentOrgId\\": \\"org-ezqr****\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '指定父组织查找下级组织',
- ],
- 'RemoveOrg' => [
- 'summary' => '移除组织。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'title' => '修改便捷账号的联系方式',
+ 'summary' => '修改便捷账号的联系方式。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-03-22T09:02:22.000Z', 'description' => 'OpenAPI 下线'],
],
- 'security' => [
- [
- 'AK' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUser'],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'OrgId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '组织ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'org-5yy5icj981xe5****',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'BusinessChannel',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回信息集合。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '6C352609-EE7F-5603-B5E6-57C3EDDD****',
- ],
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:ModifyUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C352609-EE7F-5603-B5E6-57C3EDDD****\\"\\n}","type":"json"}]',
- 'title' => '移除组织',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'MoveOrg' => [
'summary' => '移动组织。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3862,43 +3362,22 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'OrgId',
'in' => 'formData',
- 'schema' => [
- 'description' => '待移动的组织ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'org-5yy5icj981xe5****',
- ],
+ 'schema' => ['description' => '待移动的组织ID。', 'type' => 'string', 'required' => true, 'example' => 'org-5yy5icj981xe5****'],
],
[
'name' => 'NewParentOrgId',
'in' => 'formData',
- 'schema' => [
- 'description' => '目标父组织ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'org-5yy5icj981xe5****'."\n",
- ],
+ 'schema' => ['description' => '目标父组织ID。', 'type' => 'string', 'required' => true, 'example' => 'org-5yy5icj981xe5****'."\n"],
],
[
'name' => 'BusinessChannel',
'in' => 'formData',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -3909,110 +3388,38 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
'title' => '移动组织',
- ],
- 'ModifyOrg' => [
- 'summary' => '修改组织。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => '请求参数发生变更'],
],
- 'security' => [
- [
- 'AK' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveOrg'],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '147038',
- 'abilityTreeNodes' => [
- 'FEATUREgwsJIXGV5',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'OrgName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '组织名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '开发部。',
- ],
- ],
- [
- 'name' => 'OrgId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '组织ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'org-76joc57khvnhdh***',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'BusinessChannel',
- 'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回信息集合。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '0296EDF8-3C8A-5128-8682-27B29C99****',
- ],
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:MoveOrg',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0296EDF8-3C8A-5128-8682-27B29C99****\\"\\n}","type":"json"}]',
- 'title' => '修改组织',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'MoveUserOrg' => [
- 'summary' => '移动用户到目标组织架构。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4020,21 +3427,12 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'OrgId',
'in' => 'formData',
- 'schema' => [
- 'description' => '组织架构ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'org-4mdgc1cocc59z****',
- ],
+ 'schema' => ['description' => '组织架构ID。', 'type' => 'string', 'required' => true, 'example' => 'org-4mdgc1cocc59z****'],
],
[
'name' => 'EndUserIds',
@@ -4043,12 +3441,7 @@
'schema' => [
'description' => '用户ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '用户ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'alex',
- ],
+ 'items' => ['description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alex'],
'required' => true,
'maxItems' => 500,
'minItems' => 1,
@@ -4057,14 +3450,7 @@
[
'name' => 'BusinessChannel',
'in' => 'formData',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -4074,104 +3460,142 @@
'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
'title' => '移动用户到目标组织架构',
- ],
- 'CreateGroup' => [
- 'summary' => '创建用户组。',
- 'methods' => [
- 'get',
- 'post',
+ 'summary' => '移动用户到目标组织架构。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveUserOrg'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ecd:MoveUserOrg',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'QuerySyncStatusByAliUid' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'GroupName',
+ 'name' => 'BusinessChannel',
'in' => 'query',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '用户组名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '开发组',
+ 'title' => 'PlainResult<UserSyncHistoryDo>',
+ 'description' => '返回信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => 'auto-increased id', 'description' => '自增ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '18500'],
+ 'GmtCreated' => ['title' => 'created time', 'description' => '创建时间。', 'type' => 'string', 'example' => '2020-06-30 07:50:42'],
+ 'GmtModified' => ['title' => 'modified time', 'description' => '修改时间。', 'type' => 'string', 'example' => '2022-03-02 14:27:39'],
+ 'AliUid' => ['title' => 'aliUid of the customer', 'description' => '阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '131239236086****'],
+ 'Status' => ['title' => 'user sync status', 'description' => '用户同步状态。', 'type' => 'string', 'example' => 'success'],
+ 'CorpId' => ['title' => 'corp id', 'description' => '企业ID。', 'type' => 'string', 'example' => 'cdrs948144195608****'],
+ 'LatestBeginTime' => ['title' => 'latestBeginTime', 'description' => '最后开始时间。', 'type' => 'string', 'example' => '2022-03-02 14:31:39'],
+ 'LatestEndTime' => ['title' => 'atest_end_time,Whether it is success or failure', 'description' => '最后结束时间，不论成功或失败。', 'type' => 'string', 'example' => '2022-03-02 16:13:12'],
+ 'LatestSuccessTime' => ['title' => 'latestSuccessTime', 'description' => '最后成功时间。', 'type' => 'string', 'example' => '2022-03-02 18:24:01'],
+ ],
+ ],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['description' => '系统状态码。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '请求失败的提示信息。', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ ],
],
],
- [
- 'name' => 'ParentGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '> 该参数暂不对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'root',
+ ],
+ 'title' => '查询用户同步状态',
+ 'summary' => '查询用户同步状态。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-03-14T09:43:54.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2022-03-14T09:43:54.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:QuerySyncStatusByAliUid',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 18500,\\n \\"GmtCreated\\": \\"2020-06-30 07:50:42\\",\\n \\"GmtModified\\": \\"2022-03-02 14:27:39\\",\\n \\"AliUid\\": 0,\\n \\"Status\\": \\"success\\",\\n \\"CorpId\\": \\"cdrs948144195608****\\",\\n \\"LatestBeginTime\\": \\"2022-03-02 14:31:39\\",\\n \\"LatestEndTime\\": \\"2022-03-02 16:13:12\\",\\n \\"LatestSuccessTime\\": \\"2022-03-02 18:24:01\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'RemoveGroup' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'BizType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '> 该参数暂不对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
[
- 'name' => 'SolutionId',
+ 'name' => 'GroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '> 该参数暂不对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'co-0esnf80jab***',
- ],
+ 'schema' => ['description' => '待删除的单个用户组ID。', 'type' => 'string', 'required' => false, 'example' => 'ug-dzjax1ez5qgph****'],
],
[
- 'name' => 'Description',
+ 'name' => 'GroupIds',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '用户组的描述。',
- 'type' => 'string',
+ 'description' => '待删除的用户组ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '待删除的用户组ID。', 'type' => 'string', 'required' => false, 'example' => 'ug-eld7uv7vtgqsz****'],
'required' => false,
- 'example' => 'TestGroup',
],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -4181,348 +3605,232 @@
'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****',
- ],
- 'GroupId' => [
- 'description' => '用户组ID。',
- 'type' => 'string',
- 'example' => 'ug-eld7uv7vtgqsz****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '42FE70D8-4336-471B-8314-CCCFCE41****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除用户组',
+ 'summary' => '删除用户组。支持批量操作。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-30T14:09:42.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ecd:RemoveGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA8D67CB-345D-5CDA-986E-FFAC7D0****\\",\\n \\"GroupId\\": \\"ug-eld7uv7vtgqsz****\\"\\n}","type":"json"}]',
- 'title' => '创建用户组',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42FE70D8-4336-471B-8314-CCCFCE41****\\"\\n}","type":"json"}]',
],
- 'DescribeGroups' => [
- 'summary' => '查询用户组。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'RemoveMfaDevice' => [
+ 'summary' => '删除便捷账号绑定的虚拟MFA设备。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'GroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '用户组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ug-16nf7xxh4o9gc****',
- ],
- ],
- [
- 'name' => 'BizType',
+ 'name' => 'SerialNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '> 该参数暂不对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- ],
+ 'schema' => ['description' => '虚拟MFA设备的序列号。可以调用[DescribeMfaDevices](~~DescribeMfaDevices~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'dc856334-446b-4035-bfbc-18af261e****'],
],
[
- 'name' => 'SolutionId',
+ 'name' => 'AdDomain',
'in' => 'query',
- 'schema' => [
- 'description' => '> 该参数暂不对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'co-0esnf80jab***',
- ],
+ 'schema' => ['description' => 'AD办公网络地址。', 'type' => 'string', 'required' => false, 'example' => 'alpha.lftltd.net'],
],
[
- 'name' => 'GroupName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '用户组名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestGroup',
- ],
- ],
- [
- 'name' => 'PageSize',
+ 'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时设置的每页行数。最大值：100。默认值：10。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '200',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '20',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '分页查询时的页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ 'title' => 'Schema of Response',
+ 'description' => '返回信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FB550AAB-FB36-4A91-93F6-F4374AF65403'],
+ ],
],
],
- [
- 'name' => 'TransferFileNeedApproval',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否已开启文件审批。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ ],
+ 'title' => '删除便捷账号绑定的虚拟MFA设备',
+ 'description' => '删除便捷账号绑定的虚拟MFA设备表示解除MFA设备绑定，相当于重置或禁用该MFA设备。对应便捷账号在登录无影终端时，需要重新绑定新的虚拟MFA设备。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2023-08-21T09:00:53.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2023-01-06T06:24:11.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveMfaDevice'],
],
+ ],
+ 'ramActions' => [
[
- 'name' => 'LoginPolicyId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '指定关联的登录策略筛选。'."\n",
- 'description' => '指定关联的登录策略筛选。'."\n",
- 'type' => 'string',
- 'required' => false,
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ecd:RemoveMfaDevice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ '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":""}]',
+ ],
+ 'RemoveOrg' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ExcludeAttachedLoginPolicyGroups',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否排除已关联登录策略的用户组。',
- 'description' => '是否排除已关联登录策略的用户组。',
- 'type' => 'boolean',
- 'required' => false,
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
+ 'parameters' => [
[
- 'name' => 'IdpId',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'name' => 'OrgId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '组织ID。', 'type' => 'string', 'required' => true, 'example' => 'org-5yy5icj981xe5****'],
],
[
'name' => 'BusinessChannel',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回数据结构。',
+ 'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- 'Groups' => [
- 'description' => '用户组列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '用户组信息。',
- 'type' => 'object',
- 'properties' => [
- 'GroupName' => [
- 'description' => '用户组名称。',
- 'type' => 'string',
- 'example' => 'TestGroup',
- ],
- 'GroupId' => [
- 'description' => '用户组ID。',
- 'type' => 'string',
- 'example' => 'ug-2412ojkwtybd****',
- ],
- 'Description' => [
- 'description' => '用户组的描述。',
- 'type' => 'string',
- 'example' => 'A test group.',
- ],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2025-08-07T13:40:40+08:00',
- ],
- 'UserCount' => [
- 'description' => '用户组内的成员数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'TransferFileNeedApproval' => [
- 'description' => '是否已开启文件审批。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'AttachedLoginPolicy' => [
- 'type' => 'object',
- 'properties' => [
- 'PolicyId' => [
- 'type' => 'string',
- ],
- 'Name' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'AuthedResources' => [
- 'description' => '已分配的资源列表。',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '已分配的资源。',
- 'enumValueTitles' => [
- 'DesktopGroup' => '共享型云电脑',
- ],
- 'example' => 'DesktopGroup',
- ],
- ],
- ],
- ],
- ],
- 'Count' => [
- 'description' => '查询结果的数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '6C352609-EE7F-5603-B5E6-57C3EDDD****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Groups\\": [\\n {\\n \\"GroupName\\": \\"TestGroup\\",\\n \\"GroupId\\": \\"ug-2412ojkwtybd****\\",\\n \\"Description\\": \\"A test group.\\",\\n \\"CreateTime\\": \\"2025-08-07T13:40:40+08:00\\",\\n \\"UserCount\\": 20,\\n \\"TransferFileNeedApproval\\": false,\\n \\"AttachedLoginPolicy\\": {\\n \\"PolicyId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n },\\n \\"AuthedResources\\": {\\n \\"key\\": \\"DesktopGroup\\"\\n }\\n }\\n ],\\n \\"Count\\": 1\\n}","type":"json"}]',
- 'title' => '查询用户组',
- ],
- 'UserBatchQuitGroup' => [
- 'summary' => '批量移除用户组中的用户。',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => '移除组织',
+ 'summary' => '移除组织。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveOrg'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ecd:RemoveOrg',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6C352609-EE7F-5603-B5E6-57C3EDDD****\\"\\n}","type":"json"}]',
+ ],
+ 'RemoveProperty' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'GroupId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '用户组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ug-lkuvalovhnlxvv****',
- ],
- ],
- [
- 'name' => 'EndUserIds',
+ 'name' => 'PropertyId',
'in' => 'formData',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '用户ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '用户ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'alex***',
- ],
- 'required' => false,
- 'maxItems' => 100,
- ],
+ 'schema' => ['description' => '属性ID。您可以调用[ListProperty](~~410890~~)进行查询。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '390'],
],
[
'name' => 'BusinessChannel',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'in' => 'query',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回数据结构。',
+ 'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '890JNJNF-SADASSDFS-SDFSDF****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '删除用户自定义属性',
+ 'summary' => '删除一组用户属性。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"890JNJNF-SADASSDFS-SDFSDF****\\"\\n}","type":"json"}]',
- 'title' => '用户组批量移除用户',
- ],
- 'UserBatchJoinGroup' => [
- 'summary' => '为用户组批量添加用户。',
- 'methods' => [
- 'get',
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveProperty'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ecd:RemoveProperty',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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":""}]',
+ ],
+ 'RemoveUsers' => [
+ 'summary' => '删除一个或者多个便捷账号。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4530,85 +3838,98 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
- 'name' => 'GroupId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '用户组ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ug-12341234****',
- ],
- ],
- [
- 'name' => 'EndUserIds',
+ 'name' => 'Users',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'description' => '用户ID列表。',
+ 'description' => '要删除的便捷账号的用户名列表。',
'type' => 'array',
- 'items' => [
- 'description' => '用户ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'alex****',
- ],
- 'required' => false,
- 'maxItems' => 100,
+ 'items' => ['description' => '要删除的便捷账号的用户名。用户名可以通过[DescribeUsers](~~DescribeUsers~~)接口获取。', 'type' => 'string', 'required' => true, 'example' => 'test1'],
+ 'required' => true,
+ 'example' => 'test1',
+ 'maxItems' => 500,
+ 'minItems' => 1,
],
],
[
'name' => 'BusinessChannel',
'in' => 'formData',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回数据结构。',
+ 'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '7A2C3803-C975-5871-A232-80A91009****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'RemoveUsersResult' => [
+ 'description' => '删除便捷账号操作的结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RemovedUsers' => [
+ 'description' => '删除成功的便捷账号。',
+ 'type' => 'array',
+ 'items' => ['description' => '删除成功的便捷账号。', 'type' => 'string', 'example' => 'test1'],
+ ],
+ 'FailedUsers' => [
+ 'description' => '删除失败的用户信息集合。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '删除失败的便捷账号。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EndUserId' => ['description' => '删除失败的便捷账号。', 'type' => 'string', 'example' => 'test2'],
+ 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidUsername'],
+ 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'test2 is an invalid username.'],
+ ],
+ ],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '删除便捷账号',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-06-30T11:24:19.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2023-12-18T11:14:57.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2022-11-02T06:24:28.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsers'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ecd:RemoveUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A2C3803-C975-5871-A232-80A91009****\\"\\n}","type":"json"}]',
- 'title' => '用户组批量添加用户',
+ '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":""}]',
],
- 'RemoveGroup' => [
- 'summary' => '删除用户组。支持批量操作。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ResetUserPassword' => [
+ 'summary' => '重置便捷账号的密码，包括生成重置密码Token，并发送重置密码邮件到便捷账号的邮箱。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4616,85 +3937,109 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'GroupId',
- 'in' => 'query',
+ 'name' => 'Users',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '待删除的单个用户组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ug-dzjax1ez5qgph****',
+ 'description' => '要重置密码的便捷账号的用户名列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '要重置密码的便捷账号的用户名。', 'type' => 'string', 'required' => true, 'example' => 'alice'],
+ 'required' => true,
+ 'example' => 'test1',
+ 'maxItems' => 100,
],
],
[
- 'name' => 'GroupIds',
- 'in' => 'query',
- 'style' => 'flat',
+ 'name' => 'NotifyType',
+ 'in' => 'formData',
'schema' => [
- 'description' => '待删除的用户组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '待删除的用户组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ug-eld7uv7vtgqsz****',
- ],
+ 'description' => '重置密码后通知用户的方式。'."\n"
+ ."\n"
+ .'> 国际站账号不支持通过短信通知用户的方式。',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
+ 'enumValueTitles' => [1 => '通过邮箱通知用户', '通过短信通知用户', '邮箱和短信都发送通知'],
+ 'example' => '1',
],
],
[
'name' => 'BusinessChannel',
- 'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回数据结构。',
+ 'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '42FE70D8-4336-471B-8314-CCCFCE41****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '32D05B39-E6EE-4D7A-9FD0-762A26859D0D'],
+ 'ResetUsersResult' => [
+ 'description' => '重置便捷账号密码操作的结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'ResetUsers' => [
+ 'description' => '已发送重置密码邮件的便捷账号列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '已发送重置密码邮件的便捷账号。', 'type' => 'string', 'example' => 'test1'],
+ ],
+ 'FailedUsers' => [
+ 'description' => '重置密码失败的便捷账号列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '重置密码失败的便捷账号信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EndUserId' => ['description' => '重置密码失败的便捷账号。', 'type' => 'string', 'example' => 'alice'],
+ 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidUsername'],
+ 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'test123 is an invalid username.'],
+ ],
+ ],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '重置便捷账号的密码',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-09-08T12:07:49.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"42FE70D8-4336-471B-8314-CCCFCE41****\\"\\n}","type":"json"}]',
- 'title' => '删除用户组',
- ],
- 'ModifyGroup' => [
- 'summary' => '修改用户组的名称和描述。',
- 'methods' => [
- 'get',
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetUserPassword'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:ResetUserPassword',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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":""}]',
+ ],
+ 'SetUserPropertyValue' => [
+ 'summary' => '为某个用户关联一个用户属性。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4702,295 +4047,210 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'GroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '用户组ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ug-dzjax1ez5qgph****',
- ],
+ 'name' => 'UserId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用户ID。可以调用[DescribeUsers](~~DescribeUsers~~)获取该参数，对应返回参数`Id`的值。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '111****'],
],
[
- 'name' => 'NewGroupName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '新的用户组名称。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '开发组',
- ],
+ 'name' => 'UserName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用户名。可以调用[DescribeUsers](~~DescribeUsers~~)获取该参数，对应返回参数`EndUserId`的值。', 'type' => 'string', 'required' => true, 'example' => 'alice'],
],
[
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'description' => '新的用户组描述。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestGroup',
- ],
+ 'name' => 'PropertyId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '属性ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '240**'],
+ ],
+ [
+ 'name' => 'PropertyValueId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '属性值ID。可以调用[ListProperty](~~ListProperty~~)获取该参数。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2251**'],
],
[
'name' => 'BusinessChannel',
- 'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回数据结构。',
+ 'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '868B8926-2E7A-5BE7-9897-E811E994****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => '为用户设置自定义属性',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:51.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2022-11-02T06:24:28.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI 下线'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\"\\n}","type":"json"}]',
- 'title' => '修改用户组',
- ],
- 'DescribeGroupUser' => [
- 'summary' => '查询用户组成员。',
- 'methods' => [
- 'get',
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUserPropertyValue'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:SetUserPropertyValue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetUserPropertyValueResponse>\\n <RequestId>D6C62E40-F937-5803-B008-92E813399BA5</RequestId>\\n</SetUserPropertyValueResponse>","errorExample":""}]',
+ ],
+ 'SyncAllEduInfo' => [
+ 'summary' => '同步所有教育信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'GroupId',
- 'in' => 'query',
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '用户组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ug-12341234****',
+ 'title' => 'BaseResult',
+ 'description' => '返回信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ ],
],
],
+ ],
+ 'title' => '同步所有教育信息',
+ 'changeSet' => [
+ ['createdAt' => '2022-03-14T09:43:55.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncAllEduInfo'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'BizType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '> 该参数暂不对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:SyncAllEduInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ ],
+ 'TransferResourcesIntoGroup' => [
+ 'summary' => '将资源转移到资源组中',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'SolutionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '> 该参数暂不对外开放使用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'co-0esnf80jab***',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'MaxResults',
+ 'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '分页查询时每页行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-ckf3cx7isinhk***'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'Resources',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => '下一次查询的Token。可从上一次调用本接口的返回参数中获取。',
- 'type' => 'string',
+ 'description' => '资源对象的列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '资源信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['description' => '资源所属的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
+ 'ResourceType' => [
+ 'description' => '资源类型。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['CLOUD_PHONE' => '云手机', 'DESKTOP' => '云电脑'],
+ 'example' => 'DESKTOP',
+ ],
+ 'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-0jl0dwz61hn59tto****'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'AAAAAV3MpHK****',
],
],
[
- 'name' => 'Filter',
+ 'name' => 'Platform',
'in' => 'query',
'schema' => [
- 'description' => '模糊搜索字符串，支持匹配用户名（EndUserId）和邮箱（Email）。',
+ 'description' => '无影产品类型。',
'type' => 'string',
'required' => false,
- 'example' => 'user',
+ 'enumValueTitles' => ['CloudPhoneConsole' => '无影云手机', 'AliyunConsole' => '无影云电脑企业版'],
+ 'example' => 'AliyunConsole',
],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回数据结构。',
+ 'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****',
- ],
- 'Groups' => [
- 'description' => '> 废弃字段。',
- 'type' => 'array',
- 'items' => [
- 'description' => '用户组信息。',
- 'type' => 'object',
- 'properties' => [
- 'GroupName' => [
- 'description' => '用户组名称。',
- 'type' => 'string',
- 'example' => '开发组',
- ],
- 'GroupId' => [
- 'description' => '用户组ID。',
- 'type' => 'string',
- 'example' => 'ug-91mvbosdjsdfh****',
- ],
- 'UserCount' => [
- 'description' => '成员个数。',
- 'type' => 'string',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'Users' => [
- 'description' => '成员列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '成员信息。',
- 'type' => 'object',
- 'properties' => [
- 'EndUserId' => [
- 'description' => '用户名。',
- 'type' => 'string',
- 'example' => 'alex****',
- ],
- 'Avatar' => [
- 'description' => '> 废弃字段。',
- 'type' => 'string',
- 'example' => 'https://avatar.****.com',
- ],
- 'Address' => [
- 'description' => '> 废弃字段。',
- 'type' => 'string',
- 'example' => 'xx-xx-xx',
- ],
- 'Phone' => [
- 'description' => '手机号。',
- 'type' => 'string',
- 'example' => '138****1111',
- ],
- 'Email' => [
- 'description' => '邮箱。',
- 'type' => 'string',
- 'example' => 'alex****@example.com',
- ],
- 'NickName' => [
- 'description' => '显示名。',
- 'type' => 'string',
- 'example' => 'alex',
- ],
- 'JobNumber' => [
- 'description' => '> 废弃字段。',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'GmtJoinGroup' => [
- 'description' => '添加时间。',
- 'type' => 'string',
- 'example' => '2024-08-26T02:59:22.000+00:00',
- ],
- 'GmtCreated' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2024-08-26T02:59:22.000+00:00',
- ],
- 'Remark' => [
- 'description' => '用户的备注。',
- 'type' => 'string',
- 'example' => 'remark',
- ],
- ],
- ],
- ],
- 'NextToken' => [
- 'description' => '下一次查询的Token。NextToken为空表示结果已经全部查询到。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA8D67CB-345D-5CDA-986E-FFAC7D0****\\",\\n \\"Groups\\": [\\n {\\n \\"GroupName\\": \\"开发组\\",\\n \\"GroupId\\": \\"ug-91mvbosdjsdfh****\\",\\n \\"UserCount\\": \\"1\\"\\n }\\n ],\\n \\"Users\\": [\\n {\\n \\"EndUserId\\": \\"alex****\\",\\n \\"Avatar\\": \\"https://avatar.****.com\\",\\n \\"Address\\": \\"xx-xx-xx\\",\\n \\"Phone\\": \\"138****1111\\",\\n \\"Email\\": \\"alex****@example.com\\",\\n \\"NickName\\": \\"alex\\",\\n \\"JobNumber\\": \\"123\\",\\n \\"GmtJoinGroup\\": \\"2024-08-26T02:59:22.000+00:00\\",\\n \\"GmtCreated\\": \\"2024-08-26T02:59:22.000+00:00\\",\\n \\"Remark\\": \\"remark\\"\\n }\\n ],\\n \\"NextToken\\": \\"AAAAAV3MpHK****\\"\\n}","type":"json"}]',
- 'title' => '查询用户组成员',
- ],
- 'RemoveMfaDevice' => [
- 'summary' => '删除便捷账号绑定的虚拟MFA设备。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '资源组转入资源组',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA8D67CB-345D-5CDA-986E-FFAC7D0****\\"\\n}","type":"json"}]',
+ ],
+ 'TransferResourcesOutofGroup' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4998,79 +4258,81 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'SerialNumber',
+ 'name' => 'ResourceGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '虚拟MFA设备的序列号。可以调用[DescribeMfaDevices](~~DescribeMfaDevices~~)获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'dc856334-446b-4035-bfbc-18af261e****',
- ],
+ 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-66konqltcpx43****'],
],
[
- 'name' => 'AdDomain',
+ 'name' => 'Resources',
'in' => 'query',
+ 'style' => 'flat',
'schema' => [
- 'description' => 'AD办公网络地址。',
- 'type' => 'string',
+ 'description' => '资源列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '资源信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['description' => '资源所属的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
+ 'ResourceType' => [
+ 'description' => '资源类型。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['CLOUD_PHONE' => '云手机', 'DESKTOP' => '云桌面'],
+ 'example' => 'DESKTOP',
+ ],
+ 'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-1shc5sk0vo****'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'alpha.lftltd.net',
],
],
[
+ 'name' => 'TargetResourceGroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => '目标资源组ID，期望转入的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-hcjo6dugpo1****'],
+ ],
+ [
+ 'name' => 'Platform',
+ 'in' => 'query',
+ 'schema' => ['description' => '> 固定值：AliyunConsole。'."\n"
+ .'> - 无影企业版固定传AliyunConsole，其他平台暂不对外开放。', 'type' => 'string', 'required' => false, 'example' => 'AliyunConsole'],
+ ],
+ [
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回信息集合。',
+ 'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'FB550AAB-FB36-4A91-93F6-F4374AF65403',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D2B1DF9E-576B-5B91-BAF6-2C3DD1****'],
],
],
],
],
- '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' => '删除便捷账号绑定的虚拟MFA设备',
- 'description' => '删除便捷账号绑定的虚拟MFA设备表示解除MFA设备绑定，相当于重置或禁用该MFA设备。对应便捷账号在登录无影终端时，需要重新绑定新的虚拟MFA设备。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'LockMfaDevice' => [
- 'summary' => '锁定便捷账号绑定的虚拟MFA设备。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '资源转出资源组',
+ 'summary' => '将资源从资源组中转出',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2B1DF9E-576B-5B91-BAF6-2C3DD1****\\"\\n}","type":"json"}]',
+ ],
+ 'UnlockMfaDevice' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5078,44 +4340,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'SerialNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '虚拟MFA设备的序列号。可以调用[DescribeMfaDevices](~~DescribeMfaDevices~~)获取。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'dc856334-446b-4035-bfbc-18af261e****',
- ],
+ 'schema' => ['description' => '虚拟MFA设备的序列号。可以调用[DescribeMfaDevices](~~DescribeMfaDevices~~)获取。', 'type' => 'string', 'required' => true, 'example' => 'dc856334-446b-4035-bfbc-18af261e****'],
],
[
'name' => 'AdDomain',
'in' => 'query',
- 'schema' => [
- 'description' => 'AD办公网络地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'upower.vip',
- ],
+ 'schema' => ['description' => 'AD办公网络地址。', 'type' => 'string', 'required' => false, 'example' => 'welab.co.id'],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -5125,33 +4365,45 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '42FE70D8-4336-471B-8314-CCCFCE4159FD',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9BD39C60-4E38-43BE-BA2F-69136C6C5190'],
],
],
],
],
- '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' => '锁定虚拟MFA设备',
- 'description' => '锁定后，虚拟MFA设备的状态将变为锁定（LOCKED）。对应的便捷账号通过启用了MFA的办公网络登录无影终端时，将因为无法认证MFA设备而无法登录。您可以调用[UnlockMfaDevice](~~UnlockMfaDevice~~)解锁。',
+ 'title' => '解锁虚拟MFA设备',
+ 'summary' => '解锁便捷账号绑定的虚拟MFA设备。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'UnlockMfaDevice' => [
- 'summary' => '解锁便捷账号绑定的虚拟MFA设备。',
- 'methods' => [
- 'get',
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2023-08-21T09:00:53.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2023-01-06T06:24:11.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockMfaDevice'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:UnlockMfaDevice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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":""}]',
+ ],
+ 'UnlockUsers' => [
+ 'summary' => '解锁一个或者多个便捷账号。解锁后的便捷账号可以登录无影终端。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5159,43 +4411,30 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'SerialNumber',
- 'in' => 'query',
+ 'name' => 'Users',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '虚拟MFA设备的序列号。可以调用[DescribeMfaDevices](~~DescribeMfaDevices~~)获取。',
- 'type' => 'string',
+ 'description' => '要解锁的便捷账号的用户名列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '要解锁的便捷账号的用户名。', 'type' => 'string', 'required' => true, 'example' => 'alice'],
'required' => true,
- 'example' => 'dc856334-446b-4035-bfbc-18af261e****',
+ 'example' => 'test1',
+ 'maxItems' => 500,
],
],
[
- 'name' => 'AdDomain',
+ 'name' => 'AutoLockTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'AD办公网络地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'welab.co.id',
- ],
+ 'schema' => ['description' => '自动锁定便捷账号的日期。', 'type' => 'string', 'required' => false, 'example' => '2023-03-03'],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -5205,134 +4444,116 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '9BD39C60-4E38-43BE-BA2F-69136C6C5190',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '023F4EC4-3602-4A3E-A514-4970847D59DB'],
+ 'UnlockUsersResult' => [
+ 'description' => '解锁便捷账号操作的结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'UnlockedUsers' => [
+ 'description' => '解锁成功的便捷账号列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '解锁成功的便捷账号。', 'type' => 'string', 'example' => 'alice'],
+ ],
+ 'FailedUsers' => [
+ 'description' => '解锁失败的便捷账号列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '解锁失败的便捷账号信息集合。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EndUserId' => ['description' => '解锁失败的便捷账号。', 'type' => 'string', 'example' => 'alice'],
+ 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'InvalidUsername'],
+ 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'test123 is an invalid username.'],
+ ],
+ ],
+ ],
+ ],
],
],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"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' => '解锁虚拟MFA设备',
+ 'title' => '解锁便捷账号',
+ 'description' => '被锁定的便捷账号无法登录无影终端，因此也无法访问任何无影云资源。如需允许便捷账号登录无影终端，需要先将其解锁。'."\n"
+ ."\n"
+ .'> 您可以调用[DescribeUsers](~~283609~~)查询便捷账号信息。若返回数据中`Status`取值为0，表示该便捷账号未被锁定；若`Status`取值为9，表示该便捷账号已被锁定。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeMfaDevices' => [
- 'summary' => '查询便捷账号绑定的虚拟MFA设备。',
- 'methods' => [
- 'get',
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-08-04T15:17:46.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2023-08-31T01:58:25.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockUsers'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:UnlockUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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":""}]',
+ ],
+ 'UpdateProperty' => [
+ 'summary' => '修改用户属性。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '返回结果的最大数量。取值范围：1~500。 '."\n"
- .'默认值：100。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '1',
- 'example' => '100',
- ],
- ],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => '查询凭证。取值为上一次API调用时返回的NextToken参数值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'caeba0bbb2be03f84eb48b699f0a4883',
- ],
+ 'name' => 'PropertyId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '要修改的属性ID。您可以调用[ListProperty](~~ListProperty~~)进行查询。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '390'],
],
[
- 'name' => 'EndUserIds',
- 'in' => 'query',
- 'style' => 'repeatList',
- 'schema' => [
- 'description' => '便捷账号的用户名列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '便捷账号的用户名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'alice',
- ],
- 'required' => false,
- 'example' => 'test',
- 'maxItems' => 100,
- ],
+ 'name' => 'PropertyKey',
+ 'in' => 'formData',
+ 'schema' => ['description' => '修改后的属性名。', 'type' => 'string', 'required' => true, 'example' => 'testkey'],
],
[
- 'name' => 'SerialNumbers',
- 'in' => 'query',
+ 'name' => 'PropertyValues',
+ 'in' => 'formData',
'style' => 'repeatList',
'schema' => [
- 'description' => '虚拟MFA设备的序列号列表。',
+ 'description' => '修改后该属性的所有属性值列表。'."\n"
+ ."\n"
+ .'><notice>此处传入的属性值将覆盖原来的属性值，而不是在原有的基础上追加。></notice>',
'type' => 'array',
'items' => [
- 'description' => '虚拟MFA设备的序列号。',
- 'type' => 'string',
+ 'description' => '修改后该属性的所有属性值。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PropertyValueId' => ['description' => '修改后该属性的属性值ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '978'],
+ 'PropertyValue' => ['description' => '修改后该属性的属性值。', 'type' => 'string', 'required' => false, 'example' => 'testvalue'],
+ ],
'required' => false,
- 'example' => 'c2d9ae94-a64b-4a0d-8024-9519ca50****',
],
'required' => false,
- 'example' => 'c2d9ae94-a64b-4a0d-8024-9519ca50****',
'maxItems' => 100,
],
],
[
- 'name' => 'AdDomain',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'AD办公网络地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn.misumi.pri',
- ],
- ],
- [
- 'name' => 'Filter',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- [
'name' => 'BusinessChannel',
'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
@@ -5342,94 +4563,41 @@
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '33DBB8EC-6E68-4726-91C4-E09C59D9A7D8',
- ],
- 'NextToken' => [
- 'description' => '下一个查询开始的Token。',
- 'type' => 'string',
- 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp',
- ],
- 'MfaDevices' => [
- 'title' => 'mfa device list',
- 'description' => '虚拟MFA设备信息集合。',
- 'type' => 'array',
- 'items' => [
- 'description' => '虚拟MFA设备信息。',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '虚拟MFA设备的ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '36',
- ],
- 'EndUserId' => [
- 'description' => '使用该虚拟MFA设备的便捷账号用户名。',
- 'type' => 'string',
- 'example' => 'alice',
- ],
- 'Email' => [
- 'description' => '> 该参数暂未开放使用。',
- 'type' => 'string',
- 'example' => 'username@example.com',
- ],
- 'GmtEnabled' => [
- 'description' => '虚拟MFA设备启用时间。按照ISO8601标准表示，并使用UTC+0时间，格式为`yyyy-MM-ddTHH:mm:ssZ`。',
- 'type' => 'string',
- 'example' => '2021-06-22T06:20:49Z',
- ],
- 'GmtUnlock' => [
- 'description' => '虚拟MFA设备被锁定后的自动解锁时间。按照ISO8601标准表示，并使用UTC+0时间，格式为`yyyy-MM-ddTHH:mm:ssZ`。',
- 'type' => 'string',
- 'example' => '2021-06-23T06:20:49Z',
- ],
- 'ConsecutiveFails' => [
- 'description' => '连续绑定或者认证虚拟MFA设备失败的次数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'SerialNumber' => [
- 'description' => '虚拟MFA设备的序列号。',
- 'type' => 'string',
- 'example' => 'dc856334-446b-4035-bfbc-18af261e****',
- ],
- 'Status' => [
- 'description' => '虚拟MFA设备状态。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'LOCKED' => '已锁定',
- 'UNBOUND' => '未绑定',
- 'NORMAL' => '正常',
- ],
- 'example' => 'NORMAL',
- ],
- 'DeviceType' => [
- 'description' => '虚拟MFA设备类型。目前仅支持`TOTP_VIRTUAL`，即遵循TOTP算法的虚拟MFA设备。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'TOTP_VIRTUAL' => '遵循TOTP算法的虚拟MFA设备',
- ],
- 'example' => 'TOTP_VIRTUAL',
- ],
- 'AdUser' => [
- 'type' => 'object',
- 'properties' => [
- 'EndUser' => [
- 'type' => 'string',
- ],
- 'DisplayName' => [
- 'type' => 'string',
- ],
- 'DisplayNameNew' => [
- 'type' => 'string',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
+ 'UpdateResult' => [
+ 'description' => '修改结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PropertyId' => ['description' => '属性ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '390'],
+ 'PropertyKey' => ['description' => '属性名。', 'type' => 'string', 'example' => 'testkey2'],
+ 'SavePropertyValueModel' => [
+ 'description' => '属性值修改结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'SavePropertyValues' => [
+ 'description' => '修改成功的属性值。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '修改成功的属性值。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PropertyValueId' => ['description' => '属性值ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '978'],
+ 'PropertyValue' => ['description' => '属性值。', 'type' => 'string', 'example' => 'testvalue2'],
+ ],
],
- 'UserPrincipalName' => [
- 'type' => 'string',
+ ],
+ 'FailedPropertyValues' => [
+ 'description' => '修改失败的属性值。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '修改失败的属性值。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PropertyId' => ['description' => '属性ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '390'],
+ 'PropertyValue' => ['description' => '属性值。', 'type' => 'string', 'example' => 'testvalue'],
+ 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'ExistedPropertyValue'],
+ 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The property value is used by another property.'],
+ ],
],
],
],
@@ -5440,22 +4608,34 @@
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"33DBB8EC-6E68-4726-91C4-E09C59D9A7D8\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp\\",\\n \\"MfaDevices\\": [\\n {\\n \\"Id\\": 36,\\n \\"EndUserId\\": \\"alice\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"GmtEnabled\\": \\"2021-06-22T06:20:49Z\\",\\n \\"GmtUnlock\\": \\"2021-06-23T06:20:49Z\\",\\n \\"ConsecutiveFails\\": 0,\\n \\"SerialNumber\\": \\"dc856334-446b-4035-bfbc-18af261e****\\",\\n \\"Status\\": \\"NORMAL\\",\\n \\"DeviceType\\": \\"TOTP_VIRTUAL\\",\\n \\"AdUser\\": {\\n \\"EndUser\\": \\"\\",\\n \\"DisplayName\\": \\"\\",\\n \\"DisplayNameNew\\": \\"\\",\\n \\"UserPrincipalName\\": \\"\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeMfaDevicesResponse>\\n <NextToken>AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp</NextToken>\\n <RequestId>8C09C087-99C3-43F0-BFEA-03E651E04696</RequestId>\\n <MfaDevices>\\n <Status>NORMAL</Status>\\n <DeviceType>TOTP_VIRTUAL</DeviceType>\\n <GmtEnabled>2021-06-22T06:20:49Z</GmtEnabled>\\n <EndUserId>test</EndUserId>\\n <SerialNumber>dc856334-446b-4035-bfbc-18af261e****</SerialNumber>\\n <ConsecutiveFails>0</ConsecutiveFails>\\n <Id>36</Id>\\n </MfaDevices>\\n</DescribeMfaDevicesResponse>","errorExample":""}]',
- 'title' => '查询便捷账号绑定的虚拟MFA设备',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'CreateResourceGroup' => [
- 'summary' => '创建资源组。',
- 'methods' => [
- 'get',
- 'post',
+ 'title' => '修改自定义属性',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2021-08-10T06:35:21.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProperty'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:UpdateProperty',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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":""}]',
+ ],
+ 'UserBatchJoinGroup' => [
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5463,95 +4643,71 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'ResourceGroupName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '资源组名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '部门A资源组',
- ],
- ],
- [
- 'name' => 'IsResourceGroupWithOfficeSite',
- 'in' => 'query',
- 'schema' => [
- 'description' => '> 该参数不对外开放使用。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
- ],
+ 'name' => 'GroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用户组ID。', 'type' => 'string', 'required' => true, 'example' => 'ug-12341234****'],
],
[
- 'name' => 'Platform',
- 'in' => 'query',
+ 'name' => 'EndUserIds',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '对于无影云电脑企业版，固定传入`AliyunConsole`。其他平台暂不支持。',
- 'type' => 'string',
+ 'description' => '用户ID列表。',
+ 'type' => 'array',
+ 'items' => ['description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alex****'],
'required' => false,
- 'enumValueTitles' => [
- 'AliyunConsole' => '无影云电脑企业版',
- ],
- 'example' => 'AliyunConsole',
+ 'maxItems' => 100,
],
],
[
'name' => 'BusinessChannel',
- 'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回信息集合。',
+ 'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '868B8926-2E7A-5BE7-9897-E811E994****',
- ],
- 'ResourceGroupId' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'example' => 'rg-ckf3cx7isinhk***',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7A2C3803-C975-5871-A232-80A91009****'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"868B8926-2E7A-5BE7-9897-E811E994****\\",\\n \\"ResourceGroupId\\": \\"rg-ckf3cx7isinhk***\\"\\n}","type":"json"}]',
- 'title' => '创建无影资源组',
- ],
- 'DeleteResourceGroup' => [
- 'summary' => '删除资源组。',
- 'methods' => [
- 'get',
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '用户组批量添加用户',
+ 'summary' => '为用户组批量添加用户。',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:52.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:UserBatchJoinGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7A2C3803-C975-5871-A232-80A91009****\\"\\n}","type":"json"}]',
+ ],
+ 'UserBatchQuitGroup' => [
+ 'summary' => '批量移除用户组中的用户。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5559,625 +4715,1049 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'ResourceGroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '待删除的资源组ID。'."\n"
- ."\n"
- .'> 如果`ResourceGroupIds`参数不为空，则两个参数同时生效。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-aj01tck67a0szp***',
- ],
+ 'name' => 'GroupId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用户组ID。', 'type' => 'string', 'required' => false, 'example' => 'ug-lkuvalovhnlxvv****'],
],
[
- 'name' => 'ResourceGroupIds',
- 'in' => 'query',
- 'style' => 'flat',
+ 'name' => 'EndUserIds',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => '待删除的资源组ID列表。'."\n"
- ."\n"
- .'> 如果`ResourceGroupIds`参数不为空，则两个参数同时生效。',
+ 'description' => '用户ID列表。',
'type' => 'array',
- 'items' => [
- 'description' => '资源组ID。可以通过调用[DescribeResourceGroups](~~DescribeResourceGroups~~)接口获取。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-eoakjtfdxkk0l***',
- ],
+ 'items' => ['description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alex***'],
'required' => false,
+ 'maxItems' => 100,
],
],
[
'name' => 'BusinessChannel',
- 'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => '渠道', 'description' => '渠道', 'type' => 'string', 'required' => false, 'example' => 'ENTERPRISE', 'default' => 'ENTERPRISE'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '返回信息集合。',
+ 'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '2463A343-BD32-5803-959E-9A8472A1***',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '890JNJNF-SADASSDFS-SDFSDF****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '用户组批量移除用户',
+ 'changeSet' => [
+ ['createdAt' => '2025-12-22T06:38:50.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2463A343-BD32-5803-959E-9A8472A1***\\"\\n}","type":"json"}]',
- 'title' => '删除无影资源组',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:UserBatchQuitGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"890JNJNF-SADASSDFS-SDFSDF****\\"\\n}","type":"json"}]',
],
- 'DescribeResourceGroups' => [
- 'summary' => '查看资源组。',
- 'methods' => [
- 'get',
- 'post',
+ ],
+ 'endpoints' => [
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'eds-user.ap-southeast-1.aliyuncs.com', 'endpoint' => 'eds-user.ap-southeast-1.aliyuncs.com', 'vpc' => 'eds-user-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'eds-user.cn-shanghai.aliyuncs.com', 'endpoint' => 'eds-user.cn-shanghai.aliyuncs.com', 'vpc' => 'eds-user-vpc.cn-shanghai.aliyuncs.com'],
+ ],
+ 'errorCodes' => [],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'DescribeGroups'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeResourceGroups'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'createdAt' => '2025-12-29T02:53:26.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'BatchSetDesktopManager'],
+ ['description' => '请求参数发生变更', 'api' => 'ChangeUserPassword'],
+ ['description' => '请求参数发生变更', 'api' => 'CheckUsedProperty'],
+ ['description' => '请求参数发生变更', 'api' => 'CheckUsedPropertyValue'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateGroup'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateOrg'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateProperty'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateResourceGroup'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateUsers'],
+ ['description' => '请求参数发生变更', 'api' => 'DeleteResourceGroup'],
+ ],
+ 'createdAt' => '2025-12-22T06:39:21.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateUsers'],
+ ['description' => '请求参数发生变更', 'api' => 'DescribeGroups'],
+ ['description' => '响应参数发生变更', 'api' => 'DescribeUsers'],
+ ['description' => '响应参数发生变更', 'api' => 'FilterUsers'],
+ ],
+ 'createdAt' => '2025-11-27T07:01:06.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeUsers'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'FilterUsers'],
],
- 'security' => [
- [
- 'AK' => [],
+ 'createdAt' => '2025-10-20T04:16:20.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'DescribeUsers'],
+ ],
+ 'createdAt' => '2025-04-01T11:55:45.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'FilterUsers'],
+ ],
+ 'createdAt' => '2025-03-24T09:53:39.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeUsers'],
+ ],
+ 'createdAt' => '2025-02-27T12:03:59.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'DescribeUsers'],
+ ],
+ 'createdAt' => '2025-01-02T11:15:48.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'FilterUsers'],
+ ],
+ 'createdAt' => '2024-12-11T07:38:50.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateUsers'],
+ ],
+ 'createdAt' => '2024-12-03T11:44:59.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'LockUsers'],
+ ],
+ 'createdAt' => '2024-11-06T11:10:19.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'DescribeUsers'],
+ ],
+ 'createdAt' => '2024-09-24T06:54:20.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeUsers'],
+ ],
+ 'createdAt' => '2024-09-24T06:17:11.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'FilterUsers'],
+ ],
+ 'createdAt' => '2024-08-15T11:59:59.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'DescribeUsers'],
+ ],
+ 'createdAt' => '2024-07-19T11:27:32.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateUsers'],
+ ['description' => '响应参数发生变更', 'api' => 'FilterUsers'],
+ ],
+ 'createdAt' => '2024-04-09T12:00:24.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'DescribeUsers'],
+ ],
+ 'createdAt' => '2024-01-24T10:01:06.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateUsers'],
+ ],
+ 'createdAt' => '2024-01-16T11:08:29.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'RemoveUsers'],
+ ],
+ 'createdAt' => '2023-12-18T11:15:12.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'DescribeUsers'],
+ ],
+ 'createdAt' => '2023-12-11T13:20:41.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'FilterUsers'],
+ ],
+ 'createdAt' => '2023-10-25T11:43:14.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeUsers'],
+ ],
+ 'createdAt' => '2023-09-23T23:11:34.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateUsers'],
+ ['description' => '请求参数发生变更', 'api' => 'UnlockUsers'],
+ ],
+ 'createdAt' => '2023-08-31T01:58:35.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'DescribeMfaDevices'],
+ ['description' => '请求参数发生变更', 'api' => 'LockMfaDevice'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'RemoveMfaDevice'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'UnlockMfaDevice'],
+ ],
+ 'createdAt' => '2023-08-21T09:01:02.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'DescribeUsers'],
+ ],
+ 'createdAt' => '2023-08-06T01:48:05.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'RemoveMfaDevice'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'UnlockMfaDevice'],
+ ],
+ 'createdAt' => '2023-01-06T06:24:30.000Z',
+ 'description' => '修改参数说明',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'FilterUsers'],
+ ],
+ 'createdAt' => '2022-12-05T05:03:01.000Z',
+ 'description' => '优化属性管理，新增批量操作接口',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CheckUsedProperty'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateProperty'],
+ ['description' => '错误码发生变更', 'api' => 'CreateUsers'],
+ ['description' => '请求参数发生变更', 'api' => 'DeleteUserPropertyValue'],
+ ['description' => '请求参数发生变更', 'api' => 'RemoveUsers'],
+ ['description' => '请求参数发生变更', 'api' => 'SetUserPropertyValue'],
+ ],
+ 'createdAt' => '2022-11-02T06:24:51.000Z',
+ 'description' => '更新接口参数',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateUsers'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeUsers'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'FilterUsers'],
+ ['description' => '请求参数发生变更', 'api' => 'ResetUserPassword'],
+ ],
+ 'createdAt' => '2022-09-08T12:08:43.000Z',
+ 'description' => '目前不对外开放',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'LockMfaDevice'],
+ ],
+ 'createdAt' => '2022-06-08T12:36:16.000Z',
+ 'description' => '修改文档是否必填',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'RemoveProperty'],
+ ],
+ 'createdAt' => '2022-05-10T11:41:13.000Z',
+ 'description' => '修改下参数必填属性',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateUsers'],
+ ],
+ 'createdAt' => '2022-05-10T11:40:21.000Z',
+ 'description' => '修改password参数的最大长度',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'FilterUsers'],
+ ['description' => '响应参数发生变更', 'api' => 'QuerySyncStatusByAliUid'],
+ ],
+ 'createdAt' => '2022-04-29T08:00:10.000Z',
+ 'description' => '添加filterusers的入参类型。根据属性查询详情。',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'FilterUsers'],
+ ],
+ 'createdAt' => '2022-03-23T09:19:05.000Z',
+ 'description' => '获取用户：FilterUsers，增加入参IncludeDesktopGroupCount，增加出参DesktopGroupCount',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'ModifyUser'],
+ ],
+ 'createdAt' => '2022-03-22T09:03:07.000Z',
+ 'description' => '支持修改用户邮箱和手机号',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'FilterUsers'],
+ ['description' => 'OpenAPI 下线', 'api' => 'QuerySyncStatusByAliUid'],
+ ['description' => 'OpenAPI 下线', 'api' => 'SyncAllEduInfo'],
+ ],
+ 'createdAt' => '2022-03-14T10:04:42.000Z',
+ 'description' => '少年云二期增加同步接口。',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'DescribeUsers'],
+ ],
+ 'createdAt' => '2022-01-13T07:51:34.000Z',
+ 'description' => '查询用户增加过滤条件',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'DescribeUsers'],
+ ],
+ 'createdAt' => '2021-08-13T04:08:16.000Z',
+ 'description' => 'DescribeUsers和ListUsers默认MaxResults调整为500',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CheckUsedProperty'],
+ ['description' => 'OpenAPI 下线', 'api' => 'CheckUsedPropertyValue'],
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateProperty'],
+ ['description' => 'OpenAPI 下线', 'api' => 'DeleteUserPropertyValue'],
+ ['description' => 'OpenAPI 下线', 'api' => 'FilterUsers'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ListProperty'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ListPropertyValue'],
+ ['description' => 'OpenAPI 下线', 'api' => 'RemoveProperty'],
+ ['description' => 'OpenAPI 下线', 'api' => 'SetUserPropertyValue'],
+ ['description' => 'OpenAPI 下线', 'api' => 'UpdateProperty'],
+ ],
+ 'createdAt' => '2021-08-10T06:35:45.000Z',
+ 'description' => '无影云桌面用户自定义属性api',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'CreateUsers'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ImportUsers'],
+ ],
+ 'createdAt' => '2021-06-01T12:56:06.000Z',
+ 'description' => 'ImportUsers现在改成异步操作；CreateUsers对于创建失败的用户会返回其邮箱',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'CreateUsers'],
+ ['description' => '请求参数发生变更', 'api' => 'CreateUsers'],
+ ['description' => '请求参数发生变更', 'api' => 'DescribeMfaDevices'],
+ ['description' => '请求参数发生变更', 'api' => 'DescribeMfaDevices'],
+ ['description' => '请求参数发生变更', 'api' => 'DescribeUsers'],
+ ['description' => '请求参数发生变更', 'api' => 'DescribeUsers'],
+ ['description' => '请求参数发生变更', 'api' => 'ImportUsers'],
+ ['description' => '请求参数发生变更', 'api' => 'ImportUsers'],
+ ],
+ 'createdAt' => '2021-04-25T07:57:07.000Z',
+ 'description' => '弹性云桌面便捷账号用户管理OpenAPI发布',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CreateUsers'],
+ ['description' => 'OpenAPI 下线', 'api' => 'DescribeUsers'],
+ ['description' => 'OpenAPI 下线', 'api' => 'ImportUsers'],
+ ],
+ 'createdAt' => '2021-04-02T06:16:12.000Z',
+ 'description' => '添加遗漏的API， DescribeUsers, CreateUsers，ImportUsers',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateProperty'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FilterUsers'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProperty'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveOrg'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyOrg'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUser'],
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockUsers'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckUsedPropertyValue'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockUsers'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeUserPassword'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveMfaDevice'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUserPropertyValue'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOrgByLayer'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveProperty'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchSetDesktopManager'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsers'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncAllEduInfo'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOrgs'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPropertyValue'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckUsedProperty'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveUserOrg'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetUserPassword'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeMfaDevices'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveOrg'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUsers'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockMfaDevice'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserPropertyValue'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateProperty'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrg'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockMfaDevice'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUsers'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'ECD',
+ 'productName' => '无影云电脑',
+ 'ramCodes' => ['ecd', 'eds-user', 'gws', 'wss'],
+ 'ramLevel' => '操作级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'DeleteResourceGroup',
+ 'description' => '删除无影资源组',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ecd:DeleteResourceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'DescribeMfaDevices',
+ 'description' => '查询便捷账号绑定的虚拟MFA设备',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeMfaDevices',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeResourceGroups',
+ 'description' => '查看资源组信息',
'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeResourceGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'parameters' => [
- [
- 'name' => 'ResourceGroupName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '资源组名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '部门A资源组',
+ [
+ 'apiName' => 'ModifyGroup',
+ 'description' => '修改用户组',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:ModifyGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'ResourceGroupIds',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'description' => '资源组ID列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-9th3k8twp3ox2***',
- ],
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'FilterUsers',
+ 'description' => '筛选查询便捷账号信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:FilterUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'PageSize',
- 'in' => 'query',
- 'schema' => [
- 'description' => '每页数量。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
+ ],
+ [
+ 'apiName' => 'DescribeGroups',
+ 'description' => '查询用户组',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeGroups',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'PageNumber',
- 'in' => 'query',
- 'schema' => [
- 'description' => '页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ ],
+ [
+ 'apiName' => 'DescribeGroupUser',
+ 'description' => '查询用户组成员',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeGroupUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'NeedContainResourceGroupWithOfficeSite',
- 'in' => 'query',
- 'schema' => [
- 'description' => '> 该参数不对外开放使用。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '0',
+ ],
+ [
+ 'apiName' => 'UserBatchQuitGroup',
+ 'description' => '用户组批量移除用户',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:UserBatchQuitGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'Platform',
- 'in' => 'query',
- 'schema' => [
- 'description' => '> 固定值：AliyunConsole。'."\n"
- .'> - 无影企业版固定传AliyunConsole，其他平台暂不对外开放。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AliyunConsole',
+ ],
+ [
+ 'apiName' => 'DescribeOrgByLayer',
+ 'description' => '指定父组织查找下级组织',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeOrgByLayer',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'BusinessChannel',
- 'in' => 'query',
- 'schema' => [
- 'title' => '渠道标记',
- 'description' => '渠道标记',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
+ ],
+ [
+ 'apiName' => 'ListProperty',
+ 'description' => '查询属性',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:ListProperty',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'AliyunResourceGroupIds',
- 'in' => 'query',
- 'style' => 'flat',
- 'schema' => [
- 'title' => '云平台资源组ID。',
- 'description' => '云平台资源组ID。',
- 'type' => 'array',
- 'items' => [
- 'title' => '资源组ID。',
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rg-as8nlsbsxsldk***',
- ],
- 'required' => false,
+ ],
+ [
+ 'apiName' => 'SetUserPropertyValue',
+ 'description' => '为用户设置自定义属性',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:SetUserPropertyValue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回信息集合。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '68BA1DF7-8814-5AED-B844-F8F7F7****',
- ],
- 'ResourceGroup' => [
- 'description' => '资源组信息列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '资源组信息。',
- 'type' => 'object',
- 'properties' => [
- 'ResourceGroupId' => [
- 'description' => '资源组ID。',
- 'type' => 'string',
- 'example' => 'rg-cyo0il2pzge1***',
- ],
- 'ResourceGroupName' => [
- 'description' => '资源组名称。',
- 'type' => 'string',
- 'example' => '测试资源组',
- ],
- 'ResourceCount' => [
- 'description' => '资源组内的资源数量。',
- 'type' => 'string',
- 'example' => '119',
- ],
- 'AuthCount' => [
- 'description' => '资源组授权的管理员数量。',
- 'type' => 'string',
- 'example' => '3',
- ],
- 'CreateTime' => [
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2022-11-29T17:25:40.000000000Z',
- ],
- 'Policies' => [
- 'description' => '> 资源组关联的策略。'."\n"
- .'> - 关联策略会对资源组内的云电脑生效，如果有多个策略，会按策略的优先级生效。'."\n"
- .'> - 如果资源组内的云电脑本身已指定其他策略，资源组关联的策略优先生效。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '策略ID。',
- 'type' => 'string',
- 'example' => 'pl-a8jnatl8kjasb***',
- ],
- 'Name' => [
- 'description' => '策略名称。',
- 'type' => 'string',
- 'example' => '测试策略123',
- ],
- 'IsDefault' => [
- 'description' => '是否默认策略。',
- 'type' => 'boolean',
- 'example' => 'False',
- ],
- ],
- ],
- ],
- 'Timers' => [
- 'description' => '> 关联的定时任务。'."\n"
- .'> - 关联的定时任务会对资源组内的云电脑生效，如果资源组内的云电脑本身已关联其他定时任务，资源组关联的任务优先生效。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '定时任务ID。',
- 'type' => 'string',
- 'example' => 't-asdzx0mbjhg***',
- ],
- 'Name' => [
- 'description' => '定时任务名称。',
- 'type' => 'string',
- 'example' => '测试任务123',
- ],
- 'TimerStatus' => [
- 'type' => 'string',
- ],
- 'BindStatus' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'AppRules' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'type' => 'string',
- ],
- 'Name' => [
- 'type' => 'string',
- ],
- 'Type' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- ],
- 'AliyunResourceGroupId' => [
- 'title' => '阿里云资源组ID',
- 'description' => '阿里云资源组ID',
- 'type' => 'string',
- 'example' => 'rg-123456',
- ],
- ],
- ],
- ],
- 'TotalCount' => [
- 'description' => '资源组总个数。',
- 'type' => 'string',
- 'example' => '7',
- ],
- ],
+ [
+ 'apiName' => 'RemoveOrg',
+ 'description' => '移除组织',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ecd:RemoveOrg',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'BatchSetDesktopManager',
+ 'description' => '为便捷账号添加或去除本地管理员权限',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:BatchSetDesktopManager',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"68BA1DF7-8814-5AED-B844-F8F7F7****\\",\\n \\"ResourceGroup\\": [\\n {\\n \\"ResourceGroupId\\": \\"rg-cyo0il2pzge1***\\",\\n \\"ResourceGroupName\\": \\"测试资源组\\",\\n \\"ResourceCount\\": \\"119\\",\\n \\"AuthCount\\": \\"3\\",\\n \\"CreateTime\\": \\"2022-11-29T17:25:40.000000000Z\\",\\n \\"Policies\\": [\\n {\\n \\"Id\\": \\"pl-a8jnatl8kjasb***\\",\\n \\"Name\\": \\"测试策略123\\",\\n \\"IsDefault\\": true\\n }\\n ],\\n \\"Timers\\": [\\n {\\n \\"Id\\": \\"t-asdzx0mbjhg***\\",\\n \\"Name\\": \\"测试任务123\\",\\n \\"TimerStatus\\": \\"\\",\\n \\"BindStatus\\": \\"\\"\\n }\\n ],\\n \\"AppRules\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Type\\": 0\\n }\\n ],\\n \\"AliyunResourceGroupId\\": \\"rg-123456\\"\\n }\\n ],\\n \\"TotalCount\\": \\"7\\"\\n}","type":"json"}]',
- 'title' => '查看资源组信息',
- ],
- 'SyncAllEduInfo' => [
- 'summary' => '同步所有教育信息。',
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'RemoveUsers',
+ 'description' => '删除便捷账号',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ecd:RemoveUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'CreateGroup',
+ 'description' => '创建用户组',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ecd:CreateGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'CheckUsedPropertyValue',
+ 'description' => '查询关联指定属性值的用户数',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:CheckUsedPropertyValue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'MoveOrg',
+ 'description' => '移动组织',
'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:MoveOrg',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'BaseResult',
- 'description' => '返回信息集合。',
- 'type' => 'object',
- 'properties' => [
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'description' => '状态码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- ],
+ [
+ 'apiName' => 'UnlockUsers',
+ 'description' => '解锁便捷账号',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:UnlockUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => '同步所有教育信息',
- ],
- 'QuerySyncStatusByAliUid' => [
- 'summary' => '查询用户同步状态。',
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'UnlockMfaDevice',
+ 'description' => '解锁虚拟MFA设备',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:UnlockMfaDevice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'GetManagerInfoByAuthCode',
+ 'description' => '根据authcode获取当前登录的管理员信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:GetManagerInfoByAuthCode',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'CreateOrg',
+ 'description' => '创建组织',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ecd:CreateOrg',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'DeleteUserPropertyValue',
+ 'description' => '为用户移除自定义属性',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ecd:DeleteUserPropertyValue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CheckUsedProperty',
+ 'description' => '查询关联指定属性的用户数',
'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
+ 'ramAction' => [
+ 'action' => 'ecd:CheckUsedProperty',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'parameters' => [
- [
- 'name' => 'BusinessChannel',
- 'in' => 'query',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
+ [
+ 'apiName' => 'QuerySyncStatusByAliUid',
+ 'description' => '查询用户同步状态',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:QuerySyncStatusByAliUid',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'PlainResult<UserSyncHistoryDo>',
- 'description' => '返回信息集合。',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => 'auto-increased id',
- 'description' => '自增ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '18500',
- ],
- 'GmtCreated' => [
- 'title' => 'created time',
- 'description' => '创建时间。',
- 'type' => 'string',
- 'example' => '2020-06-30 07:50:42',
- ],
- 'GmtModified' => [
- 'title' => 'modified time',
- 'description' => '修改时间。',
- 'type' => 'string',
- 'example' => '2022-03-02 14:27:39',
- ],
- 'AliUid' => [
- 'title' => 'aliUid of the customer',
- 'description' => '阿里云账号ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '131239236086****',
- ],
- 'Status' => [
- 'title' => 'user sync status',
- 'description' => '用户同步状态。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'CorpId' => [
- 'title' => 'corp id',
- 'description' => '企业ID。',
- 'type' => 'string',
- 'example' => 'cdrs948144195608****',
- ],
- 'LatestBeginTime' => [
- 'title' => 'latestBeginTime',
- 'description' => '最后开始时间。',
- 'type' => 'string',
- 'example' => '2022-03-02 14:31:39',
- ],
- 'LatestEndTime' => [
- 'title' => 'atest_end_time,Whether it is success or failure',
- 'description' => '最后结束时间，不论成功或失败。',
- 'type' => 'string',
- 'example' => '2022-03-02 16:13:12',
- ],
- 'LatestSuccessTime' => [
- 'title' => 'latestSuccessTime',
- 'description' => '最后成功时间。',
- 'type' => 'string',
- 'example' => '2022-03-02 18:24:01',
- ],
- ],
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'description' => '系统状态码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '请求失败的提示信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
- ],
- ],
+ [
+ 'apiName' => 'ResetUserPassword',
+ 'description' => '重置便捷账号的密码',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:ResetUserPassword',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Id\\": 18500,\\n \\"GmtCreated\\": \\"2020-06-30 07:50:42\\",\\n \\"GmtModified\\": \\"2022-03-02 14:27:39\\",\\n \\"AliUid\\": 0,\\n \\"Status\\": \\"success\\",\\n \\"CorpId\\": \\"cdrs948144195608****\\",\\n \\"LatestBeginTime\\": \\"2022-03-02 14:31:39\\",\\n \\"LatestEndTime\\": \\"2022-03-02 16:13:12\\",\\n \\"LatestSuccessTime\\": \\"2022-03-02 18:24:01\\"\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
- 'title' => '查询用户同步状态',
- ],
- 'ChangeUserPassword' => [
- 'summary' => '当用户为管理员激活模式时，可以通过该接口修改用户登录密码。',
- 'methods' => [
- 'get',
- 'post',
+ [
+ 'apiName' => 'ChangeUserPassword',
+ 'description' => '修改用户密码',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:ChangeUserPassword',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'RemoveGroup',
+ 'description' => '删除用户组',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ecd:RemoveGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'UpdateProperty',
+ 'description' => '修改自定义属性',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:UpdateProperty',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'RemoveProperty',
+ 'description' => '删除用户自定义属性',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ecd:RemoveProperty',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateProperty',
+ 'description' => '创建用户自定义属性',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ecd:CreateProperty',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeUsers',
+ 'description' => '查询便捷账号信息',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateResourceGroup',
+ 'description' => '创建无影资源组',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ecd:CreateResourceGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateUsers',
+ 'description' => '创建便捷账号',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ecd:CreateUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'LockUsers',
+ 'description' => '锁定便捷账号',
'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
+ 'ramAction' => [
+ 'action' => 'ecd:LockUsers',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'parameters' => [
- [
- 'name' => 'EndUserId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '要修改密码的便捷账号的用户名。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'alice***',
+ [
+ 'apiName' => 'ListPropertyValue',
+ 'description' => '查询用户自定义属性值',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ecd:ListPropertyValue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'NewPassword',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '用户的新密码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Admin@12***',
+ ],
+ [
+ 'apiName' => 'RemoveMfaDevice',
+ 'description' => '删除便捷账号绑定的虚拟MFA设备',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ecd:RemoveMfaDevice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'BusinessChannel',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '渠道',
- 'description' => '渠道',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ENTERPRISE',
- 'default' => 'ENTERPRISE',
+ ],
+ [
+ 'apiName' => 'DescribeUser',
+ 'description' => '查询用户信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回信息集合。',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'AA8D67CB-345D-5CDA-986E-FFAC7D0****',
- ],
- ],
+ [
+ 'apiName' => 'LockMfaDevice',
+ 'description' => '锁定虚拟MFA设备',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:LockMfaDevice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UserBatchJoinGroup',
+ 'description' => '用户组批量添加用户',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:UserBatchJoinGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'MoveUserOrg',
+ 'description' => '移动用户到目标组织架构',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ecd:MoveUserOrg',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyUser',
+ 'description' => '修改便捷账号的联系方式',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:ModifyUser',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'InitTenantAlias',
+ 'description' => '初始化组织ID',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ecd:InitTenantAlias',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModifyOrg',
+ 'description' => '修改组织',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'ecd:ModifyOrg',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SyncAllEduInfo',
+ 'description' => '同步所有教育信息',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ecd:SyncAllEduInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeOrgs',
+ 'description' => '查询组织列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ecd:DescribeOrgs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA8D67CB-345D-5CDA-986E-FFAC7D0****\\"\\n}","type":"json"}]',
- 'title' => '修改用户密码',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'eds-user.cn-shanghai.aliyuncs.com',
],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'eds-user.ap-southeast-1.aliyuncs.com',
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'User', 'arn' => 'acs:ecd::{#accountId}:*'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 18:43:18 +0000