'1.0',
'info' => ['style' => 'RPC', 'product' => 'Ims', 'version' => '2019-08-15'],
'directories' => [
[
'children' => [
[
'children' => ['CreateUser', 'GetUser', 'UpdateUser', 'DeleteUser', 'ListUsers', 'ListUserBasicInfos', 'GetAccountSummary'],
'type' => 'directory',
'title' => '用户',
'id' => 49688,
],
[
'children' => ['CreateLoginProfile', 'GetLoginProfile', 'UpdateLoginProfile', 'DeleteLoginProfile', 'ChangePassword'],
'type' => 'directory',
'title' => '登录信息',
'id' => 49678,
],
[
'children' => ['CreateAccessKey', 'DeleteAccessKey', 'UpdateAccessKey', 'GetAccessKeyLastUsed', 'ListAccessKeys', 'GetAccessKeyPolicy', 'SetAccessKeyPolicy', 'CreateServiceCredential', 'DeleteServiceCredential', 'UpdateServiceCredential', 'GetServiceCredential', 'ListServiceCredentials'],
'type' => 'directory',
'title' => '访问密钥',
'id' => 49672,
],
[
'children' => ['GetVerificationInfo', 'CreateVirtualMFADevice', 'ListVirtualMFADevices', 'DeleteVirtualMFADevice', 'DisableVirtualMFA', 'BindMFADevice', 'UnbindMFADevice', 'GetAccountMFAInfo', 'GetUserMFAInfo', 'SetVerificationInfo', 'UnbindVerification'],
'type' => 'directory',
'title' => '多因素认证',
'id' => 49696,
],
[
'children' => ['TagResources', 'UntagResources', 'ListTagResources'],
'type' => 'directory',
'title' => '标签',
'id' => 49684,
],
[
'children' => ['UpdatePasskey', 'ListPasskeys', 'DeletePasskey'],
'type' => 'directory',
'title' => '通行密钥',
'id' => 49708,
],
[
'children' => ['ListUsersInRecycleBin', 'GetUserInRecycleBin', 'DeleteUserInRecycleBin', 'RestoreUserFromRecycleBin', 'ListAccessKeysInRecycleBin', 'GetAccessKeyInfoInRecycleBin', 'DeleteAccessKeyInRecycleBin', 'RestoreAccessKeyFromRecycleBin'],
'type' => 'directory',
'title' => '回收站',
'id' => 49712,
],
],
'type' => 'directory',
'title' => '用户管理',
'id' => 49671,
],
[
'children' => ['CreateGroup', 'GetGroup', 'UpdateGroup', 'DeleteGroup', 'ListGroups', 'AddUserToGroup', 'RemoveUserFromGroup', 'ListUsersForGroup', 'ListGroupsForUser'],
'type' => 'directory',
'title' => '用户组管理',
'id' => 49615,
],
[
'children' => ['SetUserSsoSettings', 'GetUserSsoSettings', 'CreateSAMLProvider', 'DeleteSAMLProvider', 'UpdateSAMLProvider', 'GetSAMLProvider', 'ListSAMLProviders', 'CreateOIDCProvider', 'GetOIDCProvider', 'UpdateOIDCProvider', 'ListOIDCProviders', 'DeleteOIDCProvider', 'AddClientIdToOIDCProvider', 'RemoveClientIdFromOIDCProvider', 'AddFingerprintToOIDCProvider', 'RemoveFingerprintFromOIDCProvider'],
'type' => 'directory',
'title' => '单点登录(SSO)管理',
'id' => 49625,
],
[
'children' => ['CreateApplication', 'GetApplication', 'UpdateApplication', 'DeleteApplication', 'ListApplications', 'ListPredefinedScopes', 'CreateAppSecret', 'GetAppSecret', 'ListAppSecretIds', 'DeleteAppSecret', 'ProvisionApplication', 'DeprovisionApplication', 'ListApplicationProvisionInfos', 'GetApplicationProvisionInfo', 'ProvisionExternalApplication', 'DeprovisionExternalApplication', 'ListExternalApplications', 'GetExternalApplication'],
'type' => 'directory',
'title' => '开放授权(OAuth)管理',
'id' => 49642,
],
[
'children' => ['SetPasswordPolicy', 'GetPasswordPolicy', 'SetSecurityPreference', 'GetSecurityPreference', 'SetDefaultDomain', 'GetDefaultDomain', 'GetCredentialReport', 'GetAccountSecurityPracticeReport', 'GenerateCredentialReport'],
'type' => 'directory',
'title' => '安全设置',
'id' => 49661,
],
[
'children' => ['GenerateGovernanceReport', 'GetGovernanceReportStatus', 'GetGovernanceItemReport', 'ListRecentGovernanceMetrics'],
'type' => 'directory',
'title' => '身份权限治理',
'id' => 49721,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AddClientIdToOIDCProvider' => [
'summary' => '调用AddClientIdToOIDCProvider为OIDC身份提供商添加指定客户端ID。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'OIDCProviderName',
'in' => 'query',
'schema' => ['description' => 'OIDC身份提供商的名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'TestOIDCProvider'],
],
[
'name' => 'ClientId',
'in' => 'query',
'schema' => ['description' => '指定的客户端ID。'."\n"
."\n"
.'格式:允许英文字母、数字、特殊字符`.-_:/`,不能以特殊字符`.-_:/`开头。'."\n"
."\n"
.'长度:最大128个字符。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '598469743454717****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B49B8FA7-87FC-5308-AE75-5EC9E36C360A'],
'OIDCProvider' => [
'description' => 'OIDC身份提供商信息。',
'type' => 'object',
'properties' => [
'UpdateDate' => ['description' => '修改时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-12T08:38:29Z'],
'Description' => ['description' => 'OIDC身份提供商的描述。', 'type' => 'string', 'example' => 'This is a new OIDC Provider.'],
'OIDCProviderName' => ['description' => 'OIDC身份提供商的名称。', 'type' => 'string', 'example' => 'TestOIDCProvider'],
'CreateDate' => ['description' => '创建时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-11T06:56:03Z'],
'Arn' => ['description' => 'OIDC身份提供商的ARN。', 'type' => 'string', 'example' => 'acs:ram::177242285274****:oidc-provider/TestOIDCProvider'],
'IssuerUrl' => ['description' => '颁发者URL。', 'type' => 'string', 'example' => 'https://xxxxxx.example.com'],
'Fingerprints' => ['description' => 'HTTPS CA证书的验证指纹。多个之间用半角逗号(,)分隔。', 'type' => 'string', 'example' => '902ef2deeb3c5b13ea4c3d5193629309e231****'],
'ClientIds' => ['description' => '客户端ID。多个之间用半角逗号(,)分隔。', 'type' => 'string', 'example' => '498469743454717****,598469743454717****'],
'GmtCreate' => ['description' => '创建时间(时间戳)。', 'type' => 'string', 'example' => '1636613763000'],
'GmtModified' => ['description' => '修改时间(时间戳)。', 'type' => 'string', 'example' => '1636706309000'],
'IssuanceLimitTime' => ['description' => '允许外部IdP颁发ID Token的最早签发时间。ID Token中的iat字段如果距离当前时间大于这个值则请求会被拒绝。'."\n"
.'单位:小时。取值范围:1~168。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '为OIDC身份提供商添加指定客户端ID',
'description' => '### 使用说明'."\n"
.'本文将提供一个示例,为名为`TestOIDCProvider`的OIDC身份提供商添加客户端ID`598469743454717****`。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~187377~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddClientIdToOIDCProvider'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:AddClientIdToOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B49B8FA7-87FC-5308-AE75-5EC9E36C360A\\",\\n \\"OIDCProvider\\": {\\n \\"UpdateDate\\": \\"2021-11-12T08:38:29Z\\",\\n \\"Description\\": \\"This is a new OIDC Provider.\\",\\n \\"OIDCProviderName\\": \\"TestOIDCProvider\\",\\n \\"CreateDate\\": \\"2021-11-11T06:56:03Z\\",\\n \\"Arn\\": \\"acs:ram::177242285274****:oidc-provider/TestOIDCProvider\\",\\n \\"IssuerUrl\\": \\"https://xxxxxx.example.com\\",\\n \\"Fingerprints\\": \\"902ef2deeb3c5b13ea4c3d5193629309e231****\\",\\n \\"ClientIds\\": \\"498469743454717****,598469743454717****\\",\\n \\"GmtCreate\\": \\"1636613763000\\",\\n \\"GmtModified\\": \\"1636706309000\\",\\n \\"IssuanceLimitTime\\": 12\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n B49B8FA7-87FC-5308-AE75-5EC9E36C360A\\n \\n 2021-11-12T08:38:29Z\\n This is a new OIDC Provider.\\n TestOIDCProvider\\n 2021-11-11T06:56:03Z\\n acs:ram::177242285274****:oidc-provider/TestOIDCProvider\\n https://dev-xxxxxx.okta.com\\n 902ef2deeb3c5b13ea4c3d5193629309e231****\\n 498469743454717****,598469743454717****\\n 1636613763000\\n 1636706309000\\n 12\\n \\n","errorExample":""}]',
],
'AddFingerprintToOIDCProvider' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'OIDCProviderName',
'in' => 'query',
'schema' => ['description' => 'OIDC身份提供商的名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'TestOIDCProvider'],
],
[
'name' => 'Fingerprint',
'in' => 'query',
'schema' => ['description' => 'HTTPS CA证书的验证指纹。'."\n"
."\n"
.'格式:允许英文字母和数字。'."\n"
."\n"
.'长度:最大128个字符。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '902ef2deeb3c5b13ea4c3d5193629309e231****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4B809BBC-0E78-544A-A91A-648926412E3E'],
'OIDCProvider' => [
'description' => 'OIDC身份提供商的名称。',
'type' => 'object',
'properties' => [
'UpdateDate' => ['description' => '修改时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-12T08:38:29Z'],
'Description' => ['description' => 'OIDC身份提供商的描述。', 'type' => 'string', 'example' => 'This is a new OIDC Provider.'],
'OIDCProviderName' => ['description' => 'OIDC身份提供商的名称。', 'type' => 'string', 'example' => 'TestOIDCProvider'],
'CreateDate' => ['description' => '创建时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-11T06:56:03Z'],
'Arn' => ['description' => 'OIDC身份提供商的ARN。', 'type' => 'string', 'example' => 'acs:ram::177242285274****:oidc-provider/OIDCProvider'],
'IssuerUrl' => ['description' => 'OIDC身份提供商的颁发者URL。', 'type' => 'string', 'example' => 'https://xxxxxx.example.com'],
'Fingerprints' => ['description' => 'HTTPS CA证书的验证指纹。多个之间用半角逗号(,)分隔。', 'type' => 'string', 'example' => '502ef2deeb3c5b13ea4c3d5193629309e231****,902ef2deeb3c5b13ea4c3d5193629309e231****'],
'ClientIds' => ['description' => '客户端ID。多个之间用半角逗号(,)分隔。', 'type' => 'string', 'example' => '498469743454717****'],
'GmtCreate' => ['description' => '创建时间(时间戳)。', 'type' => 'string', 'example' => '1636613763000'],
'GmtModified' => ['description' => '修改时间(时间戳)。', 'type' => 'string', 'example' => '1636706309000'],
'IssuanceLimitTime' => ['description' => '允许外部IdP颁发ID Token的最早签发时间。ID Token中的iat字段如果距离当前时间大于这个值则请求会被拒绝。'."\n"
.'单位:小时。取值范围:1~168。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '为OIDC身份提供商添加验证指纹',
'summary' => '调用AddFingerprintToOIDCProvider为OIDC身份提供商添加验证指纹。',
'description' => '### 使用说明'."\n"
.'本文将提供一个示例,为名为`TestOIDCProvider`的OIDC身份提供商添加一个验证指纹`902ef2deeb3c5b13ea4c3d5193629309e231****`。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~187377~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFingerprintToOIDCProvider'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:AddFingerprintToOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4B809BBC-0E78-544A-A91A-648926412E3E\\",\\n \\"OIDCProvider\\": {\\n \\"UpdateDate\\": \\"2021-11-12T08:38:29Z\\",\\n \\"Description\\": \\"This is a new OIDC Provider.\\",\\n \\"OIDCProviderName\\": \\"TestOIDCProvider\\",\\n \\"CreateDate\\": \\"2021-11-11T06:56:03Z\\",\\n \\"Arn\\": \\"acs:ram::177242285274****:oidc-provider/OIDCProvider\\",\\n \\"IssuerUrl\\": \\"https://xxxxxx.example.com\\",\\n \\"Fingerprints\\": \\"502ef2deeb3c5b13ea4c3d5193629309e231****,902ef2deeb3c5b13ea4c3d5193629309e231****\\",\\n \\"ClientIds\\": \\"498469743454717****\\",\\n \\"GmtCreate\\": \\"1636613763000\\",\\n \\"GmtModified\\": \\"1636706309000\\",\\n \\"IssuanceLimitTime\\": 12\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4B809BBC-0E78-544A-A91A-648926412E3E\\n \\n 2021-11-12T08:38:29Z\\n This is a new OIDC Provider.\\n TestOIDCProvider\\n 2021-11-11T06:56:03Z\\n acs:ram::177242285274****:oidc-provider/OIDCProvider\\n https://dev-xxxxxx.okta.com\\n 502ef2deeb3c5b13ea4c3d5193629309e231****,902ef2deeb3c5b13ea4c3d5193629309e231****\\n 498469743454717****\\n 1636613763000\\n 1636706309000\\n 12\\n \\n","errorExample":""}]',
],
'AddUserToGroup' => [
'summary' => '将指定的RAM用户添加到指定的用户组。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram3V29VK'],
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '用户组名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Test-Team'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '85836703-8D4F-485F-9726-4D1C730F957E'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '将RAM用户添加到指定的用户组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUserToGroup'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:AddUserToGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/{#GroupName}'],
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"85836703-8D4F-485F-9726-4D1C730F957E\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 85836703-8D4F-485F-9726-4D1C730F957E\\r\\n","errorExample":""}]',
],
'BindMFADevice' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '7428',
'abilityTreeNodes' => ['FEATUREramCFN0GB'],
'autoTest' => false,
'notSupportAutoTestReason' => '无法通过测试平台自动生成MFA Code',
],
'parameters' => [
[
'name' => 'SerialNumber',
'in' => 'query',
'schema' => ['description' => '多因素认证设备的序列号。'."\n"
."\n"
.'> 您可以调用[CreateVirtualMFADevice](~~186179~~)获取多因素认证设备的序列号。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'acs:ram::177242285274****:mfa/device001'],
],
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'AuthenticationCode1',
'in' => 'query',
'schema' => ['description' => '第一组安全验证码。'."\n"
."\n"
.'> 您可以调用[CreateVirtualMFADevice](~~186179~~)创建多因素认证设备并生成密钥(`Base32StringSeed`的值),然后使用该密钥在移动端阿里云应用中手动添加多因素认证设备,最后获取连续的两组安全验证码。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '123456'],
],
[
'name' => 'AuthenticationCode2',
'in' => 'query',
'schema' => ['description' => '第二组安全验证码。'."\n"
."\n"
.'> 您可以调用[CreateVirtualMFADevice](~~186179~~)创建多因素认证设备并生成密钥(`Base32StringSeed`的值),然后使用该密钥在移动端阿里云应用中手动添加多因素认证设备,最后获取连续的两组安全验证码。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '654321'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B9AF80E4-1565-42D9-9256-0B8B0D9FD3EC'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '为RAM用户绑定多因素认证设备',
'summary' => '为RAM用户绑定指定的多因素认证设备。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindMFADevice'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:BindMFADevice',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B9AF80E4-1565-42D9-9256-0B8B0D9FD3EC\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n B9AF80E4-1565-42D9-9256-0B8B0D9FD3EC\\r\\n","errorExample":""}]',
],
'ChangePassword' => [
'summary' => 'RAM用户为自己修改控制台登录密码。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '7429',
'abilityTreeNodes' => ['FEATUREramFSAEMQ'],
'autoTest' => false,
'notSupportAutoTestReason' => '该API只支持子用户调用,企业级能力验证时无法通过测试平台使用子用户的凭证调用API',
],
'parameters' => [
[
'name' => 'OldPassword',
'in' => 'query',
'schema' => ['description' => 'RAM用户的控制台登录旧密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mypassword'],
],
[
'name' => 'NewPassword',
'in' => 'query',
'schema' => ['description' => 'RAM用户的控制台登录新密码。'."\n"
."\n"
.'密码必须符合密码强度要求。关于如何获取密码强度要求,请参见[GetPasswordPolicy](~~186691~~)。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'newpassword'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'RAM用户修改自己的登录密码',
'description' => '> 该API仅限RAM用户调用。调用前,请确保已将[SetSecurityPreference](~~43765~~)中的`AllowUserToChangePassword`设置为`True`,即允许RAM用户自主管理密码。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangePassword'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:ChangePassword',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t04F0F334-1335-436C-A1D7-6C044FE73368\\r\\n","errorExample":""}]',
],
'CreateAccessKey' => [
'summary' => '创建阿里云账号(主账号)或RAM用户的访问密钥。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram6Y0S22'],
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。'."\n"
."\n"
.'如果为空,默认为当前用户创建访问密钥。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '19DDD9F7-AFCC-4D72-8CBA-CCE5A142E7AB'],
'AccessKey' => [
'description' => '访问密钥。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '访问密钥的状态。取值:'."\n"
."\n"
.'- Active:已激活。'."\n"
.'- Inactive:已禁用。', 'type' => 'string', 'example' => 'Active'],
'AccessKeySecret' => ['description' => '访问密钥。', 'type' => 'string', 'example' => 'yourAccessKeySecret'],
'AccessKeyId' => ['description' => '访问密钥ID。', 'type' => 'string', 'example' => 'yourAccessKeyID'],
'CreateDate' => ['description' => '访问密钥的创建时间。', 'type' => 'string', 'example' => '2020-10-15T08:08:54Z'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建主账号或RAM用户访问密钥',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccessKey'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateAccessKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"19DDD9F7-AFCC-4D72-8CBA-CCE5A142E7AB\\",\\n \\"AccessKey\\": {\\n \\"Status\\": \\"Active\\",\\n \\"AccessKeySecret\\": \\"yourAccessKeySecret\\",\\n \\"AccessKeyId\\": \\"yourAccessKeyID\\",\\n \\"CreateDate\\": \\"2020-10-15T08:08:54Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t19DDD9F7-AFCC-4D72-8CBA-CCE5A142E7AB\\r\\n\\t\\r\\n\\t\\tActive\\r\\n\\t\\tLTAI4G3HaMmeHpay2gcq****\\r\\n\\t\\tY3MSLE6OgizS4qrz5LVFDoyZEL****\\r\\n\\t\\t2020-10-15T08:08:54Z\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
],
'CreateAppSecret' => [
'summary' => '为指定的应用创建一个应用密钥。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramQ794FD'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '472457090344041****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE46FC3C-3BDE-4771-B531-27B7B6EB533D'],
'AppSecret' => [
'description' => '应用密钥信息。',
'type' => 'object',
'properties' => [
'AppSecretValue' => ['description' => '应用密钥内容。该值可作为OAuth的应用密钥(Client Secret)使用。', 'type' => 'string', 'example' => 'ai78ZmmxnlUG1jXlBZRDFKos9DIjY4m17Q7dCpMwn1rqXsTGb1X1XmrmveMp****'],
'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => '472457090344041****'],
'AppSecretId' => ['description' => '应用密钥ID。', 'type' => 'string', 'example' => '2efd5004-005c-4f05-83c6-5b1dd176****'],
'CreateDate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-10-26T02:52:31Z'],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '为指定的应用创建应用密钥',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppSecret'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateAppSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE46FC3C-3BDE-4771-B531-27B7B6EB533D\\",\\n \\"AppSecret\\": {\\n \\"AppSecretValue\\": \\"ai78ZmmxnlUG1jXlBZRDFKos9DIjY4m17Q7dCpMwn1rqXsTGb1X1XmrmveMp****\\",\\n \\"AppId\\": \\"472457090344041****\\",\\n \\"AppSecretId\\": \\"2efd5004-005c-4f05-83c6-5b1dd176****\\",\\n \\"CreateDate\\": \\"2020-10-26T02:52:31Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\tEE46FC3C-3BDE-4771-B531-27B7B6EB533D\\r\\n\\t\\r\\n\\t\\t472457090344041****\\r\\n\\t\\tai78ZmmxnlUG1jXlBZRDFKos9DIjY4m17Q7dCpMwn1rqXsTGb1X1XmrmveMp****\\r\\n\\t\\t2efd5004-005c-4f05-83c6-5b1dd176****\\r\\n\\t\\t2020-10-26T02:52:31Z\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]',
],
'CreateApplication' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramV0FSPT'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => ['description' => '应用的显示名称。'."\n"
."\n"
.'最大长度为24个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'myapp'],
],
[
'name' => 'AppType',
'in' => 'query',
'schema' => ['description' => '应用类型。取值:'."\n"
."\n"
.'- WebApp:指基于浏览器交互的网络应用。 '."\n"
.'- NativeApp:指操作系统中运行的本地应用,主要为运行在桌面操作系统或移动操作系统中的应用。 '."\n"
.'- ServerApp:指直接访问阿里云服务,而无需依赖用户登录的应用,目前仅支持基于SCIM协议的用户同步应用。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'WebApp'],
],
[
'name' => 'RedirectUris',
'in' => 'query',
'schema' => ['description' => '回调地址。'."\n"
."\n"
.'输入多个时,以英文分号(;)分隔。', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com'],
],
[
'name' => 'SecretRequired',
'in' => 'query',
'schema' => ['description' => '是否需要应用密钥。取值:'."\n"
."\n"
.'- true'."\n"
.'- false'."\n"
."\n"
.'> - 对于WebApp和ServerApp类型的应用,该值会被强制设置为true,不支持修改。'."\n"
.'- 对于NativeApp类型的应用,可以设置为true或false,如不设置,默认为false。由于此类应用往往运行在非可信环境,无法有效保护应用密钥,因此建议您如无明确需要,不要设置为true。更多信息,请参见[Native应用登录阿里云](~~93697~~)。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'AccessTokenValidity',
'in' => 'query',
'schema' => ['description' => '访问令牌有效期。'."\n"
."\n"
.'取值范围:900~10800。单位:秒。'."\n"
."\n"
.'默认值:3600。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600'],
],
[
'name' => 'RefreshTokenValidity',
'in' => 'query',
'schema' => ['description' => '刷新令牌有效期。'."\n"
."\n"
.'取值范围:7200~31536000。单位:秒。'."\n"
."\n"
.'默认值:'."\n"
."\n"
.'- 对于NativeApp和ServerApp类型的应用,如果该值为空,则默认为2592000秒(即30天)。'."\n"
.'- 对于WebApp类型的应用,如果该值为空,则默认为7776000秒(即90天)。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2592000'],
],
[
'name' => 'PredefinedScopes',
'in' => 'query',
'schema' => ['description' => '应用权限范围。'."\n"
."\n"
.'关于应用权限范围的取值和描述,请参见[OAuth范围](~~93693~~)。您也可以调用[ListPredefinedScopes](~~187206~~)获取不同应用类型支持的应用权限范围。'."\n"
."\n"
.'输入多个应用权限范围时,以英文分号(;)分隔。', 'type' => 'string', 'required' => false, 'example' => 'aliuid;profile'],
],
[
'name' => 'RequiredScopes',
'in' => 'query',
'schema' => ['description' => '必选的应用权限范围。'."\n"
."\n"
.'您可以将`RequiredScopes`中设置的一个或多个范围设为必选,设为必选后,当用户进行应用授权时,必选范围默认选中且不可取消。'."\n"
."\n"
.'输入多个应用权限范围时,以英文分号(;)分隔。'."\n"
."\n"
.'> 如果您设置的`RequiredScopes`项不在`PredefinedScopes`的范围内,则该项必选范围不生效。', 'type' => 'string', 'required' => false, 'example' => 'aliuid'],
],
[
'name' => 'IsMultiTenant',
'in' => 'query',
'schema' => ['description' => '是否允许被其他账号安装。取值:'."\n"
."\n"
.'- true:对于NativeApp和ServerApp类型的应用,如果该值为空,则默认为true。'."\n"
.'- false:对于WebApp类型的应用,如果该值为空,则默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'AppName',
'in' => 'query',
'schema' => ['description' => '应用名称。'."\n"
."\n"
.'最大长度为64 个字符,允许输入英文字母、数字、英文句点(.)、下划线(_)或中划线(-)。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'myapp'],
],
[
'name' => 'ProtocolVersion',
'in' => 'query',
'schema' => ['description' => '应用的OAuth协议版本。取值:'."\n"
.'+ `2.0`:表示为OAuth 2.0协议。'."\n"
.'+ `2.1`:表示为OAuth 2.1协议。'."\n"
."\n"
.'默认值:`2.0`。', 'type' => 'string', 'required' => false, 'example' => '2.0'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6616F09B-2768-4C11-8866-A8EE4C4A583E'],
'Application' => [
'description' => '应用信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '应用的显示名称。', 'type' => 'string', 'example' => 'myapp'],
'AccessTokenValidity' => ['description' => '访问令牌有效期。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'SecretRequired' => ['description' => '是否需要应用密钥。', 'type' => 'boolean', 'example' => 'true'],
'AccountId' => ['description' => '应用所属的阿里云账号ID。', 'type' => 'string', 'example' => '177242285274****'],
'CreateDate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-10-23T08:06:57Z'],
'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'myapp'],
'RedirectUris' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RedirectUri' => [
'description' => '回调地址。',
'type' => 'array',
'items' => ['description' => '回调地址。', 'type' => 'string', 'example' => 'https://www.example.com'],
],
],
'description' => '',
],
'UpdateDate' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-10-23T08:06:57Z'],
'DelegatedScope' => [
'description' => '应用权限范围信息。',
'type' => 'object',
'properties' => [
'PredefinedScopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PredefinedScope' => [
'description' => '应用权限范围信息。',
'type' => 'array',
'items' => [
'description' => '应用权限范围信息。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '范围描述。', 'type' => 'string', 'example' => 'Obtain the OpenID of the user. This is the default permission that you cannot remove.'],
'Required' => ['description' => '安装应用时,此权限范围是否默认必选。取值:'."\n"
."\n"
.'- true:必选。'."\n"
.'- false:非必选。'."\n"
."\n"
.'其中`openid`默认为必选。', 'type' => 'boolean', 'example' => 'true'],
'Name' => ['description' => '范围名称。', 'type' => 'string', 'example' => 'openid'],
],
],
],
],
'description' => '',
],
],
],
'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => '472457090344041****'],
'RefreshTokenValidity' => ['description' => '刷新令牌有效期。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '7776000'],
'IsMultiTenant' => ['description' => '是否允许被其他账号安装。', 'type' => 'boolean', 'example' => 'true'],
'AppType' => ['description' => '应用类型。', 'type' => 'string', 'example' => 'WebApp'],
'ProtocolVersion' => ['description' => '应用的OAuth协议版本。取值:'."\n"
.'+ `2.0`:表示为OAuth 2.0协议。'."\n"
.'+ `2.1`:表示为OAuth 2.1协议。', 'type' => 'string', 'example' => '2.0'],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '创建应用',
'summary' => '创建一个应用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApplication'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6616F09B-2768-4C11-8866-A8EE4C4A583E\\",\\n \\"Application\\": {\\n \\"DisplayName\\": \\"myapp\\",\\n \\"AccessTokenValidity\\": 3600,\\n \\"SecretRequired\\": true,\\n \\"AccountId\\": \\"177242285274****\\",\\n \\"CreateDate\\": \\"2020-10-23T08:06:57Z\\",\\n \\"AppName\\": \\"myapp\\",\\n \\"RedirectUris\\": {\\n \\"RedirectUri\\": [\\n \\"https://www.example.com\\"\\n ]\\n },\\n \\"UpdateDate\\": \\"2020-10-23T08:06:57Z\\",\\n \\"DelegatedScope\\": {\\n \\"PredefinedScopes\\": {\\n \\"PredefinedScope\\": [\\n {\\n \\"Description\\": \\"Obtain the OpenID of the user. This is the default permission that you cannot remove.\\",\\n \\"Required\\": true,\\n \\"Name\\": \\"openid\\"\\n }\\n ]\\n }\\n },\\n \\"AppId\\": \\"472457090344041****\\",\\n \\"RefreshTokenValidity\\": 7776000,\\n \\"IsMultiTenant\\": true,\\n \\"AppType\\": \\"WebApp\\",\\n \\"ProtocolVersion\\": \\"2.0\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t6616F09B-2768-4C11-8866-A8EE4C4A583E\\r\\n\\t\\r\\n\\t\\t177242285274****\\r\\n\\t\\ttrue\\r\\n\\t\\ttrue\\r\\n\\t\\t2020-10-23T08:06:57Z\\r\\n\\t\\tmyapp\\r\\n\\t\\t2020-10-23T08:06:57Z\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t用于获取用户的OpenID(默认权限范围,不可移除)\\r\\n\\t\\t\\t\\t\\topenid\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t472457090344041****\\r\\n\\t\\tmyapp\\r\\n\\t\\t3600\\r\\n\\t\\t\\r\\n\\t\\t\\thttps://www.example.com\\r\\n\\t\\t\\r\\n\\t\\t7776000\\r\\n\\t\\tWebApp\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]',
],
'CreateGroup' => [
'summary' => '创建一个用户组。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramY5X059'],
],
'parameters' => [
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => ['description' => '用户组显示名称。'."\n"
."\n"
.'最大长度24个字符。', 'type' => 'string', 'required' => false, 'example' => 'Dev-Team'],
],
[
'name' => 'Comments',
'in' => 'query',
'schema' => ['description' => '备注。'."\n"
."\n"
.'最大长度128个字符。', 'type' => 'string', 'required' => false, 'example' => '开发团队'],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '用户组名称。该参数必须指定。'."\n"
."\n"
.'最大长度64个字符,可包含英文字母、数字、英文句点(.)、下划线(_)和短划线(-)。'."\n"
."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Dev-Team'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Group' => [
'description' => '用户组信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '用户组显示名称。', 'type' => 'string', 'example' => 'Dev-Team'],
'GroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => '740317625433843****'],
'UpdateDate' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-10-19T16:15:17Z'],
'GroupName' => ['description' => '用户组名称。', 'type' => 'string', 'example' => 'Dev-Team'],
'Comments' => ['description' => '备注。', 'type' => 'string', 'example' => '开发团队'],
'CreateDate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-10-19T16:15:17Z'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3C38192B-7BF8-45DA-8F0A-E670EA51426C'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建用户组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroup'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Group\\": {\\n \\"DisplayName\\": \\"Dev-Team\\",\\n \\"GroupId\\": \\"740317625433843****\\",\\n \\"UpdateDate\\": \\"2020-10-19T16:15:17Z\\",\\n \\"GroupName\\": \\"Dev-Team\\",\\n \\"Comments\\": \\"开发团队\\",\\n \\"CreateDate\\": \\"2020-10-19T16:15:17Z\\"\\n },\\n \\"RequestId\\": \\"3C38192B-7BF8-45DA-8F0A-E670EA51426C\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\tDev-Team\\r\\n\\t\\t2020-10-19T16:15:17Z\\r\\n 740317625433843****\\r\\n\\t\\t开发团队\\r\\n\\t\\tDev-Team\\r\\n\\t\\t2020-10-19T16:15:17Z\\r\\n\\t\\r\\n\\t3C38192B-7BF8-45DA-8F0A-E670EA51426C\\r\\n\\t\\r\\n","errorExample":""}]',
],
'CreateLoginProfile' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramFSAEMQ'],
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => 'RAM用户的控制台登录密码。'."\n"
."\n"
.'密码必须符合密码强度要求。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mypassword'],
],
[
'name' => 'PasswordResetRequired',
'in' => 'query',
'schema' => ['description' => 'RAM用户在下次登录时是否必须重置密码。取值:'."\n"
."\n"
.'- true'."\n"
.'- false(默认值)', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'MFABindRequired',
'in' => 'query',
'schema' => ['description' => '是否强制要求RAM用户开启多因素认证。取值:'."\n"
."\n"
.'- true:要求开启。RAM用户在下次登录时必须绑定多因素认证设备。'."\n"
.'- false(默认值):不要求开启。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '开启或禁用控制台密码登录。取值:'."\n"
."\n"
.'- Active(默认值):开启。'."\n"
.'- Inactive:禁用。', 'type' => 'string', 'required' => false, 'example' => 'Active'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '29CB303C-1F05-43A6-A6BC-EBC5A797F8DB'],
'LoginProfile' => [
'description' => '控制台登录信息。',
'type' => 'object',
'properties' => [
'UserPrincipalName' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'example' => 'test@example.onaliyun.com'],
'Status' => ['description' => '开启或禁用控制台密码登录。', 'type' => 'string', 'example' => 'Active'],
'UpdateDate' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-10-14T03:47:51Z'],
'PasswordResetRequired' => ['description' => 'RAM用户在下次登录时是否必须重置密码。', 'type' => 'boolean', 'example' => 'false'],
'MFABindRequired' => ['description' => '是否强制要求RAM用户开启多因素认证。', 'type' => 'boolean', 'example' => 'false'],
'PasswordStatus' => ['description' => '初始密码的状态。初始密码指新创建或重新启用控制台登录设置的密码。'."\n"
."\n"
.'取值'."\n"
.'- "NotInitial":非初始密码。'."\n"
.'- "InitialValid":初始密码有效。'."\n"
.'- "InitialExpired":初始密码已过期。', 'type' => 'string', 'example' => 'NotInitial'],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '开启指定RAM用户的控制台登录',
'summary' => '为RAM用户创建登录配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLoginProfile'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateLoginProfile',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"29CB303C-1F05-43A6-A6BC-EBC5A797F8DB\\",\\n \\"LoginProfile\\": {\\n \\"UserPrincipalName\\": \\"test@example.onaliyun.com\\",\\n \\"Status\\": \\"Active\\",\\n \\"UpdateDate\\": \\"2020-10-14T03:47:51Z\\",\\n \\"PasswordResetRequired\\": false,\\n \\"MFABindRequired\\": false,\\n \\"PasswordStatus\\": \\"NotInitial\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t29CB303C-1F05-43A6-A6BC-EBC5A797F8DB\\r\\n\\t\\r\\n\\t\\tActive\\r\\n\\t\\t2020-10-14T03:47:51Z\\r\\n\\t\\tfalse\\r\\n\\t\\ttest@example.onaliyun.com\\r\\n\\t\\tfalse\\r\\n\\t\\r\\n","errorExample":""}]',
],
'CreateOIDCProvider' => [
'summary' => '调用CreateOIDCProvider创建OIDC身份提供商,配置阿里云与外部身份提供商(IdP)的信任关系。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'OIDCProviderName',
'in' => 'query',
'schema' => ['description' => 'OIDC身份提供商的名称。'."\n"
."\n"
.'格式:允许英文字母、数字、特殊字符`.-_`,不能以特殊字符`.-_`开头或结尾。'."\n"
."\n"
.'长度:最大128个字符。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'TestOIDCProvider'],
],
[
'name' => 'IssuerUrl',
'in' => 'query',
'schema' => ['description' => '颁发者URL。由外部IdP提供。同一个阿里云账号下必须唯一。'."\n"
."\n"
.'格式:该URL必须以`https`开头,符合标准URL格式,不允许带有query参数(以`?`标识)、fragment片段(以`#`标识)和登录信息(以`@`标识)。'."\n"
."\n"
.'长度:最大255个字符。'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'https://xxxxxx.example.com'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'OIDC身份提供商的描述。'."\n"
."\n"
.'长度:最大256个字符。', 'type' => 'string', 'required' => false, 'example' => 'This is an OIDC Provider.'],
],
[
'name' => 'ClientIds',
'in' => 'query',
'schema' => ['description' => '客户端ID。由外部IdP提供。多个之间用半角逗号(,)分隔。'."\n"
."\n"
.'格式:允许英文字母、数字、特殊字符`.-_:/`,不能以特殊字符`.-_:/`开头。'."\n"
."\n"
.'长度:单个客户端ID最大128个字符。', 'type' => 'string', 'required' => false, 'example' => '498469743454717****'],
],
[
'name' => 'Fingerprints',
'in' => 'query',
'schema' => ['description' => 'HTTPS CA证书的验证指纹。由外部IdP提供。多个之间用半角逗号(,)分隔。'."\n"
."\n\n"
.'格式:允许英文字母和数字。'."\n"
."\n"
.'长度:单个验证指纹最大128个字符。', 'type' => 'string', 'required' => false, 'example' => '902ef2deeb3c5b13ea4c3d5193629309e231****'],
],
[
'name' => 'IssuanceLimitTime',
'in' => 'query',
'schema' => ['description' => '允许外部IdP颁发ID Token的最早签发时间。ID Token中的iat字段如果距离当前时间大于这个值则请求会被拒绝。'."\n"
.'单位:小时。取值范围:1~168。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '6'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '64B11B41-636D-51E3-A39B-C8703CD2218C'],
'OIDCProvider' => [
'description' => 'OIDC身份提供商信息。',
'type' => 'object',
'properties' => [
'UpdateDate' => ['description' => '修改时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-11T06:56:03Z'],
'Description' => ['description' => 'OIDC身份提供商的描述。', 'type' => 'string', 'example' => 'This is an OIDC Provider.'],
'OIDCProviderName' => ['description' => 'OIDC身份提供商的名称。', 'type' => 'string', 'example' => 'TestOIDCProvider'],
'CreateDate' => ['description' => '创建时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-11T06:56:03Z'],
'Arn' => ['description' => 'OIDC身份提供商的ARN。', 'type' => 'string', 'example' => 'acs:ram::177242285274****:oidc-provider/TestOIDCProvider'],
'IssuerUrl' => ['description' => '颁发者URL。', 'type' => 'string', 'example' => 'https://xxxxxx.example.com'],
'Fingerprints' => ['description' => 'HTTPS CA证书的验证指纹。', 'type' => 'string', 'example' => '902ef2deeb3c5b13ea4c3d5193629309e231****'],
'ClientIds' => ['description' => '客户端ID。', 'type' => 'string', 'example' => '498469743454717****'],
'GmtCreate' => ['description' => '创建时间(时间戳)。', 'type' => 'string', 'example' => '1636613763000'],
'GmtModified' => ['description' => '修改时间(时间戳)。', 'type' => 'string', 'example' => '1636613763000'],
'IssuanceLimitTime' => ['description' => '允许外部IdP颁发ID Token的最早签发时间。ID Token中的iat字段如果距离当前时间大于这个值则请求会被拒绝。'."\n"
.'单位:小时。取值范围:1~168。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '创建OIDC身份供应商',
'description' => '### 前提条件'."\n"
.'调用前,请提前从外部IdP(例如:Google G Suite或Okta等)获取颁发者URL、HTTPS CA证书的验证指纹和客户端ID等信息。'."\n"
."\n"
.'### 使用限制'."\n"
."\n"
.'- 一个阿里云账号中可创建的OIDC身份提供商最大个数:100个。'."\n"
.'- 一个OIDC身份提供商中的客户端ID最大个数:50个。'."\n"
.'- 一个OIDC身份提供商中的验证指纹最大个数:5个。'."\n"
."\n"
.'### 使用说明'."\n"
."\n"
.'本文将提供一个示例,创建一个名为`TestOIDCProvider`的身份提供商,配置外部IdP与阿里云的信任关系。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~187377~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOIDCProvider'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"64B11B41-636D-51E3-A39B-C8703CD2218C\\",\\n \\"OIDCProvider\\": {\\n \\"UpdateDate\\": \\"2021-11-11T06:56:03Z\\",\\n \\"Description\\": \\"This is an OIDC Provider.\\",\\n \\"OIDCProviderName\\": \\"TestOIDCProvider\\",\\n \\"CreateDate\\": \\"2021-11-11T06:56:03Z\\",\\n \\"Arn\\": \\"acs:ram::177242285274****:oidc-provider/TestOIDCProvider\\",\\n \\"IssuerUrl\\": \\"https://xxxxxx.example.com\\",\\n \\"Fingerprints\\": \\"902ef2deeb3c5b13ea4c3d5193629309e231****\\",\\n \\"ClientIds\\": \\"498469743454717****\\",\\n \\"GmtCreate\\": \\"1636613763000\\",\\n \\"GmtModified\\": \\"1636613763000\\",\\n \\"IssuanceLimitTime\\": 6\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 64B11B41-636D-51E3-A39B-C8703CD2218C\\n \\n 2021-11-11T06:56:03Z\\n This is an OIDC Provider.\\n TestOIDCProvider\\n 2021-11-11T06:56:03Z\\n acs:ram::177242285274****:oidc-provider/TestOIDCProvider\\n https://dev-xxxxxx.okta.com\\n 902ef2deeb3c5b13ea4c3d5193629309e231****\\n 498469743454717****\\n 1636613763000\\n 1636613763000\\n 6\\n \\n","errorExample":""}]',
],
'CreateSAMLProvider' => [
'summary' => '创建一个角色SSO的身份提供商配置。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram7YYMOK'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SAMLProviderName',
'in' => 'query',
'schema' => ['description' => '身份提供商名称。'."\n"
."\n"
.'最大长度128个字符,允许英文字母、数字、特殊字符`.-_`,不能以特殊字符`.-_`开头或结尾。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-provider'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '备注。', 'type' => 'string', 'required' => false, 'example' => 'This is a provider.'],
],
[
'name' => 'EncodedSAMLMetadataDocument',
'in' => 'query',
'schema' => ['description' => '元数据文档。经过Base64编码。'."\n"
."\n"
.'由支持SAML2.0协议的身份提供商提供。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'PD94bWwgdmVy****'],
],
[
'name' => 'AuthnSignAlgo',
'in' => 'query',
'schema' => ['description' => '阿里云SP支持的签名算法。取值:'."\n"
."\n"
.'- rsa-sha256'."\n"
.'- rsa-sha1(默认值)', 'type' => 'string', 'required' => false, 'example' => 'rsa-sha1'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E5EDDFD2-3654-4F9F-9780-4AE7D81823EF'],
'SAMLProvider' => [
'description' => '身份提供商信息。',
'type' => 'object',
'properties' => [
'UpdateDate' => ['description' => '更新时间(UTC时间)。', 'type' => 'string', 'example' => '2020-10-22T02:51:20Z'],
'Description' => ['description' => '备注。', 'type' => 'string', 'example' => 'This is a provider.'],
'SAMLProviderName' => ['description' => '身份提供商名称。', 'type' => 'string', 'example' => 'test-provider'],
'CreateDate' => ['description' => '创建时间(UTC时间)。', 'type' => 'string', 'example' => '2020-10-22T02:37:05Z'],
'Arn' => ['description' => '身份提供商的ARN。', 'type' => 'string', 'example' => 'acs:ram::177242285274****:saml-provider/test-provider'],
'AuthnSignAlgo' => ['description' => '阿里云SP支持的签名算法。取值:'."\n"
."\n"
.'- rsa-sha256'."\n"
.'- rsa-sha1(默认值)', 'type' => 'string', 'example' => 'rsa-sha1'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '创建角色SSO身份提供商',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSAMLProvider'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateSAMLProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E5EDDFD2-3654-4F9F-9780-4AE7D81823EF\\",\\n \\"SAMLProvider\\": {\\n \\"UpdateDate\\": \\"2020-10-22T02:51:20Z\\",\\n \\"Description\\": \\"This is a provider.\\",\\n \\"SAMLProviderName\\": \\"test-provider\\",\\n \\"CreateDate\\": \\"2020-10-22T02:37:05Z\\",\\n \\"Arn\\": \\"acs:ram::177242285274****:saml-provider/test-provider\\",\\n \\"AuthnSignAlgo\\": \\"rsa-sha1\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n E5EDDFD2-3654-4F9F-9780-4AE7D81823EF\\r\\n \\r\\n 2020-10-22T02:51:20Z\\r\\n test-provider\\r\\n This is a provider.\\r\\n acs:ram::177242285274****:saml-provider/test-provider\\r\\n 2020-10-22T02:37:05Z\\r\\n \\r\\n","errorExample":""}]',
],
'CreateServiceCredential' => [
'summary' => '创建RAM用户在指定云服务的服务凭证。',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['title' => 'RAM 用户的登录名称。'."\n"
.'如果为空,默认为当前用户创建服务凭证。', 'description' => 'RAM 用户的登录名称。'."\n"
.'如果为空,默认为当前用户创建服务凭证。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'ServiceName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['title' => '阿里云服务名称', 'description' => '阿里云服务名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxx.aliyuncs.com'],
],
[
'name' => 'ServiceCredentialName',
'in' => 'query',
'schema' => ['title' => '服务凭证名称。'."\n"
.'长度为1~128个字符,可包含英文字母、数字、半角句号(.)、短划线(-)和下划线(_)。', 'description' => '服务凭证名称。'."\n"
.'长度为1~128个字符,可包含英文字母、数字、半角句号(.)、短划线(-)和下划线(_)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'yourServiceCredentialName'],
],
[
'name' => 'CredentialAgeDays',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['title' => '服务凭证过期时间,以天为单位。'."\n"
.'取值范围1-36600.'."\n"
.'不传表示永久有效。', 'description' => '服务凭证过期时间,以天为单位。'."\n"
.'取值范围1-36600.'."\n"
.'不传表示永久有效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '81313F5E-3C85-478F-BCC9-E1B70E4556DB'],
'ServiceCredential' => [
'title' => '服务凭证信息',
'description' => '服务凭证信息',
'type' => 'object',
'properties' => [
'ServiceName' => ['title' => '阿里云服务名称', 'description' => '阿里云服务名称', 'type' => 'string', 'example' => 'xxx.aliyuncs.com'],
'UserPrincipalName' => ['title' => 'RAM 用户的登录名称', 'description' => 'RAM 用户的登录名称', 'type' => 'string', 'example' => 'test@example.onaliyun.com'],
'ServiceCredentialName' => ['title' => '服务凭证名称', 'description' => '服务凭证名称', 'type' => 'string', 'example' => 'yourServiceCredentialName'],
'ServiceCredentialId' => ['title' => '服务凭证ID', 'description' => '服务凭证ID', 'type' => 'string', 'example' => 'SC*************'],
'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2026-01-01T10:05:24Z'],
'ExpirationTime' => ['title' => '过期时间。'."\n"
.'永久有效的服务凭证不返回该字段。', 'description' => '过期时间。'."\n"
.'永久有效的服务凭证不返回该字段。', 'type' => 'string', 'example' => '2026-02-01T10:05:24Z'],
'Status' => [
'title' => '服务凭证状态',
'description' => '服务凭证状态',
'type' => 'string',
'example' => 'Active',
'enum' => ['Active', 'Inactive', 'Expired'],
],
'ServiceCredentialSecret' => ['title' => '服务凭证密钥', 'description' => '服务凭证密钥', 'type' => 'string', 'example' => 'yourServiceCredentialSecret'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建服务凭证',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateServiceCredential',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:ServiceCredentialServiceName', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81313F5E-3C85-478F-BCC9-E1B70E4556DB\\",\\n \\"ServiceCredential\\": {\\n \\"ServiceName\\": \\"xxx.aliyuncs.com\\",\\n \\"UserPrincipalName\\": \\"test@example.onaliyun.com\\",\\n \\"ServiceCredentialName\\": \\"yourServiceCredentialName\\",\\n \\"ServiceCredentialId\\": \\"SC*************\\",\\n \\"CreateTime\\": \\"2026-01-01T10:05:24Z\\",\\n \\"ExpirationTime\\": \\"2026-02-01T10:05:24Z\\",\\n \\"Status\\": \\"Active\\",\\n \\"ServiceCredentialSecret\\": \\"yourServiceCredentialSecret\\"\\n }\\n}","type":"json"}]',
],
'CreateUser' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramJI77QT'],
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => [
'description' => 'RAM用户的登录名称。'."\n"
."\n"
.'格式为`@.onaliyun.com`,其中``为RAM用户名称,`.onaliyun.com`为默认域名。 关于如何获取默认域名,请参见[GetDefaultDomain](~~186720~~)。'."\n"
."\n"
.'`UserPrincipalName`总长度为`1~128`个字符,可包含英文字母、数字、半角句号(.)、短划线(-)和下划线(_)。其中``的长度为`1~64`个字符。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [],
'example' => 'Test@example.onaliyun.com',
],
],
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的显示名称。'."\n"
."\n"
.'长度为1~24个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'],
],
[
'name' => 'MobilePhone',
'in' => 'query',
'schema' => ['description' => 'RAM用户的手机号码。'."\n"
."\n"
.'格式:国际区号-号码。'."\n"
."\n"
.'> 该参数仅适用于中国站。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => '86-1868888****'],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => ['description' => 'RAM用户的电子邮箱。'."\n"
.'> 该参数仅适用于中国站。', 'type' => 'string', 'required' => false, 'example' => 'alice@example.com'],
],
[
'name' => 'Comments',
'in' => 'query',
'schema' => ['description' => '备注。'."\n"
."\n"
.'长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'This is a cloud computing engineer.'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标签列表,最多包含20个子项',
'description' => '标签列表。最多包含20个标签。',
'type' => 'array',
'items' => [
'description' => '标签列表。最多包含20个标签。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键', 'description' => '标签键。'."\n"
."\n"
.'N的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'operator'],
'Value' => ['title' => '标签值', 'description' => '标签值。'."\n"
."\n"
.'N的取值范围:1~20。可以为空字符串。最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'User' => [
'description' => 'RAM用户信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => 'RAM用户的显示名称。', 'type' => 'string', 'example' => 'test'],
'UserPrincipalName' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'example' => 'test@example.onaliyun.com'],
'Email' => ['description' => 'RAM用户的电子邮箱。'."\n"
.'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => 'alice@example.com'],
'UpdateDate' => ['description' => 'RAM用户的更新时间。', 'type' => 'string', 'example' => '2020-10-12T09:12:00Z'],
'MobilePhone' => ['description' => 'RAM用户的手机号码。'."\n"
.'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => '86-1868888****'],
'UserId' => ['description' => 'RAM用户ID。', 'type' => 'string', 'example' => '20732900249392****'],
'Comments' => ['description' => '备注。', 'type' => 'string', 'example' => 'This is a cloud computing engineer.'],
'LastLoginDate' => ['description' => 'RAM用户最近一次登录控制台的时间。', 'type' => 'string', 'example' => '2020-10-12T09:12:00Z'],
'CreateDate' => ['description' => 'RAM用户的创建时间。', 'type' => 'string', 'example' => '2020-10-12T09:12:00Z'],
'ProvisionType' => ['description' => '同步类型。取值:'."\n"
.'- Manual:在RAM中手动创建的RAM用户。'."\n"
.'- SCIM:通过SCIM协议同步创建的RAM用户。'."\n"
.'- CloudSSO:通过云SSO同步创建的用户。', 'type' => 'string', 'example' => 'Manual'],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '标签列表。',
'type' => 'object',
'properties' => [
'TagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'operator'],
'TagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'alice'],
],
],
],
],
'description' => '',
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2BB8C44A-2862-4922-AD43-03924749173B'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建RAM用户',
'summary' => '创建RAM用户。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUser'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"User\\": {\\n \\"DisplayName\\": \\"test\\",\\n \\"UserPrincipalName\\": \\"test@example.onaliyun.com\\",\\n \\"Email\\": \\"alice@example.com\\",\\n \\"UpdateDate\\": \\"2020-10-12T09:12:00Z\\",\\n \\"MobilePhone\\": \\"86-1868888****\\",\\n \\"UserId\\": \\"20732900249392****\\",\\n \\"Comments\\": \\"This is a cloud computing engineer.\\",\\n \\"LastLoginDate\\": \\"2020-10-12T09:12:00Z\\",\\n \\"CreateDate\\": \\"2020-10-12T09:12:00Z\\",\\n \\"ProvisionType\\": \\"Manual\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagKey\\": \\"operator\\",\\n \\"TagValue\\": \\"alice\\"\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"2BB8C44A-2862-4922-AD43-03924749173B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n test\\n test@example.onaliyun.com\\n alice@example.com\\n 2020-10-12T09:12:00Z\\n 86-1868888****\\n 20732900249392****\\n This is a cloud computing engineer.\\n 2020-10-12T09:12:00Z\\n 2020-10-12T09:12:00Z\\n Manual\\n \\n operator\\n alice\\n \\n \\n 2BB8C44A-2862-4922-AD43-03924749173B\\n","errorExample":""}]',
],
'CreateVirtualMFADevice' => [
'summary' => '创建一个虚拟多因素认证设备。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramCFN0GB'],
],
'parameters' => [
[
'name' => 'VirtualMFADeviceName',
'in' => 'query',
'schema' => ['description' => '多因素认证设备名称。'."\n"
."\n"
.'长度为1~64个字符,可包含英文字母、数字和短划线(-)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'device001'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'VirtualMFADevice' => [
'description' => '多因素认证设备信息。',
'type' => 'object',
'properties' => [
'SerialNumber' => ['description' => '设备序列号。', 'type' => 'string', 'example' => 'acs:ram::177242285274****:mfa/device001'],
'QRCodePNG' => ['description' => '密钥的二维码,使用Base64编码。', 'type' => 'string', 'example' => 'YXNkZmFzZDlmeW5hc2Q5OGZoODd4bXJmcThhaGU5aSBmYXNkZiBzYWRmIGFGIDRxd2VjIGEgdHEz****'],
'Base32StringSeed' => ['description' => '多因素认证设备密钥。', 'type' => 'string', 'example' => 'LD3CJ23Z2VGEX6R7ZTQCOA4XL2KODS5PKH7442NLKYX2PVHSHYB7UT3TS5HA****'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C609CC97-10FE-43EB-BE32-BDC219D8F1E4'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建多因素认证设备',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVirtualMFADevice'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateVirtualMFADevice',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'MFADevice', 'arn' => 'acs:ram::{#accountId}:mfa/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"VirtualMFADevice\\": {\\n \\"SerialNumber\\": \\"acs:ram::177242285274****:mfa/device001\\",\\n \\"QRCodePNG\\": \\"YXNkZmFzZDlmeW5hc2Q5OGZoODd4bXJmcThhaGU5aSBmYXNkZiBzYWRmIGFGIDRxd2VjIGEgdHEz****\\",\\n \\"Base32StringSeed\\": \\"LD3CJ23Z2VGEX6R7ZTQCOA4XL2KODS5PKH7442NLKYX2PVHSHYB7UT3TS5HA****\\"\\n },\\n \\"RequestId\\": \\"C609CC97-10FE-43EB-BE32-BDC219D8F1E4\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\tacs:ram::177242285274****:mfa/device001\\r\\n\\t\\tYXNkZmFzZDlmeW5hc2Q5OGZoODd4bXJmcThhaGU5aSBmYXNkZiBzYWRmIGFGIDRxd2VjIGEgdHEz****\\r\\n\\t\\tLD3CJ23Z2VGEX6R7ZTQCOA4XL2KODS5PKH7442NLKYX2PVHSHYB7UT3TS5HA****\\r\\n\\t\\r\\n\\tC609CC97-10FE-43EB-BE32-BDC219D8F1E4\\r\\n","errorExample":""}]',
],
'DeleteAccessKey' => [
'summary' => '删除阿里云账号(主账号)或RAM用户的访问密钥。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramI3FYOF'],
],
'parameters' => [
[
'name' => 'UserAccessKeyId',
'in' => 'query',
'schema' => ['description' => '需要删除的访问密钥ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LTAI*******************'],
],
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。'."\n"
."\n"
.'如果为空,默认删除当前用户的访问密钥。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B9AF80E4-1565-42D9-9256-0B8B0D9FD3EC'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除用户的访问密钥',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccessKey'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteAccessKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B9AF80E4-1565-42D9-9256-0B8B0D9FD3EC\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n B9AF80E4-1565-42D9-9256-0B8B0D9FD3EC\\r\\n","errorExample":""}]',
],
'DeleteAccessKeyInRecycleBin' => [
'summary' => '删除回收站中归属于指定RAM用户的指定访问密钥。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramI3FYOF'],
],
'parameters' => [
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => 'RAM用户ID。'."\n"
."\n"
.'> - 当调用者为云账号时,必须传入该参数。'."\n"
.'> - 当调用者为RAM用户时,可不传入该参数。若不传入则默认为调用者的用户ID。', 'type' => 'string', 'required' => false, 'example' => '20732900249392****'],
],
[
'name' => 'UserAccessKeyId',
'in' => 'query',
'schema' => ['description' => 'RAM用户的访问密钥ID。', 'type' => 'string', 'required' => false, 'example' => 'LTAI*******************'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除回收站中的访问密钥',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccessKeyInRecycleBin'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteAccessKeyInRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\n","errorExample":""}]',
],
'DeleteAppSecret' => [
'summary' => '删除指定的应用密钥。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramQ794FD'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '472457090344041****'],
],
[
'name' => 'AppSecretId',
'in' => 'query',
'schema' => ['description' => '应用密钥ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2efd5004-005c-4f05-83c6-5b1dd176****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '85836703-8D4F-485F-9726-4D1C730F957E'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除指定应用的应用密钥',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAppSecret'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteAppSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"85836703-8D4F-485F-9726-4D1C730F957E\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 85836703-8D4F-485F-9726-4D1C730F957E\\r\\n","errorExample":""}]',
],
'DeleteApplication' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram3BGJ0P'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '472457090344041****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '85836703-8D4F-485F-9726-4D1C730F957E'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除一个应用',
'summary' => '删除指定的应用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApplication'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"85836703-8D4F-485F-9726-4D1C730F957E\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 85836703-8D4F-485F-9726-4D1C730F957E\\r\\n","errorExample":""}]',
],
'DeleteGroup' => [
'summary' => '删除一个指定的用户组。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramM3CIN3'],
],
'parameters' => [
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '用户组名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Dev-Team'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '85836703-8D4F-485F-9726-4D1C730F957E'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除指定的用户组',
'description' => '删除用户组前,请确保用户组没有绑定任何权限策略且用户组内没有RAM用户。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroup'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/{#GroupName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"85836703-8D4F-485F-9726-4D1C730F957E\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 85836703-8D4F-485F-9726-4D1C730F957E\\r\\n","errorExample":""}]',
],
'DeleteLoginProfile' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramFSAEMQ'],
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test@example.onaliyun.com'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B9AF80E4-1565-42D9-9256-0B8B0D9FD3EC'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '关闭指定RAM用户的控制台登录',
'summary' => '删除RAM用户的控制台登录配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLoginProfile'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteLoginProfile',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B9AF80E4-1565-42D9-9256-0B8B0D9FD3EC\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n B9AF80E4-1565-42D9-9256-0B8B0D9FD3EC\\r\\n","errorExample":""}]',
],
'DeleteOIDCProvider' => [
'summary' => '调用DeleteOIDCProvider删除OIDC身份提供商。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'OIDCProviderName',
'in' => 'query',
'schema' => ['description' => 'OIDC身份提供商的名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'TestOIDCProvider'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '85836703-8D4F-485F-9726-4D1C730F957E'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '删除OIDC身份提供商',
'description' => '### 使用说明'."\n"
.'本文将提供一个示例,删除名为`TestOIDCProvider`的OIDC身份提供商。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~187377~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteOIDCProvider'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"85836703-8D4F-485F-9726-4D1C730F957E\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t85836703-8D4F-485F-9726-4D1C730F957E\\r\\n\\t","errorExample":""}]',
],
'DeletePasskey' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeCode' => '254326',
'abilityTreeNodes' => ['FEATUREramCFN0GB'],
'autoTest' => false,
'notSupportAutoTestReason' => '因为创建passkey需要通过控制台页面,没有openAPI,因此无法创建用来删除的passkey',
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'PasskeyId',
'in' => 'query',
'schema' => ['description' => '通行密钥的ID。', 'type' => 'string', 'required' => false, 'example' => 'PASSKEY-CuZjEHhWcr7GIQOMGvkS'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '8A1673AA-5DB3-5AFB-8758-AF9EC2889259'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除通行密钥',
'summary' => '删除用户的通行密钥。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'ram:DeletePasskey',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8A1673AA-5DB3-5AFB-8758-AF9EC2889259\\"\\n}","type":"json"}]',
],
'DeleteSAMLProvider' => [
'summary' => '删除一个角色SSO的身份提供商配置。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram7YYMOK'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SAMLProviderName',
'in' => 'query',
'schema' => ['description' => '需要删除的身份提供商名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-provider'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '85836703-8D4F-485F-9726-4D1C730F957E'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '删除指定的角色SSO身份提供商',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSAMLProvider'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteSAMLProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'SAMLProvider', 'arn' => 'acs:ram::{#accountId}:saml-provider/{#SAMLProviderName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"85836703-8D4F-485F-9726-4D1C730F957E\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 85836703-8D4F-485F-9726-4D1C730F957E\\r\\n","errorExample":""}]',
],
'DeleteServiceCredential' => [
'summary' => '删除RAM用户的服务凭证。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ServiceCredentialId',
'in' => 'query',
'schema' => ['title' => '服务凭证ID', 'description' => '服务凭证ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SC****************'],
],
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['title' => 'RAM用户登录名称。'."\n"
.'不指定表示删除当前调用身份下的服务凭证。', 'description' => 'RAM用户登录名称。'."\n"
.'不指定表示删除当前调用身份下的服务凭证。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '492E130C-76D3-55D5-BE5C-C023E431369A'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除服务凭证',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteServiceCredential',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:ServiceCredentialServiceName', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"492E130C-76D3-55D5-BE5C-C023E431369A\\"\\n}","type":"json"}]',
],
'DeleteUser' => [
'summary' => '删除指定的RAM用户。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => '指定的RAM用户登录名称。'."\n"
."\n"
.'> `UserPrincipalName`与`UserId`参数,必须指定一个,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '指定的RAM用户ID。'."\n"
.'> `UserPrincipalName`与`UserId`参数,必须指定一个,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => '20732900249392****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '85836703-8D4F-485F-9726-4D1C730F957E'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除RAM用户',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUser'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"85836703-8D4F-485F-9726-4D1C730F957E\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 85836703-8D4F-485F-9726-4D1C730F957E\\r\\n","errorExample":""}]',
],
'DeleteUserInRecycleBin' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => 'RAM用户ID。', 'type' => 'string', 'required' => false, 'example' => '20732900249392****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除回收站中的RAM用户',
'summary' => '删除回收站中的指定RAM用户。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~187377~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserInRecycleBin'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteUserInRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\n","errorExample":""}]',
],
'DeleteVirtualMFADevice' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramCFN0GB'],
],
'parameters' => [
[
'name' => 'SerialNumber',
'in' => 'query',
'schema' => ['description' => '设备序列号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acs:ram::123456789012****:mfa/device002'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除多因素认证设备',
'summary' => '删除指定的多因素认证设备。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteVirtualMFADevice'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteVirtualMFADevice',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'MFADevice', 'arn' => 'acs:ram::{#accountId}:mfa/{#SerialNumber}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\r\\n","errorExample":""}]',
],
'DeprovisionApplication' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram3BGJ0P'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '407342493648015****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4507D1CD-526A-4E2B-A1E2-3AB045D1AE0B'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '卸载已安装的应用',
'summary' => '卸载已安装的外部应用,或内部应用中的ServerApp类型应用。',
'description' => '当解除安装内部应用时,该内部应用的类型必须是**ServerApp**类型,否则会调用出错。'."\n"
."\n"
.'> 在**内部应用**中,仅有ServerApp类型的应用需要进行**安装(Provision)操作**,因此仅有ServerApp类型的内部应用**能够解除安装**,WebApp和NativeApp类型的内部应用**无需也无法解除安装**。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeprovisionApplication'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:DeprovisionApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4507D1CD-526A-4E2B-A1E2-3AB045D1AE0B\\"\\n}","type":"json"}]',
],
'DeprovisionExternalApplication' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '7447',
'abilityTreeNodes' => ['FEATUREramCEEHYN'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '417273362044613****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4507D1CD-526A-4E2B-A1C2-3AB045D1AE0B'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '卸载已安装的外部应用',
'summary' => '卸载已安装的外部应用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeprovisionExternalApplication'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:DeprovisionExternalApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4507D1CD-526A-4E2B-A1C2-3AB045D1AE0B\\"\\n}","type":"json"}]',
],
'DisableVirtualMFA' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '7448',
'abilityTreeNodes' => ['FEATUREramCFN0GB'],
'autoTest' => false,
'notSupportAutoTestReason' => '无法通过测试平台自动生成MFA Code,所以无法构建绑定了MFA的用户用于测试',
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test@example.onaliyun.com'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B9AF80E4-1565-42D9-9256-0B8B0D9FD3EC'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '解绑并删除多因素认证设备',
'summary' => '解绑并删除一个指定RAM用户的多因素认证设备。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableVirtualMFA'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:DisableVirtualMFA',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B9AF80E4-1565-42D9-9256-0B8B0D9FD3EC\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n B9AF80E4-1565-42D9-9256-0B8B0D9FD3EC\\r\\n","errorExample":""}]',
],
'GenerateCredentialReport' => [
'summary' => '生成阿里云账号(主账号)下的用户凭证报告。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramYDDQL2'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BBCCA90A-A1F0-4B16-B355-692247197805'],
'State' => ['description' => '用户凭证报告的生成状态。取值:'."\n"
."\n"
.'- STARTED:用户凭证报告开始生成。'."\n"
.'- INPROGRESS:用户凭证报告生成中。'."\n"
.'- COMPLETED:用户凭证报告已经生成。'."\n", 'type' => 'string', 'example' => 'STARTED'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'Ims::2019-08-15::GetCredentialReport', 'callbackInterval' => 10000, 'maxCallbackTimes' => 5],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '生成用户凭证报告',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateCredentialReport'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:GenerateCredentialReport',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BBCCA90A-A1F0-4B16-B355-692247197805\\",\\n \\"State\\": \\"STARTED\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\tBBCCA90A-A1F0-4B16-B355-692247197805\\r\\n\\tSTARTED\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
],
'GenerateGovernanceReport' => [
'summary' => '生成身份权限治理检测报告。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramOHWKAN'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '492E130C-76D3-55D5-BE5C-C023E431369A'],
'State' => ['description' => '报告的生成状态。取值:'."\n"
.'- Started:治理报告开始生成。'."\n"
.'- Progressing:治理报告生成中。'."\n"
.'- Completed:治理报告已经生成。', 'type' => 'string', 'example' => 'Started'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'Ims::2019-08-15::GetGovernanceReportStatus', 'callbackInterval' => 10000, 'maxCallbackTimes' => 5],
'title' => '生成身份权限治理检测报告',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateGovernanceReport'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:GenerateGovernanceReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"492E130C-76D3-55D5-BE5C-C023E431369A\\",\\n \\"State\\": \\"Started\\"\\n}","type":"json"}]',
],
'GetAccessKeyInfoInRecycleBin' => [
'summary' => '查询回收站中的归属于RAM用户的指定访问密钥信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'UserAccessKeyId',
'in' => 'query',
'schema' => ['description' => 'RAM用户的访问密钥ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LTAI*******************'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B'],
'AccessKey' => [
'description' => '访问密钥信息。',
'type' => 'object',
'properties' => [
'UserId' => ['description' => 'RAM用户ID。', 'type' => 'string', 'example' => '20732900249392****'],
'UserPrincipalName' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'example' => 'test@example.onaliyun.com'],
'UserRecycled' => ['description' => '访问密钥所属的RAM用户是否在回收站中。取值:'."\n"
."\n"
.'- true:在回收站。'."\n"
.'- false:不在回收站。', 'type' => 'boolean', 'example' => 'true'],
'AccessKeyId' => ['description' => '访问密钥ID。', 'type' => 'string', 'example' => 'LTAI*******************'],
'CreateDate' => ['description' => '访问密钥的创建时间。', 'type' => 'string', 'example' => '2020-10-12T09:12:00Z'],
'RecycleDate' => ['description' => '访问密钥被删除进入回收站的时间。', 'type' => 'string', 'example' => '2020-10-12T10:12:00Z'],
'DeleteDate' => ['description' => '访问密钥将从回收站中彻底删除的时间。', 'type' => 'string', 'example' => '2020-11-12T10:12:00Z'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询回收站中的访问密钥',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccessKeyInfoInRecycleBin'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetAccessKeyInfoInRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\",\\n \\"AccessKey\\": {\\n \\"UserId\\": \\"20732900249392****\\",\\n \\"UserPrincipalName\\": \\"test@example.onaliyun.com\\",\\n \\"UserRecycled\\": true,\\n \\"AccessKeyId\\": \\"LTAI*******************\\",\\n \\"CreateDate\\": \\"2020-10-12T09:12:00Z\\",\\n \\"RecycleDate\\": \\"2020-10-12T10:12:00Z\\",\\n \\"DeleteDate\\": \\"2020-11-12T10:12:00Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\n \\n 20732900249392****\\n test@example.onaliyun.com\\n true\\n LTAI4GFTgcR8m8cZQDTH****\\n 2020-10-12T09:12:00Z\\n 2020-10-12T10:12:00Z\\n 2020-11-12T10:12:00Z\\n \\n","errorExample":""}]',
],
'GetAccessKeyLastUsed' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。'."\n"
."\n"
.'如果为空,默认查询当前用户的访问密钥。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'UserAccessKeyId',
'in' => 'query',
'schema' => ['description' => '需要查询的访问密钥ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LTAI*******************'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'AccessKeyLastUsed' => [
'description' => '访问密钥的最后使用信息。',
'type' => 'object',
'properties' => [
'LastUsedDate' => ['description' => '最后使用时间。', 'type' => 'string', 'example' => '2020-10-16T01:37:37Z'],
'ServiceName' => ['description' => '最后使用的云服务。', 'type' => 'string', 'example' => 'Ram'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B29C79F6-354B-4297-A994-1338CC22A2EC'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询指定访问密钥的最后使用时间',
'summary' => '查询某个指定访问密钥的最后使用时间。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '350', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccessKeyLastUsed'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetAccessKeyLastUsed',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessKeyLastUsed\\": {\\n \\"LastUsedDate\\": \\"2020-10-16T01:37:37Z\\",\\n \\"ServiceName\\": \\"Ram\\"\\n },\\n \\"RequestId\\": \\"B29C79F6-354B-4297-A994-1338CC22A2EC\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 2020-10-16T01:37:37Z\\n Ram\\n \\n B29C79F6-354B-4297-A994-1338CC22A2EC\\n","errorExample":""}]',
],
'GetAccessKeyPolicy' => [
'summary' => '查询阿里云账号(主账号)或RAM用户的访问密钥的网络访问限制策略。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM 用户的登录名称。 '."\n"
."\n"
.'如果为空,默认获取当前用户的指定访问密钥的网络访问限制策略。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'UserAccessKeyId',
'in' => 'query',
'schema' => ['description' => '访问密钥 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LTAI*******************'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessKeyPolicy' => ['description' => '网络访问限制策略。JSON 格式字符串,具体参见SetAccessKeyPolicy文档中的AccessKeyPolicy结构说明。', 'type' => 'string', 'example' => '{"Status":"Inactive","Statements":[{"Value":"AllowAllVPC","Type":"VPCWhiteList","IPList":["::/0","0.0.0.0/0"]}]}'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4B450CA1-36E8-4AA2-8461-86B42BF4CC4E'],
'AccessKeyId' => ['description' => '访问密钥ID。', 'type' => 'string', 'example' => 'LTAI*******************'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询指定访问密钥的网络访问限制策略',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetAccessKeyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessKeyPolicy\\": \\"{\\\\\\"Status\\\\\\":\\\\\\"Inactive\\\\\\",\\\\\\"Statements\\\\\\":[{\\\\\\"Value\\\\\\":\\\\\\"AllowAllVPC\\\\\\",\\\\\\"Type\\\\\\":\\\\\\"VPCWhiteList\\\\\\",\\\\\\"IPList\\\\\\":[\\\\\\"::/0\\\\\\",\\\\\\"0.0.0.0/0\\\\\\"]}]}\\",\\n \\"RequestId\\": \\"4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\",\\n \\"AccessKeyId\\": \\"LTAI*******************\\"\\n}","type":"json"}]',
],
'GetAccountMFAInfo' => [
'summary' => '查询阿里云账号(主账号)的多因素认证设备信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4BE83135-0B08-467C-B3A2-27B312FD0F57'],
'IsMFAEnable' => ['description' => '是否已启用多因素认证设备。取值:'."\n"
."\n"
.'- true:已启用。'."\n"
.'- false:未启用。', 'type' => 'boolean', 'example' => 'false'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询主账号多因素认证设备信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountMFAInfo'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetAccountMFAInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4BE83135-0B08-467C-B3A2-27B312FD0F57\\",\\n \\"IsMFAEnable\\": false\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t4BE83135-0B08-467C-B3A2-27B312FD0F57\\r\\n\\tfalse\\r\\n\\t\\r\\n","errorExample":""}]',
],
'GetAccountSecurityPracticeReport' => [
'summary' => '获取阿里云账号(主账号)下的用户凭证报告。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ABA822EE-85C2-4418-9577-A1831FC8466D'],
'AccountSecurityPracticeInfo' => [
'description' => '阿里云账号安全报告信息。',
'type' => 'object',
'properties' => [
'AccountSecurityPracticeUserInfo' => [
'description' => '阿里云账号安全报告信息。',
'type' => 'object',
'properties' => [
'UnusedAkNum' => ['description' => '阿里云账号中未使用的访问密钥的个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'SubUserWithUnusedAccessKey' => ['description' => '拥有未使用访问密钥的RAM用户的个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RootWithAccessKey' => ['description' => '阿里云账号访问密钥(AccessKey)的个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'SubUser' => ['description' => '阿里云账号中RAM用户的个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '9'],
'BindMfa' => ['description' => '是否已开启多因素认证。取值:'."\n"
."\n"
.'- true:已开启。'."\n"
.'- false:未开启。', 'type' => 'boolean', 'example' => 'false'],
'OldAkNum' => ['description' => '阿里云账号中旧访问密钥的个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'SubUserPwdLevel' => ['description' => 'RAM用户密码强度的等级。取值:'."\n"
."\n"
.'- low'."\n"
.'- mid'."\n"
.'- high', 'type' => 'string', 'example' => 'low'],
'SubUserWithOldAccessKey' => ['description' => '使用旧访问密钥的RAM用户的个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'SubUserBindMfa' => ['description' => '绑定了多因素认证设备的RAM用户的个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
'Score' => ['description' => '阿里云账号安全最终得分。', 'type' => 'integer', 'format' => 'int32', 'example' => '63'],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询阿里云账号的安全报告',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountSecurityPracticeReport'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetAccountSecurityPracticeReport',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ABA822EE-85C2-4418-9577-A1831FC8466D\\",\\n \\"AccountSecurityPracticeInfo\\": {\\n \\"AccountSecurityPracticeUserInfo\\": {\\n \\"UnusedAkNum\\": 0,\\n \\"SubUserWithUnusedAccessKey\\": 0,\\n \\"RootWithAccessKey\\": 1,\\n \\"SubUser\\": 9,\\n \\"BindMfa\\": false,\\n \\"OldAkNum\\": 0,\\n \\"SubUserPwdLevel\\": \\"low\\",\\n \\"SubUserWithOldAccessKey\\": 0,\\n \\"SubUserBindMfa\\": 0\\n },\\n \\"Score\\": 63\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\tABA822EE-85C2-4418-9577-A1831FC8466D\\r\\n\\t\\r\\n\\t\\t63\\r\\n\\t\\t\\r\\n\\t\\t\\t9\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t1\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\tlow\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
],
'GetAccountSummary' => [
'summary' => '查询阿里云账号(主账号)的概览信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramPNEJCS'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '81313F5E-3C85-478F-BCC9-E1B70E4556DB'],
'SummaryMap' => [
'description' => '阿里云账号概览信息。',
'type' => 'object',
'properties' => [
'MFADevices' => ['description' => '虚拟多因素认证设备的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '13'],
'AccessKeysPerUserQuota' => ['description' => '每个RAM用户允许拥有访问密钥的最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'AttachedPoliciesPerGroupQuota' => ['description' => '每个用户组允许添加自定义策略的最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'AttachedSystemPoliciesPerRoleQuota' => ['description' => '每个RAM角色允许添加系统策略的最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'AttachedPoliciesPerRoleQuota' => ['description' => '每个RAM角色允许添加自定义策略的最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'GroupsPerUserQuota' => ['description' => '每个RAM用户允许加入的用户组最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'Roles' => ['description' => 'RAM角色数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '19'],
'PolicySizeQuota' => ['description' => '权限策略内容的最大长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '2048'],
'AttachedSystemPoliciesPerGroupQuota' => ['description' => '每个用户组允许添加系统策略的最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'AttachedSystemPoliciesPerUserQuota' => ['description' => '每个RAM用户允许添加系统策略的最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'AttachedPoliciesPerUserQuota' => ['description' => '每个RAM用户允许添加自定义策略的最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'GroupsQuota' => ['description' => '允许创建用户组的最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
'Groups' => ['description' => '用户组数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
'PoliciesQuota' => ['description' => '允许创建自定义策略的最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1500'],
'VirtualMFADevicesQuota' => ['description' => '允许创建虚拟多因素认证设备的最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
'VersionsPerPolicyQuota' => ['description' => '权限策略版本的最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'RolesQuota' => ['description' => '允许创建RAM角色的最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
'UsersQuota' => ['description' => '允许创建RAM用户的最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
'Policies' => ['description' => '自定义策略数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '13'],
'Users' => ['description' => 'RAM用户数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '9'],
'MFADevicesInUse' => ['description' => '使用中的虚拟多因素认证设备的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'IPItemsPerAKPolicyQuota' => ['description' => '一条账号级或AccessKey级网络访问限制策略中可设置的IP地址最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
'ConditionsPerAKPolicyQuota' => ['description' => '一条账号级或AccessKey级网络访问限制策略中可设置的策略条目最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
'AccountAccessKeysPerAccountQuota' => ['description' => '主账号AccessKey最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'AuthorizedClientPerUserQuota' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
'ServiceCredentialsPerUserPerServiceQuota' => ['description' => '每个用户在每个服务创建API key的最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"81313F5E-3C85-478F-BCC9-E1B70E4556DB\\",\\n \\"SummaryMap\\": {\\n \\"MFADevices\\": 13,\\n \\"AccessKeysPerUserQuota\\": 2,\\n \\"AttachedPoliciesPerGroupQuota\\": 5,\\n \\"AttachedSystemPoliciesPerRoleQuota\\": 20,\\n \\"AttachedPoliciesPerRoleQuota\\": 5,\\n \\"GroupsPerUserQuota\\": 5,\\n \\"Roles\\": 19,\\n \\"PolicySizeQuota\\": 2048,\\n \\"AttachedSystemPoliciesPerGroupQuota\\": 20,\\n \\"AttachedSystemPoliciesPerUserQuota\\": 20,\\n \\"AttachedPoliciesPerUserQuota\\": 10,\\n \\"GroupsQuota\\": 50,\\n \\"Groups\\": 7,\\n \\"PoliciesQuota\\": 1500,\\n \\"VirtualMFADevicesQuota\\": 1000,\\n \\"VersionsPerPolicyQuota\\": 5,\\n \\"RolesQuota\\": 1000,\\n \\"UsersQuota\\": 1000,\\n \\"Policies\\": 13,\\n \\"Users\\": 9,\\n \\"MFADevicesInUse\\": 2,\\n \\"IPItemsPerAKPolicyQuota\\": 50,\\n \\"ConditionsPerAKPolicyQuota\\": 8,\\n \\"AccountAccessKeysPerAccountQuota\\": 2,\\n \\"AuthorizedClientPerUserQuota\\": 0,\\n \\"ServiceCredentialsPerUserPerServiceQuota\\": 2\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t81313F5E-3C85-478F-BCC9-E1B70E4556DB\\r\\n\\t\\r\\n\\t\\t13\\r\\n\\t\\t5\\r\\n\\t\\t10\\r\\n\\t\\t19\\r\\n\\t\\t9\\r\\n\\t\\t1000\\r\\n\\t\\t1500\\r\\n\\t\\t1000\\r\\n\\t\\t20\\r\\n\\t\\t2\\r\\n\\t\\t2\\r\\n\\t\\t5\\r\\n\\t\\t2048\\r\\n\\t\\t5\\r\\n\\t\\t20\\r\\n\\t\\t7\\r\\n\\t\\t5\\r\\n\\t\\t1000\\r\\n\\t\\t20\\r\\n\\t\\t13\\r\\n\\t\\t50\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
'title' => '查询主账号概览信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountSummary'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetAccountSummary',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetAppSecret' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramQ794FD'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '472457090344041****'],
],
[
'name' => 'AppSecretId',
'in' => 'query',
'schema' => ['description' => '应用密钥ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2efd5004-005c-4f05-83c6-5b1dd176****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EE46FC3C-3BDE-4771-B531-27B7B6EB533D'],
'AppSecret' => [
'description' => '应用密钥信息。',
'type' => 'object',
'properties' => [
'AppSecretValue' => ['description' => '应用密钥内容。', 'type' => 'string', 'example' => 'ai78ZmmxnlUG1jXlBZRDFKos9DIjY4m17Q7dCpMwn1rqXsTGb1X1XmrmveMp****'],
'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => '472457090344041****'],
'AppSecretId' => ['description' => '应用密钥ID。', 'type' => 'string', 'example' => '2efd5004-005c-4f05-83c6-5b1dd176****'],
'CreateDate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-10-26T02:52:31Z'],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询指定应用密钥信息',
'summary' => '查询指定应用的密钥信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAppSecret'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetAppSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE46FC3C-3BDE-4771-B531-27B7B6EB533D\\",\\n \\"AppSecret\\": {\\n \\"AppSecretValue\\": \\"ai78ZmmxnlUG1jXlBZRDFKos9DIjY4m17Q7dCpMwn1rqXsTGb1X1XmrmveMp****\\",\\n \\"AppId\\": \\"472457090344041****\\",\\n \\"AppSecretId\\": \\"2efd5004-005c-4f05-83c6-5b1dd176****\\",\\n \\"CreateDate\\": \\"2020-10-26T02:52:31Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n EE46FC3C-3BDE-4771-B531-27B7B6EB533D\\r\\n \\r\\n 472457090344041****\\r\\n ai78ZmmxnlUG1jXlBZRDFKos9DIjY4m17Q7dCpMwn1rqXsTGb1X1XmrmveMp****\\r\\n 2efd5004-005c-4f05-83c6-5b1dd176****\\r\\n 2020-10-26T02:52:31Z\\r\\n \\r\\n","errorExample":""}]',
],
'GetApplication' => [
'summary' => '查询指定应用的配置信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram2SMFX0'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '472457090344041****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6616F09B-2768-4C11-8866-A8EE4C4A583E'],
'Application' => [
'description' => '应用信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '应用的显示名称。', 'type' => 'string', 'example' => 'myapp'],
'AccessTokenValidity' => ['description' => '访问令牌有效期。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'SecretRequired' => ['description' => '是否需要应用密钥。', 'type' => 'boolean', 'example' => 'true'],
'AccountId' => ['description' => '应用所属的阿里云账号ID。', 'type' => 'string', 'example' => '177242285274****'],
'CreateDate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-10-23T08:06:57Z'],
'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'myapp'],
'RedirectUris' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RedirectUri' => [
'description' => '回调地址。',
'type' => 'array',
'items' => ['description' => '回调地址。', 'type' => 'string', 'example' => 'https://www.example.com'],
],
],
'description' => '',
],
'UpdateDate' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-10-23T08:06:57Z'],
'DelegatedScope' => [
'description' => '应用权限范围信息。',
'type' => 'object',
'properties' => [
'PredefinedScopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PredefinedScope' => [
'description' => '应用权限范围信息。',
'type' => 'array',
'items' => [
'description' => '应用权限范围信息。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '范围描述。', 'type' => 'string', 'example' => 'Obtain the OpenID of the user. This is the default permission that you cannot remove.'],
'Name' => ['description' => '范围名称。', 'type' => 'string', 'example' => 'openid'],
'Required' => ['description' => '安装应用时,此权限范围是否默认必选。取值:'."\n"
."\n"
.'- true:必选。'."\n"
.'- false:非必选。'."\n"
."\n"
.'其中`openid`默认为必选。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'description' => '',
],
],
],
'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => '472457090344041****'],
'RefreshTokenValidity' => ['description' => '刷新令牌有效期。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '7776000'],
'IsMultiTenant' => ['description' => '是否允许被其他账号安装。', 'type' => 'boolean', 'example' => 'true'],
'AppType' => ['description' => '应用类型。取值:'."\n"
."\n"
.'- WebApp:指基于浏览器交互的网络应用。'."\n"
.'- NativeApp:指操作系统中运行的本地应用,主要为运行在桌面操作系统或移动操作系统中的应用。'."\n"
.'- ServerApp:指直接访问阿里云服务,而无需依赖用户登录的应用,目前仅支持基于SCIM协议的用户同步应用。', 'type' => 'string', 'example' => 'WebApp'],
'ProtocolVersion' => ['description' => '应用的OAuth协议版本。取值:'."\n"
.'+ `2.0`:表示为OAuth 2.0协议。'."\n"
.'+ `2.1`:表示为OAuth 2.1协议。', 'type' => 'string', 'example' => '2.0'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询应用的配置信息',
'description' => '本文将提供一个示例,查询应用`472457090344041****`的配置信息。',
'requestParamsDescription' => ' 关于公共请求参数的详情,请参见[公共参数](~~187377~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplication'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6616F09B-2768-4C11-8866-A8EE4C4A583E\\",\\n \\"Application\\": {\\n \\"DisplayName\\": \\"myapp\\",\\n \\"AccessTokenValidity\\": 3600,\\n \\"SecretRequired\\": true,\\n \\"AccountId\\": \\"177242285274****\\",\\n \\"CreateDate\\": \\"2020-10-23T08:06:57Z\\",\\n \\"AppName\\": \\"myapp\\",\\n \\"RedirectUris\\": {\\n \\"RedirectUri\\": [\\n \\"https://www.example.com\\"\\n ]\\n },\\n \\"UpdateDate\\": \\"2020-10-23T08:06:57Z\\",\\n \\"DelegatedScope\\": {\\n \\"PredefinedScopes\\": {\\n \\"PredefinedScope\\": [\\n {\\n \\"Description\\": \\"Obtain the OpenID of the user. This is the default permission that you cannot remove.\\",\\n \\"Name\\": \\"openid\\",\\n \\"Required\\": true\\n }\\n ]\\n }\\n },\\n \\"AppId\\": \\"472457090344041****\\",\\n \\"RefreshTokenValidity\\": 7776000,\\n \\"IsMultiTenant\\": true,\\n \\"AppType\\": \\"WebApp\\",\\n \\"ProtocolVersion\\": \\"2.0\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 6616F09B-2768-4C11-8866-A8EE4C4A583E\\r\\n \\r\\n 177242285274****\\r\\n true\\r\\n true\\r\\n 2020-10-23T08:06:57Z\\r\\n myapp\\r\\n 2020-10-23T08:06:57Z\\r\\n \\r\\n \\r\\n \\r\\n 用于获取用户的OpenID(默认权限范围,不可移除)\\r\\n openid\\r\\n \\r\\n \\r\\n \\r\\n 472457090344041****\\r\\n myapp\\r\\n 3600\\r\\n \\r\\n https://www.example.com\\r\\n \\r\\n 7776000\\r\\n WebApp\\r\\n \\r\\n","errorExample":""}]',
],
'GetApplicationProvisionInfo' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramCEEHYN'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '452392483381546****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '936E1D9C-157D-45BD-8A3B-81C0716EB078'],
'ApplicationProvisionInfo' => [
'description' => '应用安装信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '应用的显示名称。', 'type' => 'string', 'example' => 'GiteeAliyun'],
'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'GiteePrd'],
'UpdateDate' => ['description' => '更新时间戳。', 'type' => 'string', 'example' => '1603693518000'],
'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => '452392483381546****'],
'DelegatedScope' => [
'description' => '应用权限范围信息。',
'type' => 'object',
'properties' => [
'PredefinedScopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PredefinedScope' => [
'description' => '应用权限范围信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => ['description' => '范围描述。', 'type' => 'string', 'example' => '用于获取用户的OpenID(默认权限范围,不可移除)'],
'Name' => ['description' => '范围名称。', 'type' => 'string', 'example' => 'openid'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'AccountId' => ['description' => '阿里云账号ID。', 'type' => 'string', 'example' => '177242285274****'],
'CreateDate' => ['description' => '安装时间戳。', 'type' => 'string', 'example' => '1603693518000'],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询应用安装信息',
'summary' => '查询指定的已安装应用的安装信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplicationProvisionInfo'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetApplicationProvisionInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"936E1D9C-157D-45BD-8A3B-81C0716EB078\\",\\n \\"ApplicationProvisionInfo\\": {\\n \\"DisplayName\\": \\"GiteeAliyun\\",\\n \\"AppName\\": \\"GiteePrd\\",\\n \\"UpdateDate\\": \\"1603693518000\\",\\n \\"AppId\\": \\"452392483381546****\\",\\n \\"DelegatedScope\\": {\\n \\"PredefinedScopes\\": {\\n \\"PredefinedScope\\": [\\n {\\n \\"Description\\": \\"用于获取用户的OpenID(默认权限范围,不可移除)\\",\\n \\"Name\\": \\"openid\\"\\n }\\n ]\\n }\\n },\\n \\"AccountId\\": \\"177242285274****\\",\\n \\"CreateDate\\": \\"1603693518000\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t936E1D9C-157D-45BD-8A3B-81C0716EB078\\r\\n\\t\\r\\n\\t\\t1603693518000\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t用于获取用户的OpenID(默认权限范围,不可移除)\\r\\n\\t\\t\\t\\t\\topenid\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t177242285274****\\r\\n\\t\\t452392483381546****\\r\\n\\t\\tGiteeAliyun\\r\\n\\t\\t1603693518000\\r\\n\\t\\tGiteePrd\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
],
'GetCredentialReport' => [
'summary' => '查询阿里云账号(主账号)下的用户凭证报告。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramYDDQL2'],
],
'parameters' => [
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '当请求的返回结果被截断时,可以使用`NextToken`获取从当前截断位置之后的内容。', 'type' => 'string', 'required' => false, 'example' => 'EXAMPLE'],
],
[
'name' => 'MaxItems',
'in' => 'query',
'schema' => ['description' => '返回结果的条数。当返回结果达到`MaxItems`限制被截断时,返回参数`IsTruncated`将等于true。'."\n"
."\n"
.'取值范围:1~3501。默认值:3501。', 'type' => 'string', 'required' => false, 'example' => '1000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'GeneratedTime' => ['description' => '用户凭证报告的生成时间。', 'type' => 'string', 'example' => '2020-10-19T15:06:52Z'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7A01826E-7601-44B0-B4DF-2B0C509836DE'],
'Content' => ['description' => '用户凭证报告内容。'."\n"
."\n"
.'采用Base64编码,解码后是CSV格式的用户凭证报告内容。', 'type' => 'string', 'example' => 'OVZWK4RMOVZW****'],
'IsTruncated' => ['description' => '请求返回结果是否被截断。取值:'."\n"
."\n"
.'- true'."\n"
.'- false', 'type' => 'string', 'example' => 'true'],
'NextToken' => ['description' => '此参数在`IsTruncated`为true时生效,用于获取截断后的内容。', 'type' => 'string', 'example' => 'EXAMPLE'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询用户凭证报告内容',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCredentialReport'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetCredentialReport',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"GeneratedTime\\": \\"2020-10-19T15:06:52Z\\",\\n \\"RequestId\\": \\"7A01826E-7601-44B0-B4DF-2B0C509836DE\\",\\n \\"Content\\": \\"OVZWK4RMOVZW****\\",\\n \\"IsTruncated\\": \\"true\\",\\n \\"NextToken\\": \\"EXAMPLE\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2020-10-19T15:06:52Z\\n 7A01826E-7601-44B0-B4DF-2B0C509836DE\\n OVZWK4RMOVZW****\\n true\\n EXAMPLE\\n","errorExample":""}]',
],
'GetDefaultDomain' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramM70W9U'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DefaultDomainName' => ['description' => '默认域名。', 'type' => 'string', 'example' => 'examplecompany.onaliyun.com'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '66815255-7CCE-4759-AC37-9755794C3626'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询默认域名',
'summary' => '查询阿里云账号(主账号)下的默认域名。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDefaultDomain'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetDefaultDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"DefaultDomainName\\": \\"examplecompany.onaliyun.com\\",\\n \\"RequestId\\": \\"66815255-7CCE-4759-AC37-9755794C3626\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n examplecompany.onaliyun.com\\r\\n 66815255-7CCE-4759-AC37-9755794C3626\\r\\n","errorExample":""}]',
],
'GetExternalApplication' => [
'summary' => '查询已安装的外部应用的信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram2SMFX0'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '472457090344041****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E4C4D1BD-2558-5BD1-8C36-A5D7FB174A55'],
'ExternalApplication' => [
'description' => '外部应用信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '应用显示名称。', 'type' => 'string', 'example' => 'GiteeAliyun'],
'UpdateDate' => ['description' => '应用更新时间戳。', 'type' => 'string', 'example' => '1737534146000'],
'DelegatedScope' => [
'description' => '应用权限范围信息。',
'type' => 'object',
'properties' => [
'PredefinedScopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PredefinedScope' => [
'description' => '应用权限范围信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => ['description' => '范围描述。', 'type' => 'string', 'example' => '用于获取用户的OpenID(默认权限范围,不可移除)'."\n"],
'Name' => ['description' => '范围名称。', 'type' => 'string', 'example' => 'openid'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'AppPrincipalName' => ['description' => '应用主体名称,格式为`@app..onaliyun.com`。', 'type' => 'string', 'example' => 'GiteePrd@app.153082740420****.onaliyun.com'],
'CreateDate' => ['description' => '安装时间戳。', 'type' => 'string', 'example' => '1737534146000'],
'TenantId' => ['description' => '外部应用安装到的阿里云账号ID。', 'type' => 'string', 'example' => '173082740420****'],
'ForeignAppId' => ['description' => '外部应用ID。', 'type' => 'string', 'example' => '407426893752729****'],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询外部应用信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExternalApplication'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetExternalApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E4C4D1BD-2558-5BD1-8C36-A5D7FB174A55\\",\\n \\"ExternalApplication\\": {\\n \\"DisplayName\\": \\"GiteeAliyun\\",\\n \\"UpdateDate\\": \\"1737534146000\\",\\n \\"DelegatedScope\\": {\\n \\"PredefinedScopes\\": {\\n \\"PredefinedScope\\": [\\n {\\n \\"Description\\": \\"用于获取用户的OpenID(默认权限范围,不可移除)\\\\n\\",\\n \\"Name\\": \\"openid\\"\\n }\\n ]\\n }\\n },\\n \\"AppPrincipalName\\": \\"GiteePrd@app.153082740420****.onaliyun.com\\",\\n \\"CreateDate\\": \\"1737534146000\\",\\n \\"TenantId\\": \\"173082740420****\\",\\n \\"ForeignAppId\\": \\"407426893752729****\\"\\n }\\n}","type":"json"}]',
],
'GetGovernanceItemReport' => [
'summary' => '查询身份权限治理检测报告中指定治理检测项的信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'GovernanceItemType',
'in' => 'query',
'schema' => ['description' => '治理检测项,取值可参考文档:[身份权限治理检测项](https://help.aliyun.com/zh/ram/user-guide/overview-of-cloud-governance-for-ram?spm=a2c4g.11174283.0.0.88b3de53tfL5XG#section-q06-p9p-8vl)。', 'type' => 'string', 'required' => false, 'example' => 'SSOLoginEnabled'],
],
[
'name' => 'Marker',
'in' => 'query',
'schema' => ['description' => '当请求的返回结果被截断时,可以使用`Marker`获取从当前截断位置之后的内容。', 'type' => 'string', 'required' => false, 'example' => 'EXAMPLE'],
],
[
'name' => 'MaxItems',
'in' => 'query',
'schema' => ['description' => '返回结果的条数。当返回结果达到`MaxItems`限制被截断时,返回参数`IsTruncated`将等于true。'."\n"
."\n"
.'取值范围:1~1000。默认值:1000。', 'type' => 'string', 'required' => false, 'example' => '1000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F2CE9688-AA85-5F23-8C22-0EC23473405F'],
'GenerateTime' => ['description' => '身份权限治理报告该治理检测项的生成时间。', 'type' => 'string', 'example' => '2020-10-19T15:06:52Z'],
'MetricType' => ['description' => '指标值类型,取值:'."\n"
.'- Number:数值类型。'."\n"
.'- String:字符串类型。'."\n"
.'- Boolean:布尔类型。', 'type' => 'string', 'example' => 'Number'],
'MetricValue' => ['description' => '指标值。', 'type' => 'any', 'example' => '100'],
'ColumnsSchema' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ColumnSchema' => [
'description' => '明细的列模式,数组,长度为明细列数。',
'type' => 'array',
'items' => [
'description' => '单个明细的列模式。',
'type' => 'object',
'properties' => [
'ColumnName' => ['description' => '列名。', 'type' => 'string', 'example' => 'UserPrincipalName'],
'ColumnType' => ['description' => '列类型,取值:'."\n"
.'- Number:数值类型。'."\n"
.'- String:字符串类型。'."\n"
.'- Boolean:布尔类型。', 'type' => 'string', 'example' => 'String'],
],
],
],
],
'description' => '',
],
'ColumnsValue' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ColumnRow' => [
'description' => '明细值,二维数组。每一行都是定长,每一行中,每一个值的类型、取值,这一行的长度和取值顺序都和ColumnsSchema中描述的保持一致。',
'type' => 'array',
'items' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ColumnValue' => [
'description' => '明细值中的一行。',
'type' => 'array',
'items' => ['description' => '本行的数据对象。', 'type' => 'any', 'example' => 'test@example.onaliyun.com'],
],
],
'description' => '',
],
],
],
'description' => '',
],
'IsTruncated' => ['description' => '请求返回结果是否被截断。取值:'."\n"
.'- true'."\n"
.'- false', 'type' => 'boolean', 'example' => 'true'],
'Marker' => ['description' => '此参数在`IsTruncated`为true时生效,用于获取截断后的内容。', 'type' => 'string', 'example' => 'EXAMPLE'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询身份权限指定治理检测项检测报告',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGovernanceItemReport'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetGovernanceItemReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2CE9688-AA85-5F23-8C22-0EC23473405F\\",\\n \\"GenerateTime\\": \\"2020-10-19T15:06:52Z\\",\\n \\"MetricType\\": \\"Number\\",\\n \\"MetricValue\\": \\"100\\",\\n \\"ColumnsSchema\\": {\\n \\"ColumnSchema\\": [\\n {\\n \\"ColumnName\\": \\"UserPrincipalName\\",\\n \\"ColumnType\\": \\"String\\"\\n }\\n ]\\n },\\n \\"ColumnsValue\\": {\\n \\"ColumnRow\\": [\\n {\\n \\"ColumnValue\\": [\\n \\"test@example.onaliyun.com\\"\\n ]\\n }\\n ]\\n },\\n \\"IsTruncated\\": true,\\n \\"Marker\\": \\"EXAMPLE\\"\\n}","type":"json"}]',
],
'GetGovernanceReportStatus' => [
'summary' => '获取身份权限治理检测报告当前的生成状态',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramOHWKAN'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F2CE9688-AA85-5F23-8C22-0EC23473405A'],
'WholeReportStatus' => ['description' => '报告的生成状态。取值:'."\n"
."\n"
.'- Started:治理报告开始生成。'."\n"
.'- Progressing:治理报告生成中。'."\n"
.'- Completed:治理报告已经生成。', 'type' => 'string', 'example' => 'Progressing'],
'GovernanceItemsStatus' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'GovernanceItemStatus' => [
'description' => '报告中单项的生成状态,为一个数组。数组中的每一行表明某治理项报告的生成状态。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GovernanceItem' => ['description' => '治理项名称。', 'type' => 'string', 'example' => 'AccountRecentUsingAccessKey'],
'Status' => ['description' => '治理项报告的生成状态,取值:'."\n"
."\n"
.'- Started:治理报告开始生成。'."\n"
.'- Progressing:治理报告生成中。'."\n"
.'- Completed:治理报告已生成。', 'type' => 'string', 'example' => 'Progressing'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询身份权限治理检测报告生成状态',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGovernanceReportStatus'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetGovernanceReportStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2CE9688-AA85-5F23-8C22-0EC23473405A\\",\\n \\"WholeReportStatus\\": \\"Progressing\\",\\n \\"GovernanceItemsStatus\\": {\\n \\"GovernanceItemStatus\\": [\\n {\\n \\"GovernanceItem\\": \\"AccountRecentUsingAccessKey\\",\\n \\"Status\\": \\"Progressing\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetGroup' => [
'summary' => '查询指定的用户组信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram3V29VK'],
],
'parameters' => [
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '用户组名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Dev-Team'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Group' => [
'description' => '用户组信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '用户组显示名称。', 'type' => 'string', 'example' => 'Dev-Team'],
'GroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => '740317625433843****'],
'UpdateDate' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-10-19T16:15:17Z'],
'GroupName' => ['description' => '用户组名称。', 'type' => 'string', 'example' => 'Dev-Team'],
'Comments' => ['description' => '备注。', 'type' => 'string', 'example' => '开发团队'],
'CreateDate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-10-19T16:15:17Z'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '86ECEC3C-7262-4C3C-94B4-A98F7CC1F060'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询指定用户组信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGroup'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/{#GroupName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Group\\": {\\n \\"DisplayName\\": \\"Dev-Team\\",\\n \\"GroupId\\": \\"740317625433843****\\",\\n \\"UpdateDate\\": \\"2020-10-19T16:15:17Z\\",\\n \\"GroupName\\": \\"Dev-Team\\",\\n \\"Comments\\": \\"开发团队\\",\\n \\"CreateDate\\": \\"2020-10-19T16:15:17Z\\"\\n },\\n \\"RequestId\\": \\"86ECEC3C-7262-4C3C-94B4-A98F7CC1F060\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\tDev-Team\\r\\n\\t\\t2020-10-19T16:15:17Z\\r\\n\\t\\t开发团队\\r\\n 740317625433843****\\r\\n\\t\\tDev-Team\\r\\n\\t\\t2020-10-19T16:15:17Z\\r\\n\\t\\r\\n\\t86ECEC3C-7262-4C3C-94B4-A98F7CC1F060\\r\\n","errorExample":""}]',
],
'GetLoginProfile' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '7462',
'abilityTreeNodes' => ['FEATUREramFSAEMQ'],
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test@example.onaliyun.com'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E517F18B-632C-48FC-93F1-CDCBCC6F8444'],
'LoginProfile' => [
'description' => '控制台登录信息。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '开启或禁用控制台登录。取值:'."\n"
."\n"
.'- Active:开启控制台登录。'."\n"
.'- Inactive:禁用控制台登录。', 'type' => 'string', 'example' => 'Active'],
'UserPrincipalName' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'example' => 'test@example.onaliyun.com'],
'UpdateDate' => ['description' => '更新时间(UTC时间)。', 'type' => 'string', 'example' => '2020-10-14T06:56:45Z'],
'LastLoginTime' => ['description' => '上次登录控制台时间(UTC时间)。', 'type' => 'string', 'example' => '2020-10-14T07:25:25Z'],
'PasswordResetRequired' => ['description' => 'RAM用户在下次登录时是否必须重置密码。取值:'."\n"
."\n"
.'- false:不要求重置密码。'."\n"
.'- true:必须重置密码。', 'type' => 'boolean', 'example' => 'false'],
'MFABindRequired' => ['description' => '是否强制要求用户开启多因素认证。取值:'."\n"
."\n"
.'- false:不要求开启多因素认证。'."\n"
.'- true:必须开启多因素认证。', 'type' => 'boolean', 'example' => 'false'],
'AutoDisableLoginStatus' => ['description' => '在满足闲置禁用条件后是否自动禁用控制台登录。默认开启,不可关闭。', 'type' => 'string', 'example' => 'true'],
'PasswordStatus' => ['description' => '初始密码的状态。初始密码指新创建或重新启用控制台登录设置的密码。'."\n"
."\n"
.'取值'."\n"
.'- "NotInitial":非初始密码。'."\n"
.'- "InitialValid":初始密码有效。'."\n"
.'- "InitialExpired":初始密码已过期。', 'type' => 'string', 'example' => 'NotInitial'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询指定RAM用户的登录信息',
'summary' => '查询指定RAM用户的登录信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLoginProfile'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetLoginProfile',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E517F18B-632C-48FC-93F1-CDCBCC6F8444\\",\\n \\"LoginProfile\\": {\\n \\"Status\\": \\"Active\\",\\n \\"UserPrincipalName\\": \\"test@example.onaliyun.com\\",\\n \\"UpdateDate\\": \\"2020-10-14T06:56:45Z\\",\\n \\"LastLoginTime\\": \\"2020-10-14T07:25:25Z\\",\\n \\"PasswordResetRequired\\": false,\\n \\"MFABindRequired\\": false,\\n \\"AutoDisableLoginStatus\\": \\"true\\",\\n \\"PasswordStatus\\": \\"NotInitial\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\tE517F18B-632C-48FC-93F1-CDCBCC6F8444\\r\\n\\t\\r\\n\\t\\tActive\\r\\n\\t\\t2020-10-14T07:25:25Z\\r\\n\\t\\t2020-10-14T07:25:00Z\\r\\n\\t\\tfalse\\r\\n\\t\\ttest@example11.onaliyun.com\\r\\n\\t\\tfalse\\r\\n\\t\\r\\n","errorExample":""}]',
],
'GetOIDCProvider' => [
'summary' => '调用GetOIDCProvider查询OIDC身份提供商信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'OIDCProviderName',
'in' => 'query',
'schema' => ['description' => 'OIDC身份提供商的名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'TestOIDCProvider'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E5E1A300-279D-5FBD-A8CF-F4EDC20C4896'],
'OIDCProvider' => [
'description' => 'OIDC身份提供商信息。',
'type' => 'object',
'properties' => [
'UpdateDate' => ['description' => '修改时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-12T08:38:29Z'],
'Description' => ['description' => 'OIDC身份提供商的描述。', 'type' => 'string', 'example' => 'This is a new OIDC Provider.'],
'OIDCProviderName' => ['description' => 'OIDC身份提供商的名称。', 'type' => 'string', 'example' => 'TestOIDCProvider'],
'CreateDate' => ['description' => '创建时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-11T06:56:03Z'],
'Arn' => ['description' => 'OIDC身份提供商的ARN。', 'type' => 'string', 'example' => 'acs:ram::177242285274****:oidc-provider/TestOIDCProvider'],
'IssuerUrl' => ['description' => 'OIDC身份提供商的颁发者URL。', 'type' => 'string', 'example' => 'https://xxxxxx.example.com'],
'Fingerprints' => ['description' => 'HTTPS CA证书的验证指纹。多个之间用半角逗号(,)分隔。', 'type' => 'string', 'example' => '902ef2deeb3c5b13ea4c3d5193629309e231****'],
'ClientIds' => ['description' => '客户端ID。多个之间用半角逗号(,)分隔。', 'type' => 'string', 'example' => '498469743454717****'],
'GmtCreate' => ['description' => '创建时间(时间戳)。', 'type' => 'string', 'example' => '1636613763000'],
'GmtModified' => ['description' => '修改时间(时间戳)。', 'type' => 'string', 'example' => '1636706309000'],
'IssuanceLimitTime' => ['description' => '允许外部IdP颁发ID Token的最早签发时间。ID Token中的iat字段如果距离当前时间大于这个值则请求会被拒绝。'."\n"
.'单位:小时。取值范围:1~168。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询OIDC身份提供商信息',
'description' => '### 使用说明'."\n"
.'本文将提供一个示例,查询名为`TestOIDCProvider`的OIDC身份提供商信息。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~187377~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOIDCProvider'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E5E1A300-279D-5FBD-A8CF-F4EDC20C4896\\",\\n \\"OIDCProvider\\": {\\n \\"UpdateDate\\": \\"2021-11-12T08:38:29Z\\",\\n \\"Description\\": \\"This is a new OIDC Provider.\\",\\n \\"OIDCProviderName\\": \\"TestOIDCProvider\\",\\n \\"CreateDate\\": \\"2021-11-11T06:56:03Z\\",\\n \\"Arn\\": \\"acs:ram::177242285274****:oidc-provider/TestOIDCProvider\\",\\n \\"IssuerUrl\\": \\"https://xxxxxx.example.com\\",\\n \\"Fingerprints\\": \\"902ef2deeb3c5b13ea4c3d5193629309e231****\\",\\n \\"ClientIds\\": \\"498469743454717****\\",\\n \\"GmtCreate\\": \\"1636613763000\\",\\n \\"GmtModified\\": \\"1636706309000\\",\\n \\"IssuanceLimitTime\\": 12\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n E5E1A300-279D-5FBD-A8CF-F4EDC20C4896\\n \\n 2021-11-12T08:38:29Z\\n This is a new OIDC Provider.\\n TestOIDCProvider\\n 2021-11-11T06:56:03Z\\n acs:ram::177242285274****:oidc-provider/TestOIDCProvider\\n https://dev-xxxxxx.okta.com\\n 902ef2deeb3c5b13ea4c3d5193629309e231****\\n 498469743454717****\\n 1636613763000\\n 1636706309000\\n 12\\n \\n","errorExample":""}]',
],
'GetPasswordPolicy' => [
'summary' => '查询RAM用户的密码强度策略信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramFSAEMQ'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BDAA8408-E67C-428B-BFF0-1B2AC05C9610'],
'PasswordPolicy' => [
'description' => '密码强度策略信息。',
'type' => 'object',
'properties' => [
'RequireNumbers' => ['description' => '密码中是否必须包含数字。', 'type' => 'boolean', 'example' => 'false'],
'RequireLowercaseCharacters' => ['description' => '密码中是否必须包含小写字母。', 'type' => 'boolean', 'example' => 'false'],
'PasswordReusePrevention' => ['description' => '历史密码检查策略。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequireSymbols' => ['description' => '密码中是否必须包含符号。', 'type' => 'boolean', 'example' => 'false'],
'PasswordNotContainUserName' => ['description' => '密码中是否不允许包含用户名。', 'type' => 'boolean', 'example' => 'false'],
'MinimumPasswordDifferentCharacter' => ['description' => '密码中最少包含的不同字符数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'MaxPasswordAge' => ['description' => '密码有效期。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'HardExpire' => ['description' => '密码过期后是否限制登录。', 'type' => 'boolean', 'example' => 'false'],
'MinimumPasswordLength' => ['description' => '最小密码长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
'RequireUppercaseCharacters' => ['description' => '密码中是否必须包含大写字母。', 'type' => 'boolean', 'example' => 'false'],
'MaxLoginAttemps' => ['description' => '密码重试次数约束。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'InitialPasswordAge' => ['title' => '初始密码有效期。', 'description' => '初始密码有效期。', 'type' => 'integer', 'format' => 'int32', 'example' => '14'],
'InterceptRiskPasswordOnApi' => ['description' => '使用OpenAPI设置密码时,是否拦截风险密码的开关。'."\n"
."\n"
.'取值:'."\n"
.'- true:使用OpenAPI设置密码时,新密码不得为风险密码。'."\n"
.'- false:使用OpenAPI设置密码时,新密码可以为风险密码。'."\n"
."\n"
.'默认值:false', 'type' => 'boolean', 'example' => 'false'],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询RAM用户密码强度策略信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPasswordPolicy'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetPasswordPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BDAA8408-E67C-428B-BFF0-1B2AC05C9610\\",\\n \\"PasswordPolicy\\": {\\n \\"RequireNumbers\\": false,\\n \\"RequireLowercaseCharacters\\": false,\\n \\"PasswordReusePrevention\\": 0,\\n \\"RequireSymbols\\": false,\\n \\"PasswordNotContainUserName\\": false,\\n \\"MinimumPasswordDifferentCharacter\\": 0,\\n \\"MaxPasswordAge\\": 0,\\n \\"HardExpire\\": false,\\n \\"MinimumPasswordLength\\": 8,\\n \\"RequireUppercaseCharacters\\": false,\\n \\"MaxLoginAttemps\\": 0,\\n \\"InitialPasswordAge\\": 14,\\n \\"InterceptRiskPasswordOnApi\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\tBDAA8408-E67C-428B-BFF0-1B2AC05C9610\\r\\n\\t\\r\\n\\t\\t8\\r\\n\\t\\tfalse\\r\\n\\t\\tfalse\\r\\n\\t\\tfalse\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\tfalse\\r\\n\\t\\tfalse\\r\\n\\t\\t0\\r\\n\\t\\tfalse\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
],
'GetSAMLProvider' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram7YYMOK'],
],
'parameters' => [
[
'name' => 'SAMLProviderName',
'in' => 'query',
'schema' => ['description' => '身份提供商名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-provider'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BAADB995-0C7A-476D-B293-7E94568EEDFB'],
'SAMLProvider' => [
'description' => '身份提供商信息。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '备注。', 'type' => 'string', 'example' => 'This is a provider.'],
'UpdateDate' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-10-22T02:51:20Z'],
'SAMLProviderName' => ['description' => '身份提供商名称。', 'type' => 'string', 'example' => 'test-provider'],
'CreateDate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-10-22T02:37:05Z'],
'EncodedSAMLMetadataDocument' => ['description' => '元数据文档。经过Base64编码。', 'type' => 'string', 'example' => 'PD94bWwgdmVy****'],
'Arn' => ['description' => '身份提供商的ARN。', 'type' => 'string', 'example' => 'acs:ram::177242285274****:saml-provider/test-provider'],
'AuthnSignAlgo' => ['description' => '阿里云SP支持的签名算法。取值:'."\n"
."\n"
.'- rsa-sha256'."\n"
.'- rsa-sha1', 'type' => 'string', 'example' => 'rsa-sha1'],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询角色SSO身份提供商信息',
'summary' => '查询指定的角色SSO身份提供商信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSAMLProvider'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetSAMLProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'SAMLProvider', 'arn' => 'acs:ram::{#accountId}:saml-provider/{#SAMLProviderName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BAADB995-0C7A-476D-B293-7E94568EEDFB\\",\\n \\"SAMLProvider\\": {\\n \\"Description\\": \\"This is a provider.\\",\\n \\"UpdateDate\\": \\"2020-10-22T02:51:20Z\\",\\n \\"SAMLProviderName\\": \\"test-provider\\",\\n \\"CreateDate\\": \\"2020-10-22T02:37:05Z\\",\\n \\"EncodedSAMLMetadataDocument\\": \\"PD94bWwgdmVy****\\",\\n \\"Arn\\": \\"acs:ram::177242285274****:saml-provider/test-provider\\",\\n \\"AuthnSignAlgo\\": \\"rsa-sha1\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\tE5EDDFD2-3654-4F9F-9780-4AE7D81823EF\\r\\n\\t\\r\\n\\t\\t2020-10-22T02:51:20Z\\r\\n\\t\\ttest-provider\\r\\n\\t\\tThis is a provider.\\r\\n\\t\\tPD94bWwgdmVy****\\r\\n\\t\\tacs:ram::177242285274****:saml-provider/test-provider\\r\\n\\t\\t2020-10-22T02:37:05Z\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
],
'GetSecurityPreference' => [
'summary' => '调用GetSecurityPreference查询RAM用户的全局安全首选项。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '7466',
'abilityTreeNodes' => ['FEATUREramPNEJCS'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'SecurityPreference' => [
'description' => '安全首选项信息。',
'type' => 'object',
'properties' => [
'AccessKeyPreference' => [
'description' => '访问密钥首选项。',
'type' => 'object',
'properties' => [
'AllowUserToManageAccessKeys' => ['description' => '是否允许RAM用户自主管理访问密钥。取值:'."\n"
."\n"
.'- true:允许。'."\n"
.'- false:不允许。', 'type' => 'boolean', 'example' => 'false'],
'AllowUserToManageServiceCredentials' => ['description' => '是否允许 RAM 用户自主管理API Key。取值:'."\n"
."\n"
.'- true:允许。'."\n"
.'- false:不允许。', 'type' => 'boolean', 'example' => 'false'],
],
],
'LoginProfilePreference' => [
'description' => '登录首选项。',
'type' => 'object',
'properties' => [
'EnableSaveMFATicket' => ['description' => 'RAM用户使用多因素认证登录后,是否允许保存多因素认证的验证状态,其有效期为7天。取值:'."\n"
.'- true:允许。'."\n"
.'- false:不允许。', 'type' => 'boolean', 'example' => 'false'],
'LoginSessionDuration' => ['description' => 'RAM用户登录有效期。单位:小时。', 'type' => 'integer', 'format' => 'int32', 'example' => '6'],
'LoginNetworkMasks' => ['description' => '登录掩码。', 'type' => 'string', 'example' => '10.0.0.0/8'],
'AllowUserToChangePassword' => ['description' => '是否允许RAM用户自主管理密码。取值:'."\n"
.'- true:允许。'."\n"
.'- false:不允许。', 'type' => 'boolean', 'example' => 'true'],
'OperationForRiskLogin' => ['description' => '异常登录时是否二次验证MFA。取值:'."\n"
."\n"
.'- autonomous(默认值):可跳过,不强制绑定。'."\n"
.'- enforceVerify:强制绑定验证。', 'type' => 'string', 'deprecated' => true, 'example' => 'autonomous'],
'MFAOperationForLogin' => ['description' => '登录时必须使用MFA(取代原EnforceMFAForLogin参数,原参数仍然有效,建议更新为新参数)。取值:'."\n"
."\n"
.'- mandatory:强制所有RAM用户。原EnforceMFAForLogin对应取值为true。'."\n"
.'- independent(默认值):依赖每个RAM用户的独立配置。原EnforceMFAForLogin对应取值为false。'."\n"
.'- adaptive:仅异常登录时使用。'."\n"
."\n", 'type' => 'string', 'example' => 'adaptive'],
'AllowUserToLoginWithPasskey' => ['description' => '是否允许RAM用户使用通行密钥登录。取值:'."\n"
."\n"
.'- true:允许。'."\n"
."\n"
.'- false:不允许。', 'type' => 'boolean', 'example' => 'true'],
],
],
'MFAPreference' => [
'description' => '多因素认证首选项。',
'type' => 'object',
'properties' => [
'AllowUserToManageMFADevices' => ['description' => '是否允许RAM用户自主管理多因素认证设备。取值:'."\n"
.'- true:允许。'."\n"
.'- false:不允许。', 'type' => 'boolean', 'example' => 'false'],
],
],
'VerificationPreference' => [
'description' => '多因素认证手段首选项。',
'type' => 'object',
'properties' => [
'VerificationTypes' => [
'description' => '多因素认证手段。',
'type' => 'array',
'items' => ['description' => '多因素认证手段。取值:'."\n"
."\n"
.'- sms:安全手机。'."\n"
.'- email:安全邮箱。', 'type' => 'string', 'example' => '["sms","email"]'],
],
],
],
'PersonalInfoPreference' => [
'description' => '个人信息首选项。',
'type' => 'object',
'properties' => [
'AllowUserToManagePersonalDingTalk' => ['description' => '是否允许RAM用户自主管理个人钉钉的绑定与解绑。取值:'."\n"
."\n"
.'- true:允许。'."\n"
.'- false:不允许。', 'type' => 'boolean', 'example' => 'true'],
],
],
'MaxIdleDays' => [
'description' => '最大闲置时间配置(天)。',
'type' => 'object',
'properties' => [
'MaxIdleDaysForUsers' => ['description' => 'RAM用户的最大闲置时间(天)配置,开启控制台登录的RAM用户的连续未登录(不包含SSO登录)达到此时间后将在次日被自动禁用控制台登录。默认为730天。', 'type' => 'integer', 'format' => 'int32', 'example' => '730'],
'MaxIdleDaysForAccessKeys' => ['description' => 'RAM用户的访问密钥的最大闲置时间(天)配置,访问密钥连续未使用达到此时间后将在次日被自动禁用。默认为730天。', 'type' => 'integer', 'format' => 'int32', 'example' => '730'],
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30C9068D-FBAA-4998-9986-8A562FED0BC3'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SecurityPreference\\": {\\n \\"AccessKeyPreference\\": {\\n \\"AllowUserToManageAccessKeys\\": false,\\n \\"AllowUserToManageServiceCredentials\\": false\\n },\\n \\"LoginProfilePreference\\": {\\n \\"EnableSaveMFATicket\\": false,\\n \\"LoginSessionDuration\\": 6,\\n \\"LoginNetworkMasks\\": \\"10.0.0.0/8\\",\\n \\"AllowUserToChangePassword\\": true,\\n \\"OperationForRiskLogin\\": \\"autonomous\\",\\n \\"MFAOperationForLogin\\": \\"adaptive\\",\\n \\"AllowUserToLoginWithPasskey\\": true\\n },\\n \\"MFAPreference\\": {\\n \\"AllowUserToManageMFADevices\\": false\\n },\\n \\"VerificationPreference\\": {\\n \\"VerificationTypes\\": [\\n \\"[\\\\\\"sms\\\\\\",\\\\\\"email\\\\\\"]\\"\\n ]\\n },\\n \\"PersonalInfoPreference\\": {\\n \\"AllowUserToManagePersonalDingTalk\\": true\\n },\\n \\"MaxIdleDays\\": {\\n \\"MaxIdleDaysForUsers\\": 730,\\n \\"MaxIdleDaysForAccessKeys\\": 730\\n }\\n },\\n \\"RequestId\\": \\"30C9068D-FBAA-4998-9986-8A562FED0BC3\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n false\\n \\n \\n false\\n 6\\n 10.0.0.0/8\\n true\\n autonomous\\n adaptive\\n \\n \\n false\\n \\n \\n [\\"sms\\",\\"email\\"]\\n \\n \\n true\\n \\n \\n 30C9068D-FBAA-4998-9986-8A562FED0BC3\\n","errorExample":""}]',
'title' => '查询RAM用户全局安全首选项',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSecurityPreference'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetSecurityPreference',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetServiceCredential' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ServiceCredentialId',
'in' => 'query',
'schema' => ['title' => '服务凭证ID', 'description' => '服务凭证ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SC****************'],
],
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['title' => 'RAM用户登录名称。'."\n"
.'不指定表示获取当前调用身份下的服务凭证。', 'description' => 'RAM用户登录名称。'."\n"
.'不指定表示获取当前调用身份下的服务凭证。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '66815255-7CCE-4759-AC37-9755794C3626'],
'ServiceCredential' => [
'title' => '服务凭证信息',
'description' => '服务凭证信息',
'type' => 'object',
'properties' => [
'ServiceCredentialId' => ['title' => '服务凭证ID', 'description' => '服务凭证ID', 'type' => 'string', 'example' => 'SC***************'],
'ServiceName' => ['title' => '阿里云服务名称', 'description' => '阿里云服务名称', 'type' => 'string', 'example' => 'xxx.aliyuncs.com'],
'UserPrincipalName' => ['title' => 'RAM用户登录名称', 'description' => 'RAM用户登录名称', 'type' => 'string', 'example' => 'test@example.onaliyun.com'],
'ServiceCredentialName' => ['title' => '服务凭证名称', 'description' => '服务凭证名称', 'type' => 'string', 'example' => 'test'],
'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2026-03-15T09:20:58Z'],
'ExpirationTime' => ['title' => '过期时间。'."\n"
.'永久有效的服务凭证不返回该字段。', 'description' => '过期时间。'."\n"
.'永久有效的服务凭证不返回该字段。', 'type' => 'string', 'example' => '2026-04-15T09:20:58Z'],
'Status' => [
'title' => '服务凭证状态',
'description' => '服务凭证状态',
'type' => 'string',
'example' => 'Active',
'enum' => ['Active', 'Inactive', 'Expired'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取单个服务凭证',
'summary' => '获取RAM用户的某个服务凭证。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetServiceCredential',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:ServiceCredentialServiceName', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"66815255-7CCE-4759-AC37-9755794C3626\\",\\n \\"ServiceCredential\\": {\\n \\"ServiceCredentialId\\": \\"SC***************\\",\\n \\"ServiceName\\": \\"xxx.aliyuncs.com\\",\\n \\"UserPrincipalName\\": \\"test@example.onaliyun.com\\",\\n \\"ServiceCredentialName\\": \\"test\\",\\n \\"CreateTime\\": \\"2026-03-15T09:20:58Z\\",\\n \\"ExpirationTime\\": \\"2026-04-15T09:20:58Z\\",\\n \\"Status\\": \\"Active\\"\\n }\\n}","type":"json"}]',
],
'GetUser' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。'."\n"
."\n"
.'格式为`@.onaliyun.com`,其中``为RAM用户名称,`.onaliyun.com`为默认域名。 '."\n"
."\n"
.'`UserPrincipalName`长度为`1~128`个字符,可包含英文字母、数字、半角句号(.)、短划线(-)和下划线(_)。其中``的长度为`1~64`个字符。'."\n"
."\n"
.'>必须指定 `UserPrincipalName`、`UserId`和`UserAccessKeyId`三个参数中的一个参数,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => 'RAM用户ID。'."\n"
.'>必须指定 `UserPrincipalName`、`UserId`和`UserAccessKeyId`三个参数中的一个参数,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => '20732900249392****'],
],
[
'name' => 'UserAccessKeyId',
'in' => 'query',
'schema' => ['description' => 'RAM用户的访问密钥ID。'."\n"
.'>必须指定 `UserPrincipalName`、`UserId`和`UserAccessKeyId`三个参数中的一个参数,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => 'LTAI*******************'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'User' => [
'description' => 'RAM用户信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => 'RAM用户的显示名称。', 'type' => 'string', 'example' => 'test'],
'UserPrincipalName' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'example' => 'test@example.onaliyun.com'],
'Email' => ['description' => 'RAM用户的电子邮箱。'."\n"
.'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => 'alice@example.com'],
'UpdateDate' => ['description' => 'RAM用户的更新时间。', 'type' => 'string', 'example' => '2020-10-13T07:39:22Z'],
'MobilePhone' => ['description' => 'RAM用户的手机号码。'."\n"
.'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => '86-1868888****'],
'UserId' => ['description' => 'RAM用户ID。', 'type' => 'string', 'example' => '20732900249392****'],
'Comments' => ['description' => '备注。', 'type' => 'string', 'example' => 'This is a cloud computing engineer.'],
'LastLoginDate' => ['description' => 'RAM用户最近一次登录控制台的时间。', 'type' => 'string', 'example' => '2020-10-12T09:12:00Z'],
'CreateDate' => ['description' => 'RAM用户的创建时间。', 'type' => 'string', 'example' => '2020-10-12T09:12:00Z'],
'ProvisionType' => ['description' => '同步类型。取值:'."\n"
.'- Manual:在RAM中手动创建的RAM用户。'."\n"
.'- SCIM:通过SCIM协议同步创建的RAM用户。'."\n"
.'- CloudSSO:通过云SSO同步创建的用户。', 'type' => 'string', 'example' => 'CloudSSO'],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'TagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'operator'],
'TagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'alice'],
],
],
],
],
'description' => '',
],
'UserName' => ['description' => 'RAM用户的名称,即登录名的前缀。', 'type' => 'string', 'example' => 'test'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询RAM用户的详细信息',
'summary' => '查询指定的RAM用户的详细信息。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"User\\": {\\n \\"DisplayName\\": \\"test\\",\\n \\"UserPrincipalName\\": \\"test@example.onaliyun.com\\",\\n \\"Email\\": \\"alice@example.com\\",\\n \\"UpdateDate\\": \\"2020-10-13T07:39:22Z\\",\\n \\"MobilePhone\\": \\"86-1868888****\\",\\n \\"UserId\\": \\"20732900249392****\\",\\n \\"Comments\\": \\"This is a cloud computing engineer.\\",\\n \\"LastLoginDate\\": \\"2020-10-12T09:12:00Z\\",\\n \\"CreateDate\\": \\"2020-10-12T09:12:00Z\\",\\n \\"ProvisionType\\": \\"CloudSSO\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagKey\\": \\"operator\\",\\n \\"TagValue\\": \\"alice\\"\\n }\\n ]\\n },\\n \\"UserName\\": \\"test\\"\\n },\\n \\"RequestId\\": \\"4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n test\\n test@example.onaliyun.com\\n alice@example.com\\n 2020-10-13T07:39:22Z\\n 86-1868888****\\n 20732900249392****\\n This is a cloud computing engineer.\\n 2020-10-12T09:12:00Z\\n 2020-10-12T09:12:00Z\\n CloudSSO\\n \\n operator\\n alice\\n \\n \\n 4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\n","errorExample":""}]',
],
'GetUserInRecycleBin' => [
'summary' => '查询回收站中的指定RAM用户信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => 'RAM用户ID。'."\n"
.'>必须指定 `UserId`、`UserAccessKeyId`两个参数中的一个参数,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => '20732900249392****'],
],
[
'name' => 'UserAccessKeyId',
'in' => 'query',
'schema' => ['description' => 'RAM用户的访问密钥ID。'."\n"
.'>必须指定 `UserId`、`UserAccessKeyId`两个参数中的一个参数,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => 'LTAI*******************'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'User' => [
'description' => 'RAM用户信息。',
'type' => 'object',
'properties' => [
'UserId' => ['description' => 'RAM用户ID。', 'type' => 'string', 'example' => '20732900249392****'],
'UserPrincipalName' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'example' => 'test@example.onaliyun.com'],
'DisplayName' => ['description' => 'RAM用户的显示名称。', 'type' => 'string', 'example' => 'test'],
'CreateDate' => ['description' => 'RAM用户的创建时间。', 'type' => 'string', 'example' => '2020-10-11T09:12:00Z'],
'RecycleDate' => ['description' => 'RAM用户被删除进入回收站的时间。', 'type' => 'string', 'example' => '2020-10-12T09:12:00Z'],
'DeleteDate' => ['description' => 'RAM用户将从回收站中彻底删除的时间。', 'type' => 'string', 'example' => '2020-11-12T09:12:00Z'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询回收站中的RAM用户',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserInRecycleBin'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetUserInRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"User\\": {\\n \\"UserId\\": \\"20732900249392****\\",\\n \\"UserPrincipalName\\": \\"test@example.onaliyun.com\\",\\n \\"DisplayName\\": \\"test\\",\\n \\"CreateDate\\": \\"2020-10-11T09:12:00Z\\",\\n \\"RecycleDate\\": \\"2020-10-12T09:12:00Z\\",\\n \\"DeleteDate\\": \\"2020-11-12T09:12:00Z\\"\\n },\\n \\"RequestId\\": \\"4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 20732900249392****\\n test@example.onaliyun.com\\n test\\n 2020-10-11T09:12:00Z\\n 2020-10-12T09:12:00Z\\n 2020-11-12T09:12:00Z\\n \\n 4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\n","errorExample":""}]',
],
'GetUserMFAInfo' => [
'summary' => '查询指定RAM用户的多因素认证设备信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramCFN0GB'],
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。存在以下两种情况:'."\n"
."\n"
.'- 当RAM用户调用时,该参数可以为空,为空时默认查询当前RAM用户的多因素认证设备信息。'."\n"
.'- 当阿里云账号(主账号)调用时,该参数不能为空,必须指定需要查询的RAM用户的登录名称。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MFADevice' => [
'description' => '多因素认证设备信息。',
'type' => 'object',
'properties' => [
'SerialNumber' => ['description' => '设备序列号。', 'type' => 'string', 'example' => 'acs:ram::177242285274****:mfa/device001'],
'Type' => ['description' => '多因素认证设备类型。取值:'."\n"
."\n"
.'- VMFA:虚拟MFA设备。'."\n"
.'- U2F:U2F安全密钥。', 'type' => 'string', 'example' => 'VMFA'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FCF7322A-20A9-4F68-8B7F-F86958839BC0'],
'IsMFAEnable' => ['description' => '是否已启用多因素认证设备。取值:'."\n"
."\n"
.'- true:已启用。'."\n"
.'- false:未启用。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询RAM用户多因素认证设备信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '700', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserMFAInfo'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetUserMFAInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"MFADevice\\": {\\n \\"SerialNumber\\": \\"acs:ram::177242285274****:mfa/device001\\",\\n \\"Type\\": \\"VMFA\\"\\n },\\n \\"RequestId\\": \\"FCF7322A-20A9-4F68-8B7F-F86958839BC0\\",\\n \\"IsMFAEnable\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\tacs:ram::177242285274****:mfa/device001\\r\\n VMFA\\r\\n\\t\\r\\n\\tFCF7322A-20A9-4F68-8B7F-F86958839BC0\\r\\n\\ttrue\\r\\n","errorExample":""}]',
],
'GetUserSsoSettings' => [
'summary' => '查询用户SSO身份提供商配置信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramY87YVY'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'UserSsoSettings' => [
'description' => '用户SSO配置信息。',
'type' => 'object',
'properties' => [
'AuxiliaryDomain' => ['description' => '辅助域名。', 'type' => 'string', 'example' => 'example.com'],
'MetadataDocument' => ['description' => '元数据文档。经过Base64编码。', 'type' => 'string', 'example' => 'PD94bWwgdmVy****'],
'SsoEnabled' => ['description' => '是否开启用户SSO。', 'type' => 'boolean', 'example' => 'false'],
'SsoLoginWithDomain' => ['description' => '当用户使用SAML SSO登录时,是否要求SAML Response的``元素内容中包含域名(即在IdP侧指定的用于SSO登录匹配的用户名是否带有域名后缀)。'."\n"
."\n"
.'- 该参数取值为`true`时,``元素内容**必须**形如`username@domain`(即带有域名后缀),其中`domain`可以是默认的域名,也可以是域别名(若已设置)。'."\n"
.'- 该参数取值为`false`时,``元素内容应当**仅有**`username`部分(即不带有域名后缀),**不得带有**`domain`部分。'."\n"
."\n"
.'该参数默认取值为`true`。', 'type' => 'boolean', 'example' => 'true'],
'AuthnSignAlgo' => ['description' => '阿里云SP支持的签名算法。取值:'."\n"
."\n"
.'- rsa-sha256'."\n"
.'- rsa-sha1', 'type' => 'string', 'example' => 'rsa-sha1'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69FC3E5E-D3D9-434B-90CA-BBA8E0551A47'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询用户SSO身份提供商信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserSsoSettings'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetUserSsoSettings',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"UserSsoSettings\\": {\\n \\"AuxiliaryDomain\\": \\"example.com\\",\\n \\"MetadataDocument\\": \\"PD94bWwgdmVy****\\",\\n \\"SsoEnabled\\": false,\\n \\"SsoLoginWithDomain\\": true,\\n \\"AuthnSignAlgo\\": \\"rsa-sha1\\"\\n },\\n \\"RequestId\\": \\"69FC3E5E-D3D9-434B-90CA-BBA8E0551A47\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\tPD94bWwgdmVy****\\r\\n\\t\\tfalse\\r\\n\\t\\texample.com\\r\\n\\t\\r\\n\\t69FC3E5E-D3D9-434B-90CA-BBA8E0551A47\\r\\n\\t\\r\\n","errorExample":""}]',
],
'GetVerificationInfo' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramFSAEMQ'],
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'B182C041-8C64-5F2F-A07B-FC67FAF89CF9'],
'SecurityPhoneDevice' => [
'description' => '安全手机信息。',
'type' => 'object',
'properties' => [
'AreaCode' => ['description' => '区号。', 'type' => 'string', 'example' => '86'],
'PhoneNumber' => ['description' => '手机号码。', 'type' => 'string', 'example' => '13900001234'],
'Status' => ['description' => '安全手机的状态。取值:'."\n"
.'- active:已激活。'."\n"
.'- pending:待激活。', 'type' => 'string', 'example' => 'active'],
],
],
'SecurityEmailDevice' => [
'description' => '安全邮箱信息。',
'type' => 'object',
'properties' => [
'Email' => ['description' => '安全邮箱地址。', 'type' => 'string', 'example' => 'username@example.com'],
'Status' => ['description' => '安全邮箱的状态。取值:'."\n"
.'- active:已激活。'."\n"
.'- pending:待激活。', 'type' => 'string', 'example' => 'active'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取用户手机邮箱的安全认证信息',
'summary' => '查询RAM用户的安全手机或安全邮箱状态。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVerificationInfo'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetVerificationInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B182C041-8C64-5F2F-A07B-FC67FAF89CF9\\",\\n \\"SecurityPhoneDevice\\": {\\n \\"AreaCode\\": \\"86\\",\\n \\"PhoneNumber\\": \\"13900001234\\",\\n \\"Status\\": \\"active\\"\\n },\\n \\"SecurityEmailDevice\\": {\\n \\"Email\\": \\"username@example.com\\",\\n \\"Status\\": \\"active\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n B182C041-8C64-5F2F-A07B-FC67FAF89CF9\\n \\n 86\\n 13900001234\\n active\\n \\n \\n username@example.com\\n active\\n \\n","errorExample":""}]',
],
'ListAccessKeys' => [
'summary' => '查询阿里云账号(主账号)或RAM用户的访问密钥列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。'."\n"
."\n"
.'如果为空,默认查询当前用户的所有访问密钥。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'AccessKeys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AccessKey' => [
'description' => '访问密钥列表。',
'type' => 'array',
'items' => [
'description' => '访问密钥。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '访问密钥状态。取值:'."\n"
."\n"
.'- Active:已激活。'."\n"
.'- Inactive:已禁用。', 'type' => 'string', 'example' => 'Active'],
'UpdateDate' => ['description' => '访问密钥更新时间。', 'type' => 'string', 'example' => '2020-10-13T12:33:18Z'],
'AccessKeyId' => ['description' => '访问密钥ID。', 'type' => 'string', 'example' => 'LTAI*******************'],
'CreateDate' => ['description' => '访问密钥创建时间。', 'type' => 'string', 'example' => '2020-10-13T12:33:18Z'],
],
],
],
],
'description' => '',
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4B450CA1-36E8-4AA2-8461-86B42BF4CC4E'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询主账号或RAM用户访问密钥列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '900', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAccessKeys'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListAccessKeys',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessKeys\\": {\\n \\"AccessKey\\": [\\n {\\n \\"Status\\": \\"Active\\",\\n \\"UpdateDate\\": \\"2020-10-13T12:33:18Z\\",\\n \\"AccessKeyId\\": \\"LTAI*******************\\",\\n \\"CreateDate\\": \\"2020-10-13T12:33:18Z\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t0wNEpMMlzy7s****\\r\\n\\t\\t\\tActive\\r\\n\\t\\t\\t2020-10-13T12:33:18Z\\r\\n\\t\\t\\t2020-10-13T12:33:18Z\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tWnIWUruvfaDT****\\r\\n\\t\\t\\tInactive\\r\\n\\t\\t\\t2020-10-14T12:33:18Z\\r\\n\\t\\t\\t2020-10-14T21:12:21Z\\r\\n\\t\\t\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
],
'ListAccessKeysInRecycleBin' => [
'summary' => '查询回收站中的指定RAM用户的访问密钥列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => 'RAM用户ID。', 'type' => 'string', 'required' => false, 'example' => '20732900249392****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'AccessKeys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AccessKey' => [
'description' => '访问密钥信息。',
'type' => 'array',
'items' => [
'description' => '访问密钥信息。',
'type' => 'object',
'properties' => [
'AccessKeyId' => ['description' => '访问密钥ID。', 'type' => 'string', 'example' => 'LTAI*******************'],
'CreateDate' => ['description' => '访问密钥的创建时间。', 'type' => 'string', 'example' => '2020-10-11T09:12:00Z'],
'RecycleDate' => ['description' => '访问密钥被删除进入回收站的时间。', 'type' => 'string', 'example' => '2020-10-12T09:12:00Z'],
'DeleteDate' => ['description' => '访问密钥将从回收站中彻底删除的时间。', 'type' => 'string', 'example' => '2020-11-12T09:12:00Z'],
],
],
],
],
'description' => '',
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询回收站中的访问密钥列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAccessKeysInRecycleBin'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListAccessKeysInRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessKeys\\": {\\n \\"AccessKey\\": [\\n {\\n \\"AccessKeyId\\": \\"LTAI*******************\\",\\n \\"CreateDate\\": \\"2020-10-11T09:12:00Z\\",\\n \\"RecycleDate\\": \\"2020-10-12T09:12:00Z\\",\\n \\"DeleteDate\\": \\"2020-11-12T09:12:00Z\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n LTAI4GFTgcR8m8cZQDTH****\\n 2020-10-11T09:12:00Z\\n 2020-10-12T09:12:00Z\\n 2020-11-12T09:12:00Z\\n \\n 4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\n","errorExample":""}]',
],
'ListAppSecretIds' => [
'summary' => '列出指定应用的应用密钥信息列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramQ794FD'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '472457090344041****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AppSecrets' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AppSecret' => [
'description' => '应用密钥信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => '472457090344041****'],
'AppSecretId' => ['description' => '应用密钥ID。', 'type' => 'string', 'example' => '2efd5004-005c-4f05-83c6-5b1dd176****'],
'CreateDate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-10-26T03:18:39Z'],
],
'description' => '',
],
],
],
'description' => '',
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5F2FD500-7173-47D6-BD2F-EB60879B4F16'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询指定应用的应用密钥ID列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAppSecretIds'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListAppSecretIds',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"AppSecrets\\": {\\n \\"AppSecret\\": [\\n {\\n \\"AppId\\": \\"472457090344041****\\",\\n \\"AppSecretId\\": \\"2efd5004-005c-4f05-83c6-5b1dd176****\\",\\n \\"CreateDate\\": \\"2020-10-26T03:18:39Z\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"5F2FD500-7173-47D6-BD2F-EB60879B4F16\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t472457090344041****\\r\\n\\t\\t\\t2efd5004-005c-4f05-83c6-5b1dd176****\\r\\n\\t\\t\\t2020-10-26T02:52:31Z\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t472457090344041****\\r\\n\\t\\t\\t7be32a14-d4c5-4f19-84e7-c37c1515****\\r\\n\\t\\t\\t2020-10-26T03:18:39Z\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t5F2FD500-7173-47D6-BD2F-EB60879B4F16\\r\\n\\t\\r\\n","errorExample":""}]',
],
'ListApplicationProvisionInfos' => [
'summary' => '查询所有已安装应用的安装信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramCEEHYN'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SourceType',
'in' => 'query',
'schema' => ['description' => '应用的来源类型。取值:'."\n"
."\n"
.'- inner:来自本账号的应用。'."\n"
.'- external:来自其他账号的应用。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'external'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ApplicationProvisionInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApplicationProvisionInfo' => [
'description' => '已安装应用的信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '应用的显示名称。', 'type' => 'string', 'example' => 'GiteeAliyun'],
'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'GiteePrd'],
'UpdateDate' => ['description' => '更新时间戳。', 'type' => 'string', 'example' => '1603693518000'],
'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => '452392483381546****'],
'DelegatedScope' => [
'description' => '应用权限范围信息。',
'type' => 'object',
'properties' => [
'PredefinedScopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PredefinedScope' => [
'description' => '应用权限范围信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => ['description' => '范围描述。', 'type' => 'string', 'example' => '用于获取用户的OpenID(默认权限范围,不可移除)'],
'Name' => ['description' => '范围名称。', 'type' => 'string', 'example' => 'openid'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'AccountId' => ['description' => '阿里云账号ID。', 'type' => 'string', 'example' => '177242285274****'],
'CreateDate' => ['description' => '安装时间戳。', 'type' => 'string', 'example' => '1603693518000'],
],
'description' => '',
],
],
],
'description' => '',
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E403EBFD-C997-489D-BFC7-37C05E66D67C'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询所有已安装应用的安装信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplicationProvisionInfos'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListApplicationProvisionInfos',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ApplicationProvisionInfos\\": {\\n \\"ApplicationProvisionInfo\\": [\\n {\\n \\"DisplayName\\": \\"GiteeAliyun\\",\\n \\"AppName\\": \\"GiteePrd\\",\\n \\"UpdateDate\\": \\"1603693518000\\",\\n \\"AppId\\": \\"452392483381546****\\",\\n \\"DelegatedScope\\": {\\n \\"PredefinedScopes\\": {\\n \\"PredefinedScope\\": [\\n {\\n \\"Description\\": \\"用于获取用户的OpenID(默认权限范围,不可移除)\\",\\n \\"Name\\": \\"openid\\"\\n }\\n ]\\n }\\n },\\n \\"AccountId\\": \\"177242285274****\\",\\n \\"CreateDate\\": \\"1603693518000\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"E403EBFD-C997-489D-BFC7-37C05E66D67C\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t1603693518000\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\t用于获取用户的OpenID(默认权限范围,不可移除)\\r\\n\\t\\t\\t\\t\\t\\topenid\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t177242285274****\\r\\n\\t\\t\\t452392483381546****\\r\\n\\t\\t\\tGiteeAliyun\\r\\n\\t\\t\\t1603693518000\\r\\n\\t\\t\\tGiteePrd\\r\\n\\t\\t\\r\\n\\t\\r\\n\\tE403EBFD-C997-489D-BFC7-37C05E66D67C\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
],
'ListApplications' => [
'summary' => '列出创建的应用列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram2SMFX0'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CE458B58-8C40-46F7-A9D4-CB85136B0C06'],
'Applications' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Application' => [
'description' => '应用信息。',
'type' => 'array',
'items' => [
'description' => '应用信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '应用的显示名称。', 'type' => 'string', 'example' => 'myapp'],
'AccessTokenValidity' => ['description' => '访问令牌有效期。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'SecretRequired' => ['description' => '是否需要应用密钥。', 'type' => 'boolean', 'example' => 'true'],
'AccountId' => ['description' => '应用所属的阿里云账号ID。', 'type' => 'string', 'example' => '177242285274****'],
'CreateDate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-10-23T09:33:22Z'],
'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'myapp'],
'RedirectUris' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RedirectUri' => [
'description' => '回调地址。',
'type' => 'array',
'items' => ['description' => '回调地址。', 'type' => 'string', 'example' => 'https://www.example.com'],
],
],
'description' => '',
],
'UpdateDate' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-10-23T09:33:22Z'],
'DelegatedScope' => [
'description' => '应用权限范围信息。',
'type' => 'object',
'properties' => [
'PredefinedScopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PredefinedScope' => [
'description' => '应用权限范围信息。',
'type' => 'array',
'items' => [
'description' => '应用权限范围信息。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '范围描述。', 'type' => 'string', 'example' => 'Obtain the OpenID of the user. This is the default permission that you cannot remove.'],
'Name' => ['description' => '范围名称。', 'type' => 'string', 'example' => 'openid'],
'Required' => ['description' => '安装应用时,此权限范围是否默认必选。取值:'."\n"
."\n"
.'- true:必选。'."\n"
.'- false:非必选。'."\n"
."\n"
.'其中`openid`默认为必选。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'description' => '',
],
],
],
'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => '441442900344560****'],
'RefreshTokenValidity' => ['description' => '刷新令牌有效期。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '7776000'],
'IsMultiTenant' => ['description' => '是否允许被其他账号安装。', 'type' => 'boolean', 'example' => 'true'],
'AppType' => ['description' => '应用类型。取值:'."\n"
."\n"
.'- WebApp:指基于浏览器交互的网络应用。'."\n"
.'- NativeApp:指操作系统中运行的本地应用,主要为运行在桌面操作系统或移动操作系统中的应用。'."\n"
.'- ServerApp:指直接访问阿里云服务,而无需依赖用户登录的应用,目前仅支持基于SCIM协议的用户同步应用。', 'type' => 'string', 'example' => 'WebApp'],
'ProtocolVersion' => ['description' => '应用的OAuth协议版本。取值:'."\n"
.'+ `2.0`:表示为OAuth 2.0协议。'."\n"
.'+ `2.1`:表示为OAuth 2.1协议。', 'type' => 'string', 'example' => '2.0'],
],
],
],
],
'description' => '',
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询应用列表',
'description' => '本文将提供一个示例,查询当前账号下的应用列表。返回结果显示,当前账号下只有一个名为`myapp`的应用。',
'requestParamsDescription' => ' 关于公共请求参数的详情,请参见[公共参数](~~187377~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplications'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:ListApplications',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CE458B58-8C40-46F7-A9D4-CB85136B0C06\\",\\n \\"Applications\\": {\\n \\"Application\\": [\\n {\\n \\"DisplayName\\": \\"myapp\\",\\n \\"AccessTokenValidity\\": 3600,\\n \\"SecretRequired\\": true,\\n \\"AccountId\\": \\"177242285274****\\",\\n \\"CreateDate\\": \\"2020-10-23T09:33:22Z\\",\\n \\"AppName\\": \\"myapp\\",\\n \\"RedirectUris\\": {\\n \\"RedirectUri\\": [\\n \\"https://www.example.com\\"\\n ]\\n },\\n \\"UpdateDate\\": \\"2020-10-23T09:33:22Z\\",\\n \\"DelegatedScope\\": {\\n \\"PredefinedScopes\\": {\\n \\"PredefinedScope\\": [\\n {\\n \\"Description\\": \\"Obtain the OpenID of the user. This is the default permission that you cannot remove.\\",\\n \\"Name\\": \\"openid\\",\\n \\"Required\\": true\\n }\\n ]\\n }\\n },\\n \\"AppId\\": \\"441442900344560****\\",\\n \\"RefreshTokenValidity\\": 7776000,\\n \\"IsMultiTenant\\": true,\\n \\"AppType\\": \\"WebApp\\",\\n \\"ProtocolVersion\\": \\"2.0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\tCE458B58-8C40-46F7-A9D4-CB85136B0C06\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t177242285274****\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\t2020-10-23T09:33:22Z\\r\\n\\t\\t\\tmyapp\\r\\n\\t\\t\\t2020-10-23T09:33:22Z\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\t用于获取用户的OpenID(默认权限范围,不可移除)\\r\\n\\t\\t\\t\\t\\t\\topenid\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t\\t用于获取阿里云UID\\r\\n\\t\\t\\t\\t\\t\\taliuid\\r\\n\\t\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t441442900344560****\\r\\n\\t\\t\\tmyapp\\r\\n\\t\\t\\t3600\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\thttps://www.example.com\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t7776000\\r\\n\\t\\t\\tWebApp\\r\\n\\t\\t\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
],
'ListExternalApplications' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram2SMFX0'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '936E1D9C-157D-45BD-8A3B-81C0716EB077'],
'IsTruncated' => ['description' => '请求返回结果是否被截断。取值:'."\n"
."\n"
.'- true:已截断。'."\n"
.'- false:未截断。', 'type' => 'boolean', 'example' => 'true'],
'Marker' => ['description' => '查询返回结果下一页的令牌。'."\n"
.'> 只有`IsTruncated`为`true`时,才显示该参数。', 'type' => 'string', 'example' => 'EXAMPLE'],
'ExternalApplications' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ExternalApplication' => [
'description' => '外部应用的信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '显示名称。', 'type' => 'string', 'example' => 'GiteeAliyun'],
'UpdateDate' => ['description' => '应用更新时间戳。', 'type' => 'string', 'example' => '1603693518000'],
'DelegatedScope' => [
'description' => '应用权限范围信息。',
'type' => 'object',
'properties' => [
'PredefinedScopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PredefinedScope' => [
'description' => '应用权限范围信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => ['description' => '范围描述。', 'type' => 'string', 'example' => '用于获取用户的OpenID(默认权限范围,不可移除)'],
'Name' => ['description' => '范围名称。', 'type' => 'string', 'example' => 'openid'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'AppPrincipalName' => ['description' => '应用主体名称,格式为`@app..onaliyun.com`。', 'type' => 'string', 'example' => 'GiteePrd@app.153082740420****.onaliyun.com'],
'CreateDate' => ['description' => '安装时间戳。', 'type' => 'string', 'example' => '1603693318000'],
'TenantId' => ['description' => '外部应用安装到的阿里云账号ID。', 'type' => 'string', 'example' => '173082740420****'],
'ForeignAppId' => ['description' => '外部应用ID。', 'type' => 'string', 'example' => '407426893752729****'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询所有已安装的外部应用',
'summary' => '查询所有已安装的外部应用的信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExternalApplications'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListExternalApplications',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"936E1D9C-157D-45BD-8A3B-81C0716EB077\\",\\n \\"IsTruncated\\": true,\\n \\"Marker\\": \\"EXAMPLE\\",\\n \\"ExternalApplications\\": {\\n \\"ExternalApplication\\": [\\n {\\n \\"DisplayName\\": \\"GiteeAliyun\\",\\n \\"UpdateDate\\": \\"1603693518000\\",\\n \\"DelegatedScope\\": {\\n \\"PredefinedScopes\\": {\\n \\"PredefinedScope\\": [\\n {\\n \\"Description\\": \\"用于获取用户的OpenID(默认权限范围,不可移除)\\",\\n \\"Name\\": \\"openid\\"\\n }\\n ]\\n }\\n },\\n \\"AppPrincipalName\\": \\"GiteePrd@app.153082740420****.onaliyun.com\\",\\n \\"CreateDate\\": \\"1603693318000\\",\\n \\"TenantId\\": \\"173082740420****\\",\\n \\"ForeignAppId\\": \\"407426893752729****\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListGroups' => [
'summary' => '列出用户组的信息列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram3V29VK'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Marker',
'in' => 'query',
'schema' => ['description' => '当请求的返回结果被截断时,可以使用`Marker`获取从当前截断位置之后的内容。 ', 'type' => 'string', 'required' => false, 'example' => 'EXAMPLE'],
],
[
'name' => 'MaxItems',
'in' => 'query',
'schema' => ['description' => '返回结果的条数。当返回结果达到`MaxItems`限制被截断时,返回参数`IsTruncated`将等于`true`。'."\n"
."\n"
.' 取值范围:1~100。默认值:100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '065527AA-2F2E-AD7C-7484-F2626CFE4934'],
'Groups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Group' => [
'description' => '用户组信息。',
'type' => 'array',
'items' => [
'description' => '用户组信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '用户组显示名称。', 'type' => 'string', 'example' => 'Dev-Team'],
'GroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => '740317625433843****'],
'UpdateDate' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-10-19T12:33:18Z'],
'GroupName' => ['description' => '用户组名称。', 'type' => 'string', 'example' => 'dev-team'],
'Comments' => ['description' => '备注。', 'type' => 'string', 'example' => '开发团队'],
'CreateDate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-10-19T12:33:18Z'],
],
],
],
],
'description' => '',
],
'IsTruncated' => ['description' => '请求返回结果是否被截断。取值:'."\n"
."\n"
.'- true'."\n"
.'- false', 'type' => 'boolean', 'example' => 'true'],
'Marker' => ['description' => '当`IsTruncated`为`true`时才有此参数,当返回`true`时,需要继续调用此接口,并且使用`Marker`获取截断后的内容 。', 'type' => 'string', 'example' => 'EXAMPLE'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询用户组列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroups'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"065527AA-2F2E-AD7C-7484-F2626CFE4934\\",\\n \\"Groups\\": {\\n \\"Group\\": [\\n {\\n \\"DisplayName\\": \\"Dev-Team\\",\\n \\"GroupId\\": \\"740317625433843****\\",\\n \\"UpdateDate\\": \\"2020-10-19T12:33:18Z\\",\\n \\"GroupName\\": \\"dev-team\\",\\n \\"Comments\\": \\"开发团队\\",\\n \\"CreateDate\\": \\"2020-10-19T12:33:18Z\\"\\n }\\n ]\\n },\\n \\"IsTruncated\\": true,\\n \\"Marker\\": \\"EXAMPLE\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t开发团队\\r\\n\\t\\t\\t2020-10-19T12:33:18Z\\r\\n\\t\\t\\tDev-Team\\r\\n\\t\\t\\tDev-Team\\r\\n 740317625433843****\\r\\n\\t\\t\\t2020-10-19T12:33:18Z\\r\\n\\t\\t\\r\\n\\t\\r\\n\\ttrue\\r\\n\\tEXAMPLE\\r\\n\\t065527AA-2F2E-AD7C-7484-F2626CFE4934\\r\\n\\t\\r\\n","errorExample":""}]',
],
'ListGroupsForUser' => [
'summary' => '查询指定的RAM用户加入的组的列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram3V29VK'],
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test@example.onaliyun.com'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7158A935-FB5E-49A7-8E52-FDA5B2B67247'],
'Groups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Group' => [
'description' => '用户组信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '用户组显示名称。', 'type' => 'string', 'example' => 'Test-Team'],
'GroupName' => ['description' => '用户组名称。', 'type' => 'string', 'example' => 'Test-Team'],
'GroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => '740317625433843****'],
'Comments' => ['description' => '备注。', 'type' => 'string', 'example' => '测试团队'],
'JoinDate' => ['description' => 'RAM用户加入时间。', 'type' => 'string', 'example' => '2020-10-20T06:57:00Z'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询RAM用户加入的用户组列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupsForUser'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListGroupsForUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7158A935-FB5E-49A7-8E52-FDA5B2B67247\\",\\n \\"Groups\\": {\\n \\"Group\\": [\\n {\\n \\"DisplayName\\": \\"Test-Team\\",\\n \\"GroupName\\": \\"Test-Team\\",\\n \\"GroupId\\": \\"740317625433843****\\",\\n \\"Comments\\": \\"测试团队\\",\\n \\"JoinDate\\": \\"2020-10-20T06:57:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t7158A935-FB5E-49A7-8E52-FDA5B2B67247\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tTest-Team\\r\\n\\t\\t\\t测试团队\\r\\n 740317625433843****\\r\\n\\t\\t\\tTest-Team\\r\\n\\t\\t\\t2020-10-20T06:57:00Z\\r\\n\\t\\t\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
],
'ListOIDCProviders' => [
'summary' => '调用ListOIDCProviders查询OIDC身份提供商列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Marker',
'in' => 'query',
'schema' => ['description' => '当请求的返回结果被截断时,可以使用`Marker`获取从当前截断位置之后的内容。 ', 'type' => 'string', 'required' => false, 'example' => 'EXAMPLE'],
],
[
'name' => 'MaxItems',
'in' => 'query',
'schema' => ['description' => '返回结果的条数。当返回结果达到`MaxItems`限制被截断时,返回参数`IsTruncated`将等于`true`。'."\n"
.' '."\n"
.'取值范围:1~100。默认值:100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D2148337-B86A-57F0-8B31-EB7BE0125226'],
'OIDCProviders' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'OIDCProvider' => [
'description' => 'OIDC身份提供商信息。',
'type' => 'array',
'items' => [
'description' => 'OIDC身份提供商信息。',
'type' => 'object',
'properties' => [
'UpdateDate' => ['description' => '修改时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-12T08:38:29Z'],
'Description' => ['description' => 'OIDC身份提供商的描述。', 'type' => 'string', 'example' => 'This is a new OIDC Provider.'],
'OIDCProviderName' => ['description' => 'OIDC身份提供商的名称。', 'type' => 'string', 'example' => 'TestOIDCProvider'],
'CreateDate' => ['description' => '创建时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-11T06:56:03Z'],
'Arn' => ['description' => 'OIDC身份提供商的ARN。', 'type' => 'string', 'example' => 'acs:ram::177242285274****:oidc-provider/TestOIDCProvider'],
'IssuerUrl' => ['description' => '颁发者URL。', 'type' => 'string', 'example' => 'https://xxxxxx.example.com'],
'Fingerprints' => ['description' => 'HTTPS CA证书的验证指纹。多个之间用半角逗号(,)分隔。', 'type' => 'string', 'example' => '902ef2deeb3c5b13ea4c3d5193629309e231****'],
'ClientIds' => ['description' => '客户端ID。多个之间用半角逗号(,)分隔。', 'type' => 'string', 'example' => '498469743454717****'],
'GmtCreate' => ['description' => '创建时间(时间戳)。', 'type' => 'string', 'example' => '1636613763000'],
'GmtModified' => ['description' => '修改时间(时间戳)。', 'type' => 'string', 'example' => '1636706309000'],
'IssuanceLimitTime' => ['description' => '允许外部IdP颁发ID Token的最早签发时间。ID Token中的iat字段如果距离当前时间大于这个值则请求会被拒绝。'."\n"
.'单位:小时。取值范围:1~168。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
],
],
],
],
'description' => '',
],
'IsTruncated' => ['description' => '请求返回结果是否被截断。取值:'."\n"
."\n"
.'- true:已截断。'."\n"
.'- false:未截断。', 'type' => 'boolean', 'example' => 'false'],
'Marker' => ['description' => '当`IsTruncated`为`true`时才有此参数,当返回`true`时,需要继续调用该接口,并且使用`Marker`获取截断后的内容 。', 'type' => 'string', 'example' => 'EXAMPLE'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询OIDC身份提供商列表',
'description' => '### 使用说明'."\n"
.'本文将提供一个示例,查询当前阿里云账号下的全部OIDC身份提供商列表。返回结果显示,只有一个名为`TestOIDCProvider`的OIDC身份提供商。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~187377~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOIDCProviders'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListOIDCProviders',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D2148337-B86A-57F0-8B31-EB7BE0125226\\",\\n \\"OIDCProviders\\": {\\n \\"OIDCProvider\\": [\\n {\\n \\"UpdateDate\\": \\"2021-11-12T08:38:29Z\\",\\n \\"Description\\": \\"This is a new OIDC Provider.\\",\\n \\"OIDCProviderName\\": \\"TestOIDCProvider\\",\\n \\"CreateDate\\": \\"2021-11-11T06:56:03Z\\",\\n \\"Arn\\": \\"acs:ram::177242285274****:oidc-provider/TestOIDCProvider\\",\\n \\"IssuerUrl\\": \\"https://xxxxxx.example.com\\",\\n \\"Fingerprints\\": \\"902ef2deeb3c5b13ea4c3d5193629309e231****\\",\\n \\"ClientIds\\": \\"498469743454717****\\",\\n \\"GmtCreate\\": \\"1636613763000\\",\\n \\"GmtModified\\": \\"1636706309000\\",\\n \\"IssuanceLimitTime\\": 12\\n }\\n ]\\n },\\n \\"IsTruncated\\": false,\\n \\"Marker\\": \\"EXAMPLE\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D2148337-B86A-57F0-8B31-EB7BE0125226\\n \\n 2021-11-12T08:38:29Z\\n This is a new OIDC Provider.\\n TestOIDCProvider\\n 2021-11-11T06:56:03Z\\n acs:ram::177242285274****:oidc-provider/TestOIDCProvider\\n https://dev-xxxxxx.okta.com\\n 902ef2deeb3c5b13ea4c3d5193629309e231****\\n 498469743454717****\\n 1636613763000\\n 1636706309000\\n 12\\n \\n false\\n EXAMPLE\\n","errorExample":""}]',
],
'ListPasskeys' => [
'summary' => '查询用户绑定的通行密钥信息。',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '254320',
'abilityTreeNodes' => ['FEATUREramCFN0GB'],
'autoTest' => false,
'notSupportAutoTestReason' => '因为创建passkey需要通过控制台页面,没有openAPI,因此无法创建用来更新的passkey',
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'],
'Passkeys' => [
'description' => '通行密钥列表信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PasskeyName' => ['description' => '通行密钥的名称。', 'type' => 'string', 'example' => 'device1'],
'PasskeyId' => ['description' => '通行密钥的ID。', 'type' => 'string', 'example' => 'PASSKEY-CuZjEHhWcr7GIQOMGvkS'],
'CreateDate' => ['description' => '通行密钥的创建时间戳。', 'type' => 'string', 'example' => '1737450279'],
'LastUseDate' => ['description' => '通行密钥的最近一次使用时间戳。', 'type' => 'string', 'example' => '1737450390'],
],
'description' => '',
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查看用户绑定的通行密钥',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'ram:ListPasskeys',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Passkeys\\": [\\n {\\n \\"PasskeyName\\": \\"device1\\",\\n \\"PasskeyId\\": \\"PASSKEY-CuZjEHhWcr7GIQOMGvkS\\",\\n \\"CreateDate\\": \\"1737450279\\",\\n \\"LastUseDate\\": \\"1737450390\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListPredefinedScopes' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AppType',
'in' => 'query',
'schema' => ['description' => '应用类型。取值:'."\n"
."\n"
.'- WebApp'."\n"
.'- NativeApp'."\n"
.'- ServerApp'."\n"
."\n"
.'如果不设置该参数,则查询所有应用类型的应用权限范围列表。', 'type' => 'string', 'required' => false, 'example' => 'WebApp'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PredefinedScopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PredefinedScope' => [
'description' => '应用权限范围信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => ['description' => '范围描述。', 'type' => 'string', 'example' => '用于获取用户的OpenID(默认权限范围,不可移除)'],
'Name' => ['description' => '范围名称。', 'type' => 'string', 'example' => 'openid'],
],
'description' => '',
],
],
],
'description' => '',
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '955C096D-EC99-480B-AF37-3921109107D0'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询系统预设的Scope列表',
'summary' => '列出系统预定义的应用权限范围列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPredefinedScopes'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PredefinedScopes\\": {\\n \\"PredefinedScope\\": [\\n {\\n \\"Description\\": \\"用于获取用户的OpenID(默认权限范围,不可移除)\\",\\n \\"Name\\": \\"openid\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"955C096D-EC99-480B-AF37-3921109107D0\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t用于获取用户的OpenID(默认权限范围,不可移除)\\r\\n\\t\\t\\topenid\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t用于访问阿里云呼叫中心服务API\\r\\n\\t\\t\\t/acs/ccc\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t用于获取阿里云UID\\r\\n\\t\\t\\taliuid\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t用于获取用户名称等个人信息\\r\\n\\t\\t\\tprofile\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t用于访问阿里云解析API\\r\\n\\t\\t\\t/acs/alidns\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t用于访问阿里云跨域身份管理服务\\r\\n\\t\\t\\t/acs/scim\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t用于访问数字化门店(Digital Store)\\r\\n\\t\\t\\t/acs/digitalstore\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t用于访问智能客服平台(Smart Customer Service Platform)\\r\\n\\t\\t\\t/acs/scsp\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t用于访问云游戏平台(Cloud Gaming Platform)\\r\\n\\t\\t\\t/acs/cloudgame\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t用于访问智能联络中心\\r\\n\\t\\t\\t/acs/aiccs\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t955C096D-EC99-480B-AF37-3921109107D0\\r\\n\\t\\r\\n","errorExample":""}]',
],
'ListRecentGovernanceMetrics' => [
'summary' => '查询最近一次治理检测中的所有检测指标值。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramOHWKAN'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '49846A91-C1C5-5C2B-BC64-8B0B7BADB4C0'],
'GenerateTime' => ['description' => '报告生成的时间。', 'type' => 'string', 'example' => '2025-02-10T02:11:23Z'],
'GovernanceMetrics' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'GovernanceMetric' => [
'description' => '治理项指标值集合,为一个数组,数组中的每一行包含一个治理项的指标值。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GovernanceItem' => ['description' => '治理项名称。', 'type' => 'string', 'example' => 'RecentAccountLoginTimes'],
'MetricType' => ['description' => '治理项指标值类型,取值:'."\n"
."\n"
.'- Number:数值类型'."\n"
.'- String:字符串类型'."\n"
.'- Boolean:布尔类型', 'type' => 'string', 'example' => 'Number'],
'MetricValue' => ['description' => '指标值,类型由`MetricType`取值决定。', 'type' => 'any', 'example' => '5'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询最近一次治理检测的所有治理项指标值',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRecentGovernanceMetrics'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListRecentGovernanceMetrics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"49846A91-C1C5-5C2B-BC64-8B0B7BADB4C0\\",\\n \\"GenerateTime\\": \\"2025-02-10T02:11:23Z\\",\\n \\"GovernanceMetrics\\": {\\n \\"GovernanceMetric\\": [\\n {\\n \\"GovernanceItem\\": \\"RecentAccountLoginTimes\\",\\n \\"MetricType\\": \\"Number\\",\\n \\"MetricValue\\": \\"5\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListSAMLProviders' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram7YYMOK'],
],
'parameters' => [
[
'name' => 'Marker',
'in' => 'query',
'schema' => ['description' => '当请求的返回结果被截断时,可以使用`Marker`获取从当前截断位置之后的内容。 ', 'type' => 'string', 'required' => false, 'example' => 'EXAMPLE'],
],
[
'name' => 'MaxItems',
'in' => 'query',
'schema' => ['description' => '返回结果的条数。当返回结果达到`MaxItems`限制被截断时,返回参数`IsTruncated`将等于`true`。 '."\n"
."\n"
.'取值范围:1~100。默认值:100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2D8B70D3-E194-41C9-93C5-F6A10D716D24'],
'SAMLProviders' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SAMLProvider' => [
'description' => '身份提供商信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UpdateDate' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-10-22T06:26:15Z'],
'Description' => ['description' => '备注。', 'type' => 'string', 'example' => 'This is a provider.'],
'SAMLProviderName' => ['description' => '身份提供商名称。', 'type' => 'string', 'example' => 'test-provider'],
'CreateDate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-10-22T06:26:15Z'],
'Arn' => ['description' => '身份提供商的ARN。', 'type' => 'string', 'example' => 'acs:ram::177242285274****:saml-provider/test-provider'],
],
'description' => '',
],
],
],
'description' => '',
],
'IsTruncated' => ['description' => '请求返回结果是否被截断。取值:'."\n"
."\n"
.'- true'."\n"
.'- false', 'type' => 'boolean', 'example' => 'true'],
'Marker' => ['description' => '当`IsTruncated`为`true`时才有此参数,当返回`true`时,需要继续调用此接口,并且使用`Marker`获取截断后的内容 。', 'type' => 'string', 'example' => 'EXAMPLE'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询角色SSO身份提供商列表',
'summary' => '查询所有角色SSO身份提供商信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSAMLProviders'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListSAMLProviders',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D8B70D3-E194-41C9-93C5-F6A10D716D24\\",\\n \\"SAMLProviders\\": {\\n \\"SAMLProvider\\": [\\n {\\n \\"UpdateDate\\": \\"2020-10-22T06:26:15Z\\",\\n \\"Description\\": \\"This is a provider.\\",\\n \\"SAMLProviderName\\": \\"test-provider\\",\\n \\"CreateDate\\": \\"2020-10-22T06:26:15Z\\",\\n \\"Arn\\": \\"acs:ram::177242285274****:saml-provider/test-provider\\"\\n }\\n ]\\n },\\n \\"IsTruncated\\": true,\\n \\"Marker\\": \\"EXAMPLE\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t2D8B70D3-E194-41C9-93C5-F6A10D716D24\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t2020-10-22T06:26:15Z\\r\\n\\t\\t\\ttest-provider\\r\\n\\t\\t\\tThis is a provider.\\r\\n\\t\\t\\tacs:ram::177242285274****:saml-provider/test-provider\\r\\n\\t\\t\\t2020-10-22T06:26:15Z\\r\\n\\t\\t\\r\\n\\t\\r\\n\\ttrue\\r\\n\\tEXAMPLE\\r\\n\\t\\r\\n","errorExample":""}]',
],
'ListServiceCredentials' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AllUsers',
'in' => 'query',
'schema' => [
'title' => '是否查询云账号下所有RAM用户的服务凭证',
'description' => '是否查询云账号下所有RAM用户的服务凭证。'."\n"
."\n"
.'值为true时,不能同时指定UserPrincipalName',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'example' => 'true',
],
],
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['title' => 'RAM用户登录名称。'."\n"
.'查询指定RAM用户的服务凭证。', 'description' => 'RAM用户登录名称。'."\n"
."\n"
.'查询指定RAM用户的服务凭证。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'ServiceName',
'in' => 'query',
'schema' => ['title' => '阿里云服务名称', 'description' => '阿里云服务名称', 'type' => 'string', 'required' => false, 'example' => 'xxx.aliyuncs.com'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['title' => '每页的最大数据条数。'."\n"
.'取值范围1~100,默认值10。', 'description' => '每页的最大数据条数。'."\n"
.'取值范围1~100,默认值10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['title' => '查询返回结果下一页的令牌。'."\n"
.'首次调用 API 不需要该字段。', 'description' => '查询返回结果下一页的令牌。'."\n"
.'首次调用 API 不需要该字段。', 'type' => 'string', 'required' => false, 'example' => 'EXAMPLE*******'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'D80A0F97-6F12-5CD1-A70A-77A03BF4CFC5'],
'ServiceCredentials' => [
'title' => '服务凭证列表',
'description' => '服务凭证列表',
'type' => 'array',
'items' => [
'title' => '服务凭证信息',
'description' => '服务凭证信息',
'type' => 'object',
'properties' => [
'ServiceCredentialId' => ['title' => '服务凭证ID', 'description' => '服务凭证ID', 'type' => 'string', 'example' => 'SC*************'],
'ServiceCredentialName' => ['title' => '服务凭证名称', 'description' => '服务凭证名称', 'type' => 'string', 'example' => 'test'],
'ServiceName' => ['title' => '阿里云服务名称', 'description' => '阿里云服务名称', 'type' => 'string', 'example' => 'xxx.aliyuncs.com'],
'UserPrincipalName' => ['title' => 'RAM用户登录名称', 'description' => 'RAM用户登录名称', 'type' => 'string', 'example' => 'test@example.onaliyun.com'],
'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2026-05-07T05:49:57Z'],
'ExpirationTime' => ['title' => '过期时间。'."\n"
.'永久有效的服务凭证不返回该字段。', 'description' => '过期时间。'."\n"
.'永久有效的服务凭证不返回该字段。', 'type' => 'string', 'example' => '2026-06-07T05:49:57Z'],
'Status' => [
'title' => '服务凭证状态',
'description' => '服务凭证状态',
'type' => 'string',
'example' => 'Active',
'enum' => ['Active', 'Inactive', 'Expired'],
],
],
],
],
'IsTruncated' => ['title' => '是否还有下一页', 'description' => '是否还有下一页', 'type' => 'boolean', 'example' => 'true'],
'NextToken' => ['title' => '获取下一页结果的令牌', 'description' => '获取下一页结果的令牌', 'type' => 'string', 'example' => 'EXAMPLE*******'],
'MaxResults' => ['title' => '每页的最大数据条数', 'description' => '每页的最大数据条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取服务凭证列表',
'summary' => '获取RAM用户或阿里云账号(主账号)下所有RAM用户的服务凭证列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListServiceCredentials',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D80A0F97-6F12-5CD1-A70A-77A03BF4CFC5\\",\\n \\"ServiceCredentials\\": [\\n {\\n \\"ServiceCredentialId\\": \\"SC*************\\",\\n \\"ServiceCredentialName\\": \\"test\\",\\n \\"ServiceName\\": \\"xxx.aliyuncs.com\\",\\n \\"UserPrincipalName\\": \\"test@example.onaliyun.com\\",\\n \\"CreateTime\\": \\"2026-05-07T05:49:57Z\\",\\n \\"ExpirationTime\\": \\"2026-06-07T05:49:57Z\\",\\n \\"Status\\": \\"Active\\"\\n }\\n ],\\n \\"IsTruncated\\": true,\\n \\"NextToken\\": \\"EXAMPLE*******\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
],
'ListTagResources' => [
'summary' => '调用ListTagResources查询资源与标签的关系。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramVRK65Q'],
],
'parameters' => [
[
'name' => 'ResourcePrincipalName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '资源名,最多50个子项',
'description' => '资源名称。'."\n"
."\n"
.'N的取值范围为:1~50。 当资源类型为user时,资源名称为RAM用户名。'."\n"
.'> 必须指定 ResourceId、ResourcePrincipalName两个参数中的一个参数,但不能同时指定。',
'type' => 'array',
'items' => ['description' => '资源名称。'."\n"
."\n"
.'N的取值范围为:1~50。 当资源类型为user时,资源名称为RAM用户名。'."\n"
.'> 必须指定 ResourceId、ResourcePrincipalName两个参数中的一个参数,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
'required' => false,
'maxItems' => 51,
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '下一个查询开始Token', 'description' => '当请求的返回结果被截断时,可以使用NextToken获取从当前截断位置之后的内容。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '返回结果的条数。当返回结果达到PageSize限制被截断时,返回参数IsTruncated将等于true。'."\n"
.'取值范围:1~100。默认值:100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['title' => '资源类型', 'description' => '资源类型。取值:'."\n"
.'- user:RAM用户。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'user'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '资源ID,最多 50个子项',
'description' => '资源ID。'."\n"
."\n"
.'N的取值范围为:1~50。 当资源类型为user时,资源ID为RAM用户ID。'."\n"
.'> 必须指定 ResourceId、ResourcePrincipalName两个参数中的一个参数,但不能同时指定。',
'type' => 'array',
'items' => ['description' => '资源ID。'."\n"
."\n"
.'N的取值范围为:1~50。 当资源类型为user时,资源ID为RAM用户ID。'."\n"
.'> 必须指定 ResourceId、ResourcePrincipalName两个参数中的一个参数,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => '20732900249392****'],
'required' => false,
'maxItems' => 51,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标签列表,最多包含20个子项',
'description' => '标签列表,最多包含20个子项。',
'type' => 'array',
'items' => [
'description' => '标签列表,最多包含20个子项。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键', 'description' => '标签键。'."\n"
."\n"
.'N的取值范围:1~20,N必须连续。', 'type' => 'string', 'required' => false, 'example' => 'operator'],
'Value' => ['title' => '标签值', 'description' => '标签值。'."\n"
."\n"
.'N的取值范围:1~20,N必须连续。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'NextToken' => ['title' => '下一个查询开始Token,NextToken为空说明没有下一个', 'description' => '当IsTruncated为true时才有此参数,当返回true时,需要继续调用此接口,使用NextToken获取截断后的内容。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4BE83135-0B08-467C-B3A2-27B312FD0F57'],
'TagResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagResource' => [
'title' => '资源列表',
'description' => '资源绑定的标签列表。',
'type' => 'array',
'items' => [
'description' => '资源绑定的标签列表。',
'type' => 'object',
'properties' => [
'ResourceType' => ['title' => '资源类型', 'description' => '资源类型。取值:'."\n"
.'- user:RAM用户。', 'type' => 'string', 'example' => 'user'],
'TagValue' => ['title' => '标签值', 'description' => '标签值。', 'type' => 'string', 'example' => 'alice'],
'ResourceId' => ['title' => '资源ID', 'description' => '资源ID。', 'type' => 'string', 'example' => '20732900249392****'],
'TagKey' => ['title' => '标签键', 'description' => '标签键。', 'type' => 'string', 'example' => 'operator'],
],
],
],
],
'description' => '',
],
'IsTruncated' => ['title' => '请求返回结果是否被截断', 'description' => '请求返回结果是否被截断。取值:'."\n"
.'- true'."\n"
.'- false', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询资源与标签的关系',
'description' => '### 使用说明'."\n"
.'请求中至少指定以下任一参数,以确定查询对象:'."\n"
.'- `ResourceId.N`'."\n"
.'- `Tag.N.Key`'."\n"
.'- `Tag.N.Key`和`Tag.N.Value`',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListTagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"RequestId\\": \\"4BE83135-0B08-467C-B3A2-27B312FD0F57\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"user\\",\\n \\"TagValue\\": \\"alice\\",\\n \\"ResourceId\\": \\"20732900249392****\\",\\n \\"TagKey\\": \\"operator\\"\\n }\\n ]\\n },\\n \\"IsTruncated\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n caeba0bbb2be03f84eb48b699f0a4883\\n 4BE83135-0B08-467C-B3A2-27B312FD0F57\\n \\n user\\n 20732900249392****\\n operator\\n alice\\n \\n \\n user\\n 20732900249392****\\n owner\\n bob\\n \\n true\\n","errorExample":""}]',
],
'ListUserBasicInfos' => [
'summary' => '调用ListUserBasicInfos查询所有RAM用户的基本信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Marker',
'in' => 'query',
'schema' => ['description' => '当请求的返回结果被截断时,可以使用`Marker`获取从当前截断位置之后的内容。 ', 'type' => 'string', 'required' => false, 'example' => 'EXAMPLE'],
],
[
'name' => 'MaxItems',
'in' => 'query',
'schema' => ['description' => '返回结果的条数。当返回结果达到`MaxItems`限制被截断时,返回参数`IsTruncated`将等于`true`。 '."\n"
."\n"
.'取值范围:1~1000。默认值:100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标签列表,最多包含20个子项',
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '标签列表。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键', 'description' => '标签键。'."\n"
."\n"
.'N的取值范围:1~20,N必须连续。', 'type' => 'string', 'required' => false, 'example' => 'operator'],
'Value' => ['title' => '标签值', 'description' => '标签值。'."\n"
."\n"
.'N的取值范围:1~20,N必须连续。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '指定查询的用户状态,支持active,freeze状态。指定全部状态时使用逗号拼接,如:active,freeze。未指定状态时默认指定active状态。'."\n"
.'使用Tag标签时,不支持指定status查询,默认查询全部状态的用户。', 'type' => 'string', 'required' => false, 'example' => 'active'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EF2B25FD-CADE-445B-BE4D-E082E0FF1A0F'],
'IsTruncated' => ['description' => '请求返回结果是否被截断。取值:'."\n"
."\n"
.'- true:已截断。'."\n"
.'- false:未截断。', 'type' => 'boolean', 'example' => 'true'],
'UserBasicInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UserBasicInfo' => [
'description' => 'RAM用户的基本信息。',
'type' => 'array',
'items' => [
'description' => 'RAM用户的基本信息。',
'type' => 'object',
'properties' => [
'UserPrincipalName' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'example' => 'test@example.onaliyun.com'],
'DisplayName' => ['description' => 'RAM用户的显示名称。', 'type' => 'string', 'example' => 'test'],
'UserId' => ['description' => 'RAM用户ID。', 'type' => 'string', 'example' => '20732900249392****'],
'Status' => ['description' => 'RAM用户的用户状态。', 'type' => 'string', 'example' => 'active'],
],
],
],
],
'description' => '',
],
'Marker' => ['description' => '当`IsTruncated`为`true`时才有此参数,当返回`true`时,需要继续调用此接口,并且使用`Marker`获取截断后的内容。', 'type' => 'string', 'example' => 'EXAMPLE'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询所有RAM用户的基本信息',
'description' => '您可以通过以下两个API查询所有RAM用户的信息,区别如下:'."\n"
."\n"
.'- ListUsers:查询RAM用户的详细信息。'."\n"
.'- ListUserBasicInfos:查询RAM用户的基本信息,仅包括RAM用户登录名称`UserPrincipalName`、RAM用户显示名称`DisplayName`和RAM用户ID`UserId`。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserBasicInfos'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListUserBasicInfos',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EF2B25FD-CADE-445B-BE4D-E082E0FF1A0F\\",\\n \\"IsTruncated\\": true,\\n \\"UserBasicInfos\\": {\\n \\"UserBasicInfo\\": [\\n {\\n \\"UserPrincipalName\\": \\"test@example.onaliyun.com\\",\\n \\"DisplayName\\": \\"test\\",\\n \\"UserId\\": \\"20732900249392****\\",\\n \\"Status\\": \\"active\\"\\n }\\n ]\\n },\\n \\"Marker\\": \\"EXAMPLE\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EF2B25FD-CADE-445B-BE4D-E082E0FF1A0F\\n true\\n \\n test@example.onaliyun.com\\n test\\n 20732900249392****\\n active\\n \\n EXAMPLE\\n","errorExample":""}]',
],
'ListUsers' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Marker',
'in' => 'query',
'schema' => ['description' => '当请求的返回结果被截断时,可以使用`Marker`获取从当前截断位置之后的内容。 ', 'type' => 'string', 'required' => false, 'example' => 'EXAMPLE'],
],
[
'name' => 'MaxItems',
'in' => 'query',
'schema' => ['description' => '返回结果的条数。当返回结果达到`MaxItems`限制被截断时,返回参数`IsTruncated`将等于true。 '."\n"
."\n"
.'取值范围:1~1000。默认值:1000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标签列表,最多包含20个子项',
'description' => '标签列表,最多包含20个子项。',
'type' => 'array',
'items' => [
'description' => '标签列表,最多包含20个子项。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键', 'description' => '标签键。'."\n"
."\n"
.'N的取值范围:1~20,N必须连续。', 'type' => 'string', 'required' => false, 'example' => 'operator'],
'Value' => ['title' => '标签值', 'description' => '标签值。'."\n"
."\n"
.'N的取值范围:1~20,N必须连续。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '指定查询的用户状态,支持active,freeze状态。指定全部状态时使用逗号拼接,如:active,freeze。未指定状态时默认指定active状态。'."\n"
.'当使用Tag标签时,默认查询全部状态的用户。', 'type' => 'string', 'required' => false, 'example' => 'active'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4B450CA1-36E8-4AA2-8461-86B42BF4CC4E'],
'IsTruncated' => ['description' => '请求返回结果是否被截断。取值:'."\n"
."\n"
.'- true'."\n"
.'- false', 'type' => 'boolean', 'example' => 'true'],
'Marker' => ['description' => '此参数在`IsTruncated`为`true`时生效,用于获取截断后的内容。', 'type' => 'string', 'example' => 'EXAMPLE'],
'Users' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'User' => [
'description' => 'RAM用户信息。',
'type' => 'array',
'items' => [
'description' => 'RAM用户信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => 'RAM用户的显示名称。', 'type' => 'string', 'example' => 'test'],
'UserPrincipalName' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'example' => 'test@example.onaliyun.com'],
'Email' => ['description' => 'RAM用户的电子邮箱。'."\n"
."\n"
.'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => 'alice@example.com'],
'UpdateDate' => ['description' => 'RAM用户的更新时间(UTC时间)。', 'type' => 'string', 'example' => '2023-08-21T06:12:47Z'],
'MobilePhone' => ['description' => 'RAM用户的手机号码。'."\n"
."\n"
.'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => '86-1868888****'],
'UserId' => ['description' => 'RAM用户ID。', 'type' => 'string', 'example' => '20732900249392****'],
'Comments' => ['description' => '备注。', 'type' => 'string', 'example' => 'This is a cloud computing engineer.'],
'LastLoginDate' => ['description' => 'RAM用户最近一次登录控制台的时间(时间戳)。', 'type' => 'string', 'example' => '1692598367586'],
'CreateDate' => ['description' => 'RAM用户的创建时间(UTC时间)。', 'type' => 'string', 'example' => '2020-08-25T09:23:57Z'],
'ProvisionType' => ['description' => '同步类型。取值:'."\n"
.'- Manual:在RAM中手动创建的RAM用户。'."\n"
.'- SCIM:通过SCIM协议同步创建的RAM用户。'."\n"
.'- CloudSSO:通过云SSO同步创建的用户。', 'type' => 'string', 'example' => 'Manual'],
'Status' => ['description' => 'RAM用户的用户状态。', 'type' => 'string', 'example' => 'active'],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '标签列表。',
'type' => 'object',
'properties' => [
'TagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'oparator'],
'TagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'alice'],
],
],
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询所有RAM用户的详细信息',
'summary' => '查询所有RAM用户的详细信息。',
'description' => '### 使用说明'."\n"
.'您可以通过以下两个API查询所有RAM用户的信息,区别如下:'."\n"
."\n"
.'- ListUsers:查询RAM用户的详细信息。'."\n"
.'- ListUserBasicInfos:查询RAM用户的基本信息,仅包括RAM用户登录名称`UserPrincipalName`、RAM用户显示名称`DisplayName`和RAM用户ID`UserId`。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsers'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListUsers',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\",\\n \\"IsTruncated\\": true,\\n \\"Marker\\": \\"EXAMPLE\\",\\n \\"Users\\": {\\n \\"User\\": [\\n {\\n \\"DisplayName\\": \\"test\\",\\n \\"UserPrincipalName\\": \\"test@example.onaliyun.com\\",\\n \\"Email\\": \\"alice@example.com\\",\\n \\"UpdateDate\\": \\"2023-08-21T06:12:47Z\\",\\n \\"MobilePhone\\": \\"86-1868888****\\",\\n \\"UserId\\": \\"20732900249392****\\",\\n \\"Comments\\": \\"This is a cloud computing engineer.\\",\\n \\"LastLoginDate\\": \\"1692598367586\\",\\n \\"CreateDate\\": \\"2020-08-25T09:23:57Z\\",\\n \\"ProvisionType\\": \\"Manual\\",\\n \\"Status\\": \\"active\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagKey\\": \\"oparator\\",\\n \\"TagValue\\": \\"alice\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\n true\\n EXAMPLE\\n \\n active\\n test\\n test@example.onaliyun.com\\n alice@example.com\\n 2023-08-21T06:12:47Z\\n 86-1868888****\\n 20732900249392****\\n This is a cloud computing engineer.\\n 1692598367586\\n 2020-08-25T09:23:57Z\\n Manual\\n \\n oparator\\n alice\\n \\n \\n","errorExample":""}]',
],
'ListUsersForGroup' => [
'summary' => '查询指定用户组内的RAM用户列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram3V29VK'],
],
'parameters' => [
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '用户组名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Test-Team'],
],
[
'name' => 'Marker',
'in' => 'query',
'schema' => ['description' => '查询返回结果下一页的令牌。首次调用API不需要`Marker`。'."\n"
."\n"
.'当您首次调用API时,如果返回数据总条数超过`MaxItems`限制,数据会被截断,只返回`MaxItems`条数据,同时,返回参数`IsTruncated`为`true`,返回一个`Marker`。您可以使用上一次返回的`Marker`继续调用API,其他请求参数保持不变,查询被截断的数据。您可以按此方法经过多次查询,直到`IsTruncated`为`false`时,表示全部数据查询完毕。', 'type' => 'string', 'required' => false, 'example' => 'EXAMPLE'],
],
[
'name' => 'MaxItems',
'in' => 'query',
'schema' => ['description' => '每页的最大数据条数。'."\n"
."\n"
.'取值范围:1~100。'."\n"
."\n"
.'默认值:100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '789FF581-B3C8-43A8-9115-54304B46D05C'],
'IsTruncated' => ['description' => '请求返回结果是否被截断。取值:'."\n"
."\n"
.'- true:已截断。'."\n"
.'- false:未截断。', 'type' => 'boolean', 'example' => 'true'],
'Marker' => ['description' => '查询返回结果下一页的令牌。'."\n"
.'> 只有`IsTruncated`为`true`时,才显示该参数。', 'type' => 'string', 'example' => 'EXAMPLE'],
'Users' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'User' => [
'description' => 'RAM用户信息。',
'type' => 'array',
'items' => [
'description' => 'RAM用户信息。',
'type' => 'object',
'properties' => [
'UserPrincipalName' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'example' => 'test@example.onaliyun.com'],
'DisplayName' => ['description' => 'RAM用户的显示名称。', 'type' => 'string', 'example' => 'test'],
'UserId' => ['description' => 'RAM用户ID。', 'type' => 'string', 'example' => '20732900249392****'],
'JoinDate' => ['description' => 'RAM用户的加入时间(UTC时间)。', 'type' => 'string', 'example' => '2020-10-20T06:57:00Z'],
],
],
],
],
'description' => '',
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询用户组内的RAM用户列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsersForGroup'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListUsersForGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/{#GroupName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"789FF581-B3C8-43A8-9115-54304B46D05C\\",\\n \\"IsTruncated\\": true,\\n \\"Marker\\": \\"EXAMPLE\\",\\n \\"Users\\": {\\n \\"User\\": [\\n {\\n \\"UserPrincipalName\\": \\"test@example.onaliyun.com\\",\\n \\"DisplayName\\": \\"test\\",\\n \\"UserId\\": \\"20732900249392****\\",\\n \\"JoinDate\\": \\"2020-10-20T06:57:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t789FF581-B3C8-43A8-9115-54304B46D05C\\r\\n true\\r\\n EXAMPLE\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t20732900249392****\\r\\n\\t\\t\\ttest\\r\\n\\t\\t\\ttest@example.onaliyun.com\\r\\n\\t\\t\\t2020-10-20T06:57:00Z\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t21096280076542****\\r\\n\\t\\t\\talice\\r\\n\\t\\t\\talice@example.onaliyun.com\\r\\n\\t\\t\\t2020-10-20T07:12:42Z\\r\\n\\t\\t\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
],
'ListUsersInRecycleBin' => [
'summary' => '查询回收站中的所有RAM用户的基本信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Marker',
'in' => 'query',
'schema' => ['description' => '当请求的返回结果被截断时,可以使用`Marker`获取从当前截断位置之后的内容。 ', 'type' => 'string', 'required' => false, 'example' => 'EXAMPLE'],
],
[
'name' => 'MaxItems',
'in' => 'query',
'schema' => ['description' => '返回结果的条数。当返回结果达到`MaxItems`限制被截断时,返回参数`IsTruncated`将等于true。 '."\n"
."\n"
.'取值范围:1~100。默认值:100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
[
'name' => 'Filter',
'in' => 'query',
'schema' => ['description' => '过滤条件,查询回收站中指定RAM用户登录名的信息。'."\n"
."\n"
.'格式:`UserPrincipalName eq @.onaliyun.com`。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => 'UserPrincipalName eq test@example.onaliyun.com'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3687BD52-49FD-585B-AB14-CD05B7C76963'],
'IsTruncated' => ['description' => '请求返回结果是否被截断。取值:'."\n"
."\n"
.'- true'."\n"
.'- false', 'type' => 'boolean', 'example' => 'true'],
'Marker' => ['description' => '此参数在`IsTruncated`为`true`时生效,用于获取截断后的内容。', 'type' => 'string', 'example' => 'EXAMPLE'],
'Users' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'User' => [
'description' => 'RAM用户信息。',
'type' => 'array',
'items' => [
'description' => 'RAM用户信息。',
'type' => 'object',
'properties' => [
'UserId' => ['description' => 'RAM用户ID。', 'type' => 'string', 'example' => '20732900249392****'],
'UserPrincipalName' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'example' => 'test@example.onaliyun.com'],
'DisplayName' => ['description' => 'RAM用户的显示名称。', 'type' => 'string', 'example' => 'test@example.onaliyun.com'],
'CreateDate' => ['description' => 'RAM用户的创建时间。', 'type' => 'string', 'example' => '2020-10-12T09:12:00Z'],
'RecycleDate' => ['description' => 'RAM用户被删除进入回收站的时间。', 'type' => 'string', 'example' => '2020-10-15T09:12:00Z'],
'DeleteDate' => ['description' => 'RAM用户将从在回收站中彻底删除的时间。', 'type' => 'string', 'example' => '2020-11-15T09:12:00Z'],
],
],
],
],
'description' => '',
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询回收站中的所有RAM用户',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsersInRecycleBin'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListUsersInRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3687BD52-49FD-585B-AB14-CD05B7C76963\\",\\n \\"IsTruncated\\": true,\\n \\"Marker\\": \\"EXAMPLE\\",\\n \\"Users\\": {\\n \\"User\\": [\\n {\\n \\"UserId\\": \\"20732900249392****\\",\\n \\"UserPrincipalName\\": \\"test@example.onaliyun.com\\",\\n \\"DisplayName\\": \\"test@example.onaliyun.com\\",\\n \\"CreateDate\\": \\"2020-10-12T09:12:00Z\\",\\n \\"RecycleDate\\": \\"2020-10-15T09:12:00Z\\",\\n \\"DeleteDate\\": \\"2020-11-15T09:12:00Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 3687BD52-49FD-585B-AB14-CD05B7C76963\\n true\\n EXAMPLE\\n \\n 20732900249392****\\n test@example.onaliyun.com\\n test@example.onaliyun.com\\n 2020-10-12T09:12:00Z\\n 2020-10-15T09:12:00Z\\n 2020-11-15T09:12:00Z\\n \\n","errorExample":""}]',
],
'ListVirtualMFADevices' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramCFN0GB'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Marker',
'in' => 'query',
'schema' => ['description' => '查询返回结果下一页的令牌。首次调用API不需要`Marker`。'."\n"
."\n"
.'当您首次调用API时,如果返回数据总条数超过`MaxItems`限制,数据会被截断,只返回`MaxItems`条数据,同时,返回参数`IsTruncated`为`true`,返回一个`Marker`。您可以使用上一次返回的`Marker`继续调用API,其他请求参数保持不变,查询被截断的数据。您可以按此方法经过多次查询,直到`IsTruncated`为`false`时,表示全部数据查询完毕。', 'type' => 'string', 'required' => false, 'example' => 'EXAMPLE'],
],
[
'name' => 'MaxItems',
'in' => 'query',
'schema' => ['description' => '每页的最大数据条数。'."\n"
."\n"
.'取值范围:1~100。'."\n"
."\n"
.'默认值:100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'VirtualMFADevices' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VirtualMFADevice' => [
'description' => '多因素认证设备信息。',
'type' => 'array',
'items' => [
'description' => '多因素认证设备信息。',
'type' => 'object',
'properties' => [
'SerialNumber' => ['description' => '设备序列号。', 'type' => 'string', 'example' => 'acs:ram::177242285274****:mfa/test'],
'User' => [
'description' => '绑定了多因素认证设备的RAM用户信息。',
'type' => 'object',
'properties' => [
'UserPrincipalName' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'example' => 'test@177242285274****.onaliyun.com'],
'DisplayName' => ['description' => 'RAM用户的显示名称。', 'type' => 'string', 'example' => 'test'],
'UserId' => ['description' => 'RAM用户ID。', 'type' => 'string', 'example' => '20732900249392****'],
],
],
'ActivateDate' => ['description' => '激活时间。', 'type' => 'string', 'example' => '2020-10-16T06:02:09Z'],
],
],
],
],
'description' => '',
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '32272612-DF82-485E-8BA9-AFA4E0C3D0BA'],
'IsTruncated' => ['description' => '请求返回结果是否被截断。取值:'."\n"
."\n"
.'- true'."\n"
.'- false', 'type' => 'boolean', 'example' => 'true'],
'Marker' => ['description' => '查询返回结果下一页的令牌。'."\n"
.'> 只有`IsTruncated`为`true`时,才显示该参数。', 'type' => 'string', 'example' => 'EXAMPLE'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询多因素认证设备列表',
'summary' => '查询多因素认证设备列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVirtualMFADevices'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListVirtualMFADevices',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'MFADevice', 'arn' => 'acs:ram::{#accountId}:mfa/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"VirtualMFADevices\\": {\\n \\"VirtualMFADevice\\": [\\n {\\n \\"SerialNumber\\": \\"acs:ram::177242285274****:mfa/test\\",\\n \\"User\\": {\\n \\"UserPrincipalName\\": \\"test@177242285274****.onaliyun.com\\",\\n \\"DisplayName\\": \\"test\\",\\n \\"UserId\\": \\"20732900249392****\\"\\n },\\n \\"ActivateDate\\": \\"2020-10-16T06:02:09Z\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"32272612-DF82-485E-8BA9-AFA4E0C3D0BA\\",\\n \\"IsTruncated\\": true,\\n \\"Marker\\": \\"EXAMPLE\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tacs:ram::177242285274****:mfa/dev-01\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t20732900249392****\\r\\n\\t\\t\\t\\ttest\\r\\n\\t\\t\\t\\ttest@177242285274****.onaliyun.com\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tacs:ram::177242285274****:mfa/test\\r\\n\\t\\t\\t2020-10-16T06:02:09Z\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t32272612-DF82-485E-8BA9-AFA4E0C3D0BA\\r\\n\\ttrue\\r\\n\\tEXAMPLE\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
],
'ProvisionApplication' => [
'summary' => '安装应用。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramCEEHYN'],
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '407426893752729****'],
],
[
'name' => 'Scopes',
'in' => 'query',
'schema' => ['description' => '授予该应用的权限范围信息,可填写多个范围,以分号(;)分隔。'."\n"
."\n\n"
.'> 支持的权限范围可以参考[OAuth应用概览](~~93693~~)中的“OAuth范围”。', 'type' => 'string', 'required' => false, 'example' => 'openid;aliuid'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C8AE06ED-9593-5BF9-8D4A-68D5DDCC90AB'],
'ApplicationProvisionInfo' => [
'description' => '应用安装信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '显示名称。', 'type' => 'string', 'example' => 'GiteeAliyun'],
'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'GiteePrd'],
'UpdateDate' => ['description' => '更新时间戳。', 'type' => 'string', 'example' => '1603693518000'],
'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => '452392483381546****'],
'DelegatedScope' => [
'description' => '应用权限范围信息。',
'type' => 'object',
'properties' => [
'PredefinedScopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PredefinedScope' => [
'description' => '应用权限范围信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => ['description' => '范围描述。', 'type' => 'string', 'example' => '用于获取用户的OpenID(默认权限范围,不可移除)'],
'Name' => ['description' => '范围名称。', 'type' => 'string', 'example' => 'openid'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'AccountId' => ['description' => '阿里云账号ID。', 'type' => 'string', 'example' => '177242285274****'],
'AppPrincipalName' => ['description' => '应用主体名称,格式为`@app..onaliyun.com`。', 'type' => 'string', 'example' => 'GiteePrd@app.177242285274****.onaliyun.com'],
'CreateDate' => ['description' => '安装时间戳。', 'type' => 'string', 'example' => '1603693518000'],
'TenantId' => ['description' => '该应用安装到的阿里云账号ID。', 'type' => 'string', 'example' => '177242285274****'],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '安装应用',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ProvisionApplication'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:ProvisionApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C8AE06ED-9593-5BF9-8D4A-68D5DDCC90AB\\",\\n \\"ApplicationProvisionInfo\\": {\\n \\"DisplayName\\": \\"GiteeAliyun\\",\\n \\"AppName\\": \\"GiteePrd\\",\\n \\"UpdateDate\\": \\"1603693518000\\",\\n \\"AppId\\": \\"452392483381546****\\",\\n \\"DelegatedScope\\": {\\n \\"PredefinedScopes\\": {\\n \\"PredefinedScope\\": [\\n {\\n \\"Description\\": \\"用于获取用户的OpenID(默认权限范围,不可移除)\\",\\n \\"Name\\": \\"openid\\"\\n }\\n ]\\n }\\n },\\n \\"AccountId\\": \\"177242285274****\\",\\n \\"AppPrincipalName\\": \\"GiteePrd@app.177242285274****.onaliyun.com\\",\\n \\"CreateDate\\": \\"1603693518000\\",\\n \\"TenantId\\": \\"177242285274****\\"\\n }\\n}","type":"json"}]',
],
'ProvisionExternalApplication' => [
'summary' => '安装外部应用。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '7484',
'abilityTreeNodes' => ['FEATUREramCEEHYN'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '403550611646604****'],
],
[
'name' => 'Scopes',
'in' => 'query',
'schema' => ['description' => '授予该应用的权限范围信息,可填写多个范围,以分号(;)分隔。'."\n"
."\n\n"
.'> 支持的权限范围可以参考[OAuth应用概览](~~93693~~)中的“OAuth范围”。', 'type' => 'string', 'required' => false, 'example' => 'openid;aliuid'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '55535873-9A6B-5C87-853F-C7CD258826F2'],
'ExternalApplication' => [
'description' => '外部应用信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '显示名称。', 'type' => 'string', 'example' => 'GiteeAliyun'."\n"],
'UpdateDate' => ['description' => '更新时间戳。', 'type' => 'string', 'example' => '1603693518000'],
'DelegatedScope' => [
'description' => '应用权限范围信息。',
'type' => 'object',
'properties' => [
'PredefinedScopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PredefinedScope' => [
'description' => '应用权限范围信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => ['description' => '范围描述。', 'type' => 'string', 'example' => '用于获取用户的OpenID(默认权限范围,不可移除)'],
'Name' => ['description' => '范围名称。', 'type' => 'string', 'example' => 'openid'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'AppPrincipalName' => ['description' => '应用主体名称,格式为`@app..onaliyun.com`。', 'type' => 'string', 'example' => 'GiteePrd@app.177242285274****.onaliyun.com'."\n"],
'CreateDate' => ['description' => '安装时间戳。', 'type' => 'string', 'example' => '1603693518000'],
'TenantId' => ['description' => '外部应用安装到的阿里云账号ID。', 'type' => 'string', 'example' => '157242285274****'],
'ForeignAppId' => ['description' => '外部应用ID。', 'type' => 'string', 'example' => '403550611646604****'],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '安装外部应用',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ProvisionExternalApplication'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:ProvisionExternalApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"55535873-9A6B-5C87-853F-C7CD258826F2\\",\\n \\"ExternalApplication\\": {\\n \\"DisplayName\\": \\"GiteeAliyun\\\\n\\",\\n \\"UpdateDate\\": \\"1603693518000\\",\\n \\"DelegatedScope\\": {\\n \\"PredefinedScopes\\": {\\n \\"PredefinedScope\\": [\\n {\\n \\"Description\\": \\"用于获取用户的OpenID(默认权限范围,不可移除)\\",\\n \\"Name\\": \\"openid\\"\\n }\\n ]\\n }\\n },\\n \\"AppPrincipalName\\": \\"GiteePrd@app.177242285274****.onaliyun.com\\\\n\\",\\n \\"CreateDate\\": \\"1603693518000\\",\\n \\"TenantId\\": \\"157242285274****\\",\\n \\"ForeignAppId\\": \\"403550611646604****\\"\\n }\\n}","type":"json"}]',
],
'RemoveClientIdFromOIDCProvider' => [
'summary' => '调用RemoveClientIdFromOIDCProvider移除OIDC身份提供商中的指定客户端ID。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'OIDCProviderName',
'in' => 'query',
'schema' => ['description' => 'OIDC身份提供商的名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'TestOIDCProvider'],
],
[
'name' => 'ClientId',
'in' => 'query',
'schema' => ['description' => '指定的客户端ID。'."\n"
."\n"
.'格式:允许英文字母、数字、特殊字符`.-_:/`,不能以特殊字符`.-_:/`开头。'."\n"
."\n"
.'长度:最大128个字符。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '498469743454717****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EC9A8F3B-AFA5-5C8F-999D-F97BC7CF1FC5'],
'OIDCProvider' => [
'description' => 'OIDC身份提供商信息。',
'type' => 'object',
'properties' => [
'UpdateDate' => ['description' => '修改时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-12T08:38:29Z'],
'Description' => ['description' => 'OIDC身份提供商的描述。', 'type' => 'string', 'example' => 'This is a new OIDC Provider.'],
'OIDCProviderName' => ['description' => 'OIDC身份提供商的名称。', 'type' => 'string', 'example' => 'TestOIDCProvider'],
'CreateDate' => ['description' => '创建时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-11T06:56:03Z'],
'Arn' => ['description' => 'OIDC身份提供商的ARN。', 'type' => 'string', 'example' => 'acs:ram::177242285274****:oidc-provider/TestOIDCProvider'],
'IssuerUrl' => ['description' => '颁发者URL。', 'type' => 'string', 'example' => 'https://xxxxxx.example.com'],
'Fingerprints' => ['description' => 'HTTPS CA证书的验证指纹。多个之间用半角逗号(,)分隔。', 'type' => 'string', 'example' => '902ef2deeb3c5b13ea4c3d5193629309e231****'],
'ClientIds' => ['description' => '客户端ID。多个之间用半角逗号(,)分隔。', 'type' => 'string', 'example' => '598469743454717****'],
'GmtCreate' => ['description' => '创建时间(时间戳)。', 'type' => 'string', 'example' => '1636613763000'],
'GmtModified' => ['description' => '修改时间(时间戳)。', 'type' => 'string', 'example' => '1636706309000'],
'IssuanceLimitTime' => ['description' => '允许外部IdP颁发ID Token的最早签发时间。ID Token中的iat字段如果距离当前时间大于这个值则请求会被拒绝。'."\n"
.'单位:小时。取值范围:1~168。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '移除OIDC身份提供商中的指定客户端ID',
'description' => '### 使用说明'."\n"
.'本文将提供一个示例,为名为`TestOIDCProvider`的OIDC身份提供商移除客户端ID`498469743454717****`。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~187377~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveClientIdFromOIDCProvider'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:RemoveClientIdFromOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC9A8F3B-AFA5-5C8F-999D-F97BC7CF1FC5\\",\\n \\"OIDCProvider\\": {\\n \\"UpdateDate\\": \\"2021-11-12T08:38:29Z\\",\\n \\"Description\\": \\"This is a new OIDC Provider.\\",\\n \\"OIDCProviderName\\": \\"TestOIDCProvider\\",\\n \\"CreateDate\\": \\"2021-11-11T06:56:03Z\\",\\n \\"Arn\\": \\"acs:ram::177242285274****:oidc-provider/TestOIDCProvider\\",\\n \\"IssuerUrl\\": \\"https://xxxxxx.example.com\\",\\n \\"Fingerprints\\": \\"902ef2deeb3c5b13ea4c3d5193629309e231****\\",\\n \\"ClientIds\\": \\"598469743454717****\\",\\n \\"GmtCreate\\": \\"1636613763000\\",\\n \\"GmtModified\\": \\"1636706309000\\",\\n \\"IssuanceLimitTime\\": 12\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n EC9A8F3B-AFA5-5C8F-999D-F97BC7CF1FC5\\n \\n 2021-11-12T08:38:29Z\\n This is a new OIDC Provider.\\n TestOIDCProvider\\n 2021-11-11T06:56:03Z\\n acs:ram::177242285274****:oidc-provider/TestOIDCProvider\\n https://dev-xxxxxx.okta.com\\n 902ef2deeb3c5b13ea4c3d5193629309e231****\\n 598469743454717****\\n 1636613763000\\n 1636706309000\\n 12\\n \\n","errorExample":""}]',
],
'RemoveFingerprintFromOIDCProvider' => [
'summary' => '调用RemoveFingerprintFromOIDCProvider移除OIDC身份提供商中指定的验证指纹。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'OIDCProviderName',
'in' => 'query',
'schema' => ['description' => 'OIDC身份提供商的名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'TestOIDCProvider'],
],
[
'name' => 'Fingerprint',
'in' => 'query',
'schema' => ['description' => '将要移除的验证指纹。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '6938fd4d98bab03faadb97b34396831e3780****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C90CE971-4C7F-5D93-BD3E-2D0E79D03C01'],
'OIDCProvider' => [
'description' => 'OIDC身份提供商信息。',
'type' => 'object',
'properties' => [
'UpdateDate' => ['description' => '修改时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-12T08:38:29Z'],
'Description' => ['description' => 'OIDC身份提供商的描述。', 'type' => 'string', 'example' => 'This is a new OIDC Provider.'],
'OIDCProviderName' => ['description' => 'OIDC身份提供商的名称。', 'type' => 'string', 'example' => 'TestOIDCProvider'],
'CreateDate' => ['description' => '创建时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-11T06:56:03Z'],
'Arn' => ['description' => 'OIDC身份提供商的ARN。', 'type' => 'string', 'example' => 'acs:ram::177242285274****:oidc-provider/TestOIDCProvider'],
'IssuerUrl' => ['description' => 'OIDC身份提供商的颁发者URL。', 'type' => 'string', 'example' => 'https://xxxxxx.example.com'],
'Fingerprints' => ['description' => 'HTTPS CA证书的验证指纹。多个之间用半角逗号(,)分隔。', 'type' => 'string', 'example' => '5938fd4d98bab03faadb97b34396831e3780****'],
'ClientIds' => ['description' => '客户端ID。多个之间用半角逗号(,)分隔。', 'type' => 'string', 'example' => '0oa4u6l8x5WoaVbd****'],
'GmtCreate' => ['description' => '创建时间(时间戳)。', 'type' => 'string', 'example' => '1636613763000'],
'GmtModified' => ['description' => '修改时间(时间戳)。', 'type' => 'string', 'example' => '1636706309000'],
'IssuanceLimitTime' => ['description' => '允许外部IdP颁发ID Token的最早签发时间。ID Token中的iat字段如果距离当前时间大于这个值则请求会被拒绝。'."\n"
.'单位:小时。取值范围:1~168。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '移除OIDC身份提供商中指定的验证指纹',
'description' => '### 使用说明'."\n"
.'本文将提供一个示例,为名为`TestOIDCProvider`的OIDC身份提供商移除验证指纹`6938fd4d98bab03faadb97b34396831e3780****`。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~187377~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveFingerprintFromOIDCProvider'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:RemoveFingerprintFromOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C90CE971-4C7F-5D93-BD3E-2D0E79D03C01\\",\\n \\"OIDCProvider\\": {\\n \\"UpdateDate\\": \\"2021-11-12T08:38:29Z\\",\\n \\"Description\\": \\"This is a new OIDC Provider.\\",\\n \\"OIDCProviderName\\": \\"TestOIDCProvider\\",\\n \\"CreateDate\\": \\"2021-11-11T06:56:03Z\\",\\n \\"Arn\\": \\"acs:ram::177242285274****:oidc-provider/TestOIDCProvider\\",\\n \\"IssuerUrl\\": \\"https://xxxxxx.example.com\\",\\n \\"Fingerprints\\": \\"5938fd4d98bab03faadb97b34396831e3780****\\",\\n \\"ClientIds\\": \\"0oa4u6l8x5WoaVbd****\\",\\n \\"GmtCreate\\": \\"1636613763000\\",\\n \\"GmtModified\\": \\"1636706309000\\",\\n \\"IssuanceLimitTime\\": 12\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n C90CE971-4C7F-5D93-BD3E-2D0E79D03C01\\n \\n 2021-11-12T08:38:29Z\\n This is a new OIDC Provider.\\n TestOIDCProvider\\n 2021-11-11T06:56:03Z\\n acs:ram::177242285274****:oidc-provider/TestOIDCProvider\\n https://dev-xxxxxx.okta.com\\n 5938fd4d98bab03faadb97b34396831e3780****\\n 0oa4u6l8x5WoaVbd****\\n 1636613763000\\n 1636706309000\\n 12\\n \\n","errorExample":""}]',
],
'RemoveUserFromGroup' => [
'summary' => '将指定RAM用户从指定用户组中移除。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram3V29VK'],
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alice@example.onaliyun.com'],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '用户组名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Test-Team'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '85836703-8D4F-485F-9726-4D1C730F957E'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '将RAM用户从用户组中移除',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUserFromGroup'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:RemoveUserFromGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/{#GroupName}'],
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"85836703-8D4F-485F-9726-4D1C730F957E\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 85836703-8D4F-485F-9726-4D1C730F957E\\r\\n","errorExample":""}]',
],
'RestoreAccessKeyFromRecycleBin' => [
'summary' => '从回收站中恢复归属于指定RAM用户的指定访问密钥。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => 'RAM用户ID。', 'type' => 'string', 'required' => false, 'example' => '20732900249392****'],
],
[
'name' => 'UserAccessKeyId',
'in' => 'query',
'schema' => ['description' => 'RAM用户的访问密钥ID。', 'type' => 'string', 'required' => false, 'example' => 'LTAI*******************'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '从回收站中恢复访问密钥',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestoreAccessKeyFromRecycleBin'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:RestoreAccessKeyFromRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\n","errorExample":""}]',
],
'RestoreUserFromRecycleBin' => [
'summary' => '从回收站中恢复指定RAM用户。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => 'RAM用户ID。', 'type' => 'string', 'required' => false, 'example' => '20732900249392****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '从回收站中恢复RAM用户',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~187377~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestoreUserFromRecycleBin'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:RestoreUserFromRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4507D1CD-526A-4E2B-A1E2-3AB045D1EE0B\\n","errorExample":""}]',
],
'SetAccessKeyPolicy' => [
'summary' => '设置阿里云账号(主账号)或RAM用户的访问密钥的网络访问限制策略。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '7486',
'abilityTreeNodes' => ['FEATUREram9EHJZG'],
'autoTest' => false,
'notSupportAutoTestReason' => '只允许控制台来源调用,非控制台来源无法调用成功',
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM 用户的登录名称。 '."\n"
."\n"
.'如果为空,默认为当前用户的指定访问密钥设置网络访问限制策略。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'UserAccessKeyId',
'in' => 'query',
'schema' => ['description' => '访问密钥 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LTAI*******************'],
],
[
'name' => 'AccessKeyPolicy',
'in' => 'query',
'schema' => ['description' => '网络访问限制策略。'."\n"
."\n"
.'JSON 格式字符串,具体参见AccessKeyPolicy结构说明。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"Status":"Inactive","Statements":[{"Value":"AllowAllVPC","Type":"VPCWhiteList","IPList":["::/0","0.0.0.0/0"]}]}'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessKeyPolicy' => ['description' => '网络访问限制策略。'."\n"
."\n"
.'JSON 格式字符串,具体参见AccessKeyPolicy结构说明。', 'type' => 'string', 'example' => '{"Status":"Inactive","Statements":[{"Value":"AllowAllVPC","Type":"VPCWhiteList","IPList":["::/0","0.0.0.0/0"]}]}'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30C9068D-FBAA-4998-9986-8A562FED0BC3'],
'AccessKeyId' => ['description' => '访问密钥ID。', 'type' => 'string', 'example' => 'LTAI*******************'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '设置指定访问密钥的网络访问限制策略',
'requestParamsDescription' => '## AccessKeyPolicy 结构说明'."\n"
.'`AccessKeyPolicy` 参数为 JSON 格式的字符串,完整结构如下:'."\n"
."\n"
.'```json'."\n"
.'{'."\n"
.' "Version": 1,'."\n"
.' "Status": "Active",'."\n"
.' "Statements": ['."\n"
.' {'."\n"
.' "Type": "ClassicWhiteList",'."\n"
.' "IPList": ["203.0.113.1", "2001:db8:85a3::8a2e:370:7334", "198.51.100.0/24"]'."\n"
.' },'."\n"
.' {'."\n"
.' "Type": "VPCWhiteList",'."\n"
.' "Value": "vpc-bp1234567890abcdef",'."\n"
.' "IPList": ["172.16.0.0/16"]'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'### 顶层字段'."\n"
.'| 字段 | 类型 | 是否必填 | 描述 |'."\n"
.'| --- | --- | --- | --- |'."\n"
.'| Version | Integer | 否 | 策略版本号,当前固定为 `1` |'."\n"
.'| Status | String | 是 | 策略状态。取值:`Active`(启用)、`Inactive`(停用) |'."\n"
.'| Statements | Array | 是 | 网络白名单规则列表,可以为空数组 `[]`,但不能为 `null` |'."\n"
."\n\n"
.'### Statement 对象'."\n"
.'每个 Statement 表示一条网络白名单规则,支持两种类型:'."\n"
."\n"
.'| 字段 | 类型 | 描述 |'."\n"
.'| --- | --- | --- |'."\n"
.'| Type | String | 规则类型。取值:`ClassicWhiteList`(经典网络白名单)、`VPCWhiteList`(VPC 网络白名单) |'."\n"
.'| Value | String | VPC 标识,仅 `VPCWhiteList` 类型时使用 |'."\n"
.'| IPList | Array | IP 地址白名单列表,支持 IPv4/IPv6 地址及 CIDR 格式 |'."\n"
."\n\n"
.'### 规则类型详解'."\n"
.'#### 1. 经典网络白名单(ClassicWhiteList)'."\n"
.'限制 AccessKey 只能从指定的公网 IP 地址发起调用。'."\n"
."\n"
.'+ **Type**:固定为 `ClassicWhiteList`'."\n"
.'+ **Value**:不可填写,留空即可'."\n"
.'+ **IPList**:必填。允许调用的 IP 地址列表,支持IPv4和IPv6地址,支持 CIDR 格式(如 `203.0.113.5/30`)'."\n"
."\n"
.'**默认行为**:若Statements中未配置任何 `ClassicWhiteList` 规则,表示**拒绝所有经典网络的访问**。'."\n"
."\n"
.'**约束**:若 IPList 中包含 IPv4 全放通地址 `0.0.0.0/0`,则必须同时包含 IPv6 全放通地址 `::/0`,反之亦然。不允许仅放通单一协议栈。'."\n"
."\n"
.'**示例**:'."\n"
."\n"
.'```json'."\n"
.'{'."\n"
.' "Type": "ClassicWhiteList",'."\n"
.' "IPList": ["203.0.113.5/30", "198.51.100.0/24"]'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'#### 2. VPC 网络白名单(VPCWhiteList)'."\n"
.'限制 AccessKey 只能从指定的 VPC 内发起调用,可进一步限制到 VPC 内的指定 IP。'."\n"
."\n"
.'+ **Type**:固定为 `VPCWhiteList`'."\n"
.'+ **Value**:必填。取值为以下之一:'."\n"
.' - 具体 VPC 实例 ID,格式为 `vpc-` 开头(如 `vpc-bp1234567890abcdef`)'."\n"
.' - `AllowAllVPC`:允许所有 VPC'."\n"
.'+ **IPList**:必填。VPC 内的 IP 地址白名单,支持 CIDR 格式(如 `10.0.0.0/24`)'."\n"
."\n"
.'**默认行为**:若Statements中未配置任何 `VPCWhiteList` 规则,则**拒绝所有 VPC 网络的访问**。'."\n"
."\n"
.'**约束**:'."\n"
."\n"
.'+ 当 Value 为 `AllowAllVPC` 时,IPList 必须同时包含 `0.0.0.0/0` 和 `::/0`(即全放通),且仅包含这两项'."\n"
.'+ 当 Value 为具体 VPC ID 时,IPList 中不允许包含 `0.0.0.0/0` 或 `::/0`'."\n"
."\n"
.'**示例 — 指定 VPC**:'."\n"
."\n"
.'```json'."\n"
.'{'."\n"
.' "Type": "VPCWhiteList",'."\n"
.' "Value": "vpc-bp1234567890abcdef",'."\n"
.' "IPList": ["172.16.0.0/16"]'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'**示例 — 允许所有 VPC**:'."\n"
."\n"
.'```json'."\n"
.'{'."\n"
.' "Type": "VPCWhiteList",'."\n"
.' "Value": "AllowAllVPC",'."\n"
.' "IPList": ["0.0.0.0/0", "::/0"]'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'### 数量限制'."\n"
.'| 限制项 | 上限 |'."\n"
.'| --- | --- |'."\n"
.'| AccessKeyPolicy 总长度 | JSON 字符串不超过 160,000 字符 |'."\n"
.'| Statements 条目数 | 最多 8 条 |'."\n"
.'| 单条 Statement 中的 IPList 条目数 | 最多 50 个 |'."\n"
."\n\n"
.'## 完整请求示例'."\n"
.'### 示例 1:仅允许特定公网 IP 调用'."\n"
.'```json'."\n"
.'{'."\n"
.' "Version": 1,'."\n"
.' "Status": "Active",'."\n"
.' "Statements": ['."\n"
.' {'."\n"
.' "Type": "ClassicWhiteList",'."\n"
.' "IPList": ["203.0.113.5/30", "198.51.100.0/24"]'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'### 示例 2:仅允许指定 VPC 内调用'."\n"
.'```json'."\n"
.'{'."\n"
.' "Version": 1,'."\n"
.' "Status": "Active",'."\n"
.' "Statements": ['."\n"
.' {'."\n"
.' "Type": "VPCWhiteList",'."\n"
.' "Value": "vpc-bp1234567890abcdef",'."\n"
.' "IPList": ["172.16.0.0/16"]'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'### 示例 3:同时配置经典网络和 VPC 网络白名单'."\n"
.'```json'."\n"
.'{'."\n"
.' "Version": 1,'."\n"
.' "Status": "Active",'."\n"
.' "Statements": ['."\n"
.' {'."\n"
.' "Type": "VPCWhiteList",'."\n"
.' "Value": "vpc-bp1234567890abcdef",'."\n"
.' "IPList": ["172.16.0.0/16"]'."\n"
.' },'."\n"
.' {'."\n"
.' "Type": "ClassicWhiteList",'."\n"
.' "IPList": ["203.0.113.0/30"]'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'### 示例 4:停用策略(保留规则但不生效)'."\n"
.'```json'."\n"
.'{'."\n"
.' "Version": 1,'."\n"
.' "Status": "Inactive",'."\n"
.' "Statements": ['."\n"
.' {'."\n"
.' "Type": "ClassicWhiteList",'."\n"
.' "IPList": ["203.0.113.5/30"]'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'### 示例 5:清空所有白名单规则'."\n"
.'```json'."\n"
.'{'."\n"
.' "Version": 1,'."\n"
.' "Status": "Inactive",'."\n"
.' "Statements": []'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:SetAccessKeyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#AccountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessKeyPolicy\\": \\"{\\\\\\"Status\\\\\\":\\\\\\"Inactive\\\\\\",\\\\\\"Statements\\\\\\":[{\\\\\\"Value\\\\\\":\\\\\\"AllowAllVPC\\\\\\",\\\\\\"Type\\\\\\":\\\\\\"VPCWhiteList\\\\\\",\\\\\\"IPList\\\\\\":[\\\\\\"::/0\\\\\\",\\\\\\"0.0.0.0/0\\\\\\"]}]}\\",\\n \\"RequestId\\": \\"30C9068D-FBAA-4998-9986-8A562FED0BC3\\",\\n \\"AccessKeyId\\": \\"LTAI*******************\\"\\n}","type":"json"}]',
],
'SetDefaultDomain' => [
'summary' => '为阿里云账号(主账号)设置默认域名。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramM70W9U'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'DefaultDomainName',
'in' => 'query',
'schema' => ['description' => '默认域名。'."\n"
."\n"
.'格式:`.onaliyun.com`。其中``为账号别名,默认值是阿里云账号ID。默认域名必须以`.onaliyun.com`后缀结尾。'."\n"
."\n"
.'默认域名(含后缀)最大长度为64个字符。可包含英文字母、数字、英文句点(.)、短划线(-)和下划线(_)。'."\n"
.'> 默认域名不能以短划线(-)开头或结尾,且不能有两个连续的短划线(-)。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'examplecompany.onaliyun.com'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DefaultDomainName' => ['description' => '默认域名。', 'type' => 'string', 'example' => 'examplecompany.onaliyun.com'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '66815255-7CCE-4759-AC37-9755794C3626'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '设置默认域名',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDefaultDomain'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:SetDefaultDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"DefaultDomainName\\": \\"examplecompany.onaliyun.com\\",\\n \\"RequestId\\": \\"66815255-7CCE-4759-AC37-9755794C3626\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\texamplecompany.onaliyun.com\\r\\n\\t66815255-7CCE-4759-AC37-9755794C3626\\r\\n\\t\\r\\n","errorExample":""}]',
],
'SetPasswordPolicy' => [
'summary' => '设置RAM用户的密码强度策略。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram47VF3L'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'MinimumPasswordLength',
'in' => 'query',
'schema' => ['description' => '最小密码长度。'."\n"
."\n"
.'取值范围:8~32。默认值:8。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8'],
],
[
'name' => 'RequireLowercaseCharacters',
'in' => 'query',
'schema' => ['description' => '密码中是否必须包含小写字母。取值:'."\n"
."\n"
.'- true'."\n"
.'- false(默认值)', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'RequireUppercaseCharacters',
'in' => 'query',
'schema' => ['description' => '密码中是否必须包含大写字母。取值:'."\n"
."\n"
.'- true'."\n"
.'- false(默认值)', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'RequireNumbers',
'in' => 'query',
'schema' => ['description' => '密码中是否必须包含数字。取值:'."\n"
."\n"
.'- true'."\n"
.'- false(默认值)', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'RequireSymbols',
'in' => 'query',
'schema' => ['description' => '密码中是否必须包含符号。取值:'."\n"
."\n"
.'- true'."\n"
.'- false(默认值)', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'HardExpire',
'in' => 'query',
'schema' => ['description' => '密码过期后是否限制登录。取值:'."\n"
."\n"
.'- true:密码过期后,不能登录控制台。需要通过主账号或具有管理员权限的RAM用户重置该RAM用户的密码后,才能正常登录。'."\n"
.'- false(默认值):密码过期后,RAM用户可以自行更改密码,然后正常登录。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'MaxLoginAttemps',
'in' => 'query',
'schema' => ['description' => '密码重试次数约束。连续输入错误密码达到设定次数后,账号将被锁定一小时。'."\n"
."\n"
.'取值范围:0~32。'."\n"
."\n"
.'默认值:0,表示不启用密码重试约束。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'PasswordReusePrevention',
'in' => 'query',
'schema' => ['description' => '历史密码检查策略。'."\n"
."\n"
.'禁止使用前N次的历史密码,N的取值范围:0~24。'."\n"
."\n"
.'默认值:0,表示不启用历史密码检查策略。 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'MaxPasswordAge',
'in' => 'query',
'schema' => ['description' => '密码有效期。'."\n"
."\n"
.'取值范围:0~1095。单位:天。'."\n"
."\n"
.'默认值:0,表示永不过期。 ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'MinimumPasswordDifferentCharacter',
'in' => 'query',
'schema' => ['description' => '密码中最少包含的不同字符数量。'."\n"
."\n"
.'取值范围:0~8。'."\n"
."\n"
.'默认值:0,表示不限制密码中的不同字符数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'PasswordNotContainUserName',
'in' => 'query',
'schema' => ['description' => '密码中是否不允许包含用户名。取值:'."\n"
."\n"
.'- true:密码中不能包含用户名。'."\n"
.'- false(默认值):密码中可以包含用户名。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'InitialPasswordAge',
'in' => 'query',
'schema' => ['title' => '初始密码有效期。', 'description' => '初始密码有效期。初始密码指新创建或重新启用控制台登录设置的密码。'."\n"
."\n"
.'取值范围:0-90。单位:天。'."\n"
."\n"
.'默认值:14。'."\n"
."\n"
.'0表示不开启初始密码有效期限制。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '14'],
],
[
'name' => 'InterceptRiskPasswordOnApi',
'in' => 'query',
'schema' => ['description' => '使用OpenAPI设置密码时,是否拦截风险密码的开关。'."\n"
."\n"
.'取值:'."\n"
.'- true:使用OpenAPI设置密码时,新密码不得为风险密码。'."\n"
.'- false:使用OpenAPI设置密码时,新密码可以为风险密码。'."\n"
."\n"
.'默认值:false', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3FB5551F-B2ED-40D4-8392-1E4AC2384EFD'],
'PasswordPolicy' => [
'description' => '密码强度策略信息。',
'type' => 'object',
'properties' => [
'RequireNumbers' => ['description' => '密码中是否必须包含数字。', 'type' => 'boolean', 'example' => 'false'],
'RequireLowercaseCharacters' => ['description' => '密码中是否必须包含小写字母。', 'type' => 'boolean', 'example' => 'false'],
'PasswordReusePrevention' => ['description' => '历史密码检查策略。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RequireSymbols' => ['description' => '密码中是否必须包含符号。', 'type' => 'boolean', 'example' => 'false'],
'PasswordNotContainUserName' => ['description' => '密码中是否不允许包含用户名。', 'type' => 'boolean', 'example' => 'false'],
'MinimumPasswordDifferentCharacter' => ['description' => '密码中最少包含的不同字符数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'MaxPasswordAge' => ['description' => '密码有效期。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'HardExpire' => ['description' => '密码过期后是否限制登录。', 'type' => 'boolean', 'example' => 'false'],
'MinimumPasswordLength' => ['description' => '最小密码长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
'RequireUppercaseCharacters' => ['description' => '密码中是否必须包含大写字母。', 'type' => 'boolean', 'example' => 'false'],
'MaxLoginAttemps' => ['description' => '密码重试次数约束。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'InitialPasswordAge' => ['title' => '初始密码有效期。', 'description' => '初始密码有效期。', 'type' => 'integer', 'format' => 'int32', 'example' => '14'],
'InterceptRiskPasswordOnApi' => ['description' => '使用OpenAPI设置密码时,是否拦截风险密码的开关。', 'type' => 'boolean', 'example' => 'false'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '设置RAM用户密码强度策略',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetPasswordPolicy'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:SetPasswordPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3FB5551F-B2ED-40D4-8392-1E4AC2384EFD\\",\\n \\"PasswordPolicy\\": {\\n \\"RequireNumbers\\": false,\\n \\"RequireLowercaseCharacters\\": false,\\n \\"PasswordReusePrevention\\": 0,\\n \\"RequireSymbols\\": false,\\n \\"PasswordNotContainUserName\\": false,\\n \\"MinimumPasswordDifferentCharacter\\": 0,\\n \\"MaxPasswordAge\\": 0,\\n \\"HardExpire\\": false,\\n \\"MinimumPasswordLength\\": 8,\\n \\"RequireUppercaseCharacters\\": false,\\n \\"MaxLoginAttemps\\": 0,\\n \\"InitialPasswordAge\\": 14,\\n \\"InterceptRiskPasswordOnApi\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t3FB5551F-B2ED-40D4-8392-1E4AC2384EFD\\r\\n\\t\\r\\n\\t\\t8\\r\\n\\t\\tfalse\\r\\n\\t\\tfalse\\r\\n\\t\\tfalse\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\t0\\r\\n\\t\\tfalse\\r\\n\\t\\tfalse\\r\\n\\t\\t0\\r\\n\\t\\tfalse\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":""}]',
],
'SetSecurityPreference' => [
'summary' => '设置RAM用户的全局安全首选项信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '7490',
'abilityTreeNodes' => ['FEATUREramPNEJCS'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'EnableSaveMFATicket',
'in' => 'query',
'schema' => ['description' => 'RAM用户使用多因素认证登录后,是否允许保存多因素认证的验证状态,其有效期为7天。取值:'."\n"
."\n"
.'- true:允许。'."\n"
.'- false(默认值):不允许。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'AllowUserToChangePassword',
'in' => 'query',
'schema' => ['description' => '是否允许RAM用户自主管理密码。取值:'."\n"
."\n"
.'- true(默认值):允许。'."\n"
.'- false:不允许。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'AllowUserToManageAccessKeys',
'in' => 'query',
'schema' => ['description' => '是否允许RAM用户自主管理访问密钥。取值:'."\n"
."\n"
.'- true:允许。'."\n"
.'- false(默认值):不允许。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'AllowUserToManageMFADevices',
'in' => 'query',
'schema' => ['description' => '是否允许RAM用户自主管理多因素认证设备。取值:'."\n"
."\n"
.'- true(默认值):允许。'."\n"
.'- false:不允许。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'LoginSessionDuration',
'in' => 'query',
'schema' => ['description' => 'RAM用户登录有效期。'."\n"
."\n"
.'取值范围:1~24。单位:小时。'."\n"
."\n"
.'默认值:6。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6'],
],
[
'name' => 'LoginNetworkMasks',
'in' => 'query',
'schema' => ['description' => '登录掩码。登录掩码决定哪些IP地址会受到登录控制台的影响,包括密码登录和单点登录(SSO),但使用访问密钥发起的API调用并不受影响。'."\n"
."\n"
.'- 如果指定掩码,RAM用户只能从指定的IP地址进行登录。'."\n"
.'- 如果不指定任何掩码,登录控制台功能将适用于整个网络。'."\n"
."\n"
.'当需要配置多个登录掩码时,请使用分号(;)来分隔,例如:192.168.0.0/16;10.0.0.0/8。'."\n"
."\n"
.'最多配置40个登录掩码,总长度最大512个字符。', 'type' => 'string', 'required' => false, 'example' => '10.0.0.0/8'],
],
[
'name' => 'VerificationTypes',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '多因素认证的手段。',
'type' => 'array',
'items' => ['description' => '多因素认证的手段。取值:'."\n"
.'- sms:安全手机。'."\n"
.'- email:安全邮箱。', 'type' => 'string', 'required' => false, 'example' => '["sms", "email"]'],
'required' => false,
],
],
[
'name' => 'AllowUserToManagePersonalDingTalk',
'in' => 'query',
'schema' => ['description' => '是否允许RAM用户自主管理个人钉钉的绑定与解绑。取值:'."\n"
."\n"
.'- true(默认值):允许。'."\n"
.'- false:不允许。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'OperationForRiskLogin',
'in' => 'query',
'schema' => ['description' => '该参数已废弃。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'autonomous'],
],
[
'name' => 'MFAOperationForLogin',
'in' => 'query',
'schema' => ['description' => '登录时必须使用MFA(取代原EnforceMFAForLogin参数,原参数仍然有效,建议更新为新参数)。取值:'."\n"
."\n"
.'- mandatory:强制所有RAM用户。原EnforceMFAForLogin对应取值为true。'."\n"
.'- independent(默认值):依赖每个RAM用户的独立配置。原EnforceMFAForLogin对应取值为false。'."\n"
.'- adaptive:仅异常登录时使用。'."\n", 'type' => 'string', 'required' => false, 'example' => 'adaptive'],
],
[
'name' => 'MaxIdleDaysForAccessKeys',
'in' => 'query',
'schema' => ['description' => 'RAM用户的访问密钥的最大闲置时间(天)配置,访问密钥连续未使用达到此时间后将在次日被自动禁用。支持设置为以下四个固定值:'."\n"
."\n"
.'- 90'."\n"
.'- 180'."\n"
.'- 365'."\n"
.'- 730(默认值)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '365'],
],
[
'name' => 'MaxIdleDaysForUsers',
'in' => 'query',
'schema' => ['description' => 'RAM用户的最大闲置时间(天)配置,开启控制台登录的RAM用户的连续未登录(不包含SSO登录)时间达到此时间后将在次日被自动禁用控制台登录。支持设置为以下四个固定值:'."\n"
."\n"
.'- 90'."\n"
.'- 180'."\n"
.'- 365'."\n"
.'- 730(默认值)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '365'],
],
[
'name' => 'AllowUserToLoginWithPasskey',
'in' => 'query',
'schema' => ['description' => '是否允许RAM用户使用通行密钥登录。取值:'."\n"
.'- true(默认值):允许。'."\n"
.'- false:不允许。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'AllowUserToManageServiceCredentials',
'in' => 'query',
'schema' => ['description' => '是否允许 RAM 用户自主管理 API Key。取值:'."\n"
."\n"
.'- true:允许。'."\n"
.'- false:不允许。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'SecurityPreference' => [
'description' => '安全首选项信息。',
'type' => 'object',
'properties' => [
'AccessKeyPreference' => [
'description' => '访问密钥首选项。',
'type' => 'object',
'properties' => [
'AllowUserToManageAccessKeys' => ['description' => '是否允许RAM用户自主管理访问密钥。', 'type' => 'boolean', 'example' => 'false'],
'AllowUserToManageServiceCredentials' => ['description' => '是否允许 RAM 用户自主管理 API Key。取值:'."\n"
."\n"
.'- true:允许。'."\n"
.'- false:不允许。', 'type' => 'boolean', 'example' => 'false'],
],
],
'LoginProfilePreference' => [
'description' => '登录首选项。',
'type' => 'object',
'properties' => [
'EnableSaveMFATicket' => ['description' => 'RAM用户使用多因素认证登录后,是否允许保存多因素认证的验证状态,其有效期为7天。', 'type' => 'boolean', 'example' => 'false'],
'LoginSessionDuration' => ['description' => 'RAM用户登录有效期。', 'type' => 'integer', 'format' => 'int32', 'example' => '6'],
'LoginNetworkMasks' => ['description' => '登录掩码。', 'type' => 'string', 'example' => '10.0.0.0/8'],
'AllowUserToChangePassword' => ['description' => '是否允许RAM用户自主管理密码。', 'type' => 'boolean', 'example' => 'true'],
'OperationForRiskLogin' => ['description' => '该参数已废弃。', 'type' => 'string', 'deprecated' => true, 'example' => 'autonomous'],
'MFAOperationForLogin' => ['description' => '登录时必须使用MFA(取代原EnforceMFAForLogin参数,原参数仍然有效,建议更新为新参数)。', 'type' => 'string', 'example' => 'adaptive'],
'AllowUserToLoginWithPasskey' => ['description' => '是否允许RAM用户使用通行密钥直接登录。', 'type' => 'boolean', 'example' => 'false'],
],
],
'MFAPreference' => [
'description' => '多因素认证首选项。',
'type' => 'object',
'properties' => [
'AllowUserToManageMFADevices' => ['description' => '是否允许RAM用户自主管理多因素认证设备。', 'type' => 'boolean', 'example' => 'false'],
],
],
'VerificationPreference' => [
'description' => '多因素认证手段的首选项。',
'type' => 'object',
'properties' => [
'VerificationTypes' => [
'description' => '多因素认证的手段。',
'type' => 'array',
'items' => ['description' => '多因素认证的手段。', 'type' => 'string', 'example' => '["sms", "email"]'],
],
],
],
'PersonalInfoPreference' => [
'description' => '个人信息首选项。',
'type' => 'object',
'properties' => [
'AllowUserToManagePersonalDingTalk' => ['description' => '是否允许RAM用户自主管理个人钉钉的绑定与解绑。', 'type' => 'boolean', 'example' => 'true'],
],
],
'MaxIdleDays' => [
'description' => '最大闲置时间配置(天)。',
'type' => 'object',
'properties' => [
'MaxIdleDaysForUsers' => ['description' => 'RAM用户的最大闲置时间(天)配置,开启控制台登录的RAM用户的连续未登录(不包含SSO登录)达到此时间后将在次日被自动禁用控制台登录。'."\n"
."\n"
.'默认值:730天。', 'type' => 'integer', 'format' => 'int32', 'example' => '730'],
'MaxIdleDaysForAccessKeys' => ['description' => 'RAM用户的访问密钥的最大闲置时间(天)配置,访问密钥连续未使用达到此时间后将在次日被自动禁用。'."\n"
."\n"
.'默认值:730天。', 'type' => 'integer', 'format' => 'int32', 'example' => '730'],
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '17494710-B4BA-4185-BBBB-C1A6ABDE1639'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SecurityPreference\\": {\\n \\"AccessKeyPreference\\": {\\n \\"AllowUserToManageAccessKeys\\": false,\\n \\"AllowUserToManageServiceCredentials\\": false\\n },\\n \\"LoginProfilePreference\\": {\\n \\"EnableSaveMFATicket\\": false,\\n \\"LoginSessionDuration\\": 6,\\n \\"LoginNetworkMasks\\": \\"10.0.0.0/8\\",\\n \\"AllowUserToChangePassword\\": true,\\n \\"OperationForRiskLogin\\": \\"autonomous\\",\\n \\"MFAOperationForLogin\\": \\"adaptive\\",\\n \\"AllowUserToLoginWithPasskey\\": false\\n },\\n \\"MFAPreference\\": {\\n \\"AllowUserToManageMFADevices\\": false\\n },\\n \\"VerificationPreference\\": {\\n \\"VerificationTypes\\": [\\n \\"[\\\\\\"sms\\\\\\", \\\\\\"email\\\\\\"]\\"\\n ]\\n },\\n \\"PersonalInfoPreference\\": {\\n \\"AllowUserToManagePersonalDingTalk\\": true\\n },\\n \\"MaxIdleDays\\": {\\n \\"MaxIdleDaysForUsers\\": 730,\\n \\"MaxIdleDaysForAccessKeys\\": 730\\n }\\n },\\n \\"RequestId\\": \\"17494710-B4BA-4185-BBBB-C1A6ABDE1639\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n false\\n \\n \\n false\\n 6\\n 10.0.0.0/8\\n true\\n autonomous\\n adaptive\\n \\n \\n false\\n \\n \\n [\\"sms\\", \\"email\\"]\\n \\n \\n true\\n \\n \\n 17494710-B4BA-4185-BBBB-C1A6ABDE1639\\n","errorExample":""}]',
'title' => '设置RAM用户的全局安全首选项',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetSecurityPreference'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:SetSecurityPreference',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:MFAOperationForLogin'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'SetUserSsoSettings' => [
'summary' => '设置用户SSO的身份提供商信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '7491',
'abilityTreeNodes' => ['FEATUREramY87YVY'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'MetadataDocument',
'in' => 'query',
'schema' => ['description' => '元数据文档。经过Base64编码。'."\n"
."\n"
.'由支持SAML2.0协议的身份提供商提供。', 'type' => 'string', 'required' => false, 'example' => 'PD94bWwgdmVy****'],
],
[
'name' => 'SsoEnabled',
'in' => 'query',
'schema' => ['description' => '是否开启RAM用户的SSO功能。取值:'."\n"
."\n"
.'- true:开启。'."\n"
.'- false(默认值):关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'AuxiliaryDomain',
'in' => 'query',
'schema' => ['description' => '辅助域名。', 'type' => 'string', 'required' => false, 'example' => 'example.com'],
],
[
'name' => 'SsoLoginWithDomain',
'in' => 'query',
'schema' => ['description' => '当用户使用SAML SSO登录时,是否要求SAML Response的``元素内容中包含域名(即在IdP侧指定的用于SSO登录匹配的用户名是否带有域名后缀)。'."\n"
."\n"
.'- 该参数取值为`true`时,``元素内容**必须**形如`username@domain`(即带有域名后缀),其中`domain`可以是默认的域名,也可以是域别名(若已设置)。'."\n"
.'- 该参数取值为`false`时,``元素内容应当**仅有**`username`部分(即不带有域名后缀),**不得带有**`domain`部分。'."\n"
."\n"
.'该参数默认取值为`true`。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'AuthnSignAlgo',
'in' => 'query',
'schema' => ['description' => '阿里云SP支持的签名算法。取值:'."\n"
."\n"
.'- rsa-sha256'."\n"
.'- rsa-sha1(默认值)', 'type' => 'string', 'required' => false, 'example' => 'rsa-sha1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'UserSsoSettings' => [
'description' => '用户SSO配置信息。',
'type' => 'object',
'properties' => [
'AuxiliaryDomain' => ['description' => '辅助域名。', 'type' => 'string', 'example' => 'example.com'],
'MetadataDocument' => ['description' => '元数据文档。经过Base64编码。', 'type' => 'string', 'example' => 'PD94bWwgdmVy****'],
'SsoEnabled' => ['description' => '是否开启用户SSO。', 'type' => 'boolean', 'example' => 'true'],
'SsoLoginWithDomain' => ['description' => '当用户使用SAML SSO登录时,是否要求SAML Response的``元素内容中包含域名(即在IdP侧指定的用于SSO登录匹配的用户名是否带有域名后缀)。'."\n"
."\n"
.'- 该参数取值为`true`时,``元素内容**必须**形如`username@domain`(即带有域名后缀),其中`domain`可以是默认的域名,也可以是域别名(若已设置)。'."\n"
.'- 该参数取值为`false`时,``元素内容应当**仅有**`username`部分(即不带有域名后缀),**不得带有**`domain`部分。'."\n"
."\n"
.'该参数默认取值为`true`。', 'type' => 'boolean', 'example' => 'true'],
'AuthnSignAlgo' => ['description' => '阿里云SP支持的签名算法。取值:'."\n"
."\n"
.'- rsa-sha256'."\n"
.'- rsa-sha1(默认值)', 'type' => 'string', 'example' => 'rsa-sha1'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '87F2E3F6-28A0-43F3-A77F-F7760E62F61E'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '设置用户SSO身份提供商信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUserSsoSettings'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:SetUserSsoSettings',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"UserSsoSettings\\": {\\n \\"AuxiliaryDomain\\": \\"example.com\\",\\n \\"MetadataDocument\\": \\"PD94bWwgdmVy****\\",\\n \\"SsoEnabled\\": true,\\n \\"SsoLoginWithDomain\\": true,\\n \\"AuthnSignAlgo\\": \\"rsa-sha1\\"\\n },\\n \\"RequestId\\": \\"87F2E3F6-28A0-43F3-A77F-F7760E62F61E\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\tPD94bWwgdmVy****\\r\\n\\t\\ttrue\\r\\n\\t\\texample.com\\r\\n\\t\\r\\n\\t87F2E3F6-28A0-43F3-A77F-F7760E62F61E\\r\\n\\t\\r\\n","errorExample":""}]',
],
'SetVerificationInfo' => [
'summary' => '为RAM用户绑定安全手机或安全邮箱。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram8R8C7X'],
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'VerifyType',
'in' => 'query',
'schema' => ['description' => '多因素认证手段。取值:'."\n"
."\n"
.'- sms:安全手机。'."\n"
.'- email:安全邮箱。', 'type' => 'string', 'required' => false, 'example' => 'sms'],
],
[
'name' => 'MobilePhone',
'in' => 'query',
'schema' => ['description' => '手机号码。'."\n"
."\n"
.'> 当`VerifyType`值为`sms`时,该字段必须设置。', 'type' => 'string', 'required' => false, 'example' => '86-13900001234'],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => ['description' => '邮箱地址。'."\n"
."\n"
.'> 当`VerifyType`值为`email`时,该字段必须设置。', 'type' => 'string', 'required' => false, 'example' => 'username@example.com'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'B182C041-8C64-5F2F-A07B-FC67FAF89CF9'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '为RAM用户绑定安全手机或安全邮箱',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetVerificationInfo'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:SetVerificationInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B182C041-8C64-5F2F-A07B-FC67FAF89CF9\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B182C041-8C64-5F2F-A07B-FC67FAF89CF9\\n","errorExample":""}]',
],
'TagResources' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramVRK65Q'],
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['title' => '资源类型', 'description' => '资源类型。取值:'."\n"
."\n"
.'- user:RAM用户。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'user'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '资源ID,最多50个子项',
'description' => '资源ID。'."\n"
."\n"
.'N的取值范围为:1~50。'."\n"
.'当资源类型为user时,资源ID为RAM用户ID。'."\n"
.'>必须指定 `ResourceId`、`ResourcePrincipalName`两个参数中的一个参数,但不能同时指定。',
'type' => 'array',
'items' => ['description' => '资源ID。'."\n"
."\n"
.'N的取值范围为:1~50。'."\n"
.'当资源类型为user时,资源ID为RAM用户ID。'."\n"
.'>必须指定 `ResourceId`、`ResourcePrincipalName`两个参数中的一个参数,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => '20732900249392****'],
'required' => false,
'maxItems' => 51,
],
],
[
'name' => 'ResourcePrincipalName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '资源名,最多50个子项',
'description' => '资源名称。'."\n"
."\n"
.'N的取值范围为:1~50。'."\n"
.'当资源类型为user时,资源名称为RAM用户名。'."\n"
.'>必须指定 `ResourceId`、`ResourcePrincipalName`两个参数中的一个参数,但不能同时指定。',
'type' => 'array',
'items' => ['description' => '资源名称。'."\n"
."\n"
.'N的取值范围为:1~50。'."\n"
.'当资源类型为user时,资源名称为RAM用户名。'."\n"
.'>必须指定 `ResourceId`、`ResourcePrincipalName`两个参数中的一个参数,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
'required' => false,
'example' => 'TagResources',
'maxItems' => 51,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标签列表,最多包含20个子项',
'description' => '资源的标签键。'."\n"
."\n"
.'N的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以aliyun和acs:开头,不能包含`http://`或者`https://`。',
'type' => 'array',
'items' => [
'description' => '资源的标签键。'."\n"
."\n"
.'N的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以aliyun和acs:开头,不能包含`http://`或者`https://`。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '标签键', 'description' => '资源的标签键。'."\n"
."\n"
.'N的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。'."\n", 'type' => 'string', 'required' => false, 'example' => 'operator'],
'Value' => ['title' => '标签值', 'description' => '资源的标签值。'."\n"
."\n"
.'N的取值范围:1~20。可以为空字符串。最多支持128个字符,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
'required' => false,
],
'required' => false,
'docRequired' => true,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3687BD52-49FD-585B-AB14-CD05B7C76963'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '资源打上标签',
'summary' => '调用TagResources接口给资源打上标签。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~187377~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:TagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3687BD52-49FD-585B-AB14-CD05B7C76963\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 3687BD52-49FD-585B-AB14-CD05B7C76963\\n","errorExample":""}]',
],
'UnbindMFADevice' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '7492',
'abilityTreeNodes' => ['FEATUREramCFN0GB'],
'autoTest' => false,
'notSupportAutoTestReason' => '无法通过测试平台自动生成MFA Code,所以无法构建绑定了MFA的用户用于测试',
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test@example.onaliyun.com'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MFADevice' => [
'description' => '多因素认证设备信息。',
'type' => 'object',
'properties' => [
'SerialNumber' => ['description' => '设备序列号。', 'type' => 'string', 'example' => 'acs:ram::151298381312****:mfa/device001'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A26CB3E9-1021-452A-AC57-3134B3BA0E4C'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '为RAM用户解绑多因素认证设备',
'summary' => '为RAM用户解绑定多因素认证设备。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindMFADevice'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UnbindMFADevice',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"MFADevice\\": {\\n \\"SerialNumber\\": \\"acs:ram::151298381312****:mfa/device001\\"\\n },\\n \\"RequestId\\": \\"A26CB3E9-1021-452A-AC57-3134B3BA0E4C\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\tacs:ram::151298381312****:mfa/device001\\r\\n\\t\\r\\n\\tA26CB3E9-1021-452A-AC57-3134B3BA0E4C\\r\\n\\r\\n","errorExample":""}]',
],
'UnbindVerification' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram8R8C7X'],
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'VerifyType',
'in' => 'query',
'schema' => ['description' => '多因素认证手段。取值:'."\n"
."\n"
.'- sms:安全手机。'."\n"
.'- email:安全邮箱。', 'type' => 'string', 'required' => false, 'example' => 'sms'],
],
[
'name' => 'MobilePhone',
'in' => 'query',
'schema' => ['description' => '手机号码。'."\n"
."\n"
.'> 当`VerifyType`值为`sms`时,该字段必须设置。', 'type' => 'string', 'required' => false, 'example' => '86-13900001234'],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => ['description' => '邮箱地址。'."\n"
."\n"
.'> 当`VerifyType`值为`email`时,该字段必须设置。', 'type' => 'string', 'required' => false, 'example' => 'username@example.com'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'B182C041-8C64-5F2F-A07B-FC67FAF89CF9'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '为RAM用户解绑安全手机或安全邮箱',
'summary' => '为RAM用户解绑安全手机或安全邮箱。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindVerification'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UnbindVerification',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B182C041-8C64-5F2F-A07B-FC67FAF89CF9\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B182C041-8C64-5F2F-A07B-FC67FAF89CF9\\n","errorExample":""}]',
],
'UntagResources' => [
'summary' => '调用UntagResources接口解绑资源的标签。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramVRK65Q'],
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['title' => '资源类型', 'description' => '资源类型。取值:'."\n"
."\n"
.'- user:RAM用户。'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'user'],
],
[
'name' => 'All',
'in' => 'query',
'schema' => ['title' => '是否全部删除,只针对TagKey.N为空时有效。 取值范围: true false True False 默认是 false', 'description' => '是否解绑资源上全部的标签。取值:'."\n"
.'- true:解绑全部标签。'."\n"
.'- false(默认值):不解绑全部标签。'."\n"
."\n"
.'> 当请求中未设置TagKey时,该参数才有效。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ResourcePrincipalName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '资源名,最多50个子项',
'description' => '资源名称。'."\n"
."\n"
.'N的取值范围为:1~50。 当资源类型为user时,资源名称为RAM用户名。'."\n"
.'> 必须指定 ResourceId、ResourcePrincipalName两个参数中的一个参数,但不能同时指定。',
'type' => 'array',
'items' => ['description' => '资源名称。'."\n"
."\n"
.'N的取值范围为:1~50。 当资源类型为user时,资源名称为RAM用户名。'."\n"
.'> 必须指定 ResourceId、ResourcePrincipalName两个参数中的一个参数,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
'required' => false,
'docRequired' => true,
'maxItems' => 51,
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '资源ID,最多 50个子项',
'description' => '资源ID。'."\n"
."\n"
.'N的取值范围为:1~50。 当资源类型为user时,资源ID为RAM用户ID。'."\n"
."\n"
.'> 必须指定 ResourceId、ResourcePrincipalName两个参数中的一个参数,但不能同时指定。',
'type' => 'array',
'items' => ['description' => '资源ID。'."\n"
."\n"
.'N的取值范围为:1~50。 当资源类型为user时,资源ID为RAM用户ID。'."\n"
."\n"
.'> 必须指定 ResourceId、ResourcePrincipalName两个参数中的一个参数,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => '20732900249392****'],
'required' => false,
'docRequired' => true,
'example' => 'UntagResources',
'maxItems' => 51,
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标签键,最多20个子项',
'description' => '资源的标签键。'."\n"
."\n"
.'N的取值范围:1~20,N必须连续。',
'type' => 'array',
'items' => ['description' => '资源的标签键。'."\n"
."\n"
.'N的取值范围:1~20,N必须连续。', 'type' => 'string', 'required' => false, 'example' => 'operator'],
'required' => false,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6AC79B74-9A78-58E2-818B-1D38EDC64D67'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '解绑资源的标签',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~187377~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UntagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6AC79B74-9A78-58E2-818B-1D38EDC64D67\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 6AC79B74-9A78-58E2-818B-1D38EDC64D67\\n","errorExample":""}]',
],
'UpdateAccessKey' => [
'summary' => '修改阿里云账号(主账号)或RAM用户的访问密钥状态。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREramXHGI9T'],
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。'."\n"
."\n"
.'如果为空,默认修改当前用户的访问密钥。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'UserAccessKeyId',
'in' => 'query',
'schema' => ['description' => '需要修改状态的访问密钥ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LTAI*******************'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '访问密钥的状态。取值:'."\n"
."\n"
.'- Active:已激活。'."\n"
.'- Inactive:已禁用。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Active'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B9AF80E4-1565-42D9-9256-0B8B0D9FD3EC'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改访问密钥状态',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAccessKey'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateAccessKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B9AF80E4-1565-42D9-9256-0B8B0D9FD3EC\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n B9AF80E4-1565-42D9-9256-0B8B0D9FD3EC\\r\\n","errorExample":""}]',
],
'UpdateApplication' => [
'summary' => '修改指定应用的配置信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
'schema' => ['description' => '应用ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '472457090344041****'],
],
[
'name' => 'NewDisplayName',
'in' => 'query',
'schema' => ['description' => '显示名称。', 'type' => 'string', 'required' => false, 'example' => 'NewApp'],
],
[
'name' => 'NewRedirectUris',
'in' => 'query',
'schema' => ['description' => '回调地址。'."\n"
."\n"
.'输入多个时,以英文分号(;)分隔。', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com'],
],
[
'name' => 'NewPredefinedScopes',
'in' => 'query',
'schema' => ['description' => '应用权限范围。'."\n"
."\n"
.'关于应用权限范围的取值和描述,请参见[OAuth范围](~~93693~~)。您也可以调用[ListPredefinedScopes](~~187206~~)获取不同应用类型支持的应用权限范围。'."\n"
."\n"
.'输入多个应用权限范围时,以英文分号(;)分隔。'."\n"
."\n"
.'新的应用权限范围会覆盖原来的应用权限范围。例如:如果原来的应用权限范围是`/acs/ccc`,新设置的应用权限范围为`/acs/alidns`,则最终生效的应用权限范围为`/acs/alidns`。如果您想在原有范围基础上新增`/acs/alidns`,请将新的应用权限范围设置为`/acs/ccc;/acs/alidns`。', 'type' => 'string', 'required' => false, 'example' => 'openid'],
],
[
'name' => 'NewRequiredScopes',
'in' => 'query',
'schema' => ['description' => '必选的应用权限范围。'."\n"
."\n"
.'您可以将`RequiredScopes`中设置的一个或多个范围设为必选,设为必选后,当用户进行应用授权时,必选范围默认选中且不可取消。'."\n"
."\n"
.'如果您同时传入了`NewPredefinedScopes`,则会先通过`NewPredefinedScopes`重新设置应用的范围列表,再通过本参数进行范围是否必选的设置。'."\n"
."\n"
.'输入多个应用权限范围时,以英文分号(;)分隔。'."\n"
."\n"
.'新的必选范围会覆盖原来的必选范围。'."\n"
."\n"
.'> 如果您设置的`RequiredScopes`项不在`PredefinedScopes`的范围内,则该项必选范围不生效。', 'type' => 'string', 'required' => false, 'example' => 'profile;aliuid'],
],
[
'name' => 'NewSecretRequired',
'in' => 'query',
'schema' => ['description' => '是否需要应用密钥。取值:'."\n"
."\n"
.'- true'."\n"
.'- false'."\n"
."\n"
.'> - 对于WebApp和ServerApp类型的应用,该值会被强制设置为true,不支持修改。'."\n"
.'- 对于NativeApp类型的应用,可以设置为true或false,如不设置,默认为false。由于此类应用往往运行在非可信环境,无法有效保护应用密钥,因此建议您如无明确需要,不要设置为true。更多信息,请参见[Native应用登录阿里云](~~93697~~)。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'NewAccessTokenValidity',
'in' => 'query',
'schema' => ['description' => '访问令牌有效期。'."\n"
."\n"
.'取值范围:900~10800。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600'],
],
[
'name' => 'NewRefreshTokenValidity',
'in' => 'query',
'schema' => ['description' => '刷新令牌有效期。'."\n"
."\n"
.'取值范围:7200~31536000。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7776000'],
],
[
'name' => 'NewIsMultiTenant',
'in' => 'query',
'schema' => ['description' => '是否允许被其他账号安装。取值:'."\n"
."\n"
.'- true:允许。'."\n"
."\n"
.'- false:不允许。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6616F09B-2768-4C11-8866-A8EE4C4A583E'],
'Application' => [
'description' => '应用信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '应用的显示名称。', 'type' => 'string', 'example' => 'NewApp'],
'AccessTokenValidity' => ['description' => '访问令牌有效期。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '3600'],
'SecretRequired' => ['description' => '是否需要应用密钥。', 'type' => 'boolean', 'example' => 'true'],
'AccountId' => ['description' => '应用所属的阿里云账号ID。', 'type' => 'string', 'example' => '177242285274****'],
'CreateDate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-10-23T08:06:57Z'],
'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'myapp'],
'RedirectUris' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RedirectUri' => [
'description' => '回调地址。',
'type' => 'array',
'items' => ['description' => '回调地址。', 'type' => 'string', 'example' => 'https://www.example.com'],
],
],
'description' => '',
],
'UpdateDate' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-10-23T08:06:57Z'],
'DelegatedScope' => [
'description' => '应用权限范围信息。',
'type' => 'object',
'properties' => [
'PredefinedScopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PredefinedScope' => [
'description' => '应用权限范围信息。',
'type' => 'array',
'items' => [
'description' => '应用权限范围信息。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '范围描述。', 'type' => 'string', 'example' => 'Obtain the OpenID of the user. This is the default permission that you cannot remove.'],
'Name' => ['description' => '范围名称。', 'type' => 'string', 'example' => 'openid'],
'Required' => ['description' => '安装应用时,此权限范围是否默认必选。取值:'."\n"
."\n"
.'- true:必选。'."\n"
.'- false:非必选。'."\n"
."\n"
.'其中`openid`默认为必选。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'description' => '',
],
],
],
'AppId' => ['description' => '应用ID。', 'type' => 'string', 'example' => '472457090344041****'],
'RefreshTokenValidity' => ['description' => '刷新令牌有效期。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '7776000'],
'IsMultiTenant' => ['description' => '是否允许被其他账号安装。', 'type' => 'boolean', 'example' => 'true'],
'AppType' => ['description' => '应用类型。', 'type' => 'string', 'example' => 'WebApp'],
'ProtocolVersion' => ['description' => '应用的OAuth协议版本。取值:'."\n"
.'+ `2.0`:表示为OAuth 2.0协议。'."\n"
.'+ `2.1`:表示为OAuth 2.1协议。', 'type' => 'string', 'example' => '2.0'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改应用的配置信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApplication'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6616F09B-2768-4C11-8866-A8EE4C4A583E\\",\\n \\"Application\\": {\\n \\"DisplayName\\": \\"NewApp\\",\\n \\"AccessTokenValidity\\": 3600,\\n \\"SecretRequired\\": true,\\n \\"AccountId\\": \\"177242285274****\\",\\n \\"CreateDate\\": \\"2020-10-23T08:06:57Z\\",\\n \\"AppName\\": \\"myapp\\",\\n \\"RedirectUris\\": {\\n \\"RedirectUri\\": [\\n \\"https://www.example.com\\"\\n ]\\n },\\n \\"UpdateDate\\": \\"2020-10-23T08:06:57Z\\",\\n \\"DelegatedScope\\": {\\n \\"PredefinedScopes\\": {\\n \\"PredefinedScope\\": [\\n {\\n \\"Description\\": \\"Obtain the OpenID of the user. This is the default permission that you cannot remove.\\",\\n \\"Name\\": \\"openid\\",\\n \\"Required\\": true\\n }\\n ]\\n }\\n },\\n \\"AppId\\": \\"472457090344041****\\",\\n \\"RefreshTokenValidity\\": 7776000,\\n \\"IsMultiTenant\\": true,\\n \\"AppType\\": \\"WebApp\\",\\n \\"ProtocolVersion\\": \\"2.0\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\tA4AE08F4-36FB-4274-BE4A-6BCAF7F15E85\\r\\n\\t\\r\\n\\t\\t177242285274****\\r\\n\\t\\ttrue\\r\\n\\t\\ttrue\\r\\n\\t\\t2020-10-23T08:06:57Z\\r\\n\\t\\tmyapp\\r\\n\\t\\t2020-11-02T07:02:06Z\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t用于获取用户的OpenID(默认权限范围,不可移除)\\r\\n\\t\\t\\t\\t\\topenid\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t472457090344041****\\r\\n\\t\\tNewApp\\r\\n\\t\\t3600\\r\\n\\t\\t\\r\\n\\t\\t\\thttps://www.example.com\\r\\n\\t\\t\\r\\n\\t\\t7776000\\r\\n\\t\\tWebApp\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
],
'UpdateGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram3V29VK'],
],
'parameters' => [
[
'name' => 'NewComments',
'in' => 'query',
'schema' => ['description' => '新的备注。'."\n"
."\n"
.'最大长度128个字符。', 'type' => 'string', 'required' => false, 'example' => '测试团队'],
],
[
'name' => 'NewDisplayName',
'in' => 'query',
'schema' => ['description' => '新的用户组显示名称。'."\n"
."\n"
.'最大长度24个字符。', 'type' => 'string', 'required' => false, 'example' => 'Test-Team'],
],
[
'name' => 'NewGroupName',
'in' => 'query',
'schema' => ['description' => '新的用户组名称。'."\n"
."\n"
.'最大长度64个字符,可包含英文字母、数字、英文句点(.)、下划线(_)和短划线(-)。', 'type' => 'string', 'required' => false, 'example' => 'Test-Team'],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '用户组名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Dev-Team'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Group' => [
'description' => '用户组信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '用户组显示名称。', 'type' => 'string', 'example' => 'Test-Team'],
'GroupId' => ['description' => '用户组ID。', 'type' => 'string', 'example' => '740317625433843****'],
'UpdateDate' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-10-20T03:44:27Z'],
'GroupName' => ['description' => '用户组名称。', 'type' => 'string', 'example' => 'Test-Team'],
'Comments' => ['description' => '备注。', 'type' => 'string', 'example' => '测试团队'],
'CreateDate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-10-19T16:15:17Z'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CDA656E3-3CE9-4A03-A8A3-B42A0C3C3287'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改指定用户组的信息',
'summary' => '修改指定用户组的基础信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroup'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/{#GroupName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Group\\": {\\n \\"DisplayName\\": \\"Test-Team\\",\\n \\"GroupId\\": \\"740317625433843****\\",\\n \\"UpdateDate\\": \\"2020-10-20T03:44:27Z\\",\\n \\"GroupName\\": \\"Test-Team\\",\\n \\"Comments\\": \\"测试团队\\",\\n \\"CreateDate\\": \\"2020-10-19T16:15:17Z\\"\\n },\\n \\"RequestId\\": \\"CDA656E3-3CE9-4A03-A8A3-B42A0C3C3287\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\tTest-Team\\r\\n\\t\\t2020-10-20T03:44:27Z\\r\\n\\t\\t测试团队\\r\\n 740317625433843****\\r\\n\\t\\tTest-Team\\r\\n\\t\\t2020-10-19T16:15:17Z\\r\\n\\t\\r\\n\\tCDA656E3-3CE9-4A03-A8A3-B42A0C3C3287\\r\\n\\t\\r\\n","errorExample":""}]',
],
'UpdateLoginProfile' => [
'summary' => '修改指定RAM用户的控制台登录信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '7497',
'abilityTreeNodes' => ['FEATUREramFSAEMQ'],
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => '指定RAM用户的登录名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => 'RAM用户的控制台登录新密码。'."\n"
."\n"
.'密码必须符合密码强度要求。', 'type' => 'string', 'required' => false, 'example' => 'mypassword'],
],
[
'name' => 'PasswordResetRequired',
'in' => 'query',
'schema' => ['description' => 'RAM用户在下次登录时是否必须重置密码。取值:'."\n"
."\n"
.'- true'."\n"
.'- false', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'MFABindRequired',
'in' => 'query',
'schema' => ['description' => '是否强制要求RAM用户开启多因素认证。取值:'."\n"
."\n"
.'- true:要求开启。RAM用户在下次登录时必须绑定多因素认证设备。'."\n"
.'- false:不要求开启。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '开启或禁用控制台密码登录。取值:'."\n"
."\n"
.'- Active:开启。'."\n"
.'- Inactive:禁用。', 'type' => 'string', 'required' => false, 'example' => 'Active'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BCDB6A7F-2199-41D9-B577-4FA536A5ADE1'],
'LoginProfile' => [
'description' => '控制台登录信息。',
'type' => 'object',
'properties' => [
'UserPrincipalName' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'example' => 'test@example11.onaliyun.com'],
'Status' => ['description' => '开启或禁用控制台密码登录。', 'type' => 'string', 'example' => 'Active'],
'UpdateDate' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-10-14T07:48:41Z'],
'PasswordResetRequired' => ['description' => 'RAM用户在下次登录时是否必须重置密码。', 'type' => 'boolean', 'example' => 'false'],
'MFABindRequired' => ['description' => '是否强制要求用户开启多因素认证。', 'type' => 'boolean', 'example' => 'false'],
'AutoDisableLoginStatus' => ['description' => '在满足闲置禁用条件后是否自动禁用控制台登录。默认开启,不可关闭。', 'type' => 'string', 'example' => 'true'],
'PasswordStatus' => ['description' => '初始密码的状态。初始密码指新创建或重新启用控制台登录设置的密码。'."\n"
."\n"
.'取值'."\n"
.'- "NotInitial":非初始密码。'."\n"
.'- "InitialValid":初始密码有效。'."\n"
.'- "InitialExpired":初始密码已过期。', 'type' => 'string', 'example' => 'NotInitial'],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改RAM用户的控制台登录信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLoginProfile'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateLoginProfile',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BCDB6A7F-2199-41D9-B577-4FA536A5ADE1\\",\\n \\"LoginProfile\\": {\\n \\"UserPrincipalName\\": \\"test@example11.onaliyun.com\\",\\n \\"Status\\": \\"Active\\",\\n \\"UpdateDate\\": \\"2020-10-14T07:48:41Z\\",\\n \\"PasswordResetRequired\\": false,\\n \\"MFABindRequired\\": false,\\n \\"AutoDisableLoginStatus\\": \\"true\\",\\n \\"PasswordStatus\\": \\"NotInitial\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\tBCDB6A7F-2199-41D9-B577-4FA536A5ADE1\\r\\n\\t\\r\\n\\t\\tActive\\r\\n\\t\\t2020-10-14T07:48:41Z\\r\\n\\t\\tfalse\\r\\n\\t\\ttest@example11.onaliyun.com\\r\\n\\t\\tfalse\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
],
'UpdateOIDCProvider' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'OIDCProviderName',
'in' => 'query',
'schema' => ['description' => 'OIDC身份提供商的名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'TestOIDCProvider'],
],
[
'name' => 'ClientIds',
'in' => 'query',
'schema' => ['description' => '客户端ID。多个之间用半角逗号(,)分隔。'."\n"
."\n"
.'格式:允许英文字母、数字、特殊字符`.-_:/`,不能以特殊字符`.-_:/`开头。'."\n"
."\n"
.'长度:单个客户端ID最大128个字符。'."\n"
."\n"
.'> 如果指定该参数,会将OIDC身份提供商的客户端ID全部替换。如果您只想新增或删除其中一个客户端ID,请使用AddClientIdToOIDCProvider或RemoveClientIdFromOIDCProvider。更多信息,请参见[AddClientIdToOIDCProvider](~~332057~~)或[RemoveClientIdFromOIDCProvider](~~332058~~)。', 'type' => 'string', 'required' => false, 'example' => '498469743454717****'],
],
[
'name' => 'NewDescription',
'in' => 'query',
'schema' => ['description' => 'OIDC身份提供商的描述。'."\n"
."\n"
.'长度:最大256个字符。', 'type' => 'string', 'required' => false, 'example' => 'This is a new OIDC Provider.'],
],
[
'name' => 'IssuanceLimitTime',
'in' => 'query',
'schema' => ['description' => '允许外部IdP颁发ID Token的最早签发时间。ID Token中的iat字段如果距离当前时间大于这个值则请求会被拒绝。'."\n"
.'单位:小时。取值范围:1~168。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '6'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E4C4D1BD-2558-5BD1-8C26-A5D7FB174A55'],
'OIDCProvider' => [
'description' => 'OIDC身份提供商信息。',
'type' => 'object',
'properties' => [
'UpdateDate' => ['description' => '修改时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-12T08:38:29Z'],
'Description' => ['description' => 'OIDC身份提供商的描述。', 'type' => 'string', 'example' => 'This is a new OIDC Provider.'],
'OIDCProviderName' => ['description' => 'OIDC身份提供商的名称。', 'type' => 'string', 'example' => 'TestOIDCProvider'],
'CreateDate' => ['description' => '创建时间(UTC时间)。', 'type' => 'string', 'example' => '2021-11-11T06:56:03Z'],
'Arn' => ['description' => 'OIDC身份提供商的ARN。', 'type' => 'string', 'example' => 'acs:ram::177242285274****:oidc-provider/TestOIDCProvider'],
'IssuerUrl' => ['description' => '颁发者URL。', 'type' => 'string', 'example' => 'https://xxxxxx.example.com'],
'Fingerprints' => ['description' => 'HTTPS CA证书的验证指纹。多个之间用半角逗号(,)分隔。', 'type' => 'string', 'example' => '902ef2deeb3c5b13ea4c3d5193629309e231****'],
'ClientIds' => ['description' => '客户端ID。多个之间用半角逗号(,)分隔。', 'type' => 'string', 'example' => '498469743454717****'],
'GmtCreate' => ['description' => '创建时间(时间戳)。', 'type' => 'string', 'example' => '1636613763000'],
'GmtModified' => ['description' => '修改时间(时间戳)。', 'type' => 'string', 'example' => '1636706309000'],
'IssuanceLimitTime' => ['description' => '允许外部IdP颁发ID Token的最早签发时间。ID Token中的iat字段如果距离当前时间大于这个值则请求会被拒绝。'."\n"
.'单位:小时。取值范围:1~168。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '修改OIDC身份提供商',
'summary' => '调用UpdateOIDCProvider修改OIDC身份提供商的描述和客户端ID。',
'description' => '### 使用说明'."\n"
.'本文将提供一个示例,将名为`TestOIDCProvider`的OIDC身份提供商的描述修改为`This is a new OIDC Provider.`。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~187377~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOIDCProvider'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4C4D1BD-2558-5BD1-8C26-A5D7FB174A55\\",\\n \\"OIDCProvider\\": {\\n \\"UpdateDate\\": \\"2021-11-12T08:38:29Z\\",\\n \\"Description\\": \\"This is a new OIDC Provider.\\",\\n \\"OIDCProviderName\\": \\"TestOIDCProvider\\",\\n \\"CreateDate\\": \\"2021-11-11T06:56:03Z\\",\\n \\"Arn\\": \\"acs:ram::177242285274****:oidc-provider/TestOIDCProvider\\",\\n \\"IssuerUrl\\": \\"https://xxxxxx.example.com\\",\\n \\"Fingerprints\\": \\"902ef2deeb3c5b13ea4c3d5193629309e231****\\",\\n \\"ClientIds\\": \\"498469743454717****\\",\\n \\"GmtCreate\\": \\"1636613763000\\",\\n \\"GmtModified\\": \\"1636706309000\\",\\n \\"IssuanceLimitTime\\": 6\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n E4C4D1BD-2558-5BD1-8C26-A5D7FB174A55\\n \\n 2021-11-12T08:38:29Z\\n This is a new OIDC Provider.\\n TestOIDCProvider\\n 2021-11-11T06:56:03Z\\n acs:ram::177242285274****:oidc-provider/TestOIDCProvider\\n https://dev-xxxxxx.okta.com\\n 902ef2deeb3c5b13ea4c3d5193629309e231****\\n 498469743454717****\\n 1636613763000\\n 1636706309000\\n 12\\n \\n","errorExample":""}]',
],
'UpdatePasskey' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '254333',
'abilityTreeNodes' => ['FEATUREramCFN0GB'],
'autoTest' => false,
'notSupportAutoTestReason' => '因为创建passkey需要通过控制台页面,没有openAPI,因此无法创建用来更新的passkey',
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'PasskeyId',
'in' => 'query',
'schema' => ['description' => '通行密钥的ID。', 'type' => 'string', 'required' => false, 'example' => 'PASSKEY-CuZjEHhWcr7GIQOMGvkS'],
],
[
'name' => 'PasskeyName',
'in' => 'query',
'schema' => ['description' => '通行密钥的名称。', 'type' => 'string', 'required' => false, 'example' => 'device1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '85836703-8D4F-485F-9726-4D1C730F957E'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新通行密钥',
'summary' => '更新通行密钥。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'ram:UpdatePasskey',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"85836703-8D4F-485F-9726-4D1C730F957E\\"\\n}","type":"json"}]',
],
'UpdateSAMLProvider' => [
'summary' => '修改指定的角色SSO身份提供商信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram7YYMOK'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SAMLProviderName',
'in' => 'query',
'schema' => ['description' => '需要修改的身份提供商名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-provider'],
],
[
'name' => 'NewDescription',
'in' => 'query',
'schema' => ['description' => '新的备注。'."\n"
."\n"
.'> `NewDescription`与`NewEncodedSAMLMetadataDocument`参数必须至少填写一个。', 'type' => 'string', 'required' => false, 'example' => 'This is a new provider.'],
],
[
'name' => 'NewEncodedSAMLMetadataDocument',
'in' => 'query',
'schema' => ['description' => '新的元数据文档。'."\n"
.'> `NewDescription`与`NewEncodedSAMLMetadataDocument`参数必须至少填写一个。', 'type' => 'string', 'required' => false, 'example' => 'PD94bWwgdmVy****'],
],
[
'name' => 'AuthnSignAlgo',
'in' => 'query',
'schema' => ['description' => '阿里云SP支持的签名算法。取值:'."\n"
."\n"
.'- rsa-sha256'."\n"
.'- rsa-sha1', 'type' => 'string', 'required' => false, 'example' => 'rsa-sha1'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E5EDDFD2-3654-4F9F-9780-4AE7D81823EF'],
'SAMLProvider' => [
'description' => '身份提供商信息。',
'type' => 'object',
'properties' => [
'UpdateDate' => ['description' => '身份提供商的修改时间(UTC时间)。', 'type' => 'string', 'example' => '2020-10-22T02:51:20Z'],
'Description' => ['description' => '备注。', 'type' => 'string', 'example' => 'This is a new provider.'],
'SAMLProviderName' => ['description' => '身份提供商名称。', 'type' => 'string', 'example' => 'test-provider'],
'CreateDate' => ['description' => '身份提供商的创建时间(UTC时间)。', 'type' => 'string', 'example' => '2020-10-22T02:37:05Z'],
'Arn' => ['description' => '身份提供商ARN。', 'type' => 'string', 'example' => 'acs:ram::177242285274****:saml-provider/test-provider'],
'AuthnSignAlgo' => ['description' => '阿里云SP支持的签名算法。取值:'."\n"
."\n"
.'- rsa-sha256'."\n"
.'- rsa-sha1', 'type' => 'string', 'example' => 'rsa-sha1'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '修改角色SSO身份提供商信息',
'description' => '本文将提供一个示例,为`test-provider`身份提供商修改备注信息为`This is a new provider.`。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSAMLProvider'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateSAMLProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'SAMLProvider', 'arn' => 'acs:ram::{#accountId}:saml-provider/{#SAMLProviderName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E5EDDFD2-3654-4F9F-9780-4AE7D81823EF\\",\\n \\"SAMLProvider\\": {\\n \\"UpdateDate\\": \\"2020-10-22T02:51:20Z\\",\\n \\"Description\\": \\"This is a new provider.\\",\\n \\"SAMLProviderName\\": \\"test-provider\\",\\n \\"CreateDate\\": \\"2020-10-22T02:37:05Z\\",\\n \\"Arn\\": \\"acs:ram::177242285274****:saml-provider/test-provider\\",\\n \\"AuthnSignAlgo\\": \\"rsa-sha1\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n E5EDDFD2-3654-4F9F-9780-4AE7D81823EF\\r\\n \\r\\n 2020-10-22T02:51:20Z\\r\\n test-provider\\r\\n This is a new provider.\\r\\n acs:ram::177242285274****:saml-provider/test-provider\\r\\n 2020-10-22T02:37:05Z\\r\\n \\r\\n","errorExample":""}]',
],
'UpdateServiceCredential' => [
'summary' => '修改RAM用户的服务凭证的状态或名称。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ServiceCredentialId',
'in' => 'query',
'schema' => ['title' => '服务凭证ID', 'description' => '服务凭证ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SC****************'],
],
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['title' => 'RAM用户登录名称。'."\n"
.'不指定表示修改当前调用身份下的服务凭证。', 'description' => 'RAM用户登录名称。'."\n"
.'不指定表示修改当前调用身份下的服务凭证。', 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['title' => '服务凭证状态。'."\n"
.'取值范围:Active / Inactive.'."\n"
.'Status和ServiceCredentialName至少指定一个。', 'description' => '服务凭证状态。'."\n"
.'取值范围:Active / Inactive.'."\n"
.'Status和ServiceCredentialName至少指定一个。', 'type' => 'string', 'required' => false, 'example' => 'Active'],
],
[
'name' => 'ServiceCredentialName',
'in' => 'query',
'schema' => ['title' => '服务凭证名称。'."\n"
.'长度为1~128个字符,可包含英文字母、数字、半角句号(.)、短划线(-)和下划线(_)。'."\n"
.'Status和ServiceCredentialName至少指定一个。', 'description' => '服务凭证名称。'."\n"
.'长度为1~128个字符,可包含英文字母、数字、半角句号(.)、短划线(-)和下划线(_)。'."\n"
.'Status和ServiceCredentialName至少指定一个。', 'type' => 'string', 'required' => false, 'example' => 'yourServiceCredentialName'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '53C8FBFD-F2E9-50F2-AD63-B6566B3D4D7B'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改服务凭证的状态或名称',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateServiceCredential',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:ServiceCredentialServiceName', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"53C8FBFD-F2E9-50F2-AD63-B6566B3D4D7B\\"\\n}","type":"json"}]',
],
'UpdateUser' => [
'summary' => '调用UpdateUser修改RAM用户信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREram8R8C7X'],
],
'parameters' => [
[
'name' => 'UserPrincipalName',
'in' => 'query',
'schema' => ['description' => '指定的RAM用户登录名称。'."\n"
."\n"
.'> `UserPrincipalName`与`UserId`参数,必须指定一个,但不能同时指定。'."\n", 'type' => 'string', 'required' => false, 'example' => 'test@example.onaliyun.com'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '指定的RAM用户ID。'."\n"
.'> `UserPrincipalName`与`UserId`参数,必须指定一个,但不能同时指定。', 'type' => 'string', 'required' => false, 'example' => '20732900249392****'],
],
[
'name' => 'NewUserPrincipalName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的新登录名称。'."\n"
."\n"
.'格式为`@.onaliyun.com`,其中``为RAM用户名称,`.onaliyun.com`为默认域名。'."\n"
."\n"
.'`UserPrincipalName`长度为`1~128`个字符,可包含英文字母、数字、半角句号(.)、短划线(-)和下划线(_)。其中``的长度为`1~64`个字符。', 'type' => 'string', 'required' => false, 'example' => 'new@example.onaliyun.com'],
],
[
'name' => 'NewDisplayName',
'in' => 'query',
'schema' => ['description' => 'RAM用户的新显示名称。'."\n"
."\n"
.'长度为1~24个字符。', 'type' => 'string', 'required' => false, 'example' => 'new'],
],
[
'name' => 'NewMobilePhone',
'in' => 'query',
'schema' => ['description' => 'RAM用户的新手机号码。'."\n"
."\n"
.'格式:国际区号-号码。'."\n"
."\n"
.'> 该参数仅适用于中国站。', 'type' => 'string', 'required' => false, 'example' => '86-1868888****'],
],
[
'name' => 'NewEmail',
'in' => 'query',
'schema' => ['description' => 'RAM用户的新电子邮箱。'."\n"
."\n"
.'> 该参数仅适用于中国站。', 'type' => 'string', 'required' => false, 'example' => 'alice@example.com'],
],
[
'name' => 'NewComments',
'in' => 'query',
'schema' => ['description' => '新备注。'."\n"
."\n"
.'长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'This is a cloud computing engineer.'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'User' => [
'description' => 'RAM用户信息。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => 'RAM用户的显示名称。', 'type' => 'string', 'example' => 'new'],
'UserPrincipalName' => ['description' => 'RAM用户的登录名称。', 'type' => 'string', 'example' => 'new@example.onaliyun.com'],
'Email' => ['description' => 'RAM用户的电子邮箱。'."\n"
."\n"
.'> 该参数仅适用于中国站。', 'type' => 'string', 'example' => 'alice@example.com'],
'UpdateDate' => ['description' => 'RAM用户的更新时间。', 'type' => 'string', 'example' => '2020-10-13T09:19:49Z'],
'MobilePhone' => ['description' => 'RAM用户的手机号码。'."\n"
."\n"
.'> 该参数仅适用于中国站。'."\n", 'type' => 'string', 'example' => '86-1868888****'],
'UserId' => ['description' => 'RAM用户ID。', 'type' => 'string', 'example' => '20732900249392****'],
'Comments' => ['description' => '备注。', 'type' => 'string', 'example' => 'This is a cloud computing engineer.'],
'LastLoginDate' => ['description' => 'RAM用户最近一次登录控制台的时间。', 'type' => 'string', 'example' => '2020-10-12T09:12:00Z'],
'CreateDate' => ['description' => 'RAM用户的创建时间。', 'type' => 'string', 'example' => '2020-10-12T09:12:00Z'],
'ProvisionType' => ['description' => '同步类型。取值:'."\n"
.'- Manual:在RAM中手动创建的RAM用户。'."\n"
.'- SCIM:通过SCIM协议同步创建的RAM用户。'."\n"
.'- CloudSSO:通过云SSO同步创建的用户。', 'type' => 'string', 'example' => 'Manual'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1B56DD42-6962-4F89-A19C-079EED1F0FE3'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改RAM用户信息',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUser'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"User\\": {\\n \\"DisplayName\\": \\"new\\",\\n \\"UserPrincipalName\\": \\"new@example.onaliyun.com\\",\\n \\"Email\\": \\"alice@example.com\\",\\n \\"UpdateDate\\": \\"2020-10-13T09:19:49Z\\",\\n \\"MobilePhone\\": \\"86-1868888****\\",\\n \\"UserId\\": \\"20732900249392****\\",\\n \\"Comments\\": \\"This is a cloud computing engineer.\\",\\n \\"LastLoginDate\\": \\"2020-10-12T09:12:00Z\\",\\n \\"CreateDate\\": \\"2020-10-12T09:12:00Z\\",\\n \\"ProvisionType\\": \\"Manual\\"\\n },\\n \\"RequestId\\": \\"1B56DD42-6962-4F89-A19C-079EED1F0FE3\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\t2020-10-13T09:19:49Z\\r\\n\\t\\talice@example.com\\r\\n\\t\\tThis is a cloud computing engineer.\\r\\n\\t\\t20732900249392****\\r\\n\\t\\t2020-10-12T09:12:00Z\\r\\n\\t\\tnew\\r\\n\\t\\tnew@example.onaliyun.com\\r\\n\\t\\t2020-10-12T09:12:00Z\\r\\n\\t\\t86-1868888****\\r\\n\\t\\r\\n\\t1B56DD42-6962-4F89-A19C-079EED1F0FE3\\r\\n\\t\\r\\n","errorExample":""}]',
],
],
'endpoints' => [
['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ims.aliyuncs.com', 'endpoint' => 'ims.aliyuncs.com', 'vpc' => 'ims.vpc-proxy.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'AuthorizationFail.AkProxy', 'message' => 'AkProxy is not allowed to invoke this Action.', 'http_code' => 401, 'description' => '此方法不允许使用此AkProxy调用。'],
['code' => 'CheckAuthenticationCodeFail', 'message' => 'The authentication code is incorrect.', 'http_code' => 403, 'description' => '验证码错误。'],
['code' => 'DeleteConflict.Group.User', 'message' => 'The group CAN NOT contain any member before deleting.', 'http_code' => 409, 'description' => '删除用户组前,必须从用户组中移除所有RAM用户。'],
['code' => 'DeleteConflict.User.AccessKey', 'message' => 'The user SHOULD NOT have any Access Key before deleting.', 'http_code' => 409, 'description' => '删除RAM用户前,必须删除用户的访问密钥。'],
['code' => 'DeleteConflict.User.Group', 'message' => 'The user SHOULD NOT be in any group before deleting.', 'http_code' => 409, 'description' => '删除RAM用户前,必须将其从用户组中移除。'],
['code' => 'DeleteConflict.User.LoginProfile', 'message' => 'The user SHOULD NOT have any Login Profile before deleting.', 'http_code' => 409, 'description' => '删除RAM用户前,必须关闭用户的控制台登录功能。'],
['code' => 'DeleteConflict.User.MFADevice', 'message' => 'The user SHOULD NOT have any MFA device before deleting.', 'http_code' => 409, 'description' => '删除RAM用户前,必须解绑用户的MFA设备。'],
['code' => 'DeleteConflict.User.Policy', 'message' => 'The user SHOULD NOT have any attached policy before deleting.', 'http_code' => 409, 'description' => '删除RAM用户前,该用户不能关联任何的权限策略。'],
['code' => 'DeleteConflict.VirtualMFADevice.User', 'message' => 'The virtual mfa device CAN NOT be bound to any user while being deleted.', 'http_code' => 409, 'description' => '虚拟MFA设备正在使用,请先解除虚拟MFA设备与RAM用户之间的绑定。'],
['code' => 'EntityAlreadyExists.Application', 'message' => 'The application name does already EXIST.', 'http_code' => 409, 'description' => '同名应用已存在。'],
['code' => 'EntityAlreadyExists.Domain', 'message' => 'The domain does already EXIST.', 'http_code' => 409, 'description' => '域名已存在。'],
['code' => 'EntityAlreadyExists.Group', 'message' => 'The group does already EXIST.', 'http_code' => 409, 'description' => '用户组已存在。'],
['code' => 'EntityAlreadyExists.SAMLProvider', 'message' => 'The SAMLProvider does already EXIST.', 'http_code' => 409, 'description' => '身份提供商已存在。'],
['code' => 'EntityAlreadyExists.User', 'message' => 'The user does already EXIST.', 'http_code' => 409, 'description' => '该RAM用户已存在。'],
['code' => 'EntityAlreadyExists.User.Group', 'message' => 'The user has already joined the group.', 'http_code' => 409, 'description' => 'RAM用户已加入该用户组。'],
['code' => 'EntityAlreadyExists.User.LoginProfile', 'message' => 'The user login profile does already EXIST.', 'http_code' => 409, 'description' => 'RAM用户的控制台登录配置已存在。'],
['code' => 'EntityAlreadyExists.User.MFADevice', 'message' => 'The user has already bound a MFA device.', 'http_code' => 409, 'description' => 'RAM用户已绑定了虚拟MFA设备。'],
['code' => 'EntityAlreadyExists.VirtualMFADevice', 'message' => 'The virtual MFA device does already EXIST.', 'http_code' => 409, 'description' => '虚拟MFA设备已存在。'],
['code' => 'EntityAlreadyExists.VirtualMFADevice.User', 'message' => 'The virtual MFA device does already been bound to a user.', 'http_code' => 409, 'description' => '虚拟MFA设备已被绑定。'],
['code' => 'EntityNotExist.Application', 'message' => 'The application does not EXIST.', 'http_code' => 404, 'description' => '应用不存在。'],
['code' => 'EntityNotExist.ApplicationProvisionInfo', 'message' => 'The application is not provisioned.', 'http_code' => 404, 'description' => '应用未被安装。'],
['code' => 'EntityNotExist.AppSecret', 'message' => 'The AppSecret does not EXIST.', 'http_code' => 404, 'description' => '应用密钥不存在。'],
['code' => 'EntityNotExist.CredentialReport', 'message' => 'The credential report has not been generated.', 'http_code' => 404, 'description' => '用户凭证报告不存在。'],
['code' => 'EntityNotExist.Group', 'message' => 'The group does not EXIST.', 'http_code' => 404, 'description' => '用户组不存在。'],
['code' => 'EntityNotExist.PredefinedScope', 'message' => 'The specified PredefinedScope does not EXIST.', 'http_code' => 404, 'description' => 'PredefinedScope不存在。'],
['code' => 'EntityNotExist.Report', 'message' => 'The security report does not exist. This happens only to new accounts that created within 24 hours.', 'http_code' => 404, 'description' => '安全报告不存在,阿里云账号创建24小时后才会生成该报告。'],
['code' => 'EntityNotExist.SAMLProvider', 'message' => 'The SAML provider does not EXIST.', 'http_code' => 404, 'description' => '身份提供商不存在。'],
['code' => 'EntityNotExist.User', 'message' => 'The user does not EXIST.', 'http_code' => 404, 'description' => 'RAM用户不存在。'],
['code' => 'EntityNotExist.User.AccessKey', 'message' => 'The users Access Key does not EXIST.', 'http_code' => 404, 'description' => 'RAM用户的访问密钥不存在。'],
['code' => 'EntityNotExist.User.LoginProfile', 'message' => 'The users login profile does not EXIST.', 'http_code' => 404, 'description' => 'RAM用户的控制台登录配置不存在。'],
['code' => 'EntityNotExist.User.MFADevice', 'message' => 'The user has not bound any MFA device.', 'http_code' => 404, 'description' => 'RAM用户未绑定虚拟MFA设备。'],
['code' => 'EntityNotExist.VirtualMFADevice', 'message' => 'The virtual MFA device does not EXIST.', 'http_code' => 404, 'description' => '虚拟MFA设备不存在。'],
['code' => 'Expired.CredentialReport', 'message' => 'The credential report has been expired.', 'http_code' => 410, 'description' => '用户凭证报告已过期。'],
['code' => 'Ims:InvalidParameter.HttpsUrl', 'message' => 'Invalid oidc issuer endpoint.', 'http_code' => 400, 'description' => 'IssuerUrl无效。'],
['code' => 'Inactive', 'message' => 'Account is inactive to IMS Service.', 'http_code' => 400, 'description' => '账号未开通IMS服务。'],
['code' => 'InternalServerException', 'message' => 'Internal service error.', 'http_code' => 500, 'description' => '服务端内部错误。'],
['code' => 'InvalidParameter', 'message' => 'invalid parameter.', 'http_code' => 400, 'description' => '参数无效。'],
['code' => 'InvalidParameter.AccessKeyPolicy.Format', 'message' => 'The format of the parameter - AccessKeyPolicy is incorrect.', 'http_code' => 400, 'description' => 'AccessKeyPolicy格式错误。'],
['code' => 'InvalidParameter.Account', 'message' => 'This API can be only invoked by RAM user.', 'http_code' => 400, 'description' => '该API只支持RAM用户访问。'],
['code' => 'InvalidParameter.AppId.Format', 'message' => 'The format of the parameter - AppId is incorrect.', 'http_code' => 400, 'description' => 'AppId格式错误。'],
['code' => 'InvalidParameter.AppName.Format', 'message' => 'The format of the parameter - AppName is incorrect.', 'http_code' => 400, 'description' => 'AppName格式错误。'],
['code' => 'InvalidParameter.AppName.Length', 'message' => 'The parameter - AppName beyond the length limit.', 'http_code' => 400, 'description' => 'AppName长度超过限制。'],
['code' => 'InvalidParameter.AppType', 'message' => 'The parameter - AppType is invalid.', 'http_code' => 400, 'description' => 'AppType无效。'],
['code' => 'InvalidParameter.AuthenticationCode.Format', 'message' => 'The parameter - AuthenticationCode MUST be 6 digit number.', 'http_code' => 400, 'description' => 'AuthenticationCode必须是6位数字。'],
['code' => 'InvalidParameter.AuxiliaryDomain', 'message' => 'The parameter - AuxiliaryDomain is reserved or banned.', 'http_code' => 400, 'description' => 'AuxiliaryDomain无效,可能是保留域名或已被禁用。'],
['code' => 'InvalidParameter.AuxiliaryDomain.Format', 'message' => 'The format of the parameter - AuxiliaryDomain is incorrect.', 'http_code' => 400, 'description' => 'AuxiliaryDomain格式错误。'],
['code' => 'InvalidParameter.AuxiliaryDomain.Length', 'message' => 'The parameter - AuxiliaryDomain beyond the length limit.', 'http_code' => 400, 'description' => 'AuxiliaryDomain长度超过限制。'],
['code' => 'InvalidParameter.ClientIds', 'message' => 'The parameter - ClientIds is invalid.', 'http_code' => 400, 'description' => 'ClientIds参数无效。'],
['code' => 'InvalidParameter.Comments.InvalidChars', 'message' => 'The parameter - Comments contains invalid chars.', 'http_code' => 400, 'description' => 'Comments中包含特殊字符。'],
['code' => 'InvalidParameter.Comments.Length', 'message' => 'The parameter - Comments beyond the length limit.', 'http_code' => 400, 'description' => 'Comments长度超过限制。'],
['code' => 'InvalidParameter.DefaultDomainName', 'message' => 'The parameter - DefaultDomainName is invalid.', 'http_code' => 400, 'description' => 'DefaultDomainName参数无效。'],
['code' => 'InvalidParameter.DefaultDomainName.Format', 'message' => 'The format of the parameter - DefaultDomainName is incorrect.', 'http_code' => 400, 'description' => 'DefaultDomainName格式错误。'],
['code' => 'InvalidParameter.DefaultDomainName.InvalidChars', 'message' => 'The parameter - DefaultDomainName contains invalid chars.', 'http_code' => 400, 'description' => 'DefaultDomainName中包含了非法字符。'],
['code' => 'InvalidParameter.DefaultDomainName.Length', 'message' => 'The parameter - DefaultDomainName beyond the length limit.', 'http_code' => 400, 'description' => 'DefaultDomainName长度超过了限制。'],
['code' => 'InvalidParameter.Description.Length', 'message' => 'The parameter - Description beyond the length limit.', 'http_code' => 400, 'description' => 'Description长度超过了限制。'],
['code' => 'InvalidParameter.DisplayName.Format', 'message' => 'The format of the parameter - DisplayName is incorrect.', 'http_code' => 400, 'description' => 'DisplayName格式错误。'],
['code' => 'InvalidParameter.DisplayName.InvalidChars', 'message' => 'The parameter - DisplayName contains invalid chars.', 'http_code' => 400, 'description' => 'DisplayName包含非法字符。'],
['code' => 'InvalidParameter.DisplayName.Length', 'message' => 'The parameter - DisplayName beyond the length limit.', 'http_code' => 400, 'description' => 'DisplayName长度超过限制。'],
['code' => 'InvalidParameter.Email.Format', 'message' => 'The format of the parameter - Email is incorrect.', 'http_code' => 400, 'description' => 'Email格式错误。'],
['code' => 'InvalidParameter.EncodedSAMLMetadataDocument.Format', 'message' => 'The format of the parameter - EncodedSAMLMetadataDocument is incorrect.', 'http_code' => 400, 'description' => 'EncodedSAMLMetadataDocument格式错误。'],
['code' => 'InvalidParameter.EncodedSAMLMetadataDocument.Length', 'message' => 'The parameter - EncodedSAMLMetadataDocument beyond the length limit.', 'http_code' => 400, 'description' => 'EncodedSAMLMetadataDocument长度超过限制。'],
['code' => 'InvalidParameter.Group.Conflict', 'message' => 'One of GroupName GroupPrincipalName must be null', 'http_code' => 400, 'description' => 'GroupName或GroupPrincipalName只能提供一个。'],
['code' => 'InvalidParameter.GroupName.Format', 'message' => 'The format of the parameter - GroupName is incorrect.', 'http_code' => 400, 'description' => 'GroupName格式错误。'],
['code' => 'InvalidParameter.GroupName.Length', 'message' => 'The parameter - GroupName beyond the length limit.', 'http_code' => 400, 'description' => 'GroupName长度超过限制。'],
['code' => 'InvalidParameter.HttpsUrl', 'message' => 'Url is not valid https url.', 'http_code' => 400, 'description' => 'IssuerUrl是无效的HTTPS URL。'],
['code' => 'InvalidParameter.LoginNetworkMasks.Format', 'message' => 'The format of the parameter - LoginNetworkMasks is incorrect.', 'http_code' => 400, 'description' => 'LoginNetworkMasks格式错误。'],
['code' => 'InvalidParameter.LoginNetworkMasks.Length', 'message' => 'The parameter - LoginNetworkMasks beyond the length limit.', 'http_code' => 400, 'description' => 'LoginNetworkMasks长度超过限制。'],
['code' => 'InvalidParameter.LoginNetworkMasks.Size', 'message' => 'The parameter - LoginNetworkMasks beyond the size limit.', 'http_code' => 400, 'description' => 'LoginNetworkMasks数量超过限制。'],
['code' => 'InvalidParameter.LoginSessionDuration', 'message' => 'The parameter - LoginSessionDuration beyond the value limit.', 'http_code' => 400, 'description' => 'LoginSessionDuration取值超过限制。'],
['code' => 'InvalidParameter.Marker', 'message' => 'The parameter - Marker is invalid.', 'http_code' => 400, 'description' => 'Marker无效。'],
['code' => 'InvalidParameter.MaxItems', 'message' => 'MaxItems must greater than 0 and less than 100.', 'http_code' => 400, 'description' => 'MaxItems范围为0~100。'],
['code' => 'InvalidParameter.MaxLoginAttemps', 'message' => 'The parameter - MaxLoginAttemps is invalid.', 'http_code' => 400, 'description' => 'MaxLoginAttemps无效。'],
['code' => 'InvalidParameter.MaxPasswordAge', 'message' => 'The parameter - MaxPasswordAge is invalid.', 'http_code' => 400, 'description' => 'MaxPasswordAge无效。'],
['code' => 'InvalidParameter.MetadataDocument.Format', 'message' => 'The format of the parameter - MetadataDocument is incorrect.', 'http_code' => 400, 'description' => '元数据文档格式错误。'],
['code' => 'InvalidParameter.MetadataDocument.Length', 'message' => 'The parameter - MetadataDocument beyond the length limit.', 'http_code' => 400, 'description' => '参数MetadataDocument的长度超出限制。'],
['code' => 'InvalidParameter.MinimumPasswordDifferentCharacter.Range', 'message' => 'The parameter - MinimumPasswordDifferentCharacter MUST be in the range of 0 and 8.', 'http_code' => 400, 'description' => 'MinimumPasswordDifferentCharacter范围为0~8。'],
['code' => 'InvalidParameter.MinimumPasswordLength.Range', 'message' => 'The parameter - MinimumPasswordLength MUST be in the range of 8 and 32.', 'http_code' => 400, 'description' => 'MinimumPasswordLength范围为8~32。'],
['code' => 'InvalidParameter.MobilePhone.Format', 'message' => 'The format of the parameter - MobilePhone is incorrect.', 'http_code' => 400, 'description' => 'MobilePhone格式错误。'],
['code' => 'InvalidParameter.NewComments.Length', 'message' => 'The parameter - NewComments beyond the length limit.', 'http_code' => 400, 'description' => 'NewComments长度超过限制。'],
['code' => 'InvalidParameter.NewDescription.Length', 'message' => 'The parameter - NewDescription beyond the length limit.', 'http_code' => 400, 'description' => 'NewDescription长度超过限制。'],
['code' => 'InvalidParameter.NewDisplayName.Format', 'message' => 'The format of the parameter - NewDisplayName is incorrect.', 'http_code' => 400, 'description' => 'NewDisplayName格式错误。'],
['code' => 'InvalidParameter.NewDisplayName.InvalidChars', 'message' => 'The parameter - NewDisplayName contains invalid chars.', 'http_code' => 400, 'description' => 'NewDisplayName中包含了非法字符。'],
['code' => 'InvalidParameter.NewDisplayName.Length', 'message' => 'The parameter - NewDisplayName beyond the length limit.', 'http_code' => 400, 'description' => 'NewDisplayName长度超过限制。'],
['code' => 'InvalidParameter.NewEmail.Format', 'message' => 'The format of the parameter - NewEmail is incorrect.', 'http_code' => 400, 'description' => 'NewEmail格式错误。'],
['code' => 'InvalidParameter.NewEncodedSAMLMetadataDocument.Format', 'message' => 'The format of the parameter - NewEncodedSAMLMetadataDocument is incorrect.', 'http_code' => 400, 'description' => 'NewEncodedSAMLMetadataDocument格式错误。'],
['code' => 'InvalidParameter.NewEncodedSAMLMetadataDocument.Length', 'message' => 'The parameter - NewEncodedSAMLMetadataDocument beyond the length limit.', 'http_code' => 400, 'description' => 'NewEncodedSAMLMetadataDocument长度超过限制。'],
['code' => 'InvalidParameter.NewGroupName.Format', 'message' => 'The format of the parameter - NewGroupName is incorrect.', 'http_code' => 400, 'description' => 'NewGroupName格式错误。'],
['code' => 'InvalidParameter.NewGroupName.Length', 'message' => 'The parameter - NewGroupName beyond the length limit.', 'http_code' => 400, 'description' => 'NewGroupName长度超过限制。'],
['code' => 'InvalidParameter.NewMobilePhone.Format', 'message' => 'The format of the parameter - NewMobilePhone is incorrect.', 'http_code' => 400, 'description' => 'NewMobilePhone格式错误。'],
['code' => 'InvalidParameter.NewPredefinedScopes', 'message' => 'The parameter - NewPredefinedScopes should only choose one style./ The parameter - NewPredefinedScopes is invalid.', 'http_code' => 400, 'description' => 'NewPredefinedScopes无效。'],
['code' => 'InvalidParameter.NewRedirectUris', 'message' => 'Invalid parameter NewRedirectUris: URL must have authority (host name).', 'http_code' => 400, 'description' => 'NewRedirectUris的URI必须包含域名。'],
['code' => 'InvalidParameter.NewRedirectUris', 'message' => 'Invalid parameter NewRedirectUris: Unknown URL protocol.', 'http_code' => 400, 'description' => 'NewRedirectUris的URI协议不支持。(如果应用类型是WebApp,URI协议必须是HTTP或者HTTPS)'],
['code' => 'InvalidParameter.NewRedirectUris', 'message' => 'Invalid parameter NewRedirectUris: URI must not contain fragment.', 'http_code' => 400, 'description' => 'NewRedirectUris的URI不能包含Fragment。'],
['code' => 'InvalidParameter.NewRedirectUris', 'message' => 'Invalid parameter NewRedirectUris: URI must not contain user info.', 'http_code' => 400, 'description' => 'NewRedirectUris的URI不能包含用户信息。'],
['code' => 'InvalidParameter.NewRedirectUris', 'message' => 'Invalid parameter NewRedirectUris: URI must be non-opaque.', 'http_code' => 400, 'description' => 'NewRedirectUris的URI不能是Opaque URI。'],
['code' => 'InvalidParameter.NewRedirectUris', 'message' => 'Invalid parameter NewRedirectUris: URI must be absolute.', 'http_code' => 400, 'description' => 'NewRedirectUris的URI必须是绝对路径。'],
['code' => 'InvalidParameter.NewRedirectUris', 'message' => 'Invalid parameter NewRedirectUris: Malformed URI.', 'http_code' => 400, 'description' => 'NewRedirectUris的URI格式错误。'],
['code' => 'InvalidParameter.NewSAMLMetadataDocument.Format', 'message' => 'The format of the parameter - NewSAMLMetadataDocument is incorrect.', 'http_code' => 400, 'description' => 'NewSAMLMetadataDocument格式错误。'],
['code' => 'InvalidParameter.NewSAMLMetadataDocument.Length', 'message' => 'The parameter - NewSAMLMetadataDocument beyond the length limit.', 'http_code' => 400, 'description' => 'NewSAMLMetadataDocument超过限制。'],
['code' => 'InvalidParameter.NewUserPrincipalName.Format', 'message' => 'The format of the parameter - NewUserPrincipalName is incorrect.', 'http_code' => 400, 'description' => 'NewUserPrincipalName格式错误。'],
['code' => 'InvalidParameter.NewUserPrincipalName.Length', 'message' => 'The parameter - NewUserPrincipalName beyond the length limit.', 'http_code' => 400, 'description' => 'NewUserPrincipalName长度超过限制。'],
['code' => 'InvalidParameter.NextToken', 'message' => 'The parameter - NextToken is invalid.', 'http_code' => 400, 'description' => '参数NextToken无效。'],
['code' => 'InvalidParameter.OIDCDiscovery.Unreachable', 'message' => 'Unreachable OIDC discovery.', 'http_code' => 400, 'description' => '颁发者URL不可达。'],
['code' => 'InvalidParameter.OIDCProviderName', 'message' => 'The parameter - OIDCProviderName is invalid.', 'http_code' => 400, 'description' => '参数OIDCProviderName无效。'],
['code' => 'InvalidParameter.Password.ReUse', 'message' => 'Password reuse prevention exceeded.', 'http_code' => 400, 'description' => '您输入的密码已被历史使用过,请使用其他密码。'],
['code' => 'InvalidParameter.Password.TooWeak', 'message' => 'The specified password is not compliant with the password policy.', 'http_code' => 400, 'description' => '密码不符合密码强度要求。'],
['code' => 'InvalidParameter.PasswordReusePrevention', 'message' => 'The parameter - PasswordReusePrevention is invalid.', 'http_code' => 400, 'description' => 'PasswordReusePrevention无效。'],
['code' => 'InvalidParameter.PredefinedScopes', 'message' => 'The parameter - PredefinedScopes is invalid.', 'http_code' => 400, 'description' => 'PredefinedScopes无效。'],
['code' => 'InvalidParameter.RedirectUris', 'message' => 'Invalid parameter RedirectUris: URL must have authority (host name).', 'http_code' => 400, 'description' => 'RedirectUris的URI必须包含域名。'],
['code' => 'InvalidParameter.RedirectUris', 'message' => 'Invalid parameter RedirectUris: Unknown URL protocol.', 'http_code' => 400, 'description' => 'RedirectUris的URI协议不支持。(如果应用类型是WebApp,URI协议必须是HTTP或者HTTPS)'],
['code' => 'InvalidParameter.RedirectUris', 'message' => 'Invalid parameter RedirectUris: URI must not contain fragment.', 'http_code' => 400, 'description' => 'RedirectUris的URI不能包含Fragment。'],
['code' => 'InvalidParameter.RedirectUris', 'message' => 'Invalid parameter RedirectUris: URI must not contain user info.', 'http_code' => 400, 'description' => 'RedirectUris的URI不能包含用户信息。'],
['code' => 'InvalidParameter.RedirectUris', 'message' => 'Invalid parameter RedirectUris: URI must be non-opaque.', 'http_code' => 400, 'description' => 'RedirectUris的URI不能是Opaque URI。'],
['code' => 'InvalidParameter.RedirectUris', 'message' => 'Invalid parameter RedirectUris: URI must be absolute.', 'http_code' => 400, 'description' => 'RedirectUris的URI必须是绝对路径。'],
['code' => 'InvalidParameter.RedirectUris', 'message' => 'Invalid parameter RedirectUris: Malformed URI.', 'http_code' => 400, 'description' => 'NewRedirectUris的URI格式错误。'],
['code' => 'InvalidParameter.ResourceType', 'message' => 'The parameter - ResourceType is invalid.', 'http_code' => 400, 'description' => '参数ResourceType无效。'],
['code' => 'InvalidParameter.RiskPassword.Weak', 'message' => 'The specified password was detected as a weak password, please set a stronger password.', 'http_code' => 400, 'description' => '检测到设置的密码为弱密码,请设置强度更高的密码。'],
['code' => 'InvalidParameter.SAMLMetadataDocument.Format', 'message' => 'The format of the parameter - SAMLMetadataDocument is incorrect.', 'http_code' => 400, 'description' => 'SAMLMetadataDocument格式错误。'],
['code' => 'InvalidParameter.SAMLMetadataDocument.Length', 'message' => 'The parameter - SAMLMetadataDocument beyond the length limit.', 'http_code' => 400, 'description' => 'SAMLMetadataDocument长度超过限制。'],
['code' => 'InvalidParameter.SAMLProviderName.InvalidChars', 'message' => 'The parameter - SAMLProviderName contains invalid chars.', 'http_code' => 400, 'description' => 'SAMLProviderName包含了非法字符。'],
['code' => 'InvalidParameter.SAMLProviderName.Length', 'message' => 'The parameter - SAMLProviderName beyond the length limit.', 'http_code' => 400, 'description' => 'SAMLProviderName长度超过限制。'],
['code' => 'InvalidParameter.Scopes', 'message' => 'The parameter - Scopes is invalid.', 'http_code' => 400, 'description' => 'Scopes无效。'],
['code' => 'InvalidParameter.SerialNumber.InvalidChars', 'message' => 'The parameter - SerialNumber contains invalid chars.', 'http_code' => 400, 'description' => 'SerialNumber中包含非法字符。'],
['code' => 'InvalidParameter.Status', 'message' => 'The parameter - Status is invalid.', 'http_code' => 400, 'description' => 'Status无效。'],
['code' => 'InvalidParameter.TagKey.Duplicate', 'message' => 'The tag is Duplicated.', 'http_code' => 400, 'description' => '标签键重复。'],
['code' => 'InvalidParameter.User.Conflict', 'message' => 'Two of UserId, UserPrincipalName and UserAccessKeyId must be null.', 'http_code' => 400, 'description' => 'UserId、UserPrincipalName或UserAccessKeyId只能提供一个。'],
['code' => 'InvalidParameter.User.Conflict', 'message' => 'One of UserId and UserPrincipalName must be null.', 'http_code' => 400, 'description' => 'UserId或UserPrincipalName只能提供一个。'],
['code' => 'InvalidParameter.UserAccessKeyId.Format', 'message' => 'The format of the parameter - UserAccessKeyId is incorrect.', 'http_code' => 400, 'description' => '参数UserAccessKeyId的格式非法。'],
['code' => 'InvalidParameter.UserPrincipalName.Format', 'message' => 'The format of the parameter - UserPrincipalName is incorrect.', 'http_code' => 400, 'description' => 'UserPrincipalName格式错误。'],
['code' => 'InvalidParameter.UserPrincipalName.InvalidChars', 'message' => 'The parameter - UserPrincipalName contains invalid chars.', 'http_code' => 400, 'description' => 'UserPrincipalName包含非法字符。'],
['code' => 'InvalidParameter.UserPrincipalName.Length', 'message' => 'The parameter - UserPrincipalName beyond the length limit.', 'http_code' => 400, 'description' => 'UserPrincipalName长度超过限制。'],
['code' => 'InvalidParameter.VirtualMFADeviceName.InvalidChars', 'message' => 'The parameter - VirtualMFADeviceName contains invalid chars.', 'http_code' => 400, 'description' => 'VirtualMFADeviceName名包含非法字符。'],
['code' => 'InvalidParameter.VirtualMFADeviceName.Length', 'message' => 'The parameter - VirtualMFADeviceName beyond the length limit.', 'http_code' => 400, 'description' => 'VirtualMFADeviceName长度超过限制'],
['code' => 'LimitExceeded.AppSecret', 'message' => 'The count of AppSecret beyond the current limits.', 'http_code' => 409, 'description' => '该应用下的密钥数量超过限制。'],
['code' => 'LimitExceeded.ExternalApplication', 'message' => 'The count of external application beyond the current limits.', 'http_code' => 409, 'description' => '安装的外部应用数量超过限制。'],
['code' => 'LimitExceeded.Group', 'message' => 'The count of groups beyond the current limits.', 'http_code' => 409, 'description' => '用户组数量超过限制。'],
['code' => 'LimitExceeded.SAMLProvider', 'message' => 'The count of SAMLProvider beyond the current limits.', 'http_code' => 409, 'description' => '身份提供商数量超过限制。'],
['code' => 'LimitExceeded.SAMLProviderIdp', 'message' => 'The count of SAMLProviderIdp beyond the current limits.', 'http_code' => 409, 'description' => '身份提供商元数据文档中的IdP数量超过限制。'],
['code' => 'LimitExceeded.SAMLProviderIdpKey', 'message' => 'The count of SAMLProviderIdpKey beyond the current limits.', 'http_code' => 409, 'description' => '身份提供商元数据文档中的IdP Key数量超过限制。'],
['code' => 'LimitExceeded.SecurityVerification', 'message' => 'The count of SecurityVerification beyond the current limits.', 'http_code' => 409, 'description' => '安全验证方式(包括手机、电子邮箱)超出数量限制。'],
['code' => 'LimitExceeded.User', 'message' => 'The count of users beyond the current limits.', 'http_code' => 409, 'description' => 'RAM用户数量超过限制。'],
['code' => 'LimitExceeded.User.AccessKey', 'message' => 'The count of the user access keys beyond the current limits.', 'http_code' => 409, 'description' => 'RAM用户的访问密钥数量超过限制。'],
['code' => 'LimitExceeded.User.Group', 'message' => 'The count of groups the target user joined beyond the current limits.', 'http_code' => 409, 'description' => '该RAM用户加入的用户组数量超过限制。'],
['code' => 'LimitExceeded.VerificationPerDay', 'message' => 'The count of active verification per day beyond the current limits.', 'http_code' => 409, 'description' => '每天允许发送安全认证激活链接超过次数限制'],
['code' => 'LimitExceeded.VerificationPerMinute', 'message' => 'The count of active verification per minute beyond the current limits.', 'http_code' => 409, 'description' => '每分钟发送安全认证链接次数超过限制'],
['code' => 'LimitExceeded.VerificationPerMoment', 'message' => 'The count of active verification per moment beyond the current limits.', 'http_code' => 409, 'description' => '15分钟内允许发送安全认证激活链接超过次数限制'],
['code' => 'LimitExceeded.VirtualMFADevice', 'message' => 'The count of virtual MFA devices beyond the current limits.', 'http_code' => 409, 'description' => '虚拟MFA设备数量超过限制。'],
['code' => 'MissingAccessKeyPolicy', 'message' => 'The input parameter AccessKeyPolicy that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少AccessKeyPolicy参数。'],
['code' => 'MissingAppId', 'message' => 'The input parameter AppId that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少AppId参数。'],
['code' => 'MissingAppName', 'message' => 'The input parameter AppName that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少AppName参数。'],
['code' => 'MissingAppSecretId', 'message' => 'The input parameter AppSecretId that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少AppSecretId参数。'],
['code' => 'MissingAuthenticationCode1', 'message' => 'The input parameter AuthenticationCode1 that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少AuthenticationCode1参数。'],
['code' => 'MissingAuthenticationCode2', 'message' => 'The input parameter AuthenticationCode2 that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少AuthenticationCode2参数。'],
['code' => 'MissingDisplayName', 'message' => 'The input parameter DisplayName that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少DisplayName参数。'],
['code' => 'MissingEncodedSAMLMetadataDocument', 'message' => 'The input parameter EncodedSAMLMetadataDocument that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少EncodedSAMLMetadataDocument参数。'],
['code' => 'MissingGroupName', 'message' => 'The input parameter GroupName that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少GroupName参数。'],
['code' => 'MissingIssuerUrl', 'message' => 'The input parameter IssuerUrl that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少必传参数IssuerUrl。'],
['code' => 'MissingNewPassword', 'message' => 'The input parameter NewPassword that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少NewPassword参数。'],
['code' => 'MissingPassword', 'message' => 'The input parameter Password that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少Password参数。'],
['code' => 'MissingSAMLProviderName', 'message' => 'The input parameter SAMLProviderName that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少SAMLProviderName参数。'],
['code' => 'MissingSerialNumber', 'message' => 'The input parameter SerialNumber that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少SerialNumber参数。'],
['code' => 'MissingStatus', 'message' => 'The input parameter Status that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少Status参数。'],
['code' => 'MissingTagOrResourceId', 'message' => 'The specified tags and resourcesIds are not allow to be both empty.', 'http_code' => 400, 'description' => 'Tag和ResourceId参数不能同时为空。'],
['code' => 'MissingUserAccessKeyId', 'message' => 'The input parameter UserAccessKeyId that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少UserAccessKeyId参数。'],
['code' => 'MissingUserPrincipalName', 'message' => 'The input parameter UserPrincipalName that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少UserPrincipalName参数。'],
['code' => 'MissingVirtualMFADeviceName', 'message' => 'The input parameter VirtualMFADeviceName that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => '缺少VirtualMFADeviceName参数。'],
['code' => 'NotReady.CredentialReport', 'message' => 'The credential report is being generated and not ready yet.', 'http_code' => 404, 'description' => '用户凭证报告未生成。'],
['code' => 'NotSupport.AliyunReservedSAMLProvider', 'message' => 'The SAMLProvider is reserved for Alibaba Cloud services.', 'http_code' => 400, 'description' => '此SAML身份提供商名称是阿里云的保留名称。'],
['code' => 'OldPassword.Incorrect', 'message' => 'The parameter OldPassword is incorrect.', 'http_code' => 400, 'description' => '旧密码错误。'],
['code' => 'OperationConflict.Application.ProvisionApplicationType', 'message' => 'The application type is not allowd to be provisioned in your account.', 'http_code' => 409, 'description' => '该类型的应用不能安装到当前账号下。'],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestoreUserFromRecycleBin'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsers'],
['threshold' => '700', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserMFAInfo'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindMFADevice'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOIDCProvider'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUserToGroup'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApplication'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPredefinedScopes'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAppSecret'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeprovisionExternalApplication'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsersForGroup'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetVerificationInfo'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOIDCProvider'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateGovernanceReport'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGovernanceItemReport'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAccessKey'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserInRecycleBin'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFingerprintToOIDCProvider'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUserSsoSettings'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRecentGovernanceMetrics'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccessKeyInRecycleBin'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangePassword'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroup'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExternalApplication'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplicationProvisionInfo'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAppSecretIds'],
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSAMLProvider'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAppSecret'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDefaultDomain'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroup'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUser'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVerificationInfo'],
['threshold' => '900', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAccessKeys'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExternalApplications'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserInRecycleBin'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSecurityPreference'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsersInRecycleBin'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLoginProfile'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGovernanceReportStatus'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserBasicInfos'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUserSsoSettings'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUser'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVirtualMFADevices'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSAMLProvider'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDefaultDomain'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindMFADevice'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLoginProfile'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetSecurityPreference'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLoginProfile'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ProvisionExternalApplication'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteVirtualMFADevice'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUserFromGroup'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplicationProvisionInfos'],
['threshold' => '350', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccessKeyLastUsed'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableVirtualMFA'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGroup'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestoreAccessKeyFromRecycleBin'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAccessKey'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteOIDCProvider'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApplication'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindVerification'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAppSecret'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupsForUser'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAccessKeysInRecycleBin'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountMFAInfo'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSAMLProvider'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVirtualMFADevice'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUser'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroups'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccessKeyInfoInRecycleBin'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOIDCProvider'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveClientIdFromOIDCProvider'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ProvisionApplication'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateCredentialReport'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApplication'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountSummary'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSAMLProvider'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPasswordPolicy'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveFingerprintFromOIDCProvider'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetPasswordPolicy'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCredentialReport'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAccessKey'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountSecurityPracticeReport'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddClientIdToOIDCProvider'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeprovisionApplication'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplications'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSAMLProviders'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplication'],
['threshold' => '450', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOIDCProviders'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLoginProfile'],
['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroup'],
],
],
'ram' => [
'productCode' => 'IMS',
'productName' => '访问控制',
'ramCodes' => ['ram', 'ims'],
'ramLevel' => '资源级',
'ramConditions' => [
[
'name' => 'ram:OidcIssuerUrl',
'schema' => ['type' => 'String', 'description' => ' 颁发者URL,由外部IdP提供'],
],
[
'name' => 'ram:ServiceCredentialServiceName',
'schema' => ['type' => 'String', 'description' => '服务凭证指定的云服务'],
],
[
'name' => 'ram:MFAOperationForLogin',
'schema' => [
'type' => 'String',
'description' => '登录时是否必须使用MFA验证',
'enums' => ['mandatory', 'independent', 'adaptive'],
],
],
],
'ramActions' => [
[
'apiName' => 'DeleteOIDCProvider',
'description' => '删除OIDC身份提供商',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}'],
],
],
],
[
'apiName' => 'ListExternalApplications',
'description' => '查询所有已安装的外部应用',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListExternalApplications',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetUserSsoSettings',
'description' => '查询用户SSO身份提供商信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetUserSsoSettings',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateUser',
'description' => '修改RAM用户信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'GetCredentialReport',
'description' => '查询用户凭证报告内容',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetCredentialReport',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetUserSsoSettings',
'description' => '设置用户SSO身份提供商信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:SetUserSsoSettings',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RestoreAccessKeyFromRecycleBin',
'description' => '从回收站中恢复访问密钥',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:RestoreAccessKeyFromRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ProvisionExternalApplication',
'description' => '安装外部应用',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:ProvisionExternalApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddClientIdToOIDCProvider',
'description' => '为OIDC身份提供商添加指定客户端ID',
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:AddClientIdToOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}'],
],
],
],
[
'apiName' => 'GetSAMLProvider',
'description' => '查询角色SSO身份提供商信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetSAMLProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'SAMLProvider', 'arn' => 'acs:ram::{#accountId}:saml-provider/{#SAMLProviderName}'],
],
],
],
[
'apiName' => 'GetGroup',
'description' => '查询指定用户组信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/{#GroupName}'],
],
],
],
[
'apiName' => 'GetLoginProfile',
'description' => '查询指定RAM用户的登录信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetLoginProfile',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'DeleteUser',
'description' => '删除RAM用户',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'CreateSAMLProvider',
'description' => '创建角色SSO身份提供商',
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateSAMLProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteServiceCredential',
'description' => '删除服务凭证',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteServiceCredential',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:ServiceCredentialServiceName', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'DeleteAccessKey',
'description' => '删除用户的访问密钥',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteAccessKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'ListGroups',
'description' => '查询用户组列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/*'],
],
],
],
[
'apiName' => 'DeletePasskey',
'description' => '删除通行密钥',
'operationType' => 'none',
'ramAction' => [
'action' => 'ram:DeletePasskey',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisableVirtualMFA',
'description' => '解绑并删除多因素认证设备',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:DisableVirtualMFA',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'GetPasswordPolicy',
'description' => '查询RAM用户密码强度策略信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetPasswordPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetDefaultDomain',
'description' => '设置默认域名',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:SetDefaultDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateGroup',
'description' => '创建用户组',
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/*'],
],
],
],
[
'apiName' => 'ListUserBasicInfos',
'description' => '查询所有RAM用户的基本信息',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListUserBasicInfos',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/*'],
],
],
],
[
'apiName' => 'UpdatePasskey',
'description' => '更新通行密钥',
'operationType' => 'none',
'ramAction' => [
'action' => 'ram:UpdatePasskey',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetOIDCProvider',
'description' => '查询OIDC身份提供商信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}'],
],
],
],
[
'apiName' => 'ListAccessKeys',
'description' => '查询主账号或RAM用户访问密钥列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListAccessKeys',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'ChangePassword',
'description' => 'RAM用户修改自己的登录密码',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:ChangePassword',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GenerateGovernanceReport',
'description' => '生成身份权限治理检测报告',
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:GenerateGovernanceReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetServiceCredential',
'description' => '获取单个服务凭证',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetServiceCredential',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:ServiceCredentialServiceName', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'ListSAMLProviders',
'description' => '查询角色SSO身份提供商列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListSAMLProviders',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListAppSecretIds',
'description' => '查询指定应用的应用密钥ID列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListAppSecretIds',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
[
'apiName' => 'ListUsersForGroup',
'description' => '查询用户组内的RAM用户列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListUsersForGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/{#GroupName}'],
],
],
],
[
'apiName' => 'DeleteAccessKeyInRecycleBin',
'description' => '删除回收站中的访问密钥',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteAccessKeyInRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteGroup',
'description' => '删除指定的用户组',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/{#GroupName}'],
],
],
],
[
'apiName' => 'UpdateAccessKey',
'description' => '修改访问密钥状态',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateAccessKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'ListTagResources',
'description' => '查询资源与标签的关系',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListTagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UnbindMFADevice',
'description' => '为RAM用户解绑多因素认证设备',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UnbindMFADevice',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'DeleteSAMLProvider',
'description' => '删除指定的角色SSO身份提供商',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteSAMLProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'SAMLProvider', 'arn' => 'acs:ram::{#accountId}:saml-provider/{#SAMLProviderName}'],
],
],
],
[
'apiName' => 'DeleteUserInRecycleBin',
'description' => '删除回收站中的RAM用户',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteUserInRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAccessKeyLastUsed',
'description' => '查询指定访问密钥的最后使用时间',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetAccessKeyLastUsed',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'SetPasswordPolicy',
'description' => '设置RAM用户密码强度策略',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:SetPasswordPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListOIDCProviders',
'description' => '查询OIDC身份提供商列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListOIDCProviders',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteAppSecret',
'description' => '删除指定应用的应用密钥',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteAppSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
[
'apiName' => 'CreateVirtualMFADevice',
'description' => '创建多因素认证设备',
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateVirtualMFADevice',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'MFADevice', 'arn' => 'acs:ram::{#accountId}:mfa/*'],
],
],
],
[
'apiName' => 'GetGovernanceItemReport',
'description' => '查询身份权限指定治理检测项检测报告',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetGovernanceItemReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetExternalApplication',
'description' => '查询外部应用信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetExternalApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RestoreUserFromRecycleBin',
'description' => '从回收站中恢复RAM用户',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:RestoreUserFromRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetAccessKeyPolicy',
'description' => '设置指定访问密钥的网络访问限制策略',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:SetAccessKeyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#AccountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'CreateServiceCredential',
'description' => '创建服务凭证',
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateServiceCredential',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:ServiceCredentialServiceName', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'GetAccessKeyPolicy',
'description' => '查询指定访问密钥的网络访问限制策略',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetAccessKeyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'RemoveFingerprintFromOIDCProvider',
'description' => '移除OIDC身份提供商中指定的验证指纹',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:RemoveFingerprintFromOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}'],
],
],
],
[
'apiName' => 'GetVerificationInfo',
'description' => '获取用户手机邮箱的安全认证信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetVerificationInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetApplicationProvisionInfo',
'description' => '查询应用安装信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetApplicationProvisionInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAppSecret',
'description' => '查询指定应用密钥信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetAppSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
[
'apiName' => 'UpdateApplication',
'description' => '修改应用的配置信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
[
'apiName' => 'DeleteVirtualMFADevice',
'description' => '删除多因素认证设备',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteVirtualMFADevice',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'MFADevice', 'arn' => 'acs:ram::{#accountId}:mfa/{#SerialNumber}'],
],
],
],
[
'apiName' => 'ListRecentGovernanceMetrics',
'description' => '查询最近一次治理检测的所有治理项指标值',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListRecentGovernanceMetrics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListApplicationProvisionInfos',
'description' => '查询所有已安装应用的安装信息',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListApplicationProvisionInfos',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'BindMFADevice',
'description' => '为RAM用户绑定多因素认证设备',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:BindMFADevice',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'CreateLoginProfile',
'description' => '开启指定RAM用户的控制台登录',
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateLoginProfile',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'GetUserMFAInfo',
'description' => '查询RAM用户多因素认证设备信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetUserMFAInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'RemoveClientIdFromOIDCProvider',
'description' => '移除OIDC身份提供商中的指定客户端ID',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:RemoveClientIdFromOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}'],
],
],
],
[
'apiName' => 'DeprovisionExternalApplication',
'description' => '卸载已安装的外部应用',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:DeprovisionExternalApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAccountSecurityPracticeReport',
'description' => '查询阿里云账号的安全报告',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetAccountSecurityPracticeReport',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPasskeys',
'description' => '查看用户绑定的通行密钥',
'operationType' => 'none',
'ramAction' => [
'action' => 'ram:ListPasskeys',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ProvisionApplication',
'description' => '安装应用',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:ProvisionApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetGovernanceReportStatus',
'description' => '查询身份权限治理检测报告生成状态',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetGovernanceReportStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteApplication',
'description' => '删除一个应用',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
[
'apiName' => 'UnbindVerification',
'description' => '为RAM用户解绑安全手机或安全邮箱',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UnbindVerification',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetSecurityPreference',
'description' => '设置RAM用户的全局安全首选项',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:SetSecurityPreference',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:MFAOperationForLogin'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListAccessKeysInRecycleBin',
'description' => '查询回收站中的访问密钥列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListAccessKeysInRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RemoveUserFromGroup',
'description' => '将RAM用户从用户组中移除',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:RemoveUserFromGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/{#GroupName}'],
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'GetAccountSummary',
'description' => '查询主账号概览信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetAccountSummary',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDefaultDomain',
'description' => '查询默认域名',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetDefaultDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UntagResources',
'description' => '解绑资源的标签',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UntagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateLoginProfile',
'description' => '修改RAM用户的控制台登录信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateLoginProfile',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'GetSecurityPreference',
'description' => '查询RAM用户全局安全首选项',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetSecurityPreference',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'TagResources',
'description' => '资源打上标签',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:TagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateAccessKey',
'description' => '创建主账号或RAM用户访问密钥',
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateAccessKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'ListVirtualMFADevices',
'description' => '查询多因素认证设备列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListVirtualMFADevices',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'MFADevice', 'arn' => 'acs:ram::{#accountId}:mfa/*'],
],
],
],
[
'apiName' => 'ListUsers',
'description' => '查询所有RAM用户的详细信息',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListUsers',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/*'],
],
],
],
[
'apiName' => 'ListServiceCredentials',
'description' => '获取服务凭证列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListServiceCredentials',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'GetAccountMFAInfo',
'description' => '查询主账号多因素认证设备信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetAccountMFAInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListApplications',
'description' => '查询应用列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:ListApplications',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeprovisionApplication',
'description' => '卸载已安装的应用',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:DeprovisionApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
[
'apiName' => 'GetUserInRecycleBin',
'description' => '查询回收站中的RAM用户',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetUserInRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateUser',
'description' => '创建RAM用户',
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/*'],
],
],
],
[
'apiName' => 'CreateOIDCProvider',
'description' => '创建OIDC身份供应商',
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListUsersInRecycleBin',
'description' => '查询回收站中的所有RAM用户',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListUsersInRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetUser',
'description' => '查询RAM用户的详细信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'CreateAppSecret',
'description' => '为指定的应用创建应用密钥',
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateAppSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
[
'apiName' => 'UpdateSAMLProvider',
'description' => '修改角色SSO身份提供商信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateSAMLProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'SAMLProvider', 'arn' => 'acs:ram::{#accountId}:saml-provider/{#SAMLProviderName}'],
],
],
],
[
'apiName' => 'ListGroupsForUser',
'description' => '查询RAM用户加入的用户组列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'ram:ListGroupsForUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'CreateApplication',
'description' => '创建应用',
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:CreateApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateOIDCProvider',
'description' => '修改OIDC身份提供商',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}'],
],
],
],
[
'apiName' => 'AddUserToGroup',
'description' => '将RAM用户添加到指定的用户组',
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:AddUserToGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/{#GroupName}'],
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'AddFingerprintToOIDCProvider',
'description' => '为OIDC身份提供商添加验证指纹',
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:AddFingerprintToOIDCProvider',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:OidcIssuerUrl', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}'],
],
],
],
[
'apiName' => 'GenerateCredentialReport',
'description' => '生成用户凭证报告',
'operationType' => 'create',
'ramAction' => [
'action' => 'ram:GenerateCredentialReport',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteLoginProfile',
'description' => '关闭指定RAM用户的控制台登录',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ram:DeleteLoginProfile',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'GetApplication',
'description' => '查询应用的配置信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
],
],
],
[
'apiName' => 'SetVerificationInfo',
'description' => '为RAM用户绑定安全手机或安全邮箱',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:SetVerificationInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateServiceCredential',
'description' => '修改服务凭证的状态或名称',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateServiceCredential',
'authLevel' => 'resource',
'actionConditions' => [
['conditionKey' => 'ram:ServiceCredentialServiceName', 'validationType' => 'always'],
],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
],
],
],
[
'apiName' => 'GetAccessKeyInfoInRecycleBin',
'description' => '查询回收站中的访问密钥',
'operationType' => 'get',
'ramAction' => [
'action' => 'ram:GetAccessKeyInfoInRecycleBin',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateGroup',
'description' => '修改指定用户组的信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'ram:UpdateGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'IMS', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/{#GroupName}'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'always', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}'],
['validationType' => 'always', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/*'],
['validationType' => 'always', 'resourceType' => 'User', 'arn' => 'acs:ram::{#accountId}:user/{#UserName}'],
['validationType' => 'conditional', 'resourceType' => 'User', 'arn' => 'acs:ram::{#AccountId}:user/*'],
['validationType' => 'always', 'resourceType' => 'SAMLProvider', 'arn' => 'acs:ram::{#accountId}:saml-provider/{#SAMLProviderName}'],
['validationType' => 'always', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/{#GroupName}'],
['validationType' => 'always', 'resourceType' => 'SAMLProvider', 'arn' => 'acs:ram::{#accountId}:saml-provider/*'],
['validationType' => 'always', 'resourceType' => 'Group', 'arn' => 'acs:ram::{#accountId}:group/*'],
['validationType' => 'always', 'resourceType' => 'Application', 'arn' => 'acs:ram::{#accountId}:application/{#AppName}'],
['validationType' => 'always', 'resourceType' => 'OIDCProvider', 'arn' => 'acs:ram::{#accountId}:oidc-provider/*'],
['validationType' => 'always', 'resourceType' => 'MFADevice', 'arn' => 'acs:ram::{#accountId}:mfa/*'],
['validationType' => 'always', 'resourceType' => 'MFADevice', 'arn' => 'acs:ram::{#accountId}:mfa/{#SerialNumber}'],
],
],
];