'1.0',
'info' => ['style' => 'RPC', 'product' => 'Eiam', 'version' => '2021-12-01'],
'directories' => [
[
'children' => ['GetServiceQuota', 'RenewFreeLicenseEndTime', 'SetInstanceControlConfiguration', 'SetInstanceGlobalizationConfig', 'CreateInstanceTrialLicense', 'CheckInstanceModuleStatus', 'CheckInstanceForDelete', 'GetInstanceGlobalizationConfig', 'GetInstanceControlConfiguration', 'GetInstanceModuleInfo', 'GetInstanceQuota', 'GetInstanceTrialStatus', 'UpdateInstanceDescription', 'EnableInitDomainAutoRedirect', 'DisableInitDomainAutoRedirect', 'GetInstanceLicense'],
'type' => 'directory',
'title' => 'Instance Management',
],
[
'children' => ['GetDomainDnsChallenge', 'SetDefaultDomain', 'CreateDomainProxyToken', 'ObtainDomainProxyToken', 'EnableDomainProxyToken', 'DisableDomainProxyToken', 'ListDomainProxyTokens', 'DeleteDomainProxyToken', 'UpdateDomainIcpNumber', 'UpdateDomainBrand'],
'type' => 'directory',
'title' => 'Domain Name Management',
],
[
'children' => [
[
'children' => ['UpdateApplicationDescription', 'GetApplicationTemplate', 'UpdateApplicationInfo', 'ListApplicationsForNetworkAccessEndpoint', 'ListApplicationsForNetworkZone', 'ListApplicationsForGroup'],
'type' => 'directory',
'title' => 'Managing basic application information',
],
[
'children' => ['EnableApplicationSso', 'DisableApplicationSso', 'SetApplicationSsoConfig', 'GetApplicationSsoConfig', 'UpdateApplicationSsoFormParams'],
'type' => 'directory',
'title' => 'SSO Configuration for Applications',
],
[
'children' => ['AuthorizeApplicationToUsers', 'AuthorizeApplicationToOrganizationalUnits', 'AuthorizeApplicationToGroups', 'RevokeApplicationFromUsers', 'RevokeApplicationFromOrganizationalUnits', 'RevokeApplicationFromGroups', 'ListUsersForApplication', 'ListOrganizationalUnitsForApplication', 'ListGroupsForApplication', 'ListApplicationsForUser', 'ListApplicationsForOrganizationalUnit'],
'type' => 'directory',
'title' => 'Managing application authorization',
],
[
'children' => ['UpdateApplicationFederatedCredentialDescription', 'UpdateApplicationFederatedCredential', 'ListApplicationFederatedCredentials', 'GetApplicationFederatedCredential', 'EnableApplicationFederatedCredential', 'DisableApplicationFederatedCredential', 'DeleteApplicationFederatedCredential', 'CreateApplicationFederatedCredential'],
'type' => 'directory',
'title' => 'Credential management for application federation',
],
[
'children' => ['CreateApplicationClientSecret', 'ListApplicationClientSecrets', 'ObtainApplicationClientSecret', 'UpdateApplicationClientSecretExpirationTime'],
'type' => 'directory',
'title' => 'Application Client Secret Management',
],
[
'children' => ['UpdateApplicationTokenExpirationTime', 'EnableApplicationToken', 'DisableApplicationToken', 'CreateApplicationToken', 'ListApplicationTokens', 'ObtainApplicationToken', 'DeleteApplicationToken'],
'type' => 'directory',
'title' => 'Application token management',
],
[
'children' => ['AddApplicationAccountToUser', 'ListApplicationAccounts', 'ListApplicationAccountsForUser', 'RemoveApplicationAccountFromUser'],
'type' => 'directory',
'title' => 'Application sub-account management',
],
[
'children' => ['EnableApplicationApiInvoke'],
'type' => 'directory',
'title' => 'Application API publication',
],
[
'children' => ['GetApplicationProvisioningUserPrimaryOrganizationalUnit', 'CheckApplicationProvisioningUserPrimaryOrganizationalUnit', 'SetApplicationProvisioningUserPrimaryOrganizationalUnit', 'SetApplicationProvisioningConfig', 'GetApplicationProvisioningConfig'],
'type' => 'directory',
'title' => 'Application account synchronization',
],
[
'children' => ['UpdateApplicationAdvancedConfig', 'GetApplicationAdvancedConfig'],
'type' => 'directory',
'title' => 'Application advanced configuration',
],
[
'children' => ['CreateApplicationRole', 'DeleteApplicationRole', 'UpdateApplicationRole', 'UpdateApplicationRoleDescription', 'GetApplicationRole', 'ListApplicationRoles'],
'type' => 'directory',
'title' => 'Managing application roles',
],
],
'type' => 'directory',
'title' => 'Application management',
],
[
'children' => [
[
'children' => ['EnableApplicationResourceServer', 'DisableApplicationResourceServer', 'EnableApplicationM2MClient', 'DisableApplicationM2MClient', 'EnableResourceServerCustomSubject', 'DisableResourceServerCustomSubject', 'SetApplicationResourceServerIdentifier'],
'type' => 'directory',
'title' => 'Basic feature management',
],
[
'children' => [
[
'children' => ['CreateResourceServerScope', 'UpdateResourceServerScope', 'DeleteResourceServerScope', 'GetResourceServerScope', 'ListResourceServerScopes'],
'type' => 'directory',
'title' => 'Permission Management',
],
[
'children' => ['AuthorizeResourceServerToClient', 'RevokeResourceServerFromClient', 'AuthorizeResourceServerScopesToClient', 'RevokeResourceServerScopesFromClient'],
'type' => 'directory',
'title' => 'Authorization management for machines',
],
[
'children' => ['AuthorizeResourceServerScopesToUser', 'RevokeResourceServerScopesFromUser', 'AuthorizeResourceServerScopesToOrganizationalUnit', 'RevokeResourceServerScopesFromOrganizationalUnit', 'AuthorizeResourceServerScopesToGroup', 'RevokeResourceServerScopesFromGroup', 'ListUsersForResourceServer', 'ListResourceServersForUser', 'ListOrganizationalUnitsForResourceServer', 'ListGroupsForResourceServer'],
'type' => 'directory',
'title' => 'User Authorization Management',
],
],
'type' => 'directory',
'title' => 'Authorization Management',
],
[
'children' => ['CreateClientPublicKey', 'DeleteClientPublicKey', 'EnableClientPublicKey', 'DisableClientPublicKey', 'SetPrimaryClientPublicKey', 'GetClientPublicKey', 'ListClientPublicKeys'],
'type' => 'directory',
'title' => 'Application Client Public Key Management',
],
],
'type' => 'directory',
'title' => 'M2M Management',
],
[
'children' => ['DeleteFederatedCredentialProvider', 'UpdateFederatedCredentialProviderDescription', 'UpdateFederatedCredentialProvider', 'ListFederatedCredentialProviders', 'ListApplicationFederatedCredentialsForProvider', 'GetFederatedCredentialProvider', 'EnableFederatedCredentialProvider', 'DisableFederatedCredentialProvider', 'CreateFederatedCredentialProvider'],
'type' => 'directory',
'title' => 'Federated trust source management',
],
[
'children' => [
'DeleteUsers',
[
'children' => ['BindUserAuthnSourceMapping', 'UnbindUserAuthnSourceMapping', 'ListUserAuthnSourceMappings'],
'type' => 'directory',
'title' => 'Manage third-party login accounts',
],
'UpdateUserDescription',
],
'type' => 'directory',
'title' => 'Account management',
],
[
'children' => ['GetRootOrganizationalUnit', 'ListOrganizationalUnitParents'],
'type' => 'directory',
'title' => 'Organization management',
],
[
'children' => [
'ExecIdentityProviderMetadataUrlResolution', 'SetIdentityProviderAuthnConfiguration', 'SetIdentityProviderUdPushConfiguration', 'GetIdentityProviderAdvancedConfiguration', 'GetIdentityProviderStatusCheckJob', 'GetIdentityProviderUdPushConfiguration', 'EnableIdentityProviderAdvancedAbility', 'CreateIdentityProviderStatusCheckJob', 'DisableIdentityProviderAdvancedAbility', 'CreateIdentityProvider', 'DeleteIdentityProvider', 'UpdateIdentityProvider', 'GetIdentityProvider', 'ListIdentityProviders', 'EnableIdentityProviderUdPull', 'DisableIdentityProviderUdPull', 'SetIdentityProviderUdPullConfiguration', 'GetIdentityProviderUdPullConfiguration', 'ListIdentityProvidersForNetworkAccessEndpoint', 'EnableIdentityProviderAuthn',
'DisableIdentityProviderAuthn',
],
'type' => 'directory',
'title' => 'Identity provider management',
],
[
'children' => ['SetPasswordExpirationConfiguration', 'SetPasswordComplexityConfiguration', 'GetForgetPasswordConfiguration', 'GetPasswordComplexityConfiguration'],
'type' => 'directory',
'title' => 'Password policy',
],
[
'children' => ['CreateConditionalAccessPolicy', 'DeleteConditionalAccessPolicy', 'DisableConditionalAccessPolicy', 'EnableConditionalAccessPolicy', 'GetConditionalAccessPolicy', 'ListConditionalAccessPolicies', 'ListConditionalAccessPoliciesForNetworkZone', 'UpdateConditionalAccessPolicy', 'UpdateConditionalAccessPolicyDescription', 'ListConditionalAccessPoliciesForUser', 'ListConditionalAccessPoliciesForApplication'],
'type' => 'directory',
'title' => 'Conditional access policy',
],
[
'children' => ['ListSynchronizationJobs', 'RunSynchronizationJob', 'GetSynchronizationJob'],
'type' => 'directory',
'title' => 'Synchronization',
],
[
'children' => ['CreateBrand', 'GetBrand', 'EnableBrand', 'DisableBrand', 'UpdateBrand', 'DeleteBrand', 'ListBrands', 'SetLoginRedirectApplicationForBrand', 'GetLoginRedirectApplicationForBrand'],
'type' => 'directory',
'title' => 'Branding',
],
[
'children' => ['CreateCustomPrivacyPolicy', 'GetCustomPrivacyPolicy', 'EnableCustomPrivacyPolicy', 'DisableCustomPrivacyPolicy', 'UpdateCustomPrivacyPolicy', 'DeleteCustomPrivacyPolicy', 'ListCustomPrivacyPolicies', 'AddCustomPrivacyPoliciesToBrand', 'RemoveCustomPrivacyPoliciesFromBrand', 'ListCustomPrivacyPoliciesForBrand'],
'type' => 'directory',
'title' => 'Custom terms',
],
[
'children' => ['CreateNetworkAccessEndpoint', 'DeleteNetworkAccessEndpoint', 'UpdateNetworkAccessEndpointName', 'ListNetworkAccessEndpointAvailableRegions', 'ListNetworkAccessEndpointAvailableZones', 'GetNetworkAccessEndpoint', 'ListNetworkAccessEndpoints', 'ListNetworkAccessPaths'],
'type' => 'directory',
'title' => 'Network endpoint',
],
[
'children' => ['CreateNetworkZone', 'DeleteNetworkZone', 'UpdateNetworkZone', 'UpdateNetworkZoneDescription', 'ListNetworkZones', 'GetNetworkZone'],
'type' => 'directory',
'title' => 'Network zone',
],
[
'children' => ['EnableInternalAuthenticationSource', 'DisableInternalAuthenticationSource'],
'type' => 'directory',
'title' => 'Authentication Source',
],
[
'children' => ['SetWebAuthnConfiguration', 'UnbindTotpAuthenticator', 'DeleteWebAuthnAuthenticator'],
'type' => 'directory',
'title' => 'Authenticator',
],
[
'children' => ['ListCloudAccounts', 'GetCloudAccount', 'CreateCloudAccount', 'UpdateCloudAccount', 'UpdateCloudAccountDescription', 'DeleteCloudAccount'],
'type' => 'directory',
'title' => 'Alibaba Cloud account',
],
[
'children' => ['ListCloudAccountRoles', 'GetCloudAccountRole', 'CreateCloudAccountRole', 'DisableCloudAccountRole', 'EnableCloudAccountRole', 'UpdateCloudAccountRoleDescription', 'DeleteCloudAccountRole'],
'type' => 'directory',
'title' => 'Cloud role',
],
[
'children' => ['DisableCredential', 'EnableCredential', 'UpdateCredentialDescription'],
'type' => 'directory',
'title' => 'Credentials',
],
[
'children' => ['CreateCredentialProvider', 'DeleteCredentialProvider', 'DisableCredentialProvider', 'EnableCredentialProvider', 'GetCredentialProvider', 'ListCredentialProviders', 'UpdateCredentialProvider', 'UpdateCredentialProviderDescription'],
'type' => 'directory',
'title' => 'Credential Provider',
],
[
'children' => [
'CreateAuthorizationRule', 'UpdateAuthorizationRule', 'UpdateAuthorizationRuleDescription', 'EnableAuthorizationRule', 'DisableAuthorizationRule', 'DeleteAuthorizationRule', 'GetAuthorizationRule', 'ListAuthorizationRules', 'AddUserToAuthorizationRule', 'UpdateAuthorizationRuleUserAttachment', 'RemoveUserFromAuthorizationRule', 'ListAuthorizationRulesForUser', 'ListUsersForAuthorizationRule', 'AddGroupToAuthorizationRule', 'UpdateAuthorizationRuleGroupAttachment', 'RemoveGroupFromAuthorizationRule', 'ListAuthorizationRulesForGroup', 'ListGroupsForAuthorizationRule', 'AddApplicationToAuthorizationRule', 'UpdateAuthorizationRuleApplicationAttachment',
'RemoveApplicationFromAuthorizationRule', 'ListApplicationsForAuthorizationRule', 'ListAuthorizationRulesForApplication', 'CreateAuthorizationResource', 'DeleteAuthorizationResource', 'GetAuthorizationResource', 'ListAuthorizationResources',
],
'type' => 'directory',
'title' => 'Data Permission Management',
],
[
'children' => ['GenerateUploadAuth', 'GenerateFileImportTemplate', 'GenerateDownloadUrlForSynchronizationJob'],
'type' => 'directory',
'title' => 'Import files',
],
[
'children' => ['GenerateOauthToken'],
'type' => 'directory',
'title' => 'OAuth token',
],
[
'children' => ['GetCustomField', 'EnableCustomField', 'DisableCustomField', 'DeleteCustomField', 'CreateCustomField'],
'type' => 'directory',
'title' => 'Extension Property',
],
[
'children' => ['ListEventTypes', 'ListActionTrackEventTypes'],
'type' => 'directory',
'title' => 'Events',
],
[
'children' => [
'ListEiamInstances', 'ListEiamRegions', 'ListApplicationSupportedProvisionProtocolTypes', 'AddUserToOrganizationalUnits', 'AddUsersToGroup', 'CreateApplication', 'CreateCredential', 'CreateDomain', 'CreateGroup', 'CreateInstance', 'CreateOrganizationalUnit', 'CreateUser', 'DeleteApplication', 'DeleteApplicationClientSecret', 'DeleteCredential', 'DeleteDomain', 'DeleteGroup', 'DeleteInstance', 'DeleteOrganizationalUnit', 'DeleteOrganizationalUnitChildren',
'DeleteUser', 'DisableApplication', 'DisableApplicationApiInvoke', 'DisableApplicationClientSecret', 'DisableApplicationProvisioning', 'DisableUser', 'EnableApplication', 'EnableApplicationClientSecret', 'EnableApplicationProvisioning', 'EnableUser', 'GetApplication', 'GetApplicationGrantScope', 'GetApplicationProvisioningScope', 'GetAuthorizationServer', 'GetCredential', 'GetDomain', 'GetGroup', 'GetInstance', 'GetOrganizationalUnit', 'GetPasswordExpirationConfiguration',
'GetPasswordHistoryConfiguration', 'GetPasswordInitializationConfiguration', 'GetUser', 'ListApplications', 'ListAuthorizationServers', 'ListCredentials', 'ListDomains', 'ListGroups', 'ListGroupsForUser', 'ListInstances', 'ListOrganizationalUnits', 'ListRegions', 'ListUsers', 'ListUsersForGroup', 'ObtainCredential', 'RemoveUserFromOrganizationalUnits', 'RemoveUsersFromGroup', 'SetApplicationGrantScope', 'SetApplicationProvisioningScope', 'SetForgetPasswordConfiguration',
'SetPasswordHistoryConfiguration', 'SetPasswordInitializationConfiguration', 'SetUserPrimaryOrganizationalUnit', 'UnlockUser', 'UpdateApplicationAuthorizationType', 'UpdateAuthorizationServer', 'UpdateAuthorizationServerDescription', 'UpdateCredential', 'UpdateGroup', 'UpdateGroupDescription', 'UpdateOrganizationalUnit', 'UpdateOrganizationalUnitDescription', 'UpdateOrganizationalUnitParentId', 'UpdateUser', 'UpdateUserPassword',
],
'type' => 'directory',
'title' => 'Others',
],
[
'children' => ['GenerateWebAuthnAuthenticatorRegistrationUrl'],
'type' => 'directory',
'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AddApplicationAccountToUser' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas51QHX0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'eiam-111ccc1111', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_11111', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'user_example', 'maxLength' => 64],
],
[
'name' => 'ApplicationUsername',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application account name.', 'type' => 'string', 'required' => true, 'example' => 'zhangsan', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ApplicationAccountId' => ['title' => '', 'description' => 'The application account ID.', 'type' => 'string', 'example' => 'aac_m6z7awz5kresi2ezgajsbkxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Add an application account for a specified employee under the current application',
'summary' => 'Adds an application account for a specified employee under the current application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AddApplicationAccountToUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationaccount/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationAccountId\\": \\"aac_m6z7awz5kresi2ezgajsbkxxxx\\"\\n}","type":"json"}]',
],
'AddApplicationToAuthorizationRule' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'title' => ''],
],
[
'name' => 'ValidityType',
'in' => 'query',
'schema' => ['description' => 'The validity period type. Valid values:'."\n"
."\n"
.'- permanent: The authorization is permanent.'."\n"
."\n"
.'- time\\_bound: The authorization is valid for a custom time range.', 'type' => 'string', 'required' => true, 'example' => 'permanent', 'maxLength' => 32, 'title' => ''],
],
[
'name' => 'ValidityPeriod',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The time range of the validity period. This parameter is valid only when you set **ValidityType** to **time\\_bound**.',
'type' => 'object',
'properties' => [
'StartTime' => ['description' => 'The start time of the validity period. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000', 'maxLength' => 64, 'title' => '', 'required' => false],
'EndTime' => ['description' => 'The end time of the validity period. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704062061000', 'maxLength' => 64, 'title' => '', 'required' => false],
],
'example' => '',
'title' => '',
'required' => false,
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'A client token used to ensure the idempotence of the request. Generate a value from your client to make sure that the value is unique among different requests. The client token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'AddApplicationToAuthorizationRule',
'summary' => 'Adds an application to an authorization rule.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AddApplicationToAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'AddCustomPrivacyPoliciesToBrand' => [
'summary' => 'Adds terms to a brand.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasLY3IT7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'BrandId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The brand ID.', 'type' => 'string', 'required' => true, 'example' => 'brand_xxxxx'],
],
[
'name' => 'CustomPrivacyPolicyIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of term IDs.',
'type' => 'array',
'items' => ['description' => 'The term ID.', 'type' => 'string', 'required' => false, 'example' => 'pp_xxxxx', 'title' => ''],
'required' => true,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Add custom terms to a brand',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:AddCustomPrivacyPoliciesToBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#PolicyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'AddGroupToAuthorizationRule' => [
'summary' => 'Adds a group to an authorization rule.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The group ID.', 'type' => 'string', 'required' => true, 'example' => 'group_miu8e4t4d7i4u7uwezgr54xxxx'],
],
[
'name' => 'ValidityType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The validity type of the relationship. Valid values:'."\n"
.'- permanent: permanent'."\n"
.'- time_bound: custom time range.', 'type' => 'string', 'required' => true, 'example' => 'permanent', 'maxLength' => 32],
],
[
'name' => 'ValidityPeriod',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The time range of the validity period. This parameter takes effect only when **ValidityType** is set to **time_bound**.',
'type' => 'object',
'properties' => [
'StartTime' => ['title' => '', 'description' => 'The start time of the validity period. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000', 'maxLength' => 64, 'required' => false],
'EndTime' => ['title' => '', 'description' => 'The end time of the validity period. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704062061000', 'maxLength' => 64, 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but you must make sure that the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Add a group to an authorization rule',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AddGroupToAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'AddUserToAuthorizationRule' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 64],
],
[
'name' => 'ValidityType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The validity type of the relationship. Valid values:'."\n"
.'- permanent: permanent'."\n"
.'- time_bound: custom time range.', 'type' => 'string', 'required' => true, 'example' => 'permanent', 'maxLength' => 32],
],
[
'name' => 'ValidityPeriod',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The time range of the validity period. This parameter takes effect only when **ValidityType** is set to **time_bound**.',
'type' => 'object',
'properties' => [
'StartTime' => ['title' => '', 'description' => 'The start time of the validity period. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000', 'maxLength' => 64, 'required' => false],
'EndTime' => ['title' => '', 'description' => 'The end time of the validity period. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704062061000', 'maxLength' => 64, 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but make sure that the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Add an account to an authorization rule',
'summary' => 'Adds an account to an authorization rule.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AddUserToAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'AddUserToOrganizationalUnits' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYZ4AR1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of organization IDs. The list can contain up to 100 elements.',
'type' => 'array',
'items' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'title' => ''],
'required' => true,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Add an EIAM account to multiple EIAM organizations',
'summary' => 'Adds a specified EIAM account to multiple EIAM organizations. If the account already exists in an organization, the operation returns a success response directly.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUserToOrganizationalUnits'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'AddUsersToGroup' => [
'summary' => 'Adds multiple Employee Identity and Access Management (EIAM) accounts to a specified EIAM account group.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasXM4LQ1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The group ID.', 'type' => 'string', 'required' => true, 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
],
[
'name' => 'UserIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of account IDs. The list can contain up to 100 elements.',
'type' => 'array',
'items' => ['description' => 'The account ID.', 'type' => 'string', 'required' => false, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'title' => ''],
'required' => true,
'example' => '[ou_001]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Add multiple EIAM accounts to a specified EIAM account group',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUsersToGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'AuthorizeApplicationToGroups' => [
'summary' => 'Grants multiple EIAM groups access to an application in a batch.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas7VNWU7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk2676xxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'GroupIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of group IDs. You can specify up to 100 group IDs in a single request.',
'type' => 'array',
'items' => ['description' => 'The group ID.', 'type' => 'string', 'required' => false, 'example' => 'group_miu8e4t4d7i4u7uwezgr54xxxx', 'title' => ''],
'required' => true,
'example' => 'group_miu8e4t4d7i4u7uwezgr54xxxx',
],
],
[
'name' => 'ApplicationRoleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application role ID.', 'type' => 'string', 'example' => 'app_role_mkv7rgt4ds8d8v0qtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Grant multiple EIAM groups access to an application',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AuthorizeApplicationToGroups'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AuthorizeApplicationToGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'AuthorizeApplicationToOrganizationalUnits' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas3S4NKL'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk2676xxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'OrganizationalUnitIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of organization IDs. You can specify a maximum of 100 organization IDs per operation.',
'type' => 'array',
'items' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'title' => ''],
'required' => true,
'example' => 'ou_wovwffm62xifdziem7an7xxxxx',
],
],
[
'name' => 'ApplicationRoleId',
'in' => 'query',
'schema' => ['description' => '应用角色ID。', 'type' => 'string', 'example' => 'app_role_mkv7rgt4ds8d8v0qtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'AuthorizeApplicationToOrganizationalUnits',
'summary' => 'Grants access to an application for multiple EIAM organizations in a batch operation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AuthorizeApplicationToOrganizationalUnits'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AuthorizeApplicationToOrganizationalUnits',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'AuthorizeApplicationToUsers' => [
'summary' => 'Grants multiple EIAM accounts access to an application in a batch.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk2676xxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'UserIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of account IDs. You can specify up to 100 account IDs in a single request.',
'type' => 'array',
'items' => ['description' => 'The account ID.', 'type' => 'string', 'required' => false, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'title' => ''],
'required' => true,
'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx',
],
],
[
'name' => 'ApplicationRoleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application role ID.', 'type' => 'string', 'example' => 'app_role_mkv7rgt4ds8d8v0qtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Grant multiple EIAM accounts access to an application',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AuthorizeApplicationToUsers'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:AuthorizeApplicationToUsers',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'AuthorizeResourceServerScopesToClient' => [
'summary' => 'Grants Scope permissions under a specified ResourceServer to a Client application.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The unique identifier of the Client application.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ResourceServerApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The unique identifier of the ResourceServer application.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ResourceServerScopeIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of Scope permission IDs under the ResourceServer.',
'type' => 'array',
'items' => ['description' => 'The Scope permission ID.', 'type' => 'string', 'required' => false, 'example' => 'ress_neg35flu6byysxwutaxu3dxxxx', 'title' => ''],
'required' => true,
'example' => '["ress_XXXXX","ress_XXXXX"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Grant scope permissions under a specified resourceServer to a client application',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AuthorizeResourceServerScopesToClient',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'AuthorizeResourceServerScopesToGroup' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The group ID.', 'type' => 'string', 'required' => true, 'example' => 'group_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID of the ResourceServer.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ResourceServerScopeIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of Scope permission IDs under the ResourceServer.',
'type' => 'array',
'items' => ['description' => 'The Scope permission ID.', 'type' => 'string', 'required' => false, 'example' => 'ress_neg35flu6byysxwutaxu3dxxxx', 'title' => ''],
'required' => true,
'example' => '["ress_XXXXX","ress_XXXXX"]',
'maxItems' => 100,
'minItems' => 1,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Grant scope permissions under a specified resourceServer to a group',
'summary' => 'Grants Scope permissions under a specified ResourceServer to a group.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AuthorizeResourceServerScopesToGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'AuthorizeResourceServerScopesToOrganizationalUnit' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The organizational unit ID.', 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID of the ResourceServer.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ResourceServerScopeIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of scope permission IDs under the ResourceServer.',
'type' => 'array',
'items' => ['description' => 'The scope permission ID.', 'type' => 'string', 'required' => false, 'example' => 'ress_neg35flu6byysxwutaxu3dxxxx', 'title' => ''],
'required' => true,
'example' => '["ress_XXXXX","ress_XXXXX"]',
'maxItems' => 100,
'minItems' => 1,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References: [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Grant scope permissions under a specified resourceServer to an organizational unit',
'summary' => 'Grants scope permissions under a specified ResourceServer to an organizational unit.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AuthorizeResourceServerScopesToOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/{#OrganizationalUnitId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'AuthorizeResourceServerScopesToUser' => [
'summary' => 'Grants Scope permissions under a specified ResourceServer to an account.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'required' => true, 'example' => 'user_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID of the ResourceServer.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ResourceServerScopeIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of Scope permission IDs under the ResourceServer.',
'type' => 'array',
'items' => ['description' => 'The Scope permission ID.', 'type' => 'string', 'required' => false, 'example' => 'ress_neg35flu6byysxwutaxu3dxxxx', 'title' => ''],
'required' => true,
'example' => '["ress_XXXXX","ress_XXXXX"]',
'maxItems' => 100,
'minItems' => 1,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References: [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Grant scope permissions under a specified resourceServer to an account',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AuthorizeResourceServerScopesToUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'AuthorizeResourceServerToClient' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The unique identifier of the Client application.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ResourceServerApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the ResourceServer application.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Authorize a specified resourceServer for a client application',
'summary' => 'Authorizes a specified ResourceServer for a Client application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:AuthorizeResourceServerToClient',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'BindUserAuthnSourceMapping' => [
'summary' => 'Associates a third-party logon account.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'user_fherbdywxxxx', 'maxLength' => 64],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The source IdP ID.', 'type' => 'string', 'required' => true, 'example' => 'idp_mwpcwnhrimlr2horxXXXX', 'maxLength' => 64],
],
[
'name' => 'UserExternalId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The external association ID.', 'type' => 'string', 'required' => true, 'example' => 'xxxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Associate a third-party logon account',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:BindUserAuthnSourceMapping',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'CheckApplicationProvisioningUserPrimaryOrganizationalUnit' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasT4AEDM'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'UserPrimaryOrganizationalUnitId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The organization ID.', 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'CheckApplicationProvisioningUserPrimaryOuResult' => [
'description' => 'The authorization information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'AllowAuthorization' => ['title' => '', 'description' => 'Indicates whether authorization is allowed.', 'type' => 'boolean', 'example' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Check whether the primary organization for application synchronization is within the application synchronization scope',
'summary' => 'Checks whether the primary organization for application synchronization is within the application synchronization scope.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'eiam:CheckApplicationProvisioningUserPrimaryOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"CheckApplicationProvisioningUserPrimaryOuResult\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"AllowAuthorization\\": false\\n }\\n}","type":"json"}]',
],
'CheckInstanceForDelete' => [
'summary' => 'Checks whether an instance can be deleted.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6GKEFM'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'CheckInstanceResult' => [
'description' => 'The check result.',
'type' => 'object',
'properties' => [
'Deletable' => ['title' => '', 'description' => 'Indicates whether the instance can be deleted.', 'type' => 'boolean', 'example' => 'True'],
'RestrictScenarios' => [
'title' => '',
'description' => 'The restriction information for instances that cannot be deleted.',
'type' => 'array',
'items' => [
'description' => 'The restriction information for instances that cannot be deleted.',
'type' => 'object',
'properties' => [
'ResourceId' => ['title' => '', 'description' => 'The resource ID.', 'type' => 'string', 'example' => 'eas-r-nguosqgr75ndg784k8'],
'HelpfulConsoleUrl' => ['title' => '', 'description' => 'The console URL that provides helpful information.', 'type' => 'string', 'example' => 'https://console-rpa.aliyun.com/'],
'RestrictReason' => ['title' => '', 'description' => 'The restriction reason.', 'type' => 'string', 'example' => 'cloud_product_dependency'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Check instance deletion',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:CheckInstanceForDelete',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"CheckInstanceResult\\": {\\n \\"Deletable\\": true,\\n \\"RestrictScenarios\\": [\\n {\\n \\"ResourceId\\": \\"eas-r-nguosqgr75ndg784k8\\",\\n \\"HelpfulConsoleUrl\\": \\"https://console-rpa.aliyun.com/\\",\\n \\"RestrictReason\\": \\"cloud_product_dependency\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'CheckInstanceModuleStatus' => [
'summary' => 'Determines whether an instance has the feature of a specific module.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '157983',
'abilityTreeNodes' => ['FEATUREidaas6GKEFM'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ModuleKey',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The primary module identifier.', 'type' => 'string', 'required' => true, 'example' => 'urn:alibaba:idaas:license:module:ud', 'maxLength' => 128],
],
[
'name' => 'FeatureKey',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The secondary module identifier.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:license:module:ud:customField', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'SubFeatureKey',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The tertiary module identifier.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:license:module:idp:alibaba:dingtalk:pull:advanced_configuration', 'maxLength' => 128, 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'Module' => [
'description' => 'The module status information.',
'type' => 'object',
'properties' => [
'ModuleStatus' => [
'title' => '',
'description' => 'The module status.',
'enumValueTitles' => ['disabled' => 'Disabled.', 'enabled' => 'Enabled.'],
'type' => 'string',
'example' => 'enabled',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Determine whether an instance has a specific module feature',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:CheckInstanceModuleStatus',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Module\\": {\\n \\"ModuleStatus\\": \\"enabled\\"\\n }\\n}","type":"json"}]',
],
'CreateApplication' => [
'summary' => 'Creates an application resource in a specified EIAM instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasJXI2A5'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk2676xxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'Ram Account SSO', 'maxLength' => 64],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application description.', 'type' => 'string', 'example' => 'RAM account SSO application', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'LogoUrl',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The URL of the application logo.', 'type' => 'string', 'example' => 'https://oss.cn-hangzhou.aliyuncs.com/logo.png', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'ApplicationSourceType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The source from which the application is created. Valid values:'."\n"
.'- urn:alibaba:idaas:app:source:template: application template.'."\n"
.'- urn:alibaba:idaas:app:source:standard: standard protocol.', 'type' => 'string', 'required' => true, 'example' => 'urn:alibaba:idaas:app:source:standard', 'maxLength' => 64],
],
[
'name' => 'SsoType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The single sign-on protocol. Valid values:'."\n"
.'- saml2: SAML 2.0 protocol.'."\n"
.'- oidc: OpenID Connect protocol.',
'enumValueTitles' => ['saml2' => 'SAML 2.0 protocol.', 'oidc' => 'OpenID Connect protocol.'],
'type' => 'string',
'required' => true,
'example' => 'saml2',
'maxLength' => 64,
],
],
[
'name' => 'ApplicationTemplateId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application template ID. This parameter is required when ApplicationSourceType is set to urn:alibaba:idaas:app:source:template.', 'type' => 'string', 'example' => 'apt_ramuser_mjqrsi', 'required' => false],
],
[
'name' => 'ApplicationIdentityType',
'in' => 'query',
'schema' => [
'description' => 'The application identity type. Default value: application. Valid values:'."\n"
.'- application: application.'."\n"
.'- agent: agent.',
'type' => 'string',
'example' => 'application',
'default' => 'application',
'enum' => ['agent', 'application'],
'required' => false,
'title' => '',
],
],
[
'name' => 'CustomFields',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FieldName' => ['type' => 'string', 'maxLength' => 64, 'description' => '', 'title' => '', 'example' => ''],
'FieldValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'maxItems' => 200,
'description' => '',
'title' => '',
'example' => '',
],
],
[
'name' => 'ApplicationOwner',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'object',
'properties' => [
'UserIds' => [
'type' => 'array',
'items' => ['type' => 'string', 'maxLength' => 64, 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
'GroupIds' => [
'type' => 'array',
'items' => ['type' => 'string', 'maxLength' => 64, 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2xxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create an EIAM application',
'description' => 'EIAM supports two standard SSO protocols for application access: SAML 2.0 and OIDC. This parameter cannot be changed after it is specified. Create the application based on the SSO protocol type used in your business scenario.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApplication'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2xxxx\\"\\n}","type":"json"}]',
],
'CreateApplicationClientSecret' => [
'summary' => 'Creates a client secret for an EIAM application. You can create a maximum of two client secrets for each EIAM application.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasJH3YY9'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ExpirationTime',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The expiration time in UNIX timestamp format, in milliseconds. If this parameter is left empty, the client secret is permanently valid. The minimum validity period that you can set is 1 day, and the maximum validity period is 3 years.', 'type' => 'integer', 'format' => 'int64', 'example' => '1735530123762', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ApplicationClientSecret' => [
'description' => 'The client secret information.',
'type' => 'object',
'properties' => [
'ClientId' => ['title' => '', 'description' => 'The client ID of the application.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'SecretId' => ['title' => '', 'description' => 'The client secret ID of the application.', 'type' => 'string', 'example' => ' sci_k52x2ru63rlkflina5utgkxxxx'],
'ClientSecret' => ['title' => '', 'description' => 'The client secret of the application.', 'type' => 'string', 'example' => 'CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create a client secret for an EIAM application',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApplicationClientSecret'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateApplicationClientSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationClientSecret\\": {\\n \\"ClientId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"SecretId\\": \\" sci_k52x2ru63rlkflina5utgkxxxx\\",\\n \\"ClientSecret\\": \\"CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx\\"\\n }\\n}","type":"json"}]',
],
'CreateApplicationFederatedCredential' => [
'summary' => 'Creates an application federated identity credential.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'FederatedCredentialProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The federated credential provider ID.', 'type' => 'string', 'required' => true, 'example' => 'fcp_adasd', 'maxLength' => 64],
],
[
'name' => 'ApplicationFederatedCredentialType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The type of the application federated identity credential.', 'type' => 'string', 'required' => true, 'example' => 'oidc', 'maxLength' => 64],
],
[
'name' => 'ApplicationFederatedCredentialName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The name of the application federated identity credential.', 'type' => 'string', 'required' => true, 'example' => 'example_name', 'maxLength' => 64],
],
[
'name' => 'VerificationCondition',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The verification condition.', 'type' => 'string', 'example' => 'IsNullOrEmpty("jwt.issuer")', 'required' => false],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'description_text', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'AttributeMappings',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The attribute mappings.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SourceValueExpression' => ['title' => '', 'description' => 'The source value expression.', 'type' => 'string', 'example' => 'Append(client.applicationFederatedCredentialId, ":", cert.subject.CN, ":", cert.serialNumber)', 'required' => false],
'TargetField' => ['title' => '', 'description' => 'The target field.', 'type' => 'string', 'example' => 'client.activeSubjectUrn', 'required' => false],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
[
'name' => 'VerificationMode',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The verification mode. Valid values:'."\n"
."\n"
.'- freedom (default)'."\n"
.'- structured', 'type' => 'string', 'example' => 'freedom', 'maxLength' => 32],
],
[
'name' => 'OidcVerificationConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The OIDC structured configuration. This parameter applies when the verification mode is structured and the credential type is oidc.',
'type' => 'object',
'properties' => [
'Profile' => ['title' => '', 'description' => 'The OIDC scenario profile. Valid values:'."\n"
."\n"
.'- generic'."\n"
.'- kubernetes'."\n"
.'- gcp_vm'."\n"
.'- azure_vm', 'type' => 'string', 'example' => 'kubernetes', 'maxLength' => 32],
'KubernetesConfig' => [
'title' => '',
'description' => 'The Kubernetes scenario configuration.',
'type' => 'object',
'properties' => [
'Namespace' => ['title' => '', 'description' => 'The Kubernetes namespace.', 'type' => 'string', 'example' => 'default', 'maxLength' => 128],
'ServiceAccountName' => ['title' => '', 'description' => 'The Kubernetes service account name.', 'type' => 'string', 'example' => 'my-sa', 'maxLength' => 128],
'PodNamePrefix' => ['title' => '', 'description' => 'The pod name prefix.', 'type' => 'string', 'example' => 'my-pod-', 'maxLength' => 128],
],
'example' => '',
],
'GcpVmConfig' => [
'title' => '',
'description' => 'The GCP VM scenario configuration.',
'type' => 'object',
'properties' => [
'ServiceAccountId' => ['title' => '', 'description' => 'The sub claim that corresponds to the service account.', 'type' => 'string', 'example' => '123456789', 'maxLength' => 128],
'InstanceIds' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
'ProjectId' => ['type' => 'string', 'maxLength' => 128, 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
'AzureVmConfig' => [
'title' => '',
'description' => 'The Azure VM scenario configuration.',
'type' => 'object',
'properties' => [
'ResourceGroupName' => ['type' => 'string', 'maxLength' => 128, 'description' => '', 'title' => '', 'example' => ''],
'VmNames' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
'SubscriptionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'PrincipalId' => ['type' => 'string', 'maxLength' => 128, 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
'GenericConfig' => [
'type' => 'object',
'properties' => [
'Subject' => ['type' => 'string', 'maxLength' => 128, 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
[
'name' => 'Pkcs7VerificationConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The PKCS#7 structured configuration. This parameter applies when the verification mode is structured and the credential type is pkcs7.',
'type' => 'object',
'properties' => [
'InstanceIds' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ApplicationFederatedCredentialId' => ['title' => '', 'description' => 'The application federated identity credential ID.', 'type' => 'string', 'example' => 'afc_asd123daxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create an application federated identity credential',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateApplicationFederatedCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationFederatedCredentialId\\": \\"afc_asd123daxxxx\\"\\n}","type":"json"}]',
],
'CreateApplicationRole' => [
'summary' => 'Creates an application role.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationRoleName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application role name.', 'type' => 'string', 'required' => true, 'example' => 'Admin Role', 'maxLength' => 64],
],
[
'name' => 'ApplicationRoleValue',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application role value.', 'type' => 'string', 'required' => true, 'example' => 'admin_role', 'maxLength' => 64],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but you must make sure that the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References: [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ApplicationRoleId' => ['title' => '', 'description' => 'The application role ID.', 'type' => 'string', 'example' => 'approle_01kghbvoptu5262q35aalvq7cxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create an application role',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateApplicationRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationrole/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationRoleId\\": \\"approle_01kghbvoptu5262q35aalvq7cxxxx\\"\\n}","type":"json"}]',
],
'CreateApplicationToken' => [
'summary' => 'Creates an application token.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasSQHOGI'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationTokenType',
'in' => 'query',
'schema' => ['description' => 'The application token type.', 'type' => 'string', 'required' => true, 'example' => 'bearer_token', 'maxLength' => 128, 'title' => ''],
],
[
'name' => 'ExpirationTime',
'in' => 'query',
'schema' => ['description' => 'The expiration time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1735530123762', 'maxLength' => 128, 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'ApplicationTokens' => [
'type' => 'object',
'properties' => [
'ApplicationTokenId' => ['description' => 'The application token ID.', 'type' => 'string', 'title' => '', 'example' => 'token_ndfxxigahelfne2y2hodehrxxxx'],
'ApplicationToken' => ['description' => 'The application token.', 'type' => 'string', 'title' => '', 'example' => 'SATFwqX8zxGf83pJcJw78KFGjmrft4erWeZYBGS8oE7NN6qoE217yaJpUdMb1UuuGqhDiF43sCA4CF91CTL5iGntqwyLuaAcS9FJ9HfGadE5a7TjiwVafwrBYkt3XXX'],
'ApplicationTokenType' => ['description' => 'The application token type.', 'type' => 'string', 'title' => '', 'example' => 'bearer_token'],
],
'description' => 'The application token.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'CreateApplicationToken',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateApplicationToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationTokens\\": {\\n \\"ApplicationTokenId\\": \\"token_ndfxxigahelfne2y2hodehrxxxx\\",\\n \\"ApplicationToken\\": \\"SATFwqX8zxGf83pJcJw78KFGjmrft4erWeZYBGS8oE7NN6qoE217yaJpUdMb1UuuGqhDiF43sCA4CF91CTL5iGntqwyLuaAcS9FJ9HfGadE5a7TjiwVafwrBYkt3XXX\\",\\n \\"ApplicationTokenType\\": \\"bearer_token\\"\\n }\\n}","type":"json"}]',
],
'CreateAuthorizationResource' => [
'summary' => 'Creates an authorization resource.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationResourceEntityType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The type of the resource entity associated with the authorization resource. Valid values:'."\n"
.'- cloud_account_role: cloud role.', 'type' => 'string', 'required' => true, 'example' => 'cloud_account_role', 'maxLength' => 32],
],
[
'name' => 'AuthorizationResourceEntityId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the resource entity associated with the authorization resource.', 'type' => 'string', 'required' => true, 'example' => 'carole_01kmek49aqxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'AuthorizationResourceId' => ['title' => '', 'description' => 'The authorization resource ID.', 'type' => 'string', 'example' => 'arres_01kgh3jvt7pk093rv6giu0c0qxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create an authorization resource',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateAuthorizationResource',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationResource', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}/authorizationresource/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"AuthorizationResourceId\\": \\"arres_01kgh3jvt7pk093rv6giu0c0qxxxx\\"\\n}","type":"json"}]',
],
'CreateAuthorizationRule' => [
'summary' => 'Creates an authorization rule.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationRuleName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The name of the authorization rule. The name can be up to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'test_rule', 'maxLength' => 64],
],
[
'name' => 'ProjectId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the project associated with the authorization rule. If you are unsure which project to associate, you can associate the default project. The default project ID is iprj_system_default.', 'type' => 'string', 'required' => true, 'example' => 'iprj_system_default', 'maxLength' => 64],
],
[
'name' => 'AuthorizationResourceScope',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The scope of authorized resources. Valid values:'."\n"
.'- global: all resources under the project.'."\n"
.'- custom: specified resources under the project.', 'type' => 'string', 'example' => 'global', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description of the authorization rule. The description can be up to 128 characters in length.', 'type' => 'string', 'example' => 'this is a test rule', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References: [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'AuthorizationRuleId' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create an authorization rule',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"AuthorizationRuleId\\": \\"arrule_01kf143ug06fg7m9f43u7vahxxxx\\"\\n}","type":"json"}]',
],
'CreateBrand' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCPBRTZ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'BrandName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The brand name.', 'type' => 'string', 'required' => true, 'example' => 'Custom Brand', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'BrandId' => ['title' => '', 'description' => 'The brand ID.', 'type' => 'string', 'example' => 'brand_xxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create a brand',
'summary' => 'Creates a brand.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"BrandId\\": \\"brand_xxxx\\"\\n}","type":"json"}]',
],
'CreateClientPublicKey' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'PublicKey',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The public key in PEM format. The key must be of the SPKI type, starting with "-----BEGIN PUBLIC KEY-----" and ending with "-----END PUBLIC KEY-----".',
'enumValueTitles' => [],
'type' => 'string',
'required' => true,
'example' => '-----BEGIN PUBLIC KEY-----'."\n"
.'MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmnWMdp9FU3vXljeIqpgR'."\n"
.'05E6jEgzIfKsFaLkv+07e2Lg8luTaJh8Q2nkbxdNpTfqBnMMyTgml88WktP45F78'."\n"
.'La7hQtR3vz0Eu1yA92gXwD5Oob7ay4JYQZ0C80o2tB3FsbXG2jUvr31MNkf/0oBY'."\n"
.'qUKK5Hnlk1TdrnZ5VkzgLGHKlj+NJHHF/57DbT64C2qpAWeKHAr9umJ8++0hKqG/'."\n"
.'oRSOpb7oWK4t5c39ulp1j5JJ6cwqrKVCXvsHfWHywOHkcyus+ZNPTQvpwjRnEmRz'."\n"
.'Vy3NWrjT7JlIa8vS1aUU+FxeFd2MLQzxFxquFLwi05su2faRexaeYwWW6IWAI3tX'."\n"
.'twxxxxxx'."\n"
.'-----END PUBLIC KEY-----',
],
],
[
'name' => 'AlgorithmType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The algorithm type.',
'enumValueTitles' => ['RSA-2048' => 'RSA-2048'],
'type' => 'string',
'required' => true,
'example' => 'RSA-2048',
'maxLength' => 64,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References: [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ClientPublicKeyId' => ['title' => '', 'description' => 'The ID of the application ClientPublicKey.', 'type' => 'string', 'example' => 'KEYCKmEYW9byWTdjuRbmCjd2Bhg6VpkAxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create an application clientPublicKey',
'summary' => 'Creates a ClientPublicKey for an application. When an M2M client uses the PRIVATE_KEY_JWT method to request the token endpoint, this public key is used by the M2M authorization server to verify the assertion carried in the client\'s token endpoint request.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'eiam:CreateClientPublicKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ClientPublicKeyId\\": \\"KEYCKmEYW9byWTdjuRbmCjd2Bhg6VpkAxxxx\\"\\n}","type":"json"}]',
],
'CreateCloudAccount' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'CloudAccountName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The cloud account name.', 'type' => 'string', 'example' => 'cloud_accout_xxxx', 'maxLength' => 64, 'required' => false],
],
[
'name' => 'CloudAccountVendorType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The cloud account type. Valid values:'."\n"
."\n"
.'- alibaba_cloud: Alibaba Cloud.',
'enumValueTitles' => ['alibaba_cloud' => 'alibaba_cloud'],
'type' => 'string',
'required' => true,
'example' => 'Alibaba_cloud(Alibaba Cloud)',
'maxLength' => 32,
'enum' => ['alibaba_cloud', 'aws', 'entra_id', 'huawei_cloud', 'tencent_cloud', 'gcp', 'azure'],
],
],
[
'name' => 'CloudAccountExternalId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The external unique identifier of the cloud account.', 'type' => 'string', 'required' => true, 'example' => '1234567', 'maxLength' => 64],
],
[
'name' => 'CloudAccountProviderName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The identity provider name.', 'type' => 'string', 'example' => 'idaas-eiam-oidc-provider', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description of the cloud account.', 'type' => 'string', 'example' => 'cloud_accout_description', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but you must make sure that the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'example' => 'client-token-example', 'title' => ''],
],
[
'name' => 'CloudAccountSite',
'in' => 'query',
'schema' => ['description' => 'The cloud account site. Valid values:'."\n"
."\n"
.'- global: international site.'."\n"
.'- china_mainland: China site.', 'type' => 'string', 'maxLength' => 32, 'required' => false, 'example' => 'china_mainland', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'CloudAccountId' => ['title' => '', 'description' => 'The cloud account ID.', 'type' => 'string', 'example' => 'ca_01kmegjc11qa1txxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create a cloud account',
'summary' => 'Creates a cloud account resource in a specified EIAM instance.',
'description' => '**Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://www.aliyun.com/price/product#/ecs/detail) of IDaaS EIAM.**',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateCloudAccount',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"CloudAccountId\\": \\"ca_01kmegjc11qa1txxxxx\\"\\n}","type":"json"}]',
],
'CreateCloudAccountRole' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CloudAccountId',
'in' => 'query',
'schema' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'required' => true, 'example' => 'ca_01kmegjc11qa1txxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CloudAccountRoleType',
'in' => 'query',
'schema' => [
'description' => 'The type of the cloud role. The format of this parameter depends on the type of the Alibaba Cloud account. The supported value is:'."\n"
."\n"
.'- role: applies to Alibaba Cloud accounts.',
'enumValueTitles' => ['role' => 'role'],
'type' => 'string',
'example' => 'role',
'maxLength' => 64,
'enum' => ['role', 'huawei_cloud_group', 'entra_id_app', 'gcp_iam_principal', 'gcp_service_account'],
'title' => '',
'required' => false,
],
],
[
'name' => 'CloudAccountRoleName',
'in' => 'query',
'schema' => ['description' => 'The name of the cloud role.', 'type' => 'string', 'required' => true, 'example' => 'role-test', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token used to ensure the idempotence of the request. Generate a unique value for this parameter from your client. The token can contain only ASCII characters and must be no more than 64 characters in length. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'example' => 'client-token-example', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the cloud role.', 'type' => 'string', 'required' => false, 'example' => 'cloud_account_role_description', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'CloudAccountRoleId' => ['description' => 'The ID of the cloud role.', 'type' => 'string', 'example' => 'carole_01kmek49aqxxxx', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'CreateCloudAccountRole',
'summary' => 'Creates a cloud role for a specified Alibaba Cloud account.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateCloudAccountRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}/cloudaccountrole/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"CloudAccountRoleId\\": \\"carole_01kmek49aqxxxx\\"\\n}","type":"json"}]',
],
'CreateConditionalAccessPolicy' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231632',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ConditionalAccessPolicyName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Conditional access policy name.', 'type' => 'string', 'required' => true, 'example' => 'My conditional access policy', 'maxLength' => 64],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Conditional access policy description.', 'type' => 'string', 'example' => 'Test description', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'ConditionalAccessPolicyType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'Conditional access policy type. Valid values:'."\n"
."\n"
.'arn:alibaba:idaas:authn:access:policy:system: system policy.',
'enumValueTitles' => ['arn:alibaba:idaas:authn:access:policy:system' => 'arn:alibaba:idaas:authn:access:policy:system'],
'type' => 'string',
'required' => true,
'example' => 'arn:alibaba:idaas:authn:access:policy:system',
'maxLength' => 64,
],
],
[
'name' => 'DecisionType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'Conditional access policy execution type. Valid values:'."\n"
."\n"
.'enforcement: enforcement policy.',
'enumValueTitles' => ['enforcement' => 'enforcement'],
'type' => 'string',
'required' => true,
'example' => 'enforcement',
'maxLength' => 32,
],
],
[
'name' => 'EvaluateAt',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'Conditional access policy evaluation point. Valid values:'."\n"
."\n"
.'- arn:alibaba:idaas:authn:access:rule:eval_at:after_step1: allow.',
'enumValueTitles' => ['arn:alibaba:idaas:authn:access:rule:eval_at:after_step1' => 'arn:alibaba:idaas:authn:access:rule:eval_at:after_step1'],
'type' => 'string',
'required' => true,
'example' => 'arn:alibaba:idaas:authn:access:rule:eval_at:after_step1',
'maxLength' => 64,
],
],
[
'name' => 'DecisionConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Conditional access policy action configuration.',
'type' => 'object',
'properties' => [
'Effect' => [
'title' => '',
'description' => 'Conditional access policy decision action. Valid values:'."\n"
."\n"
.'- allow: allow.'."\n"
.'- deny: deny.',
'enumValueTitles' => ['allow' => 'allow', 'deny' => 'deny'],
'type' => 'string',
'example' => 'allow or deny',
'required' => false,
],
'MfaType' => [
'title' => '',
'description' => 'Conditional access policy MFA type. Valid values:'."\n"
."\n"
.'- directly_access: direct access.'."\n"
.'- mfa_required: MFA required.',
'enumValueTitles' => ['directly_access' => 'directly_access', 'mfa_required' => 'mfa_required'],
'type' => 'string',
'example' => 'directly_access',
'required' => false,
],
'MfaAuthenticationIntervalSeconds' => ['title' => '', 'description' => 'Conditional access policy re-authentication interval (seconds).'."\n"
."\n"
.'- Maximum MFA authentication interval: 86400.'."\n"
.'- Minimum MFA authentication interval: 300.', 'type' => 'integer', 'format' => 'int64', 'example' => '500', 'required' => false],
'MfaAuthenticationMethods' => [
'title' => '',
'description' => 'MFA types allowed by the conditional access policy. Valid values:'."\n"
.'- ia_otp_sms: SMS verification code.'."\n"
.'- ia_otp_email: email verification code.'."\n"
.'- ia_totp: OTP dynamic password.'."\n"
.'- ia_webauthn: WebAuthn.',
'type' => 'array',
'items' => ['description' => 'MFA type.', 'type' => 'string', 'required' => false, 'example' => 'ia_totp', 'title' => ''],
'required' => false,
'enumValueTitles' => ['ia_otp_email' => 'ia_otp_email', 'ia_otp_sms' => 'ia_otp_sms', 'ia_webauthn' => 'ia_webauthn', 'ia_totp' => 'ia_totp'],
'example' => '',
],
'ActiveSessionReuseStatus' => [
'description' => 'Specifies whether to enable session reuse.',
'enumValueTitles' => ['disabled' => 'disabled', 'enabled' => 'enabled'],
'type' => 'string',
'example' => 'enabled',
'required' => false,
'title' => '',
],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'ConditionsConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Conditional access policy condition configuration.',
'type' => 'object',
'properties' => [
'Applications' => [
'title' => '',
'description' => 'Conditional access policy target applications.',
'type' => 'object',
'properties' => [
'IncludeApplications' => [
'title' => '',
'description' => 'Included applications.',
'type' => 'array',
'items' => ['description' => 'Application ID.', 'type' => 'string', 'required' => false, 'example' => 'app_xxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'ExcludeApplications' => [
'title' => '',
'description' => 'Excluded applications.',
'type' => 'array',
'items' => ['description' => 'Application ID.', 'type' => 'string', 'required' => false, 'example' => 'app_xxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
'Users' => [
'title' => '',
'description' => 'Conditional access policy target users.',
'type' => 'object',
'properties' => [
'IncludeUsers' => [
'title' => '',
'description' => 'Included users.',
'type' => 'array',
'items' => ['description' => 'User ID.', 'type' => 'string', 'required' => false, 'example' => 'user_xxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'ExcludeUsers' => [
'title' => '',
'description' => 'Excluded users.',
'type' => 'array',
'items' => ['description' => 'User ID.', 'type' => 'string', 'required' => false, 'example' => 'user_xxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'IncludeGroups' => [
'title' => '',
'description' => 'Included user groups.',
'type' => 'array',
'items' => ['description' => 'Group ID.', 'type' => 'string', 'required' => false, 'example' => 'group_xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'ExcludeGroups' => [
'title' => '',
'description' => 'Excluded user groups.',
'type' => 'array',
'items' => ['description' => 'Group ID.', 'type' => 'string', 'required' => false, 'example' => 'group_xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'IncludeOrganizationalUnits' => [
'title' => '',
'description' => 'Included organizational units.',
'type' => 'array',
'items' => ['description' => 'Organizational unit ID.', 'type' => 'string', 'required' => false, 'example' => 'ou_sdfnbsxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'ExcludeOrganizationalUnits' => [
'title' => '',
'description' => 'Excluded organizational units.',
'type' => 'array',
'items' => ['description' => 'Organizational unit ID.', 'type' => 'string', 'required' => false, 'example' => 'ou_xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
'NetworkZones' => [
'title' => '',
'description' => 'Conditional access policy network zones.',
'type' => 'object',
'properties' => [
'IncludeNetworkZones' => [
'title' => '',
'description' => 'Included network zones.',
'type' => 'array',
'items' => ['description' => 'Network zone ID.', 'type' => 'string', 'required' => false, 'example' => 'network_xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'ExcludeNetworkZones' => [
'title' => '',
'description' => 'Excluded network zones.',
'type' => 'array',
'items' => ['description' => 'Network zone ID.', 'type' => 'string', 'required' => false, 'example' => 'network_xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
'required' => false,
'enumValueTitles' => [],
'example' => '',
],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Conditional access policy priority. A smaller value indicates a higher priority.'."\n"
.'Minimum value: 1.'."\n"
.'Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Idempotency token.', 'type' => 'string', 'example' => 'client-token-example', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ConditionalAccessPolicyId' => ['title' => '', 'description' => 'Conditional access policy ID.', 'type' => 'string', 'example' => 'cp_xxxxx'],
],
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'CreateConditionalAccessPolicy',
'summary' => 'Creates a conditional access policy.',
'description' => 'Creates a conditional access policy.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConditionalAccessPolicy'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateConditionalAccessPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ConditionalAccessPolicyId\\": \\"cp_xxxxx\\"\\n}","type":"json"}]',
],
'CreateCredential' => [
'summary' => 'Creates a credential resource in a specified EIAM instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'CredentialIdentifier',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The credential identifier.', 'type' => 'string', 'required' => true, 'example' => 'credential_identifier_test', 'maxLength' => 64],
],
[
'name' => 'CredentialName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['title' => '', 'description' => 'The credential name.', 'type' => 'string', 'required' => true, 'example' => 'credential_name', 'maxLength' => 64],
],
[
'name' => 'CredentialSubjectType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The subject type of the credential. Valid values:'."\n"
.'- authentication_token_provider: authentication token provider.', 'type' => 'string', 'example' => 'authentication_token_provider', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'CredentialSubjectId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The subject ID of the credential.', 'type' => 'string', 'example' => 'apt_werthgfdsasffxxxxx', 'maxLength' => 64, 'required' => false],
],
[
'name' => 'CredentialScenarioLabel',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The Scenarios label of the credential. Valid values:'."\n"
.'- llm: large language model.'."\n"
.'- saas: third-party SaaS service.',
'type' => 'string',
'example' => 'llm',
'maxLength' => 32,
'enum' => ['llm', 'saas'],
'required' => false,
],
],
[
'name' => 'CredentialType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The credential type. Valid values:'."\n"
.'- api_key: API key authentication credential.'."\n"
.'- oauth_client: OAuth client authentication credential.',
'type' => 'string',
'required' => true,
'example' => 'api_key',
'maxLength' => 32,
'enum' => ['api_key', 'oauth_client'],
],
],
[
'name' => 'CredentialContent',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The credential content.',
'type' => 'object',
'properties' => [
'OAuthClientContent' => [
'title' => '',
'description' => 'The credential content of the OAuth client authentication credential type.',
'type' => 'object',
'properties' => [
'ClientId' => ['title' => '', 'description' => 'The client_id of the OAuth protocol.', 'type' => 'string', 'example' => 'dmvncmxersdxxxxxx', 'required' => false],
'ClientSecret' => ['title' => '', 'description' => 'The client_secret of the OAuth protocol.', 'type' => 'string', 'example' => 'nsklncmwizncxxxx', 'required' => false],
],
'required' => false,
'example' => '',
],
'ApiKeyContent' => [
'title' => '',
'description' => 'The credential content of the API key credential type.',
'type' => 'object',
'properties' => [
'ApiKey' => ['title' => '', 'description' => 'The API key content.', 'type' => 'string', 'example' => 'nsklnertyt5ddwizncxxxx', 'required' => false],
],
'required' => false,
'example' => '',
],
],
'required' => true,
'example' => '',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The credential description.', 'type' => 'string', 'example' => 'credential_description', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The ClientToken parameter supports only ASCII characters and cannot exceed 64 characters in length. For more information, see References: [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'maxLength' => 64],
],
[
'name' => 'CredentialSharingScope',
'in' => 'query',
'schema' => ['title' => '', 'type' => 'string', 'maxLength' => 32, 'description' => '', 'example' => ''],
],
[
'name' => 'ExclusiveUserId',
'in' => 'query',
'schema' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
],
[
'name' => 'CredentialExternalId',
'in' => 'query',
'schema' => ['title' => '', 'type' => 'string', 'maxLength' => 64, 'description' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'CredentialId' => ['title' => '', 'description' => 'The credential ID.', 'type' => 'string', 'example' => 'cred_mkv7rgt4d7i4u7zqtzev2mxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create a credential',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"CredentialId\\": \\"cred_mkv7rgt4d7i4u7zqtzev2mxxxx\\"\\n}","type":"json"}]',
],
'CreateCredentialProvider' => [
'summary' => 'Creates a credential provider.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The idempotency token that ensures the idempotence of the request.'."\n"
."\n"
.'Generate a parameter value from your client to ensure that the value is unique across different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters in length. For more information, see References [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example'],
],
[
'name' => 'CredentialProviderIdentifier',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The business identifier of the credential provider.'."\n"
."\n"
.'> Allowed characters include uppercase and lowercase letters, digits, and the special characters `.-_`. The length cannot exceed 64 characters.', 'type' => 'string', 'required' => true, 'example' => 'test_example_identifier', 'maxLength' => 64],
],
[
'name' => 'CredentialProviderName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The name of the credential provider.'."\n"
."\n"
.'> The length cannot exceed 64 characters.', 'type' => 'string', 'required' => true, 'example' => 'test_example_name', 'maxLength' => 64],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description.'."\n"
."\n"
.'> The length cannot exceed 128 characters.', 'type' => 'string', 'example' => 'This is an example description', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'CredentialProviderType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The type of the credential provider. Valid values:'."\n"
."\n"
.'- oauth: OAuth credential provider'."\n"
.'- jwt: JWT credential provider', 'type' => 'string', 'required' => true, 'example' => 'oauth'],
],
[
'name' => 'CredentialProviderConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The configuration of the credential provider.',
'type' => 'object',
'properties' => [
'OAuthProviderConfig' => [
'title' => '',
'description' => 'The configuration of the OAuth credential provider.',
'type' => 'object',
'properties' => [
'ClientId' => ['title' => '', 'description' => 'The client_id in the OAuth protocol, which is the client ID.'."\n"
."\n"
.'> The length cannot exceed 128 characters.', 'type' => 'string', 'required' => true, 'example' => 'client_id_example_xxx'],
'ClientSecret' => ['title' => '', 'description' => 'The client_secret in the OAuth protocol, which is the client secret.'."\n"
."\n"
.'> The length cannot exceed 1024 characters.', 'type' => 'string', 'required' => true, 'example' => 'client_secret_example_xxx'],
'TokenEndpoint' => ['title' => '', 'description' => 'The token endpoint of the OAuth protocol.'."\n"
."\n"
.'> The value must start with `http://` or `https://`, and the length cannot exceed 1024 characters.', 'type' => 'string', 'required' => true, 'example' => 'https://example.com/token'],
'Scope' => ['title' => '', 'description' => 'The scope in the OAuth protocol, which specifies the permission scope.'."\n"
."\n"
.'> The Scope configuration on the credential provider serves as the default value. If the scope parameter is not specified when calling the DeveloperAPI to obtain an OAuth Access Token, the Scope configuration on the credential provider is used for issuance.'."\n"
."\n"
.'>Separate multiple Scope values with spaces.>'."\n"
."\n"
.'The following restrictions apply to each individual Scope value:'."\n"
.'1. Allowed characters: lowercase letters, digits, and the special characters `|/:_-.`'."\n"
.'2. Must contain at least one lowercase letter or digit.'."\n"
.'3. Must start with the special character `.`, a lowercase letter, or a digit.'."\n"
.'4. The length cannot exceed 1024 characters.', 'type' => 'string', 'example' => 'example:test_01 example:test_02', 'required' => false],
],
'required' => false,
'example' => '',
],
'JwtProviderConfig' => [
'title' => '',
'description' => 'The configuration of the JWT credential provider.',
'type' => 'object',
'properties' => [
'Expiration' => ['title' => '', 'description' => 'The validity period of the JWT. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '900', 'required' => false],
'ExpirationCleanupEnabled' => ['title' => '', 'description' => 'Specifies whether to enable JWT expiration cleanup.', 'type' => 'boolean', 'example' => 'true', 'required' => false],
'DerivedShortTokenEnabled' => ['title' => '', 'description' => 'Specifies whether to enable the JWT derived short token capability.', 'type' => 'boolean', 'example' => 'false', 'required' => false],
'AllowedTokenIssuers' => [
'title' => '',
'description' => 'The list of allowed JWT issuers.'."\n"
."\n"
.'> The list can contain up to 200 entries.',
'type' => 'array',
'items' => ['title' => '', 'description' => 'An allowed JWT issuer.'."\n"
."\n"
.'> The length cannot exceed 1024 characters.', 'type' => 'string', 'example' => 'https://test.issuer.com', 'required' => false],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'CredentialProviderId' => ['title' => '', 'description' => 'The credential provider ID.', 'type' => 'string', 'example' => 'atp_01kr2cmj5gxxx4fvmls2e93dxxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create a credential provider',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"CredentialProviderId\\": \\"atp_01kr2cmj5gxxx4fvmls2e93dxxxxx\\"\\n}","type":"json"}]',
],
'CreateCustomField' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGOSU2H'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'EntityType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The entity to which the field belongs. Valid values:'."\n"
.'- user: account.', 'type' => 'string', 'required' => true, 'example' => 'user', 'maxLength' => 32],
],
[
'name' => 'FieldName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The field identifier.'."\n"
.'Maximum length: 40 characters. The value can contain lowercase letters and underscores, and cannot start with an underscore.', 'type' => 'string', 'required' => true, 'example' => 'field_001'],
],
[
'name' => 'FieldDisplayName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The field display name.'."\n"
.'Maximum length: 64 characters.', 'type' => 'string', 'required' => true, 'example' => 'name_001'],
],
[
'name' => 'FieldDisplayType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The field display type. Valid values:'."\n"
.'- input: text input box. Supported data types: string and number.'."\n"
.'- select: drop-down list. Supported data types: string and boolean.'."\n"
.'- checkbox: multi-select box. Supported data types: string.', 'type' => 'string', 'required' => true, 'example' => 'input', 'maxLength' => 32],
],
[
'name' => 'FieldDataType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The data type of the field. Valid values:'."\n"
.'- string: string.'."\n"
.'- number: number. Maximum length: 32 characters. Positive integers and decimals are supported.'."\n"
.'- boolean: Boolean.', 'type' => 'string', 'required' => true, 'example' => 'string', 'maxLength' => 32],
],
[
'name' => 'DefaultValue',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The default value of the field.'."\n"
.'If configuration items exist for the type, the default value must be one of the configuration items and must be in the enabled state. Maximum length: 1024 characters.', 'type' => 'string', 'example' => 'string', 'required' => false],
],
[
'name' => 'FieldDataConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The field value configuration items.',
'type' => 'object',
'properties' => [
'Items' => [
'title' => '',
'description' => 'The list of field configuration items. Maximum number of items: 100.',
'type' => 'array',
'items' => [
'description' => 'The field configuration item data object.',
'type' => 'object',
'properties' => [
'DisplayName' => ['title' => '', 'description' => 'The display name of the configuration item.'."\n"
.'Maximum length: 128 characters.', 'type' => 'string', 'example' => 'string', 'maxLength' => 128, 'required' => false],
'Value' => ['title' => '', 'description' => 'The display value of the configuration item.'."\n"
.'Maximum length: 64 characters.', 'type' => 'string', 'example' => 'string', 'maxLength' => 128, 'required' => false],
'Status' => ['title' => '', 'description' => 'The status of the configuration item. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.'."\n"
."\n"
.'If a configuration item is disabled, it cannot be used when creating or updating entity field values.', 'type' => 'string', 'example' => 'string', 'maxLength' => 32, 'required' => false],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'example' => 'string',
'maxLength' => 2048,
],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'Unique',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether the field value is unique.'."\n"
.'If this parameter is set to true, the field value must be unique within the corresponding entity type and cannot be duplicated.', 'type' => 'boolean', 'example' => 'false', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'Encrypted',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether to encrypt the field.'."\n"
.'If this parameter is set to true, the data value is encrypted at the storage layer.', 'type' => 'boolean', 'example' => 'false', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'Required',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether the field is required.', 'type' => 'boolean', 'example' => 'false', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'UserPermission',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The field permission on the portal side. Valid values:'."\n"
.'- hide: Not visible on the portal side.'."\n"
.'- read_only: Visible on the portal side but cannot be edited or updated.'."\n"
.'- read_write: Visible and editable on the portal side.', 'type' => 'string', 'example' => 'false', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The field description.'."\n"
.'Maximum length: 512 characters.', 'type' => 'string', 'example' => 'Field test', 'maxLength' => 2048, 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'FieldId' => ['title' => '', 'description' => 'The field ID.', 'type' => 'string', 'example' => 'ufd_001'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create an extended field',
'summary' => 'Creates an extended field.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateCustomField',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomField', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customfield/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"FieldId\\": \\"ufd_001\\"\\n}","type":"json"}]',
],
'CreateCustomPrivacyPolicy' => [
'summary' => 'You can create custom terms.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas4TD7D0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CustomPrivacyPolicyName',
'in' => 'query',
'schema' => ['description' => 'The name of the custom privacy policy.', 'type' => 'string', 'required' => true, 'example' => 'Custom Privacy Policy Name', 'maxLength' => 256, 'title' => ''],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => 'The status of the custom privacy policy.', 'type' => 'string', 'example' => 'enabled', 'title' => '', 'required' => false],
],
[
'name' => 'UserConsentType',
'in' => 'query',
'schema' => [
'description' => 'The consent type for the privacy policy.',
'enumValueTitles' => ['explicit_consent' => 'Users must manually select the checkbox to agree.', 'implied_consent' => 'Users agree by default.'],
'type' => 'string',
'example' => 'implied_consent',
'title' => '',
'required' => false,
],
],
[
'name' => 'DefaultLanguageCode',
'in' => 'query',
'schema' => ['description' => 'The default language of the privacy policy.', 'type' => 'string', 'required' => false, 'example' => 'zh-Hans-CN', 'title' => ''],
],
[
'name' => 'CustomPrivacyPolicyContents',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The details of the custom privacy policy content.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CustomPrivacyPolicyTip' => ['description' => 'The prompt for the custom privacy policy.', 'type' => 'string', 'example' => 'Please read and agree:', 'maxLength' => 256, 'title' => '', 'required' => false],
'LanguageCode' => ['description' => 'The language of the custom privacy policy. The value is the LanguageCode returned by the ListLanguages operation.', 'type' => 'string', 'example' => 'zh-Hans-CN', 'maxLength' => 64, 'title' => '', 'required' => false],
'CustomPrivacyPolicyItems' => [
'description' => 'The items of the custom privacy policy.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CustomPrivacyPolicyItemName' => ['description' => 'The name of the custom privacy policy item.', 'type' => 'string', 'example' => 'Custom Privacy Policy Name', 'title' => '', 'required' => false],
'CustomPrivacyPolicyItemUrl' => ['description' => 'The endpoint of the custom privacy policy item.', 'type' => 'string', 'example' => 'http://www.xxxx.com', 'title' => '', 'required' => false],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
'title' => '',
'required' => false,
],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
'title' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token used to ensure the idempotence of the request. The client generates this value to make sure that it is unique among different requests. The value can be up to 64 ASCII characters in length and cannot contain non-ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'CustomPrivacyPolicyId' => ['description' => 'The ID of the custom privacy policy.', 'type' => 'string', 'title' => '', 'example' => 'pp_neagxpoznsjdtxxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'CreateCustomPrivacyPolicy',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateCustomPrivacyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"CustomPrivacyPolicyId\\": \\"pp_neagxpoznsjdtxxxxx\\"\\n}","type":"json"}]',
],
'CreateDomain' => [
'summary' => 'Creates a custom domain name for an EIAM (Entity and Identity Access Management) instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGK16FE'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => 'The domain name.', 'type' => 'string', 'required' => true, 'example' => 'www.example.com', 'title' => ''],
],
[
'name' => 'Filing',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The parameters for ICP filing information.',
'type' => 'object',
'properties' => [
'IcpNumber' => ['description' => 'The ICP filing number associated with the domain name.', 'type' => 'string', 'example' => 'xICPxxxxxx-xx', 'title' => '', 'required' => false],
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'DomainId' => [
'description' => 'The domain ID.',
'properties' => [],
'type' => 'string',
'title' => '',
'example' => 'dm_mtohn6mltdz3ibtly2rxvnvxxx',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"DomainId\\": \\"dm_mtohn6mltdz3ibtly2rxvnvxxx\\"\\n}","type":"json"}]',
'title' => 'CreateDomain',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDomain'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/*'],
],
],
],
],
],
'CreateDomainProxyToken' => [
'summary' => 'Creates a proxy token for a domain name of an Employee Identity and Access Management (EIAM) instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGK16FE'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'DomainId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The domain name ID.', 'type' => 'string', 'required' => true, 'example' => 'dm_examplexxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'DomainProxyTokenId' => [
'title' => '',
'description' => 'The domain proxy token ID.',
'properties' => [],
'type' => 'string',
'example' => 'pt_mtohn73423stghoivjmi4jwxxx',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create a proxy token for an EIAM instance domain name',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDomainProxyToken'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateDomainProxyToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'DomainProxyToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}/domainproxytoken/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"DomainProxyTokenId\\": \\"pt_mtohn73423stghoivjmi4jwxxx\\"\\n}","type":"json"}]',
],
'CreateFederatedCredentialProvider' => [
'summary' => 'Creates a federated trust source.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'FederatedCredentialProviderName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The name of the federated trust source.', 'type' => 'string', 'required' => true, 'example' => 'test', 'maxLength' => 64],
],
[
'name' => 'FederatedCredentialProviderType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The type of the federated trust source.', 'type' => 'string', 'required' => true, 'example' => 'pkcs7', 'maxLength' => 64],
],
[
'name' => 'NetworkAccessEndpointId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the network access endpoint.', 'type' => 'string', 'required' => false, 'example' => 'nae_example_id', 'maxLength' => 64],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description of the federated trust source.', 'type' => 'string', 'example' => 'test', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'PrivateCaProviderConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The private CA configuration.',
'type' => 'object',
'properties' => [
'TrustAnchorSource' => ['title' => '', 'description' => 'The method used to retrieve the root certificate.', 'type' => 'string', 'required' => false, 'example' => 'custom', 'maxLength' => 32],
'Certificates' => [
'title' => '',
'description' => 'The list of root certificates.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Content' => ['title' => '', 'description' => 'The content of the root certificate.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----'."\n"
.'MIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z'."\n"
.'-----END CERTIFICATE-----', 'required' => false],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
'TrustCondition' => ['title' => '', 'description' => 'The trust condition for the root certificate.', 'type' => 'string', 'example' => 'IsNullOrEmpty("jwt.issuer")', 'maxLength' => 10240, 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'OidcProviderConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The OIDC configuration.',
'type' => 'object',
'properties' => [
'JwksSource' => ['title' => '', 'description' => 'The source of the JWKS.', 'type' => 'string', 'required' => false, 'example' => 'static', 'maxLength' => 32],
'JwksUri' => ['title' => '', 'description' => 'The JWKS endpoint.', 'type' => 'string', 'example' => 'https://example.com/jwks', 'maxLength' => 1024, 'required' => false],
'StaticJwks' => ['title' => '', 'description' => 'The statically retrieved JWKS.', 'type' => 'string', 'example' => '{'."\n"
.' "keys": ['."\n"
.' {'."\n"
.' "kty": "RSA",'."\n"
.' "e": "AQAB",'."\n"
.' "use": "sig",'."\n"
.' "kid": "KEY2RzsjRrimRASiAhCjBo18YwDoxpYHnHtv",'."\n"
.' "n": "qrsfFfSZngqKOxVE29ZIR4SXkwKq029B3HLDAZui_Pwaxwn8FssR9QdwsljZS06BTDp10vhPgqMB7s7TmHulL3I4WuSB-l4uXXXXX"'."\n"
.' }'."\n"
.' ]'."\n"
.'}', 'required' => false],
'Audiences' => [
'description' => 'The list of audiences.',
'type' => 'array',
'items' => ['description' => 'The audience.', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
'TrustCondition' => ['title' => '', 'description' => 'The trust condition.', 'type' => 'string', 'example' => 'IsNullOrEmpty("jwt.issuer")', 'maxLength' => 10240, 'required' => false],
'Issuer' => ['title' => '', 'description' => 'Issuer', 'type' => 'string', 'example' => 'https://example.com', 'maxLength' => 1024, 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'Pkcs7ProviderConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The PKCS7 configuration.',
'type' => 'object',
'properties' => [
'TrustAnchorSource' => ['title' => '', 'description' => 'The source of the certificate trust anchor.', 'type' => 'string', 'required' => false, 'example' => 'custom', 'maxLength' => 32],
'Certificates' => [
'title' => '',
'description' => 'The list of PKCS7 certificates.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Content' => ['title' => '', 'description' => 'The content of the root certificate.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----'."\n"
.'MIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z'."\n"
.'-----END CERTIFICATE-----', 'required' => false],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
'TrustCondition' => ['title' => '', 'description' => 'The trust condition.', 'type' => 'string', 'example' => 'IsNullOrEmpty("jwt.issuer")', 'maxLength' => 10240, 'required' => false],
'CmsVerificationMode' => ['title' => '', 'description' => 'The CMS verification mode.', 'type' => 'string', 'required' => false, 'example' => 'cert_chain', 'maxLength' => 32],
'SigningTimeValueExpression' => ['title' => '', 'description' => 'The expression used to retrieve the signing time.', 'type' => 'string', 'example' => 'pkcs7.signingTime', 'required' => false],
'SignatureEffectiveTime' => ['title' => '', 'description' => 'The validity period of the signature.', 'type' => 'integer', 'format' => 'int64', 'example' => '1200', 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'CloudIdPProviderConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'type' => 'object',
'properties' => [
'IdentityProviderId' => ['title' => '', 'type' => 'string', 'example' => 'idp_m7hk2hbnew5ir3ycfabug6xxxx', 'maxLength' => 32, 'description' => ''],
],
'description' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'FederatedCredentialProviderId' => ['title' => '', 'description' => 'The ID of the federated trust source.', 'type' => 'string', 'example' => 'fcp_sada123XXXX'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create a federated trust source',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateFederatedCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"FederatedCredentialProviderId\\": \\"fcp_sada123XXXX\\"\\n}","type":"json"}]',
],
'CreateGroup' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas7VNWU7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Group name. The maximum length is 64 characters.', 'type' => 'string', 'required' => true, 'example' => 'name_test'],
],
[
'name' => 'GroupExternalId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Group external ID, used for association with external systems. The default value is the group ID. The maximum length is 64 characters.', 'type' => 'string', 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx', 'required' => false],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Description. The maximum length is 256 characters.', 'type' => 'string', 'example' => 'this is a test.', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'GroupId' => ['title' => '', 'description' => 'Group ID.', 'type' => 'string', 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create an EIAM account group',
'summary' => 'Create an EIAM account group.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"GroupId\\": \\"group_d6sbsuumeta4h66ec3il7yxxxx\\"\\n}","type":"json"}]',
],
'CreateIdentityProvider' => [
'summary' => 'Create an identity provider.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '139692',
'abilityTreeNodes' => ['FEATUREidaas3ZGGWT'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'IdentityProviderName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Identity provider name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'maxLength' => 64],
],
[
'name' => 'IdentityProviderType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Identity provider synchronization type.'."\n"
."\n"
.'- Inbound DingTalk: urn:alibaba:idaas:idp:alibaba:dingtalk:pull'."\n"
."\n"
.'- Outbound DingTalk: urn:alibaba:idaas:idp:alibaba:dingtalk:push'."\n"
."\n"
.'- Inbound WeCom: urn:alibaba:idaas:idp:tencent:wecom:pull'."\n"
."\n"
.'- Inbound Lark: urn:alibaba:idaas:idp:bytedance:lark:pull'."\n"
."\n"
.'- Inbound AD: urn:alibaba:idaas:idp:microsoft:ad:pull'."\n"
."\n"
.'- Inbound LDAP: urn:alibaba:idaas:idp:unknown:ldap:pull'."\n"
."\n"
.'- Standard OIDC: urn:alibaba:idaas:idp:standard:oidc'."\n"
."\n"
.'- SASE Custom OIDC: urn:alibaba:idaas:idp:alibaba:sase', 'type' => 'string', 'required' => true, 'example' => 'urn:alibaba:idaas:idp:alibaba:dingtalk:push', 'maxLength' => 64],
],
[
'name' => 'UdPushConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Outbound synchronization configuration.',
'type' => 'object',
'properties' => [
'IncrementalCallbackStatus' => ['title' => '', 'description' => 'Incremental callback status. This field is not yet enabled. Please ignore it.', 'type' => 'string', 'example' => 'disabled', 'maxLength' => 32, 'required' => false],
'PeriodicSyncStatus' => ['title' => '', 'description' => 'Periodic verification status. This field is not yet enabled. Please ignore it.', 'type' => 'string', 'example' => 'disabled', 'maxLength' => 32, 'required' => false],
'UdSyncScopeConfigs' => [
'title' => '',
'description' => 'Outbound synchronization configuration.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SourceScopes' => [
'title' => '',
'description' => 'Source synchronization node list.',
'type' => 'array',
'items' => ['description' => 'Source synchronization node. Enter the organization ID.', 'type' => 'string', 'required' => false, 'example' => 'ou_lyhyy6p7yf7mdrdiq5xxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'TargetScope' => ['title' => '', 'description' => 'Target synchronization node.', 'type' => 'string', 'example' => 'ou_lyhyy6p7yf7mdrdiq5xxxx', 'required' => false],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
'PeriodicSyncConfig' => [
'title' => '',
'description' => 'Periodic verification configuration.',
'type' => 'object',
'properties' => [
'PeriodicSyncType' => [
'title' => '',
'description' => 'Type.',
'enumValueTitles' => ['cron' => 'cron', 'time' => 'time'],
'type' => 'string',
'example' => 'cron'."\n",
'required' => false,
],
'PeriodicSyncCron' => ['title' => '', 'description' => 'Cron expression.', 'type' => 'string', 'example' => '0 45 1 * * ?'."\n", 'required' => false],
'PeriodicSyncTimes' => [
'title' => '',
'description' => 'Set of execution time points.',
'type' => 'array',
'items' => ['title' => '', 'description' => 'Execution time point.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'required' => false],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'UdPullConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Inbound synchronization configuration.',
'type' => 'object',
'properties' => [
'GroupSyncStatus' => ['title' => '', 'description' => 'Whether group synchronization is supported. Default: disabled. Valid values:'."\n"
."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'disabled', 'maxLength' => 32, 'required' => false],
'IncrementalCallbackStatus' => ['title' => '', 'description' => 'Incremental callback status. Specifies whether to process incremental callback data from the IdP. Valid values:'."\n"
."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'disabled', 'maxLength' => 32, 'required' => false],
'PeriodicSyncStatus' => ['title' => '', 'description' => 'Periodic verification status. Specifies whether to periodically verify data differences between EIAM and the identity provider. Valid values:'."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'disabled', 'maxLength' => 32, 'required' => false],
'UdSyncScopeConfig' => [
'title' => '',
'description' => 'Synchronization scope configuration.',
'type' => 'object',
'properties' => [
'SourceScopes' => [
'title' => '',
'description' => 'Source synchronization node list.',
'type' => 'array',
'items' => ['description' => 'Source synchronization node.', 'type' => 'string', 'required' => false, 'example' => 'ou_lyhyy6p7yf7mdrdiq5xxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'TargetScope' => ['title' => '', 'description' => 'Target synchronization node. Enter the IDaaS organization ID.', 'type' => 'string', 'example' => 'ou_lyhyy6p7yf7mdrdiq5xxxx', 'required' => false],
],
'required' => false,
'example' => '',
],
'PeriodicSyncConfig' => [
'title' => '',
'description' => 'Periodic verification configuration.',
'type' => 'object',
'properties' => [
'PeriodicSyncType' => [
'title' => '',
'description' => 'Type.',
'type' => 'string',
'example' => 'cron',
'enum' => ['cron', 'time'],
'required' => false,
],
'PeriodicSyncCron' => ['title' => '', 'description' => 'Cron expression.', 'type' => 'string', 'example' => '0 45 1 * * ?', 'required' => false],
'PeriodicSyncTimes' => [
'title' => '',
'description' => 'Set of execution time points.',
'type' => 'array',
'items' => ['description' => 'Execution time point.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'AuthnConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Authentication configuration.',
'type' => 'object',
'properties' => [
'AuthnStatus' => ['title' => '', 'description' => 'Whether the corresponding IdP supports authentication. Valid values:'."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'required' => false, 'example' => 'enabled', 'maxLength' => 32],
'AutoUpdatePasswordStatus' => ['title' => '', 'description' => 'Whether automatic password update is supported. Valid values:'."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'enabled', 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'BindingConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'OIDC identity provider account binding rule configuration.',
'type' => 'object',
'properties' => [
'AutoMatchUserProfileExpressions' => [
'title' => '',
'description' => 'List of rules for automatic account matching.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ExpressionMappingType' => ['title' => '', 'description' => 'Expression type. Valid values:'."\n"
."\n"
.'- Field: field'."\n"
."\n"
.'- Expression: expression', 'type' => 'string', 'required' => false, 'example' => 'field'],
'SourceValueExpression' => ['title' => '', 'description' => 'Mapping attribute value expression.', 'type' => 'string', 'required' => false, 'example' => 'idpUser.phoneNumber'],
'TargetField' => ['title' => '', 'description' => 'Mapping target attribute name.', 'type' => 'string', 'required' => false, 'example' => 'user.username'],
'TargetFieldDescription' => ['title' => '', 'description' => 'Mapping target attribute description.', 'type' => 'string', 'required' => false, 'example' => 'username'],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
'AutoMatchUserStatus' => ['title' => '', 'description' => 'Whether automatic account matching is enabled. Valid values:'."\n"
."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'disabled', 'required' => false],
'MappingBindingStatus' => ['title' => '', 'description' => 'Whether the manual account binding feature is enabled. Valid values:'."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'enabled', 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'DingtalkAppConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'DingTalk configuration.',
'type' => 'object',
'properties' => [
'AppKey' => ['title' => '', 'description' => 'AppKey of the DingTalk first-party application.', 'type' => 'string', 'example' => 'Xczngvfemo4e', 'required' => false],
'AppSecret' => ['title' => '', 'description' => 'AppSecret of the DingTalk first-party application.', 'type' => 'string', 'example' => '5d405a12a6f84ad4ab05ee09axxxx', 'required' => false],
'CorpId' => ['title' => '', 'description' => 'CorpId of the DingTalk first-party application.', 'type' => 'string', 'example' => '307568042478613xxxx', 'required' => false],
'DingtalkVersion' => ['title' => '', 'description' => 'DingTalk version. Valid values:'."\n"
."\n"
.'- Standard DingTalk: public_dingtalk'."\n"
."\n"
.'- Exclusive DingTalk: private_dingtalk', 'type' => 'string', 'example' => 'public_dingtalk', 'maxLength' => 32, 'required' => false],
'EncryptKey' => ['description' => 'DingTalk application EncryptKey.', 'type' => 'string', 'required' => false, 'example' => 'VkdWw91mdkrjVFr3ObNwefap21dfxxxx', 'title' => ''],
'VerificationToken' => ['description' => 'DingTalk application VerificationToken.', 'type' => 'string', 'required' => false, 'example' => 'myDingApp_VerifyTokenxxxxx', 'title' => ''],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'LdapConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'AD/LDAP configuration.',
'type' => 'object',
'properties' => [
'AdministratorPassword' => ['title' => '', 'description' => 'Administrator password.', 'type' => 'string', 'example' => 'xxxx', 'required' => false],
'AdministratorUsername' => ['title' => '', 'description' => 'Administrator account.', 'type' => 'string', 'example' => 'DC=example,DC=com', 'required' => false],
'CertificateFingerprintStatus' => ['title' => '', 'description' => 'Whether to verify certificate fingerprint. Valid values:'."\n"
."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'enabled', 'required' => false],
'CertificateFingerprints' => [
'title' => '',
'description' => 'Certificate fingerprint list.',
'type' => 'array',
'items' => ['description' => 'Certificate fingerprint in SHA256 public key format.', 'type' => 'string', 'required' => false, 'example' => 'asdasd2221asdawqeda', 'title' => ''],
'required' => false,
'example' => '',
],
'GroupMemberAttributeName' => ['title' => '', 'description' => 'Group member attribute.', 'type' => 'string', 'example' => 'member', 'required' => false],
'GroupObjectClass' => ['title' => '', 'description' => 'Group ObjectClass.', 'type' => 'string', 'example' => 'group', 'required' => false],
'GroupObjectClassCustomFilter' => ['title' => '', 'description' => 'Group custom filter.', 'type' => 'string', 'example' => '(|(cn=test)(group=test@test.com))', 'required' => false],
'LdapProtocol' => ['title' => '', 'description' => 'Communication protocol.', 'type' => 'string', 'example' => 'ldap', 'required' => false],
'LdapServerHost' => ['title' => '', 'description' => 'AD/LDAP server address.', 'type' => 'string', 'example' => '123.xx.xx.89', 'required' => false],
'LdapServerPort' => ['title' => '', 'description' => 'AD/LDAP port number.', 'type' => 'integer', 'format' => 'int32', 'example' => '636', 'required' => false],
'OrganizationUnitObjectClass' => ['title' => '', 'description' => 'Organization ObjectClass.', 'type' => 'string', 'example' => 'organizationUnit,top', 'required' => false],
'StartTlsStatus' => ['title' => '', 'description' => 'Whether startTLS is enabled. Valid values:'."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'enabled', 'required' => false],
'UserLoginIdentifier' => ['title' => '', 'description' => 'User login identifier.', 'type' => 'string', 'example' => 'userPrincipalName, mail', 'required' => false],
'UserObjectClass' => ['title' => '', 'description' => 'User ObjectClass.', 'type' => 'string', 'example' => 'person,user', 'required' => false],
'UserObjectClassCustomFilter' => ['title' => '', 'description' => 'User custom filter.', 'type' => 'string', 'example' => '(|(cn=test)(mail=test@test.com))', 'required' => false],
'PasswordSyncStatus' => [
'title' => '',
'description' => 'Password synchronization switch.',
'type' => 'string',
'example' => 'enabled',
'enum' => ['enabled', 'disabled'],
'required' => false,
],
'UserRdn' => ['title' => '', 'description' => 'User RDN.', 'type' => 'string', 'example' => 'cn', 'required' => false],
'OrganizationalUnitRdn' => ['title' => '', 'description' => 'Organization RDN.', 'type' => 'string', 'example' => 'ou', 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'WeComConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'WeCom configuration.',
'type' => 'object',
'properties' => [
'AgentId' => ['title' => '', 'description' => 'AgentId of the WeCom self-built application.', 'type' => 'string', 'example' => '278231941749863339', 'required' => false],
'AuthorizeCallbackDomain' => ['title' => '', 'description' => 'Authorization callback domain.', 'type' => 'string', 'example' => 'https://xxx.aliyunidaas.com/xxxx', 'required' => false],
'CorpId' => ['title' => '', 'description' => 'CorpId of the WeCom self-built application.', 'type' => 'string', 'example' => '3756043633237690761', 'required' => false],
'CorpSecret' => ['title' => '', 'description' => 'CorpSecret of the WeCom self-built application.', 'type' => 'string', 'example' => 'CSEHDddddddxxxxuxkJEHPveWRXBGqVqRsxxxx', 'required' => false],
'TrustableDomain' => ['title' => '', 'description' => 'Trusted domain.', 'type' => 'string', 'example' => 'https://xxx.aliyunidaas.com/', 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'OidcConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'OIDC IdP configuration.',
'type' => 'object',
'properties' => [
'AuthnParam' => [
'title' => '',
'description' => 'OIDC client authentication configuration.',
'type' => 'object',
'properties' => [
'AuthnMethod' => ['title' => '', 'description' => 'OIDC authentication method. Valid values:'."\n"
."\n"
.'- client_secret_basic'."\n"
."\n"
.'- client_secret_post', 'type' => 'string', 'example' => 'client_secret_post', 'required' => false],
'ClientId' => ['title' => '', 'description' => 'OIDC client ID.', 'type' => 'string', 'example' => 'mkv7rgt4d7i4u7zqtzev2mxxxx', 'required' => false],
'ClientSecret' => ['title' => '', 'description' => 'OIDC client secret.', 'type' => 'string', 'example' => 'CSEHDddddddxxxxuxkJEHPveWRXBGqVqRsxxxx', 'required' => false],
],
'required' => false,
'example' => '',
],
'EndpointConfig' => [
'title' => '',
'description' => 'OIDC endpoint configuration.',
'type' => 'object',
'properties' => [
'AuthorizationEndpoint' => ['title' => '', 'description' => 'OIDC authorization endpoint.', 'type' => 'string', 'example' => 'https://example.com/auth/authorize', 'required' => false],
'Issuer' => ['title' => '', 'description' => 'OIDC issuer.', 'type' => 'string', 'example' => 'https://example.com/auth', 'required' => false],
'JwksUri' => ['title' => '', 'description' => 'OIDC JWKS URI.', 'type' => 'string', 'example' => 'https://example.com/auth/jwks', 'required' => false],
'TokenEndpoint' => ['title' => '', 'description' => 'OIDC token endpoint.', 'type' => 'string', 'example' => 'https://example.com/auth/token', 'required' => false],
'UserinfoEndpoint' => ['title' => '', 'description' => 'OIDC UserInfo endpoint.', 'type' => 'string', 'example' => 'https://example.com/auth/userinfo', 'required' => false],
],
'required' => false,
'example' => '',
],
'GrantScopes' => [
'title' => '',
'description' => 'OIDC grant scopes.',
'type' => 'array',
'items' => ['description' => 'OIDC grant scope, organization ID or group ID.', 'type' => 'string', 'required' => false, 'example' => 'ou_lyhyy6p7yf7mdrdiq5xxxx', 'title' => ''],
'required' => false,
'example' => 'openid',
],
'GrantType' => ['title' => '', 'description' => 'OIDC grant type.', 'type' => 'string', 'example' => 'authorization_code', 'required' => false],
'PkceChallengeMethod' => ['title' => '', 'description' => 'PKCE algorithm. Valid values:'."\n"
."\n"
.'- SHA256: S256'."\n"
."\n"
.'- Plain text: plain', 'type' => 'string', 'example' => 'S256', 'required' => false],
'PkceRequired' => ['title' => '', 'description' => 'Whether to use PKCE in Authorization Code grant mode.', 'type' => 'boolean', 'example' => 'true', 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'NetworkAccessEndpointId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Network access endpoint ID.', 'type' => 'string', 'example' => 'nae_examplexxxx', 'required' => false],
],
[
'name' => 'AutoCreateUserConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Automatic account creation rule configuration.',
'type' => 'object',
'properties' => [
'AutoCreateUserStatus' => ['title' => '', 'description' => 'Whether automatic account creation is enabled. Valid values:'."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'disabled', 'required' => false],
'TargetOrganizationalUnitIds' => [
'description' => 'Set of target organizational unit IDs.',
'type' => 'array',
'items' => ['description' => 'Target organizational unit ID.', 'type' => 'string', 'required' => false, 'example' => 'ou_lyhyy6p7yf7mdrdiq5xxxx', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'AutoUpdateUserConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Automatic account update rule configuration.',
'type' => 'object',
'properties' => [
'AutoUpdateUserStatus' => ['title' => '', 'description' => 'Whether automatic account update is enabled. Valid values:'."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'disabled', 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'LarkConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Lark configuration.',
'type' => 'object',
'properties' => [
'AppId' => ['title' => '', 'description' => 'Lark application AppId.', 'type' => 'string', 'example' => 'cli_xxxx', 'required' => false],
'AppSecret' => ['title' => '', 'description' => 'Lark application Secret.', 'type' => 'string', 'example' => 'KiiLzh5Dueh4wbLxxxx', 'required' => false],
'EnterpriseNumber' => ['title' => '', 'description' => 'Lark enterprise code.', 'type' => 'string', 'example' => 'FSX123111xxx', 'maxLength' => 128, 'required' => false],
'EncryptKey' => ['title' => '', 'description' => 'EncryptKey of the Lark self-built application.', 'type' => 'string', 'required' => false, 'example' => 'VkdWw91mdkrjVFr3ObNwefap21dfxxxx'],
'VerificationToken' => ['title' => '', 'description' => 'VerificationToken of the Lark self-built application.', 'type' => 'string', 'required' => false, 'example' => 'feishuVerifyTokenxxxxx'],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'LogoUrl',
'in' => 'query',
'schema' => ['description' => 'Application logo URL.', 'type' => 'string', 'required' => false, 'example' => 'xxxx-image://xxxx_23aqr2ye554csg33dqpch5eu3q/tmp/d17d9adc-a943-45e7-ba0c-2838dddea678'."\n", 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'Client token used to ensure the idempotency of the request. Generate a parameter value from your client to ensure the value is unique across different requests. ClientToken only supports ASCII characters. If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.', 'type' => 'string', 'required' => false, 'example' => 'clientToken_20250704_Axxxxx', 'title' => ''],
],
[
'name' => 'SamlConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'type' => 'object',
'properties' => [
'IdPEntityId' => ['title' => '', 'type' => 'string', 'required' => false, 'example' => 'http://dc.test.com/adfs/services/trust', 'description' => ''],
'IdPSsoUrl' => ['title' => '', 'type' => 'string', 'required' => false, 'example' => 'https://dc.test.com/adfs/ls/', 'description' => ''],
'Certificates' => [
'title' => '',
'type' => 'array',
'items' => [
'title' => '',
'type' => 'object',
'properties' => [
'Content' => ['title' => '', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE----- MIIC0jCCAbqgAwIBAgIQXXXXX-----END CERTIFICATE-----', 'description' => ''],
],
'description' => '',
'example' => '',
],
'required' => false,
'description' => '',
'example' => '',
],
'RequireRequestSigned' => ['title' => '', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'description' => ''],
'BindingMethod' => [
'title' => '',
'type' => 'string',
'example' => 'HTTP-REDIRECT',
'enum' => ['HTTP-REDIRECT', 'HTTP-POST'],
'description' => '',
],
'MaxClockSkew' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '180', 'default' => '180', 'description' => ''],
'WantResponseSigned' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''],
'WantAssertionsSigned' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''],
],
'description' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'IdentityProviderId' => ['title' => '', 'description' => 'Identity provider ID.', 'type' => 'string', 'example' => 'idp_mwpcwnhrimlr2horxXXXX'],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter.OidcIssuer', 'errorMessage' => 'OidcIssuer format check failed, it must be an address that starts with http or https.', 'description' => 'OidcIssuer format check failed, it must be an address that starts with http or https.'],
],
],
'title' => 'Create Identity Provider',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIdentityProvider'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"IdentityProviderId\\": \\"idp_mwpcwnhrimlr2horxXXXX\\"\\n}","type":"json"}]',
],
'CreateIdentityProviderStatusCheckJob' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['description' => 'The ID of the identity provider.', 'type' => 'string', 'required' => true, 'example' => 'idp_11111', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'IdentityProviderStatusCheckJobId' => ['description' => 'The ID of the job.', 'type' => 'string', 'title' => '', 'example' => 'async_000xxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'CreateIdentityProviderStatusCheckJob',
'summary' => 'Creates a status check job for an identity provider.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"IdentityProviderStatusCheckJobId\\": \\"async_000xxxx\\"\\n}","type":"json"}]',
],
'CreateInstance' => [
'summary' => 'Creates an instance based on which all capabilities of Identity as a Service (IDaaS) Enterprise Identity and Access Management (EIAM) are provided.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6GKEFM'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description of the instance. The description can be up to 128 characters in length.', 'type' => 'string', 'example' => 'instance_for_test', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'InstanceId' => [
'description' => 'The ID of the instance that is created.',
'properties' => [],
'type' => 'string',
'title' => '',
'example' => 'idaas_wj5htncdvoc4q5xxxxxxxxx',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"InstanceId\\": \\"idaas_wj5htncdvoc4q5xxxxxxxxx\\"\\n}","type":"json"}]',
'title' => 'CreateInstance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/*'],
],
],
],
],
],
'CreateInstanceTrialLicense' => [
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas92IAAU'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'eiam-111ccc1111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'LicenseId' => ['title' => '', 'description' => 'The unique identifier of the License.', 'type' => 'string', 'example' => 'license_463hfmewi2njxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Create a trial license',
'summary' => 'Creates a trial License for an instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateInstanceTrialLicense',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"LicenseId\\": \\"license_463hfmewi2njxxxx\\"\\n}","type":"json"}]',
],
'CreateNetworkAccessEndpoint' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGNRASW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NetworkAccessEndpointName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Network access endpoint name.', 'type' => 'string', 'required' => true, 'example' => 'Xx-business VPC access endpoint'],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'VPC ID connected to the network access endpoint.', 'type' => 'string', 'required' => true, 'example' => 'vpc-examplexxx'],
],
[
'name' => 'VpcRegionId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Region of the VPC ID connected to the network access endpoint.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'VSwitchIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'List of specified vSwitches connected to the network access endpoint.',
'type' => 'array',
'items' => ['description' => 'vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-2vc8z0f90z4k6xxxxx'."\n", 'title' => ''],
'required' => false,
'example' => 'vsw-examplexxx',
'maxLength' => 2,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Ensures the idempotency of the request. Generate a parameter value from your client to ensure uniqueness across different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/en/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'example' => 'client-token-example', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'NetworkAccessEndpointId' => ['title' => '', 'description' => 'Network access endpoint ID.', 'type' => 'string', 'example' => 'nae_examplexxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create a network access endpoint',
'summary' => 'Creates a network access endpoint.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateNetworkAccessEndpoint'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateNetworkAccessEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"NetworkAccessEndpointId\\": \\"nae_examplexxxx\\"\\n}","type":"json"}]',
],
'CreateNetworkZone' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231616',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NetworkZoneName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Network zone name.', 'type' => 'string', 'required' => true, 'example' => 'IPV4Test', 'maxLength' => 64],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Network zone description.', 'type' => 'string', 'example' => 'Test description', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'NetworkZoneType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'Network zone type.',
'enumValueTitles' => ['arn:alibaba:idaas:network:zone:classic' => 'Classic network', 'arn:alibaba:idaas:network:zone:vpc' => 'Virtual private cloud (VPC)'],
'type' => 'string',
'required' => true,
'example' => 'arn:alibaba:idaas:network:zone:classic',
'maxLength' => 64,
],
],
[
'name' => 'Ipv4Cidrs',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Network zone IPv4 CIDR blocks.',
'type' => 'array',
'items' => ['description' => 'The IPv4 CIDR block.', 'type' => 'string', 'required' => false, 'example' => '140.xxx.11.0/xx', 'title' => ''],
'required' => false,
'example' => '0.0.0.0/0',
],
],
[
'name' => 'Ipv6Cidrs',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Network zone IPv6 CIDR blocks.',
'type' => 'array',
'items' => ['description' => 'The IPv6 CIDR block.', 'type' => 'string', 'required' => false, 'example' => '2001:xxxx:4801:xx::40', 'title' => ''],
'required' => false,
'example' => '::/0',
],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'VPC ID.', 'type' => 'string', 'example' => 'vpc_xxxxx', 'maxLength' => 64, 'required' => false],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Idempotency token.', 'type' => 'string', 'example' => 'client-token-example', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'NetworkZoneId' => ['title' => '', 'description' => 'Network zone ID.', 'type' => 'string', 'example' => 'network_m6a57vre4g3h7m725yrq6pxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'CreateNetworkZone',
'summary' => 'Creates a network zone object.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateNetworkZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"NetworkZoneId\\": \\"network_m6a57vre4g3h7m725yrq6pxxxx\\"\\n}","type":"json"}]',
],
'CreateOrganizationalUnit' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '117580',
'abilityTreeNodes' => ['FEATUREidaas3S4NKL'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Organization name. The maximum length is 64 characters.', 'type' => 'string', 'required' => true, 'example' => 'test_ou_name', 'maxLength' => 128],
],
[
'name' => 'ParentId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Parent organization ID.', 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitExternalId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'External ID of the organization, which is used for association with an external system. The default value is the organization ID. The maximum length is 64 characters.', 'type' => 'string', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description. The maximum length is 256 characters.', 'type' => 'string', 'example' => 'description', 'maxLength' => 256, 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'OrganizationalUnitId' => ['title' => '', 'description' => 'Organization ID.', 'type' => 'string', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Create an EIAM organization',
'summary' => 'Creates an EIAM organization under a specified organization.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrganizationalUnit'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"OrganizationalUnitId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\"\\n}","type":"json"}]',
],
'CreateResourceServerScope' => [
'summary' => 'Creates a scope permission for a specified resource server.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ResourceServerScopeName',
'in' => 'query',
'schema' => ['description' => 'The name of the scope permission.', 'type' => 'string', 'required' => true, 'example' => 'Read User Info', 'maxLength' => 32, 'title' => ''],
],
[
'name' => 'ResourceServerScopeValue',
'in' => 'query',
'schema' => ['description' => 'The value of the scope permission.', 'type' => 'string', 'required' => true, 'example' => 'User:Read:ALL', 'maxLength' => 128, 'title' => ''],
],
[
'name' => 'ResourceServerScopeType',
'in' => 'query',
'schema' => [
'description' => 'The type of the scope permission.',
'enumValueTitles' => ['urn:alibaba:idaas:resourceserver:scope:application' => 'Machine permission', 'urn:alibaba:idaas:resourceserver:scope:application_delegated' => 'urn:alibaba:idaas:resourceserver:scope:application\\_delegated', 'urn:alibaba:idaas:resourceserver:scope:delegated' => 'User permission'],
'type' => 'string',
'required' => true,
'example' => 'urn:alibaba:idaas:resourceserver:scope:delegated',
'title' => '',
],
],
[
'name' => 'AuthorizationType',
'in' => 'query',
'schema' => [
'description' => 'The authorization type. This parameter is required for user permissions.',
'enumValueTitles' => ['authorize_required' => 'Manual authorization', 'default_all' => 'Automatic authorization'],
'type' => 'string',
'example' => 'authorize_required',
'enum' => ['authorize_required', 'default_all'],
'title' => '',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'ResourceServerScopeId' => ['description' => 'The ID of the scope permission.', 'type' => 'string', 'title' => '', 'example' => 'ress_neg35flu6byysxwutaxu3dxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'CreateResourceServerScope',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateResourceServerScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ResourceServerScope', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/resourceserverscope/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ResourceServerScopeId\\": \\"ress_neg35flu6byysxwutaxu3dxxxx\\"\\n}","type":"json"}]',
],
'CreateUser' => [
'summary' => 'Creates an EIAM account in a specified EIAM instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'Username',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The username. The username can contain letters, digits, underscores (_), periods (.), at signs (@), and hyphens (-). The username can be up to 256 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'user_001', 'maxLength' => 256],
],
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The display name of the account. The display name can be up to 128 characters in length.', 'type' => 'string', 'example' => 'name_001', 'maxLength' => 256, 'required' => false],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The password. The password must meet the requirements of the password policy.', 'type' => 'string', 'required' => false, 'example' => '123456', 'maxLength' => 64],
],
[
'name' => 'PhoneRegion',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The phone region code. The value is a 1 to 6-digit number and does not include a plus sign (+).', 'type' => 'string', 'example' => '86', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The phone number. The value is a 6 to 15-digit number.', 'type' => 'string', 'example' => '12345678901', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'PhoneNumberVerified',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether the phone number is verified as a trusted phone number. This parameter is required if PhoneNumber is specified. If no special business requirement exists, set this parameter to true.', 'type' => 'boolean', 'example' => 'true', 'maxLength' => 64, 'required' => false],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The email address. The email prefix can contain uppercase letters, lowercase letters, digits, periods (.), underscores (_), and hyphens (-). The email address can be up to 128 characters in length.', 'type' => 'string', 'example' => 'example@example.com', 'maxLength' => 256, 'required' => false],
],
[
'name' => 'EmailVerified',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether the email address is verified as a trusted email address. This parameter is required if Email is specified. If no special business requirement exists, set this parameter to true.', 'type' => 'boolean', 'example' => 'true', 'maxLength' => 64, 'required' => false],
],
[
'name' => 'UserExternalId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The external ID of the account. This parameter is used to associate the account with an external system. The value can be up to 128 characters in length. If this parameter is not specified, the account ID is used by default.', 'type' => 'string', 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 256, 'required' => false],
],
[
'name' => 'PrimaryOrganizationalUnitId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the primary organizational unit.', 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of organizational unit IDs to which the account belongs. An account can belong to multiple organizational units.',
'type' => 'array',
'items' => ['description' => 'The organizational unit ID.', 'type' => 'string', 'required' => false, 'example' => 'ou_adz2vmgiwpo4tu6jtss3mynjji', 'title' => ''],
'required' => false,
'example' => '',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description. The description can be up to 256 characters in length.', 'type' => 'string', 'example' => 'description text', 'maxLength' => 256, 'required' => false],
],
[
'name' => 'CustomFields',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of custom fields.',
'type' => 'array',
'items' => [
'description' => 'The custom field object.',
'type' => 'object',
'properties' => [
'FieldName' => ['title' => '', 'description' => 'The identifier of the custom field. Create the custom field in advance. For more information, refer to the custom fields module in the console.', 'type' => 'string', 'example' => 'age', 'maxLength' => 64, 'required' => false],
'FieldValue' => ['title' => '', 'description' => 'The value of the custom field. The value must comply with the attribute constraints of the corresponding custom field.', 'type' => 'string', 'example' => '10', 'maxLength' => 256, 'required' => false],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'example' => 'description',
],
],
[
'name' => 'PasswordInitializationConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The password initialization configuration.',
'type' => 'object',
'properties' => [
'PasswordInitializationPolicyPriority' => ['title' => '', 'description' => 'The priority of the password initialization policy. By default, this parameter does not take effect. Valid values:'."\n"
.'- global: The global policy policy priority. The instance-level password initialization policy is used, and the password initialization policy specified in this request does not take effect. For more information, refer to the password initialization policy in password-related policies.'."\n"
.'- custom: The custom policy policy priority. The password initialization policy defined in this request is used, including whether to enable forced password change, the password initialization method, and the notification channel.', 'type' => 'string', 'example' => 'global', 'maxLength' => 64, 'required' => false],
'PasswordForcedUpdateStatus' => ['title' => '', 'description' => 'The forced password change status. By default, this feature is not enabled. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enabled', 'maxLength' => 64, 'required' => false],
'UserNotificationChannels' => [
'title' => '',
'description' => 'The list of password notification channels.',
'type' => 'array',
'items' => ['description' => 'The password notification channel. Valid values:'."\n"
.'- email: email'."\n"
.'- sms: text message.', 'type' => 'string', 'required' => false, 'example' => 'sms', 'title' => ''],
'required' => false,
'example' => 'sms',
'maxLength' => 64,
],
'PasswordInitializationType' => ['title' => '', 'description' => 'The password initialization method. Valid values:'."\n"
.'- random: random.', 'type' => 'string', 'example' => 'random', 'maxLength' => 64, 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References: How to ensure idempotence.', 'type' => 'string', 'required' => false, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'UserId' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'ResourceDuplicated.Username', 'errorMessage' => 'The specified resource: Username already exist.', 'description' => 'Duplicate user name'],
],
],
'title' => 'Create an EIAM account',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUser'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"UserId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\"\\n}","type":"json"}]',
],
'DeleteApplication' => [
'summary' => 'Deletes an EIAM application resource.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeCode' => '114492',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ', 'FEATUREidaasJXI2A5', 'FEATUREidaasAAD0EO'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Delete an EIAM application',
'description' => 'Before deleting a specified EIAM application, make sure the application is no longer in use. After the application is deleted, all configuration data is permanently deleted and cannot be recovered.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApplication'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteApplicationClientSecret' => [
'summary' => 'Deletes a client secret of an EIAM application.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasJH3YY9'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'SecretId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client secret ID of the application.', 'type' => 'string', 'required' => true, 'example' => ' sci_k52x2ru63rlkflina5utgkxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete a client secret of an EIAM application',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApplicationClientSecret'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteApplicationClientSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/{#SecretId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteApplicationFederatedCredential' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationFederatedCredentialId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application federated identity credential ID.', 'type' => 'string', 'required' => true, 'example' => 'afc_aaaaa1111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete an application federated identity credential',
'summary' => 'Deletes a federated identity credential of an application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteApplicationFederatedCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/{#ApplicationFederatedCredentialId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteApplicationRole' => [
'summary' => 'Deletes an application role.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationRoleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application role ID.', 'type' => 'string', 'required' => true, 'example' => 'approle_01kh2vuo8v9splv8maak1d22rxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete an application role',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteApplicationRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationrole/{#ApplicationRoleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteApplicationToken' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasSQHOGI'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationTokenId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application token ID.', 'type' => 'string', 'required' => true, 'example' => 'token_sfrwerxxxxxxxxxxxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete an application token',
'summary' => 'Deletes an ApplicationToken.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteApplicationToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/{#ApplicationTokenId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteAuthorizationResource' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationResourceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorized resource ID.', 'type' => 'string', 'required' => true, 'example' => 'arres_01kgh3jvt7pk093rv6giu0c0qxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete an authorized resource',
'summary' => 'Deletes an authorized resource.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteAuthorizationResource',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationResource', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}/authorizationresource/{#AuthorizationResourceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteAuthorizationRule' => [
'summary' => 'Deletes an authorization rule. The authorization rule can be deleted only when it is in the disabled state.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete an authorization rule',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteBrand' => [
'summary' => 'Delete Brand',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCPBRTZ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'BrandId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Brand ID.', 'type' => 'string', 'required' => true, 'example' => 'brand_xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete Brand',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteClientPublicKey' => [
'summary' => 'Deletes a specified application ClientPublicKey.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientPublicKeyId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the application ClientPublicKey.', 'type' => 'string', 'required' => true, 'example' => 'KEYEqDnDJhztiEAwSin7MZoxGcihzCAuxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete a specified application clientPublicKey',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteClientPublicKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/{#ClientPublicKeyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteCloudAccount' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CloudAccountId',
'in' => 'query',
'schema' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'required' => true, 'example' => 'ca_01kmegjc11qa1txxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DeleteCloudAccount',
'summary' => 'Deletes an Alibaba Cloud account resource.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteCloudAccount',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteCloudAccountRole' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CloudAccountId',
'in' => 'query',
'schema' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'required' => true, 'example' => 'ca_01kmegjc11qa1txxxxx', 'title' => ''],
],
[
'name' => 'CloudAccountRoleId',
'in' => 'query',
'schema' => ['description' => 'The ID of the cloud role.', 'type' => 'string', 'required' => true, 'example' => 'carole_01kmek49aqxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DeleteCloudAccountRole',
'summary' => 'Deletes a cloud role from a specified Alibaba Cloud account.',
'description' => 'You must disable the cloud role before you delete it. After you delete the role, all related data is also deleted and cannot be recovered.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteCloudAccountRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/${#CloudAccountId}/cloudaccountrole/{#CloudAccountRoleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteConditionalAccessPolicy' => [
'summary' => 'Deletes a conditional access policy.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231633',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ConditionalAccessPolicyId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the conditional access policy.', 'type' => 'string', 'required' => true, 'example' => 'cap_11111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Delete a conditional access policy',
'description' => 'Before you delete a conditional access policy, make sure that the policy is no longer in use. After the policy is deleted, all configuration data is permanently removed and cannot be recovered.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConditionalAccessPolicy'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteConditionalAccessPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/{#ConditionalAccessPolicyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteCredential' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CredentialId',
'in' => 'query',
'schema' => ['description' => 'Credential ID.', 'type' => 'string', 'required' => true, 'example' => 'cred_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DeleteCredential',
'summary' => 'Deletes a credential resource.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteCredentialProvider' => [
'summary' => 'Deletes a credential provider.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'CredentialProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The credential provider ID.', 'type' => 'string', 'required' => true, 'example' => 'atp_01kr2cmj5gxxx4fvmls2e93dxxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Delete a credential provider',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteCustomField' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGOSU2H'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'FieldId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The field ID.', 'type' => 'string', 'required' => true, 'example' => 'ufd_001', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete an extended character field',
'summary' => 'Deletes an extended character field.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteCustomField',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomField', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customfield/{#FieldId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteCustomPrivacyPolicy' => [
'summary' => 'Deletes a custom clause.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas4TD7D0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'CustomPrivacyPolicyId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The custom clause ID.', 'type' => 'string', 'required' => true, 'example' => 'pp_xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete a custom clause',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteCustomPrivacyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#CustomPrivacyPolicyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteDomain' => [
'summary' => 'Deletes a custom domain name of a specified Employee Identity and Access Management (EIAM) instance. Deletion of the instance initialization domain name or default domain name is rejected.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGK16FE'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'DomainId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The domain name ID.', 'type' => 'string', 'required' => true, 'example' => 'dm_examplexxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete a custom domain name of a specified EIAM instance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDomain'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteDomainProxyToken' => [
'summary' => 'Deletes a proxy token for a specified domain name of an EIAM instance. Only proxy tokens in the disabled state can be deleted.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGK16FE'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'DomainId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The domain name ID.', 'type' => 'string', 'required' => true, 'example' => 'dm_examplexxxxx'],
],
[
'name' => 'DomainProxyTokenId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The domain proxy token ID.', 'type' => 'string', 'required' => true, 'example' => 'pt_examplexxxx'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete a proxy token for a specified EIAM instance domain name',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDomainProxyToken'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteDomainProxyToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'DomainProxyToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}/domainproxytoken/{#DomainProxyTokenId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteFederatedCredentialProvider' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'FederatedCredentialProviderId',
'in' => 'query',
'schema' => ['description' => 'The ID of the federated credential provider.', 'type' => 'string', 'required' => true, 'example' => 'fcp_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DeleteFederatedCredentialProvider',
'summary' => 'Deletes a federated credential provider.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteFederatedCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/{#FederatedCredentialProviderId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteGroup' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas7VNWU7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Group ID.', 'type' => 'string', 'required' => true, 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete an EIAM account group',
'summary' => 'Delete an EIAM account group.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteIdentityProvider' => [
'summary' => 'Deletes an identity provider.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'."\n", 'maxLength' => 64],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The identity provider ID.', 'type' => 'string', 'required' => true, 'example' => 'idp_my664lwkhpicbyzirog3xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete an identity provider',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIdentityProvider'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteInstance' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6GKEFM'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID of the instance to delete.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete an EIAM instance',
'summary' => 'Deletes an Employee Identity and Access Management (EIAM) instance that you no longer use.',
'description' => 'Make sure that the instance is no longer in use. After an EIAM instance is deleted, all related data is deleted.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteNetworkAccessEndpoint' => [
'summary' => 'Deletes a dedicated network access endpoint.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGNRASW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NetworkAccessEndpointId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the dedicated network access endpoint. Only network access endpoints whose NetworkEndpointType is private can be deleted.', 'type' => 'string', 'required' => true, 'example' => 'nae_examplexxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Delete a dedicated network access endpoint',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteNetworkAccessEndpoint'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteNetworkAccessEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteNetworkZone' => [
'summary' => 'Deletes a network zone object.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231617',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NetworkZoneId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The network zone ID.', 'type' => 'string', 'required' => true, 'example' => 'network_11111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Delete a network zone object',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteNetworkZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/{#NetworkZoneId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteOrganizationalUnit' => [
'summary' => 'Deletes a specified EIAM organizational unit. The deletion fails if the organizational unit contains EIAM accounts or child organizational units.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas3S4NKL'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The organizational unit ID.', 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete an EIAM organizational unit',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteOrganizationalUnit'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteOrganizationalUnitChildren' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas3S4NKL'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The organization ID.', 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete an organization and all its accounts and sub-organizations',
'summary' => 'Deletes all data of a specified organization. This operation can force delete all accounts and sub-organizations under the specified organization.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteOrganizationalUnitChildren'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteResourceServerScope' => [
'summary' => 'Deletes a scope permission under a specified ResourceServer.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ResourceServerScopeId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The scope permission ID under the ResourceServer.', 'type' => 'string', 'required' => true, 'example' => 'ress_neg35flu6byysxwutaxu3dxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete a scope permission under a specified resourceServer',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteResourceServerScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ResourceServerScope', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/resourceserverscope/{#ResourceServerScopeId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteUser' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete an EIAM account',
'summary' => 'Deletes a specified EIAM account and purges all information associated with the account.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUser'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteUsers' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'UserIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'A list of account IDs.',
'type' => 'array',
'items' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => 'user_xxaaxa', 'title' => ''],
'required' => true,
'example' => 'u_001',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DeleteUsers',
'summary' => 'Deletes multiple accounts in a batch.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DeleteWebAuthnAuthenticator' => [
'summary' => 'Deletes the specified WebAuthn authenticator.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'user_53eh54zdr6iazeijyep5wcxxxx', 'title' => ''],
],
[
'name' => 'AuthenticatorId',
'in' => 'query',
'schema' => ['description' => 'The authenticator ID.', 'type' => 'string', 'required' => true, 'example' => 'authn_h4x5etphqdasydr67lxxxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DeleteWebAuthnAuthenticator',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableApplication' => [
'summary' => 'Disables an application by changing its status from enabled to disabled, making all capabilities of the application unavailable.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ', 'FEATUREidaasJXI2A5'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Disable an EIAM application',
'description' => 'When you change an application from the enabled state to the disabled state, all features of the application become unavailable (such as SSO and account synchronization). Confirm that you are aware of the risks that this operation may cause.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableApplication'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableApplicationApiInvoke' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasZSI8X0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DisableApplicationApiInvoke',
'summary' => 'Disables the Developer API feature for an Employee Identity and Access Management (EIAM) application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableApplicationApiInvoke'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationApiInvoke',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableApplicationClientSecret' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasJH3YY9'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'."\n", 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the application for which you want to disable a client key.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'."\n", 'maxLength' => 64],
],
[
'name' => 'SecretId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client key ID of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sci_k52x2ru63rlkflina5utgkxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DisableApplicationClientSecret',
'summary' => 'Disables a client key of an Employee Identity and Access Management (EIAM) application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableApplicationClientSecret'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationClientSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/{#SecretId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableApplicationFederatedCredential' => [
'summary' => 'Disables a federated identity credential for an application.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationFederatedCredentialId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application federated identity credential ID.', 'type' => 'string', 'required' => true, 'example' => 'afc_aaaaa1111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Disable an application federated identity credential',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationFederatedCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/{#ApplicationFederatedCredentialId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableApplicationM2MClient' => [
'summary' => 'Disables the machine-to-machine (M2M) client feature for an application. This feature enables an application to act as an OAuth client and make calls to access resources.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DisableApplicationM2MClient',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationM2MClient',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableApplicationProvisioning' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DisableApplicationProvisioning',
'summary' => 'Disables the account synchronization feature for an application in Identity as a Service (IDaaS) Employee Identity and Access Management (EIAM).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableApplicationProvisioning'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationProvisioning',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableApplicationResourceServer' => [
'summary' => 'Disables the ResourceServer capability of a specified application.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Disable the resourceServer capability of a specified application',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationResourceServer',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableApplicationSso' => [
'summary' => 'Disables the single sign-on (SSO) feature for an Employee Identity and Access Management (EIAM) application. This way, employees cannot log on to the application by using SSO.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ', 'FEATUREidaasJXI2A5'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DisableApplicationSso',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableApplicationSso'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationSso',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableApplicationToken' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasSQHOGI'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationTokenId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application token ID.', 'type' => 'string', 'required' => true, 'example' => 'token_sfrwerxxxxxxxxxxxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Disable an application token',
'summary' => 'Disables an application token.',
'description' => 'When you change an application from the enabled state to the disabled state, all features of the application become unavailable, such as SSO and account synchronization. Make sure that you are aware of the risks that this operation may cause.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/{#ApplicationTokenId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableAuthorizationRule' => [
'summary' => 'Disables an authorization rule.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but make sure that the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References: [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Disable an authorization rule',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableBrand' => [
'summary' => 'Disables a brand.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCPBRTZ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'BrandId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The brand ID.', 'type' => 'string', 'required' => true, 'example' => 'brand_xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Disable a brand',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableClientPublicKey' => [
'summary' => 'Disables a specified application ClientPublicKey.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientPublicKeyId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the application ClientPublicKey.', 'type' => 'string', 'required' => true, 'example' => 'KEYEqDnDJhztiEAwSin7MZoxGcihzCAuxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but you must make sure that the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Disable a specified application clientPublicKey',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableClientPublicKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/{#ClientPublicKeyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableCloudAccountRole' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CloudAccountId',
'in' => 'query',
'schema' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => true, 'example' => 'ca_01kmegjc11qa1txxxxx', 'title' => ''],
],
[
'name' => 'CloudAccountRoleId',
'in' => 'query',
'schema' => ['description' => 'The cloud role ID.', 'type' => 'string', 'required' => true, 'example' => 'carole_01kmek49aqxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of the request. Generate a unique value from your client for this parameter. The token can contain only ASCII characters and must be no more than 64 characters in length. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DisableCloudAccountRole',
'summary' => 'Disables a cloud role for a specified Alibaba Cloud account.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableCloudAccountRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/${#CloudAccountId}/cloudaccountrole/{#CloudAccountRoleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableConditionalAccessPolicy' => [
'summary' => 'Disables a conditional access policy.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231629',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ConditionalAccessPolicyId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The conditional access policy ID.', 'type' => 'string', 'required' => true, 'example' => 'cap_11111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Disable a conditional access policy',
'description' => 'When you change a conditional access policy from the enabled state to the disabled state, the policy no longer intercepts requests. Confirm that you are aware of the security risks that this operation may cause.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableConditionalAccessPolicy'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableConditionalAccessPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/{#ConditionalAccessPolicyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableCredential' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CredentialId',
'in' => 'query',
'schema' => ['description' => 'The ID of the credential.', 'type' => 'string', 'required' => true, 'example' => 'cred_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'Ensure idempotence. Generate a unique value on your client for each request. ClientToken supports only ASCII characters and must be no longer than 64 characters. For more information, see [How to Ensure Idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DisableCredential',
'summary' => 'Disables a credential resource.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableCredentialProvider' => [
'summary' => 'Disables a credential provider.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CredentialProviderId',
'in' => 'query',
'schema' => ['description' => 'The credential provider ID.', 'type' => 'string', 'required' => true, 'example' => 'atp_01kr2cmj5gxxx4fvmls2e93dxxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DisableCredentialProvider',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableCustomField' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasWO82PZ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'FieldId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The field ID.', 'type' => 'string', 'required' => true, 'example' => 'ufd_001', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Disable a field',
'summary' => 'Disables a field.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableCustomField',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomField', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customfield/{#FieldId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableCustomPrivacyPolicy' => [
'summary' => 'Disables a custom term.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas4TD7D0'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'CustomPrivacyPolicyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the custom term.', 'type' => 'string', 'required' => true, 'example' => 'pp_xxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Disable a custom term',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableCustomPrivacyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#CustomPrivacyPolicyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableDomainProxyToken' => [
'summary' => 'Disables a specified domain proxy token for an EIAM instance. After the token is disabled, domain usage is affected.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGK16FE'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'DomainId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'example' => 'dm_examplexxxxx'],
],
[
'name' => 'DomainProxyTokenId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The domain proxy token ID.', 'type' => 'string', 'required' => true, 'example' => 'pt_examplexxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Disable a domain proxy token for an EIAM instance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableDomainProxyToken'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableDomainProxyToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'DomainProxyToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}/domainproxytoken/{#DomainProxyTokenId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableFederatedCredentialProvider' => [
'summary' => 'Disables a federated credential provider.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'FederatedCredentialProviderId',
'in' => 'query',
'schema' => ['description' => 'The federated credential provider ID.', 'type' => 'string', 'required' => true, 'example' => 'fcp_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DisableFederatedCredentialProvider',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableFederatedCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/{#FederatedCredentialProviderId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableIdentityProviderAdvancedAbility' => [
'summary' => 'Disables the advanced configuration.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas2HJ3XK'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_12323131xzxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['description' => 'The identity provider ID.', 'type' => 'string', 'required' => true, 'example' => 'idp_11111', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DisableIdentityProviderAdvancedAbility',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableIdentityProviderAuthn' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasOO9F76'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'eiam-111ccc1111', 'maxLength' => 64],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The identity provider ID.', 'type' => 'string', 'required' => true, 'example' => 'idp_11111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Disable authentication',
'summary' => 'Disables authentication.',
'description' => 'When you change an application from the enabled state to the disabled state, all features of the application become unavailable, such as SSO and account synchronization. Make sure that you are aware of the risks that this operation may cause.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableIdentityProviderUdPull' => [
'summary' => 'Disables the inbound synchronization feature of an identity provider.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasOO9F76'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The identity provider ID.', 'type' => 'string', 'required' => true, 'example' => 'idp_my664lwkhpicbyzirog3xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Disable Identity Provider Inbound Synchronization',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableIdentityProviderUdPull'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableInitDomainAutoRedirect' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGK16FE'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Disable automatic redirect from initialization domain to default domain for an EIAM instance',
'summary' => 'Disables automatic redirect from the initialization domain to the default domain for an EIAM instance. After disabling, accessing the portal via the initialization domain will no longer redirect to the default domain.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableInitDomainAutoRedirect'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableInitDomainAutoRedirect',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableInternalAuthenticationSource' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasOO9F76'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_111xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'AuthenticationSourceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the internal authentication source.', 'type' => 'string', 'example' => 'ia_password', 'maxLength' => 64, 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DisableInternalAuthenticationSource',
'summary' => 'Disables an internal authentication source.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableResourceServerCustomSubject' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DisableResourceServerCustomSubject',
'summary' => 'Disables the custom subject feature for a specified resource server.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableResourceServerCustomSubject',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'DisableUser' => [
'summary' => 'Sets an account status to disabled. If the account is already disabled, the operation returns success directly.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas1FXU07'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Disable an EIAM account',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableUser'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableApplication' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ', 'FEATUREidaasJXI2A5'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the application that you want to enable.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'EnableApplication',
'summary' => 'Enables a disabled Employee Identity and Access Management (EIAM) application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableApplication'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableApplicationApiInvoke' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasZSI8X0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'example' => ' idaas_ue2jvisn35ea5lmthk267xxxxx'],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'EnableApplicationApiInvoke',
'summary' => 'You can call the EnableApplicationApiInvoke operation to enable Developer API calls for an EIAM application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableApplicationApiInvoke'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationApiInvoke',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableApplicationClientSecret' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasJH3YY9'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'."\n", 'maxLength' => 64],
],
[
'name' => 'SecretId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client key ID of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sci_k52x2ru63rlkflina5utgkxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'EnableApplicationClientSecret',
'summary' => 'Enables the client key of an application in Identity as a Service (IDaaS) Employee Identity and Access Management (EIAM).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableApplicationClientSecret'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationClientSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/{#SecretId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableApplicationFederatedCredential' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the application.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationFederatedCredentialId',
'in' => 'query',
'schema' => ['description' => 'The ID of the application federated credential.', 'type' => 'string', 'required' => true, 'example' => 'afc_aaaaa1111', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'EnableApplicationFederatedCredential',
'summary' => 'Enables an application federated credential.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationFederatedCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/{#ApplicationFederatedCredentialId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableApplicationM2MClient' => [
'summary' => 'Enables the machine-to-machine (M2M) client feature for an application. This allows the application to act as a caller (an OAuth client) to access resources.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'EnableApplicationM2MClient',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationM2MClient',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableApplicationProvisioning' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'EnableApplicationProvisioning',
'summary' => 'Enables the account synchronization feature for an application in Identity as a Service (IDaaS) Employee Identity and Access Management (EIAM).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableApplicationProvisioning'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationProvisioning',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableApplicationResourceServer' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'EnableApplicationResourceServer',
'summary' => 'Enables the ResourceServer feature for a specified application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationResourceServer',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableApplicationSso' => [
'summary' => 'Enables the SSO feature for an EIAM application.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ', 'FEATUREidaasJXI2A5'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Enable SSO for an EIAM application',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableApplicationSso'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationSso',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableApplicationToken' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasSQHOGI'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationTokenId',
'in' => 'query',
'schema' => ['description' => 'The application token ID.', 'type' => 'string', 'required' => true, 'example' => 'token_sfrwerxxxxxxxxxxxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'EnableApplicationToken',
'summary' => 'Enables an application token.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/{#ApplicationTokenId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableAuthorizationRule' => [
'summary' => 'Enables an authorization rule.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References: [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Enable an authorization rule',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableBrand' => [
'summary' => 'Enables a brand.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCPBRTZ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'BrandId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The brand ID.', 'type' => 'string', 'required' => true, 'example' => 'brand_xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Enable a brand',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableClientPublicKey' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientPublicKeyId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the application ClientPublicKey.', 'type' => 'string', 'required' => true, 'example' => 'KEYEqDnDJhztiEAwSin7MZoxGcihzCAuxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but you must make sure that the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Enable a specified application clientPublicKey',
'summary' => 'Enables a specified application ClientPublicKey.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableClientPublicKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/{#ClientPublicKeyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableCloudAccountRole' => [
'summary' => 'Enables a cloud role for a specified Alibaba Cloud account.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CloudAccountId',
'in' => 'query',
'schema' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'required' => true, 'example' => 'ca_01kmegjc11qa1txxxxx', 'title' => ''],
],
[
'name' => 'CloudAccountRoleId',
'in' => 'query',
'schema' => ['description' => 'The ID of the cloud role.', 'type' => 'string', 'required' => true, 'example' => 'carole_01kmek49aqxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token used to ensure the idempotence of the request. Generate a unique value for this parameter. The token can contain only ASCII characters and must be no more than 64 characters in length. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'EnableCloudAccountRole',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableCloudAccountRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}/cloudaccountrole/{#CloudAccountRoleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableConditionalAccessPolicy' => [
'summary' => 'Enables a conditional access policy.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231628',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ConditionalAccessPolicyId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The conditional access policy ID.', 'type' => 'string', 'required' => true, 'example' => 'cap_11111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Enable a conditional access policy',
'description' => 'When you change a conditional access policy from enabled to disabled, the policy no longer intercepts requests. Confirm that you are aware of the risks that this operation may cause.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableConditionalAccessPolicy'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableConditionalAccessPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/{#ConditionalAccessPolicyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableCredential' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'CredentialId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The credential ID.', 'type' => 'string', 'required' => true, 'example' => 'cred_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References: [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Enable a credential',
'summary' => 'Enables a credential resource.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableCredentialProvider' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CredentialProviderId',
'in' => 'query',
'schema' => ['description' => 'The ID of the credential provider.', 'type' => 'string', 'required' => true, 'example' => 'atp_01kr2cmj5gxxx4fvmls2e93dxxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'EnableCredentialProvider',
'summary' => 'Enables a credential provider.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableCustomField' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasWO82PZ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'FieldId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The field ID.', 'type' => 'string', 'required' => true, 'example' => 'ufd_001', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Enable a field',
'summary' => 'Enables a field.',
'description' => '**Before you use this operation, make sure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/ecs/detail) of IDaaS EIAM.**.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableCustomField',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomField', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customfield/{#FieldId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableCustomPrivacyPolicy' => [
'summary' => 'Enables a custom clause.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas4TD7D0'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'CustomPrivacyPolicyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the custom clause.', 'type' => 'string', 'required' => true, 'example' => 'pp_neagxpoznsjdtxxxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Enable a custom clause',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableCustomPrivacyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#CustomPrivacyPolicyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableDomainProxyToken' => [
'summary' => 'Enables a domain proxy token for a specified EIAM instance domain name to verify domain security.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGK16FE'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'DomainId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The domain name ID.', 'type' => 'string', 'required' => true, 'example' => 'dm_examplexxxxx'],
],
[
'name' => 'DomainProxyTokenId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The domain proxy token ID.', 'type' => 'string', 'required' => true, 'example' => 'pt_examplexxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Enable a domain proxy token for a specified EIAM instance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableDomainProxyToken'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableDomainProxyToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'DomainProxyToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}/domainproxytoken/{#DomainProxyTokenId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableFederatedCredentialProvider' => [
'summary' => 'Enables a federated credential provider.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'title' => '', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
],
[
'name' => 'FederatedCredentialProviderId',
'in' => 'query',
'schema' => ['description' => 'The ID of the federated credential provider.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'title' => '', 'example' => 'fcp_mkv7rgt4d7i4u7zqtzev2mxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'EnableFederatedCredentialProvider',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableFederatedCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/{#FederatedCredentialProviderId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableIdentityProviderAdvancedAbility' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas2HJ3XK'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_111ccc111xx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['description' => 'The identity provider ID.', 'type' => 'string', 'required' => true, 'example' => 'idp_11111', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'EnableIdentityProviderAdvancedAbility',
'summary' => 'Enables advanced configuration.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableIdentityProviderAuthn' => [
'summary' => 'Enables authentication.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasOO9F76'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'eiam-111ccc1111', 'maxLength' => 64],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The identity provider ID.', 'type' => 'string', 'required' => true, 'example' => 'idp_11111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Enable authentication',
'description' => 'When you change a conditional access policy from enabled to disabled, the policy no longer intercepts requests. Make sure that you are aware of the risks that this operation may cause.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableIdentityProviderUdPull' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasOO9F76'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The identity provider ID.', 'type' => 'string', 'required' => true, 'example' => 'idp_my664lwkhpicbyzirog3xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Enable Identity Provider Inbound Synchronization',
'summary' => 'Enables the inbound synchronization feature for an identity provider.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableIdentityProviderUdPull'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableInitDomainAutoRedirect' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGK16FE'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Enable automatic redirection from initialization domain to default domain for an EIAM instance',
'summary' => 'Enables automatic redirection from the initialization domain to the default domain for an EIAM instance. After this feature is enabled, accessing the portal through the initialization domain will redirect to the default domain address.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableInitDomainAutoRedirect'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableInitDomainAutoRedirect',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableInternalAuthenticationSource' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasOO9F76'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_111ccc11xxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'AuthenticationSourceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the internal authentication source.', 'type' => 'string', 'example' => 'ia_password', 'maxLength' => 64, 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'EnableInternalAuthenticationSource',
'summary' => 'Enables an internal authentication source.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableResourceServerCustomSubject' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'EnableResourceServerCustomSubject',
'summary' => 'Enables the custom subject feature for a specified resource server. After this feature is enabled, the subject of an issued access token changes from to :. The `client.activeSubjectUrn` is set in the attribute mapping of the application\'s federated identity provider.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableResourceServerCustomSubject',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'EnableUser' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas1FXU07'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Enable an EIAM account',
'summary' => 'Sets an account to the enabled state.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableUser'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'ExecIdentityProviderMetadataUrlResolution' => [
'summary' => 'Resolves the metadata for an identity provider.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYOPWPR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'OidcIssuer',
'in' => 'query',
'schema' => ['description' => 'The OIDC issuer URL.', 'type' => 'string', 'required' => false, 'example' => 'https://login.example.com/.well-known/openid-configuration', 'maxLength' => 512, 'title' => ''],
],
[
'name' => 'NetworkAccessEndpointId',
'in' => 'query',
'schema' => ['description' => 'The network access endpoint ID.', 'type' => 'string', 'example' => 'inae_public', 'title' => '', 'required' => false],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['description' => 'The ID of the identity provider in IDaaS.', 'type' => 'string', 'example' => 'idp_mwpcwnhrimlr2horxXXXX', 'title' => '', 'required' => false],
],
[
'name' => 'SamlMetadataUrl',
'in' => 'query',
'schema' => ['type' => 'string', 'example' => 'https://dc.test.com/FederationMetadata/2007-06/FederationMetadata.xml', 'title' => '', 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'IdentityProviderMetadata' => [
'type' => 'object',
'properties' => [
'OidcOpenIdConfiguration' => [
'description' => 'The OIDC identity provider metadata.',
'type' => 'object',
'properties' => [
'Issuer' => ['description' => 'The OIDC issuer.', 'type' => 'string', 'title' => '', 'example' => 'https://demo.com/fe974231-3454-4b70-9326-70fb71e41bce/v2.0/'],
'AuthorizationEndpoint' => ['description' => 'The OAuth 2.0 authorization endpoint.', 'type' => 'string', 'title' => '', 'example' => 'https://demo.com/oauth2/default/v1/authorize'],
'JwksUri' => ['description' => 'The OIDC JSON Web Key Set (JWKS) URI.', 'type' => 'string', 'title' => '', 'example' => 'https://demo.com/oauth2/v1/keys'],
'TokenEndpoint' => ['description' => 'The OAuth 2.0 token endpoint.', 'type' => 'string', 'title' => '', 'example' => 'https://demo.com/api/bff/v1.2/developer/oidc/token'],
'UserinfoEndpoint' => ['description' => 'The OIDC userinfo endpoint.', 'type' => 'string', 'title' => '', 'example' => 'https://demo.com/api/bff/v1.2/developer/oidc/userinfo'],
],
'title' => '',
'example' => '',
],
'SamlMetadataConfiguration' => [
'type' => 'object',
'properties' => [
'IdPEntityId' => ['description' => 'The entity ID of the SAML identity provider.', 'type' => 'string', 'example' => 'http://dc.test.com/adfs/services/trust', 'title' => ''],
'IdPSsoUrl' => ['description' => 'The SSO URL of the SAML identity provider.', 'type' => 'string', 'example' => 'https://dc.test.com/adfs/ls/', 'title' => ''],
'Certificates' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Content' => ['description' => 'The content of the certificate.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE----- MIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z -----END CERTIFICATE-----', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => 'The certificates.',
'title' => '',
'example' => '',
],
],
'description' => 'The SAML identity provider metadata.',
'title' => '',
'example' => '',
],
],
'description' => 'The identity provider metadata.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ExecIdentityProviderMetadataUrlResolution',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ExecIdentityProviderMetadataUrlResolution',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"IdentityProviderMetadata\\": {\\n \\"OidcOpenIdConfiguration\\": {\\n \\"Issuer\\": \\"https://demo.com/fe974231-3454-4b70-9326-70fb71e41bce/v2.0/\\",\\n \\"AuthorizationEndpoint\\": \\"https://demo.com/oauth2/default/v1/authorize\\",\\n \\"JwksUri\\": \\"https://demo.com/oauth2/v1/keys\\",\\n \\"TokenEndpoint\\": \\"https://demo.com/api/bff/v1.2/developer/oidc/token\\",\\n \\"UserinfoEndpoint\\": \\"https://demo.com/api/bff/v1.2/developer/oidc/userinfo\\"\\n },\\n \\"SamlMetadataConfiguration\\": {\\n \\"IdPEntityId\\": \\"http://dc.test.com/adfs/services/trust\\",\\n \\"IdPSsoUrl\\": \\"https://dc.test.com/adfs/ls/\\",\\n \\"Certificates\\": [\\n {\\n \\"Content\\": \\"-----BEGIN CERTIFICATE----- MIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z -----END CERTIFICATE-----\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'GenerateDownloadUrlForSynchronizationJob' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAMME3J'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'SynchronizationJobId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The synchronization task ID.', 'type' => 'string', 'required' => true, 'example' => 'sync_000036q9p3jd5s18boeo2dvmmanu2086vxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'FileDownloadUrl' => ['title' => '', 'description' => 'The download URL of the template.', 'type' => 'string', 'example' => 'https://test.oss.aliyuncs.com/idaas_ly77wa2oexrciw5v672vxxxx/tmp/eiam_user_export_1766469463365.csv'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Generate file import result download URL',
'summary' => 'Generates a download URL for file import results.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'eiam:GenerateDownloadUrlForSynchronizationJob',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'SynchronizationJob', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/{#SynchronizationJobId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"FileDownloadUrl\\": \\"https://test.oss.aliyuncs.com/idaas_ly77wa2oexrciw5v672vxxxx/tmp/eiam_user_export_1766469463365.csv\\"\\n}","type":"json"}]',
],
'GenerateFileImportTemplate' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAMME3J'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'TargetType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The synchronization target type. Valid values:'."\n"
.'- identity_provider: identity provider'."\n"
.'- application: application'."\n"
.'- eiam_v2_user_import: IDaaS 2.0 user import.',
'enumValueTitles' => ['identity_provider' => 'Identity provider.', 'application' => 'Application.', 'eiam_v2_user_import' => 'IDaaS 2.0 user import.'],
'type' => 'string',
'required' => true,
'example' => 'eiam_v2_user_import,'."\n"
.'application, identity_provider',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'FileDownloadUrl' => ['title' => '', 'description' => 'The download URL of the template.', 'type' => 'string', 'example' => 'https://test.oss-cn-hangzhou.aliyuncs.com/idaas_ly77wa2oexrciw5v672vxxxx/tmp/eiam_v2_user_import_1766469463365.csv'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Generate file import template',
'summary' => 'Generates a file import template.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:GenerateFileImportTemplate',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"FileDownloadUrl\\": \\"https://test.oss-cn-hangzhou.aliyuncs.com/idaas_ly77wa2oexrciw5v672vxxxx/tmp/eiam_v2_user_import_1766469463365.csv\\"\\n}","type":"json"}]',
],
'GenerateOauthToken' => [
'summary' => 'Obtains an access token for accessing a resource server by using a specified application as the client identity.',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
],
[
'name' => 'ScopeValues',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The permission scopes.',
'type' => 'array',
'items' => ['description' => 'The permission value.', 'type' => 'string', 'required' => false, 'example' => 'User:Read:ALL', 'title' => ''],
'required' => true,
'example' => '',
],
],
[
'name' => 'Audience',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The audience identifier of the resource server.', 'type' => 'string', 'required' => true, 'example' => 'https://example.com'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4XXXXXXX'],
'TokenResponse' => [
'title' => '',
'description' => 'The token response.',
'type' => 'object',
'properties' => [
'TokenType' => ['title' => '', 'description' => 'The token type. Currently, only Bearer is supported.', 'type' => 'string', 'example' => 'Bearer'],
'AccessToken' => ['title' => '', 'description' => 'Access Token。', 'type' => 'string', 'required' => false, 'example' => '***'],
'ExpiresIn' => ['title' => '', 'description' => 'The validity period, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1200'],
'ExpiresAt' => ['title' => '', 'description' => 'The expiration time, in UNIX timestamp format. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1770186372'],
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Generate oAuth token',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'eiam:GenerateOauthToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4XXXXXXX\\",\\n \\"TokenResponse\\": {\\n \\"TokenType\\": \\"Bearer\\",\\n \\"AccessToken\\": \\"***\\",\\n \\"ExpiresIn\\": 1200,\\n \\"ExpiresAt\\": 1770186372\\n }\\n}","type":"json"}]',
],
'GenerateUploadAuth' => [
'summary' => 'Get Upload Authentication',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '123244',
'abilityTreeNodes' => ['FEATUREidaasI2RX2L'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_111ccc11xxxx', 'maxLength' => 64],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'File type.', 'type' => 'string', 'example' => 'image', 'required' => false],
],
[
'name' => 'Purpose',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'File purpose.', 'type' => 'string', 'example' => 'user_import', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'AccessId' => ['title' => '', 'description' => 'Authentication Access ID.', 'type' => 'string', 'example' => 'STS.NYgAmE3cyPoMDxtWgtwG3xxxx'],
'Policy' => ['title' => '', 'description' => 'Authentication policy.', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0xMi0yM1QwNjoxODozNi4zNTZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLHsiYnVja2V0IjoidGVtcC1pZGFhcy1laWFtLWNuLWhhbmd6aG91In0seyJrZXkiOiJpZGFhc19seTc3d2Eyb2V4cmNpdzV2Njcydml6eG12ZS9maWxlX2ltcG9ydC82ODg2NmQyMS0wYWI3LTQ1MGQtYjllNi01YjFlYWZlMDYzZTEifSx7Ingtb3NzLWZvcmJpZC1vdmVyd3JpdGUiOiJ0cnVlIn0seyJ4LW9zcy1vYmplY3QtYWNsIjoicHJpdmF0ZSJxxxx'],
'Signature' => ['title' => '', 'description' => 'Authentication signature.', 'type' => 'string', 'example' => 't3JyykEKg3kHQuUrhaXYxtboUxxxxx'],
'Key' => ['title' => '', 'description' => 'Authentication key.', 'type' => 'string', 'example' => 'idaas-csv://idaas_ly77wa2oexrciw5v672vizxxxx'."\n"
.'/file_import/68866d21-0ab7-450d-b9e6-5b1eafxxxx"'],
'Host' => ['title' => '', 'description' => 'Bucket address host.', 'type' => 'string', 'example' => 'https://temp.oss.aliyuncs.com'],
'Expire' => ['title' => '', 'description' => 'Expiration time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1766470716'],
'DownLoadUrl' => ['title' => '', 'description' => 'Pre-download URL.', 'type' => 'string', 'example' => 'https://temp.oss.aliyuncs.com/idaas_ly77wa2oexrciw5v672vizxxxx/file_import/68866d21-0ab7-450d-b9e6-5b1eafe06xxxx'],
'SecurityToken' => ['description' => 'STS authentication access credential.', 'type' => 'string', 'example' => 'CAISzgJ1q6Ft5B2yfSjIr5rSCtfx3rxY562mRl7Fs2che8gfpbLg1zz2IHhMfXVpA+Afv/sxlG5Q7/wdlrp6SJtIXleCZtF94oxN9h2gb4fb4wgFPgjY08/LI3OaLjKm9u2wCryLYbGwU/OpbE++5U0X6LDmdDKkckW4OJmS8/BOZcgWWQ/KBlgvRq0hRG1YpdQdKGHaONu0LxfumRCwNkdzvRdmgm4NgsbWgO/ks0aO0wehm7BO+N6gfcD9NvMBZskvD42Hu8VtbbfE3SJq7BxHybx7lqQs+02c5onEXwALs0zXbLSErIU2dlBjH68hAOtFquPgnPtzt6nJkID62421pmiSr561rumAtyikcIvBXr5RHT3LoP1LA5UhHC1UotFVgGOaCXLbtuArXptaY/JiNL/0hFEpVt7knInNpUbntINy5f5fqzNMlShqKOXTK93xGoABgfahfEFC23BhLp3NnBxnaG/psewhUfRg/wYS9oE268EST0qPq0ZvzmZjsmtbtnFL8takNDOIdutBZeb9nngkEi7tYyVcwoYBnbJ3sopnFEVozB2VO5XuRHLBkOfB+2z1zD91KtoDajJxpT295Qm0ndFALS1tCGI452yRIrCHynggxxxxx', 'title' => ''],
'EncryptedKey' => ['description' => 'Encrypted file encryption configuration key of the instance.', 'type' => 'string', 'example' => 'eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIiwia2lkIjoia2V5X3Z1ZWhjbmh2NWppcGhmZGJwcWpqd3dsemFhIn0..YetpxsPdqdLvAy6G.0Zy5meoTzvCuNfA_0w7E9ItY2uGu1v1BxR9i98KeHXv_P-sm9w1q0XPf5Fw.55V_jFq2t2ZHdjg5c7uxxxx', 'title' => ''],
'PlaintextKey' => ['description' => 'Plaintext key for encryption configuration.', 'type' => 'string', 'example' => 'fBLqWEvq3SbCj1cX/rtZoSPDVduOWdloOO2VN2+5Sxxxx', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Get Upload Authentication',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:GenerateUploadAuth',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"AccessId\\": \\"STS.NYgAmE3cyPoMDxtWgtwG3xxxx\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyNS0xMi0yM1QwNjoxODozNi4zNTZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLHsiYnVja2V0IjoidGVtcC1pZGFhcy1laWFtLWNuLWhhbmd6aG91In0seyJrZXkiOiJpZGFhc19seTc3d2Eyb2V4cmNpdzV2Njcydml6eG12ZS9maWxlX2ltcG9ydC82ODg2NmQyMS0wYWI3LTQ1MGQtYjllNi01YjFlYWZlMDYzZTEifSx7Ingtb3NzLWZvcmJpZC1vdmVyd3JpdGUiOiJ0cnVlIn0seyJ4LW9zcy1vYmplY3QtYWNsIjoicHJpdmF0ZSJxxxx\\",\\n \\"Signature\\": \\"t3JyykEKg3kHQuUrhaXYxtboUxxxxx\\",\\n \\"Key\\": \\"idaas-csv://idaas_ly77wa2oexrciw5v672vizxxxx\\\\n/file_import/68866d21-0ab7-450d-b9e6-5b1eafxxxx\\\\\\"\\",\\n \\"Host\\": \\"https://temp.oss.aliyuncs.com\\",\\n \\"Expire\\": 1766470716,\\n \\"DownLoadUrl\\": \\"https://temp.oss.aliyuncs.com/idaas_ly77wa2oexrciw5v672vizxxxx/file_import/68866d21-0ab7-450d-b9e6-5b1eafe06xxxx\\",\\n \\"SecurityToken\\": \\"CAISzgJ1q6Ft5B2yfSjIr5rSCtfx3rxY562mRl7Fs2che8gfpbLg1zz2IHhMfXVpA+Afv/sxlG5Q7/wdlrp6SJtIXleCZtF94oxN9h2gb4fb4wgFPgjY08/LI3OaLjKm9u2wCryLYbGwU/OpbE++5U0X6LDmdDKkckW4OJmS8/BOZcgWWQ/KBlgvRq0hRG1YpdQdKGHaONu0LxfumRCwNkdzvRdmgm4NgsbWgO/ks0aO0wehm7BO+N6gfcD9NvMBZskvD42Hu8VtbbfE3SJq7BxHybx7lqQs+02c5onEXwALs0zXbLSErIU2dlBjH68hAOtFquPgnPtzt6nJkID62421pmiSr561rumAtyikcIvBXr5RHT3LoP1LA5UhHC1UotFVgGOaCXLbtuArXptaY/JiNL/0hFEpVt7knInNpUbntINy5f5fqzNMlShqKOXTK93xGoABgfahfEFC23BhLp3NnBxnaG/psewhUfRg/wYS9oE268EST0qPq0ZvzmZjsmtbtnFL8takNDOIdutBZeb9nngkEi7tYyVcwoYBnbJ3sopnFEVozB2VO5XuRHLBkOfB+2z1zD91KtoDajJxpT295Qm0ndFALS1tCGI452yRIrCHynggxxxxx\\",\\n \\"EncryptedKey\\": \\"eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIiwia2lkIjoia2V5X3Z1ZWhjbmh2NWppcGhmZGJwcWpqd3dsemFhIn0..YetpxsPdqdLvAy6G.0Zy5meoTzvCuNfA_0w7E9ItY2uGu1v1BxR9i98KeHXv_P-sm9w1q0XPf5Fw.55V_jFq2t2ZHdjg5c7uxxxx\\",\\n \\"PlaintextKey\\": \\"fBLqWEvq3SbCj1cX/rtZoSPDVduOWdloOO2VN2+5Sxxxx\\"\\n}","type":"json"}]',
],
'GenerateWebAuthnAuthenticatorRegistrationUrl' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'user_e2jvisn35ea5lmthk267xx', 'title' => ''],
],
[
'name' => 'DomainId',
'in' => 'query',
'schema' => ['description' => 'The domain ID.', 'type' => 'string', 'example' => 'dm_nfplcagj5cguo2267bkjxxxx', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'WebAuthnAuthenticatorRegistrationUrl' => [
'type' => 'object',
'properties' => [
'RegistrationUrl' => ['description' => 'The WebAuthn authenticator registration URL.', 'type' => 'string', 'title' => '', 'example' => 'https://012cnaliyunidaas..com./login/webauthn/registration'],
'RegistrationUrlParameters' => ['description' => 'The parameters for the WebAuthn authenticator registration URL.', 'type' => 'string', 'title' => '', 'example' => 'eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIiwia2lkIjoia2V5X29ueWNzbXNib3Y1bmV2anlncHgyZnlsbjdhIn0'],
],
'description' => 'Information about the WebAuthn authenticator registration URL.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'GenerateWebAuthnAuthenticatorRegistrationUrl',
'summary' => 'Generates a WebAuthn authenticator registration URL.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"WebAuthnAuthenticatorRegistrationUrl\\": {\\n \\"RegistrationUrl\\": \\"https://012cnaliyunidaas..com./login/webauthn/registration\\",\\n \\"RegistrationUrlParameters\\": \\"eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIiwia2lkIjoia2V5X29ueWNzbXNib3Y1bmV2anlncHgyZnlsbjdhIn0\\"\\n }\\n}","type":"json"}]',
],
'GetApplication' => [
'summary' => 'Retrieves the details of a specified EIAM application.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '119367',
'abilityTreeNodes' => ['FEATUREidaasZSI8X0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'Application' => [
'description' => 'The returned application information.',
'type' => 'object',
'properties' => [
'ApiInvokeStatus' => ['title' => '', 'description' => 'The status of the Developer API feature for the application. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'disabled'],
'ApplicationVisibility' => [
'description' => 'The application visibility.',
'type' => 'array',
'items' => ['description' => 'The application visibility.', 'type' => 'string', 'example' => '[web]', 'title' => ''],
'title' => '',
'example' => '',
],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'ApplicationName' => ['title' => '', 'description' => 'The application name.', 'type' => 'string', 'example' => 'SAML application'],
'ApplicationSourceType' => ['title' => '', 'description' => 'The source from which the application was created. Valid values:'."\n"
.'- urn:alibaba:idaas:app:source:template: Application template.'."\n"
.'- urn:alibaba:idaas:app:source:standard: Standard protocol.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:app:source:template'],
'ApplicationTemplateId' => ['title' => '', 'description' => 'The ID of the application template associated during creation. This value is returned only when the application was created from an application template.', 'type' => 'string', 'example' => 'apt_rpa_tdsxxx'],
'AuthorizationType' => ['title' => '', 'description' => 'The access authorization type of the application. Valid values:'."\n"
.'- authorize\\_required: Explicit authorization is required for access.'."\n"
.'- default\\_all: All members have access permissions by default.', 'type' => 'string', 'example' => 'authorize_required'],
'ClientId' => ['title' => '', 'description' => 'The client ID of the application.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'CreateTime' => ['title' => '', 'description' => 'The time when the application was created. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
'Description' => ['title' => '', 'description' => 'The application description.', 'type' => 'string', 'example' => 'An application for test environment'],
'Features' => ['title' => '', 'description' => 'The features supported by the application, returned as a JSON array string. Valid values:'."\n"
.'- sso: Single sign-on.'."\n"
.'- provision: Account synchronization.'."\n"
.'- api\\_invoke: API access.', 'type' => 'string', 'example' => '["sso", "provision"]'],
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'LogoUrl' => ['title' => '', 'description' => 'The URL of the application logo.', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg'],
'ManagedServiceCode' => ['title' => '', 'description' => 'The ServiceCode of the cloud service that manages the application template.', 'type' => 'string', 'example' => 'rpa'],
'ServiceManaged' => ['title' => '', 'description' => 'Indicates whether the application template is managed by a cloud service.', 'type' => 'boolean', 'example' => 'true'],
'SsoType' => ['title' => '', 'description' => 'The single sign-on protocol. Valid values:'."\n"
.'- saml2: SAML 2.0 protocol.'."\n"
.'- oidc: OpenID Connect protocol.'."\n"
.'- oauth2/m2m: OAuth 2.0 protocol.'."\n"
.'- oidc+oauth2/m2m: OpenID Connect and OAuth 2.0 protocols.', 'type' => 'string', 'example' => 'saml2'],
'Status' => ['title' => '', 'description' => 'The application status. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enabled'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the application was last updated. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
'M2MClientStatus' => ['title' => '', 'description' => 'The M2MClient status.', 'type' => 'string', 'example' => 'enabled'],
'ResourceServerStatus' => ['title' => '', 'description' => 'The ResourceServer status.', 'type' => 'string', 'example' => 'enabled'],
'ResourceServerIdentifier' => ['title' => '', 'description' => 'The unique identifier of the ResourceServer, which corresponds to the ResourceServer audience.', 'type' => 'string', 'example' => 'https://www.example.com'],
'CustomSubjectStatus' => ['description' => 'Indicates whether the custom Subject field in the token is enabled. After this feature is enabled, the issued Access Token changes from \\ to \\:\\, where client.activeSubjectUrn is configured in the attribute mapping of the federated identity credential of the application.', 'type' => 'string', 'example' => 'enabled', 'title' => ''],
'ApplicationCreationType' => [
'title' => '',
'description' => 'The application creation type.',
'enumValueTitles' => ['user_custom' => 'User-created.', 'system_init' => 'System-created.'],
'type' => 'string',
'example' => 'user_custom',
'enum' => ['user_custom', 'system_init'],
],
'ResourceServerSourceType' => [
'title' => '',
'description' => 'The resource server source type.',
'enumValueTitles' => ['urn:cloud:idaas:resourceserver:source:custom' => 'Custom.', 'urn:cloud:idaas:resourceserver:source:system' => 'System.'],
'type' => 'string',
'example' => 'urn:cloud:idaas:resourceserver:source:custom',
'enum' => ['urn:cloud:idaas:resourceserver:source:custom', 'urn:cloud:idaas:resourceserver:source:system'],
],
'ApplicationIdentityType' => [
'description' => 'The application identity type. Valid values:'."\n"
.'- application: Application.'."\n"
.'- agent: Agent.',
'enumValueTitles' => ['agent' => 'agent.', 'application' => 'application.'],
'type' => 'string',
'example' => 'application',
'title' => '',
],
'CustomFields' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FieldName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'FieldValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => '',
'title' => '',
'example' => '',
],
'ApplicationOwner' => [
'type' => 'object',
'properties' => [
'UserIds' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
'GroupIds' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'SmartConfigCapabilities' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'gatewayOptions' => [
'gatewayProtocols' => [],
],
'title' => 'Query the details of an EIAM application',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplication'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Application\\": {\\n \\"ApiInvokeStatus\\": \\"disabled\\",\\n \\"ApplicationVisibility\\": [\\n \\"[web]\\"\\n ],\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"ApplicationName\\": \\"SAML application\\",\\n \\"ApplicationSourceType\\": \\"urn:alibaba:idaas:app:source:template\\",\\n \\"ApplicationTemplateId\\": \\"apt_rpa_tdsxxx\\",\\n \\"AuthorizationType\\": \\"authorize_required\\",\\n \\"ClientId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"CreateTime\\": 1649830226000,\\n \\"Description\\": \\"An application for test environment\\",\\n \\"Features\\": \\"[\\\\\\"sso\\\\\\", \\\\\\"provision\\\\\\"]\\",\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"LogoUrl\\": \\"https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg\\",\\n \\"ManagedServiceCode\\": \\"rpa\\",\\n \\"ServiceManaged\\": true,\\n \\"SsoType\\": \\"saml2\\",\\n \\"Status\\": \\"enabled\\",\\n \\"UpdateTime\\": 1649830226000,\\n \\"M2MClientStatus\\": \\"enabled\\",\\n \\"ResourceServerStatus\\": \\"enabled\\",\\n \\"ResourceServerIdentifier\\": \\"https://www.example.com\\",\\n \\"CustomSubjectStatus\\": \\"enabled\\",\\n \\"ApplicationCreationType\\": \\"user_custom\\",\\n \\"ResourceServerSourceType\\": \\"urn:cloud:idaas:resourceserver:source:custom\\",\\n \\"ApplicationIdentityType\\": \\"application\\",\\n \\"CustomFields\\": [\\n {\\n \\"FieldName\\": \\"\\",\\n \\"FieldValue\\": \\"\\"\\n }\\n ],\\n \\"ApplicationOwner\\": {\\n \\"UserIds\\": [\\n \\"\\"\\n ],\\n \\"GroupIds\\": [\\n \\"\\"\\n ]\\n },\\n \\"SmartConfigCapabilities\\": [\\n \\"\\"\\n ]\\n }\\n}","type":"json"}]',
],
'GetApplicationAdvancedConfig' => [
'summary' => 'Retrieves the advanced configuration of an application.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ', 'FEATUREidaasJXI2A5'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'ApplicationAdvancedConfig' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The ID of the IDaaS EIAM instance.', 'type' => 'string', 'title' => '', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'ScimServerAdvancedConfig' => [
'description' => 'The advanced configuration of the SCIM server.',
'type' => 'object',
'properties' => [
'UserCustomFieldNamespace' => ['description' => 'The namespace of the user extension fields.', 'type' => 'string', 'title' => '', 'example' => 'urn:ietf:params:scim:schemas:extension:customfield:2.0:User'."\n"],
'SupportedUserCustomFieldIds' => [
'description' => 'A list of IDs of the supported custom user fields.',
'type' => 'array',
'items' => ['description' => 'The ID of a supported custom user field.', 'type' => 'string', 'example' => 'ufd_ymjguxxxxxxxx', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => 'The advanced configuration of the application.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'GetApplicationAdvancedConfig',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationAdvancedConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationAdvancedConfig\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"ScimServerAdvancedConfig\\": {\\n \\"UserCustomFieldNamespace\\": \\"urn:ietf:params:scim:schemas:extension:customfield:2.0:User\\\\n\\",\\n \\"SupportedUserCustomFieldIds\\": [\\n \\"ufd_ymjguxxxxxxxx\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'GetApplicationFederatedCredential' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationFederatedCredentialId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application federated credential ID.', 'type' => 'string', 'required' => true, 'example' => 'afc_aaaaa1111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ApplicationFederatedCredential' => [
'description' => 'The application federated credential object.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'ApplicationFederatedCredentialId' => ['title' => '', 'description' => 'The application federated credential ID.', 'type' => 'string', 'example' => 'afc_aaaaa1111'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'FederatedCredentialProviderId' => ['title' => '', 'description' => 'The federated trust source ID.', 'type' => 'string', 'example' => 'fcp_asda1dasdxxxx'],
'ApplicationFederatedCredentialType' => ['title' => '', 'description' => 'The application federated credential type.', 'type' => 'string', 'example' => 'oidc'],
'ApplicationFederatedCredentialName' => ['title' => '', 'description' => 'The application federated credential name.', 'type' => 'string', 'example' => 'test'],
'Status' => ['title' => '', 'description' => 'The application federated credential status.', 'type' => 'string', 'example' => 'enabled'],
'Description' => ['title' => '', 'description' => 'The application federated credential description.', 'type' => 'string', 'example' => 'test'],
'CreateTime' => ['title' => '', 'description' => 'The time when the credential was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1758785994982'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the credential was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1758785994982'],
'LastUsedTime' => ['title' => '', 'description' => 'The time when the credential was last used.', 'type' => 'integer', 'format' => 'int64', 'example' => '1758785994982'],
'AttributeMappings' => [
'title' => '',
'description' => 'The attribute mappings.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SourceValueExpression' => ['title' => '', 'description' => 'The source value expression.', 'type' => 'string', 'example' => 'Append(client.applicationFederatedCredentialId, ":", cert.subject.CN, ":", cert.serialNumber)'],
'TargetField' => ['title' => '', 'description' => 'The target field.', 'type' => 'string', 'example' => 'client.activeSubjectUrn'."\n"],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
'VerificationCondition' => ['title' => '', 'description' => 'The verification condition.', 'type' => 'string', 'example' => 'Equals(cert.subject.CN, "test")'],
'VerificationMode' => ['description' => 'The verification mode. Valid values: freedom and structured.', 'type' => 'string', 'title' => '', 'example' => ''],
'OidcVerificationConfig' => [
'description' => 'The OIDC structured configuration. This parameter applies when the verification mode is structured and the credential type is oidc.',
'type' => 'object',
'properties' => [
'Profile' => ['description' => 'The OIDC scenario profile. Valid values: generic, kubernetes, gcp_vm, and azure_vm.', 'type' => 'string', 'title' => '', 'example' => ''],
'KubernetesConfig' => [
'description' => 'The Kubernetes scenario configuration.',
'type' => 'object',
'properties' => [
'Namespace' => ['description' => 'The Kubernetes namespace.', 'type' => 'string', 'title' => '', 'example' => ''],
'ServiceAccountName' => ['description' => 'The Kubernetes service account name.', 'type' => 'string', 'title' => '', 'example' => ''],
'PodNamePrefix' => ['description' => 'The pod name prefix.', 'type' => 'string', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'GcpVmConfig' => [
'description' => 'The GCP VM scenario configuration.',
'type' => 'object',
'properties' => [
'ServiceAccountId' => ['description' => 'The service account ID that corresponds to the sub claim.', 'type' => 'string', 'title' => '', 'example' => ''],
'InstanceIds' => [
'description' => 'The list of VM instance IDs. A maximum of 10 instance IDs are supported.',
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
'ProjectId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'AzureVmConfig' => [
'description' => 'The Azure VM scenario configuration.',
'type' => 'object',
'properties' => [
'ResourceGroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'SubscriptionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'VmNames' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
'PrincipalId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'GenericConfig' => [
'type' => 'object',
'properties' => [
'Subject' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Pkcs7VerificationConfig' => [
'description' => 'The PKCS#7 structured configuration. This parameter applies when the verification mode is structured and the credential type is pkcs7.',
'type' => 'object',
'properties' => [
'InstanceIds' => [
'description' => 'The list of allowed instance IDs. A maximum of 10 instance IDs are supported.',
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Retrieve an application federated credential',
'summary' => 'Retrieves the federated identity credential of an application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationFederatedCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/{#ApplicationFederatedCredentialId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationFederatedCredential\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"ApplicationFederatedCredentialId\\": \\"afc_aaaaa1111\\",\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"FederatedCredentialProviderId\\": \\"fcp_asda1dasdxxxx\\",\\n \\"ApplicationFederatedCredentialType\\": \\"oidc\\",\\n \\"ApplicationFederatedCredentialName\\": \\"test\\",\\n \\"Status\\": \\"enabled\\",\\n \\"Description\\": \\"test\\",\\n \\"CreateTime\\": 1758785994982,\\n \\"UpdateTime\\": 1758785994982,\\n \\"LastUsedTime\\": 1758785994982,\\n \\"AttributeMappings\\": [\\n {\\n \\"SourceValueExpression\\": \\"Append(client.applicationFederatedCredentialId, \\\\\\":\\\\\\", cert.subject.CN, \\\\\\":\\\\\\", cert.serialNumber)\\",\\n \\"TargetField\\": \\"client.activeSubjectUrn\\\\n\\"\\n }\\n ],\\n \\"VerificationCondition\\": \\"Equals(cert.subject.CN, \\\\\\"test\\\\\\")\\",\\n \\"VerificationMode\\": \\"\\",\\n \\"OidcVerificationConfig\\": {\\n \\"Profile\\": \\"\\",\\n \\"KubernetesConfig\\": {\\n \\"Namespace\\": \\"\\",\\n \\"ServiceAccountName\\": \\"\\",\\n \\"PodNamePrefix\\": \\"\\"\\n },\\n \\"GcpVmConfig\\": {\\n \\"ServiceAccountId\\": \\"\\",\\n \\"InstanceIds\\": [\\n \\"\\"\\n ],\\n \\"ProjectId\\": \\"\\"\\n },\\n \\"AzureVmConfig\\": {\\n \\"ResourceGroupName\\": \\"\\",\\n \\"SubscriptionId\\": \\"\\",\\n \\"VmNames\\": [\\n \\"\\"\\n ],\\n \\"PrincipalId\\": \\"\\"\\n },\\n \\"GenericConfig\\": {\\n \\"Subject\\": \\"\\"\\n }\\n },\\n \\"Pkcs7VerificationConfig\\": {\\n \\"InstanceIds\\": [\\n \\"\\"\\n ]\\n }\\n }\\n}","type":"json"}]',
],
'GetApplicationGrantScope' => [
'summary' => 'Queries the Developer API authorization scope of an EIAM application.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasF356YC'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'."\n", 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'."\n", 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ApplicationGrantScope' => [
'title' => '',
'description' => 'The authorization scope.',
'type' => 'object',
'properties' => [
'GrantScopes' => [
'title' => '',
'description' => 'The collection of API authorization scopes.',
'type' => 'array',
'items' => ['description' => 'The API authorization scope. Valid values:'."\n"
.'- urn:alibaba:idaas:scope:user:read\\_all: the permission to query all users.'."\n"
.'- urn:alibaba:idaas:scope:user:manage\\_all: the permission to manage all users.'."\n"
.'- urn:alibaba:idaas:scope:organizational\\_unit:read\\_all: the permission to query all organizational units.'."\n"
.'- urn:alibaba:idaas:scope:organizational\\_unit:manage\\_all: the permission to manage all organizational units.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:scope:user:read_all ', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query the developer API authorization scope of an EIAM application',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplicationGrantScope'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationGrantScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationGrantScope\\": {\\n \\"GrantScopes\\": [\\n \\"urn:alibaba:idaas:scope:user:read_all \\"\\n ]\\n }\\n}","type":"json"}]',
],
'GetApplicationProvisioningConfig' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'ApplicationProvisioningConfig' => [
'description' => 'The account synchronization configuration of the application.',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'ProvisionProtocolType' => ['description' => 'The protocol type for application synchronization. Valid values:'."\n"
."\n"
.'- idaas\\_callback: the custom event callback protocol of IDaaS.'."\n"
."\n"
.'- scim2: the System for Cross-domain Identity Management (SCIM) protocol.', 'type' => 'string', 'title' => '', 'example' => 'idaas_callback'],
'ProvisionJwksEndpoint' => ['description' => 'The public key endpoint for signature verification of application synchronization callback messages.', 'type' => 'string', 'title' => '', 'example' => 'https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk267xxxxx/app_mkv7rgt4d7i4u7zqtzev2mxxxx/provisioning/jwks'],
'CallbackProvisioningConfig' => [
'title' => '',
'description' => 'The configuration parameters for the custom event callback protocol of IDaaS.',
'type' => 'object',
'properties' => [
'CallbackUrl' => ['description' => 'The destination address where the application receives IDaaS event callbacks.', 'type' => 'string', 'example' => 'https://example.com/event/callback', 'title' => ''],
'EncryptKey' => ['description' => 'The symmetric key for encrypting and decrypting IDaaS event callbacks. This key uses the AES-256 algorithm and is in hexadecimal format.', 'type' => 'string', 'example' => '1adfdfdfd******111', 'title' => ''],
'EncryptRequired' => ['description' => 'Indicates whether to encrypt IDaaS event callback messages. Valid values:'."\n"
."\n"
.'- true: The messages are encrypted.'."\n"
."\n"
.'- false: The messages are not encrypted and are transmitted in plaintext.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ListenEventScopes' => [
'title' => '',
'description' => 'The list of message types for the IDaaS event callback listener.',
'type' => 'array',
'items' => ['description' => ''."\n"
."\n"
.'Message type for the IDaaS event callback listener. For a list of valid values, see [Address Book Events](https://www.alibabacloud.com/help/zh/idaas/eiam/developer-reference/callback-events?spm=a2c63.p38356.0.0.68ec1103TPulue).'."\n"
."\n"
.''."\n"
."\n"
.''."\n"
."\n"
.'The message type for the IDaaS event callback listener. For more information about valid values, see [Address book events](https://www.alibabacloud.com/help/en/idaas/eiam/developer-reference/callback-events).'."\n"
."\n"
.'', 'type' => 'string', 'example' => 'urn:alibaba:idaas:app:event:ud:user:create', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
'ProvisionPassword' => ['description' => 'Indicates whether to synchronize passwords in IDaaS user event callbacks. Valid values:'."\n"
."\n"
.'- true: Passwords are synchronized.'."\n"
."\n"
.'- false: Passwords are not synchronized.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ScimProvisioningConfig' => [
'title' => '',
'description' => 'The configuration parameters for IDaaS SCIM protocol synchronization.',
'type' => 'object',
'properties' => [
'ScimBaseUrl' => ['description' => 'The base URL where the application receives IDaaS SCIM protocol synchronization.', 'type' => 'string', 'title' => '', 'example' => 'https://example.com/scim'],
'AuthnConfiguration' => [
'title' => '',
'description' => 'The configuration parameters for SCIM protocol synchronization.',
'type' => 'object',
'properties' => [
'AuthnMode' => ['description' => 'The authorization mode for the SCIM protocol interface. Valid values:'."\n"
."\n"
.'- oauth2: OAuth2 mode.', 'type' => 'string', 'title' => '', 'example' => 'oauth2'],
'GrantType' => ['description' => 'The authorization mode for the SCIM protocol. Valid values:'."\n"
."\n"
.'- client\\_credentials: client credentials mode.'."\n"
."\n"
.'- bearer\\_token: bearer token mode.', 'type' => 'string', 'title' => '', 'example' => 'bearer_token'],
'AuthnParam' => [
'title' => '',
'description' => 'The authorization configuration parameters. Usage:'."\n"
."\n"
.'- If GrantType is set to client\\_credentials, you must specify ClientId, ClientSecret, and AuthnMethod.'."\n"
."\n"
.'- If GrantType is set to bearer\\_token, you must specify AccessToken.',
'type' => 'object',
'properties' => [
'AccessToken' => ['title' => '', 'description' => 'The access token. This parameter is required when GrantType is set to bearer\\_token.', 'type' => 'string', 'example' => 'k52x2ru63rlkflina5utgkxxxx'],
'TokenEndpoint' => ['description' => 'The token endpoint.', 'type' => 'string', 'title' => '', 'example' => 'https://www.example.com/oauth/token'],
'ClientId' => ['title' => '', 'description' => 'The client ID of the application.', 'type' => 'string', 'example' => 'mkv7rgt4d7i4u7zqtzev2mxxxx'],
'ClientSecret' => ['title' => '', 'description' => 'The client secret of the application.', 'type' => 'string', 'example' => 'CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx'."\n"],
'AuthnMethod' => ['title' => '', 'description' => 'The authentication mode for the SCIM protocol. Valid values:'."\n"
."\n"
.'- client\\_secret\\_basic: The key is passed in the request header.'."\n"
."\n"
.'- client\\_secret\\_post: The key is passed in the request body.', 'type' => 'string', 'example' => 'client_secret_basic'],
],
'example' => '',
],
],
'example' => '',
],
'ProvisioningActions' => [
'title' => '',
'description' => 'The operations on the target resource for the SCIM protocol. Valid values:'."\n"
."\n"
.'- urn:alibaba:idaas:app:scim:User:CREATE: creates an account.'."\n"
."\n"
.'- urn:alibaba:idaas:app:scim:User:UPDATE: updates an account.'."\n"
."\n"
.'- urn:alibaba:idaas:app:scim:User:DELETE: deletes an account.',
'type' => 'array',
'items' => ['description' => 'The operation on the target resource for the SCIM protocol.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:app:scim:User:CREATE', 'title' => ''],
'example' => '',
],
'FullPushScopes' => [
'title' => '',
'description' => 'The scope of a full push for the SCIM protocol. Valid values:'."\n"
."\n"
.'- urn:alibaba:idaas:app:scim:User:PUSH: performs a full synchronization of users.',
'type' => 'array',
'items' => ['description' => 'The scope of a full push for the SCIM protocol.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:app:scim:User:PUSH', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
'Status' => ['description' => 'The status of the IDaaS account synchronization feature. Valid values:'."\n"
."\n"
.'- enabled: The feature is enabled.'."\n"
."\n"
.'- disabled: The feature is disabled.', 'type' => 'string', 'title' => '', 'example' => 'enabled'],
'ConfigOperateMode' => ['description' => 'The rendering mode of the account synchronization page. Valid values:'."\n"
."\n"
.'- standard: standard mode.'."\n"
."\n"
.'- template: template mode.', 'type' => 'string', 'title' => '', 'example' => 'standard'],
'NetworkAccessEndpointId' => ['description' => 'The network endpoint ID.', 'type' => 'string', 'example' => 'nae_examplexxxx', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'GetApplicationProvisioningConfig',
'summary' => 'Retrieves the account synchronization configuration for an Entity Identity and Access Management (EIAM) application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplicationProvisioningConfig'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationProvisioningConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationProvisioningConfig\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"ProvisionProtocolType\\": \\"idaas_callback\\",\\n \\"ProvisionJwksEndpoint\\": \\"https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk267xxxxx/app_mkv7rgt4d7i4u7zqtzev2mxxxx/provisioning/jwks\\",\\n \\"CallbackProvisioningConfig\\": {\\n \\"CallbackUrl\\": \\"https://example.com/event/callback\\",\\n \\"EncryptKey\\": \\"1adfdfdfd******111\\",\\n \\"EncryptRequired\\": true,\\n \\"ListenEventScopes\\": [\\n \\"urn:alibaba:idaas:app:event:ud:user:create\\"\\n ]\\n },\\n \\"ProvisionPassword\\": true,\\n \\"ScimProvisioningConfig\\": {\\n \\"ScimBaseUrl\\": \\"https://example.com/scim\\",\\n \\"AuthnConfiguration\\": {\\n \\"AuthnMode\\": \\"oauth2\\",\\n \\"GrantType\\": \\"bearer_token\\",\\n \\"AuthnParam\\": {\\n \\"AccessToken\\": \\"k52x2ru63rlkflina5utgkxxxx\\",\\n \\"TokenEndpoint\\": \\"https://www.example.com/oauth/token\\",\\n \\"ClientId\\": \\"mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"ClientSecret\\": \\"CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx\\\\n\\",\\n \\"AuthnMethod\\": \\"client_secret_basic\\"\\n }\\n },\\n \\"ProvisioningActions\\": [\\n \\"urn:alibaba:idaas:app:scim:User:CREATE\\"\\n ],\\n \\"FullPushScopes\\": [\\n \\"urn:alibaba:idaas:app:scim:User:PUSH\\"\\n ]\\n },\\n \\"Status\\": \\"enabled\\",\\n \\"ConfigOperateMode\\": \\"standard\\",\\n \\"NetworkAccessEndpointId\\": \\"nae_examplexxxx\\"\\n }\\n}","type":"json"}]',
],
'GetApplicationProvisioningScope' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '137231',
'abilityTreeNodes' => ['FEATUREidaas60YEMV'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ApplicationProvisioningScope' => [
'title' => '',
'description' => 'The scope of account synchronization.'."\n",
'type' => 'object',
'properties' => [
'OrganizationalUnitIds' => [
'title' => '',
'description' => 'The list of organizational units that are authorized for account synchronization.'."\n",
'type' => 'array',
'items' => ['description' => 'An organizational unit that is authorized for account synchronization.'."\n", 'type' => 'string', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'title' => ''],
'example' => '',
],
'GroupIds' => [
'title' => '',
'description' => 'Synchronize the list of authorized groups.',
'type' => 'array',
'items' => ['type' => 'string', 'example' => 'group_4iwmw6vfga5zddghppisezxxxxx', 'description' => 'Synchronize the list of authorized groups.', 'title' => ''],
'example' => '',
],
'UsedQuota' => ['title' => '', 'description' => 'Indicates the quota number of used authorized agents.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'MaxQuota' => ['title' => '', 'description' => 'Instance Indicates the maximum quota number of authorized agents.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
],
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'GetApplicationProvisioningScope',
'summary' => 'Queries the account synchronization scope of applications in Identity as a Service (IDaaS) Employee IAM (EIAM). This scope is the same as the scope within which developers can call the DeveloperAPI to query and manage accounts.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplicationProvisioningScope'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationProvisioningScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationProvisioningScope\\": {\\n \\"OrganizationalUnitIds\\": [\\n \\"ou_wovwffm62xifdziem7an7xxxxx\\"\\n ],\\n \\"GroupIds\\": [\\n \\"group_4iwmw6vfga5zddghppisezxxxxx\\"\\n ],\\n \\"UsedQuota\\": 10,\\n \\"MaxQuota\\": 1000\\n }\\n}","type":"json"}]',
],
'GetApplicationProvisioningUserPrimaryOrganizationalUnit' => [
'summary' => 'Queries the synchronization configuration of a specified application.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasSQHOGI'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'UserPrimaryOrganizationalUnitId' => ['description' => 'The user\'s primary organizational unit for application synchronization.', 'type' => 'string', 'title' => '', 'example' => 'ou_12121xxxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'GetApplicationProvisioningUserPrimaryOrganizationalUnit',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationProvisioningUserPrimaryOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"UserPrimaryOrganizationalUnitId\\": \\"ou_12121xxxxxx\\"\\n}","type":"json"}]',
],
'GetApplicationRole' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationRoleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application role ID.', 'type' => 'string', 'required' => true, 'example' => 'approle_01kh2vuo8v9splv8maak1d22rxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ApplicationRole' => [
'description' => 'The application role information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'ApplicationRoleId' => ['title' => '', 'description' => 'The application role ID.', 'type' => 'string', 'example' => 'approle_01kh2vuo8v9splv8maak1d22rxxxx'],
'ApplicationRoleName' => ['title' => '', 'description' => 'The application role name.', 'type' => 'string', 'example' => 'Admin Role'],
'ApplicationRoleValue' => ['title' => '', 'description' => 'The application role value.', 'type' => 'string', 'example' => 'admin_role'],
'Description' => ['title' => '', 'description' => 'The application role description.', 'type' => 'string', 'example' => 'Admin Role Description'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Retrieve application role information',
'summary' => 'Retrieves application role information.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationrole/{#ApplicationRoleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationRole\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxx\\",\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"ApplicationRoleId\\": \\"approle_01kh2vuo8v9splv8maak1d22rxxxx\\",\\n \\"ApplicationRoleName\\": \\"Admin Role\\",\\n \\"ApplicationRoleValue\\": \\"admin_role\\",\\n \\"Description\\": \\"Admin Role Description\\"\\n }\\n}","type":"json"}]',
],
'GetApplicationSsoConfig' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '117713',
'abilityTreeNodes' => ['FEATUREidaasDDL9A8'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'ApplicationSsoConfig' => [
'description' => 'The SSO configuration of the application.',
'type' => 'object',
'properties' => [
'SamlSsoConfig' => [
'title' => '',
'description' => 'The SSO configuration parameters for the application that uses Security Assertion Markup Language (SAML) 2.0. This parameter is returned only when the application uses SAML 2.0 for SSO.',
'type' => 'object',
'properties' => [
'SpSsoAcsUrl' => ['description' => 'The SAML assertion consumer service (ACS) URL of the application (service provider).', 'type' => 'string', 'title' => '', 'example' => 'https://signin.aliyun.com/saml-role/sso'],
'SpEntityId' => ['description' => 'The SAML EntityID of the application (service provider).', 'type' => 'string', 'example' => 'urn:alibaba:cloudcomputing', 'title' => ''],
'NameIdFormat' => ['description' => 'The format of the NameID in the SAML protocol. Valid values:'."\n"
."\n"
.'- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified: Unspecified. The application determines how to parse the NameID.'."\n"
."\n"
.'- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress: Email address format.'."\n"
."\n"
.'- urn:oasis:names:tc:SAML:2.0:nameid-format:persistent: Persistent NameID.'."\n"
."\n"
.'- urn:oasis:names:tc:SAML:2.0:nameid-format:transient: Transient NameID.', 'type' => 'string', 'example' => 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified', 'title' => ''],
'NameIdValueExpression' => ['description' => 'The expression used to generate the value of the NameID in the SAML assertion.', 'type' => 'string', 'title' => '', 'example' => 'user.username'],
'DefaultRelayState' => ['description' => 'The default value of RelayState. If the SSO is initiated by EIAM, the RelayState in the SAML response is set to this value.', 'type' => 'string', 'example' => 'https://home.console.aliyun.com', 'title' => ''],
'SignatureAlgorithm' => ['description' => 'The signature algorithm for the SAML assertion.', 'type' => 'string', 'example' => 'RSA-SHA256', 'title' => ''],
'ResponseSigned' => ['description' => 'Indicates whether the response needs to be signed. ResponseSigned and AssertionSigned cannot both be false.'."\n"
."\n"
.'- true: The response must be signed.'."\n"
."\n"
.'- false: The response does not need to be signed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'AssertionSigned' => ['description' => 'Indicates whether the assertion needs to be signed. ResponseSigned and AssertionSigned cannot both be false.'."\n"
."\n"
.'- true: The assertion must be signed.'."\n"
."\n"
.'- false: The assertion does not need to be signed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'AttributeStatements' => [
'title' => '',
'description' => 'The configuration of additional user attributes in the SAML assertion.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AttributeName' => ['description' => 'The name of the attribute in the SAML assertion.', 'type' => 'string', 'title' => '', 'example' => 'https://www.aliyun.com/SAML-Role/Attributes/RoleSessionName'],
'AttributeValueExpression' => ['description' => 'The expression used to generate the value of the attribute in the SAML assertion.', 'type' => 'string', 'title' => '', 'example' => 'user.username'],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
'IdPEntityId' => ['description' => 'The EntityID of the identity provider (IdP) in the SAML protocol.', 'type' => 'string', 'title' => '', 'example' => 'https://example.com/'],
'OptionalRelayStates' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RelayState' => ['description' => 'The optional RelayState value. The display names of multiple redirect URLs are shown on the application card in the application portal. After a user clicks a URL and completes the SSO, the user is redirected to the URL.', 'type' => 'string', 'example' => 'https://home.console.aliyun.com', 'title' => ''],
'DisplayName' => ['description' => 'The display name of the RelayState.', 'type' => 'string', 'example' => 'Ram Account SSO', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => 'The optional RelayState values. The display names of multiple redirect URLs are shown on the application card in the application portal. After a user clicks a URL and completes the SSO, the user is redirected to the URL. You must specify a default redirect URL before you can specify optional RelayState values.',
'title' => '',
'example' => '',
],
],
'example' => '',
],
'OidcSsoConfig' => [
'title' => '',
'description' => 'The SSO configuration parameters for the application that uses OpenID Connect (OIDC). This parameter is returned only when the application uses OIDC for SSO.',
'type' => 'object',
'properties' => [
'RedirectUris' => [
'title' => '',
'description' => 'The list of redirect URIs that the application supports.',
'type' => 'array',
'items' => ['description' => 'The redirect URI that the application supports.', 'type' => 'string', 'example' => 'https://example.com/oidc/login/callback'."\n", 'title' => ''],
'example' => '',
],
'PostLogoutRedirectUris' => [
'title' => '',
'description' => 'The list of post-logout redirect URIs.',
'type' => 'array',
'items' => ['description' => 'The post-logout redirect URI that is added to the whitelist. When the application initiates a logout request, you can specify the post\\_logout\\_redirect\\_uri parameter.', 'type' => 'string', 'example' => 'https://example.com/oidc/login/logout'."\n", 'title' => ''],
'example' => '',
],
'GrantTypes' => [
'title' => '',
'description' => 'The list of OIDC grant types that are supported.',
'type' => 'array',
'items' => ['description' => 'The OIDC grant type. Valid values:'."\n"
."\n"
.'- authorization\\_code: Authorization code.'."\n"
."\n"
.'- implicit: Implicit.'."\n"
."\n"
.'- refresh\\_token: Refresh token.'."\n"
."\n"
.'- urn:ietf:params:oauth:grant-type:device\\_code: Device code.'."\n"
."\n"
.'- password: Password.', 'type' => 'string', 'example' => 'refresh_token', 'title' => ''],
'example' => 'authorization_code',
],
'ResponseTypes' => [
'title' => '',
'description' => 'The response type that the application supports. This parameter is returned only if OidcSsoConfig.GrantTypes is set to implicit.',
'type' => 'array',
'items' => ['description' => 'The OIDC-compliant response\\_type parameter. This parameter is valid only if GrantTypes is set to implicit. Valid values:'."\n"
."\n"
.'- token: Returns only an access token.'."\n"
."\n"
.'- id\\_token: Returns only an ID token.'."\n"
."\n"
.'- token id\\_token: Returns both an access token and an ID token.', 'type' => 'string', 'example' => 'token id_token', 'title' => ''],
'example' => 'token id_token',
],
'GrantScopes' => [
'title' => '',
'description' => 'The OIDC-compliant scope parameter. This parameter specifies the scope of user attributes that can be returned by the userinfo endpoint or included in the ID token.',
'type' => 'array',
'items' => ['description' => 'The OIDC-compliant scope parameter. This parameter specifies the scope of user attributes that can be returned by the userinfo endpoint or included in the ID token. Valid values:'."\n"
."\n"
.'- openid: An OIDC-compliant parameter that specifies the unique ID of the user.'."\n"
."\n"
.'- profile: The user profile.'."\n"
."\n"
.'- email: The user\'s email address.'."\n"
."\n"
.'- phone: The user\'s mobile number.', 'type' => 'string', 'example' => 'openid', 'title' => ''],
'example' => 'profile,email',
],
'PasswordTotpMfaRequired' => ['description' => 'Indicates whether Time-based One-Time Password (TOTP) multi-factor authentication (MFA) is required for password-based logon. This parameter is valid only if GrantTypes for the OIDC application is set to password.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'PasswordAuthenticationSourceId' => ['description' => 'The ID of the authentication source for password-based logon. This parameter is valid only if GrantTypes for the OIDC application is set to password.', 'type' => 'string', 'example' => 'ia_password', 'title' => ''],
'PkceRequired' => ['description' => 'Indicates whether Proof Key for Code Exchange (PKCE) is required for the application SSO. For more information, see RFC 7636.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'PkceChallengeMethods' => [
'title' => '',
'description' => 'The algorithm used to calculate the code challenge in PKCE.',
'type' => 'array',
'items' => ['description' => 'The algorithm used to calculate the code challenge in PKCE. Valid values:'."\n"
."\n"
.'- plain: Plaintext.'."\n"
."\n"
.'- S256: SHA-256.', 'type' => 'string', 'example' => 'S256', 'title' => ''],
'example' => 'S256',
],
'AccessTokenEffectiveTime' => ['description' => 'The validity period of the access token. Unit: seconds. Default value: 1200 (20 minutes).', 'type' => 'integer', 'format' => 'int64', 'example' => '1200', 'title' => ''],
'CodeEffectiveTime' => ['description' => 'The validity period of the authorization code. Unit: seconds. Default value: 60 (1 minute).', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''],
'IdTokenEffectiveTime' => ['description' => 'The validity period of the ID token. Unit: seconds. Default value: 300 (5 minutes).', 'type' => 'integer', 'format' => 'int64', 'example' => '1200', 'title' => ''],
'RefreshTokenEffective' => ['description' => 'The validity period of the refresh token. Unit: seconds. Default value: 86400 (1 day).', 'type' => 'integer', 'format' => 'int64', 'example' => '86400', 'title' => ''],
'CustomClaims' => [
'title' => '',
'description' => 'The custom claims that are returned in the ID token.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ClaimName' => ['description' => 'The name of the claim.', 'type' => 'string', 'title' => '', 'example' => 'userOuIds'],
'ClaimValueExpression' => ['description' => 'The expression used to generate the value of the claim.', 'type' => 'string', 'title' => '', 'example' => 'ObjectToJsonString(user.organizationalUnits)'],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
'SubjectIdExpression' => ['description' => 'The expression used to generate the value of the sub claim in the ID token.', 'type' => 'string', 'example' => 'user.userid', 'title' => ''],
'AllowedPublicClient' => ['description' => 'Indicates whether the application is allowed to make requests to the IDaaS EIAM authorization server as a public client. This feature is supported only for the authorization code and device code grant types. Default value: false.', 'type' => 'string', 'title' => '', 'example' => 'true'],
],
'example' => '',
],
'ProtocolEndpointDomain' => [
'title' => '',
'description' => 'The configuration of the metadata endpoint provided by the application.',
'type' => 'object',
'properties' => [
'SamlSsoEndpoint' => ['description' => 'The endpoint that receives AuthnRequest requests for the SAML protocol. This parameter is returned only when the application uses SAML 2.0 for SSO.', 'type' => 'string', 'title' => '', 'example' => 'https://l1seshcn.aliyunidaas.com/login/app/app_mltuxdwd4lq4eer6tmtlmaxm5e/saml2/sso'],
'SamlMetaEndpoint' => ['title' => '', 'description' => 'The metadata endpoint for the SAML protocol. This parameter is returned only when the application uses SAML 2.0 for SSO.', 'type' => 'string', 'example' => 'https://l1seshcn.aliyunidaas.com/api/v2/app_mltuxdwd4lq4eer6tmtlmaxm5e/saml2/meta'],
'OidcIssuer' => ['description' => 'The OIDC issuer. This parameter is returned only when the application uses OIDC for SSO.', 'type' => 'string', 'title' => '', 'example' => 'https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oidc'],
'OidcJwksEndpoint' => ['description' => 'The JSON Web Key Set (JWKS) endpoint for OIDC. This parameter is returned only when the application uses OIDC for SSO.', 'type' => 'string', 'title' => '', 'example' => 'https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oidc/jwks'],
'Oauth2AuthorizationEndpoint' => ['description' => 'The OAuth 2.0 authorization endpoint. This parameter is returned only when the application uses OIDC for SSO.', 'type' => 'string', 'title' => '', 'example' => 'https://l1seshcn.aliyunidaas.com/login/app/app_mltta64q65enci54slingvvsgq/oauth2/authorize'],
'Oauth2RevokeEndpoint' => ['description' => 'The OAuth 2.0 token revocation endpoint. This parameter is returned only when the application uses OIDC for SSO.', 'type' => 'string', 'title' => '', 'example' => 'https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/revoke'],
'Oauth2TokenEndpoint' => ['description' => 'The OAuth 2.0 token endpoint. This parameter is returned only when the application uses OIDC for SSO.', 'type' => 'string', 'title' => '', 'example' => 'https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/token'],
'Oauth2DeviceAuthorizationEndpoint' => ['description' => 'The OAuth 2.0 device authorization endpoint. This parameter is returned only when the application uses OIDC for SSO.', 'type' => 'string', 'title' => '', 'example' => 'https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/device/code'],
'Oauth2UserinfoEndpoint' => ['description' => 'The OIDC userinfo endpoint. This parameter is returned only when the application uses OIDC for SSO.', 'type' => 'string', 'title' => '', 'example' => 'https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/userinfo'],
'OidcLogoutEndpoint' => ['description' => 'The OIDC Relying Party (RP)-initiated logout endpoint. This parameter is returned only when the application uses OIDC for SSO.', 'type' => 'string', 'title' => '', 'example' => 'https://l1seshcn.aliyunidaas.com/login/app/app_mltta64q65enci54slingvvsgq/oauth2/logout'],
],
'example' => '',
],
'SsoStatus' => ['description' => 'The status of the SSO feature for the application. Valid values:'."\n"
."\n"
.'- enabled: Enabled.'."\n"
."\n"
.'- disabled: Disabled.', 'type' => 'string', 'title' => '', 'example' => 'enabled'],
'InitLoginType' => ['description' => 'The SSO initiation method. Valid values:'."\n"
."\n"
.'- only\\_app\\_init\\_sso: SSO is initiated only by the application. This is the default value for OIDC applications. If this method is used for a SAML application, you must specify InitLoginUrl.'."\n"
."\n"
.'- idaas\\_or\\_app\\_init\\_sso: SSO can be initiated by the IDaaS console or the application. This is the default value for SAML applications. If this method is used for an OIDC application, you must specify InitLoginUrl.', 'type' => 'string', 'title' => '', 'example' => 'only_app_init_sso'],
'InitLoginUrl' => ['description' => 'The URL that triggers SSO. This parameter is required when InitLoginType for an OIDC application is set to idaas\\_or\\_app\\_init\\_sso. This parameter is also required when InitLoginType for a SAML application is set to only\\_app\\_init\\_sso.', 'type' => 'string', 'title' => '', 'example' => 'http://127.0.0.1:8000/start_login?enterprise_code=ABCDEF'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'GetApplicationSsoConfig',
'summary' => 'Retrieves the single sign-on (SSO) configuration for an application in EIAM.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplicationSsoConfig'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationSsoConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationSsoConfig\\": {\\n \\"SamlSsoConfig\\": {\\n \\"SpSsoAcsUrl\\": \\"https://signin.aliyun.com/saml-role/sso\\",\\n \\"SpEntityId\\": \\"urn:alibaba:cloudcomputing\\",\\n \\"NameIdFormat\\": \\"urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified\\",\\n \\"NameIdValueExpression\\": \\"user.username\\",\\n \\"DefaultRelayState\\": \\"https://home.console.aliyun.com\\",\\n \\"SignatureAlgorithm\\": \\"RSA-SHA256\\",\\n \\"ResponseSigned\\": true,\\n \\"AssertionSigned\\": true,\\n \\"AttributeStatements\\": [\\n {\\n \\"AttributeName\\": \\"https://www.aliyun.com/SAML-Role/Attributes/RoleSessionName\\",\\n \\"AttributeValueExpression\\": \\"user.username\\"\\n }\\n ],\\n \\"IdPEntityId\\": \\"https://example.com/\\",\\n \\"OptionalRelayStates\\": [\\n {\\n \\"RelayState\\": \\"https://home.console.aliyun.com\\",\\n \\"DisplayName\\": \\"Ram Account SSO\\"\\n }\\n ]\\n },\\n \\"OidcSsoConfig\\": {\\n \\"RedirectUris\\": [\\n \\"https://example.com/oidc/login/callback\\\\n\\"\\n ],\\n \\"PostLogoutRedirectUris\\": [\\n \\"https://example.com/oidc/login/logout\\\\n\\"\\n ],\\n \\"GrantTypes\\": [\\n \\"refresh_token\\"\\n ],\\n \\"ResponseTypes\\": [\\n \\"token id_token\\"\\n ],\\n \\"GrantScopes\\": [\\n \\"openid\\"\\n ],\\n \\"PasswordTotpMfaRequired\\": true,\\n \\"PasswordAuthenticationSourceId\\": \\"ia_password\\",\\n \\"PkceRequired\\": true,\\n \\"PkceChallengeMethods\\": [\\n \\"S256\\"\\n ],\\n \\"AccessTokenEffectiveTime\\": 1200,\\n \\"CodeEffectiveTime\\": 60,\\n \\"IdTokenEffectiveTime\\": 1200,\\n \\"RefreshTokenEffective\\": 86400,\\n \\"CustomClaims\\": [\\n {\\n \\"ClaimName\\": \\"userOuIds\\",\\n \\"ClaimValueExpression\\": \\"ObjectToJsonString(user.organizationalUnits)\\"\\n }\\n ],\\n \\"SubjectIdExpression\\": \\"user.userid\\",\\n \\"AllowedPublicClient\\": \\"true\\"\\n },\\n \\"ProtocolEndpointDomain\\": {\\n \\"SamlSsoEndpoint\\": \\"https://l1seshcn.aliyunidaas.com/login/app/app_mltuxdwd4lq4eer6tmtlmaxm5e/saml2/sso\\",\\n \\"SamlMetaEndpoint\\": \\"https://l1seshcn.aliyunidaas.com/api/v2/app_mltuxdwd4lq4eer6tmtlmaxm5e/saml2/meta\\",\\n \\"OidcIssuer\\": \\"https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oidc\\",\\n \\"OidcJwksEndpoint\\": \\"https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oidc/jwks\\",\\n \\"Oauth2AuthorizationEndpoint\\": \\"https://l1seshcn.aliyunidaas.com/login/app/app_mltta64q65enci54slingvvsgq/oauth2/authorize\\",\\n \\"Oauth2RevokeEndpoint\\": \\"https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/revoke\\",\\n \\"Oauth2TokenEndpoint\\": \\"https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/token\\",\\n \\"Oauth2DeviceAuthorizationEndpoint\\": \\"https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/device/code\\",\\n \\"Oauth2UserinfoEndpoint\\": \\"https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk2676rypm/app_mltta64q65enci54slingvvsgq/oauth2/userinfo\\",\\n \\"OidcLogoutEndpoint\\": \\"https://l1seshcn.aliyunidaas.com/login/app/app_mltta64q65enci54slingvvsgq/oauth2/logout\\"\\n },\\n \\"SsoStatus\\": \\"enabled\\",\\n \\"InitLoginType\\": \\"only_app_init_sso\\",\\n \\"InitLoginUrl\\": \\"http://127.0.0.1:8000/start_login?enterprise_code=ABCDEF\\"\\n }\\n}","type":"json"}]',
],
'GetApplicationTemplate' => [
'summary' => 'Retrieves application template information.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasPKGURD'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ApplicationTemplateId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application template ID.', 'type' => 'string', 'required' => true, 'example' => 'apt_ramuser_xxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ApplicationTemplate' => [
'description' => 'The application template information.',
'type' => 'object',
'properties' => [
'ApplicationTemplateId' => ['title' => '', 'description' => 'The application template ID.', 'type' => 'string', 'example' => 'apt_ramintlrole_ixxxxx'],
'ApplicationTemplateName' => ['title' => '', 'description' => 'The application template name.', 'type' => 'string', 'example' => 'Alibaba Cloud '],
'Description' => ['title' => '', 'description' => 'The application template description.', 'type' => 'string', 'example' => 'Alibaba Cloud SSO'],
'LogoUrl' => ['title' => '', 'description' => 'The logo URL of the application template.', 'type' => 'string', 'example' => 'https://example.com/imgextra/i4/O1CN01xTLxLb1WtyKksHW1H_!!6000000002847-2-tps-xxx-xxx.png'],
'HelpDocumentUrl' => ['title' => '', 'description' => 'The help document URL of the application template.', 'type' => 'string', 'example' => 'https://example.com/document_detail/409xxx.html'],
'CreateTime' => ['title' => '', 'description' => 'The time when the application template was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1730341123000'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the application template was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1730341124000'],
'SaleInfo' => [
'title' => '',
'description' => 'The sale information of the application template.',
'type' => 'object',
'properties' => [
'AlwaysFree' => ['title' => '', 'description' => 'Indicates whether the application template is always free.', 'type' => 'boolean', 'example' => 'true'],
],
'example' => '',
],
'ServiceManaged' => ['title' => '', 'description' => 'Indicates whether the application template is managed by an Alibaba Cloud service.', 'type' => 'boolean', 'example' => 'true'],
'ManagedServiceCode' => ['title' => '', 'description' => 'The service code of the Alibaba Cloud service that manages the application template.', 'type' => 'string', 'example' => 'bastionhost'],
'ServiceConsoleUrl' => ['title' => '', 'description' => 'The console URL of the Alibaba Cloud service that manages the application template.', 'type' => 'string', 'example' => 'https://example.com/?p=bastion'],
'SsoTypes' => [
'title' => '',
'description' => 'The supported SSO protocols.',
'type' => 'array',
'items' => [
'description' => 'The supported SSO protocol type.',
'enumValueTitles' => ['saml2' => 'saml2', 'oidc' => 'oidc'],
'type' => 'string',
'example' => 'saml2',
'title' => '',
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Retrieve application template information',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationTemplate',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationTemplate', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:applicationtemplate/{#ApplicationTemplateId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationTemplate\\": {\\n \\"ApplicationTemplateId\\": \\"apt_ramintlrole_ixxxxx\\",\\n \\"ApplicationTemplateName\\": \\"Alibaba Cloud \\",\\n \\"Description\\": \\"Alibaba Cloud SSO\\",\\n \\"LogoUrl\\": \\"https://example.com/imgextra/i4/O1CN01xTLxLb1WtyKksHW1H_!!6000000002847-2-tps-xxx-xxx.png\\",\\n \\"HelpDocumentUrl\\": \\"https://example.com/document_detail/409xxx.html\\",\\n \\"CreateTime\\": 1730341123000,\\n \\"UpdateTime\\": 1730341124000,\\n \\"SaleInfo\\": {\\n \\"AlwaysFree\\": true\\n },\\n \\"ServiceManaged\\": true,\\n \\"ManagedServiceCode\\": \\"bastionhost\\",\\n \\"ServiceConsoleUrl\\": \\"https://example.com/?p=bastion\\",\\n \\"SsoTypes\\": [\\n \\"saml2\\"\\n ]\\n }\\n}","type":"json"}]',
],
'GetAuthorizationResource' => [
'summary' => 'Queries information about an authorized resource.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationResourceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization resource ID.', 'type' => 'string', 'required' => true, 'example' => 'arres_01kgh3jvt7pk093rv6giu0c0qxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'AuthorizationResource' => [
'description' => 'The authorized resource.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'AuthorizationRuleId' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx'],
'AuthorizationResourceId' => ['title' => '', 'description' => 'The authorization resource ID.', 'type' => 'string', 'example' => 'arres_01kgh3jvt7pk093rv6giu0c0qxxxx'],
'AuthorizationResourceEntityType' => ['title' => '', 'description' => 'The type of the resource entity associated with the authorized resource. Valid values:'."\n"
."\n"
.'- cloud_account_role: cloud role.', 'type' => 'string', 'example' => 'cloud_account_role'],
'AuthorizationResourceEntityId' => ['title' => '', 'description' => 'The ID of the resource entity associated with the authorized resource.', 'type' => 'string', 'example' => 'carole_01kmek49aqxxxx'],
'CloudAccountId' => ['title' => '', 'description' => 'The ID of the cloud account to which the resource entity associated with the authorized resource belongs.', 'type' => 'string', 'example' => 'ca_01kmegjc11qa1txxxxx'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query an authorized resource',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetAuthorizationResource',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationResource', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}/authorizationresource/{#AuthorizationResourceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"AuthorizationResource\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"AuthorizationRuleId\\": \\"arrule_01kf143ug06fg7m9f43u7vahxxxx\\",\\n \\"AuthorizationResourceId\\": \\"arres_01kgh3jvt7pk093rv6giu0c0qxxxx\\",\\n \\"AuthorizationResourceEntityType\\": \\"cloud_account_role\\",\\n \\"AuthorizationResourceEntityId\\": \\"carole_01kmek49aqxxxx\\",\\n \\"CloudAccountId\\": \\"ca_01kmegjc11qa1txxxxx\\"\\n }\\n}","type":"json"}]',
],
'GetAuthorizationRule' => [
'summary' => 'Query information about an authorization rule.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['description' => 'Authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'AuthorizationRule' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'title' => ''],
'AuthorizationRuleId' => ['description' => 'Authorization rule ID.', 'type' => 'string', 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'title' => ''],
'AuthorizationRuleName' => ['description' => 'Authorization rule name.', 'type' => 'string', 'example' => 'test-name', 'title' => ''],
'Status' => ['description' => 'Authorization rule status. Valid values:'."\n"
."\n"
.'- enabled: Enabled'."\n"
."\n"
.'- disabled: Disabled', 'type' => 'string', 'example' => 'enabled', 'title' => ''],
'ProjectId' => ['description' => 'Project ID associated with the authorization rule.', 'type' => 'string', 'title' => '', 'example' => 'iprj_system_default'],
'AuthorizationResourceScope' => ['description' => 'Authorization resource scope. Valid values:'."\n"
."\n"
.'- global: Global resources under the project'."\n"
."\n"
.'- custom: Resources within the specified project scope', 'type' => 'string', 'title' => '', 'example' => 'global'],
'AuthorizationRuleCreationType' => ['description' => 'Authorization rule creation type. Valid values:'."\n"
."\n"
.'- system\\_init: System created'."\n"
."\n"
.'- user\\_custom: User created', 'type' => 'string', 'title' => '', 'example' => 'user_custom'],
'AuthorizationRuleSubjectScope' => ['description' => 'Authorization rule subject scope. Valid values:'."\n"
."\n"
.'- shared: Shared type, supports all subjects, including accounts and applications'."\n"
."\n"
.'- exclusive: Exclusive type', 'type' => 'string', 'title' => '', 'example' => 'shared'],
'AuthorizationRuleSubjectType' => ['description' => 'Subject type associated with the authorization rule. Valid when the authorization rule subject scope is exclusive. Valid values:'."\n"
."\n"
.'- application: Application'."\n"
."\n"
.'- user: Account', 'type' => 'string', 'title' => '', 'example' => 'user'],
'AuthorizationRuleSubjectId' => ['description' => 'Subject ID associated with the authorization rule.', 'type' => 'string', 'title' => '', 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx'],
'Description' => ['description' => 'Authorization rule description.', 'type' => 'string', 'title' => '', 'example' => 'this is a test'],
'CreateTime' => ['description' => 'Creation time, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1652085686179'],
'UpdateTime' => ['description' => 'Last update time, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1652085686179'],
],
'description' => 'Authorization rule object.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'GetAuthorizationRule',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"AuthorizationRule\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"AuthorizationRuleId\\": \\"arrule_01kf143ug06fg7m9f43u7vahxxxx\\",\\n \\"AuthorizationRuleName\\": \\"test-name\\",\\n \\"Status\\": \\"enabled\\",\\n \\"ProjectId\\": \\"iprj_system_default\\",\\n \\"AuthorizationResourceScope\\": \\"global\\",\\n \\"AuthorizationRuleCreationType\\": \\"user_custom\\",\\n \\"AuthorizationRuleSubjectScope\\": \\"shared\\",\\n \\"AuthorizationRuleSubjectType\\": \\"user\\",\\n \\"AuthorizationRuleSubjectId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"Description\\": \\"this is a test\\",\\n \\"CreateTime\\": 1652085686179,\\n \\"UpdateTime\\": 1652085686179\\n }\\n}","type":"json"}]',
],
'GetAuthorizationServer' => [
'summary' => 'Queries an authorization server.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationServerId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization server ID.', 'type' => 'string', 'required' => true, 'example' => 'iauths_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'AuthorizationServer' => [
'description' => 'The authorization server.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_qzljgbhtwnnsywtdbz7yzy2any'],
'AuthorizationServerId' => ['title' => '', 'description' => 'The authorization server ID.', 'type' => 'string', 'example' => 'iauths_system'],
'AuthorizationServerName' => ['title' => '', 'description' => 'The name of the authorization server.', 'type' => 'string', 'example' => 'System_Default'],
'CreateTime' => ['title' => '', 'description' => 'The time when the authorization server was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1754620108295'],
'LastUpdateTime' => ['title' => '', 'description' => 'The time when the authorization server was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1781608572164'],
'Issuer' => ['title' => '', 'description' => 'The issuer of the authorization token.', 'type' => 'string', 'example' => 'https://xxxx.aliyunidaas.com/api/v2/iauths_system/oauth2'],
'Status' => ['title' => '', 'description' => 'The status of the authorization server.', 'type' => 'string', 'example' => 'ENABLE'],
'IssuerMode' => ['title' => '', 'description' => 'The issuer mode.', 'type' => 'string', 'example' => 'static'],
'IssuerDomain' => ['title' => '', 'description' => 'The domain name used by the issuer.', 'type' => 'string', 'example' => 'xxxx.aliyunidaas.com'],
'CreationType' => ['title' => '', 'description' => 'The creation type.', 'type' => 'string', 'example' => 'system_init'],
'Description' => ['title' => '', 'description' => 'The description of the authorization server.', 'type' => 'string', 'example' => 'description of authorization server'],
'ProtocolEndpoint' => [
'title' => '',
'description' => 'The endpoint configuration of the authorization server.',
'type' => 'object',
'properties' => [
'Oauth2TokenEndpoint' => ['title' => '', 'description' => 'The token endpoint of the authorization server.', 'type' => 'string', 'example' => 'https://xxxx.aliyunidaas.com/api/v2/iauths_system/oauth2/token'],
'OidcJwksEndpoint' => ['title' => '', 'description' => 'The JWKS endpoint of the authorization server.', 'type' => 'string', 'example' => 'https://xxxx.aliyunidaas.com/api/v2/iauths_system/oauth2/jwks'],
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Get authorization server information',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"AuthorizationServer\\": {\\n \\"InstanceId\\": \\"idaas_qzljgbhtwnnsywtdbz7yzy2any\\",\\n \\"AuthorizationServerId\\": \\"iauths_system\\",\\n \\"AuthorizationServerName\\": \\"System_Default\\",\\n \\"CreateTime\\": 1754620108295,\\n \\"LastUpdateTime\\": 1781608572164,\\n \\"Issuer\\": \\"https://xxxx.aliyunidaas.com/api/v2/iauths_system/oauth2\\",\\n \\"Status\\": \\"ENABLE\\",\\n \\"IssuerMode\\": \\"static\\",\\n \\"IssuerDomain\\": \\"xxxx.aliyunidaas.com\\",\\n \\"CreationType\\": \\"system_init\\",\\n \\"Description\\": \\"description of authorization server\\",\\n \\"ProtocolEndpoint\\": {\\n \\"Oauth2TokenEndpoint\\": \\"https://xxxx.aliyunidaas.com/api/v2/iauths_system/oauth2/token\\",\\n \\"OidcJwksEndpoint\\": \\"https://xxxx.aliyunidaas.com/api/v2/iauths_system/oauth2/jwks\\"\\n }\\n }\\n}","type":"json"}]',
'translator' => 'machine',
],
'GetBrand' => [
'summary' => 'Get Brand Details',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCPBRTZ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'BrandId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Brand ID.', 'type' => 'string', 'required' => true, 'example' => 'brand_xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'Brand' => [
'description' => 'Brand.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'BrandId' => ['title' => '', 'description' => 'Brand ID.', 'type' => 'string', 'example' => 'brand_xxxx'],
'BrandName' => ['title' => '', 'description' => 'Brand name.', 'type' => 'string', 'example' => 'Custom Brand'],
'BrandType' => [
'title' => '',
'description' => 'Brand type.',
'enumValueTitles' => ['system_init' => 'System initialized', 'user_custom' => 'User customized'],
'type' => 'string',
'example' => 'user_custom',
],
'Status' => [
'title' => '',
'description' => 'Brand status.',
'enumValueTitles' => ['disabled' => 'Disabled', 'enabled' => 'Enabled'],
'type' => 'string',
'example' => 'enabled',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query information about a brand',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Brand\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"BrandId\\": \\"brand_xxxx\\",\\n \\"BrandName\\": \\"Custom Brand\\",\\n \\"BrandType\\": \\"user_custom\\",\\n \\"Status\\": \\"enabled\\"\\n }\\n}","type":"json"}]',
],
'GetClientPublicKey' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientPublicKeyId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the application ClientPublicKey.', 'type' => 'string', 'required' => true, 'example' => 'KEYEqDnDJhztiEAwSin7MZoxGcihzCAuxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ClientPublicKey' => [
'description' => 'The application ClientPublicKey information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'ClientPublicKeyId' => ['title' => '', 'description' => 'The ID of the application ClientPublicKey.', 'type' => 'string', 'example' => 'KEYEqDnDJhztiEAwSin7MZoxGcihzCAuxxxx'],
'PublicKey' => ['title' => '', 'description' => 'The public key.', 'type' => 'string', 'example' => '-----BEGIN PUBLIC KEY-----'."\n"
.'MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmnWMdp9FU3vXljeIqpgR'."\n"
.'05E6jEgzIfKsFaLkv+07e2Lg8luTaJh8Q2nkbxdNpTfqBnMMyTgml88WktP45F78'."\n"
.'La7hQtR3vz0Eu1yA92gXwD5Oob7ay4JYQZ0C80o2tB3FsbXG2jUvr31MNkf/0oBY'."\n"
.'qUKK5Hnlk1TdrnZ5VkzgLGHKlj+NJHHF/57DbT64C2qpAWeKHAr9umJ8++0hKqG/'."\n"
.'oRSOpb7oWK4t5c39ulp1j5JJ6cwqrKVCXvsHfWHywOHkcyus+ZNPTQvpwjRnEmRz'."\n"
.'Vy3NWrjT7JlIa8vS1aUU+FxeFd2MLQzxFxquFLwi05su2faRexaeYwWW6IWAI3tX'."\n"
.'twxxxxxx'."\n"
.'-----END PUBLIC KEY-----'],
'AlgorithmType' => [
'title' => '',
'description' => 'The algorithm type.',
'enumValueTitles' => ['RSA-2048' => 'RSA-2048'],
'type' => 'string',
'example' => 'RSA-2048',
],
'Status' => [
'title' => '',
'description' => 'The status.',
'enumValueTitles' => ['disabled' => 'Disabled.', 'enabled' => 'Enabled.'],
'type' => 'string',
'example' => 'enabled',
],
'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731305755000'],
'Primary' => [
'title' => '',
'description' => 'Indicates whether the key pair is used with priority.',
'enumValueTitles' => ['true' => 'Yes.', 'false' => 'No.'],
'type' => 'boolean',
'example' => 'true',
],
'LastUsedTime' => ['title' => '', 'description' => 'The last time the key pair was used.', 'type' => 'integer', 'format' => 'int64', 'example' => '1771305755000'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query the clientPublicKey of a specified application',
'summary' => 'Queries the ClientPublicKey of a specified application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetClientPublicKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/{#ClientPublicKeyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ClientPublicKey\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"ClientPublicKeyId\\": \\"KEYEqDnDJhztiEAwSin7MZoxGcihzCAuxxxx\\",\\n \\"PublicKey\\": \\"-----BEGIN PUBLIC KEY-----\\\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmnWMdp9FU3vXljeIqpgR\\\\n05E6jEgzIfKsFaLkv+07e2Lg8luTaJh8Q2nkbxdNpTfqBnMMyTgml88WktP45F78\\\\nLa7hQtR3vz0Eu1yA92gXwD5Oob7ay4JYQZ0C80o2tB3FsbXG2jUvr31MNkf/0oBY\\\\nqUKK5Hnlk1TdrnZ5VkzgLGHKlj+NJHHF/57DbT64C2qpAWeKHAr9umJ8++0hKqG/\\\\noRSOpb7oWK4t5c39ulp1j5JJ6cwqrKVCXvsHfWHywOHkcyus+ZNPTQvpwjRnEmRz\\\\nVy3NWrjT7JlIa8vS1aUU+FxeFd2MLQzxFxquFLwi05su2faRexaeYwWW6IWAI3tX\\\\ntwxxxxxx\\\\n-----END PUBLIC KEY-----\\",\\n \\"AlgorithmType\\": \\"RSA-2048\\",\\n \\"Status\\": \\"enabled\\",\\n \\"CreateTime\\": 1731305755000,\\n \\"Primary\\": true,\\n \\"LastUsedTime\\": 1771305755000\\n }\\n}","type":"json"}]',
],
'GetCloudAccount' => [
'summary' => 'Queries the resource information of a cloud account.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'CloudAccountId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The cloud account ID.', 'type' => 'string', 'required' => true, 'example' => 'ca_01kmegjc11qa1txxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'CloudAccount' => [
'description' => 'The cloud account details.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'CloudAccountId' => ['title' => '', 'description' => 'The cloud account ID.', 'type' => 'string', 'example' => 'ca_01kmegjc11qa1txxxxx'],
'CloudAccountName' => [
'title' => '',
'description' => 'The cloud account name.',
'enumValueTitles' => [],
'type' => 'string',
'example' => 'cloud_accout_xxxx',
],
'CloudAccountVendorType' => [
'title' => '',
'description' => 'The cloud account type. Valid values:'."\n"
."\n"
.'- alibaba_cloud: Alibaba Cloud.',
'enumValueTitles' => [' alibaba_cloud' => ' alibaba_cloud'],
'type' => 'string',
'example' => 'alibaba_cloud',
],
'CloudAccountExternalId' => ['title' => '', 'description' => 'The external unique identifier of the cloud account.', 'type' => 'string', 'example' => '1234567'],
'CloudAccountProviderName' => ['title' => '', 'description' => 'The identity provider name.', 'type' => 'string', 'example' => 'idaas-eiam-oidc-provider'],
'CloudAccountHealth' => [
'title' => '',
'description' => 'The health status of the cloud account. Valid values:'."\n"
.'- healthy: Healthy.'."\n"
.'- unhealthy: Unhealthy.'."\n"
.'- unknown: Unknown.',
'enumValueTitles' => ['healthy' => 'healthy', 'unhealthy' => 'unhealthy', 'unknown' => 'unknown'],
'type' => 'string',
'example' => 'healthy',
],
'CloudAccountHealthCheckResult' => [
'description' => 'The health check result of the cloud account.',
'type' => 'object',
'properties' => [
'LastCheckTime' => ['description' => 'The time of the last health check. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000', 'title' => ''],
'Result' => [
'description' => 'The health check result of the cloud account. Valid values:'."\n"
."\n"
.'- success: Succeeded.'."\n"
.'- failed: Failed.',
'enumValueTitles' => ['success' => 'success', 'failed' => 'failed'],
'type' => 'string',
'example' => 'success',
'title' => '',
],
'ErrorReason' => [
'description' => 'The error reason. This field is returned when the health check status is unhealthy.',
'type' => 'object',
'properties' => [
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'AuthenticationFail.NoPermission', 'title' => ''],
'ErrorMessage' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'There is no permission.', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Description' => ['title' => '', 'description' => 'The cloud account description.', 'type' => 'string', 'example' => 'cloud_accout_description'],
'CloudAccountProviderConfig' => [
'title' => '',
'description' => 'The identity provider configuration.',
'type' => 'object',
'properties' => [
'AuthorizationServerId' => ['title' => '', 'description' => 'The authorization server ID.', 'type' => 'string', 'example' => 'iauths_system'],
'Issuer' => ['title' => '', 'description' => 'Issuer。', 'type' => 'string', 'example' => 'https://xxxxx.aliyunidaas.com/api/v2/iauths_system/oauth2'],
'Audience' => ['title' => '', 'description' => 'The audience identifier.', 'type' => 'string', 'example' => 'urn:cloud:idaas:sts:xxx:xxx'],
'OidcJwksEndpoint' => ['title' => '', 'description' => 'The signature verification public key endpoint.', 'type' => 'string', 'example' => 'https://xxxxx.aliyunidaas.com/api/v2/iauths_system/oauth2/jwks'],
],
'example' => '',
],
'CreateTime' => ['description' => 'The creation time. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830225000', 'title' => ''],
'UpdateTime' => ['description' => 'The last update time. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830227000', 'title' => ''],
'CloudAccountSite' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query cloud account information',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetCloudAccount',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"CloudAccount\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"CloudAccountId\\": \\"ca_01kmegjc11qa1txxxxx\\",\\n \\"CloudAccountName\\": \\"cloud_accout_xxxx\\",\\n \\"CloudAccountVendorType\\": \\"alibaba_cloud\\",\\n \\"CloudAccountExternalId\\": \\"1234567\\",\\n \\"CloudAccountProviderName\\": \\"idaas-eiam-oidc-provider\\",\\n \\"CloudAccountHealth\\": \\"healthy\\",\\n \\"CloudAccountHealthCheckResult\\": {\\n \\"LastCheckTime\\": 1649830226000,\\n \\"Result\\": \\"success\\",\\n \\"ErrorReason\\": {\\n \\"ErrorCode\\": \\"AuthenticationFail.NoPermission\\",\\n \\"ErrorMessage\\": \\"There is no permission.\\"\\n }\\n },\\n \\"Description\\": \\"cloud_accout_description\\",\\n \\"CloudAccountProviderConfig\\": {\\n \\"AuthorizationServerId\\": \\"iauths_system\\",\\n \\"Issuer\\": \\"https://xxxxx.aliyunidaas.com/api/v2/iauths_system/oauth2\\",\\n \\"Audience\\": \\"urn:cloud:idaas:sts:xxx:xxx\\",\\n \\"OidcJwksEndpoint\\": \\"https://xxxxx.aliyunidaas.com/api/v2/iauths_system/oauth2/jwks\\"\\n },\\n \\"CreateTime\\": 1649830225000,\\n \\"UpdateTime\\": 1649830227000,\\n \\"CloudAccountSite\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'GetCloudAccountRole' => [
'summary' => 'Queries the resource information of a cloud role.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'CloudAccountId',
'in' => 'query',
'schema' => ['description' => 'The cloud account ID.', 'type' => 'string', 'required' => true, 'example' => 'ca_01kmegjc11qa1txxxxx', 'title' => ''],
],
[
'name' => 'CloudAccountRoleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The cloud role ID.', 'type' => 'string', 'required' => true, 'example' => 'carole_01kmek49aqxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'CloudAccountRole' => [
'description' => 'The cloud role details.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'CloudAccountId' => ['title' => '', 'description' => 'The cloud account ID.', 'type' => 'string', 'example' => 'ca_01kmegjc11qa1txxxxx'],
'CloudAccountRoleId' => ['title' => '', 'description' => 'The cloud role ID.', 'type' => 'string', 'example' => 'carole_01kmek49aqxxxx'],
'CloudAccountRoleType' => [
'title' => '',
'description' => 'The cloud role type. The specific format depends on the cloud account type. Valid values:'."\n"
."\n"
.'- role: applicable to Alibaba Cloud accounts.',
'enumValueTitles' => ['role' => 'role'],
'type' => 'string',
'example' => 'role',
],
'CloudAccountRoleUsageType' => ['title' => '', 'description' => 'The cloud role usage type. Valid values:'."\n"
.'- system: system.'."\n"
.'- user: user.', 'type' => 'string', 'example' => 'system'],
'CloudAccountRoleName' => ['title' => '', 'description' => 'The cloud role name.', 'type' => 'string', 'example' => 'role-test'],
'CloudAccountRoleExternalId' => ['title' => '', 'description' => 'The cloud role identifier.', 'type' => 'string', 'example' => 'acs:ram::xxx:role/role-test'],
'CloudAccountRoleHealth' => ['title' => '', 'description' => 'The cloud role health status. Valid values:'."\n"
.'- healthy: healthy.'."\n"
.'- unhealthy: unhealthy.'."\n"
.'- unknown: unknown.', 'type' => 'string', 'example' => 'healthy'],
'Status' => ['title' => '', 'description' => 'The cloud role status. Valid values:'."\n"
.'- enabled: enabled.'."\n"
.'- disable: disabled.', 'type' => 'string', 'example' => 'enabled'],
'CloudAccountRoleHealthCheckResult' => [
'title' => '',
'description' => 'The cloud role health check result.',
'type' => 'object',
'properties' => [
'Result' => ['title' => '', 'description' => 'The cloud role health check result. Valid values:'."\n"
."\n"
.'- success: succeeded.'."\n"
."\n"
.'- failed: failed.', 'type' => 'string', 'example' => 'success'],
'LastCheckTime' => ['title' => '', 'description' => 'The time of the last health check. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
'ErrorReason' => [
'title' => '',
'description' => 'The error reason. This field is returned when the health check status is unhealthy.',
'type' => 'object',
'properties' => [
'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'AuthenticationFail.NoPermission'],
'ErrorMessage' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'There is no permission.'],
],
'example' => '',
],
],
'example' => '',
],
'Description' => ['description' => 'The cloud role description.', 'type' => 'string', 'example' => 'cloud_account_role_description', 'title' => ''],
'CreateTime' => ['description' => 'The creation time. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1719320115000', 'title' => ''],
'UpdateTime' => ['description' => 'The last update time. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830227000'."\n", 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query cloud role information',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetCloudAccountRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/${#CloudAccountId}/cloudaccountrole/{#CloudAccountRoleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"CloudAccountRole\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"CloudAccountId\\": \\"ca_01kmegjc11qa1txxxxx\\",\\n \\"CloudAccountRoleId\\": \\"carole_01kmek49aqxxxx\\",\\n \\"CloudAccountRoleType\\": \\"role\\",\\n \\"CloudAccountRoleUsageType\\": \\"system\\",\\n \\"CloudAccountRoleName\\": \\"role-test\\",\\n \\"CloudAccountRoleExternalId\\": \\"acs:ram::xxx:role/role-test\\",\\n \\"CloudAccountRoleHealth\\": \\"healthy\\",\\n \\"Status\\": \\"enabled\\",\\n \\"CloudAccountRoleHealthCheckResult\\": {\\n \\"Result\\": \\"success\\",\\n \\"LastCheckTime\\": 1649830226000,\\n \\"ErrorReason\\": {\\n \\"ErrorCode\\": \\"AuthenticationFail.NoPermission\\",\\n \\"ErrorMessage\\": \\"There is no permission.\\"\\n }\\n },\\n \\"Description\\": \\"cloud_account_role_description\\",\\n \\"CreateTime\\": 1719320115000,\\n \\"UpdateTime\\": 1649830227000\\n }\\n}","type":"json"}]',
],
'GetConditionalAccessPolicy' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231650',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ConditionalAccessPolicyId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Conditional access policy ID.', 'type' => 'string', 'required' => true, 'example' => 'cap_11111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ConditionalAccessPolicy' => [
'description' => 'Details of the conditional access policy.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'example' => 'idaas_qnx6fbrinlecptl5hld23lfkvy'],
'ConditionalAccessPolicyId' => ['title' => '', 'description' => 'Conditional access policy ID.', 'type' => 'string', 'example' => 'cp_xxxxx'],
'ConditionalAccessPolicyName' => ['title' => '', 'description' => 'Conditional access policy name.', 'type' => 'string', 'example' => 'My policy'],
'Description' => ['title' => '', 'description' => 'Conditional access policy description.', 'type' => 'string', 'example' => 'ga access port for ecs: internal-cn-hangzhou-docker-builder-2(i-bp19g1pheaailkk1xvr6)'],
'ConditionalAccessPolicyType' => ['title' => '', 'description' => 'Conditional access policy type.', 'type' => 'string', 'example' => 'arn:alibaba:idaas:authn:access:policy:system'],
'Status' => ['title' => '', 'description' => 'Enabled or disabled status of the conditional access policy.', 'type' => 'string', 'example' => 'enabled'],
'DecisionType' => ['title' => '', 'description' => 'Execution type of the conditional access policy.', 'type' => 'string', 'example' => 'enforcement'],
'EvaluateAt' => ['title' => '', 'description' => 'Evaluation point of the conditional access policy.', 'type' => 'string', 'example' => 'arn:alibaba:idaas:authn:access:rule:eval_at:after_step1'],
'DecisionConfig' => [
'title' => '',
'description' => 'Execution action of the conditional access policy.',
'type' => 'object',
'properties' => [
'Effect' => ['title' => '', 'description' => 'Decision action of the conditional access policy.', 'type' => 'string', 'example' => 'allow'],
'MfaType' => ['title' => '', 'description' => 'MFA authentication type of the conditional access policy.', 'type' => 'string', 'example' => 'directly_access'],
'MfaAuthenticationIntervalSeconds' => ['title' => '', 'description' => 'Re-authentication interval (seconds) of the conditional access policy.', 'type' => 'integer', 'format' => 'int64', 'example' => '300'],
'MfaAuthenticationMethods' => [
'title' => '',
'description' => 'Allowed MFA types of the conditional access policy.',
'type' => 'array',
'items' => ['description' => 'Allowed MFA types of the conditional access policy. Valid values:'."\n"
.'- ia_otp_sms: SMS verification code.'."\n"
.'- ia_otp_email: Email verification code.'."\n"
.'- ia_totp: OTP dynamic password.'."\n"
.'- ia_webauthn: WebAuthn.', 'type' => 'string', 'example' => 'ia_otp_sms', 'title' => ''],
'example' => '',
],
'ActiveSessionReuseStatus' => ['description' => 'Whether session reuse is enabled.', 'type' => 'string', 'example' => 'enabled', 'title' => ''],
],
'example' => '',
],
'ConditionsConfig' => [
'title' => '',
'description' => 'Conditional access policy content.',
'type' => 'object',
'properties' => [
'Applications' => [
'title' => '',
'description' => 'Target applications of the conditional access policy.',
'type' => 'object',
'properties' => [
'IncludeApplications' => [
'title' => '',
'description' => 'Included applications.',
'type' => 'array',
'items' => ['description' => 'Application ID.', 'type' => 'string', 'example' => 'app_xxxx', 'title' => ''],
'example' => '',
],
'ExcludeApplications' => [
'title' => '',
'description' => 'Excluded applications.',
'type' => 'array',
'items' => ['description' => 'Application ID.', 'type' => 'string', 'example' => 'app_xxxx'."\n", 'title' => ''],
'example' => '',
],
],
'example' => '',
],
'Users' => [
'title' => '',
'description' => 'Target users of the conditional access policy.',
'type' => 'object',
'properties' => [
'IncludeUsers' => [
'title' => '',
'description' => 'Included users.',
'type' => 'array',
'items' => ['description' => 'User ID.', 'type' => 'string', 'example' => 'user_xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeUsers' => [
'title' => '',
'description' => 'Excluded users.',
'type' => 'array',
'items' => ['description' => 'User ID.', 'type' => 'string', 'example' => 'user_xxxxx', 'title' => ''],
'example' => '',
],
'IncludeGroups' => [
'title' => '',
'description' => 'Included user groups.',
'type' => 'array',
'items' => ['description' => 'User group ID.', 'type' => 'string', 'example' => 'group_xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeGroups' => [
'title' => '',
'description' => 'Excluded user groups.',
'type' => 'array',
'items' => ['description' => 'User group ID.', 'type' => 'string', 'example' => 'group_xxxxx', 'title' => ''],
'example' => '',
],
'IncludeOrganizationalUnits' => [
'title' => '',
'description' => 'Included organizations.',
'type' => 'array',
'items' => ['description' => 'Organization ID.', 'type' => 'string', 'example' => 'ou_xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeOrganizationalUnits' => [
'title' => '',
'description' => 'Excluded organizations.',
'type' => 'array',
'items' => ['description' => 'Organization ID.', 'type' => 'string', 'example' => 'ou_xxxxx', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
'NetworkZones' => [
'title' => '',
'description' => 'Network zones of the conditional access policy.',
'type' => 'object',
'properties' => [
'IncludeNetworkZones' => [
'title' => '',
'description' => 'Included network ranges.',
'type' => 'array',
'items' => ['description' => 'Network range ID.', 'type' => 'string', 'example' => 'network_xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeNetworkZones' => [
'title' => '',
'description' => 'Excluded network ranges.',
'type' => 'array',
'items' => ['description' => 'Network range ID.', 'type' => 'string', 'example' => 'network_xxxxx', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
],
'example' => '',
],
'Priority' => ['title' => '', 'description' => 'Priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'CreateTime' => ['title' => '', 'description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741857554000'],
'LastUpdatedTime' => ['title' => '', 'description' => 'Update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741857554000'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Query Conditional Access Policy',
'summary' => 'Get a conditional access policy.',
'description' => 'Query a conditional access policy.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConditionalAccessPolicy'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetConditionalAccessPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/{#ConditionalAccessPolicyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ConditionalAccessPolicy\\": {\\n \\"InstanceId\\": \\"idaas_qnx6fbrinlecptl5hld23lfkvy\\",\\n \\"ConditionalAccessPolicyId\\": \\"cp_xxxxx\\",\\n \\"ConditionalAccessPolicyName\\": \\"My policy\\",\\n \\"Description\\": \\"ga access port for ecs: internal-cn-hangzhou-docker-builder-2(i-bp19g1pheaailkk1xvr6)\\",\\n \\"ConditionalAccessPolicyType\\": \\"arn:alibaba:idaas:authn:access:policy:system\\",\\n \\"Status\\": \\"enabled\\",\\n \\"DecisionType\\": \\"enforcement\\",\\n \\"EvaluateAt\\": \\"arn:alibaba:idaas:authn:access:rule:eval_at:after_step1\\",\\n \\"DecisionConfig\\": {\\n \\"Effect\\": \\"allow\\",\\n \\"MfaType\\": \\"directly_access\\",\\n \\"MfaAuthenticationIntervalSeconds\\": 300,\\n \\"MfaAuthenticationMethods\\": [\\n \\"ia_otp_sms\\"\\n ],\\n \\"ActiveSessionReuseStatus\\": \\"enabled\\"\\n },\\n \\"ConditionsConfig\\": {\\n \\"Applications\\": {\\n \\"IncludeApplications\\": [\\n \\"app_xxxx\\"\\n ],\\n \\"ExcludeApplications\\": [\\n \\"app_xxxx\\\\n\\"\\n ]\\n },\\n \\"Users\\": {\\n \\"IncludeUsers\\": [\\n \\"user_xxxxx\\"\\n ],\\n \\"ExcludeUsers\\": [\\n \\"user_xxxxx\\"\\n ],\\n \\"IncludeGroups\\": [\\n \\"group_xxxxx\\"\\n ],\\n \\"ExcludeGroups\\": [\\n \\"group_xxxxx\\"\\n ],\\n \\"IncludeOrganizationalUnits\\": [\\n \\"ou_xxxxx\\"\\n ],\\n \\"ExcludeOrganizationalUnits\\": [\\n \\"ou_xxxxx\\"\\n ]\\n },\\n \\"NetworkZones\\": {\\n \\"IncludeNetworkZones\\": [\\n \\"network_xxxxx\\"\\n ],\\n \\"ExcludeNetworkZones\\": [\\n \\"network_xxxxx\\"\\n ]\\n }\\n },\\n \\"Priority\\": 5,\\n \\"CreateTime\\": 1741857554000,\\n \\"LastUpdatedTime\\": 1741857554000\\n }\\n}","type":"json"}]',
],
'GetCredential' => [
'summary' => 'Queries the information about a credential resource.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'CredentialId',
'in' => 'query',
'schema' => ['description' => 'The credential ID.', 'type' => 'string', 'required' => true, 'example' => 'cred_mkv7rgt4d7i4u7zqtzev2mxxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'Credential' => [
'description' => 'The credential information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'CredentialId' => ['title' => '', 'description' => 'The credential ID.', 'type' => 'string', 'example' => 'cred_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'Status' => ['title' => '', 'description' => 'The credential status. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enabled'],
'CredentialIdentifier' => ['title' => '', 'description' => 'The credential identifier.', 'type' => 'string', 'example' => 'credential_identifier_test'],
'CredentialName' => ['title' => '', 'description' => 'The credential name.', 'type' => 'string', 'example' => 'credential_name'],
'CredentialSubjectType' => ['title' => '', 'description' => 'The type of the subject to which the credential belongs. Valid values:'."\n"
.'- authentication_token_provider: Authentication token provider.', 'type' => 'string', 'example' => 'authentication_token_provider'],
'CredentialSubjectId' => ['title' => '', 'description' => 'The ID of the subject to which the credential belongs.', 'type' => 'string', 'example' => 'apt_werthgfdsasffxxxxx'],
'CredentialScenarioLabel' => ['title' => '', 'description' => 'The scenarios label of the credential. Valid values:'."\n"
.'- llm: Large language model.'."\n"
.'- saas: Third-party SaaS service.', 'type' => 'string', 'example' => 'llm'],
'CredentialType' => ['title' => '', 'description' => 'The credential type. Valid values:'."\n"
.'- api_key: API key credential.'."\n"
.'- oauth_client: OAuth client credential.', 'type' => 'string', 'example' => 'api_key'],
'CredentialCreationType' => ['title' => '', 'description' => 'The creation type of the credential. Valid values:'."\n"
.'- system_init: Created by the system.'."\n"
.'- user_custom: Created by the user.', 'type' => 'string', 'example' => 'user_custom'],
'Description' => ['title' => '', 'description' => 'The credential description.', 'type' => 'string', 'example' => 'credential_description'],
'CreateTime' => ['title' => '', 'description' => 'The creation time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830225000'],
'UpdateTime' => ['title' => '', 'description' => 'The update time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830227000'],
'CredentialContent' => [
'title' => '',
'description' => 'The content of the credential.',
'type' => 'object',
'properties' => [
'OAuthClientContent' => [
'title' => '',
'description' => 'The content of the OAuth client credential.',
'type' => 'object',
'properties' => [
'ClientId' => ['title' => '', 'description' => 'The client_id of the OAuth protocol.', 'type' => 'string', 'example' => 'dmvncmxersdxxxxxx'],
],
'example' => '',
],
],
'example' => '',
],
'CredentialSharingScope' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
'ExclusiveUserId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
'CredentialExternalId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query credential information',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Credential\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"CredentialId\\": \\"cred_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"Status\\": \\"enabled\\",\\n \\"CredentialIdentifier\\": \\"credential_identifier_test\\",\\n \\"CredentialName\\": \\"credential_name\\",\\n \\"CredentialSubjectType\\": \\"authentication_token_provider\\",\\n \\"CredentialSubjectId\\": \\"apt_werthgfdsasffxxxxx\\",\\n \\"CredentialScenarioLabel\\": \\"llm\\",\\n \\"CredentialType\\": \\"api_key\\",\\n \\"CredentialCreationType\\": \\"user_custom\\",\\n \\"Description\\": \\"credential_description\\",\\n \\"CreateTime\\": 1649830225000,\\n \\"UpdateTime\\": 1649830227000,\\n \\"CredentialContent\\": {\\n \\"OAuthClientContent\\": {\\n \\"ClientId\\": \\"dmvncmxersdxxxxxx\\"\\n }\\n },\\n \\"CredentialSharingScope\\": \\"\\",\\n \\"ExclusiveUserId\\": \\"\\",\\n \\"CredentialExternalId\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'GetCredentialProvider' => [
'summary' => 'Queries the details of a credential provider.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'CredentialProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The credential provider ID.', 'type' => 'string', 'required' => true, 'example' => 'atp_01kr2cmj5gxxx4fvmls2e93dxxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'CredentialProvider' => [
'title' => '',
'description' => 'The credential provider.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'CredentialProviderId' => ['title' => '', 'description' => 'The credential provider ID.', 'type' => 'string', 'example' => 'atp_01kr2cmj5gxxx4fvmls2e93dxxxxx'],
'CredentialProviderIdentifier' => ['title' => '', 'description' => 'The credential provider identifier.', 'type' => 'string', 'example' => 'test_example_identifier'],
'CredentialProviderName' => ['title' => '', 'description' => 'The credential provider name.', 'type' => 'string', 'example' => 'test_example_name'],
'CreateTime' => ['title' => '', 'description' => 'The creation time of the credential provider. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830225000'],
'UpdateTime' => ['title' => '', 'description' => 'The update time of the credential provider. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830225000'],
'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'This is an example description'],
'CredentialProviderType' => ['title' => '', 'description' => 'The credential provider type. Valid values:'."\n"
."\n"
.'- oauth: OAuth credential provider.'."\n"
.'- jwt: JWT credential provider.', 'type' => 'string', 'example' => 'oauth'],
'CredentialProviderCreationType' => ['title' => '', 'description' => 'The credential provider creation type. Valid values:'."\n"
."\n"
.'- system_init: Created by the system.'."\n"
.'- user_custom: Created by the user.', 'type' => 'string', 'example' => 'user_custom'],
'Status' => ['title' => '', 'description' => 'The credential provider status. Valid values:'."\n"
."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enabled'],
'CredentialProviderConfig' => [
'title' => '',
'description' => 'The credential provider configuration.',
'type' => 'object',
'properties' => [
'ProviderCredentialIds' => [
'title' => '',
'description' => 'The list of credential IDs corresponding to the sensitive configurations of the credential provider.'."\n"
."\n"
.'> The system securely stores the sensitive configuration information of the credential provider in the form of credentials.',
'type' => 'array',
'items' => ['description' => 'The credential ID corresponding to the sensitive configuration.', 'type' => 'string', 'example' => 'cred_mkv7xxxxd7i4u7zqtzev2mxxxx', 'title' => ''],
'example' => '',
],
'OAuthProviderConfig' => [
'title' => '',
'description' => 'The configuration of the OAuth credential provider.',
'type' => 'object',
'properties' => [
'ClientId' => ['title' => '', 'description' => 'The client_id in the OAuth protocol.', 'type' => 'string', 'example' => 'client_id_example_xxx'],
'TokenEndpoint' => ['title' => '', 'description' => 'The token endpoint of the OAuth protocol.', 'type' => 'string', 'example' => 'https://example.com/token'],
'Scope' => ['title' => '', 'description' => 'The scope in the OAuth protocol.'."\n"
."\n"
.'> The scope configuration of the OAuth credential provider serves as the default value. If the scope parameter is not specified when calling the DeveloperAPI to obtain an OAuth access token, the scope configuration of the credential provider is used for issuance.'."\n"
."\n"
.'>Multiple scope values are separated by spaces.>', 'type' => 'string', 'example' => 'example:test_01 example:test_02'],
],
'example' => '',
],
'JwtProviderConfig' => [
'title' => '',
'description' => 'The configuration of the JWT credential provider.',
'type' => 'object',
'properties' => [
'Issuer' => ['title' => '', 'description' => 'JWT issuer。', 'type' => 'string', 'example' => 'https://test.issuer.com'],
'JwksEndpoint' => ['title' => '', 'description' => 'The JWKs endpoint URL.', 'type' => 'string', 'example' => 'https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks'],
'Expiration' => ['title' => '', 'description' => 'The validity period of the JWT, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '900'],
'ExpirationCleanupEnabled' => ['title' => '', 'description' => 'Indicates whether JWT expiration cleanup is enabled.', 'type' => 'boolean', 'example' => 'true'],
'DerivedShortTokenEnabled' => ['title' => '', 'description' => 'Indicates whether the JWT derived short token feature is enabled.', 'type' => 'boolean', 'example' => 'false'],
'AllowedTokenIssuers' => [
'title' => '',
'description' => 'The list of allowed JWT issuers.',
'type' => 'array',
'items' => ['title' => '', 'description' => 'The allowed JWT issuer.', 'type' => 'string', 'example' => 'https://test.issuer.com'],
'example' => '',
],
],
'example' => '',
],
],
'example' => '',
],
],
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query credential provider details',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"CredentialProvider\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"CredentialProviderId\\": \\"atp_01kr2cmj5gxxx4fvmls2e93dxxxxx\\",\\n \\"CredentialProviderIdentifier\\": \\"test_example_identifier\\",\\n \\"CredentialProviderName\\": \\"test_example_name\\",\\n \\"CreateTime\\": 1649830225000,\\n \\"UpdateTime\\": 1649830225000,\\n \\"Description\\": \\"This is an example description\\",\\n \\"CredentialProviderType\\": \\"oauth\\",\\n \\"CredentialProviderCreationType\\": \\"user_custom\\",\\n \\"Status\\": \\"enabled\\",\\n \\"CredentialProviderConfig\\": {\\n \\"ProviderCredentialIds\\": [\\n \\"cred_mkv7xxxxd7i4u7zqtzev2mxxxx\\"\\n ],\\n \\"OAuthProviderConfig\\": {\\n \\"ClientId\\": \\"client_id_example_xxx\\",\\n \\"TokenEndpoint\\": \\"https://example.com/token\\",\\n \\"Scope\\": \\"example:test_01 example:test_02\\"\\n },\\n \\"JwtProviderConfig\\": {\\n \\"Issuer\\": \\"https://test.issuer.com\\",\\n \\"JwksEndpoint\\": \\"https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks\\",\\n \\"Expiration\\": 900,\\n \\"ExpirationCleanupEnabled\\": true,\\n \\"DerivedShortTokenEnabled\\": false,\\n \\"AllowedTokenIssuers\\": [\\n \\"https://test.issuer.com\\"\\n ]\\n }\\n }\\n }\\n}","type":"json"}]',
],
'GetCustomField' => [
'summary' => 'Retrieves the information about an extended field.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAI4U3X'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'FieldId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The field ID.', 'type' => 'string', 'required' => true, 'example' => 'ufd_001', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'CustomField' => [
'description' => 'The custom field information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_z4pwq7v5ankdimdelzo2zbmzo4'],
'FieldId' => ['title' => '', 'description' => 'The field ID.', 'type' => 'string', 'example' => 'ufd_ncvy5trszg3zajaal5iofauy2q'],
'EntityType' => ['title' => '', 'description' => 'The entity type to which the field belongs.', 'type' => 'string', 'example' => 'user'],
'FieldName' => ['title' => '', 'description' => 'The field identifier.', 'type' => 'string', 'example' => 'userId'],
'FieldDisplayName' => ['title' => '', 'description' => 'The display name of the field.', 'type' => 'string', 'example' => 'userId'],
'FieldDisplayType' => [
'title' => '',
'description' => 'The display type of the field.',
'enumValueTitles' => ['input' => 'input', 'number' => 'number', 'select' => 'select', 'checkbox' => 'checkbox'],
'type' => 'string',
'example' => 'input',
],
'FieldDataType' => [
'title' => '',
'description' => 'The data type.',
'enumValueTitles' => ['number' => 'number', 'boolean' => 'boolean', 'string' => 'string'],
'type' => 'string',
'example' => 'string',
],
'DefaultValue' => ['title' => '', 'description' => 'The default value of the field.', 'type' => 'string', 'example' => 'test'],
'FieldDataConfig' => [
'title' => '',
'description' => 'The field value configuration items.',
'type' => 'object',
'properties' => [
'Items' => [
'title' => '',
'description' => 'The list of field configuration items.',
'type' => 'array',
'items' => [
'description' => 'The custom field configuration.',
'type' => 'object',
'properties' => [
'DisplayName' => ['title' => '', 'description' => 'The display name of the configuration item.', 'type' => 'string', 'example' => 'hobby'],
'Value' => ['title' => '', 'description' => 'The value of the configuration item.', 'type' => 'string', 'example' => 'game'],
'Status' => [
'title' => '',
'description' => 'The status of the configuration item.',
'enumValueTitles' => ['disabled' => 'disabled.', 'enabled' => 'enabled.'],
'type' => 'string',
'example' => 'enabled',
],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'example' => '',
],
'Unique' => ['title' => '', 'description' => 'Indicates whether the field is unique.', 'type' => 'boolean', 'example' => 'false'],
'Encrypted' => ['title' => '', 'description' => 'Indicates whether the field is encrypted.', 'type' => 'boolean', 'example' => 'false'],
'Required' => ['title' => '', 'description' => 'Indicates whether the field is required.', 'type' => 'boolean', 'example' => 'false'],
'UserPermission' => [
'title' => '',
'description' => 'The user-side (portal-side) permission.',
'enumValueTitles' => ['read_write' => 'editable.', 'hide' => 'hidden.', 'read_only' => 'visible.'],
'type' => 'string',
'example' => 'read_only',
],
'CreateTime' => ['title' => '', 'description' => 'The time when the extended field was created, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '17642960730'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the extended field was last updated, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '17642960730'],
'Status' => [
'title' => '',
'description' => 'The status of the extended field.',
'enumValueTitles' => ['disabled' => 'disabled.', 'enabled' => 'enabled.'],
'type' => 'string',
'example' => 'enabled',
],
'Description' => ['title' => '', 'description' => 'The description of the extended field.', 'type' => 'string', 'example' => 'test'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Retrieve extended field information',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetCustomField',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomField', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customfield/{#FieldId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"CustomField\\": {\\n \\"InstanceId\\": \\"idaas_z4pwq7v5ankdimdelzo2zbmzo4\\",\\n \\"FieldId\\": \\"ufd_ncvy5trszg3zajaal5iofauy2q\\",\\n \\"EntityType\\": \\"user\\",\\n \\"FieldName\\": \\"userId\\",\\n \\"FieldDisplayName\\": \\"userId\\",\\n \\"FieldDisplayType\\": \\"input\\",\\n \\"FieldDataType\\": \\"string\\",\\n \\"DefaultValue\\": \\"test\\",\\n \\"FieldDataConfig\\": {\\n \\"Items\\": [\\n {\\n \\"DisplayName\\": \\"hobby\\",\\n \\"Value\\": \\"game\\",\\n \\"Status\\": \\"enabled\\"\\n }\\n ]\\n },\\n \\"Unique\\": false,\\n \\"Encrypted\\": false,\\n \\"Required\\": false,\\n \\"UserPermission\\": \\"read_only\\",\\n \\"CreateTime\\": 17642960730,\\n \\"UpdateTime\\": 17642960730,\\n \\"Status\\": \\"enabled\\",\\n \\"Description\\": \\"test\\"\\n }\\n}","type":"json"}]',
],
'GetCustomPrivacyPolicy' => [
'summary' => 'Retrieves a custom privacy policy.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas4TD7D0'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'CustomPrivacyPolicyId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The custom privacy policy ID.', 'type' => 'string', 'required' => true, 'example' => 'pp_xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'CustomPrivacyPolicy' => [
'description' => 'The custom privacy policy.',
'type' => 'object',
'properties' => [
'CustomPrivacyPolicyId' => ['description' => 'The custom privacy policy ID.', 'type' => 'string', 'example' => 'pp_xxxxx', 'title' => ''],
'CustomPrivacyPolicyName' => ['description' => 'The custom privacy policy name.', 'type' => 'string', 'example' => 'Custom Privacy Policy Name', 'title' => ''],
'Status' => [
'description' => 'The status of the custom privacy policy. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.',
'enumValueTitles' => ['disabled' => 'Disabled.', 'enabled' => 'Enabled.'],
'type' => 'string',
'example' => 'enabled',
'title' => '',
],
'DefaultLanguageCode' => ['description' => 'The language of the custom privacy policy. The value is obtained from the LanguageCode parameter returned by the ListLanguages operation.', 'type' => 'string', 'example' => 'zh-Hans-CN', 'title' => ''],
'UserConsentType' => [
'description' => 'The user consent type.',
'enumValueTitles' => ['explicit_consent' => 'Manual consent required.', 'implied_consent' => 'Consent by default.'],
'type' => 'string',
'example' => 'implied_consent',
'title' => '',
],
'CustomPrivacyPolicyContents' => [
'description' => 'The content details of the custom privacy policy.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CustomPrivacyPolicyTip' => ['description' => 'The tip for the custom privacy policy content.', 'type' => 'string', 'example' => 'Please read and agree:', 'title' => ''],
'LanguageCode' => ['description' => 'The language of the custom privacy policy. The value is obtained from the LanguageCode parameter returned by the ListLanguages operation.', 'type' => 'string', 'example' => 'zh-Hans-CN', 'title' => ''],
'CustomPrivacyPolicyItems' => [
'description' => 'The custom privacy policy items.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CustomPrivacyPolicyItemName' => ['description' => 'The name of the custom privacy policy item.', 'type' => 'string', 'example' => 'item name', 'title' => ''],
'CustomPrivacyPolicyItemUrl' => ['description' => 'The URL of the custom privacy policy item. The URL must start with https://.', 'type' => 'string', 'example' => 'https://example.com', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Retrieve a custom privacy policy',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetCustomPrivacyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#CustomPrivacyPolicyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"CustomPrivacyPolicy\\": {\\n \\"CustomPrivacyPolicyId\\": \\"pp_xxxxx\\",\\n \\"CustomPrivacyPolicyName\\": \\"Custom Privacy Policy Name\\",\\n \\"Status\\": \\"enabled\\",\\n \\"DefaultLanguageCode\\": \\"zh-Hans-CN\\",\\n \\"UserConsentType\\": \\"implied_consent\\",\\n \\"CustomPrivacyPolicyContents\\": [\\n {\\n \\"CustomPrivacyPolicyTip\\": \\"Please read and agree:\\",\\n \\"LanguageCode\\": \\"zh-Hans-CN\\",\\n \\"CustomPrivacyPolicyItems\\": [\\n {\\n \\"CustomPrivacyPolicyItemName\\": \\"item name\\",\\n \\"CustomPrivacyPolicyItemUrl\\": \\"https://example.com\\"\\n }\\n ]\\n }\\n ],\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\"\\n }\\n}","type":"json"}]',
],
'GetDomain' => [
'summary' => 'Retrieves information about a domain name for an EIAM instance.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '187288',
'abilityTreeNodes' => ['FEATUREidaas6GKEFM'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'DomainId',
'in' => 'query',
'schema' => ['description' => 'The ID of the domain name.', 'type' => 'string', 'required' => true, 'example' => 'dm_examplexxxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'Domain' => [
'description' => 'The domain name object.',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'title' => ''],
'DomainId' => ['description' => 'The ID of the domain name.', 'type' => 'string', 'example' => 'dm_examplexxxxx', 'title' => ''],
'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'login.example.com', 'title' => ''],
'DomainType' => ['description' => 'The type of the domain name. Valid values:'."\n"
."\n"
.'- system\\_init: The initial domain name.'."\n"
."\n"
.'- user\\_custom: A custom domain name.', 'type' => 'string', 'example' => 'system_init', 'title' => ''],
'LockMode' => ['description' => 'The lock status of the domain name. Valid values:'."\n"
."\n"
.'- unlock: Normal.'."\n"
."\n"
.'- lockByLicense: The domain name is unavailable due to license restrictions.', 'type' => 'string', 'example' => 'unlock', 'title' => ''],
'DefaultDomain' => ['description' => 'Specifies whether the domain name is the default domain name.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'CreateTime' => ['description' => 'The time when the domain name was created. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000', 'title' => ''],
'UpdateTime' => ['description' => 'The time when the domain name was last updated. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000', 'title' => ''],
'Filing' => [
'title' => '',
'description' => 'The ICP filing information about the domain name.',
'type' => 'object',
'properties' => [
'IcpNumber' => ['description' => 'The ICP filing number that is associated with the domain name. The ICP filing number can be for an entity or a website.', 'type' => 'string', 'title' => '', 'example' => 'xICPxxxxxx-xx'],
],
'example' => '',
],
'BrandId' => ['description' => 'The ID of the brand.', 'type' => 'string', 'example' => 'brand_xxxxx', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Domain\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"DomainId\\": \\"dm_examplexxxxx\\",\\n \\"Domain\\": \\"login.example.com\\",\\n \\"DomainType\\": \\"system_init\\",\\n \\"LockMode\\": \\"unlock\\",\\n \\"DefaultDomain\\": false,\\n \\"CreateTime\\": 1649830226000,\\n \\"UpdateTime\\": 1649830226000,\\n \\"Filing\\": {\\n \\"IcpNumber\\": \\"xICPxxxxxx-xx\\"\\n },\\n \\"BrandId\\": \\"brand_xxxxx\\"\\n }\\n}","type":"json"}]',
'title' => 'GetDomain',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDomain'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}'],
],
],
],
],
],
'GetDomainDnsChallenge' => [
'summary' => 'Queries the DNS Challenge record for a specified EIAM domain name. This record is used to verify domain ownership.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGK16FE'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'Domain',
'in' => 'query',
'schema' => ['description' => 'The domain name.', 'type' => 'string', 'required' => true, 'example' => 'dm_examplexxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'DomainDnsChallenge' => [
'description' => 'The DNS Challenge record.',
'type' => 'object',
'properties' => [
'DnsChallengeName' => ['description' => 'The name of the DNS Challenge.', 'type' => 'string', 'example' => '_idaas-challenge.login.example.com', 'title' => ''],
'DnsType' => ['description' => 'The type of the DNS record.', 'type' => 'string', 'example' => 'txt', 'title' => ''],
'DnsChallengeValue' => ['description' => 'The value of the DNS Challenge.', 'type' => 'string', 'example' => 'yriov8FD/rIGjQTU3/JjqkwxRbo5dyGftHWOtP5xfCI=', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"DomainDnsChallenge\\": {\\n \\"DnsChallengeName\\": \\"_idaas-challenge.login.example.com\\",\\n \\"DnsType\\": \\"txt\\",\\n \\"DnsChallengeValue\\": \\"yriov8FD/rIGjQTU3/JjqkwxRbo5dyGftHWOtP5xfCI=\\"\\n }\\n}","type":"json"}]',
'title' => 'GetDomainDnsChallenge',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDomainDnsChallenge'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetDomainDnsChallenge',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/*'],
],
],
],
],
],
'GetFederatedCredentialProvider' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'FederatedCredentialProviderId',
'in' => 'query',
'schema' => ['description' => 'The federated credential provider ID.', 'type' => 'string', 'required' => true, 'example' => 'fcp_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'FederatedCredentialProvider' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The ID of the EIAM instance.', 'type' => 'string', 'title' => '', 'example' => 'idaas_qlbbighyxbu42xl7eninojXXX'],
'FederatedCredentialProviderId' => ['description' => 'The ID of the federated credential provider.', 'type' => 'string', 'title' => '', 'example' => 'fcp_asd123XXX'],
'FederatedCredentialProviderName' => ['description' => 'The name of the federated credential provider.', 'type' => 'string', 'title' => '', 'example' => 'test'],
'FederatedCredentialProviderType' => ['description' => 'The type of the federated credential provider.', 'type' => 'string', 'title' => '', 'example' => 'pkcs7'],
'Description' => ['description' => 'The description.', 'type' => 'string', 'title' => '', 'example' => 'test'],
'NetworkAccessEndpointId' => ['description' => 'The ID of the network access endpoint.', 'type' => 'string', 'title' => '', 'example' => 'inae_public'],
'Status' => ['description' => 'The status of the federated credential provider.', 'type' => 'string', 'title' => '', 'example' => 'enabled'],
'CreateTime' => ['description' => 'The time when the provider was created.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1729061324000'],
'UpdateTime' => ['description' => 'The time when the provider was last updated.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1729061324000'."\n"],
'OidcProviderConfig' => [
'description' => 'The OpenID Connect (OIDC) configuration.',
'type' => 'object',
'properties' => [
'JwksSource' => ['description' => 'The source of the JSON Web Key Set (JWKS).', 'type' => 'string', 'title' => '', 'example' => 'static'],
'JwksUri' => ['description' => 'The JWKS endpoint.', 'type' => 'string', 'title' => '', 'example' => 'https://example.com'],
'StaticJwks' => ['description' => 'The static JWKS content.', 'type' => 'string', 'title' => '', 'example' => '{'."\n"
.' "keys": ['."\n"
.' {'."\n"
.' "kty": "RSA",'."\n"
.' "e": "AQAB",'."\n"
.' "use": "sig",'."\n"
.' "kid": "KEY2RzsjRrimRASiAhCjBo18YwDoxpYHnHtv",'."\n"
.' "n": "qrsfFfSZngqKOxVE29ZIR4SXkwKq029B3HLDAZui_Pwaxwn8FssR9QdwsljZS06BTDp10vhPgqMB7s7TmHulL3I4WuSB-l4uXTXXXX"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'],
'Audiences' => [
'description' => 'A list of audiences for the OIDC credential.',
'type' => 'array',
'items' => ['description' => 'An audience.', 'type' => 'string', 'example' => 'https://example.com', 'title' => ''],
'title' => '',
'example' => '',
],
'Issuer' => ['description' => 'The issuer of the OIDC credential.', 'type' => 'string', 'title' => '', 'example' => 'http://test.idaas.com/v2/oauth'],
'TrustCondition' => ['description' => 'The trust condition for the OIDC provider.', 'type' => 'string', 'title' => '', 'example' => 'IsNullOrEmpty("jwt.issuer")'."\n"],
'DynamicJwks' => ['description' => 'The dynamically obtained JWKS.', 'type' => 'string', 'title' => '', 'example' => 'https://example.com'],
'JwksLastObtainedTime' => ['description' => 'The time of the last JWKS retrieval.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729061324000', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Pkcs7ProviderConfig' => [
'description' => 'The PKCS#7 configuration.',
'type' => 'object',
'properties' => [
'TrustAnchorSource' => ['description' => 'The source of the certificate trust anchor.', 'type' => 'string', 'title' => '', 'example' => 'alibaba_cloud'],
'Certificates' => [
'description' => 'A list of PKCS#7 certificates.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Fingerprint' => ['description' => 'The fingerprint of the certificate.', 'type' => 'string', 'title' => '', 'example' => '2b18947a6a9fc7764fd8b5fb18a863b0c6daxxx'],
'Content' => ['description' => 'The content of the certificate.', 'type' => 'string', 'title' => '', 'example' => '-----BEGIN CERTIFICATE-----'."\n"
.'MIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z'."\n"
.'-----END CERTIFICATE-----'],
'CertificateMetadata' => [
'description' => 'The certificate metadata.',
'type' => 'object',
'properties' => [
'NotBefore' => ['description' => 'The time when the certificate becomes valid.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1729061324000'],
'NotAfter' => ['description' => 'The time when the certificate expires.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1729061324000'],
],
'title' => '',
'example' => '',
],
],
'description' => 'A certificate from the list.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TrustCondition' => ['description' => 'The trust condition for the PKCS#7 provider.', 'type' => 'string', 'title' => '', 'example' => 'IsNullOrEmpty("certNo")'],
'CmsVerificationMode' => ['description' => 'The Cryptographic Message Syntax (CMS) verification mode.', 'type' => 'string', 'title' => '', 'example' => 'cert'],
'SigningTimeValueExpression' => ['description' => 'An expression that specifies the signing time.', 'type' => 'string', 'title' => '', 'example' => 'pkcs7.payload.jsonData.audience.signingTime'],
'SignatureEffectiveTime' => ['description' => 'The validity period of the signature, in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '3600'],
],
'title' => '',
'example' => '',
],
'PrivateCaProviderConfig' => [
'description' => 'The private certificate authority (CA) configuration.',
'type' => 'object',
'properties' => [
'TrustAnchorSource' => ['description' => 'The method for obtaining the root certificate.', 'type' => 'string', 'title' => '', 'example' => 'custom'],
'Certificates' => [
'description' => 'A list of root certificates.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Fingerprint' => ['description' => 'The fingerprint of the root certificate.', 'type' => 'string', 'title' => '', 'example' => '2b18947a6a9fc7764fd8b5fb18a863b0c6daxxx'],
'Content' => ['description' => 'The content of the root certificate.', 'type' => 'string', 'title' => '', 'example' => '-----BEGIN CERTIFICATE-----'."\n"
.'MIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z'."\n"
.'-----END CERTIFICATE-----'],
'CertificateMetadata' => [
'description' => 'The certificate metadata.',
'type' => 'object',
'properties' => [
'NotBefore' => ['description' => 'The time when the certificate becomes valid.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1729061324000'],
'NotAfter' => ['description' => 'The time when the certificate expires.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1729061324000'],
],
'title' => '',
'example' => '',
],
],
'description' => 'A root certificate.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TrustCondition' => ['description' => 'The trust condition for the root certificate.', 'type' => 'string', 'title' => '', 'example' => 'IsNullOrEmpty("certNo")'],
],
'title' => '',
'example' => '',
],
'CloudIdPProviderConfig' => [
'type' => 'object',
'properties' => [
'IdentityProviderId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => 'The federated credential provider.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'GetFederatedCredentialProvider',
'summary' => 'Retrieve a federated credential provider.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetFederatedCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/{#FederatedCredentialProviderId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"FederatedCredentialProvider\\": {\\n \\"InstanceId\\": \\"idaas_qlbbighyxbu42xl7eninojXXX\\",\\n \\"FederatedCredentialProviderId\\": \\"fcp_asd123XXX\\",\\n \\"FederatedCredentialProviderName\\": \\"test\\",\\n \\"FederatedCredentialProviderType\\": \\"pkcs7\\",\\n \\"Description\\": \\"test\\",\\n \\"NetworkAccessEndpointId\\": \\"inae_public\\",\\n \\"Status\\": \\"enabled\\",\\n \\"CreateTime\\": 1729061324000,\\n \\"UpdateTime\\": 1729061324000,\\n \\"OidcProviderConfig\\": {\\n \\"JwksSource\\": \\"static\\",\\n \\"JwksUri\\": \\"https://example.com\\",\\n \\"StaticJwks\\": \\"{\\\\n \\\\\\"keys\\\\\\": [\\\\n {\\\\n \\\\\\"kty\\\\\\": \\\\\\"RSA\\\\\\",\\\\n \\\\\\"e\\\\\\": \\\\\\"AQAB\\\\\\",\\\\n \\\\\\"use\\\\\\": \\\\\\"sig\\\\\\",\\\\n \\\\\\"kid\\\\\\": \\\\\\"KEY2RzsjRrimRASiAhCjBo18YwDoxpYHnHtv\\\\\\",\\\\n \\\\\\"n\\\\\\": \\\\\\"qrsfFfSZngqKOxVE29ZIR4SXkwKq029B3HLDAZui_Pwaxwn8FssR9QdwsljZS06BTDp10vhPgqMB7s7TmHulL3I4WuSB-l4uXTXXXX\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"Audiences\\": [\\n \\"https://example.com\\"\\n ],\\n \\"Issuer\\": \\"http://test.idaas.com/v2/oauth\\",\\n \\"TrustCondition\\": \\"IsNullOrEmpty(\\\\\\"jwt.issuer\\\\\\")\\\\n\\",\\n \\"DynamicJwks\\": \\"https://example.com\\",\\n \\"JwksLastObtainedTime\\": 1729061324000\\n },\\n \\"Pkcs7ProviderConfig\\": {\\n \\"TrustAnchorSource\\": \\"alibaba_cloud\\",\\n \\"Certificates\\": [\\n {\\n \\"Fingerprint\\": \\"2b18947a6a9fc7764fd8b5fb18a863b0c6daxxx\\",\\n \\"Content\\": \\"-----BEGIN CERTIFICATE-----\\\\nMIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z\\\\n-----END CERTIFICATE-----\\",\\n \\"CertificateMetadata\\": {\\n \\"NotBefore\\": 1729061324000,\\n \\"NotAfter\\": 1729061324000\\n }\\n }\\n ],\\n \\"TrustCondition\\": \\"IsNullOrEmpty(\\\\\\"certNo\\\\\\")\\",\\n \\"CmsVerificationMode\\": \\"cert\\",\\n \\"SigningTimeValueExpression\\": \\"pkcs7.payload.jsonData.audience.signingTime\\",\\n \\"SignatureEffectiveTime\\": 3600\\n },\\n \\"PrivateCaProviderConfig\\": {\\n \\"TrustAnchorSource\\": \\"custom\\",\\n \\"Certificates\\": [\\n {\\n \\"Fingerprint\\": \\"2b18947a6a9fc7764fd8b5fb18a863b0c6daxxx\\",\\n \\"Content\\": \\"-----BEGIN CERTIFICATE-----\\\\nMIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z\\\\n-----END CERTIFICATE-----\\",\\n \\"CertificateMetadata\\": {\\n \\"NotBefore\\": 1729061324000,\\n \\"NotAfter\\": 1729061324000\\n }\\n }\\n ],\\n \\"TrustCondition\\": \\"IsNullOrEmpty(\\\\\\"certNo\\\\\\")\\"\\n },\\n \\"CloudIdPProviderConfig\\": {\\n \\"IdentityProviderId\\": \\"\\"\\n }\\n }\\n}","type":"json"}]',
],
'GetForgetPasswordConfiguration' => [
'summary' => 'Queries the forgot password policy of a specified EIAM instance.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas41RG68'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'OpenForgetPasswordConfiguration' => [
'description' => 'The forgot password configuration.',
'type' => 'object',
'properties' => [
'Enable' => ['title' => '', 'description' => 'Indicates whether the forgot password feature is enabled. This parameter is deprecated. Use the ForgetPasswordStatus parameter instead.', 'type' => 'boolean', 'example' => 'true'],
'EnableSms' => ['title' => '', 'description' => 'Indicates whether SMS is enabled as an authentication method for forgot password. This parameter is deprecated. Use the AuthenticationChannels parameter instead.', 'type' => 'boolean', 'example' => 'true'],
'EnableEmail' => ['title' => '', 'description' => 'Indicates whether email is enabled as an authentication method for forgot password. This parameter is deprecated. Use the AuthenticationChannels parameter instead.', 'type' => 'boolean', 'example' => 'false'],
'ForgetPasswordStatus' => ['title' => '', 'description' => 'The status of the forgot password configuration. Valid values: enabled and disabled.', 'type' => 'string', 'example' => 'enabled'],
'AuthenticationChannels' => [
'title' => '',
'description' => 'The list of authentication channels for forgot password. This parameter is required when ForgetPasswordStatus is set to enabled. Valid values: email, sms (SMS), totp (OTP), and web_authn (WebAuthn).',
'type' => 'array',
'items' => ['description' => 'The authentication channel for forgot password. This parameter is required when ForgetPasswordStatus is set to enabled. Valid values: email, sms (SMS), totp (OTP), and web_authn (WebAuthn).', 'type' => 'string', 'example' => 'sms', 'title' => ''],
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'GetForgetPasswordConfiguration',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetForgetPasswordConfiguration'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetForgetPasswordConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthenticationSource', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"OpenForgetPasswordConfiguration\\": {\\n \\"Enable\\": true,\\n \\"EnableSms\\": true,\\n \\"EnableEmail\\": false,\\n \\"ForgetPasswordStatus\\": \\"enabled\\",\\n \\"AuthenticationChannels\\": [\\n \\"sms\\"\\n ]\\n }\\n}","type":"json"}]',
],
'GetGroup' => [
'summary' => 'Queries the details of an EIAM account group.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas1LGU5E'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The group ID.', 'type' => 'string', 'required' => true, 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'Group' => [
'description' => 'The account group object information.',
'type' => 'object',
'properties' => [
'GroupId' => ['title' => '', 'description' => 'The group ID.', 'type' => 'string', 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
'GroupName' => ['title' => '', 'description' => 'The group name.', 'type' => 'string', 'example' => 'group_name'],
'Description' => ['title' => '', 'description' => 'The group description.', 'type' => 'string', 'example' => 'test_group'],
'GroupExternalId' => ['title' => '', 'description' => 'The external ID of the group, which is used to associate the group with an external system. The default value is the account group ID.', 'type' => 'string', 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
'GroupSourceType' => ['title' => '', 'description' => 'The source type of the group. Currently, only built-in groups are supported. Valid values:'."\n"
.'- build_in: built-in.', 'type' => 'string', 'example' => 'build_in'],
'GroupSourceId' => ['title' => '', 'description' => 'The source ID of the group. The default value is the instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'CreateTime' => ['title' => '', 'description' => 'The time when the group was created. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the group was last updated. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query an EIAM account group',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Group\\": {\\n \\"GroupId\\": \\"group_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"GroupName\\": \\"group_name\\",\\n \\"Description\\": \\"test_group\\",\\n \\"GroupExternalId\\": \\"group_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"GroupSourceType\\": \\"build_in\\",\\n \\"GroupSourceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"CreateTime\\": 1652085686179,\\n \\"UpdateTime\\": 1652085686179,\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\"\\n }\\n}","type":"json"}]',
],
'GetIdentityProvider' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '119470',
'abilityTreeNodes' => ['FEATUREidaas3ZGGWT'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The identity provider ID.', 'type' => 'string', 'required' => true, 'example' => 'idp_my664lwkhpicbyzirog3xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'IdentityProviderDetail' => [
'description' => 'The identity provider information.',
'type' => 'object',
'properties' => [
'AdvancedStatus' => [
'title' => '',
'description' => 'The advanced configuration status. Valid values:'."\n"
."\n"
.'- disabled: Disabled.'."\n"
."\n"
.'- enabled: Enabled.',
'enumValueTitles' => [],
'type' => 'string',
'example' => 'disabled',
],
'AuthnSourceSupplier' => ['title' => '', 'description' => 'The authentication source product, such as Okta, Google, or Azure AD. Valid values:'."\n"
."\n"
.'- urn:alibaba:idaas:idp:alibaba:dingtalk: DingTalk.'."\n"
."\n"
.'- urn:alibaba:idaas:idp:unknown:ldap: LDAP.'."\n"
."\n"
.'- urn:alibaba:idaas:idp:alibaba:idaas: Alibaba Cloud IDaaS.'."\n"
."\n"
.'- urn:alibaba:idaas:idp:tencent:wecom: WeCom.'."\n"
."\n"
.'- urn:alibaba:idaas:idp:bytedance:lark: Lark.'."\n"
."\n"
.'- urn:alibaba:idaas:idp:microsoft:ad: Active Directory.'."\n"
."\n"
.'- urn:alibaba:idaas:idp:microsoft:aad: Azure Active Directory.'."\n"
."\n"
.'- urn:alibaba:idaas:idp:alibaba:sase: Alibaba Cloud SASE.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:idp:bytedance:lark'],
'AuthnSourceType' => ['title' => '', 'description' => 'The authentication method type, such as OIDC or SAML. Valid values:'."\n"
."\n"
.'- urn:alibaba:idaas:authntype:oidc: OIDC.'."\n"
."\n"
.'- urn:alibaba:idaas:authntype:saml2: SAML.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:authntype:oidc'],
'AuthnStatus' => ['title' => '', 'description' => 'Specifies whether the corresponding IdP supports authentication. Valid values:'."\n"
."\n"
.'- disabled: Disabled.'."\n"
."\n"
.'- enabled: Enabled.', 'type' => 'string', 'example' => 'disabled'],
'CreateTime' => ['title' => '', 'description' => 'The creation time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1726021079000'],
'Description' => ['title' => '', 'description' => 'The description of the identity provider.', 'type' => 'string', 'example' => 'for poc test'],
'DingtalkAppConfig' => [
'title' => '',
'description' => 'The DingTalk basic configuration.',
'type' => 'object',
'properties' => [
'AppKey' => ['title' => '', 'description' => 'The AppKey of the DingTalk first-party application.', 'type' => 'string', 'example' => '41reopmwoy9s'],
'AppSecret' => ['title' => '', 'description' => 'The AppSecret of the DingTalk first-party application.', 'type' => 'string', 'example' => 'REOQ6Cl55kriOd8NOBeqWYLKpHR4p6fdZxxxx'],
'CorpId' => ['title' => '', 'description' => 'The CorpId of the DingTalk first-party application.', 'type' => 'string', 'example' => '3756043633237690761'],
'DingtalkVersion' => ['title' => '', 'description' => 'The DingTalk version. Valid values:'."\n"
."\n"
.'- public_dingtalk: Standard DingTalk.'."\n"
."\n"
.'- private_dingtalk: Dedicated DingTalk.', 'type' => 'string', 'example' => 'public_dingtalk'],
'EncryptKey' => ['description' => 'The EncryptKey of the DingTalk application.', 'type' => 'string', 'example' => '29003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d', 'title' => ''],
'VerificationToken' => ['description' => 'The VerificationToken of the DingTalk application.', 'type' => 'string', 'example' => '5ba9c127a7abe029003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d', 'title' => ''],
'DingtalkLoginVersion' => [
'title' => '',
'description' => 'The DingTalk QR code logon version.',
'enumValueTitles' => ['old_version' => 'Legacy DingTalk QR code logon.', 'new_version' => 'New DingTalk QR code logon.'],
'type' => 'string',
'example' => 'old_version',
],
],
'example' => '',
],
'DingtalkProvisioningConfig' => [
'title' => '',
'description' => 'The DingTalk synchronization configuration. This value is returned only for DingTalk identity providers.',
'type' => 'object',
'properties' => [
'AuthedDepartmentIds' => [
'title' => '',
'description' => 'The authorized DingTalk departments.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DeptId' => ['title' => '', 'description' => 'The DingTalk department ID.', 'type' => 'string', 'example' => '123xxx444'],
'DeptName' => ['title' => '', 'description' => 'The DingTalk department name.', 'type' => 'string', 'example' => 'test_department'],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
'AuthedUsers' => [
'title' => '',
'description' => 'The list of authorized DingTalk accounts.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['title' => '', 'description' => 'The DingTalk username.', 'type' => 'string', 'example' => 'zhangsan'],
'UserId' => ['title' => '', 'description' => 'The DingTalk user ID.', 'type' => 'string', 'example' => '130308333929200479'],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
'CorpId' => ['title' => '', 'description' => 'The DingTalk enterprise CorpId.', 'type' => 'string', 'example' => 'ding_xxxxx'],
'CorpName' => ['title' => '', 'description' => 'The DingTalk enterprise name.', 'type' => 'string', 'example' => 'test_enterprise'],
],
'example' => '',
],
'IdentityProviderExternalId' => ['title' => '', 'description' => 'The external ID of the identity provider.', 'type' => 'string', 'example' => 'idp_xxxx'],
'IdentityProviderId' => ['title' => '', 'description' => 'The identity provider ID.', 'type' => 'string', 'example' => 'idp_mwpcwnhrimlr2horx7xgg7pp7y'],
'IdentityProviderName' => ['title' => '', 'description' => 'The name of the identity provider.', 'type' => 'string', 'example' => 'test'],
'IdentityProviderType' => ['title' => '', 'description' => 'The synchronization type of the identity provider. Valid values:'."\n"
."\n"
.'- urn:alibaba:idaas:idp:alibaba:dingtalk:pull: Inbound DingTalk.'."\n"
."\n"
.'- urn:alibaba:idaas:idp:alibaba:dingtalk:push: Outbound DingTalk.'."\n"
."\n"
.'- urn:alibaba:idaas:idp:tencent:wecom:pull: Inbound WeCom.'."\n"
."\n"
.'- urn:alibaba:idaas:idp:bytedance:lark:pull: Inbound Lark.'."\n"
."\n"
.'- urn:alibaba:idaas:idp:microsoft:ad:pull: Inbound AD.'."\n"
."\n"
.'- urn:alibaba:idaas:idp:unknown:ldap:pull: Inbound LDAP.'."\n"
."\n"
.'- urn:alibaba:idaas:idp:standard:oidc: Standard OIDC.'."\n"
."\n"
.'- urn:alibaba:idaas:idp:alibaba:sase: SASE custom OIDC.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:idp:alibaba:dingtalk:push'."\n"],
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_x2df3bak3uwnapqm6xxxx'],
'LarkConfig' => [
'title' => '',
'description' => 'The Lark configuration.',
'type' => 'object',
'properties' => [
'AppId' => ['title' => '', 'description' => 'The AppId of the Lark self-built application.', 'type' => 'string', 'example' => 'cli_a7a99f53a317100c'],
'AppSecret' => ['title' => '', 'description' => 'The AppSecret of the Lark self-built application.', 'type' => 'string', 'example' => '***'],
'EnterpriseNumber' => ['title' => '', 'description' => 'The Lark enterprise number.', 'type' => 'string', 'example' => 'FX1231xxxx'],
'EncryptKey' => ['title' => '', 'description' => 'The EncryptKey of the Lark self-built application.', 'type' => 'string', 'example' => 'VkdWw91mdkrjVFr3ObNwefap21dfbZbK'],
'VerificationToken' => ['title' => '', 'description' => 'The VerificationToken of the Lark self-built application.', 'type' => 'string', 'example' => 'VkdWw91mdkrjVFr3ObNwefap21dfbZbK'],
],
'example' => '',
],
'LastStatusCheckJobResult' => ['title' => '', 'description' => 'The result of the last status check.', 'type' => 'string', 'example' => 'success'],
'LdapConfig' => [
'title' => '',
'description' => 'The AD/LDAP identity provider configuration.',
'type' => 'object',
'properties' => [
'AdministratorPassword' => ['title' => '', 'description' => 'The AD/LDAP administrator password.', 'type' => 'string', 'example' => 'XXXX'],
'AdministratorUsername' => ['title' => '', 'description' => 'The AD/LDAP administrator account.', 'type' => 'string', 'example' => 'example.com'],
'CertificateFingerprintStatus' => ['title' => '', 'description' => 'Specifies whether to verify the certificate fingerprint. Valid values:'."\n"
."\n"
.'- disabled: Disabled.'."\n"
."\n"
.'- enabled: Enabled.', 'type' => 'string', 'example' => 'enabled'],
'CertificateFingerprints' => [
'title' => '',
'description' => 'The list of certificate fingerprints.',
'type' => 'array',
'items' => ['description' => 'The certificate fingerprint in SHA-256 format of the public key.', 'type' => 'string', 'example' => 'asdsadaasd', 'title' => ''],
'example' => '',
],
'LdapProtocol' => ['title' => '', 'description' => 'The communication protocol of AD/LDAP.', 'type' => 'string', 'example' => 'ldap'],
'LdapServerHost' => ['title' => '', 'description' => 'The AD/LDAP server address.', 'type' => 'string', 'example' => '127.xx.xx.100'],
'LdapServerPort' => ['title' => '', 'description' => 'The AD/LDAP server address.', 'type' => 'integer', 'format' => 'int32', 'example' => '389'],
'StartTlsStatus' => ['title' => '', 'description' => 'Specifies whether StartTLS is enabled. Valid values:'."\n"
."\n"
.'- disabled: Disabled.'."\n"
."\n"
.'- enabled: Enabled.', 'type' => 'string', 'example' => 'enabled'],
],
'example' => '',
],
'LockReason' => ['title' => '', 'description' => 'The lock reason.', 'type' => 'string', 'example' => 'financial'],
'NetworkAccessEndpointId' => ['title' => '', 'description' => 'The network endpoint ID.', 'type' => 'string', 'example' => 'nae_mx4vsadfe6govkqkwckxxxx'],
'OidcConfig' => [
'title' => '',
'description' => 'The OIDC IdP configuration.',
'type' => 'object',
'properties' => [
'AuthnParam' => [
'title' => '',
'description' => 'The OIDC client authentication configuration.',
'type' => 'object',
'properties' => [
'AuthnMethod' => ['title' => '', 'description' => 'The OIDC authentication method.', 'type' => 'string', 'example' => 'client_secret_post'],
'ClientId' => ['title' => '', 'description' => 'The OIDC client ID.', 'type' => 'string', 'example' => 'mkv7rgt4d7i4u7zqtzev2mxxxx'],
'ClientSecret' => ['title' => '', 'description' => 'The OIDC client secret.', 'type' => 'string', 'example' => 'CSEHDddddddxxxxuxkJEHPveWRXBGqVqRsxxxx'],
],
'example' => '',
],
'EndpointConfig' => [
'title' => '',
'description' => 'The OIDC endpoint configuration.',
'type' => 'object',
'properties' => [
'AuthorizationEndpoint' => ['title' => '', 'description' => 'The OIDC authorization endpoint.', 'type' => 'string', 'example' => 'https://example.com/oauth/authorize'],
'Issuer' => ['title' => '', 'description' => 'The OIDC issuer information.', 'type' => 'string', 'example' => 'https://example.com/oauth'],
'JwksUri' => ['title' => '', 'description' => 'The OIDC JWKS URI.', 'type' => 'string', 'example' => 'https://example.com/oauth/jwks'],
'TokenEndpoint' => ['title' => '', 'description' => 'The OIDC token endpoint.', 'type' => 'string', 'example' => 'https://example.com/oauth/token'],
'UserinfoEndpoint' => ['title' => '', 'description' => 'The OIDC user information endpoint.', 'type' => 'string', 'example' => 'https://example.com/oauth/userinfo'],
],
'example' => '',
],
'GrantScopes' => [
'title' => '',
'description' => 'The list of OIDC grant scopes.',
'type' => 'array',
'items' => ['description' => 'The OIDC grant scope.', 'type' => 'string', 'example' => 'ou_asdaq1addsxzdq1xxxx', 'title' => ''],
'example' => 'openid',
],
'GrantType' => ['title' => '', 'description' => 'The OIDC grant type.', 'type' => 'string', 'example' => 'authorization_code'],
'PkceChallengeMethod' => ['title' => '', 'description' => 'The PKCE algorithm. Valid values:'."\n"
."\n"
.'- S256: SHA-256.'."\n"
."\n"
.'- plain: Plaintext.', 'type' => 'string', 'example' => 'S256'],
'PkceRequired' => ['title' => '', 'description' => 'Specifies whether to use PKCE in the AuthorizationCode grant mode.', 'type' => 'boolean', 'example' => 'true'],
],
'example' => '',
],
'UdPullConfig' => [
'title' => '',
'description' => 'The inbound synchronization configuration.',
'type' => 'object',
'properties' => [
'GroupSyncStatus' => ['description' => 'Specifies whether group synchronization is enabled. Valid values:'."\n"
."\n"
.'- disabled: Disabled.'."\n"
."\n"
.'- enabled: Enabled.', 'type' => 'string', 'example' => 'disabled', 'title' => ''],
'IncrementalCallbackStatus' => ['title' => '', 'description' => 'The incremental callback status. Specifies whether to process incremental callback data from the IdP. Valid values:'."\n"
."\n"
.'- disabled: Disabled.'."\n"
."\n"
.'- enabled: Enabled.', 'type' => 'string', 'example' => 'disabled'],
'UdSyncScopeConfig' => [
'title' => '',
'description' => 'The synchronization scope configuration.',
'type' => 'object',
'properties' => [
'SourceScopes' => [
'title' => '',
'description' => 'The list of synchronization source nodes.',
'type' => 'array',
'items' => ['description' => 'The synchronization source node.', 'type' => 'string', 'example' => 'ou_123xxxx', 'title' => ''],
'example' => '',
],
'TargetScope' => ['title' => '', 'description' => 'The synchronization target node.', 'type' => 'string', 'example' => 'ou_123xxxx'],
],
'example' => '',
],
],
'example' => '',
],
'UdPullStatus' => ['title' => '', 'description' => 'Specifies whether the inbound synchronization feature is supported. Valid values:'."\n"
."\n"
.'- disabled: Disabled.'."\n"
."\n"
.'- enabled: Enabled.', 'type' => 'string', 'example' => 'disabled'],
'UdPushConfig' => [
'title' => '',
'description' => 'The outbound synchronization configuration.',
'type' => 'object',
'properties' => [
'IncrementalCallbackStatus' => ['title' => '', 'description' => 'This field is not in use. Ignore it.', 'type' => 'string', 'example' => 'disabled'],
'UdSyncScopeConfigs' => [
'title' => '',
'description' => 'The list of synchronization scope configurations.',
'type' => 'array',
'items' => [
'description' => 'The list of synchronization scope configurations.',
'type' => 'object',
'properties' => [
'SourceScopes' => [
'title' => '',
'description' => 'The list of synchronization source nodes.',
'type' => 'array',
'items' => ['description' => 'The synchronization source node. Set this to the organizational unit ID.', 'type' => 'string', 'example' => 'ou_123xxxx', 'title' => ''],
'example' => '',
],
'TargetScope' => ['title' => '', 'description' => 'The synchronization target node.', 'type' => 'string', 'example' => 'ou_123xxxx'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'example' => '',
],
'UdPushStatus' => ['title' => '', 'description' => 'Specifies whether the outbound synchronization feature is enabled. Valid values:'."\n"
."\n"
.'- disabled: Disabled.'."\n"
."\n"
.'- enabled: Enabled.', 'type' => 'string', 'example' => 'disabled'],
'UpdateTime' => ['title' => '', 'description' => 'The update time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1726021079000'],
'WeComConfig' => [
'title' => '',
'description' => 'The WeCom configuration.',
'type' => 'object',
'properties' => [
'AgentId' => ['title' => '', 'description' => 'The ID of the WeCom self-built application.', 'type' => 'string', 'example' => '1242350'],
'AuthorizeCallbackDomain' => ['title' => '', 'description' => 'The authorization callback domain.', 'type' => 'string', 'example' => 'https://example.com/xxxx'],
'CorpId' => ['title' => '', 'description' => 'The CorpId of the WeCom self-built application.', 'type' => 'string', 'example' => '3562012953454577801'],
'CorpSecret' => ['title' => '', 'description' => 'The CorpSecret of the WeCom self-built application.', 'type' => 'string', 'example' => 'weaseiszjskejskaj12sjeszojxxxx'],
'TrustableDomain' => ['title' => '', 'description' => 'The trusted domain name.', 'type' => 'string', 'example' => 'https://example.com'],
],
'example' => '',
],
'LogoUrl' => ['description' => 'The custom logo URL of the identity provider.', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg', 'title' => ''],
'SamlConfig' => [
'title' => '',
'description' => 'The SAML IdP configuration.',
'type' => 'object',
'properties' => [
'IdPEntityId' => ['title' => '', 'description' => 'The EntityId of the IdP.', 'type' => 'string', 'example' => 'http://dc.test.com/adfs/services/trust'],
'IdPSsoUrl' => ['title' => '', 'description' => 'The logon URL of the IdP.', 'type' => 'string', 'example' => 'https://dc.test.com/adfs/ls/'],
'Certificates' => [
'title' => '',
'description' => 'The list of IdP signing certificates.',
'type' => 'array',
'items' => [
'title' => '',
'description' => 'The certificate information.',
'type' => 'object',
'properties' => [
'Content' => ['title' => '', 'description' => 'The certificate content.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE----- MIIC0jCCAbqgAwIBAgIQXXXXX -----END CERTIFICATE-----'],
'CertificateMetadata' => [
'title' => '',
'description' => 'The certificate metadata.',
'type' => 'object',
'properties' => [
'NotBefore' => ['title' => '', 'description' => 'The earliest validity date of the certificate.', 'type' => 'integer', 'format' => 'int64', 'example' => '1672531200000'],
'NotAfter' => ['title' => '', 'description' => 'The latest validity date of the certificate.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704067200000'],
],
'example' => '',
],
],
'example' => '',
],
'example' => '',
],
'RequireRequestSigned' => ['title' => '', 'description' => 'Specifies whether the request must be signed.', 'type' => 'boolean', 'example' => 'true'],
'BindingMethod' => [
'title' => '',
'description' => 'The binding type.',
'type' => 'string',
'example' => 'HTTP-REDIRECT',
'enum' => ['HTTP-REDIRECT', 'HTTP-POST'],
],
'MaxClockSkew' => ['title' => '', 'description' => 'The maximum clock skew.', 'type' => 'integer', 'format' => 'int64', 'example' => '180'],
'WantResponseSigned' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'WantAssertionsSigned' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
],
'EndpointMetadata' => [
'title' => '',
'description' => 'The endpoint metadata.',
'type' => 'object',
'properties' => [
'SamlEntityId' => ['title' => '', 'description' => 'The SAML EntityId.', 'type' => 'string', 'example' => 'https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/meta'],
'SamlAcsEndpoint' => ['title' => '', 'description' => 'The SAML Assertion Consumer Service (ACS) endpoint.', 'type' => 'string', 'example' => 'https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/acs'],
'SamlMetaEndpoint' => ['title' => '', 'description' => 'The SAML metadata endpoint.', 'type' => 'string', 'example' => 'https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/meta'],
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Get identity provider',
'summary' => 'Retrieves an identity provider.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIdentityProvider'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IdentityProviderDetail\\": {\\n \\"AdvancedStatus\\": \\"disabled\\",\\n \\"AuthnSourceSupplier\\": \\"urn:alibaba:idaas:idp:bytedance:lark\\",\\n \\"AuthnSourceType\\": \\"urn:alibaba:idaas:authntype:oidc\\",\\n \\"AuthnStatus\\": \\"disabled\\",\\n \\"CreateTime\\": 1726021079000,\\n \\"Description\\": \\"for poc test\\",\\n \\"DingtalkAppConfig\\": {\\n \\"AppKey\\": \\"41reopmwoy9s\\",\\n \\"AppSecret\\": \\"REOQ6Cl55kriOd8NOBeqWYLKpHR4p6fdZxxxx\\",\\n \\"CorpId\\": \\"3756043633237690761\\",\\n \\"DingtalkVersion\\": \\"public_dingtalk\\",\\n \\"EncryptKey\\": \\"29003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d\\",\\n \\"VerificationToken\\": \\"5ba9c127a7abe029003eb11d0a28b4802a6f02fb8aa25dff730e2ac26ffd200d\\",\\n \\"DingtalkLoginVersion\\": \\"old_version\\"\\n },\\n \\"DingtalkProvisioningConfig\\": {\\n \\"AuthedDepartmentIds\\": [\\n {\\n \\"DeptId\\": \\"123xxx444\\",\\n \\"DeptName\\": \\"test_department\\"\\n }\\n ],\\n \\"AuthedUsers\\": [\\n {\\n \\"Name\\": \\"zhangsan\\",\\n \\"UserId\\": \\"130308333929200479\\"\\n }\\n ],\\n \\"CorpId\\": \\"ding_xxxxx\\",\\n \\"CorpName\\": \\"test_enterprise\\"\\n },\\n \\"IdentityProviderExternalId\\": \\"idp_xxxx\\",\\n \\"IdentityProviderId\\": \\"idp_mwpcwnhrimlr2horx7xgg7pp7y\\",\\n \\"IdentityProviderName\\": \\"test\\",\\n \\"IdentityProviderType\\": \\"urn:alibaba:idaas:idp:alibaba:dingtalk:push\\\\n\\",\\n \\"InstanceId\\": \\"idaas_x2df3bak3uwnapqm6xxxx\\",\\n \\"LarkConfig\\": {\\n \\"AppId\\": \\"cli_a7a99f53a317100c\\",\\n \\"AppSecret\\": \\"***\\",\\n \\"EnterpriseNumber\\": \\"FX1231xxxx\\",\\n \\"EncryptKey\\": \\"VkdWw91mdkrjVFr3ObNwefap21dfbZbK\\",\\n \\"VerificationToken\\": \\"VkdWw91mdkrjVFr3ObNwefap21dfbZbK\\"\\n },\\n \\"LastStatusCheckJobResult\\": \\"success\\",\\n \\"LdapConfig\\": {\\n \\"AdministratorPassword\\": \\"XXXX\\",\\n \\"AdministratorUsername\\": \\"example.com\\",\\n \\"CertificateFingerprintStatus\\": \\"enabled\\",\\n \\"CertificateFingerprints\\": [\\n \\"asdsadaasd\\"\\n ],\\n \\"LdapProtocol\\": \\"ldap\\",\\n \\"LdapServerHost\\": \\"127.xx.xx.100\\",\\n \\"LdapServerPort\\": 389,\\n \\"StartTlsStatus\\": \\"enabled\\"\\n },\\n \\"LockReason\\": \\"financial\\",\\n \\"NetworkAccessEndpointId\\": \\"nae_mx4vsadfe6govkqkwckxxxx\\",\\n \\"OidcConfig\\": {\\n \\"AuthnParam\\": {\\n \\"AuthnMethod\\": \\"client_secret_post\\",\\n \\"ClientId\\": \\"mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"ClientSecret\\": \\"CSEHDddddddxxxxuxkJEHPveWRXBGqVqRsxxxx\\"\\n },\\n \\"EndpointConfig\\": {\\n \\"AuthorizationEndpoint\\": \\"https://example.com/oauth/authorize\\",\\n \\"Issuer\\": \\"https://example.com/oauth\\",\\n \\"JwksUri\\": \\"https://example.com/oauth/jwks\\",\\n \\"TokenEndpoint\\": \\"https://example.com/oauth/token\\",\\n \\"UserinfoEndpoint\\": \\"https://example.com/oauth/userinfo\\"\\n },\\n \\"GrantScopes\\": [\\n \\"ou_asdaq1addsxzdq1xxxx\\"\\n ],\\n \\"GrantType\\": \\"authorization_code\\",\\n \\"PkceChallengeMethod\\": \\"S256\\",\\n \\"PkceRequired\\": true\\n },\\n \\"UdPullConfig\\": {\\n \\"GroupSyncStatus\\": \\"disabled\\",\\n \\"IncrementalCallbackStatus\\": \\"disabled\\",\\n \\"UdSyncScopeConfig\\": {\\n \\"SourceScopes\\": [\\n \\"ou_123xxxx\\"\\n ],\\n \\"TargetScope\\": \\"ou_123xxxx\\"\\n }\\n },\\n \\"UdPullStatus\\": \\"disabled\\",\\n \\"UdPushConfig\\": {\\n \\"IncrementalCallbackStatus\\": \\"disabled\\",\\n \\"UdSyncScopeConfigs\\": [\\n {\\n \\"SourceScopes\\": [\\n \\"ou_123xxxx\\"\\n ],\\n \\"TargetScope\\": \\"ou_123xxxx\\"\\n }\\n ]\\n },\\n \\"UdPushStatus\\": \\"disabled\\",\\n \\"UpdateTime\\": 1726021079000,\\n \\"WeComConfig\\": {\\n \\"AgentId\\": \\"1242350\\",\\n \\"AuthorizeCallbackDomain\\": \\"https://example.com/xxxx\\",\\n \\"CorpId\\": \\"3562012953454577801\\",\\n \\"CorpSecret\\": \\"weaseiszjskejskaj12sjeszojxxxx\\",\\n \\"TrustableDomain\\": \\"https://example.com\\"\\n },\\n \\"LogoUrl\\": \\"https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg\\",\\n \\"SamlConfig\\": {\\n \\"IdPEntityId\\": \\"http://dc.test.com/adfs/services/trust\\",\\n \\"IdPSsoUrl\\": \\"https://dc.test.com/adfs/ls/\\",\\n \\"Certificates\\": [\\n {\\n \\"Content\\": \\"-----BEGIN CERTIFICATE----- MIIC0jCCAbqgAwIBAgIQXXXXX -----END CERTIFICATE-----\\",\\n \\"CertificateMetadata\\": {\\n \\"NotBefore\\": 1672531200000,\\n \\"NotAfter\\": 1704067200000\\n }\\n }\\n ],\\n \\"RequireRequestSigned\\": true,\\n \\"BindingMethod\\": \\"HTTP-REDIRECT\\",\\n \\"MaxClockSkew\\": 180,\\n \\"WantResponseSigned\\": false,\\n \\"WantAssertionsSigned\\": false\\n },\\n \\"EndpointMetadata\\": {\\n \\"SamlEntityId\\": \\"https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/meta\\",\\n \\"SamlAcsEndpoint\\": \\"https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/acs\\",\\n \\"SamlMetaEndpoint\\": \\"https://9test.aliyunidaas.com/login/saml2/idp_nhlraxfiwsx7w7zp26qzyoxxxx/meta\\"\\n }\\n },\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'GetIdentityProviderAdvancedConfiguration' => [
'summary' => 'Retrieves advanced configuration information.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => 'eiam-111ccc1111', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['description' => 'Identity provider ID', 'type' => 'string', 'required' => true, 'example' => 'idp_11111', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'AdvancedConfiguration' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'title' => '', 'example' => 'idaas_kpvmhktvun6u66dgpjh3l4wxxx'],
'IdentityProviderId' => ['description' => 'Identity provider ID', 'type' => 'string', 'title' => '', 'example' => 'idp_na2rzpyc67zr7ixdfy35zgrxxx'],
'DingtalkAdvancedConfig' => [
'description' => 'DingTalk advanced configuration',
'type' => 'object',
'properties' => [
'AppKey' => ['description' => 'AppKey of the DingTalk first-party application', 'type' => 'string', 'title' => '', 'example' => 'ding5xo9rg0csw3f6xxx'],
'AppSecret' => ['description' => 'App secret of the DingTalk first-party application', 'type' => 'string', 'title' => '', 'example' => '***'],
],
'title' => '',
'example' => '',
],
],
'description' => 'Advanced configuration information',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'GetIdentityProviderAdvancedConfiguration',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"AdvancedConfiguration\\": {\\n \\"InstanceId\\": \\"idaas_kpvmhktvun6u66dgpjh3l4wxxx\\",\\n \\"IdentityProviderId\\": \\"idp_na2rzpyc67zr7ixdfy35zgrxxx\\",\\n \\"DingtalkAdvancedConfig\\": {\\n \\"AppKey\\": \\"ding5xo9rg0csw3f6xxx\\",\\n \\"AppSecret\\": \\"***\\"\\n }\\n }\\n}","type":"json"}]',
],
'GetIdentityProviderStatusCheckJob' => [
'summary' => 'Retrieves an IdP check task.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['description' => 'The identity provider (IdP) ID.', 'type' => 'string', 'required' => true, 'example' => 'idp_11111', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'IdentityProviderStatusCheckJobId',
'in' => 'query',
'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => 'async_000xxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'IdentityProviderStatusCheckJob' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'idaas_ki6hd7ihir4ybawogqk6kqsfxxx'],
'IdentityProviderId' => ['description' => 'The ID of the IdP.', 'type' => 'string', 'title' => '', 'example' => 'idp_ncehkms65fiefobrvwy2blrxxx'],
'IdentityProviderStatusCheckJobId' => ['description' => 'The ID of the IdP status check job.', 'type' => 'string', 'title' => '', 'example' => 'async_000036tfu8cgngmakngrr2rk75qgf87pf3rxxx'],
'Status' => ['description' => 'The status of the check task.', 'type' => 'string', 'title' => '', 'example' => 'success'],
'CheckResult' => ['description' => 'The result of the check task.', 'type' => 'string', 'title' => '', 'example' => 'success'],
'StartTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1763776265757'],
'EndTime' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1763776265757'],
'JobCheckItems' => [
'description' => 'The results of the status check subtasks.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'MajorCheckItem' => ['description' => 'The major check item.', 'type' => 'string', 'title' => '', 'example' => 'network_check'],
'MinorCheckItem' => ['description' => 'The minor check item.', 'type' => 'string', 'title' => '', 'example' => 'network_access_status'],
'Result' => ['description' => 'The result.', 'type' => 'string', 'title' => '', 'example' => 'success'],
'ErrorReason' => [
'description' => 'The reason for the error.',
'type' => 'object',
'properties' => [
'ErrorLevel' => ['description' => 'The error level.', 'type' => 'string', 'title' => '', 'example' => 'high'],
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'NetworkAccessPointWarning.SingleNetworkAccessPath'],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'There is only one path in the current network access endpoint.'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => 'The information about the IdP status check job.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'GetIdentityProviderStatusCheckJob',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"IdentityProviderStatusCheckJob\\": {\\n \\"InstanceId\\": \\"idaas_ki6hd7ihir4ybawogqk6kqsfxxx\\",\\n \\"IdentityProviderId\\": \\"idp_ncehkms65fiefobrvwy2blrxxx\\",\\n \\"IdentityProviderStatusCheckJobId\\": \\"async_000036tfu8cgngmakngrr2rk75qgf87pf3rxxx\\",\\n \\"Status\\": \\"success\\",\\n \\"CheckResult\\": \\"success\\",\\n \\"StartTime\\": 1763776265757,\\n \\"EndTime\\": 1763776265757,\\n \\"JobCheckItems\\": [\\n {\\n \\"MajorCheckItem\\": \\"network_check\\",\\n \\"MinorCheckItem\\": \\"network_access_status\\",\\n \\"Result\\": \\"success\\",\\n \\"ErrorReason\\": {\\n \\"ErrorLevel\\": \\"high\\",\\n \\"ErrorCode\\": \\"NetworkAccessPointWarning.SingleNetworkAccessPath\\",\\n \\"ErrorMessage\\": \\"There is only one path in the current network access endpoint.\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetIdentityProviderUdPullConfiguration' => [
'summary' => 'Retrieves the inbound synchronization configuration of an identity provider (IdP).',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '134735',
'abilityTreeNodes' => ['FEATUREidaas3ZGGWT'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The identity provider ID.', 'type' => 'string', 'required' => true, 'example' => 'idp_my664lwkhpicbyzirog3xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'UdPullConfiguration' => [
'description' => 'The inbound synchronization configuration.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'IdentityProviderId' => ['title' => '', 'description' => 'The identity provider ID.', 'type' => 'string', 'example' => 'idp_my664lwkhpicbyzirog3xxxxx'."\n"],
'IncrementalCallbackStatus' => ['title' => '', 'description' => 'The incremental callback status, which specifies whether to process incremental callback data from the IdP. Valid values:'."\n"
."\n"
.'- disabled'."\n"
.'- enabled.', 'type' => 'string', 'example' => 'enabled'],
'PeriodicSyncStatus' => ['title' => '', 'description' => 'The periodic verification status, which specifies whether to periodically verify data differences between IDaaS and the identity provider. Valid values:'."\n"
."\n"
.'- disabled'."\n"
.'- enabled.', 'type' => 'string', 'example' => 'enabled'],
'GroupSyncStatus' => ['title' => '', 'description' => 'The group synchronization status. Valid values:'."\n"
."\n"
.'- disabled'."\n"
.'- enabled.', 'type' => 'string', 'example' => 'enabled'],
'UdSyncScopeConfig' => [
'title' => '',
'description' => 'The synchronization scope configuration.',
'type' => 'object',
'properties' => [
'SourceScopes' => [
'title' => '',
'description' => 'The list of source nodes for synchronization.',
'type' => 'array',
'items' => ['description' => 'The source node for synchronization.', 'type' => 'string', 'example' => '960', 'title' => ''],
'example' => '',
],
'TargetScope' => ['title' => '', 'description' => 'The target node for synchronization.', 'type' => 'string', 'example' => 'ou_asjdfhaskfhw213mnsj33sXXX'],
],
'example' => '',
],
'PullProtectedRule' => [
'title' => '',
'description' => 'The inbound synchronization protection rule configuration.',
'type' => 'object',
'properties' => [
'UserDeletedThreshold' => ['title' => '', 'description' => 'The threshold for the number of deleted accounts. If the number of deleted users exceeds this value, the synchronization task is terminated.', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'OrganizationalUnitDeletedThreshold' => ['title' => '', 'description' => 'The threshold for the number of deleted organizational units. If the number of deleted organizational units exceeds this value, the synchronization task is terminated.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'GroupDeletedThreshold' => ['title' => '', 'description' => 'The threshold for the number of deleted groups. If the number of deleted groups exceeds this value, the synchronization task is terminated.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
'example' => '',
],
'LdapUdPullConfig' => [
'title' => '',
'description' => 'The LDAP synchronization configuration.',
'type' => 'object',
'properties' => [
'UserObjectClass' => ['title' => '', 'description' => 'The user ObjectClass.', 'type' => 'string', 'example' => 'ou,top'],
'OrganizationUnitObjectClass' => ['title' => '', 'description' => 'The organizational unit ObjectClass.', 'type' => 'string', 'example' => 'ou,top'],
'UserObjectClassCustomFilter' => ['title' => '', 'description' => 'The custom filter for users.', 'type' => 'string', 'example' => '(|(cn=test)(mail=test@test.com))'],
'GroupObjectClass' => ['title' => '', 'description' => 'The group ObjectClass.', 'type' => 'string', 'example' => 'member'],
'GroupMemberAttributeName' => ['title' => '', 'description' => 'The group member identifier attribute.', 'type' => 'string', 'example' => 'group'],
'GroupObjectClassCustomFilter' => ['title' => '', 'description' => 'The custom filter for groups.', 'type' => 'string', 'example' => '(|(cn=test)(group=test@test.com))'],
],
'example' => '',
],
'PeriodicSyncConfig' => [
'title' => '',
'description' => 'The periodic synchronization configuration.',
'type' => 'object',
'properties' => [
'PeriodicSyncType' => [
'title' => '',
'description' => 'The periodic synchronization type.',
'type' => 'string',
'example' => 'cron',
'enum' => ['cron', 'time'],
],
'PeriodicSyncCron' => ['title' => '', 'description' => 'The cron expression.', 'type' => 'string', 'example' => '0 45 1 * * ?'],
'PeriodicSyncTimes' => ['title' => '', 'description' => 'The execution time points. For example, [3, 5] indicates that synchronization runs once between 3:00 and 4:00 and once between 5:00 and 6:00.', 'type' => 'integer', 'format' => 'int32', 'example' => '[3,5]'],
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Retrieve idP inbound synchronization configuration',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIdentityProviderUdPullConfiguration'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"UdPullConfiguration\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"IdentityProviderId\\": \\"idp_my664lwkhpicbyzirog3xxxxx\\\\n\\",\\n \\"IncrementalCallbackStatus\\": \\"enabled\\",\\n \\"PeriodicSyncStatus\\": \\"enabled\\",\\n \\"GroupSyncStatus\\": \\"enabled\\",\\n \\"UdSyncScopeConfig\\": {\\n \\"SourceScopes\\": [\\n \\"960\\"\\n ],\\n \\"TargetScope\\": \\"ou_asjdfhaskfhw213mnsj33sXXX\\"\\n },\\n \\"PullProtectedRule\\": {\\n \\"UserDeletedThreshold\\": 30,\\n \\"OrganizationalUnitDeletedThreshold\\": 10,\\n \\"GroupDeletedThreshold\\": 10\\n },\\n \\"LdapUdPullConfig\\": {\\n \\"UserObjectClass\\": \\"ou,top\\",\\n \\"OrganizationUnitObjectClass\\": \\"ou,top\\",\\n \\"UserObjectClassCustomFilter\\": \\"(|(cn=test)(mail=test@test.com))\\",\\n \\"GroupObjectClass\\": \\"member\\",\\n \\"GroupMemberAttributeName\\": \\"group\\",\\n \\"GroupObjectClassCustomFilter\\": \\"(|(cn=test)(group=test@test.com))\\"\\n },\\n \\"PeriodicSyncConfig\\": {\\n \\"PeriodicSyncType\\": \\"cron\\",\\n \\"PeriodicSyncCron\\": \\"0 45 1 * * ?\\",\\n \\"PeriodicSyncTimes\\": 0\\n }\\n }\\n}","type":"json"}]',
],
'GetIdentityProviderUdPushConfiguration' => [
'summary' => 'Retrieve the IdP outbound synchronization configuration.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => 'eiam-111ccc1111', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['description' => 'Identity provider ID', 'type' => 'string', 'required' => true, 'example' => 'idp_11111', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'UdPushConfiguration' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'Instance ID', 'type' => 'string', 'title' => '', 'example' => 'idaas_7vdv3olzk36gymwtlaq6fixxxx'],
'IdentityProviderId' => ['description' => 'Identity provider ID', 'type' => 'string', 'title' => '', 'example' => 'idp_na2rzpyc67zr7ixdfy35zgrxxx'],
'IncrementalCallbackStatus' => ['description' => 'Incremental callback status. Indicates whether incremental callback data from the IdP is processed.', 'type' => 'string', 'example' => 'enabled', 'title' => ''],
'UdSyncScopeConfigs' => [
'description' => 'Outbound synchronization configuration details',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SourceScopes' => [
'description' => 'Source nodes for synchronization',
'type' => 'array',
'items' => ['description' => 'Source node for synchronization', 'type' => 'string', 'example' => 'ou_12121xxxx', 'title' => ''],
'title' => '',
'example' => '',
],
'TargetScope' => ['description' => 'Target node for synchronization', 'type' => 'string', 'title' => '', 'example' => '604352338'],
],
'description' => 'Outbound synchronization configuration details',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'LdapUdPushConfig' => [
'type' => 'object',
'properties' => [
'UserObjectClass' => ['description' => 'User ObjectClass', 'type' => 'string', 'example' => 'user,top', 'title' => ''],
'OrganizationUnitObjectClass' => ['description' => 'Organization ObjectClass', 'type' => 'string', 'example' => 'ou,top', 'title' => ''],
'UserRdn' => ['description' => 'User RDN', 'type' => 'string', 'example' => 'cn', 'title' => ''],
'OrganizationalUnitRdn' => ['description' => 'Organization RDN', 'type' => 'string', 'example' => 'ou', 'title' => ''],
'PasswordSyncStatus' => ['description' => 'Password synchronization status', 'type' => 'string', 'example' => 'enabled', 'title' => ''],
],
'title' => '',
'description' => 'LDAP synchronization-side configuration',
'example' => '',
],
'PeriodicSyncConfig' => [
'type' => 'object',
'properties' => [
'PeriodicSyncType' => ['description' => 'Type', 'type' => 'string', 'example' => 'cron', 'title' => ''],
'PeriodicSyncCron' => ['description' => 'Cron expression', 'type' => 'string', 'example' => '0 45 1 * * ?', 'title' => ''],
'PeriodicSyncTimes' => [
'type' => 'array',
'items' => ['description' => 'Time point', 'type' => 'string', 'example' => '3', 'title' => ''],
'title' => '',
'description' => 'Collection of time points',
'example' => '',
],
],
'title' => '',
'description' => 'Periodic verification configuration',
'example' => '',
],
'PeriodicSyncStatus' => ['description' => 'Periodic verification status', 'type' => 'string', 'example' => 'disabled', 'title' => ''],
],
'description' => 'Outbound synchronization configuration',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'GetIdentityProviderUdPushConfiguration',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"UdPushConfiguration\\": {\\n \\"InstanceId\\": \\"idaas_7vdv3olzk36gymwtlaq6fixxxx\\",\\n \\"IdentityProviderId\\": \\"idp_na2rzpyc67zr7ixdfy35zgrxxx\\",\\n \\"IncrementalCallbackStatus\\": \\"enabled\\",\\n \\"UdSyncScopeConfigs\\": [\\n {\\n \\"SourceScopes\\": [\\n \\"ou_12121xxxx\\"\\n ],\\n \\"TargetScope\\": \\"604352338\\"\\n }\\n ],\\n \\"LdapUdPushConfig\\": {\\n \\"UserObjectClass\\": \\"user,top\\",\\n \\"OrganizationUnitObjectClass\\": \\"ou,top\\",\\n \\"UserRdn\\": \\"cn\\",\\n \\"OrganizationalUnitRdn\\": \\"ou\\",\\n \\"PasswordSyncStatus\\": \\"enabled\\"\\n },\\n \\"PeriodicSyncConfig\\": {\\n \\"PeriodicSyncType\\": \\"cron\\",\\n \\"PeriodicSyncCron\\": \\"0 45 1 * * ?\\",\\n \\"PeriodicSyncTimes\\": [\\n \\"3\\"\\n ]\\n },\\n \\"PeriodicSyncStatus\\": \\"disabled\\"\\n }\\n}","type":"json"}]',
],
'GetInstance' => [
'summary' => 'Queries the details of an EIAM instance.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6GKEFM'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'Instance' => [
'description' => 'The instance information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_abt3pfwojojcq323si6g5xxxxx'],
'CreateTime' => ['title' => '', 'description' => 'The time when the instance was created. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1550115455000'],
'Status' => ['title' => '', 'description' => 'The instance status. Valid values:'."\n"
.'- creating: Being created.'."\n"
.'- running: Running.', 'type' => 'string', 'example' => 'running'],
'Description' => ['title' => '', 'description' => 'The description of the instance.', 'type' => 'string', 'example' => 'instance_for_test'],
'DefaultEndpoint' => [
'title' => '',
'description' => 'The default domain name of the instance. This field is no longer maintained. Use the DomainConfig fields or refer to the query domain name list operation instead.',
'type' => 'object',
'properties' => [
'Endpoint' => ['title' => '', 'description' => 'The domain name of the instance.', 'type' => 'string', 'example' => 'example-xxx.aliyunidaas.com'."\n"],
'Status' => ['title' => '', 'description' => 'The status of the instance domain name. Valid values:'."\n"
.'- resolved: Resolved.'."\n"
.'- unresolved: Not resolved.', 'type' => 'string', 'example' => 'resolved'],
],
'example' => '',
],
'EgressAddresses' => [
'title' => '',
'description' => 'The public egress CIDR blocks of the instance. For example, during Active Directory (AD) account synchronization, the EIAM instance accesses your AD server through these public CIDR blocks.',
'type' => 'array',
'items' => ['description' => 'The public egress address of the instance.', 'type' => 'string', 'example' => '203.0.XX.XX/27', 'title' => ''],
'example' => '',
],
'DomainConfig' => [
'title' => '',
'description' => 'The domain name configuration of the instance.',
'type' => 'object',
'properties' => [
'InitDomainAutoRedirectStatus' => ['title' => '', 'description' => 'The automatic redirect status of the initialization domain name. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'disabled'],
'DefaultDomain' => ['title' => '', 'description' => 'The default domain name of the instance.', 'type' => 'string', 'example' => 'login.example.com'],
'InitDomain' => ['title' => '', 'description' => 'The initialization domain name of the instance.', 'type' => 'string', 'example' => 'rx72nxxx.example.com'],
],
'example' => '',
],
'ServiceManaged' => ['title' => '', 'description' => 'Indicates whether the instance is managed by an Alibaba Cloud service.', 'type' => 'boolean', 'example' => 'false'],
'ManagedServiceCode' => ['title' => '', 'description' => 'The ServiceCode of the Alibaba Cloud service that manages the instance.', 'type' => 'string', 'example' => 'sase'],
'CrossRegionReplication' => ['title' => '', 'type' => 'string', 'required' => false, 'example' => 'enabled', 'description' => ''],
'CrossRegionReplicationRole' => ['title' => '', 'type' => 'string', 'required' => false, 'example' => 'primary', 'description' => ''],
'InstanceFailoverStatus' => ['title' => '', 'type' => 'string', 'required' => false, 'example' => 'inactive', 'description' => ''],
'ReplicationConfiguration' => [
'title' => '',
'type' => 'object',
'properties' => [
'PrimaryInstanceId' => ['title' => '', 'type' => 'string', 'example' => 'idaas_xxxx', 'description' => ''],
'PrimaryInstanceRegionId' => ['title' => '', 'type' => 'string', 'example' => 'cn-hangzhou', 'description' => ''],
'BackupInstanceId' => ['title' => '', 'type' => 'string', 'example' => 'idaas_xxxx', 'description' => ''],
'BackupInstanceRegionId' => ['title' => '', 'type' => 'string', 'example' => 'cn-beijing', 'description' => ''],
'ReplicationCreateTime' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'example' => '1778499337000', 'description' => ''],
],
'description' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query a single EIAM instance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Instance\\": {\\n \\"InstanceId\\": \\"idaas_abt3pfwojojcq323si6g5xxxxx\\",\\n \\"CreateTime\\": 1550115455000,\\n \\"Status\\": \\"running\\",\\n \\"Description\\": \\"instance_for_test\\",\\n \\"DefaultEndpoint\\": {\\n \\"Endpoint\\": \\"example-xxx.aliyunidaas.com\\\\n\\",\\n \\"Status\\": \\"resolved\\"\\n },\\n \\"EgressAddresses\\": [\\n \\"203.0.XX.XX/27\\"\\n ],\\n \\"DomainConfig\\": {\\n \\"InitDomainAutoRedirectStatus\\": \\"disabled\\",\\n \\"DefaultDomain\\": \\"login.example.com\\",\\n \\"InitDomain\\": \\"rx72nxxx.example.com\\"\\n },\\n \\"ServiceManaged\\": false,\\n \\"ManagedServiceCode\\": \\"sase\\",\\n \\"CrossRegionReplication\\": \\"enabled\\",\\n \\"CrossRegionReplicationRole\\": \\"primary\\",\\n \\"InstanceFailoverStatus\\": \\"inactive\\",\\n \\"ReplicationConfiguration\\": {\\n \\"PrimaryInstanceId\\": \\"idaas_xxxx\\",\\n \\"PrimaryInstanceRegionId\\": \\"cn-hangzhou\\",\\n \\"BackupInstanceId\\": \\"idaas_xxxx\\",\\n \\"BackupInstanceRegionId\\": \\"cn-beijing\\",\\n \\"ReplicationCreateTime\\": 1778499337000\\n }\\n }\\n}","type":"json"}]',
],
'GetInstanceControlConfiguration' => [
'summary' => 'Queries instance control items.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '237885',
'abilityTreeNodes' => ['FEATUREidaas0REDLU', 'FEATUREidaas6GKEFM'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ElementName',
'in' => 'query',
'schema' => ['title' => '', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'InstanceControlConfiguration' => [
'description' => 'The instance control configuration.',
'type' => 'object',
'properties' => [
'ControlElements' => [
'title' => '',
'description' => 'The instance control configuration.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ElementName' => ['title' => '', 'description' => 'The name of the instance control item.', 'type' => 'string', 'example' => 'human_verification'],
'Status' => ['title' => '', 'description' => 'The status of the instance control item.', 'type' => 'string', 'example' => 'enabled'],
'HumanVerificationConfig' => [
'description' => 'The Completely Automated Public Turing test to tell Computers and Humans Apart (CAPTCHA) authenticate configuration.',
'type' => 'object',
'properties' => [
'HumanVerificationType' => ['description' => 'The CAPTCHA type.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:humanverification:alibaba-cloud-jigsaw-verification', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query instance control items',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetInstanceControlConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"InstanceControlConfiguration\\": {\\n \\"ControlElements\\": [\\n {\\n \\"ElementName\\": \\"human_verification\\",\\n \\"Status\\": \\"enabled\\",\\n \\"HumanVerificationConfig\\": {\\n \\"HumanVerificationType\\": \\"urn:alibaba:idaas:humanverification:alibaba-cloud-jigsaw-verification\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetInstanceGlobalizationConfig' => [
'summary' => 'Retrieves the language and time zone information of an instance.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6GKEFM'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'GlobalizationConfig' => [
'description' => 'The language and time zone configuration of the instance.',
'type' => 'object',
'properties' => [
'Language' => ['title' => '', 'description' => 'The language.', 'type' => 'string', 'example' => 'zh-Hans-CN'],
'TimeZone' => ['title' => '', 'description' => 'The time zone.', 'type' => 'string', 'example' => 'Asia/Shanghai'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Retrieve instance language and time zone information',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetInstanceGlobalizationConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"GlobalizationConfig\\": {\\n \\"Language\\": \\"zh-Hans-CN\\",\\n \\"TimeZone\\": \\"Asia/Shanghai\\"\\n }\\n}","type":"json"}]',
],
'GetInstanceLicense' => [
'summary' => 'Queries the active license information for an instance.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6GKEFM'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk2676xxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'License' => [
'description' => 'The license details.',
'type' => 'object',
'properties' => [
'LicenseId' => ['title' => '', 'description' => 'The unique identifier for the license.', 'type' => 'string', 'example' => 'license_1234xxxx'],
'LicenseStatus' => [
'title' => '',
'description' => 'The license status.',
'enumValueTitles' => ['valid' => 'The license is active and in effect.', 'expired' => 'The license\'s validity period has ended.', 'released' => 'The license has been released and is no longer in use.'],
'type' => 'string',
'example' => 'valid',
],
'LicenseChargeType' => [
'title' => '',
'description' => 'The billing method for the license.',
'enumValueTitles' => ['prepay' => 'subscription', 'postpay' => 'pay-as-you-go'],
'type' => 'string',
'example' => 'prepay',
],
'LicenseConfigJson' => ['title' => '', 'description' => 'The detailed configurations of the license, formatted as a JSON string.', 'type' => 'string', 'example' => '{"modules":[{"features":[{"name":"urn:alibaba:idaas:license:module:ud:customField","status":"enabled"}]……{"name":"urn:alibaba:idaas:license:tag:enterprise","status":"enabled"}],"version":"1.0"}'],
'LicenseCreateTime' => ['title' => '', 'description' => 'The UNIX timestamp indicating when the license was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1720509699000'],
'PurchaseChannel' => [
'title' => '',
'description' => 'The channel used to purchase the license.',
'enumValueTitles' => ['alibaba_cloud' => 'Alibaba Cloud', 'system_free' => 'System-provisioned free edition', 'system_trial' => 'System-provisioned trial edition'],
'type' => 'string',
'example' => 'alibaba_cloud',
],
'PurchaseInstanceId' => ['title' => '', 'description' => 'The unique identifier of the external service associated with the license.', 'type' => 'string', 'example' => 'eiam-cn-xxxxx'],
'Edition' => [
'title' => '',
'description' => 'The license edition.',
'enumValueTitles' => ['enterprise' => 'enterprise edition', 'free' => 'free edition', 'trial' => 'trial edition'],
'type' => 'string',
'example' => 'free',
],
'UserQuota' => ['title' => '', 'description' => 'The user quota included with the license.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'StartTime' => ['title' => '', 'description' => 'The UNIX timestamp indicating the start of the license validity period.', 'type' => 'integer', 'format' => 'int64', 'example' => '1720509699000'],
'EndTime' => ['title' => '', 'description' => 'The UNIX timestamp indicating the end of the license validity period.', 'type' => 'integer', 'format' => 'int64', 'example' => '1723996800000'],
'InstanceLicenseDetail' => [
'type' => 'object',
'properties' => [
'UserQuota' => ['description' => 'The user quota included with the license.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'PrepaidActiveUserNumber' => ['description' => 'The number of active subscription accounts.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'M2mApplicationQuota' => ['description' => 'The quota for machine-to-machine (M2M) applications.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'M2mApplicationLicenseStatus' => [
'description' => 'The status of the license for machine-to-machine (M2M) applications.',
'enumValueTitles' => ['disabled' => 'This feature is disabled.', 'enabled' => 'This feature is enabled.'],
'type' => 'string',
'example' => 'enabled',
'title' => '',
],
'MimApplicationLicenseStatus' => ['description' => 'The machine identity status.', 'type' => 'string', 'example' => 'enabled', 'title' => ''],
'NetworkAccessEndpointQuota' => ['description' => 'The quota for network access endpoints.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'ConditionalAccessPolicyLicenseStatus' => [
'description' => 'The status of the license for the Conditional Access feature.',
'enumValueTitles' => ['disabled' => 'This feature is disabled.', 'enabled' => 'This feature is enabled.'],
'type' => 'string',
'example' => 'enabled',
'title' => '',
],
],
'description' => 'The details of the instance license.',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => 'The response parameters.',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"License\\": {\\n \\"LicenseId\\": \\"license_1234xxxx\\",\\n \\"LicenseStatus\\": \\"valid\\",\\n \\"LicenseChargeType\\": \\"prepay\\",\\n \\"LicenseConfigJson\\": \\"{\\\\\\"modules\\\\\\":[{\\\\\\"features\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"urn:alibaba:idaas:license:module:ud:customField\\\\\\",\\\\\\"status\\\\\\":\\\\\\"enabled\\\\\\"}]……{\\\\\\"name\\\\\\":\\\\\\"urn:alibaba:idaas:license:tag:enterprise\\\\\\",\\\\\\"status\\\\\\":\\\\\\"enabled\\\\\\"}],\\\\\\"version\\\\\\":\\\\\\"1.0\\\\\\"}\\",\\n \\"LicenseCreateTime\\": 1720509699000,\\n \\"PurchaseChannel\\": \\"alibaba_cloud\\",\\n \\"PurchaseInstanceId\\": \\"eiam-cn-xxxxx\\",\\n \\"Edition\\": \\"free\\",\\n \\"UserQuota\\": 100,\\n \\"StartTime\\": 1720509699000,\\n \\"EndTime\\": 1723996800000,\\n \\"InstanceLicenseDetail\\": {\\n \\"UserQuota\\": 100,\\n \\"PrepaidActiveUserNumber\\": 100,\\n \\"M2mApplicationQuota\\": 2,\\n \\"M2mApplicationLicenseStatus\\": \\"enabled\\",\\n \\"MimApplicationLicenseStatus\\": \\"enabled\\",\\n \\"NetworkAccessEndpointQuota\\": 1,\\n \\"ConditionalAccessPolicyLicenseStatus\\": \\"enabled\\"\\n }\\n }\\n}","type":"json"}]',
'title' => 'Query License of the Instance',
'description' => 'Ensure the instance is not in use before deletion. Deleting an EIAM instance permanently removes all of its associated data.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceLicense'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetInstanceLicense',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'GetInstanceModuleInfo' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6GKEFM'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ModuleKey',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The identifier of the first-level module.', 'type' => 'string', 'required' => true, 'example' => 'urn:alibaba:idaas:license:module:ud', 'maxLength' => 128],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'Module' => [
'description' => 'The instance information.',
'type' => 'object',
'properties' => [
'ModuleKey' => ['title' => '', 'description' => 'The identifier of the first-level module.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:license:module:application'],
'ModuleStatus' => ['title' => '', 'description' => 'The status of the first-level module.', 'type' => 'string', 'example' => 'enabled'],
'Features' => [
'title' => '',
'description' => 'The second-level module information.',
'type' => 'array',
'items' => [
'description' => 'The second-level module information.',
'type' => 'object',
'properties' => [
'FeatureKey' => ['title' => '', 'description' => 'The identifier of the second-level module.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:license:module:application:standard:oidc'],
'FeatureStatus' => ['title' => '', 'description' => 'The status of the second-level module.', 'type' => 'string', 'example' => 'enabled'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Retrieve all module information under a first-level module',
'summary' => 'Retrieves all module information under a first-level module.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetInstanceModuleInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Module\\": {\\n \\"ModuleKey\\": \\"urn:alibaba:idaas:license:module:application\\",\\n \\"ModuleStatus\\": \\"enabled\\",\\n \\"Features\\": [\\n {\\n \\"FeatureKey\\": \\"urn:alibaba:idaas:license:module:application:standard:oidc\\",\\n \\"FeatureStatus\\": \\"enabled\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetInstanceQuota' => [
'summary' => 'Retrieves the quota of a single type for an instance.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6GKEFM'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'QuotaKey',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The quota type.', 'type' => 'string', 'required' => true, 'example' => 'userMaxNumber'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'Quota' => [
'description' => 'The quota information.',
'type' => 'object',
'properties' => [
'QuotaKey' => ['title' => '', 'description' => 'The key of the quota.', 'type' => 'string', 'example' => 'userMaxNumber'],
'QuotaValue' => ['title' => '', 'description' => 'The value of the quota.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Retrieve a single quota type for an instance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetInstanceQuota',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Quota\\": {\\n \\"QuotaKey\\": \\"userMaxNumber\\",\\n \\"QuotaValue\\": 5\\n }\\n}","type":"json"}]',
],
'GetInstanceTrialStatus' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas92IAAU'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'eiam-111ccc1111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TrialStatus' => ['title' => '', 'description' => 'The trial status of the instance.', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Get the trial status of an instance',
'summary' => 'Retrieves the trial status of an instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetInstanceTrialStatus',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TrialStatus\\": true\\n}","type":"json"}]',
],
'GetLoginRedirectApplicationForBrand' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCPBRTZ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'BrandId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The brand ID.', 'type' => 'string', 'required' => true, 'example' => 'brand_xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'BrandLoginRedirectApplication' => [
'description' => 'The brand logon redirect application information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'BrandId' => ['title' => '', 'description' => 'The brand ID.', 'type' => 'string', 'example' => 'brand_xxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_xxxx'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Get brand logon redirect application',
'summary' => 'Sets the post-logon redirect application for a brand.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetLoginRedirectApplicationForBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"BrandLoginRedirectApplication\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"BrandId\\": \\"brand_xxxx\\",\\n \\"ApplicationId\\": \\"app_xxxx\\"\\n }\\n}","type":"json"}]',
],
'GetNetworkAccessEndpoint' => [
'summary' => 'Queries the information about a specified network access endpoint.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGNRASW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NetworkAccessEndpointId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The dedicated network access endpoint ID.', 'type' => 'string', 'required' => true, 'example' => 'nae-examplexxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'NetworkAccessEndpoint' => [
'description' => 'The network access endpoint information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'NetworkAccessEndpointId' => ['title' => '', 'description' => 'The dedicated network access endpoint ID.', 'type' => 'string', 'example' => 'nae_examplexxx'],
'NetworkAccessEndpointName' => ['title' => '', 'description' => 'The name of the dedicated network access endpoint.', 'type' => 'string', 'example' => 'Xx-business VPC access endpoint'],
'VpcId' => ['title' => '', 'description' => 'The ID of the VPC to which the dedicated network access endpoint is connected.', 'type' => 'string', 'example' => 'vpc-examplexxx'],
'VpcRegionId' => ['title' => '', 'description' => 'The region of the VPC to which the dedicated network access endpoint is connected.', 'type' => 'string', 'example' => 'cn-hangzhou'],
'VSwitchIds' => [
'title' => '',
'description' => 'The list of vSwitches to which the dedicated network access endpoint is connected.',
'type' => 'array',
'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-2vc8z0f90z4k6xxxxx'."\n", 'title' => ''],
'example' => 'vsw-examplexxx',
],
'SecurityGroupId' => ['title' => '', 'description' => 'The ID of the security group used by the dedicated network access endpoint.', 'type' => 'string', 'example' => 'sg-examplexxx'],
'Status' => ['title' => '', 'description' => 'The status of the network access endpoint. Valid values:'."\n"
."\n"
.'- pending: pending initialization.'."\n"
.'- creating: being created.'."\n"
.'- running: running.'."\n"
.'- deleting: being deleted.', 'type' => 'string', 'example' => 'running'],
'NetworkAccessEndpointType' => ['title' => '', 'description' => 'The type of the network access endpoint. Valid values:'."\n"
."\n"
.'- shared: shared network access endpoint.'."\n"
.'- private: dedicated network access endpoint.', 'type' => 'string', 'example' => 'private'],
'EgressPublicIpAddresses' => [
'title' => '',
'description' => 'The public egress IP addresses of the shared network access endpoint. This parameter is returned only when NetworkEndpointType is set to shared.',
'type' => 'array',
'items' => ['description' => 'The public egress IP address.', 'type' => 'string', 'example' => '公网出口IP地址,具体以接口实际返回为准。 示例:203.0.XX.XX/27', 'title' => ''],
'example' => '203.0.XX.XX/27',
],
'EgressPrivateIpAddresses' => [
'title' => '',
'description' => 'The private egress IP addresses of the dedicated network access endpoint. This parameter is returned only when NetworkEndpointType is set to private.',
'type' => 'array',
'items' => ['description' => 'The private egress IP address.', 'type' => 'string', 'example' => '192.168.1.1', 'title' => ''],
'example' => '172.168.x.x',
],
'CreateTime' => ['title' => '', 'description' => 'The time when the network access endpoint was created. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the dedicated network access endpoint was last updated. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query a network access endpoint',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNetworkAccessEndpoint'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetNetworkAccessEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"NetworkAccessEndpoint\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"NetworkAccessEndpointId\\": \\"nae_examplexxx\\",\\n \\"NetworkAccessEndpointName\\": \\"Xx-business VPC access endpoint\\",\\n \\"VpcId\\": \\"vpc-examplexxx\\",\\n \\"VpcRegionId\\": \\"cn-hangzhou\\",\\n \\"VSwitchIds\\": [\\n \\"vsw-2vc8z0f90z4k6xxxxx\\\\n\\"\\n ],\\n \\"SecurityGroupId\\": \\"sg-examplexxx\\",\\n \\"Status\\": \\"running\\",\\n \\"NetworkAccessEndpointType\\": \\"private\\",\\n \\"EgressPublicIpAddresses\\": [\\n \\"公网出口IP地址,具体以接口实际返回为准。 示例:203.0.XX.XX/27\\"\\n ],\\n \\"EgressPrivateIpAddresses\\": [\\n \\"192.168.1.1\\"\\n ],\\n \\"CreateTime\\": 1649830226000,\\n \\"UpdateTime\\": 1649830226000\\n }\\n}","type":"json"}]',
],
'GetNetworkZone' => [
'summary' => 'Retrieves a network zone object.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231618',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NetworkZoneId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The network zone ID.', 'type' => 'string', 'required' => true, 'example' => 'network_11111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'NetworkZone' => [
'description' => 'The network zone object.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'NetworkZoneId' => ['title' => '', 'description' => 'The network zone ID.', 'type' => 'string', 'example' => 'network_m6fbr2bcbcadu3bcdpgzcxxxxx'],
'NetworkZoneName' => ['title' => '', 'description' => 'The network zone name.', 'type' => 'string', 'example' => 'test4_name'],
'Description' => ['title' => '', 'description' => 'The network zone description.', 'type' => 'string', 'example' => 'test_description'],
'NetworkZoneType' => [
'title' => '',
'description' => 'The network zone type.',
'enumValueTitles' => ['arn:alibaba:idaas:network:zone:classic' => 'Classic network.', 'arn:alibaba:idaas:network:zone:vpc' => 'Virtual private cloud (VPC).'],
'type' => 'string',
'example' => 'arn:alibaba:idaas:network:zone:classic',
],
'VpcId' => ['title' => '', 'description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-25w8wxxxx'],
'Ipv4Cidrs' => [
'description' => 'The IPv4 CIDR blocks of the network zone.',
'type' => 'array',
'items' => ['description' => 'The IPv4 CIDR block.', 'type' => 'string', 'example' => '106.xxx.34.xx', 'title' => ''],
'title' => '',
'example' => '',
],
'Ipv6Cidrs' => [
'description' => 'The IPv6 CIDR blocks of the network zone.',
'type' => 'array',
'items' => ['description' => 'The IPv6 CIDR block.', 'type' => 'string', 'example' => '2001:xxxx:4801:xx::40', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Retrieve a network zone object',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetNetworkZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/{#NetworkZoneId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"NetworkZone\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"NetworkZoneId\\": \\"network_m6fbr2bcbcadu3bcdpgzcxxxxx\\",\\n \\"NetworkZoneName\\": \\"test4_name\\",\\n \\"Description\\": \\"test_description\\",\\n \\"NetworkZoneType\\": \\"arn:alibaba:idaas:network:zone:classic\\",\\n \\"VpcId\\": \\"vpc-25w8wxxxx\\",\\n \\"Ipv4Cidrs\\": [\\n \\"106.xxx.34.xx\\"\\n ],\\n \\"Ipv6Cidrs\\": [\\n \\"2001:xxxx:4801:xx::40\\"\\n ]\\n }\\n}","type":"json"}]',
],
'GetOrganizationalUnit' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas3S4NKL'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Organizational unit ID.', 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Response result.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'OrganizationalUnit' => [
'description' => 'Organizational unit data object.',
'type' => 'object',
'properties' => [
'OrganizationalUnitId' => ['title' => '', 'description' => 'Organizational unit ID.', 'type' => 'string', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx'],
'OrganizationalUnitName' => ['title' => '', 'description' => 'Organizational unit name.', 'type' => 'string', 'example' => 'test_organizationalUnit_name'],
'ParentId' => ['title' => '', 'description' => 'Parent organizational unit ID.', 'type' => 'string', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx'],
'OrganizationalUnitExternalId' => ['title' => '', 'description' => 'Organizational unit external ID, used for mapping between external data and IDaaS organizational units. The default value is the IDaaS organizational unit ID.'."\n"
."\n"
.'Note: The external ID is unique within the same source type and source ID.', 'type' => 'string', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx'],
'OrganizationalUnitSourceType' => ['title' => '', 'description' => 'Account source type. Valid values:'."\n"
.'- build\\_in: self-built.'."\n"
.'- ding\\_talk: imported from DingTalk.'."\n"
.'- ad: imported from AD.'."\n"
.'- ldap: imported from LDAP.'."\n"
.'- we\\_com: imported from WeCom.', 'type' => 'string', 'example' => 'build_in'],
'OrganizationalUnitSourceId' => ['title' => '', 'description' => 'Organizational unit source ID.'."\n"
."\n"
.'The default value for the self-built type is the instance ID. For other types, the value corresponds to the enterprise ID of the respective source. For example, the DingTalk source corresponds to the corpId of the DingTalk enterprise.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'CreateTime' => ['title' => '', 'description' => 'The time when the organizational unit was created, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the organizational unit was last updated, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'Description' => ['title' => '', 'description' => 'Description of the organizational unit.', 'type' => 'string', 'example' => 'Test organization'],
'InstanceId' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'Leaf' => ['title' => '', 'description' => 'Indicates whether the organizational unit is a leaf node. A value of true indicates that the organizational unit has no child nodes, and a value of false indicates that the organizational unit has child nodes.', 'type' => 'boolean', 'example' => 'false'],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Query an EIAM organizational unit',
'summary' => 'Queries the information of an EIAM organizational unit.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOrganizationalUnit'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"OrganizationalUnit\\": {\\n \\"OrganizationalUnitId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"OrganizationalUnitName\\": \\"test_organizationalUnit_name\\",\\n \\"ParentId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"OrganizationalUnitExternalId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"OrganizationalUnitSourceType\\": \\"build_in\\",\\n \\"OrganizationalUnitSourceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"CreateTime\\": 1652085686179,\\n \\"UpdateTime\\": 1652085686179,\\n \\"Description\\": \\"Test organization\\",\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"Leaf\\": false\\n }\\n}","type":"json"}]',
],
'GetPasswordComplexityConfiguration' => [
'summary' => 'Retrieves the password complexity policy for a specified EIAM instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6KLVYX'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'PasswordComplexityConfiguration' => [
'description' => 'The password complexity policy configuration.',
'type' => 'object',
'properties' => [
'PasswordMinLength' => ['description' => 'The minimum password length.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'PasswordComplexityRules' => [
'title' => '',
'description' => 'The list of password complexity rules.',
'type' => 'array',
'items' => [
'description' => 'The rule check object.',
'type' => 'object',
'properties' => [
'PasswordCheckType' => ['description' => 'The password check type. Valid values:'."\n"
."\n"
.'- inclusion\\_upper\\_case: The password must contain uppercase letters.'."\n"
."\n"
.'- inclusion\\_lower\\_case: The password must contain lowercase letters.'."\n"
."\n"
.'- inclusion\\_special\\_case: The password must contain at least one of the following special characters: \\` @ % + \\ / \' ! # $ ^ ? : , ( ) { } \\[ ] \\~ - \\_ . \\`.'."\n"
."\n"
.'- inclusion\\_number: The password must contain digits.'."\n"
."\n"
.'- exclusion\\_username: The password cannot contain the username.'."\n"
."\n"
.'- exclusion\\_email: The password cannot contain the email address.'."\n"
."\n"
.'- exclusion\\_phone\\_number: The password cannot contain the mobile number.'."\n"
."\n"
.'- exclusion\\_display\\_name: The password cannot contain the display name.', 'type' => 'string', 'example' => 'inclusion_upper_case', 'title' => ''],
],
'title' => '',
'example' => '',
],
'example' => '',
],
'DisabledWeakPasswordLogin' => ['description' => 'Indicates whether logon with a weak password is disabled.', 'type' => 'boolean', 'title' => '', 'example' => 'false'],
'DisabledWeakPasswordLoginStartedAt' => ['description' => 'The time when the weak password logon restriction takes effect.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1773383634936'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"PasswordComplexityConfiguration\\": {\\n \\"PasswordMinLength\\": 3,\\n \\"PasswordComplexityRules\\": [\\n {\\n \\"PasswordCheckType\\": \\"inclusion_upper_case\\"\\n }\\n ],\\n \\"DisabledWeakPasswordLogin\\": false,\\n \\"DisabledWeakPasswordLoginStartedAt\\": 1773383634936\\n }\\n}","type":"json"}]',
'title' => 'GetPasswordComplexityConfiguration',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPasswordComplexityConfiguration'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetPasswordComplexityConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'GetPasswordExpirationConfiguration' => [
'summary' => 'Queries the password expiration policy of a specified EIAM instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasSOLMDG'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'PasswordExpirationConfiguration' => [
'description' => 'The password expiration configuration.',
'type' => 'object',
'properties' => [
'PasswordExpirationStatus' => ['title' => '', 'description' => 'The status of the password expiration configuration. Valid values:'."\n"
."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enabled'],
'PasswordValidMaxDay' => ['title' => '', 'description' => 'The maximum validity period of a password. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'example' => '180'],
'PasswordExpirationAction' => ['title' => '', 'description' => 'The action to take when a password expires. Valid values:'."\n"
."\n"
.'- forbid\\_login: Forbid logon.'."\n"
.'- force\\_update\\_password: Force password change.'."\n"
.'- remind\\_update\\_password: Remind password change.', 'type' => 'string', 'example' => 'forbid_login'],
'PasswordExpirationNotificationStatus' => ['title' => '', 'description' => 'The status of password expiration notification. Valid values:'."\n"
."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enabled'],
'PasswordExpirationNotificationChannels' => [
'title' => '',
'description' => 'The list of password expiration notification channels.',
'type' => 'array',
'items' => ['description' => 'The password expiration notification channel. Valid values:'."\n"
."\n"
.'- login: User logon.'."\n"
.'- email: Email.'."\n"
.'- sms: SMS.', 'type' => 'string', 'example' => 'login', 'title' => ''],
'example' => 'login',
],
'PasswordExpirationNotificationDuration' => ['title' => '', 'description' => 'The advance notice period before password expiration. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
'PasswordForcedUpdateDuration' => ['title' => '', 'description' => 'The grace period for forced password change after expiration. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'EffectiveAuthenticationSourceIds' => [
'description' => 'The list of effective authentication source IDs. Default value: ["ia_all"].'."\n"
."\n"
.'- ia_all: All authentication sources. If this value is specified, no other values can be specified.'."\n"
.'- ia_password: Account password logon.'."\n"
.'- ia_otp_sms: SMS verification code logon.'."\n"
.'- ia_webauthn: WebAuthn authenticator logon.'."\n"
.'- idp_xxx: Authentication method of a specific identity provider.',
'type' => 'array',
'items' => ['description' => 'The authentication source ID.', 'type' => 'string', 'example' => 'ia_all', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query EIAM password expiration policy',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPasswordExpirationConfiguration'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetPasswordExpirationConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"PasswordExpirationConfiguration\\": {\\n \\"PasswordExpirationStatus\\": \\"enabled\\",\\n \\"PasswordValidMaxDay\\": 180,\\n \\"PasswordExpirationAction\\": \\"forbid_login\\",\\n \\"PasswordExpirationNotificationStatus\\": \\"enabled\\",\\n \\"PasswordExpirationNotificationChannels\\": [\\n \\"login\\"\\n ],\\n \\"PasswordExpirationNotificationDuration\\": 7,\\n \\"PasswordForcedUpdateDuration\\": 3,\\n \\"EffectiveAuthenticationSourceIds\\": [\\n \\"ia_all\\"\\n ]\\n }\\n}","type":"json"}]',
],
'GetPasswordHistoryConfiguration' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6L2G67'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'PasswordHistoryConfiguration' => [
'description' => 'The password history check configuration.',
'type' => 'object',
'properties' => [
'PasswordHistoryStatus' => ['title' => '', 'description' => 'The status of the password history configuration. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enabled'],
'PasswordHistoryMaxRetention' => ['title' => '', 'description' => 'The maximum number of recent password records to retain.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query EIAM password history policy',
'summary' => 'Queries the password history policy of a specified EIAM instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPasswordHistoryConfiguration'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetPasswordHistoryConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"PasswordHistoryConfiguration\\": {\\n \\"PasswordHistoryStatus\\": \\"enabled\\",\\n \\"PasswordHistoryMaxRetention\\": 3\\n }\\n}","type":"json"}]',
],
'GetPasswordInitializationConfiguration' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6KLVYX'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'PasswordInitializationConfiguration' => [
'description' => 'The password initialization configuration.',
'type' => 'object',
'properties' => [
'PasswordInitializationStatus' => ['title' => '', 'description' => 'The status of the password initialization configuration. Valid values:'."\n"
."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enabled'],
'PasswordInitializationType' => ['title' => '', 'description' => 'The password initialization method. Valid values:'."\n"
."\n"
.'- random: Random.', 'type' => 'string', 'example' => 'random'],
'PasswordForcedUpdateStatus' => ['title' => '', 'description' => 'The status of forced password update. Valid values:'."\n"
."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enabled'],
'PasswordInitializationNotificationChannels' => [
'title' => '',
'description' => 'The list of password initialization notification channels.',
'type' => 'array',
'items' => ['description' => 'The password initialization notification channel. Valid values:'."\n"
."\n"
.'- email: Email.'."\n"
.'- sms: SMS.', 'type' => 'string', 'example' => 'email', 'title' => ''],
'example' => 'email',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query EIAM password initialization policy',
'summary' => 'Queries the password initialization policy of Employee Identity and Access Management (EIAM).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPasswordInitializationConfiguration'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetPasswordInitializationConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"PasswordInitializationConfiguration\\": {\\n \\"PasswordInitializationStatus\\": \\"enabled\\",\\n \\"PasswordInitializationType\\": \\"random\\",\\n \\"PasswordForcedUpdateStatus\\": \\"enabled\\",\\n \\"PasswordInitializationNotificationChannels\\": [\\n \\"email\\"\\n ]\\n }\\n}","type":"json"}]',
],
'GetResourceServerScope' => [
'summary' => 'Queries the scope permissions under a specified ResourceServer.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ResourceServerScopeId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The scope permission ID.', 'type' => 'string', 'required' => true, 'example' => 'ress_neg35flu6byysxwutaxu3dxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ResourceServerScope' => [
'description' => 'The scope permission information under the ResourceServer.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_xxxxxxxxxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_xxxxxxxxxxx'],
'ResourceServerScopeId' => ['title' => '', 'description' => 'The scope permission ID.', 'type' => 'string', 'example' => 'rss_xxxxxxxxxxx'],
'ResourceServerScopeName' => ['title' => '', 'description' => 'The scope permission name.', 'type' => 'string', 'example' => 'Read User Info'],
'ResourceServerScopeValue' => ['title' => '', 'description' => 'The scope permission value.', 'type' => 'string', 'example' => 'User:Read:ALL'],
'ResourceServerScopeType' => [
'title' => '',
'description' => 'The scope permission type.',
'enumValueTitles' => ['urn:alibaba:idaas:resourceserver:scope:application' => 'machine permission.', 'urn:alibaba:idaas:resourceserver:scope:application_delegated' => 'urn:alibaba:idaas:resourceserver:scope:application_delegated', 'urn:alibaba:idaas:resourceserver:scope:delegated' => 'user permission.', '人员&机器权限' => 'user and machine permission.'],
'type' => 'string',
'example' => 'urn:alibaba:idaas:resourceserver:scope:delegated',
],
'AuthorizationType' => [
'title' => '',
'description' => 'The authorization type.',
'enumValueTitles' => ['authorize_required' => 'manual authorization.', 'default_all' => 'automatic authorization.'],
'type' => 'string',
'example' => 'authorize_required',
'enum' => ['authorize_required', 'default_all'],
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query scope permissions under a specified resourceServer',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetResourceServerScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ResourceServerScope', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/resourceserverscope/{#ResourceServerScopeId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ResourceServerScope\\": {\\n \\"InstanceId\\": \\"idaas_xxxxxxxxxxx\\",\\n \\"ApplicationId\\": \\"app_xxxxxxxxxxx\\",\\n \\"ResourceServerScopeId\\": \\"rss_xxxxxxxxxxx\\",\\n \\"ResourceServerScopeName\\": \\"Read User Info\\",\\n \\"ResourceServerScopeValue\\": \\"User:Read:ALL\\",\\n \\"ResourceServerScopeType\\": \\"urn:alibaba:idaas:resourceserver:scope:delegated\\",\\n \\"AuthorizationType\\": \\"authorize_required\\"\\n }\\n}","type":"json"}]',
],
'GetRootOrganizationalUnit' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasZCZ2SC'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'OrganizationalUnit' => [
'description' => 'The organizational unit data object.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'OrganizationalUnitId' => ['title' => '', 'description' => 'The organizational unit ID.', 'type' => 'string', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx'],
'OrganizationalUnitName' => ['title' => '', 'description' => 'The organizational unit name.', 'type' => 'string', 'example' => 'name001'],
'CreateTime' => ['title' => '', 'description' => 'The time when the organizational unit was created, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the organizational unit was last updated, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'Description' => ['title' => '', 'description' => 'The description of the organizational unit.', 'type' => 'string', 'example' => 'Test organization'],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Query EIAM root organizational unit information',
'summary' => 'Queries the root organizational unit information of EIAM.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRootOrganizationalUnit'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetRootOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"OrganizationalUnit\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"OrganizationalUnitId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"OrganizationalUnitName\\": \\"name001\\",\\n \\"CreateTime\\": 1652085686179,\\n \\"UpdateTime\\": 1652085686179,\\n \\"Description\\": \\"Test organization\\"\\n }\\n}","type":"json"}]',
],
'GetServiceQuota' => [
'summary' => 'Retrieves the service quota.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasXM4LQ1'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'QuotaType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The unique identifier of the quota.', 'type' => 'string', 'required' => true, 'example' => 'instanceTrialTimes。'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ServiceQuota' => [
'description' => 'The service quota.',
'type' => 'object',
'properties' => [
'QuotaType' => ['title' => '', 'description' => 'The unique identifier of the quota.', 'type' => 'string', 'example' => 'instanceTrialNumber'],
'QuotaValue' => ['title' => '', 'description' => 'The value of the quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'UsedQuotaValue' => ['title' => '', 'description' => 'The current usage of the quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Retrieve service quota',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetServiceQuota',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ServiceQuota\\": {\\n \\"QuotaType\\": \\"instanceTrialNumber\\",\\n \\"QuotaValue\\": 5,\\n \\"UsedQuotaValue\\": 1\\n }\\n}","type":"json"}]',
],
'GetSynchronizationJob' => [
'summary' => 'Obtains the information about a single synchronization job.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231892',
'abilityTreeNodes' => ['FEATUREidaasLILYPH'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'SynchronizationJobId',
'in' => 'query',
'schema' => ['description' => 'The ID of the synchronization job.', 'type' => 'string', 'required' => true, 'example' => 'sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx'."\n", 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'SynchronizationJob' => [
'description' => 'The information about the synchronization job.',
'type' => 'object',
'properties' => [
'SynchronizationJobId' => ['description' => 'The ID of the synchronization job.', 'type' => 'string', 'title' => '', 'example' => 'sync_0000347vjovtcf41li0fgsd98gn24q9nj9xxxxx'."\n"],
'TargetType' => ['description' => 'The type of the synchronization destination. Valid values:'."\n"
."\n"
.'- identity\\_provider'."\n"
."\n"
.'- application', 'type' => 'string', 'title' => '', 'example' => 'identity_provider'],
'TargetId' => ['description' => 'The ID of the synchronization destination.', 'type' => 'string', 'title' => '', 'example' => 'idp_my664lwkhpicbyzirog3nxxxxx'."\n"],
'Direction' => ['description' => 'The direction of the synchronization job. Valid values:'."\n"
."\n"
.'- ingress'."\n"
."\n"
.'- egress', 'type' => 'string', 'title' => '', 'example' => 'ingress'],
'StartTime' => ['description' => 'The start time of the synchronization. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1649830226000'],
'EndTime' => ['description' => 'The end time of the synchronization. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1649830226000'],
'TriggerType' => ['description' => 'The trigger type of the synchronization. Valid values:'."\n"
."\n"
.'- auto'."\n"
."\n"
.'- manual', 'type' => 'string', 'title' => '', 'example' => 'auto'],
'Status' => ['description' => 'The status of the synchronization job. Valid values:'."\n"
."\n"
.'- pending'."\n"
."\n"
.'- running'."\n"
."\n"
.'- failed'."\n"
."\n"
.'- partial\\_success'."\n"
."\n"
.'- success', 'type' => 'string', 'title' => '', 'example' => 'running'],
'Result' => [
'title' => '',
'description' => 'The result of the synchronization job.',
'type' => 'object',
'properties' => [
'UserStatistics' => [
'title' => '',
'description' => 'The user synchronization result statistics.',
'type' => 'object',
'properties' => [
'Created' => [
'title' => '',
'description' => 'The creation result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Updated' => [
'title' => '',
'description' => 'The update result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Binded' => [
'title' => '',
'description' => 'The binding result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Deleted' => [
'title' => '',
'description' => 'The deletion result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Same' => [
'title' => '',
'description' => 'The result statistics about identical users.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Pushed' => [
'title' => '',
'description' => 'The notification result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
],
'example' => '',
],
'OrganizationalUnitStatistics' => [
'title' => '',
'description' => 'The organization synchronization result statistics.',
'type' => 'object',
'properties' => [
'Created' => [
'title' => '',
'description' => 'The creation result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Updated' => [
'title' => '',
'description' => 'The update result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Binded' => [
'title' => '',
'description' => 'The binding result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Deleted' => [
'title' => '',
'description' => 'The deletion result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Same' => [
'title' => '',
'description' => 'The result statistics about identical organizations.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Pushed' => [
'title' => '',
'description' => 'The notification result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
],
'example' => '',
],
'GroupStatistics' => [
'title' => '',
'description' => 'The group synchronization result statistics.',
'type' => 'object',
'properties' => [
'Created' => [
'title' => '',
'description' => 'The creation result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Updated' => [
'title' => '',
'description' => 'The update result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Binded' => [
'title' => '',
'description' => 'The binding result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Deleted' => [
'title' => '',
'description' => 'The deletion result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Same' => [
'title' => '',
'description' => 'The result statistics about identical groups.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Pushed' => [
'title' => '',
'description' => 'The notification result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
],
'example' => '',
],
'GroupMemberStatistics' => [
'title' => '',
'description' => 'The group member synchronization result statistics.',
'type' => 'object',
'properties' => [
'Created' => [
'title' => '',
'description' => 'The creation result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Updated' => [
'title' => '',
'description' => 'The update result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Binded' => [
'title' => '',
'description' => 'The binding result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Deleted' => [
'title' => '',
'description' => 'The deletion result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Same' => [
'title' => '',
'description' => 'The result statistics about identical group members.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
'Pushed' => [
'title' => '',
'description' => 'The notification result statistics.',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '30'],
'Success' => ['description' => 'The number of successful items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Failed' => ['description' => 'The number of failed items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
'Skipped' => ['description' => 'The number of skipped items.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'],
],
'example' => '',
],
],
'example' => '',
],
'ErrorMessage' => ['description' => 'The error message returned in the case of an error.', 'type' => 'string', 'example' => 'Internal error', 'title' => ''],
'ErrorCode' => ['description' => 'The error code corresponding to the error message.', 'type' => 'string', 'title' => '', 'example' => 'ErrorCodeNotFound'],
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"SynchronizationJob\\": {\\n \\"SynchronizationJobId\\": \\"sync_0000347vjovtcf41li0fgsd98gn24q9nj9xxxxx\\\\n\\",\\n \\"TargetType\\": \\"identity_provider\\",\\n \\"TargetId\\": \\"idp_my664lwkhpicbyzirog3nxxxxx\\\\n\\",\\n \\"Direction\\": \\"ingress\\",\\n \\"StartTime\\": 1649830226000,\\n \\"EndTime\\": 1649830226000,\\n \\"TriggerType\\": \\"auto\\",\\n \\"Status\\": \\"running\\",\\n \\"Result\\": {\\n \\"UserStatistics\\": {\\n \\"Created\\": {\\n \\"Total\\": 10,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Updated\\": {\\n \\"Total\\": 10,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Binded\\": {\\n \\"Total\\": 10,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Deleted\\": {\\n \\"Total\\": 10,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Same\\": {\\n \\"Total\\": 10,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Pushed\\": {\\n \\"Total\\": 10,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n }\\n },\\n \\"OrganizationalUnitStatistics\\": {\\n \\"Created\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Updated\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Binded\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Deleted\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Same\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Pushed\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n }\\n },\\n \\"GroupStatistics\\": {\\n \\"Created\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Updated\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Binded\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Deleted\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Same\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Pushed\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n }\\n },\\n \\"GroupMemberStatistics\\": {\\n \\"Created\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Updated\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Binded\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Deleted\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Same\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n },\\n \\"Pushed\\": {\\n \\"Total\\": 30,\\n \\"Success\\": 10,\\n \\"Failed\\": 10,\\n \\"Skipped\\": 10\\n }\\n },\\n \\"ErrorMessage\\": \\"Internal error\\",\\n \\"ErrorCode\\": \\"ErrorCodeNotFound\\"\\n }\\n }\\n}","type":"json"}]',
'title' => 'GetSynchronizationJob',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSynchronizationJob'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetSynchronizationJob',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'SynchronizationJob', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/{#SynchronizationJobId}'],
],
],
],
],
],
'GetUser' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasY4QW79'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'User' => [
'description' => 'The account object data.',
'type' => 'object',
'properties' => [
'UserId' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx'],
'Username' => ['title' => '', 'description' => 'The username of the account.', 'type' => 'string', 'example' => 'name001'],
'DisplayName' => ['title' => '', 'description' => 'The display name of the account.', 'type' => 'string', 'example' => 'display_name001'],
'PasswordSet' => ['title' => '', 'description' => 'Indicates whether the password is set.', 'type' => 'boolean', 'example' => 'false'],
'PhoneRegion' => ['title' => '', 'description' => 'The country calling code of the phone number. Example: 86 for the Chinese mainland. The code does not include the 00 or + prefix.', 'type' => 'string', 'example' => '86'],
'PhoneNumber' => ['title' => '', 'description' => 'The phone number of the account.', 'type' => 'string', 'example' => '156xxxxxxx'],
'PhoneNumberVerified' => ['title' => '', 'description' => 'Indicates whether the phone number is verified. A value of true indicates that the phone number has been verified by the user or set as verified by the administrator. A value of false indicates that the phone number is not verified.', 'type' => 'boolean', 'example' => 'true'],
'Email' => ['title' => '', 'description' => 'The email address of the account.', 'type' => 'string', 'example' => 'user@example.com'],
'EmailVerified' => ['title' => '', 'description' => 'Indicates whether the email address is verified. A value of true indicates that the email address has been verified by the user or set as verified by the administrator. A value of false indicates that the email address is not verified.', 'type' => 'boolean', 'example' => 'true'],
'UserExternalId' => ['title' => '', 'description' => 'The external ID of the account. This ID is used to associate external data with the IDaaS account. The default value is the IDaaS account ID.'."\n"
."\n"
.'> Note: The external ID must be unique within the same source type and source ID.', 'type' => 'string', 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx'],
'UserSourceType' => ['title' => '', 'description' => 'The source type of the account. Valid values:'."\n"
."\n"
.'- build_in: self-built.'."\n"
."\n"
.'- ding_talk: imported from DingTalk.'."\n"
.'- ad: imported from AD.'."\n"
.'- ldap: imported from LDAP.'."\n"
.'- we_com: imported from WeCom.', 'type' => 'string', 'example' => 'build_in'],
'UserSourceId' => ['title' => '', 'description' => 'The source ID of the account.'."\n"
."\n"
.'For the self-built type, the default value is the instance ID. For other types, the value corresponds to the enterprise ID of the respective source. For example, the DingTalk source corresponds to the corpId of the DingTalk enterprise.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'Status' => ['title' => '', 'description' => 'The status of the account. Valid values:'."\n"
.'- enabled: enabled.'."\n"
."\n"
.'- disabled: disabled.', 'type' => 'string', 'example' => 'enabled'],
'AccountExpireTime' => ['title' => '', 'description' => 'The expiration time of the account, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'PasswordExpireTime' => ['title' => '', 'description' => 'The expiration time of the password, in UNIX timestamp format. Unit: milliseconds.'."\n"
."\n"
.'- A return value of -1 indicates that the password does not expire.'."\n"
."\n"
.'- No return value indicates that the password does not expire.'."\n"
."\n"
.'- A specific timestamp value indicates the exact password expiration time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'RegisterTime' => ['title' => '', 'description' => 'The registration time of the account, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'LockExpireTime' => ['title' => '', 'description' => 'The lock expiration time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'CreateTime' => ['title' => '', 'description' => 'The creation time of the account, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'UpdateTime' => ['title' => '', 'description' => 'The most recent update time of the account, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'Description' => ['title' => '', 'description' => 'The description of the account.', 'type' => 'string', 'example' => 'Test account'],
'OrganizationalUnits' => [
'title' => '',
'description' => 'The list of organizational units to which the account belongs.',
'type' => 'array',
'items' => [
'description' => 'The organizational unit object information.',
'type' => 'object',
'properties' => [
'OrganizationalUnitId' => ['title' => '', 'description' => 'The organizational unit ID.', 'type' => 'string', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx'],
'OrganizationalUnitName' => ['title' => '', 'description' => 'The organizational unit name.', 'type' => 'string', 'example' => 'test_ou_name'],
'Primary' => ['title' => '', 'description' => 'Indicates whether this is the primary organizational unit.', 'type' => 'boolean', 'example' => 'true'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
'PrimaryOrganizationalUnitId' => ['title' => '', 'description' => 'The ID of the primary organizational unit to which the account belongs.', 'type' => 'string', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx'],
'CustomFields' => [
'title' => '',
'description' => 'The list of custom fields of the account.',
'type' => 'array',
'items' => [
'description' => 'The custom field object.',
'type' => 'object',
'properties' => [
'FieldName' => ['title' => '', 'description' => 'The identifier of the custom field.', 'type' => 'string', 'example' => 'age'],
'FieldValue' => ['title' => '', 'description' => 'The value of the custom field.', 'type' => 'string', 'example' => '10'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
'Groups' => [
'title' => '',
'description' => 'The list of groups to which the account belongs.',
'type' => 'array',
'items' => [
'description' => 'The group object to which the account belongs.',
'type' => 'object',
'properties' => [
'GroupId' => ['title' => '', 'description' => 'The group ID.', 'type' => 'string', 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
'GroupName' => ['title' => '', 'description' => 'The group name.', 'type' => 'string', 'example' => 'group_test_name'],
'Description' => ['title' => '', 'description' => 'The group description.', 'type' => 'string', 'example' => 'this is a test.'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'PreferredLanguage' => ['title' => '', 'description' => 'The preferred language.', 'type' => 'string', 'example' => 'en-US'],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Query EIAM account information',
'summary' => 'Queries the details of an EIAM account.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"User\\": {\\n \\"UserId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"Username\\": \\"name001\\",\\n \\"DisplayName\\": \\"display_name001\\",\\n \\"PasswordSet\\": false,\\n \\"PhoneRegion\\": \\"86\\",\\n \\"PhoneNumber\\": \\"156xxxxxxx\\",\\n \\"PhoneNumberVerified\\": true,\\n \\"Email\\": \\"user@example.com\\",\\n \\"EmailVerified\\": true,\\n \\"UserExternalId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"UserSourceType\\": \\"build_in\\",\\n \\"UserSourceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"Status\\": \\"enabled\\",\\n \\"AccountExpireTime\\": 1652085686179,\\n \\"PasswordExpireTime\\": 1652085686179,\\n \\"RegisterTime\\": 1652085686179,\\n \\"LockExpireTime\\": 1652085686179,\\n \\"CreateTime\\": 1652085686179,\\n \\"UpdateTime\\": 1652085686179,\\n \\"Description\\": \\"Test account\\",\\n \\"OrganizationalUnits\\": [\\n {\\n \\"OrganizationalUnitId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"OrganizationalUnitName\\": \\"test_ou_name\\",\\n \\"Primary\\": true\\n }\\n ],\\n \\"PrimaryOrganizationalUnitId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"CustomFields\\": [\\n {\\n \\"FieldName\\": \\"age\\",\\n \\"FieldValue\\": \\"10\\"\\n }\\n ],\\n \\"Groups\\": [\\n {\\n \\"GroupId\\": \\"group_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"GroupName\\": \\"group_test_name\\",\\n \\"Description\\": \\"this is a test.\\"\\n }\\n ],\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"PreferredLanguage\\": \\"en-US\\"\\n }\\n}","type":"json"}]',
],
'ListActionTrackEventTypes' => [
'summary' => 'View the list of invocation events.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas27GRM6'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'You can use this parameter to specify the query token.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'title' => '', 'required' => false],
],
[
'name' => 'PreviousToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to retrieve the previous page of results.', 'type' => 'string', 'example' => 'PTxxxxxexample', 'title' => '', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'default' => '100', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'NextToken' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'example' => 'NTxxxexample', 'title' => ''],
'PreviousToken' => ['description' => 'The token to retrieve the previous page of results.', 'type' => 'string', 'example' => 'PTxxxexample', 'title' => ''],
'MaxResults' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'EventTypes' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EventType' => ['description' => 'The event type.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:event:user:create', 'title' => ''],
],
'description' => 'The list of event types.',
'title' => '',
'example' => '',
],
'description' => 'The list of event types.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListActionTrackEventTypes',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListActionTrackEventTypes',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"PreviousToken\\": \\"PTxxxexample\\",\\n \\"MaxResults\\": 100,\\n \\"EventTypes\\": [\\n {\\n \\"EventType\\": \\"urn:alibaba:idaas:event:user:create\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListApplicationAccounts' => [
'summary' => 'Queries the application accounts of an application by paging.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas51QHX0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'eiam-111ccc1111', 'maxLength' => 64],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_11111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'ApplicationAccounts' => [
'description' => 'The list of application accounts.',
'type' => 'array',
'items' => [
'description' => 'The list of application accounts.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The IDaaS EIAM instance ID.', 'type' => 'string', 'example' => 'idaas_eznwtkkaucljizh6qqu7ptxxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_m43o4h5adeo5klvbbxgxxxxx'],
'ApplicationAccountId' => ['title' => '', 'description' => 'The application account ID.', 'type' => 'string', 'example' => 'aac_m66smhbq5krept7nza54hxxxx'],
'UserId' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'example' => 'user_tkmboufpnvpbitdpzrlngxzxxxx'],
'ApplicationUsername' => ['title' => '', 'description' => 'The application account name.', 'type' => 'string', 'example' => 'test'],
'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1737510353000'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query application accounts by paging',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationAccounts',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationaccount/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"ApplicationAccounts\\": [\\n {\\n \\"InstanceId\\": \\"idaas_eznwtkkaucljizh6qqu7ptxxxx\\",\\n \\"ApplicationId\\": \\"app_m43o4h5adeo5klvbbxgxxxxx\\",\\n \\"ApplicationAccountId\\": \\"aac_m66smhbq5krept7nza54hxxxx\\",\\n \\"UserId\\": \\"user_tkmboufpnvpbitdpzrlngxzxxxx\\",\\n \\"ApplicationUsername\\": \\"test\\",\\n \\"CreateTime\\": 1737510353000\\n }\\n ]\\n}","type":"json"}]',
],
'ListApplicationAccountsForUser' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas51QHX0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'eiam-111ccc1111', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_11111', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'user_example', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'ApplicationAccounts' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The ID of the IDaaS EIAM instance.', 'type' => 'string', 'title' => '', 'example' => 'idaas_ki6hd7ihir4ybawogqk6xxxxx'],
'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'app_na2r76irswrwfgpkz7xvcj7xxxxx'],
'ApplicationAccountId' => ['description' => 'The application account ID.', 'type' => 'string', 'title' => '', 'example' => 'aac_m6e3ukegwvbcb2fne7j32xxxxxx'],
'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'title' => '', 'example' => 'user_tkmboufpnvpbitdpzrlng6mxxxxx'],
'ApplicationUsername' => ['description' => 'The name of the application account.', 'type' => 'string', 'title' => '', 'example' => 'test'],
'CreateTime' => ['description' => 'The time when the account was created.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1754359439000'],
],
'description' => 'The information about the member accounts.',
'title' => '',
'example' => '',
],
'description' => 'The information about the member accounts.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListApplicationAccountsForUser',
'summary' => 'Queries all accounts that belong to a specified user in an application.',
'description' => 'This operation queries only applications that are directly assigned to an organization. You can use the **ApplicationIds** parameter to filter the applications.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListApplicationAccountsForUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationaccount/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"ApplicationAccounts\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ki6hd7ihir4ybawogqk6xxxxx\\",\\n \\"ApplicationId\\": \\"app_na2r76irswrwfgpkz7xvcj7xxxxx\\",\\n \\"ApplicationAccountId\\": \\"aac_m6e3ukegwvbcb2fne7j32xxxxxx\\",\\n \\"UserId\\": \\"user_tkmboufpnvpbitdpzrlng6mxxxxx\\",\\n \\"ApplicationUsername\\": \\"test\\",\\n \\"CreateTime\\": 1754359439000\\n }\\n ]\\n}","type":"json"}]',
],
'ListApplicationClientSecrets' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasJH3YY9'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'ApplicationClientSecrets' => [
'description' => 'The information about the client secrets.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'idaas_wdziy4vnjt33ehhf7z2o2nxxxx'],
'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'."\n"],
'ClientId' => ['description' => 'The client ID of the application.', 'type' => 'string', 'title' => '', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'SecretId' => ['description' => 'The client secret ID of the application.', 'type' => 'string', 'title' => '', 'example' => 'sci_k52x2ru63rlkflina5utgkxxxx'],
'ClientSecret' => ['description' => 'The client secret of the application. The returned ClientSecret is masked.', 'type' => 'string', 'title' => '', 'example' => 'eyJh*****************************************************************************************************OQ'],
'Status' => [
'description' => 'The status of the client secret. Valid values:'."\n"
."\n"
.'- enabled: The client secret is enabled.'."\n"
."\n"
.'- disabled: The client secret is disabled.',
'enumValueTitles' => ['disabled' => '禁用', 'enabled' => '启用'],
'type' => 'string',
'title' => '',
'example' => 'enabled',
],
'LastUsedTime' => ['description' => 'The last time the client secret was used. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1649830226000'],
'ExpirationTime' => ['description' => 'The expiration time of the client secret. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1749830226000'],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListApplicationClientSecrets',
'summary' => 'Queries all client secrets for an EIAM application. The key data in the response is masked. To obtain an unmasked key, call the ObtainApplicationClientSecret operation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplicationClientSecrets'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationClientSecrets',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"ApplicationClientSecrets\\": [\\n {\\n \\"InstanceId\\": \\"idaas_wdziy4vnjt33ehhf7z2o2nxxxx\\",\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\\\n\\",\\n \\"ClientId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"SecretId\\": \\"sci_k52x2ru63rlkflina5utgkxxxx\\",\\n \\"ClientSecret\\": \\"eyJh*****************************************************************************************************OQ\\",\\n \\"Status\\": \\"enabled\\",\\n \\"LastUsedTime\\": 1649830226000,\\n \\"ExpirationTime\\": 1749830226000\\n }\\n ]\\n}","type":"json"}]',
],
'ListApplicationFederatedCredentials' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token used to retrieve the next page of results.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'PreviousToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token used to retrieve the previous page of results.', 'type' => 'string', 'example' => 'PTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries per page in a paged query. This parameter is used for paging.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_xxxasda1', 'maxLength' => 64],
],
[
'name' => 'ApplicationFederatedCredentialType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The type of the application federated credential provider.', 'type' => 'string', 'example' => 'oidc', 'maxLength' => 64, 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned by this call.', 'type' => 'string', 'example' => 'NTxxxexample'],
'PreviousToken' => ['title' => '', 'description' => 'The pagination token returned by this call.', 'type' => 'string', 'example' => 'PTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The number of entries per page in a paged query. This parameter is used for paging.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'ApplicationFederatedCredentials' => [
'description' => 'The list of application federated credentials.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'ApplicationFederatedCredentialId' => ['title' => '', 'description' => 'The application federated credential ID.', 'type' => 'string', 'example' => 'afc_adsa1sdaxxxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_xxxasda1'],
'FederatedCredentialProviderId' => ['title' => '', 'description' => 'The federated trust source ID.', 'type' => 'string', 'example' => 'fcp_das1asda1xxxx'],
'ApplicationFederatedCredentialType' => ['title' => '', 'description' => 'The type of the application federated credential.', 'type' => 'string', 'example' => 'oidc'],
'ApplicationFederatedCredentialName' => ['title' => '', 'description' => 'The name of the application federated credential.', 'type' => 'string', 'example' => 'test'],
'Status' => ['title' => '', 'description' => 'The status of the application federated credential.', 'type' => 'string', 'example' => 'enabled'],
'Description' => ['title' => '', 'description' => 'The description of the application federated credential.', 'type' => 'string', 'example' => 'test'],
'CreateTime' => ['title' => '', 'description' => 'The time when the application federated credential was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1758785994982'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the application federated credential was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1758785994982'],
'LastUsedTime' => ['title' => '', 'description' => 'The time when the application federated credential was last used.', 'type' => 'integer', 'format' => 'int64', 'example' => '1758785994982'],
'VerificationCondition' => ['description' => 'The verification condition. In freedom mode, this is a manually entered value. In structured mode, this is the final compiled value.', 'type' => 'string', 'title' => '', 'example' => ''],
'VerificationMode' => ['description' => 'The verification mode. Valid values: freedom and structured.', 'type' => 'string', 'title' => '', 'example' => ''],
'OidcVerificationConfig' => [
'description' => 'The OIDC structured configuration. This parameter applies to the structured mode with the OIDC type.',
'type' => 'object',
'properties' => [
'Profile' => ['description' => 'The OIDC scenario profile. Valid values: generic, kubernetes, gcp_vm, and azure_vm.', 'type' => 'string', 'title' => '', 'example' => ''],
'KubernetesConfig' => [
'description' => 'The Kubernetes scenario configuration.',
'type' => 'object',
'properties' => [
'Namespace' => ['description' => 'The Kubernetes namespace.', 'type' => 'string', 'title' => '', 'example' => ''],
'ServiceAccountName' => ['description' => 'The Kubernetes service account name.', 'type' => 'string', 'title' => '', 'example' => ''],
'PodNamePrefix' => ['description' => 'The pod name prefix.', 'type' => 'string', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'GcpVmConfig' => [
'description' => 'The GCP VM scenario configuration.',
'type' => 'object',
'properties' => [
'ServiceAccountId' => ['description' => 'The sub claim that corresponds to the service account.', 'type' => 'string', 'title' => '', 'example' => ''],
'InstanceIds' => [
'description' => 'The list of VM instance IDs. A maximum of 10 IDs are supported.',
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
'ProjectId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'AzureVmConfig' => [
'description' => 'The Azure VM scenario configuration.',
'type' => 'object',
'properties' => [
'ResourceGroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'SubscriptionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'VmNames' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
'PrincipalId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'GenericConfig' => [
'type' => 'object',
'properties' => [
'Subject' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Pkcs7VerificationConfig' => [
'description' => 'The PKCS#7 structured configuration. This parameter applies to the structured mode with the PKCS#7 type.',
'type' => 'object',
'properties' => [
'InstanceIds' => [
'description' => 'The list of allowed instance IDs. A maximum of 10 IDs are supported.',
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List application federated credentials',
'summary' => 'Queries a list of application federated credentials.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationFederatedCredentials',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"PreviousToken\\": \\"PTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"ApplicationFederatedCredentials\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"ApplicationFederatedCredentialId\\": \\"afc_adsa1sdaxxxxx\\",\\n \\"ApplicationId\\": \\"app_xxxasda1\\",\\n \\"FederatedCredentialProviderId\\": \\"fcp_das1asda1xxxx\\",\\n \\"ApplicationFederatedCredentialType\\": \\"oidc\\",\\n \\"ApplicationFederatedCredentialName\\": \\"test\\",\\n \\"Status\\": \\"enabled\\",\\n \\"Description\\": \\"test\\",\\n \\"CreateTime\\": 1758785994982,\\n \\"UpdateTime\\": 1758785994982,\\n \\"LastUsedTime\\": 1758785994982,\\n \\"VerificationCondition\\": \\"\\",\\n \\"VerificationMode\\": \\"\\",\\n \\"OidcVerificationConfig\\": {\\n \\"Profile\\": \\"\\",\\n \\"KubernetesConfig\\": {\\n \\"Namespace\\": \\"\\",\\n \\"ServiceAccountName\\": \\"\\",\\n \\"PodNamePrefix\\": \\"\\"\\n },\\n \\"GcpVmConfig\\": {\\n \\"ServiceAccountId\\": \\"\\",\\n \\"InstanceIds\\": [\\n \\"\\"\\n ],\\n \\"ProjectId\\": \\"\\"\\n },\\n \\"AzureVmConfig\\": {\\n \\"ResourceGroupName\\": \\"\\",\\n \\"SubscriptionId\\": \\"\\",\\n \\"VmNames\\": [\\n \\"\\"\\n ],\\n \\"PrincipalId\\": \\"\\"\\n },\\n \\"GenericConfig\\": {\\n \\"Subject\\": \\"\\"\\n }\\n },\\n \\"Pkcs7VerificationConfig\\": {\\n \\"InstanceIds\\": [\\n \\"\\"\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]',
],
'ListApplicationFederatedCredentialsForProvider' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'PreviousToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The token used to retrieve the previous page.', 'type' => 'string', 'example' => 'PTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The maximum number of entries to return per page in a paged query. This parameter is used for paging.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'FederatedCredentialProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The federated trust source ID.', 'type' => 'string', 'required' => false, 'example' => 'fcp_adasd12dxxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned by this call.', 'type' => 'string', 'example' => 'NTxxxexample'],
'PreviousToken' => ['title' => '', 'description' => 'The pagination token returned by this call.', 'type' => 'string', 'example' => 'PTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The maximum number of entries returned per page in a paged query. This parameter is used for paging.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'ApplicationFederatedCredentials' => [
'description' => 'The list of application federated credentials.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'ApplicationFederatedCredentialId' => ['title' => '', 'description' => 'The application federated credential ID.', 'type' => 'string', 'example' => 'afc_dads12sadxxxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_asda1dsadxxxxx'],
'FederatedCredentialProviderId' => ['title' => '', 'description' => 'The federated trust source ID.', 'type' => 'string', 'example' => 'fcp_adasd12dxxxxx'],
'ApplicationFederatedCredentialType' => ['title' => '', 'description' => 'The application federated credential type.', 'type' => 'string', 'example' => 'oidc'],
'ApplicationFederatedCredentialName' => ['title' => '', 'description' => 'The application federated credential name.', 'type' => 'string', 'example' => 'test'],
'Status' => ['title' => '', 'description' => 'The application federated credential status.', 'type' => 'string', 'example' => 'enabled'],
'Description' => ['title' => '', 'description' => 'The application federated credential description.', 'type' => 'string', 'example' => 'test'],
'CreateTime' => ['title' => '', 'description' => 'The time when the credential was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1758785994982'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the credential was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1758785994982'],
'LastUsedTime' => ['title' => '', 'description' => 'The time when the credential was last used.', 'type' => 'integer', 'format' => 'int64', 'example' => '1758785994982'],
'VerificationCondition' => ['description' => 'The verification condition. In freedom mode, this is a manually entered value. In structured mode, this is the final compiled value.', 'type' => 'string', 'title' => '', 'example' => ''],
'VerificationMode' => ['description' => 'The verification mode. Valid values: freedom and structured.', 'type' => 'string', 'title' => '', 'example' => ''],
'OidcVerificationConfig' => [
'description' => 'The OIDC structured configuration. This applies to structured mode with the OIDC type.',
'type' => 'object',
'properties' => [
'Profile' => ['description' => 'The OIDC scenario profile. Valid values: generic, kubernetes, gcp_vm, and azure_vm.', 'type' => 'string', 'title' => '', 'example' => ''],
'KubernetesConfig' => [
'description' => 'The Kubernetes scenario configuration.',
'type' => 'object',
'properties' => [
'Namespace' => ['description' => 'The Kubernetes namespace.', 'type' => 'string', 'title' => '', 'example' => ''],
'ServiceAccountName' => ['description' => 'The Kubernetes service account name.', 'type' => 'string', 'title' => '', 'example' => ''],
'PodNamePrefix' => ['description' => 'The pod name prefix.', 'type' => 'string', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'GcpVmConfig' => [
'description' => 'The GCP VM scenario configuration.',
'type' => 'object',
'properties' => [
'ServiceAccountId' => ['description' => 'The sub claim that corresponds to the service account.', 'type' => 'string', 'title' => '', 'example' => ''],
'InstanceIds' => [
'description' => 'The list of VM instance IDs. A maximum of 10 IDs are supported.',
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
'ProjectId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'AzureVmConfig' => [
'description' => 'The Azure VM scenario configuration.',
'type' => 'object',
'properties' => [
'ResourceGroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'SubscriptionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'VmNames' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
'PrincipalId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'GenericConfig' => [
'type' => 'object',
'properties' => [
'Subject' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'Pkcs7VerificationConfig' => [
'description' => 'The PKCS#7 structured configuration. This applies to structured mode with the PKCS#7 type.',
'type' => 'object',
'properties' => [
'InstanceIds' => [
'description' => 'The list of allowed instance IDs. A maximum of 10 IDs are supported.',
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query application federated credentials by federated trust source ID',
'summary' => 'Queries the list of application federated credentials by federated trust source ID.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationFederatedCredentialsForProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/*/applicationfederatedcredential/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"PreviousToken\\": \\"PTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"ApplicationFederatedCredentials\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"ApplicationFederatedCredentialId\\": \\"afc_dads12sadxxxxx\\",\\n \\"ApplicationId\\": \\"app_asda1dsadxxxxx\\",\\n \\"FederatedCredentialProviderId\\": \\"fcp_adasd12dxxxxx\\",\\n \\"ApplicationFederatedCredentialType\\": \\"oidc\\",\\n \\"ApplicationFederatedCredentialName\\": \\"test\\",\\n \\"Status\\": \\"enabled\\",\\n \\"Description\\": \\"test\\",\\n \\"CreateTime\\": 1758785994982,\\n \\"UpdateTime\\": 1758785994982,\\n \\"LastUsedTime\\": 1758785994982,\\n \\"VerificationCondition\\": \\"\\",\\n \\"VerificationMode\\": \\"\\",\\n \\"OidcVerificationConfig\\": {\\n \\"Profile\\": \\"\\",\\n \\"KubernetesConfig\\": {\\n \\"Namespace\\": \\"\\",\\n \\"ServiceAccountName\\": \\"\\",\\n \\"PodNamePrefix\\": \\"\\"\\n },\\n \\"GcpVmConfig\\": {\\n \\"ServiceAccountId\\": \\"\\",\\n \\"InstanceIds\\": [\\n \\"\\"\\n ],\\n \\"ProjectId\\": \\"\\"\\n },\\n \\"AzureVmConfig\\": {\\n \\"ResourceGroupName\\": \\"\\",\\n \\"SubscriptionId\\": \\"\\",\\n \\"VmNames\\": [\\n \\"\\"\\n ],\\n \\"PrincipalId\\": \\"\\"\\n },\\n \\"GenericConfig\\": {\\n \\"Subject\\": \\"\\"\\n }\\n },\\n \\"Pkcs7VerificationConfig\\": {\\n \\"InstanceIds\\": [\\n \\"\\"\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]',
],
'ListApplicationRoles' => [
'summary' => 'Retrieves a list of application roles using a cursor.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token used to start the next query. Set this parameter to the value of NextToken that is returned in the last API call. Leave this parameter empty for the first query.', 'type' => 'string', 'example' => 'NTxxxxexample', 'title' => '', 'required' => false],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '500', 'minimum' => '0', 'default' => '20', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => 'The name of the filter condition.',
'enumValueTitles' => ['ApplicationRoleNameStartsWith' => 'Queries application roles by matching the prefix of their names.', 'ApplicationRoleIds' => 'Queries application roles by a list of their IDs.'],
'type' => 'string',
'example' => 'ApplicationRoleNameStartsWith',
'enum' => ['ApplicationRoleNameStartsWith', 'ApplicationRoleIds'],
'title' => '',
'required' => false,
],
'Value' => [
'type' => 'array',
'items' => ['description' => 'The value of the filter condition.', 'type' => 'string', 'example' => 'Admin Role', 'title' => '', 'required' => false],
'maxItems' => 100,
'minItems' => 1,
'title' => '',
'description' => 'The values of the filter condition.',
'required' => false,
'example' => '',
],
],
'description' => 'A filter condition.',
'required' => false,
'title' => '',
'example' => '',
],
'title' => '',
'description' => 'The filter conditions.',
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'NextToken' => ['description' => 'The token used to start the next query.', 'type' => 'string', 'example' => 'NTxxxxexample', 'title' => ''],
'ApplicationRoles' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'."\n"],
'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'ApplicationRoleId' => ['description' => 'The application role ID.', 'type' => 'string', 'title' => '', 'example' => 'approle_01kh2vuo8v9splv8maak1d22rxxxx'],
'ApplicationRoleName' => ['description' => 'The name of the application role.', 'type' => 'string', 'title' => '', 'example' => 'Admin Role'],
'ApplicationRoleValue' => ['description' => 'The value of the application role.', 'type' => 'string', 'example' => 'admin_role', 'title' => ''],
'Description' => ['description' => 'The description of the application role.', 'type' => 'string', 'example' => 'Admin Role Description'."\n", 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => 'The list of application roles.',
'title' => '',
'example' => '',
],
'MaxResults' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListApplicationRoles',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationRoles',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationrole/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxxexample\\",\\n \\"ApplicationRoles\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\\\n\\",\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"ApplicationRoleId\\": \\"approle_01kh2vuo8v9splv8maak1d22rxxxx\\",\\n \\"ApplicationRoleName\\": \\"Admin Role\\",\\n \\"ApplicationRoleValue\\": \\"admin_role\\",\\n \\"Description\\": \\"Admin Role Description\\\\n\\"\\n }\\n ],\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
],
'ListApplicationSupportedProvisionProtocolTypes' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ', 'FEATUREidaasJXI2A5', 'FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'."\n", 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ApplicationSupportedProvisionProtocolType' => [
'description' => 'The list of synchronization types supported by the application.',
'type' => 'object',
'properties' => [
'ProvisionProtocolType' => [
'title' => '',
'description' => 'The account synchronization type supported by the application. Valid values:'."\n"
.'- idaas\\_callback: Event callback type.'."\n"
.'- scim2: System for Cross-domain Identity Management protocol type.',
'type' => 'array',
'items' => ['description' => 'The application synchronization protocol type. Valid values:'."\n"
.'- idaas_callback: IDaaS custom event callback protocol.'."\n"
.'- scim2: System for Cross-domain Identity Management protocol.', 'type' => 'string', 'example' => 'idaas_callback', 'title' => ''],
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List account synchronization types supported by an application',
'summary' => 'Queries the list of account synchronization types supported by an application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationSupportedProvisionProtocolTypes',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationSupportedProvisionProtocolType\\": {\\n \\"ProvisionProtocolType\\": [\\n \\"idaas_callback\\"\\n ]\\n }\\n}","type":"json"}]',
],
'ListApplicationTokens' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasSQHOGI'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationTokenType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application token type.', 'type' => 'string', 'required' => true, 'example' => 'bearer_token', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ApplicationTokens' => [
'description' => 'The application tokens.',
'type' => 'array',
'items' => [
'description' => 'The application tokens.',
'type' => 'object',
'properties' => [
'AliUid' => ['title' => '', 'description' => 'aliUid。', 'type' => 'integer', 'format' => 'int64', 'example' => '1973166921975xxxx'],
'InstanceId' => ['title' => '', 'description' => 'The IDaaS EIAM instance ID.', 'type' => 'string', 'example' => 'idaas_ki6hd7ihir4ybawogqk6kqxxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_m7ar5tms4dwtggavalk3j3mxxxx'],
'ApplicationTokenId' => ['title' => '', 'description' => 'The application token ID.', 'type' => 'string', 'example' => 'token_ndfxxigahelfne2y2hodehrxxxx'],
'ApplicationTokenType' => ['title' => '', 'description' => 'The application token type.', 'type' => 'string', 'example' => 'bearer_token'],
'ApplicationToken' => ['title' => '', 'description' => 'The application tokens.', 'type' => 'string', 'example' => 'SATFwqX8zxGf83pJcJw78KFGjmrft4erWeZYBGS8oE7NN6qoE217yaJpUdMb1UuuGqhDiF43sCA4CF91CTL5iGntqwyLuaAcS9FJ9HfGadE5a7TjiwVafwrBYktxxxx'],
'Status' => ['title' => '', 'description' => 'The enabling status.', 'type' => 'string', 'example' => 'enabled'],
'Description' => ['title' => '', 'description' => 'The application token description.', 'type' => 'string', 'example' => 'jwqtts-0430'],
'ExpirationTime' => ['title' => '', 'description' => 'The expiration time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1747796654000'],
'LastUsedTime' => ['title' => '', 'description' => 'The last used time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1747796654000'],
'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1747796654000', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Retrieve application token list',
'summary' => 'Retrieves the list of application tokens.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationTokens',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationTokens\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"InstanceId\\": \\"idaas_ki6hd7ihir4ybawogqk6kqxxxx\\",\\n \\"ApplicationId\\": \\"app_m7ar5tms4dwtggavalk3j3mxxxx\\",\\n \\"ApplicationTokenId\\": \\"token_ndfxxigahelfne2y2hodehrxxxx\\",\\n \\"ApplicationTokenType\\": \\"bearer_token\\",\\n \\"ApplicationToken\\": \\"SATFwqX8zxGf83pJcJw78KFGjmrft4erWeZYBGS8oE7NN6qoE217yaJpUdMb1UuuGqhDiF43sCA4CF91CTL5iGntqwyLuaAcS9FJ9HfGadE5a7TjiwVafwrBYktxxxx\\",\\n \\"Status\\": \\"enabled\\",\\n \\"Description\\": \\"jwqtts-0430\\",\\n \\"ExpirationTime\\": 1747796654000,\\n \\"LastUsedTime\\": 1747796654000,\\n \\"CreateTime\\": 1747796654000\\n }\\n ]\\n}","type":"json"}]',
],
'ListApplications' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasJXI2A5'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'ApplicationIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of application IDs.',
'type' => 'array',
'items' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'title' => ''],
'required' => false,
'example' => 'Ram Account SSO',
],
],
[
'name' => 'ApplicationName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application name. Only left fuzzy match is supported.', 'type' => 'string', 'example' => 'Ram Account SSO', 'maxLength' => 64, 'required' => false],
],
[
'name' => 'AuthorizationType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The application access authorization type. Valid values:'."\n"
.'- authorize\\_required: Explicit authorization is required for access.'."\n"
.'- default\\_all: All members have access permissions by default.',
'enumValueTitles' => ['authorize_required' => 'Explicit authorization is required for access.', 'default_all' => 'All members have access permissions by default.'],
'type' => 'string',
'example' => 'authorize_required',
'maxLength' => 64,
'required' => false,
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The application status. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.',
'enumValueTitles' => ['disabled' => 'Disabled.', 'enabled' => 'Enabled.'],
'type' => 'string',
'example' => 'enabled',
'maxLength' => 32,
'required' => false,
],
],
[
'name' => 'M2MClientStatus',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether the M2M Client identity is enabled.', 'type' => 'string', 'required' => false, 'example' => 'enabled', 'maxLength' => 32],
],
[
'name' => 'ResourceServerStatus',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether the ResourceServer capability is enabled.', 'type' => 'string', 'example' => 'enabled', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'SsoType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The SSO type filter condition. Multiple types can be separated by commas, such as oauth2/m2m,oidc+oauth2/m2m.',
'enumValueTitles' => ['oauth2/m2m' => 'oauth2/m2m', 'saml2' => 'saml2', 'oidc' => 'oidc', 'oidc+oauth2/m2m' => 'oidc+oauth2/m2m'],
'type' => 'string',
'example' => 'oauth2/m2m',
'maxLength' => 32,
'required' => false,
],
],
[
'name' => 'ApplicationCreationType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The application creation type. If this parameter is left empty, applications of the user_custom type are queried by default. To query applications of all types, set this parameter to all.',
'enumValueTitles' => ['system_init' => 'System-created.', 'user_custom' => 'User-created.'],
'type' => 'string',
'example' => 'system_init',
'required' => false,
],
],
[
'name' => 'ApplicationIdentityType',
'in' => 'query',
'schema' => [
'description' => 'The application identity type. If this parameter is left empty, applications of the application type are queried by default. To query applications of all identity types, set this parameter to all.',
'enumValueTitles' => ['all' => 'all', 'agent' => 'Agent.', 'application' => 'Application.'],
'type' => 'string',
'example' => 'application',
'enum' => ['application', 'agent', 'all'],
'required' => false,
'title' => '',
],
],
[
'name' => 'CustomFields',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The list of custom fields.',
'type' => 'array',
'items' => [
'description' => 'The custom field object.',
'type' => 'object',
'properties' => [
'FieldName' => ['description' => 'The custom field identifier. Valid values:'."\n"
.'- agent_type: the agent type.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => 'agent_type', 'title' => ''],
'FieldValue' => ['description' => 'The custom field value.', 'type' => 'string', 'required' => false, 'example' => 'x-claw', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'ServiceManaged',
'in' => 'query',
'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
[
'name' => 'ManagedServiceCode',
'in' => 'query',
'schema' => ['type' => 'string', 'maxLength' => 64, 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Applications' => [
'description' => 'The list of application information.',
'type' => 'array',
'items' => [
'description' => 'The application information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'ClientId' => ['title' => '', 'description' => 'The client ID of the application.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'LogoUrl' => ['title' => '', 'description' => 'The URL of the application logo.', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg'],
'ApplicationName' => ['title' => '', 'description' => 'The application name.', 'type' => 'string', 'example' => 'SAML Application'],
'Description' => ['title' => '', 'description' => 'The application description.', 'type' => 'string', 'example' => 'A test application'],
'SsoType' => ['title' => '', 'description' => 'The single sign-on (SSO) logon protocol. Valid values:'."\n"
.'- saml2: SAML 2.0 protocol.'."\n"
.'- oidc: OpenID Connect protocol.'."\n"
.'- oauth2/m2m: OAuth 2.0 protocol.'."\n"
.'- oidc+oauth2/m2m: OpenID Connect and OAuth 2.0 protocols.', 'type' => 'string', 'example' => 'saml2'],
'ApplicationSourceType' => ['title' => '', 'description' => 'The application creation source. Valid values:'."\n"
.'- urn:alibaba:idaas:app:source:template: Application template.'."\n"
.'- urn:alibaba:idaas:app:source:standard: Standard protocol.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:app:source:standard'],
'Features' => ['title' => '', 'description' => 'The features supported by the application, returned as a JSON array string. Valid values:'."\n"
.'- sso: Single sign-on.'."\n"
.'- slo: Single logout.'."\n"
.'- provision: Account synchronization.'."\n"
.'- api\\_invoke: API access. '."\n"
.'- m2m_client: M2M Client capability.'."\n"
.'- resource_server: API service capability.'."\n"
.'- other: Fallback.', 'type' => 'string', 'example' => '["sso", "provision"]'],
'Status' => ['title' => '', 'description' => 'The application status. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.'."\n"
.'- deleted: Soft deleted.', 'type' => 'string', 'example' => 'enabled'],
'CreateTime' => ['title' => '', 'description' => 'The time when the application was created, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the application was last updated, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
'ServiceManaged' => ['title' => '', 'description' => 'Indicates whether the application template is managed by an Alibaba Cloud service.', 'type' => 'boolean', 'example' => 'true'],
'ManagedServiceCode' => ['title' => '', 'description' => 'The ServiceCode of the Alibaba Cloud service that manages the application template.', 'type' => 'string', 'example' => 'rpa'],
'ApplicationTemplateId' => ['title' => '', 'description' => 'The application template ID.', 'type' => 'string', 'example' => 'apt_xxx_xxx'],
'ApplicationCreationType' => [
'title' => '',
'description' => 'The application creation type.',
'enumValueTitles' => ['system_init' => 'System-created.', 'user_custom' => 'User-created.'],
'type' => 'string',
'example' => 'user_custom',
],
'ResourceServerStatus' => ['title' => '', 'description' => 'The resource server status.', 'type' => 'string', 'example' => 'enabled'],
'ResourceServerIdentifier' => ['title' => '', 'description' => 'The unique identifier of the ResourceServer.', 'type' => 'string', 'example' => 'https://example.com'],
'ResourceServerSourceType' => [
'title' => '',
'description' => 'The resource server source type.',
'enumValueTitles' => ['urn:cloud:idaas:resourceserver:source:custom' => 'Custom.', 'urn:cloud:idaas:resourceserver:source:system' => 'System.'],
'type' => 'string',
'example' => 'urn:cloud:idaas:resourceserver:source:custom',
],
'ApplicationIdentityType' => [
'description' => 'The application identity type.',
'enumValueTitles' => ['agent' => 'Agent.', 'application' => 'Application.'],
'type' => 'string',
'example' => 'application',
'title' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List EIAM applications',
'summary' => 'Performs a paged query to retrieve information about one or more EIAM applications with paging.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplications'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplications',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"Applications\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"ClientId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"LogoUrl\\": \\"https://img.alicdn.com/imgextra/i4/O1CN01lvYwpv1aGowQXDML9_!!6000000003303-0-tps-580-580.jpg\\",\\n \\"ApplicationName\\": \\"SAML Application\\",\\n \\"Description\\": \\"A test application\\",\\n \\"SsoType\\": \\"saml2\\",\\n \\"ApplicationSourceType\\": \\"urn:alibaba:idaas:app:source:standard\\",\\n \\"Features\\": \\"[\\\\\\"sso\\\\\\", \\\\\\"provision\\\\\\"]\\",\\n \\"Status\\": \\"enabled\\",\\n \\"CreateTime\\": 1649830226000,\\n \\"UpdateTime\\": 1649830226000,\\n \\"ServiceManaged\\": true,\\n \\"ManagedServiceCode\\": \\"rpa\\",\\n \\"ApplicationTemplateId\\": \\"apt_xxx_xxx\\",\\n \\"ApplicationCreationType\\": \\"user_custom\\",\\n \\"ResourceServerStatus\\": \\"enabled\\",\\n \\"ResourceServerIdentifier\\": \\"https://example.com\\",\\n \\"ResourceServerSourceType\\": \\"urn:cloud:idaas:resourceserver:source:custom\\",\\n \\"ApplicationIdentityType\\": \\"application\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListApplicationsForAuthorizationRule' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token that indicates the start position of the next page.'."\n"
."\n"
.'- If this parameter is not specified, the query starts from the first page.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The maximum number of entries per page.'."\n"
."\n"
.'- Default value: 20.'."\n"
."\n"
.'- Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The filter conditions.',
'type' => 'array',
'items' => [
'description' => 'The filter conditions.',
'type' => 'object',
'properties' => [
'Name' => ['title' => '', 'description' => 'The name of the filter field. Valid values:'."\n"
."\n"
.'- ApplicationId: the application ID.', 'type' => 'string', 'example' => 'ApplicationId', 'required' => false],
'Value' => [
'title' => '',
'description' => 'The values of the filter field.',
'type' => 'array',
'items' => ['description' => 'The value of the filter field.', 'type' => 'string', 'required' => false, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned in this call. Use this token for the next paged query.', 'type' => 'string', 'example' => 'NTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The number of entries per page in a paging query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'Applications' => [
'description' => 'The list of applications.',
'type' => 'array',
'items' => [
'description' => 'The application information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'ValidityType' => ['title' => '', 'description' => 'The validity type of the association. Valid values:'."\n"
.'- permanent: permanent'."\n"
.'- time_bound: custom time range.', 'type' => 'string', 'example' => 'permanent'],
'ValidityPeriod' => [
'title' => '',
'description' => 'The time range of the validity period. This parameter takes effect only when ValidityType is set to time_bound.',
'type' => 'object',
'properties' => [
'StartTime' => ['title' => '', 'description' => 'The start time of the validity period, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000'],
'EndTime' => ['title' => '', 'description' => 'The end time of the validity period, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000'],
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List applications associated with an authorization rule',
'summary' => 'Lists the applications associated with an authorization rule.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationsForAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/AuthorizationRule/{#AuthorizationRuleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"Applications\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"ValidityType\\": \\"permanent\\",\\n \\"ValidityPeriod\\": {\\n \\"StartTime\\": 1704042061000,\\n \\"EndTime\\": 1704042061000\\n }\\n }\\n ]\\n}","type":"json"}]',
],
'ListApplicationsForGroup' => [
'summary' => 'Query the list of applications accessible to an EIAM group.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas7VNWU7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'ApplicationIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Application ID list. A maximum of 100 application IDs are supported.',
'type' => 'array',
'items' => ['description' => 'Application ID.', 'type' => 'string', 'required' => false, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'title' => ''],
'required' => false,
'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx',
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Group ID.', 'type' => 'string', 'required' => true, 'example' => 'group_miu8e4t4d7i4u7uwezgr54xxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Response result.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'Total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Applications' => [
'description' => 'List of applications authorized for access.',
'type' => 'array',
'items' => [
'description' => 'An application authorized for access.',
'type' => 'object',
'properties' => [
'ApplicationId' => ['title' => '', 'description' => 'Application ID.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'HasDirectAuthorization' => ['title' => '', 'description' => 'Whether direct authorization exists. Valid values:'."\n"
."\n"
.'- true: A direct authorization relationship record exists between the application and the group.'."\n"
.'- false: No direct authorization relationship record exists between the application and the group.'."\n", 'type' => 'boolean', 'example' => 'true'],
'HasInheritAuthorization' => ['title' => '', 'description' => 'Whether inherited authorization exists.', 'type' => 'boolean', 'example' => 'false'],
'ApplicationRoles' => [
'title' => '',
'description' => 'Application role list.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApplicationRoleId' => ['title' => '', 'description' => 'Application role ID.', 'type' => 'string', 'example' => 'app_role_mkv7rgt4ds8d8v0qtzev2mxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Query the list of applications accessible to an EIAM group',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"Applications\\": [\\n {\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"HasDirectAuthorization\\": true,\\n \\"HasInheritAuthorization\\": false,\\n \\"ApplicationRoles\\": [\\n {\\n \\"ApplicationRoleId\\": \\"app_role_mkv7rgt4ds8d8v0qtzev2mxxxx\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'ListApplicationsForNetworkAccessEndpoint' => [
'summary' => 'Retrieves application information under a network access endpoint.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGNRASW'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'NetworkAccessEndpointId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The network access endpoint ID.', 'type' => 'string', 'required' => true, 'example' => 'nae_mxzj4c44ctyectkggtg4mxxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned in this call.', 'type' => 'string', 'example' => 'NTxxxexample'],
'ApplicationsForNetworkAccessEndpoint' => [
'description' => 'The collection of applications under the network access endpoint.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_6ed5syotlwdrgmbzn7qn5xxxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_m5nzr3kk4njkco2nnc4wjxxxxx'],
'ApplicationName' => ['title' => '', 'description' => 'The application name.', 'type' => 'string', 'example' => 'cloudSSO'],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Retrieve application information under a network access endpoint',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListApplicationsForNetworkAccessEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"ApplicationsForNetworkAccessEndpoint\\": [\\n {\\n \\"InstanceId\\": \\"idaas_6ed5syotlwdrgmbzn7qn5xxxxx\\",\\n \\"ApplicationId\\": \\"app_m5nzr3kk4njkco2nnc4wjxxxxx\\",\\n \\"ApplicationName\\": \\"cloudSSO\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListApplicationsForNetworkZone' => [
'summary' => 'Retrieves the list of applications associated with a network domain.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasXRGGQQ'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'PreviousToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token for the previous page.', 'type' => 'string', 'example' => 'PTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'NetworkZoneId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the network zone associated with the application.', 'type' => 'string', 'required' => true, 'example' => 'network_11111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned by this call.', 'type' => 'string', 'example' => 'NTxxxexample'],
'PreviousToken' => ['title' => '', 'description' => 'The pagination token returned by this call.', 'type' => 'string', 'example' => 'PTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'Applications' => [
'description' => 'The list of applications.',
'type' => 'array',
'items' => [
'description' => 'The application information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The IDaaS EIAM instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'ApplicationName' => ['title' => '', 'description' => 'The application name.', 'type' => 'string', 'example' => 'cloudSSO'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Retrieve applications associated with a network domain',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationsForNetworkZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/{#NetworkZoneId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"PreviousToken\\": \\"PTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"Applications\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"ApplicationName\\": \\"cloudSSO\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListApplicationsForOrganizationalUnit' => [
'summary' => 'Queries the list of applications accessible to an EIAM organizational unit by paging. The response includes application IDs. To obtain detailed application information, call the GetApplication operation.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas3S4NKL'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'ApplicationIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of application IDs. A maximum of 100 application IDs are supported in a single operation.',
'type' => 'array',
'items' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'title' => ''],
'required' => false,
'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx',
],
],
[
'name' => 'OrganizationalUnitId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The organizational unit ID.', 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Applications' => [
'description' => 'The list of applications that are authorized for access.',
'type' => 'array',
'items' => [
'description' => 'The application that is authorized for access.',
'type' => 'object',
'properties' => [
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'ApplicationRoles' => [
'title' => '',
'description' => 'The list of application roles.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApplicationRoleId' => ['title' => '', 'description' => 'The application role ID.', 'type' => 'string', 'example' => 'app_role_mkv7rgt4ds8d8v0qtzev2mxxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Query applications accessible to an EIAM organizational unit',
'description' => 'This operation queries only the direct permissions of the organizational unit, that is, applications directly assigned to the organizational unit. When you call this operation, you can use the **ApplicationIds** parameter to filter applications.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplicationsForOrganizationalUnit'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"Applications\\": [\\n {\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"ApplicationRoles\\": [\\n {\\n \\"ApplicationRoleId\\": \\"app_role_mkv7rgt4ds8d8v0qtzev2mxxxx\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'ListApplicationsForUser' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasY4QW79'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'title' => '', 'required' => false],
],
[
'name' => 'ApplicationIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of application IDs. You can specify up to 100 application IDs in a single request.',
'type' => 'array',
'items' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'title' => ''],
'required' => false,
'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => 'The account ID.', 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'QueryMode',
'in' => 'query',
'schema' => ['description' => 'The query mode. Default value: **OnlyDirect**. Valid values:'."\n"
."\n"
.'- OnlyDirect: Queries only the direct permissions of the account. Direct permissions are granted for applications that are directly assigned to the account.'."\n"
."\n"
.'- IncludeInherit: Queries both the direct and inherited permissions of the account. Inherited permissions are granted from the parent organizations or groups to which the account belongs.', 'type' => 'string', 'example' => 'OnlyDirect', 'maxLength' => 32, 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'Applications' => [
'description' => 'The list of applications that the account is authorized to access.',
'type' => 'array',
'items' => [
'description' => 'The application that the account is authorized to access.',
'type' => 'object',
'properties' => [
'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'title' => ''],
'HasDirectAuthorization' => ['description' => 'Indicates whether a direct authorization exists. Valid values:'."\n"
."\n"
.'- true: A direct authorization record exists between the application and the account.'."\n"
."\n"
.'- false: No direct authorization record exists between the application and the account.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'HasInheritAuthorization' => ['description' => 'Indicates whether an inherited authorization exists. Valid values:'."\n"
."\n"
.'- true: A direct authorization record exists between the application and a parent organization or a group to which the account belongs.'."\n"
."\n"
.'- false: No direct authorization record exists between the application and any of the parent organizations or groups to which the account belongs.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'ApplicationRoles' => [
'description' => 'The list of application roles.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApplicationRoleId' => ['description' => 'The ID of the application role.', 'type' => 'string', 'example' => 'app_role_mkv7rgt4ds8d8v0qtzev2mxxxx', 'title' => ''],
'HasDirectAuthorization' => ['description' => 'Indicates whether the role is directly assigned to the user.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'HasInheritAuthorization' => ['description' => 'Indicates whether the role is inherited from an organization or a group to which the user belongs.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'ListApplicationsForUser',
'summary' => 'Queries the applications that an EIAM account can access and returns a paginated list of application IDs. To retrieve detailed information about a specific application, call the GetApplication operation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplicationsForUser'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"Applications\\": [\\n {\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"HasDirectAuthorization\\": true,\\n \\"HasInheritAuthorization\\": false,\\n \\"ApplicationRoles\\": [\\n {\\n \\"ApplicationRoleId\\": \\"app_role_mkv7rgt4ds8d8v0qtzev2mxxxx\\",\\n \\"HasDirectAuthorization\\": true,\\n \\"HasInheritAuthorization\\": false\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'ListAuthorizationResources' => [
'summary' => 'Queries a list of authorization resource information.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The token that identifies the start position of the next page.'."\n"
."\n"
.'- If you do not specify this parameter, the query starts from the first page.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The maximum number of entries per page.'."\n"
."\n"
.'- Default value: 20.'."\n"
."\n"
.'- Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The filter conditions.',
'type' => 'array',
'items' => [
'description' => 'The filter conditions.',
'type' => 'object',
'properties' => [
'Name' => ['title' => '', 'description' => 'The name of the filter field. Valid values:'."\n"
."\n"
.'- AuthorizationResourceEntityType: the resource entity type associated with the authorization resource.'."\n"
."\n"
.'- AuthorizationResourceEntityId: the resource entity ID associated with the authorization resource.', 'type' => 'string', 'example' => 'AuthorizationResourceEntityId', 'required' => false],
'Value' => [
'title' => '',
'description' => 'The values of the filter field.',
'type' => 'array',
'items' => ['description' => 'The value of the filter field.', 'type' => 'string', 'required' => false, 'example' => 'ca_01kmegjc11qa1txxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned in this call. Use this token for the next page query.', 'type' => 'string', 'example' => 'NTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The number of entries per page in the paged query. This is the paging size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'AuthorizationResources' => [
'description' => 'The list of authorization resources.',
'type' => 'array',
'items' => [
'description' => 'The authorization resource data object containing the source data and resource data.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'AuthorizationRuleId' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx'],
'AuthorizationResourceId' => ['title' => '', 'description' => 'The authorization resource ID.', 'type' => 'string', 'example' => 'arres_01kgh3jvt7pk093rv6giu0c0qxxxx'],
'AuthorizationResourceEntityType' => ['title' => '', 'description' => 'The resource entity type associated with the authorization resource. Valid values:'."\n"
.'- cloud_account_role: cloud role.', 'type' => 'string', 'example' => 'cloud_account_role'],
'AuthorizationResourceEntityId' => ['title' => '', 'description' => 'The resource entity ID associated with the authorization resource.', 'type' => 'string', 'example' => 'carole_01kmek49aqxxxx'],
'CloudAccountId' => ['title' => '', 'description' => 'The cloud account ID to which the resource entity associated with the authorization resource belongs.', 'type' => 'string', 'example' => 'ca_01kmegjc11qa1txxxxx'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List authorization resource information',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListAuthorizationResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"AuthorizationResources\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"AuthorizationRuleId\\": \\"arrule_01kf143ug06fg7m9f43u7vahxxxx\\",\\n \\"AuthorizationResourceId\\": \\"arres_01kgh3jvt7pk093rv6giu0c0qxxxx\\",\\n \\"AuthorizationResourceEntityType\\": \\"cloud_account_role\\",\\n \\"AuthorizationResourceEntityId\\": \\"carole_01kmek49aqxxxx\\",\\n \\"CloudAccountId\\": \\"ca_01kmegjc11qa1txxxxx\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListAuthorizationRules' => [
'summary' => 'Lists authorization rules.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that identifies the start of the next page of results.'."\n"
."\n"
.'- If you do not specify this parameter, the system returns the first page of results.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'title' => '', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return on each page.'."\n"
."\n"
.'- If you do not specify this parameter, the default value is 20.'."\n"
."\n"
.'- The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'title' => '', 'required' => false],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The filter conditions.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the field to filter. Valid values:'."\n"
."\n"
.'- AuthorizationRuleId: the ID of the authorization rule.'."\n"
."\n"
.'- AuthorizationRuleNameStartWith: the leftmost characters of the authorization rule name.', 'type' => 'string', 'example' => 'AuthorizationRuleId', 'title' => '', 'required' => false],
'Value' => [
'description' => 'The list of values for the field to filter.',
'type' => 'array',
'items' => ['description' => 'The value of the field to filter.', 'type' => 'string', 'required' => false, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'title' => ''],
'example' => '',
'title' => '',
'required' => false,
],
],
'description' => 'The filter condition.',
'required' => false,
'title' => '',
'example' => '',
],
'example' => '',
'title' => '',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'NextToken' => ['description' => 'The token returned by this call. Use it in the next call to retrieve the next page of results.', 'type' => 'string', 'example' => 'NTxxxexample', 'title' => ''],
'MaxResults' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'AuthorizationRules' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'title' => ''],
'AuthorizationRuleId' => ['description' => 'The ID of the authorization rule.', 'type' => 'string', 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'title' => ''],
'AuthorizationRuleName' => ['description' => 'The name of the authorization rule.', 'type' => 'string', 'example' => 'test-name', 'title' => ''],
'Status' => ['description' => 'The status of the authorization rule. Valid values:'."\n"
."\n"
.'- enabled'."\n"
."\n"
.'- disabled', 'type' => 'string', 'example' => 'enabled', 'title' => ''],
'ProjectId' => ['description' => 'The ID of the project associated with the authorization rule.', 'type' => 'string', 'title' => '', 'example' => 'iprj_system_default'],
'AuthorizationResourceScope' => ['description' => 'The scope of resources to authorize. Valid values:'."\n"
."\n"
.'- global: global resources in the project'."\n"
."\n"
.'- custom: resources in a specific project', 'type' => 'string', 'title' => '', 'example' => 'global'],
'AuthorizationRuleCreationType' => ['description' => 'The type of authorization rule creation. Valid values:'."\n"
."\n"
.'- system\\_init: created by the system'."\n"
."\n"
.'- user\\_custom: created by a user', 'type' => 'string', 'title' => '', 'example' => 'user_custom'],
'AuthorizationRuleSubjectScope' => ['description' => 'The scope of subjects for the authorization rule. Valid values:'."\n"
."\n"
.'- shared: applies to all subjects, such as accounts and applications'."\n"
."\n"
.'- exclusive: applies only to a specific subject', 'type' => 'string', 'title' => '', 'example' => 'shared'],
'AuthorizationRuleSubjectType' => ['description' => 'The type of subject associated with the authorization rule. This parameter takes effect only when AuthorizationRuleSubjectScope is exclusive. Valid values:'."\n"
."\n"
.'- application'."\n"
."\n"
.'- user', 'type' => 'string', 'title' => '', 'example' => 'user'],
'AuthorizationRuleSubjectId' => ['description' => 'The ID of the subject associated with the authorization rule.', 'type' => 'string', 'title' => '', 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx'],
'Description' => ['description' => 'The description of the authorization rule.', 'type' => 'string', 'title' => '', 'example' => 'this is a test'],
'CreateTime' => ['description' => 'The time when the authorization rule was created, in Unix timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1652085686179'],
'UpdateTime' => ['description' => 'The time when the authorization rule was last updated, in Unix timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1652085686179'],
],
'description' => 'The authorization rule object.',
'title' => '',
'example' => '',
],
'description' => 'The list of authorization rules.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListAuthorizationRules',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListAuthorizationRules',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"AuthorizationRules\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"AuthorizationRuleId\\": \\"arrule_01kf143ug06fg7m9f43u7vahxxxx\\",\\n \\"AuthorizationRuleName\\": \\"test-name\\",\\n \\"Status\\": \\"enabled\\",\\n \\"ProjectId\\": \\"iprj_system_default\\",\\n \\"AuthorizationResourceScope\\": \\"global\\",\\n \\"AuthorizationRuleCreationType\\": \\"user_custom\\",\\n \\"AuthorizationRuleSubjectScope\\": \\"shared\\",\\n \\"AuthorizationRuleSubjectType\\": \\"user\\",\\n \\"AuthorizationRuleSubjectId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"Description\\": \\"this is a test\\",\\n \\"CreateTime\\": 1652085686179,\\n \\"UpdateTime\\": 1652085686179\\n }\\n ]\\n}","type":"json"}]',
],
'ListAuthorizationRulesForApplication' => [
'summary' => 'Lists the authorization rules associated with an application.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The token that marks the starting position of the next page.'."\n"
."\n"
.'- If you do not specify this parameter, the query starts from the first page.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The maximum number of entries per page.'."\n"
."\n"
.'- Default value: 20.'."\n"
."\n"
.'- Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned in this call. Use this token to query the next page.', 'type' => 'string', 'example' => 'NTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The number of entries per page for paging.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'AuthorizationRules' => [
'description' => 'The list of authorization rules.',
'type' => 'array',
'items' => [
'description' => 'The authorization rule object.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'AuthorizationRuleId' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx'],
'ValidityType' => ['title' => '', 'description' => 'The validity type of the relationship. Valid values:'."\n"
.'- permanent: permanent'."\n"
.'- time_bound: custom time range.', 'type' => 'string', 'example' => 'permanent'],
'ValidityPeriod' => [
'title' => '',
'description' => 'The time range of the validity period. This parameter takes effect only when ValidityType is set to time_bound.',
'type' => 'object',
'properties' => [
'StartTime' => ['title' => '', 'description' => 'The start time of the validity period, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000'],
'EndTime' => ['title' => '', 'description' => 'The end time of the validity period, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000'],
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List authorization rules associated with an application',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListAuthorizationRulesForApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"AuthorizationRules\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"AuthorizationRuleId\\": \\"arrule_01kf143ug06fg7m9f43u7vahxxxx\\",\\n \\"ValidityType\\": \\"permanent\\",\\n \\"ValidityPeriod\\": {\\n \\"StartTime\\": 1704042061000,\\n \\"EndTime\\": 1704042061000\\n }\\n }\\n ]\\n}","type":"json"}]',
],
'ListAuthorizationRulesForGroup' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The token that identifies the start position of the next page.'."\n"
."\n"
.'- If this parameter is not specified, the query starts from the first page.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The maximum number of entries per page.'."\n"
."\n"
.'- Default value: 20.'."\n"
."\n"
.'- Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The group ID.', 'type' => 'string', 'required' => true, 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned in this call. Use this token to query the next page.', 'type' => 'string', 'example' => 'NTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The number of entries per page in a paged query. This parameter specifies the paging size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'AuthorizationRules' => [
'description' => 'The list of authorization rules.',
'type' => 'array',
'items' => [
'description' => 'The authorization rule object.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'AuthorizationRuleId' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx'],
'ValidityType' => ['title' => '', 'description' => 'The validity type of the relationship. Valid values:'."\n"
.'- permanent: permanent'."\n"
.'- time_bound: custom time range.', 'type' => 'string', 'example' => 'permanent'],
'ValidityPeriod' => [
'title' => '',
'description' => 'The time range of the validity period. This parameter takes effect only when **ValidityType** is set to **time_bound**.',
'type' => 'object',
'properties' => [
'StartTime' => ['title' => '', 'description' => 'The start time of the validity period, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000'],
'EndTime' => ['title' => '', 'description' => 'The end time of the validity period, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000'],
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List authorization rules associated with a group',
'summary' => 'Lists the authorization rules associated with a group.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListAuthorizationRulesForGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"AuthorizationRules\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"AuthorizationRuleId\\": \\"arrule_01kf143ug06fg7m9f43u7vahxxxx\\",\\n \\"ValidityType\\": \\"permanent\\",\\n \\"ValidityPeriod\\": {\\n \\"StartTime\\": 1704042061000,\\n \\"EndTime\\": 1704042061000\\n }\\n }\\n ]\\n}","type":"json"}]',
],
'ListAuthorizationRulesForUser' => [
'summary' => 'Lists the authorization rules associated with an account.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token that indicates the start position of the next page.'."\n"
."\n"
.'- If this parameter is not specified, the query starts from the first page.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The maximum number of entries per page.'."\n"
."\n"
.'- Default value: 20.'."\n"
."\n"
.'- Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned in this call. Use this token to query the next page.', 'type' => 'string', 'example' => 'NTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The maximum number of entries per page in a paged query. This parameter indicates the paging size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'AuthorizationRules' => [
'description' => 'The list of authorization rules.',
'type' => 'array',
'items' => [
'description' => 'The authorization rule object.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'AuthorizationRuleId' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx'],
'ValidityType' => ['title' => '', 'description' => 'The validity type of the relationship. Valid values:'."\n"
.'- permanent: permanent'."\n"
.'- time_bound: custom time range.', 'type' => 'string', 'example' => 'permanent'],
'ValidityPeriod' => [
'title' => '',
'description' => 'The time range of the validity period. This parameter takes effect only when ValidityType is set to time_bound.',
'type' => 'object',
'properties' => [
'StartTime' => ['title' => '', 'description' => 'The start time of the validity period, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000'],
'EndTime' => ['title' => '', 'description' => 'The end time of the validity period, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000'],
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List authorization rules associated with an account',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListAuthorizationRulesForUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"AuthorizationRules\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"AuthorizationRuleId\\": \\"arrule_01kf143ug06fg7m9f43u7vahxxxx\\",\\n \\"ValidityType\\": \\"permanent\\",\\n \\"ValidityPeriod\\": {\\n \\"StartTime\\": 1704042061000,\\n \\"EndTime\\": 1704042061000\\n }\\n }\\n ]\\n}","type":"json"}]',
],
'ListAuthorizationServers' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries per page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of authorization servers.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned in this call.', 'type' => 'string', 'example' => 'NTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The number of entries per page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'AuthorizationServers' => [
'title' => '',
'description' => 'The list of authorization servers.',
'type' => 'array',
'items' => [
'title' => '',
'description' => 'The authorization server information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'AuthorizationServerId' => ['title' => '', 'description' => 'The unique identifier of the authorization server.', 'type' => 'string', 'example' => 'iauths_system'],
'AuthorizationServerName' => ['title' => '', 'description' => 'The name of the authorization server.', 'type' => 'string', 'example' => 'my_authorization_server'],
'Description' => ['title' => '', 'description' => 'The description of the authorization server.', 'type' => 'string', 'example' => 'description of authorization server'],
'Issuer' => ['title' => '', 'description' => 'The currently active issuer address.', 'type' => 'string', 'example' => 'https://xxxx.aliyunidaas.com/api/v2/iauths_system/oauth2/token'],
'IssuerMode' => ['title' => '', 'description' => 'The issuer mode.', 'type' => 'string', 'example' => 'static'],
'IssuerDomain' => ['title' => '', 'description' => 'The domain name used by the issuer.', 'type' => 'string', 'example' => 'xxxx.aliyunidaas.com'],
'CreationType' => ['title' => '', 'description' => 'The creation type.', 'type' => 'string', 'example' => 'user_custom'],
'Status' => ['title' => '', 'description' => 'The status.', 'type' => 'string', 'example' => 'ENABLE'],
'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'UpdateTime' => ['title' => '', 'description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
],
'example' => '',
],
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query authorization servers',
'summary' => 'Retrieves a list of all authorization servers under an instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 10,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"AuthorizationServers\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"AuthorizationServerId\\": \\"iauths_system\\",\\n \\"AuthorizationServerName\\": \\"my_authorization_server\\",\\n \\"Description\\": \\"description of authorization server\\",\\n \\"Issuer\\": \\"https://xxxx.aliyunidaas.com/api/v2/iauths_system/oauth2/token\\",\\n \\"IssuerMode\\": \\"static\\",\\n \\"IssuerDomain\\": \\"xxxx.aliyunidaas.com\\",\\n \\"CreationType\\": \\"user_custom\\",\\n \\"Status\\": \\"ENABLE\\",\\n \\"CreateTime\\": 1652085686179,\\n \\"UpdateTime\\": 1652085686179\\n }\\n ]\\n}","type":"json"}]',
],
'ListBrands' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCPBRTZ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'PreviousToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token for the previous page.', 'type' => 'string', 'example' => 'PTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned by this call.', 'type' => 'string', 'example' => 'NTxxxexample'],
'PreviousToken' => ['title' => '', 'description' => 'The pagination token returned by this call.', 'type' => 'string', 'example' => 'PTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'Brands' => [
'description' => 'The list of brand data.',
'type' => 'array',
'items' => [
'description' => 'The brand data.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'BrandId' => ['title' => '', 'description' => 'The brand ID.', 'type' => 'string', 'example' => 'brand_xxxx'],
'BrandName' => ['title' => '', 'description' => 'The brand name.', 'type' => 'string', 'example' => 'Custom Brand'],
'BrandType' => [
'title' => '',
'description' => 'The brand type.',
'enumValueTitles' => ['system_init' => 'system initialized.', 'user_custom' => 'user-defined.'],
'type' => 'string',
'example' => 'user_custom',
],
'Status' => [
'title' => '',
'description' => 'The brand status.',
'enumValueTitles' => ['disabled' => 'disabled.', 'enabled' => 'enabled.'],
'type' => 'string',
'example' => 'enabled',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query brand list',
'summary' => 'Retrieves a list of brands.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListBrands',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"PreviousToken\\": \\"PTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"Brands\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"BrandId\\": \\"brand_xxxx\\",\\n \\"BrandName\\": \\"Custom Brand\\",\\n \\"BrandType\\": \\"user_custom\\",\\n \\"Status\\": \\"enabled\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListClientPublicKeys' => [
'summary' => 'Lists the client public keys for a specified application using a cursor.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token for the next page of results. Set this to the NextToken value from the previous API call. For the first query, leave this parameter empty.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'title' => '', 'required' => false],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page of a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'NextToken' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'example' => 'NTxxxexample', 'title' => ''],
'ClientPublicKeys' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'ApplicationId' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'ClientPublicKeyId' => ['description' => 'The ID of the client public key.', 'type' => 'string', 'title' => '', 'example' => 'KEYEqDnDJhztiEAwSin7MZoxGcihzCAuxxxx'],
'PublicKey' => ['description' => 'The public key.', 'type' => 'string', 'title' => '', 'example' => '-----BEGIN PUBLIC KEY-----'."\n"
.'MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmnWMdp9FU3vXljeIqpgR'."\n"
.'05E6jEgzIfKsFaLkv+07e2Lg8luTaJh8Q2nkbxdNpTfqBnMMyTgml88WktP45F78'."\n"
.'La7hQtR3vz0Eu1yA92gXwD5Oob7ay4JYQZ0C80o2tB3FsbXG2jUvr31MNkf/0oBY'."\n"
.'qUKK5Hnlk1TdrnZ5VkzgLGHKlj+NJHHF/57DbT64C2qpAWeKHAr9umJ8++0hKqG/'."\n"
.'oRSOpb7oWK4t5c39ulp1j5JJ6cwqrKVCXvsHfWHywOHkcyus+ZNPTQvpwjRnEmRz'."\n"
.'Vy3NWrjT7JlIa8vS1aUU+FxeFd2MLQzxFxquFLwi05su2faRexaeYwWW6IWAI3tX'."\n"
.'twxxxxxx'."\n"
.'-----END PUBLIC KEY-----'],
'AlgorithmType' => [
'description' => 'The algorithm type.',
'enumValueTitles' => ['RSA-2048' => 'RSA-2048'],
'type' => 'string',
'title' => '',
'example' => 'RSA-2048'."\n",
],
'Status' => [
'description' => 'The status.',
'enumValueTitles' => ['disabled' => 'Disabled', 'enabled' => 'Enabled'],
'type' => 'string',
'title' => '',
'example' => 'enabled',
],
'Primary' => [
'description' => 'Indicates whether the key is used with priority.',
'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'],
'type' => 'boolean',
'title' => '',
'example' => 'true',
],
'CreateTime' => ['description' => 'The time when the key was created.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1722006052000'],
'LastUsedTime' => ['description' => 'The time when the key was last used.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1762006052000'],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => 'The list of client public keys for the application.',
'title' => '',
'example' => '',
],
'MaxResults' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListClientPublicKeys',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListClientPublicKeys',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"ClientPublicKeys\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"ClientPublicKeyId\\": \\"KEYEqDnDJhztiEAwSin7MZoxGcihzCAuxxxx\\",\\n \\"PublicKey\\": \\"-----BEGIN PUBLIC KEY-----\\\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmnWMdp9FU3vXljeIqpgR\\\\n05E6jEgzIfKsFaLkv+07e2Lg8luTaJh8Q2nkbxdNpTfqBnMMyTgml88WktP45F78\\\\nLa7hQtR3vz0Eu1yA92gXwD5Oob7ay4JYQZ0C80o2tB3FsbXG2jUvr31MNkf/0oBY\\\\nqUKK5Hnlk1TdrnZ5VkzgLGHKlj+NJHHF/57DbT64C2qpAWeKHAr9umJ8++0hKqG/\\\\noRSOpb7oWK4t5c39ulp1j5JJ6cwqrKVCXvsHfWHywOHkcyus+ZNPTQvpwjRnEmRz\\\\nVy3NWrjT7JlIa8vS1aUU+FxeFd2MLQzxFxquFLwi05su2faRexaeYwWW6IWAI3tX\\\\ntwxxxxxx\\\\n-----END PUBLIC KEY-----\\",\\n \\"AlgorithmType\\": \\"RSA-2048\\\\n\\",\\n \\"Status\\": \\"enabled\\",\\n \\"Primary\\": true,\\n \\"CreateTime\\": 1722006052000,\\n \\"LastUsedTime\\": 1762006052000\\n }\\n ],\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
],
'ListCloudAccountRoles' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'CloudAccountId',
'in' => 'query',
'schema' => ['description' => 'The cloud account ID.', 'type' => 'string', 'required' => true, 'example' => 'ca_01kmegjc11qa1txxxxx', 'title' => ''],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The token that identifies the start position of the next page.'."\n"
."\n"
.'- If this parameter is not specified, the query starts from the first page.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The maximum number of records per page.'."\n"
."\n"
.'- If this parameter is not specified, the default value is 20.'."\n"
."\n"
.'- The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '500', 'minimum' => '1', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The filter conditions.',
'type' => 'array',
'items' => [
'description' => 'The filter conditions.',
'type' => 'object',
'properties' => [
'Name' => [
'description' => 'The name of the filter field. Valid values:'."\n"
.'- CloudAccountRoleId: the cloud role ID.'."\n"
.'- CloudAccountRoleName: the cloud role name.'."\n"
.'- CloudAccountRoleExternalId: the external identifier of the cloud role.'."\n"
.'- CloudAccountRoleUsageType: the usage type of the cloud role.',
'enumValueTitles' => ['CloudAccountRoleId' => 'CloudAccountRoleId', 'CloudAccountRoleName' => 'CloudAccountRoleName', 'CloudAccountRoleUsageType' => 'CloudAccountRoleUsageType', 'CloudAccountRoleExternalId' => 'CloudAccountRoleExternalId'],
'type' => 'string',
'required' => false,
'example' => 'CloudAccountRoleId',
'title' => '',
],
'Value' => [
'description' => 'The values of the filter field.',
'type' => 'array',
'items' => ['description' => 'The value of the filter field.', 'type' => 'string', 'required' => false, 'example' => 'carole_01kmek49aqxxxx', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned in this call.', 'type' => 'string', 'example' => 'NTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The number of rows per page in the paging query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'CloudAccountRoles' => [
'description' => 'The list of cloud roles.',
'type' => 'array',
'items' => [
'description' => 'The details of the cloud role.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'CloudAccountId' => ['title' => '', 'description' => 'The cloud account ID.', 'type' => 'string', 'example' => 'ca_01kmegjc11qa1txxxxx'],
'CloudAccountRoleId' => ['title' => '', 'description' => 'The cloud role ID.', 'type' => 'string', 'example' => 'carole_01kmek49aqxxxx'],
'CloudAccountRoleType' => [
'title' => '',
'description' => 'The cloud role type. The specific format depends on the cloud account type. Valid values:'."\n"
."\n"
.'- role: applicable to Alibaba Cloud accounts.',
'enumValueTitles' => ['role' => 'role'],
'type' => 'string',
'example' => 'role',
],
'CloudAccountRoleUsageType' => [
'title' => '',
'description' => 'The usage type of the cloud role. Valid values:'."\n"
.'- system: system.'."\n"
.'- user: user.',
'enumValueTitles' => ['system' => 'system', 'user' => 'user'],
'type' => 'string',
'example' => 'system',
],
'CloudAccountRoleName' => ['title' => '', 'description' => 'The cloud role name.', 'type' => 'string', 'example' => 'role-test'],
'CloudAccountRoleExternalId' => ['title' => '', 'description' => 'The cloud role identifier.', 'type' => 'string', 'example' => 'acs:ram::xxx:role/role-test'],
'CloudAccountRoleHealth' => [
'title' => '',
'description' => 'The health status of the cloud role. Valid values:'."\n"
.'- healthy: healthy.'."\n"
.'- unhealthy: unhealthy.'."\n"
.'- unknown: unknown.',
'enumValueTitles' => ['healthy' => 'healthy', 'unhealthy' => 'unhealthy', 'unknown' => 'unknown'],
'type' => 'string',
'example' => 'healthy',
],
'Status' => [
'title' => '',
'description' => 'The cloud role status. Valid values:'."\n"
.'- enabled: enabled.'."\n"
.'- disable: disabled.',
'enumValueTitles' => ['disabled' => 'disabled', 'enabled' => 'enabled'],
'type' => 'string',
'example' => 'enabled',
],
'Description' => ['title' => '', 'description' => 'The cloud role description.', 'type' => 'string', 'example' => 'cloud_account_role_description'],
'CreateTime' => ['description' => 'The creation time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1719320115000', 'title' => ''],
'UpdateTime' => ['description' => 'The last update time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1719320117000', 'title' => ''],
'CloudAccountRoleHealthCheckResult' => [
'description' => 'The health check result of the cloud role.',
'type' => 'object',
'properties' => [
'Result' => [
'description' => 'The health check result of the cloud role. Valid values:'."\n"
.'- success: succeeded.'."\n"
.'- failed: failed.',
'enumValueTitles' => ['success' => 'success', 'failed' => 'failed'],
'type' => 'string',
'example' => 'success',
'title' => '',
],
'LastCheckTime' => ['description' => 'The last check time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000', 'title' => ''],
'ErrorReason' => [
'description' => 'The error reason. This field is returned when the health check status is unhealthy.',
'type' => 'object',
'properties' => [
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'AuthenticationFail.NoPermission', 'title' => ''],
'ErrorMessage' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'There is no permission.', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List cloud roles',
'summary' => 'Queries the information about one or more cloud roles by using paging.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListCloudAccountRoles',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}/cloudaccountrole/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"CloudAccountRoles\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"CloudAccountId\\": \\"ca_01kmegjc11qa1txxxxx\\",\\n \\"CloudAccountRoleId\\": \\"carole_01kmek49aqxxxx\\",\\n \\"CloudAccountRoleType\\": \\"role\\",\\n \\"CloudAccountRoleUsageType\\": \\"system\\",\\n \\"CloudAccountRoleName\\": \\"role-test\\",\\n \\"CloudAccountRoleExternalId\\": \\"acs:ram::xxx:role/role-test\\",\\n \\"CloudAccountRoleHealth\\": \\"healthy\\",\\n \\"Status\\": \\"enabled\\",\\n \\"Description\\": \\"cloud_account_role_description\\",\\n \\"CreateTime\\": 1719320115000,\\n \\"UpdateTime\\": 1719320117000,\\n \\"CloudAccountRoleHealthCheckResult\\": {\\n \\"Result\\": \\"success\\",\\n \\"LastCheckTime\\": 1649830226000,\\n \\"ErrorReason\\": {\\n \\"ErrorCode\\": \\"AuthenticationFail.NoPermission\\",\\n \\"ErrorMessage\\": \\"There is no permission.\\"\\n }\\n }\\n }\\n ]\\n}","type":"json"}]',
],
'ListCloudAccounts' => [
'summary' => 'Queries information about one or more cloud accounts by using paging.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The token that marks the starting position of the next page.'."\n"
."\n"
.'- If you do not specify this parameter, the query starts from the first page.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The maximum number of records per page.'."\n"
."\n"
.'- Default value: 20.'."\n"
."\n"
.'- Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '500', 'minimum' => '1', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The filter conditions.',
'type' => 'array',
'items' => [
'description' => 'The filter conditions.',
'type' => 'object',
'properties' => [
'Name' => [
'description' => 'The name of the filter field. Valid values:'."\n"
."\n"
.'- CloudAccountId: the cloud account ID.'."\n"
.'- CloudAccountExternalId: the external unique identifier of the cloud account.'."\n"
.'- CloudAccountVendorType: the cloud account type.',
'enumValueTitles' => ['CloudAccountVendorType' => 'CloudAccountVendorType', 'CloudAccountExternalId' => 'CloudAccountExternalId', 'CloudAccountId' => 'CloudAccountId'],
'type' => 'string',
'required' => false,
'example' => 'CloudAccountId',
'title' => '',
],
'Value' => [
'description' => 'The values of the filter field.',
'type' => 'array',
'items' => ['description' => 'The value of the filter field.', 'type' => 'string', 'required' => false, 'example' => 'ca_01kmegjc11qa1txxxxx', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The token returned for the current call to indicate the starting position of the next page.', 'type' => 'string', 'example' => 'NTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The number of rows per page when paging is used.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'CloudAccounts' => [
'description' => 'The list of cloud accounts.',
'type' => 'array',
'items' => [
'description' => 'The cloud account details.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'CloudAccountId' => ['title' => '', 'description' => 'The cloud account ID.', 'type' => 'string', 'example' => 'ca_01kmegjc11qa1txxxxx'],
'CloudAccountName' => ['title' => '', 'description' => 'The cloud account name.', 'type' => 'string', 'example' => 'cloud_accout_xxxx'],
'CloudAccountVendorType' => ['title' => '', 'description' => 'The cloud account type. Valid values:'."\n"
."\n"
.'- alibaba_cloud: Alibaba Cloud.', 'type' => 'string', 'example' => 'alibaba_cloud'],
'CloudAccountExternalId' => ['title' => '', 'description' => 'The external unique identifier of the cloud account.', 'type' => 'string', 'example' => '1234567'],
'CloudAccountProviderName' => ['title' => '', 'description' => 'The identity provider name.', 'type' => 'string', 'example' => 'idaas-eiam-oidc-provider'],
'CloudAccountHealth' => [
'title' => '',
'description' => 'The health status of the cloud account. Valid values:'."\n"
.'- healthy: Healthy.'."\n"
.'- unhealthy: Unhealthy.'."\n"
.'- unknown: Unknown.',
'enumValueTitles' => ['healthy' => 'healthy', 'unhealthy' => 'unhealthy', 'unknown' => 'unknown'],
'type' => 'string',
'example' => 'healthy',
],
'Description' => ['title' => '', 'description' => 'The description of the cloud account.', 'type' => 'string', 'example' => 'cloud_accout_description'],
'CreateTime' => ['description' => 'The time when the cloud account was created. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830225000', 'title' => ''],
'UpdateTime' => ['description' => 'The time when the cloud account was last updated. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830227000', 'title' => ''],
'CloudAccountHealthCheckResult' => [
'description' => 'The health check result of the cloud account.',
'type' => 'object',
'properties' => [
'LastCheckTime' => ['description' => 'The time of the last health check. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000', 'title' => ''],
'Result' => [
'description' => 'The health check result of the cloud account. Valid values:'."\n"
.'- success: The health check succeeded.'."\n"
.'- failed: The health check failed.',
'enumValueTitles' => ['success' => 'success', 'failed' => 'failed'],
'type' => 'string',
'example' => 'success',
'title' => '',
],
'ErrorReason' => [
'description' => 'The error reason. This field is returned when the health check status is unhealthy.',
'type' => 'object',
'properties' => [
'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'AuthenticationFail.NoPermission', 'title' => ''],
'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'There is no permission.', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'CloudAccountSite' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List cloud accounts',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListCloudAccounts',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"CloudAccounts\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"CloudAccountId\\": \\"ca_01kmegjc11qa1txxxxx\\",\\n \\"CloudAccountName\\": \\"cloud_accout_xxxx\\",\\n \\"CloudAccountVendorType\\": \\"alibaba_cloud\\",\\n \\"CloudAccountExternalId\\": \\"1234567\\",\\n \\"CloudAccountProviderName\\": \\"idaas-eiam-oidc-provider\\",\\n \\"CloudAccountHealth\\": \\"healthy\\",\\n \\"Description\\": \\"cloud_accout_description\\",\\n \\"CreateTime\\": 1649830225000,\\n \\"UpdateTime\\": 1649830227000,\\n \\"CloudAccountHealthCheckResult\\": {\\n \\"LastCheckTime\\": 1649830226000,\\n \\"Result\\": \\"success\\",\\n \\"ErrorReason\\": {\\n \\"ErrorCode\\": \\"AuthenticationFail.NoPermission\\",\\n \\"ErrorMessage\\": \\"There is no permission.\\"\\n }\\n },\\n \\"CloudAccountSite\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListConditionalAccessPolicies' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231630',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Next page query token.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Number of rows per page in paginated queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'PreviousToken',
'in' => 'query',
'schema' => ['description' => 'Previous page query token.', 'type' => 'string', 'required' => false, 'example' => 'PTxxxxxexample', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'Total number of items in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The query token value returned by this call.', 'type' => 'string', 'example' => 'NTxxxexample'],
'ConditionalAccessPolicies' => [
'description' => 'Collection of conditional access policies.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'example' => 'idaas_ksvv5c7f2l6uzh6oqspeks23ni'],
'ConditionalAccessPolicyId' => ['title' => '', 'description' => 'Conditional access policy ID.', 'type' => 'string', 'example' => 'cp_xxxxx'],
'ConditionalAccessPolicyName' => ['title' => '', 'description' => 'Conditional access policy name.', 'type' => 'string', 'example' => 'My policy'],
'Description' => ['title' => '', 'description' => 'Conditional access policy description.', 'type' => 'string', 'example' => 'My policy description'],
'ConditionalAccessPolicyType' => ['title' => '', 'description' => 'Conditional access policy type.', 'type' => 'string', 'example' => 'arn:alibaba:idaas:authn:access:policy:system'],
'Status' => ['title' => '', 'description' => 'Conditional access policy enabled/disabled status.', 'type' => 'string', 'example' => 'disabled'],
'DecisionType' => ['title' => '', 'description' => 'Conditional access policy execution type.', 'type' => 'string', 'example' => 'enforcement'],
'EvaluateAt' => ['title' => '', 'description' => 'Conditional access policy evaluation point.', 'type' => 'string', 'example' => 'arn:alibaba:idaas:authn:access:rule:eval_at:after_step1'],
'Priority' => ['title' => '', 'description' => 'Priority, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'DecisionConfig' => [
'title' => '',
'description' => 'Conditional access policy execution action.',
'type' => 'object',
'properties' => [
'Effect' => ['title' => '', 'description' => 'Conditional access policy decision action:'."\n"
.'deny: Deny access.'."\n"
.'allow: Allow access.', 'type' => 'string', 'example' => 'deny'],
'MfaType' => ['title' => '', 'description' => 'Conditional access policy MFA type.', 'type' => 'string', 'example' => 'directly_access'],
'MfaAuthenticationIntervalSeconds' => ['title' => '', 'description' => 'Conditional access policy re-authentication interval (seconds), ranging from 300 to 86400.', 'type' => 'integer', 'format' => 'int64', 'example' => '300'],
'MfaAuthenticationMethods' => [
'title' => '',
'description' => 'MFA types allowed by the conditional access policy.',
'type' => 'array',
'items' => ['description' => 'MFA types allowed by the conditional access policy. Valid values:'."\n"
.'- ia_otp_sms: SMS verification code.'."\n"
.'- ia_otp_email: Email verification code.'."\n"
.'- ia_totp: OTP dynamic password.'."\n"
.'- ia_webauthn: WebAuthn.', 'type' => 'string', 'example' => 'ia_otp_email', 'title' => ''],
'example' => '',
],
'ActiveSessionReuseStatus' => ['description' => 'Whether to enable secondary authentication session reuse.', 'type' => 'string', 'example' => 'disabled', 'title' => ''],
],
'example' => '',
],
'ConditionsConfig' => [
'title' => '',
'description' => 'Conditional access policy conditions.',
'type' => 'object',
'properties' => [
'Applications' => [
'title' => '',
'description' => 'Conditional access policy target applications.',
'type' => 'object',
'properties' => [
'IncludeApplications' => [
'title' => '',
'description' => 'Included applications.',
'type' => 'array',
'items' => ['description' => 'Application ID.', 'type' => 'string', 'example' => 'app_xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeApplications' => [
'title' => '',
'description' => 'Excluded applications.',
'type' => 'array',
'items' => ['description' => 'Application ID.', 'type' => 'string', 'example' => 'app_xxxxx', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
'Users' => [
'title' => '',
'description' => 'Conditional access policy target users.',
'type' => 'object',
'properties' => [
'IncludeUsers' => [
'title' => '',
'description' => 'Included users.',
'type' => 'array',
'items' => ['description' => 'User ID.', 'type' => 'string', 'example' => 'user_xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeUsers' => [
'title' => '',
'description' => 'Excluded users.',
'type' => 'array',
'items' => ['description' => 'User ID.', 'type' => 'string', 'example' => 'user_xxxxx', 'title' => ''],
'example' => '',
],
'IncludeGroups' => [
'title' => '',
'description' => 'Included user groups.',
'type' => 'array',
'items' => ['description' => 'User group ID.', 'type' => 'string', 'example' => 'group_xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeGroups' => [
'title' => '',
'description' => 'Excluded user groups.',
'type' => 'array',
'items' => ['description' => 'User group ID.', 'type' => 'string', 'example' => 'group_xxxxx', 'title' => ''],
'example' => '',
],
'IncludeOrganizationalUnits' => [
'title' => '',
'description' => 'Included organizational units.',
'type' => 'array',
'items' => ['description' => 'Organizational unit ID.', 'type' => 'string', 'example' => 'ou_xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeOrganizationalUnits' => [
'title' => '',
'description' => 'Excluded organizational units.',
'type' => 'array',
'items' => ['description' => 'Organizational unit ID.', 'type' => 'string', 'example' => 'ou_xxxxx', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
'NetworkZones' => [
'title' => '',
'description' => 'Conditional access policy network zones.',
'type' => 'object',
'properties' => [
'IncludeNetworkZones' => [
'title' => '',
'description' => 'Included network zones.',
'type' => 'array',
'items' => ['description' => 'Included network zone ID.', 'type' => 'string', 'example' => 'network_xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeNetworkZones' => [
'title' => '',
'description' => 'Excluded network zones.',
'type' => 'array',
'items' => ['description' => 'Excluded network zone ID.', 'type' => 'string', 'example' => 'network_xxxxx', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
],
'example' => '',
],
'CreateTime' => ['title' => '', 'description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741857554000'],
'LastUpdatedTime' => ['title' => '', 'description' => 'Update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741857554000'],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PreviousToken' => ['description' => 'Previous page query token.', 'type' => 'string', 'example' => 'PTxxxxxexample', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'ListConditionalAccessPolicies',
'summary' => 'List conditional access policies.',
'description' => 'Query the list of conditional access policies with pagination.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConditionalAccessPolicies'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListConditionalAccessPolicies',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"ConditionalAccessPolicies\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ksvv5c7f2l6uzh6oqspeks23ni\\",\\n \\"ConditionalAccessPolicyId\\": \\"cp_xxxxx\\",\\n \\"ConditionalAccessPolicyName\\": \\"My policy\\",\\n \\"Description\\": \\"My policy description\\",\\n \\"ConditionalAccessPolicyType\\": \\"arn:alibaba:idaas:authn:access:policy:system\\",\\n \\"Status\\": \\"disabled\\",\\n \\"DecisionType\\": \\"enforcement\\",\\n \\"EvaluateAt\\": \\"arn:alibaba:idaas:authn:access:rule:eval_at:after_step1\\",\\n \\"Priority\\": 1,\\n \\"DecisionConfig\\": {\\n \\"Effect\\": \\"deny\\",\\n \\"MfaType\\": \\"directly_access\\",\\n \\"MfaAuthenticationIntervalSeconds\\": 300,\\n \\"MfaAuthenticationMethods\\": [\\n \\"ia_otp_email\\"\\n ],\\n \\"ActiveSessionReuseStatus\\": \\"disabled\\"\\n },\\n \\"ConditionsConfig\\": {\\n \\"Applications\\": {\\n \\"IncludeApplications\\": [\\n \\"app_xxxxx\\"\\n ],\\n \\"ExcludeApplications\\": [\\n \\"app_xxxxx\\"\\n ]\\n },\\n \\"Users\\": {\\n \\"IncludeUsers\\": [\\n \\"user_xxxxx\\"\\n ],\\n \\"ExcludeUsers\\": [\\n \\"user_xxxxx\\"\\n ],\\n \\"IncludeGroups\\": [\\n \\"group_xxxxx\\"\\n ],\\n \\"ExcludeGroups\\": [\\n \\"group_xxxxx\\"\\n ],\\n \\"IncludeOrganizationalUnits\\": [\\n \\"ou_xxxxx\\"\\n ],\\n \\"ExcludeOrganizationalUnits\\": [\\n \\"ou_xxxxx\\"\\n ]\\n },\\n \\"NetworkZones\\": {\\n \\"IncludeNetworkZones\\": [\\n \\"network_xxxxx\\"\\n ],\\n \\"ExcludeNetworkZones\\": [\\n \\"network_xxxxx\\"\\n ]\\n }\\n },\\n \\"CreateTime\\": 1741857554000,\\n \\"LastUpdatedTime\\": 1741857554000\\n }\\n ],\\n \\"PreviousToken\\": \\"PTxxxxxexample\\"\\n}","type":"json"}]',
],
'ListConditionalAccessPoliciesForApplication' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231637',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Application ID associated with the conditional access policy.', 'type' => 'string', 'required' => true, 'example' => 'app_11111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ConditionalAccessPolicies' => [
'description' => 'Collection of conditional access policies.',
'type' => 'array',
'items' => [
'description' => 'Conditional access policy object.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'example' => 'idaas_oynbcyaaejuik6b37eldzxxxxx'],
'ConditionalAccessPolicyId' => ['title' => '', 'description' => 'Conditional access policy ID.', 'type' => 'string', 'example' => 'cap_m5etun43kejxphsbke6mjxxxxx'],
'ConditionalAccessPolicyName' => ['title' => '', 'description' => 'Conditional access policy name.', 'type' => 'string', 'example' => 'myPolicy'],
'Description' => ['title' => '', 'description' => 'Conditional access policy description.', 'type' => 'string', 'example' => 'policyTest'],
'ConditionalAccessPolicyType' => ['title' => '', 'description' => 'Conditional access policy type.', 'type' => 'string', 'example' => 'arn:alibaba:idaas:authn:access:policy:system'],
'Status' => [
'title' => '',
'description' => 'Enabled or disabled status of the conditional access policy.',
'enumValueTitles' => ['disabled' => 'Disabled', 'enabled' => 'Enabled'],
'type' => 'string',
'example' => 'disabled',
],
'DecisionType' => [
'title' => '',
'description' => 'Conditional access policy decision type.',
'enumValueTitles' => ['enforcement' => 'Enforcement', 'reportOnly' => 'Report only'],
'type' => 'string',
'example' => 'enforcement',
],
'EvaluateAt' => [
'title' => '',
'description' => 'Conditional access policy evaluation point.',
'enumValueTitles' => ['arn:alibaba:idaas:authn:access:rule:eval_at:before_authn' => 'Before authentication', 'arn:alibaba:idaas:authn:access:rule:eval_at:after_authn' => 'After authentication', 'arn:alibaba:idaas:authn:access:rule:eval_at:after_step1' => 'After first-factor authentication'],
'type' => 'string',
'example' => 'arn:alibaba:idaas:authn:access:rule:eval_at:after_step1',
],
'Priority' => ['title' => '', 'description' => 'Priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'DecisionConfig' => [
'title' => '',
'description' => 'Conditional access policy decision configuration.',
'type' => 'object',
'properties' => [
'Effect' => [
'title' => '',
'description' => 'Conditional access policy decision action.',
'enumValueTitles' => ['allow' => 'Allow', 'deny' => 'Deny'],
'type' => 'string',
'example' => 'allow',
],
'MfaType' => [
'title' => '',
'description' => 'Conditional access policy MFA type.',
'enumValueTitles' => ['directly_access' => 'Direct access', 'mfa_required' => 'MFA required'],
'type' => 'string',
'example' => 'directly_access',
],
'MfaAuthenticationIntervalSeconds' => ['title' => '', 'description' => 'Conditional access policy re-authentication interval (seconds).', 'type' => 'integer', 'format' => 'int64', 'example' => '300'],
'MfaAuthenticationMethods' => [
'title' => '',
'description' => 'Collection of MFA authentication methods allowed by the conditional access policy.',
'type' => 'array',
'items' => ['description' => 'MFA authentication method allowed by the conditional access policy.', 'type' => 'string', 'example' => 'ia_webauthn', 'title' => ''],
'example' => '',
],
'ActiveSessionReuseStatus' => ['description' => 'Whether session reuse is enabled.', 'type' => 'string', 'example' => 'disabled', 'title' => ''],
],
'example' => '',
],
'ConditionsConfig' => [
'title' => '',
'description' => 'Conditional access policy conditions.',
'type' => 'object',
'properties' => [
'Applications' => [
'title' => '',
'description' => 'Conditional access policy target applications.',
'type' => 'object',
'properties' => [
'IncludeApplications' => [
'title' => '',
'description' => 'Included applications.',
'type' => 'array',
'items' => ['description' => 'Application ID.', 'type' => 'string', 'example' => 'app_m7op362gcbdpzh6tsyy52xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeApplications' => [
'title' => '',
'description' => 'Excluded applications.',
'type' => 'array',
'items' => ['description' => 'Application ID.', 'type' => 'string', 'example' => 'app_xxxxx62gcbdpzh6tsyy52xxxxx', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
'Users' => [
'title' => '',
'description' => 'Conditional access policy target users.',
'type' => 'object',
'properties' => [
'IncludeUsers' => [
'title' => '',
'description' => 'Included users.',
'type' => 'array',
'items' => ['description' => 'User ID.', 'type' => 'string', 'example' => 'user_7kht3wmffmdvvqizxwsab3xxxx', 'title' => ''],
'example' => '',
],
'ExcludeUsers' => [
'title' => '',
'description' => 'Excluded users.',
'type' => 'array',
'items' => ['description' => 'User ID.', 'type' => 'string', 'example' => 'user_rh2uldi6u56epkazm2wgrxxxxx', 'title' => ''],
'example' => '',
],
'IncludeGroups' => [
'title' => '',
'description' => 'Included groups.',
'type' => 'array',
'items' => ['description' => 'Group ID.', 'type' => 'string', 'example' => 'group_xtlpbw47kxxz6rygjkqupxxxxx', 'title' => ''],
'example' => '',
],
'ExcludeGroups' => [
'title' => '',
'description' => 'Excluded groups.',
'type' => 'array',
'items' => ['description' => 'Group ID.', 'type' => 'string', 'example' => 'group_eki2tt7g4hjbiowfzh5j4xxxxx', 'title' => ''],
'example' => '',
],
'IncludeOrganizationalUnits' => [
'title' => '',
'description' => 'Included organizational units.',
'type' => 'array',
'items' => ['description' => 'Organizational unit ID.', 'type' => 'string', 'example' => 'ou_kp63or7wlpkbfperzo3qg2ssxx', 'title' => ''],
'example' => '',
],
'ExcludeOrganizationalUnits' => [
'title' => '',
'description' => 'Excluded organizational units.',
'type' => 'array',
'items' => ['description' => 'Organizational unit ID.', 'type' => 'string', 'example' => 'ou_kp63or7wlpkbfperzo3qg2xxxx', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
'NetworkZones' => [
'title' => '',
'description' => 'Conditional access policy network zones.',
'type' => 'object',
'properties' => [
'IncludeNetworkZones' => [
'title' => '',
'description' => 'Included network zones.',
'type' => 'array',
'items' => ['description' => 'Network zone ID.', 'type' => 'string', 'example' => 'network_m7qormftq3tyxgi34vzpzxxxxx', 'title' => ''],
'example' => '',
],
'ExcludeNetworkZones' => [
'title' => '',
'description' => 'Excluded network zones.',
'type' => 'array',
'items' => ['description' => 'Network zone ID.', 'type' => 'string', 'example' => 'network_aaaormftq3tyxgi34vzpzxxxxx', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
],
'example' => '',
],
'CreateTime' => ['title' => '', 'description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741857554000'],
'LastUpdatedTime' => ['title' => '', 'description' => 'Last updated time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741857554000'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'List Conditional Access Policies for Application',
'summary' => 'List conditional access policies associated with an application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListConditionalAccessPoliciesForApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ConditionalAccessPolicies\\": [\\n {\\n \\"InstanceId\\": \\"idaas_oynbcyaaejuik6b37eldzxxxxx\\",\\n \\"ConditionalAccessPolicyId\\": \\"cap_m5etun43kejxphsbke6mjxxxxx\\",\\n \\"ConditionalAccessPolicyName\\": \\"myPolicy\\",\\n \\"Description\\": \\"policyTest\\",\\n \\"ConditionalAccessPolicyType\\": \\"arn:alibaba:idaas:authn:access:policy:system\\",\\n \\"Status\\": \\"disabled\\",\\n \\"DecisionType\\": \\"enforcement\\",\\n \\"EvaluateAt\\": \\"arn:alibaba:idaas:authn:access:rule:eval_at:after_step1\\",\\n \\"Priority\\": 100,\\n \\"DecisionConfig\\": {\\n \\"Effect\\": \\"allow\\",\\n \\"MfaType\\": \\"directly_access\\",\\n \\"MfaAuthenticationIntervalSeconds\\": 300,\\n \\"MfaAuthenticationMethods\\": [\\n \\"ia_webauthn\\"\\n ],\\n \\"ActiveSessionReuseStatus\\": \\"disabled\\"\\n },\\n \\"ConditionsConfig\\": {\\n \\"Applications\\": {\\n \\"IncludeApplications\\": [\\n \\"app_m7op362gcbdpzh6tsyy52xxxxx\\"\\n ],\\n \\"ExcludeApplications\\": [\\n \\"app_xxxxx62gcbdpzh6tsyy52xxxxx\\"\\n ]\\n },\\n \\"Users\\": {\\n \\"IncludeUsers\\": [\\n \\"user_7kht3wmffmdvvqizxwsab3xxxx\\"\\n ],\\n \\"ExcludeUsers\\": [\\n \\"user_rh2uldi6u56epkazm2wgrxxxxx\\"\\n ],\\n \\"IncludeGroups\\": [\\n \\"group_xtlpbw47kxxz6rygjkqupxxxxx\\"\\n ],\\n \\"ExcludeGroups\\": [\\n \\"group_eki2tt7g4hjbiowfzh5j4xxxxx\\"\\n ],\\n \\"IncludeOrganizationalUnits\\": [\\n \\"ou_kp63or7wlpkbfperzo3qg2ssxx\\"\\n ],\\n \\"ExcludeOrganizationalUnits\\": [\\n \\"ou_kp63or7wlpkbfperzo3qg2xxxx\\"\\n ]\\n },\\n \\"NetworkZones\\": {\\n \\"IncludeNetworkZones\\": [\\n \\"network_m7qormftq3tyxgi34vzpzxxxxx\\"\\n ],\\n \\"ExcludeNetworkZones\\": [\\n \\"network_aaaormftq3tyxgi34vzpzxxxxx\\"\\n ]\\n }\\n },\\n \\"CreateTime\\": 1741857554000,\\n \\"LastUpdatedTime\\": 1741857554000\\n }\\n ]\\n}","type":"json"}]',
],
'ListConditionalAccessPoliciesForNetworkZone' => [
'summary' => 'Retrieves the list of conditional access policies associated with a network zone.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232557',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NetworkZoneId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The network zone ID associated with the conditional access policy.', 'type' => 'string', 'required' => true, 'example' => 'app_11111', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ConditionalAccessPolicies' => [
'description' => 'The collection of conditional access policies.',
'type' => 'array',
'items' => [
'description' => 'The collection of conditional access policies.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_oynbcyaaejuik6b37eldz4pinu'],
'ConditionalAccessPolicyId' => ['title' => '', 'description' => 'The conditional access policy ID.', 'type' => 'string', 'example' => 'cp_xxxxx'],
'ConditionalAccessPolicyName' => ['title' => '', 'description' => 'The conditional access policy name.', 'type' => 'string', 'example' => 'My policy'],
'Description' => ['title' => '', 'description' => 'The description of the conditional access policy.', 'type' => 'string', 'example' => 'terraform-example'],
'ConditionalAccessPolicyType' => ['title' => '', 'description' => 'The type of the conditional access policy.', 'type' => 'string', 'example' => 'arn:alibaba:idaas:authn:access:policy:system'],
'Status' => ['title' => '', 'description' => 'The enabled or disabled status of the conditional access policy.', 'type' => 'string', 'example' => 'disabled'],
'DecisionType' => ['title' => '', 'description' => 'The decision type of the conditional access policy.', 'type' => 'string', 'example' => 'enforcement'],
'EvaluateAt' => ['title' => '', 'description' => 'The evaluation point of the conditional access policy.', 'type' => 'string', 'example' => 'arn:alibaba:idaas:authn:access:rule:eval_at:after_step1'],
'Priority' => ['title' => '', 'description' => 'The priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'DecisionConfig' => [
'title' => '',
'description' => 'The decision action configuration of the conditional access policy.',
'type' => 'object',
'properties' => [
'Effect' => ['title' => '', 'description' => 'The decision action of the conditional access policy.', 'type' => 'string', 'example' => 'allow'],
'MfaType' => ['title' => '', 'description' => 'The MFA type of the conditional access policy.', 'type' => 'string', 'example' => 'directly_access'],
'MfaAuthenticationIntervalSeconds' => ['title' => '', 'description' => 'The re-authentication interval of the conditional access policy, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '300'],
'MfaAuthenticationMethods' => [
'title' => '',
'description' => 'The MFA methods allowed by the conditional access policy.',
'type' => 'array',
'items' => ['description' => 'The MFA methods allowed by the conditional access policy. Valid values:'."\n"
.'- ia_otp_sms: SMS verification code.'."\n"
.'- ia_otp_email: email verification code.'."\n"
.'- ia_totp: OTP dynamic password.'."\n"
.'- ia_webauthn: WebAuthn.', 'type' => 'string', 'example' => 'ia_totp', 'title' => ''],
'example' => '',
],
'ActiveSessionReuseStatus' => ['description' => 'Indicates whether session reuse is enabled.', 'type' => 'string', 'example' => 'enabled', 'title' => ''],
],
'example' => '',
],
'ConditionsConfig' => [
'title' => '',
'description' => 'The conditions configuration of the conditional access policy.',
'type' => 'object',
'properties' => [
'Applications' => [
'title' => '',
'description' => 'The target applications of the conditional access policy.',
'type' => 'object',
'properties' => [
'IncludeApplications' => [
'title' => '',
'description' => 'The included applications.',
'type' => 'array',
'items' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'app_xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeApplications' => [
'title' => '',
'description' => 'The excluded applications.',
'type' => 'array',
'items' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'app_xxxxx', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
'Users' => [
'title' => '',
'description' => 'The target users of the conditional access policy.',
'type' => 'object',
'properties' => [
'IncludeUsers' => [
'title' => '',
'description' => 'The included users.',
'type' => 'array',
'items' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'user_xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeUsers' => [
'title' => '',
'description' => 'The excluded users.',
'type' => 'array',
'items' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'user_xxxxx', 'title' => ''],
'example' => '',
],
'IncludeGroups' => [
'title' => '',
'description' => 'The included user groups.',
'type' => 'array',
'items' => ['description' => 'The user group ID.', 'type' => 'string', 'example' => 'group_xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeGroups' => [
'title' => '',
'description' => 'The excluded user groups.',
'type' => 'array',
'items' => ['description' => 'The user group ID.', 'type' => 'string', 'example' => 'group_xxxxx', 'title' => ''],
'example' => '',
],
'IncludeOrganizationalUnits' => [
'title' => '',
'description' => 'The included organizational units.',
'type' => 'array',
'items' => ['description' => 'The organizational unit ID.', 'type' => 'string', 'example' => 'ou_xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeOrganizationalUnits' => [
'title' => '',
'description' => 'The excluded organizational units.',
'type' => 'array',
'items' => ['description' => 'The organizational unit ID.', 'type' => 'string', 'example' => 'ou_xxxxx', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
'NetworkZones' => [
'title' => '',
'description' => 'The network zones of the conditional access policy.',
'type' => 'object',
'properties' => [
'IncludeNetworkZones' => [
'title' => '',
'description' => 'The included network zones.',
'type' => 'array',
'items' => ['description' => 'The network zone ID.', 'type' => 'string', 'example' => 'network_xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeNetworkZones' => [
'title' => '',
'description' => 'The excluded network zones.',
'type' => 'array',
'items' => ['description' => 'The network zone ID.', 'type' => 'string', 'example' => 'network_xxxxx', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
],
'example' => '',
],
'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741857554000'],
'LastUpdatedTime' => ['title' => '', 'description' => 'The last updated time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741857554000'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'List conditional access policies associated with a network zone',
'description' => 'Retrieves the list of conditional access policies associated with a network zone.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConditionalAccessPoliciesForNetworkZone'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListConditionalAccessPoliciesForNetworkZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/*'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/{#NetworkZoneId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ConditionalAccessPolicies\\": [\\n {\\n \\"InstanceId\\": \\"idaas_oynbcyaaejuik6b37eldz4pinu\\",\\n \\"ConditionalAccessPolicyId\\": \\"cp_xxxxx\\",\\n \\"ConditionalAccessPolicyName\\": \\"My policy\\",\\n \\"Description\\": \\"terraform-example\\",\\n \\"ConditionalAccessPolicyType\\": \\"arn:alibaba:idaas:authn:access:policy:system\\",\\n \\"Status\\": \\"disabled\\",\\n \\"DecisionType\\": \\"enforcement\\",\\n \\"EvaluateAt\\": \\"arn:alibaba:idaas:authn:access:rule:eval_at:after_step1\\",\\n \\"Priority\\": 10,\\n \\"DecisionConfig\\": {\\n \\"Effect\\": \\"allow\\",\\n \\"MfaType\\": \\"directly_access\\",\\n \\"MfaAuthenticationIntervalSeconds\\": 300,\\n \\"MfaAuthenticationMethods\\": [\\n \\"ia_totp\\"\\n ],\\n \\"ActiveSessionReuseStatus\\": \\"enabled\\"\\n },\\n \\"ConditionsConfig\\": {\\n \\"Applications\\": {\\n \\"IncludeApplications\\": [\\n \\"app_xxxxx\\"\\n ],\\n \\"ExcludeApplications\\": [\\n \\"app_xxxxx\\"\\n ]\\n },\\n \\"Users\\": {\\n \\"IncludeUsers\\": [\\n \\"user_xxxxx\\"\\n ],\\n \\"ExcludeUsers\\": [\\n \\"user_xxxxx\\"\\n ],\\n \\"IncludeGroups\\": [\\n \\"group_xxxxx\\"\\n ],\\n \\"ExcludeGroups\\": [\\n \\"group_xxxxx\\"\\n ],\\n \\"IncludeOrganizationalUnits\\": [\\n \\"ou_xxxxx\\"\\n ],\\n \\"ExcludeOrganizationalUnits\\": [\\n \\"ou_xxxxx\\"\\n ]\\n },\\n \\"NetworkZones\\": {\\n \\"IncludeNetworkZones\\": [\\n \\"network_xxxxx\\"\\n ],\\n \\"ExcludeNetworkZones\\": [\\n \\"network_xxxxx\\"\\n ]\\n }\\n },\\n \\"CreateTime\\": 1741857554000,\\n \\"LastUpdatedTime\\": 1741857554000\\n }\\n ]\\n}","type":"json"}]',
],
'ListConditionalAccessPoliciesForUser' => [
'summary' => 'Retrieves the list of conditional access policies associated with a user.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231631',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The user ID associated with the conditional access policy.', 'type' => 'string', 'required' => true, 'example' => 'user_xxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ConditionalAccessPolicies' => [
'description' => 'The collection of conditional access policies.',
'type' => 'array',
'items' => [
'description' => 'The conditional access policy object.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_oynbcyaaejuik6b37eldz4xxxx'],
'ConditionalAccessPolicyId' => ['title' => '', 'description' => 'The conditional access policy ID.', 'type' => 'string', 'example' => 'cap_m5etun43kejxphsbke6mjxxxxx'],
'ConditionalAccessPolicyName' => ['title' => '', 'description' => 'The conditional access policy name.', 'type' => 'string', 'example' => 'policyName'],
'Description' => ['title' => '', 'description' => 'The description of the conditional access policy.', 'type' => 'string', 'example' => 'testPolicy'],
'ConditionalAccessPolicyType' => ['title' => '', 'description' => 'The type of the conditional access policy.', 'type' => 'string', 'example' => 'arn:alibaba:idaas:authn:access:policy:system'],
'Status' => [
'title' => '',
'description' => 'The enabled or disabled status of the conditional access policy.',
'enumValueTitles' => ['disabled' => 'Disabled.', 'enabled' => 'Enabled.'],
'type' => 'string',
'example' => 'disabled',
],
'DecisionType' => [
'title' => '',
'description' => 'The execution type of the conditional access policy.',
'enumValueTitles' => ['enforcement' => 'Enforcement policy.', 'reportOnly' => 'Report only.'],
'type' => 'string',
'example' => 'enforcement',
],
'EvaluateAt' => [
'title' => '',
'description' => 'The evaluation point of the conditional access policy.',
'enumValueTitles' => ['arn:alibaba:idaas:authn:access:rule:eval_at:before_authn' => 'Before authentication.', 'arn:alibaba:idaas:authn:access:rule:eval_at:after_authn' => 'After authentication.', 'arn:alibaba:idaas:authn:access:rule:eval_at:after_step1' => 'After first-factor authentication.'],
'type' => 'string',
'example' => 'arn:alibaba:idaas:authn:access:rule:eval_at:after_step1',
],
'Priority' => ['title' => '', 'description' => 'The priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'DecisionConfig' => [
'title' => '',
'description' => 'The execution configuration of the conditional access policy.',
'type' => 'object',
'properties' => [
'Effect' => [
'title' => '',
'description' => 'The decision action of the conditional access policy.',
'enumValueTitles' => ['allow' => 'Allow.', 'deny' => 'Deny.'],
'type' => 'string',
'example' => 'allow',
],
'MfaType' => [
'title' => '',
'description' => 'The MFA type of the conditional access policy.',
'enumValueTitles' => ['directly_access' => 'Direct access.', 'mfa_required' => 'MFA required.'],
'type' => 'string',
'example' => 'directly_access',
],
'MfaAuthenticationIntervalSeconds' => ['title' => '', 'description' => 'The re-authentication interval of the conditional access policy, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '300'],
'MfaAuthenticationMethods' => [
'title' => '',
'description' => 'The MFA methods allowed by the conditional access policy.',
'type' => 'array',
'items' => [
'description' => 'The MFA methods allowed by the conditional access policy.',
'enumValueTitles' => ['ia_otp_email' => 'OTP email authentication source. Authenticates through email OTP. Typically used as a second authentication factor, but can also be used for standalone login when configured by an administrator.', 'ia_otp_sms' => 'OTP SMS authentication source. Authenticates through SMS OTP. Typically used as a second authentication factor, but can also be used for standalone login when configured by an administrator.', 'ia_webauthn' => 'WebAuthn authentication source. Authenticates using FIDO2 WebAuthn.', 'ia_totp' => 'TOTP authentication source. Authenticates using TOTP. Typically used as a second authentication factor.'],
'type' => 'string',
'example' => 'ia_webauthn',
'title' => '',
],
'example' => '',
],
'ActiveSessionReuseStatus' => [
'description' => 'Indicates whether session reuse is enabled.',
'enumValueTitles' => ['disabled' => 'Disabled.', 'enabled' => 'Enabled.'],
'type' => 'string',
'example' => 'disabled',
'title' => '',
],
],
'example' => '',
],
'ConditionsConfig' => [
'title' => '',
'description' => 'The conditional access policy conditions.',
'type' => 'object',
'properties' => [
'Applications' => [
'title' => '',
'description' => 'The target applications of the conditional access policy.',
'type' => 'object',
'properties' => [
'IncludeApplications' => [
'title' => '',
'description' => 'The included applications.',
'type' => 'array',
'items' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'app_mrxpwnipe6vxix72w72gppxxxx', 'title' => ''],
'example' => '',
],
'ExcludeApplications' => [
'title' => '',
'description' => 'The excluded applications.',
'type' => 'array',
'items' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'app_xxxxx', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
'Users' => [
'title' => '',
'description' => 'The target users of the conditional access policy.',
'type' => 'object',
'properties' => [
'IncludeUsers' => [
'title' => '',
'description' => 'The included users.',
'type' => 'array',
'items' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'user_7kht3wmffmdvvqizxwsab3xxxx', 'title' => ''],
'example' => '',
],
'ExcludeUsers' => [
'title' => '',
'description' => 'The excluded users.',
'type' => 'array',
'items' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'user_rh2uldi6u56epkazm2wgrxxxxx', 'title' => ''],
'example' => '',
],
'IncludeGroups' => [
'title' => '',
'description' => 'The included user groups.',
'type' => 'array',
'items' => ['description' => 'The user group ID.', 'type' => 'string', 'example' => 'group_xtlpbw47kxxz6rygjkqupxxxxx', 'title' => ''],
'example' => '',
],
'ExcludeGroups' => [
'title' => '',
'description' => 'The excluded user groups.',
'type' => 'array',
'items' => ['description' => 'The user group ID.', 'type' => 'string', 'example' => 'group_eki2tt7g4hjbiowfzh5j4xxxxx', 'title' => ''],
'example' => '',
],
'IncludeOrganizationalUnits' => [
'title' => '',
'description' => 'The included organizational units.',
'type' => 'array',
'items' => ['description' => 'The organizational unit ID.', 'type' => 'string', 'example' => 'ou_kp63or7wlpkbfperzo3qg2xxxx', 'title' => ''],
'example' => '',
],
'ExcludeOrganizationalUnits' => [
'title' => '',
'description' => 'The excluded organizational units.',
'type' => 'array',
'items' => ['description' => 'The organizational unit ID.', 'type' => 'string', 'example' => 'ou_kp63or7wlpkbfperzo3qg2aaxx', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
'NetworkZones' => [
'title' => '',
'description' => 'The network zones of the conditional access policy.',
'type' => 'object',
'properties' => [
'IncludeNetworkZones' => [
'title' => '',
'description' => 'The included network zones.',
'type' => 'array',
'items' => ['description' => 'The network zone ID.', 'type' => 'string', 'example' => 'network_m5wbsb2eaxzs4zmykoh22xxxxx', 'title' => ''],
'example' => '',
],
'ExcludeNetworkZones' => [
'title' => '',
'description' => 'The excluded network zones.',
'type' => 'array',
'items' => ['description' => 'The network zone ID.', 'type' => 'string', 'example' => 'network_xxxxx', 'title' => ''],
'example' => '',
],
],
'example' => '',
],
],
'example' => '',
],
'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741857554000'],
'LastUpdatedTime' => ['title' => '', 'description' => 'The last updated time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1741857554000'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'List conditional access policies associated with a user',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListConditionalAccessPoliciesForUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ConditionalAccessPolicies\\": [\\n {\\n \\"InstanceId\\": \\"idaas_oynbcyaaejuik6b37eldz4xxxx\\",\\n \\"ConditionalAccessPolicyId\\": \\"cap_m5etun43kejxphsbke6mjxxxxx\\",\\n \\"ConditionalAccessPolicyName\\": \\"policyName\\",\\n \\"Description\\": \\"testPolicy\\",\\n \\"ConditionalAccessPolicyType\\": \\"arn:alibaba:idaas:authn:access:policy:system\\",\\n \\"Status\\": \\"disabled\\",\\n \\"DecisionType\\": \\"enforcement\\",\\n \\"EvaluateAt\\": \\"arn:alibaba:idaas:authn:access:rule:eval_at:after_step1\\",\\n \\"Priority\\": 100,\\n \\"DecisionConfig\\": {\\n \\"Effect\\": \\"allow\\",\\n \\"MfaType\\": \\"directly_access\\",\\n \\"MfaAuthenticationIntervalSeconds\\": 300,\\n \\"MfaAuthenticationMethods\\": [\\n \\"ia_webauthn\\"\\n ],\\n \\"ActiveSessionReuseStatus\\": \\"disabled\\"\\n },\\n \\"ConditionsConfig\\": {\\n \\"Applications\\": {\\n \\"IncludeApplications\\": [\\n \\"app_mrxpwnipe6vxix72w72gppxxxx\\"\\n ],\\n \\"ExcludeApplications\\": [\\n \\"app_xxxxx\\"\\n ]\\n },\\n \\"Users\\": {\\n \\"IncludeUsers\\": [\\n \\"user_7kht3wmffmdvvqizxwsab3xxxx\\"\\n ],\\n \\"ExcludeUsers\\": [\\n \\"user_rh2uldi6u56epkazm2wgrxxxxx\\"\\n ],\\n \\"IncludeGroups\\": [\\n \\"group_xtlpbw47kxxz6rygjkqupxxxxx\\"\\n ],\\n \\"ExcludeGroups\\": [\\n \\"group_eki2tt7g4hjbiowfzh5j4xxxxx\\"\\n ],\\n \\"IncludeOrganizationalUnits\\": [\\n \\"ou_kp63or7wlpkbfperzo3qg2xxxx\\"\\n ],\\n \\"ExcludeOrganizationalUnits\\": [\\n \\"ou_kp63or7wlpkbfperzo3qg2aaxx\\"\\n ]\\n },\\n \\"NetworkZones\\": {\\n \\"IncludeNetworkZones\\": [\\n \\"network_m5wbsb2eaxzs4zmykoh22xxxxx\\"\\n ],\\n \\"ExcludeNetworkZones\\": [\\n \\"network_xxxxx\\"\\n ]\\n }\\n },\\n \\"CreateTime\\": 1741857554000,\\n \\"LastUpdatedTime\\": 1741857554000\\n }\\n ]\\n}","type":"json"}]',
],
'ListCredentialProviders' => [
'summary' => 'Lists credential providers.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The maximum number of entries per page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'CredentialProviderIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of credential provider IDs.',
'type' => 'array',
'items' => ['description' => 'The credential provider ID.', 'type' => 'string', 'required' => false, 'example' => 'atp_01kr2cmj5gxxx4fvmls2e93dxxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
[
'name' => 'CredentialProviderTypes',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of credential provider types.',
'type' => 'array',
'items' => ['description' => 'The credential provider type. Valid values:'."\n"
."\n"
.'- oauth: OAuth credential provider.'."\n"
.'- jwt: JWT credential provider.', 'type' => 'string', 'required' => false, 'example' => 'oauth', 'title' => ''],
'required' => false,
'example' => '',
],
],
[
'name' => 'Statuses',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of credential provider statuses.',
'type' => 'array',
'items' => ['description' => 'The credential provider status. Valid values:'."\n"
."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'enabled', 'title' => ''],
'required' => false,
'example' => '',
],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of filter conditions.',
'type' => 'array',
'items' => [
'description' => 'The filter condition.',
'type' => 'object',
'properties' => [
'Name' => ['title' => '', 'description' => 'The filter condition name. Valid values:'."\n"
."\n"
.'- CredentialProviderName: the credential provider name.'."\n"
.'- CredentialProviderIdentifier: the credential provider identifier.', 'type' => 'string', 'required' => false, 'example' => 'CredentialProviderName'],
'Value' => [
'title' => '',
'description' => 'The list of filter condition values.',
'type' => 'array',
'items' => ['description' => 'The filter condition value.', 'type' => 'string', 'required' => false, 'example' => 'test_example_name', 'title' => ''],
'required' => false,
'maxItems' => 10,
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 10,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned by this call.', 'type' => 'string', 'example' => 'NTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The maximum number of entries per page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'CredentialProviders' => [
'title' => '',
'description' => 'The list of credential providers.',
'type' => 'array',
'items' => [
'description' => 'The credential provider.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'CredentialProviderId' => ['title' => '', 'description' => 'The credential provider ID.', 'type' => 'string', 'example' => 'atp_01kr2cmj5gxxx4fvmls2e93dxxxxx'],
'CredentialProviderIdentifier' => ['title' => '', 'description' => 'The credential provider identifier.', 'type' => 'string', 'example' => 'test_example_identifier'],
'CredentialProviderName' => ['title' => '', 'description' => 'The credential provider name.', 'type' => 'string', 'example' => 'test_example_name'],
'CreateTime' => ['title' => '', 'description' => 'The creation time of the credential provider. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830225000'],
'UpdateTime' => ['title' => '', 'description' => 'The update time of the credential provider. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830225000'],
'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'This is an example description'],
'CredentialProviderType' => ['title' => '', 'description' => 'The credential provider type. Valid values:'."\n"
."\n"
.'- oauth: OAuth credential provider.'."\n"
.'- jwt: JWT credential provider.', 'type' => 'string', 'example' => 'oauth'],
'CredentialProviderCreationType' => ['title' => '', 'description' => 'The creation type of the credential provider. Valid values:'."\n"
."\n"
.'- system_init: Created by the system.'."\n"
.'- user_custom: Created by the user.', 'type' => 'string', 'example' => 'user_custom'],
'Status' => ['title' => '', 'description' => 'The credential provider status. Valid values:'."\n"
."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enabled'],
'CredentialProviderConfig' => [
'title' => '',
'description' => 'The credential provider configuration.',
'type' => 'object',
'properties' => [
'ProviderCredentialIds' => [
'title' => '',
'description' => 'The list of credential IDs that correspond to the sensitive configuration of the credential provider.'."\n"
."\n"
.'> The system securely stores the sensitive configuration of the credential provider as credentials.',
'type' => 'array',
'items' => ['description' => 'The credential ID that corresponds to the sensitive configuration.', 'type' => 'string', 'example' => 'cred_mkv7xxxxd7i4u7zqtzev2mxxxx', 'title' => ''],
'example' => '',
],
'OAuthProviderConfig' => [
'title' => '',
'description' => 'The configuration of the OAuth credential provider.',
'type' => 'object',
'properties' => [
'ClientId' => ['title' => '', 'description' => 'The client_id in the OAuth protocol, which is the client ID.', 'type' => 'string', 'example' => 'client_id_example_xxx'],
'TokenEndpoint' => ['title' => '', 'description' => 'The token endpoint of the OAuth protocol.', 'type' => 'string', 'example' => 'https://example.com/token'],
'Scope' => ['title' => '', 'description' => 'The scope in the OAuth protocol, which specifies the permission scope.'."\n"
."\n"
.'> The Scope configuration of the OAuth credential provider serves as the default value. If the scope parameter is not specified when calling the DeveloperAPI to obtain an OAuth access token, the Scope configuration of the credential provider is used for token issuance.'."\n"
."\n"
.'>Multiple Scope values are separated by spaces.>', 'type' => 'string', 'example' => 'example:test_01 example:test_02'],
],
'example' => '',
],
'JwtProviderConfig' => [
'title' => '',
'description' => 'The configuration of the JWT credential provider.',
'type' => 'object',
'properties' => [
'Issuer' => ['title' => '', 'description' => 'JWT issuer。', 'type' => 'string', 'example' => 'https://test.issuer.com'],
'JwksEndpoint' => ['title' => '', 'description' => 'The JWKs endpoint URL.', 'type' => 'string', 'example' => 'https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks'],
'Expiration' => ['title' => '', 'description' => 'The validity period of the JWT, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '900'],
'ExpirationCleanupEnabled' => ['title' => '', 'description' => 'Indicates whether JWT expiration cleanup is enabled.', 'type' => 'boolean', 'example' => 'true'],
'DerivedShortTokenEnabled' => ['title' => '', 'description' => 'Indicates whether the JWT derived short token feature is enabled.', 'type' => 'boolean', 'example' => 'false'],
'AllowedTokenIssuers' => [
'title' => '',
'description' => 'The list of allowed JWT issuers.',
'type' => 'array',
'items' => ['title' => '', 'description' => 'The allowed JWT issuer.', 'type' => 'string', 'example' => 'https://test.issuer.com'],
'example' => '',
],
],
'example' => '',
],
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'List credential providers',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListCredentialProviders',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"CredentialProviders\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"CredentialProviderId\\": \\"atp_01kr2cmj5gxxx4fvmls2e93dxxxxx\\",\\n \\"CredentialProviderIdentifier\\": \\"test_example_identifier\\",\\n \\"CredentialProviderName\\": \\"test_example_name\\",\\n \\"CreateTime\\": 1649830225000,\\n \\"UpdateTime\\": 1649830225000,\\n \\"Description\\": \\"This is an example description\\",\\n \\"CredentialProviderType\\": \\"oauth\\",\\n \\"CredentialProviderCreationType\\": \\"user_custom\\",\\n \\"Status\\": \\"enabled\\",\\n \\"CredentialProviderConfig\\": {\\n \\"ProviderCredentialIds\\": [\\n \\"cred_mkv7xxxxd7i4u7zqtzev2mxxxx\\"\\n ],\\n \\"OAuthProviderConfig\\": {\\n \\"ClientId\\": \\"client_id_example_xxx\\",\\n \\"TokenEndpoint\\": \\"https://example.com/token\\",\\n \\"Scope\\": \\"example:test_01 example:test_02\\"\\n },\\n \\"JwtProviderConfig\\": {\\n \\"Issuer\\": \\"https://test.issuer.com\\",\\n \\"JwksEndpoint\\": \\"https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks\\",\\n \\"Expiration\\": 900,\\n \\"ExpirationCleanupEnabled\\": true,\\n \\"DerivedShortTokenEnabled\\": false,\\n \\"AllowedTokenIssuers\\": [\\n \\"https://test.issuer.com\\"\\n ]\\n }\\n }\\n }\\n ]\\n}","type":"json"}]',
],
'ListCredentials' => [
'summary' => 'Queries the information of one or more credentials by using paging.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The maximum number of entries per page.'."\n"
.'- Default value: 20.'."\n"
.'- Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'CredentialIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The list of credential IDs.',
'type' => 'array',
'items' => ['title' => '', 'description' => 'The credential ID.', 'type' => 'string', 'required' => false, 'example' => 'cred_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'CredentialTypes',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'type' => 'array',
'items' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
'description' => '',
'example' => '',
],
],
[
'name' => 'Statuses',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The list of credential statuses.',
'type' => 'array',
'items' => ['title' => '', 'description' => 'The credential status. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- diasbled: Disabled.', 'type' => 'string', 'required' => false, 'example' => 'enabled'],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The filter conditions.',
'type' => 'array',
'items' => [
'description' => 'The filter conditions.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the filter field. Valid values:'."\n"
.'- CredentialIdentifier: the credential identifier.', 'type' => 'string', 'required' => false, 'example' => 'CredentialIdentifier', 'title' => ''],
'Value' => [
'description' => 'The list of filter field values.',
'type' => 'array',
'items' => ['description' => 'The filter field value.', 'type' => 'string', 'required' => false, 'example' => 'credential_identifier_test', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'CredentialSharingScopes',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'type' => 'array',
'items' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
'description' => '',
'example' => '',
],
],
[
'name' => 'CredentialExternalIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'type' => 'array',
'items' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
'description' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned in this call.', 'type' => 'string', 'example' => 'NTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The maximum number of entries per page for paging.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'Credentials' => [
'description' => 'The list of credentials.',
'type' => 'array',
'items' => [
'description' => 'The credential information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The EIAM instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'CredentialId' => ['title' => '', 'description' => 'The credential ID.', 'type' => 'string', 'example' => 'cred_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'Status' => ['title' => '', 'description' => 'The credential status. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- diasbled: Disabled.', 'type' => 'string', 'example' => 'enabled'],
'CredentialIdentifier' => ['title' => '', 'description' => 'The credential identifier.', 'type' => 'string', 'example' => 'credential_identifier_test'],
'CredentialName' => ['title' => '', 'description' => 'The credential name.', 'type' => 'string', 'example' => 'credential_name'],
'CredentialSubjectType' => ['title' => '', 'description' => 'The subject type to which the credential belongs. Valid values:'."\n"
.'- authentication_token_provider: authentication token provider.', 'type' => 'string', 'example' => 'authentication_token_provider'],
'CredentialSubjectId' => ['title' => '', 'description' => 'The subject ID to which the credential belongs.', 'type' => 'string', 'example' => 'apt_werthgfdsasffxxxxx'],
'CredentialScenarioLabel' => ['title' => '', 'description' => 'The scenarios label of the credential. Valid values:'."\n"
.'- llm: large language model.'."\n"
.'- saas: third-party SaaS service.', 'type' => 'string', 'example' => 'llm'],
'CredentialType' => ['title' => '', 'description' => 'The credential type. Valid values:'."\n"
.'- api_key: API key authentication credential.'."\n"
.'- oauth_client: OAuth client authentication credential.', 'type' => 'string', 'example' => 'api_key'],
'CredentialCreationType' => ['title' => '', 'description' => 'The creation type of the credential. Valid values:'."\n"
.'- system_init: Created by the system.'."\n"
.'- user_custom: Created by the user.', 'type' => 'string', 'example' => 'user_custom'],
'Description' => ['title' => '', 'description' => 'The credential description.', 'type' => 'string', 'example' => 'credential_description'],
'CreateTime' => ['title' => '', 'description' => 'The creation time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830225000'],
'UpdateTime' => ['title' => '', 'description' => 'The update time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830227000'],
'CredentialContent' => [
'title' => '',
'description' => 'The credential content.',
'type' => 'object',
'properties' => [
'OAuthClientContent' => [
'title' => '',
'description' => 'The credential content of the OAuth client authentication credential type.',
'type' => 'object',
'properties' => [
'ClientId' => ['title' => '', 'description' => 'The client_id of the OAuth protocol.', 'type' => 'string', 'example' => 'dmvncmxersdxxxxxx'],
],
'example' => '',
],
],
'example' => '',
],
'CredentialSharingScope' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
'ExclusiveUserId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
'CredentialExternalId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List credentials',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListCredentials',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"Credentials\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"CredentialId\\": \\"cred_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"Status\\": \\"enabled\\",\\n \\"CredentialIdentifier\\": \\"credential_identifier_test\\",\\n \\"CredentialName\\": \\"credential_name\\",\\n \\"CredentialSubjectType\\": \\"authentication_token_provider\\",\\n \\"CredentialSubjectId\\": \\"apt_werthgfdsasffxxxxx\\",\\n \\"CredentialScenarioLabel\\": \\"llm\\",\\n \\"CredentialType\\": \\"api_key\\",\\n \\"CredentialCreationType\\": \\"user_custom\\",\\n \\"Description\\": \\"credential_description\\",\\n \\"CreateTime\\": 1649830225000,\\n \\"UpdateTime\\": 1649830227000,\\n \\"CredentialContent\\": {\\n \\"OAuthClientContent\\": {\\n \\"ClientId\\": \\"dmvncmxersdxxxxxx\\"\\n }\\n },\\n \\"CredentialSharingScope\\": \\"\\",\\n \\"ExclusiveUserId\\": \\"\\",\\n \\"CredentialExternalId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListCustomPrivacyPolicies' => [
'summary' => 'Queries the list of custom terms.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas4TD7D0', 'FEATUREidaasLY3IT7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'PreviousToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The token for the previous page.', 'type' => 'string', 'example' => 'PTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'CustomPrivacyPolicyNameStartsWith',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['title' => '', 'description' => 'The custom term name. Left fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'Custom', 'maxLength' => 256],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned by this call.', 'type' => 'string', 'example' => 'NTxxxexample'],
'PreviousToken' => ['title' => '', 'description' => 'The pagination token returned by this call.', 'type' => 'string', 'example' => 'PTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'CustomPrivacyPolicies' => [
'description' => 'The list of custom terms.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'CustomPrivacyPolicyId' => ['title' => '', 'description' => 'The custom term ID.', 'type' => 'string', 'example' => 'pp_xxxxx'],
'CustomPrivacyPolicyName' => ['title' => '', 'description' => 'The custom term name.', 'type' => 'string', 'example' => 'Custom Privacy Policy Name'],
'Status' => [
'title' => '',
'description' => 'The custom term status.',
'enumValueTitles' => ['disabled' => 'Disabled.', 'enabled' => 'Enabled.'],
'type' => 'string',
'example' => 'enabled',
],
'UserConsentType' => [
'title' => '',
'description' => 'The consent type of the custom term.',
'enumValueTitles' => ['explicit_consent' => 'Manual checkbox consent.', 'implied_consent' => 'Implied consent by default.'],
'type' => 'string',
'example' => 'implied_consent',
],
'DefaultLanguageCode' => ['title' => '', 'description' => 'The default language term entry. The value is obtained from the LanguageCode field returned by the ListLanguages operation.', 'type' => 'string', 'example' => 'zh-Hans-CN'],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query custom terms list',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListCustomPrivacyPolicies',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"PreviousToken\\": \\"PTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"CustomPrivacyPolicies\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"CustomPrivacyPolicyId\\": \\"pp_xxxxx\\",\\n \\"CustomPrivacyPolicyName\\": \\"Custom Privacy Policy Name\\",\\n \\"Status\\": \\"enabled\\",\\n \\"UserConsentType\\": \\"implied_consent\\",\\n \\"DefaultLanguageCode\\": \\"zh-Hans-CN\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListCustomPrivacyPoliciesForBrand' => [
'summary' => 'Retrieves the resources of brand-linked instances.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasLY3IT7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'title' => '', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to retrieve the next page of results.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'NTxxxxxexample'],
],
[
'name' => 'PreviousToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to retrieve the previous page of results.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'PTxxxxxexample'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'default' => '20', 'title' => '', 'required' => false, 'example' => '20'],
],
[
'name' => 'BrandId',
'in' => 'query',
'schema' => ['description' => 'The brand ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'brand_xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['type' => 'integer', 'format' => 'int64', 'title' => '', 'description' => 'The total number of entries.', 'example' => '100'],
'NextToken' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'title' => '', 'example' => 'NTxxxexample'],
'PreviousToken' => ['description' => 'The token to retrieve the previous page of results.', 'type' => 'string', 'title' => '', 'example' => 'PTxxxexample'],
'MaxResults' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '20'],
'BrandCustomPrivacyPolicies' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CustomPrivacyPolicyId' => ['description' => 'The privacy policy ID.', 'type' => 'string', 'title' => '', 'example' => 'pp_xxxx'],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => 'The list of custom privacy policies associated with the brand.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListCustomPrivacyPoliciesForBrand',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListCustomPrivacyPoliciesForBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"PreviousToken\\": \\"PTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"BrandCustomPrivacyPolicies\\": [\\n {\\n \\"CustomPrivacyPolicyId\\": \\"pp_xxxx\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListDomainProxyTokens' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGK16FE'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'DomainId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The domain ID.', 'type' => 'string', 'required' => true, 'example' => 'dm_examplexxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'DomainProxyTokens' => [
'description' => 'A list of domain proxy token objects.',
'type' => 'array',
'items' => [
'description' => 'The domain proxy token object.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'DomainProxyTokenId' => ['title' => '', 'description' => 'The domain proxy token ID.', 'type' => 'string', 'example' => 'pt_examplexxxx'],
'DomainProxyToken' => ['title' => '', 'description' => 'The domain proxy token.', 'type' => 'string', 'example' => 'PTxxxxxxxx'],
'DomainId' => ['title' => '', 'description' => 'The domain ID.', 'type' => 'string', 'example' => 'dm_examplexxxx'],
'Status' => ['title' => '', 'description' => 'The token status. Valid values:'."\n"
.'- enabled: The token is enabled.'."\n"
."\n"
.'- disabled: The token is disabled.', 'type' => 'string', 'example' => 'enabled'],
'CreateTime' => ['title' => '', 'description' => 'The creation time of the domain proxy token, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
'UpdateTime' => ['title' => '', 'description' => 'The most recent update time of the domain proxy token, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
'LastUsedTime' => ['title' => '', 'description' => 'The most recent usage time of the domain proxy token, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List Domain Proxy Tokens of an EIAM Instance',
'summary' => 'Queries a list of domain proxy tokens of an EIAM instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDomainProxyTokens'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListDomainProxyTokens',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'DomainProxyToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}/domainproxytoken/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"DomainProxyTokens\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"DomainProxyTokenId\\": \\"pt_examplexxxx\\",\\n \\"DomainProxyToken\\": \\"PTxxxxxxxx\\",\\n \\"DomainId\\": \\"dm_examplexxxx\\",\\n \\"Status\\": \\"enabled\\",\\n \\"CreateTime\\": 1649830226000,\\n \\"UpdateTime\\": 1649830226000,\\n \\"LastUsedTime\\": 1649830226000\\n }\\n ]\\n}","type":"json"}]',
],
'ListDomains' => [
'summary' => 'Queries the domain names of an EIAM instance, including the default domain name and custom domain names.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGK16FE'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'BrandId',
'in' => 'query',
'schema' => ['description' => 'The brand ID.', 'type' => 'string', 'required' => false, 'example' => 'brand_xxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'Domains' => [
'description' => 'The list of domain names.',
'type' => 'array',
'items' => [
'description' => 'The domain name object.',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'title' => ''],
'DomainId' => ['description' => 'The domain name ID.', 'type' => 'string', 'example' => 'dm_examplexxxxx', 'title' => ''],
'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''],
'DomainType' => ['description' => 'The type of the domain name. Valid values:'."\n"
."\n"
.'- system\\_init: The default domain name that is generated during initialization.'."\n"
."\n"
.'- user\\_custom: A custom domain name.', 'type' => 'string', 'example' => 'system_init', 'title' => ''],
'LockMode' => ['description' => 'The lock status of the domain name. Valid values:'."\n"
."\n"
.'- unlock: Normal.'."\n"
."\n"
.'- lockByLicense: The domain name is unavailable due to license limitations.', 'type' => 'string', 'example' => 'unlock', 'title' => ''],
'DefaultDomain' => ['description' => 'Indicates whether the domain name is the default one.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'CreateTime' => ['description' => 'The time when the domain name was created. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000', 'title' => ''],
'UpdateTime' => ['description' => 'The time when the domain name was last updated. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000', 'title' => ''],
'Filing' => [
'title' => '',
'description' => 'The ICP filing information about the domain name.',
'type' => 'object',
'properties' => [
'IcpNumber' => ['description' => 'The ICP filing number associated with the domain name. Both entity and website ICP filing numbers are supported.', 'type' => 'string', 'title' => '', 'example' => 'xICPxxxxxx-xx'],
],
'example' => '',
],
'BrandId' => ['description' => 'The brand ID.', 'type' => 'string', 'example' => 'brand_xxxx', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Domains\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"DomainId\\": \\"dm_examplexxxxx\\",\\n \\"Domain\\": \\"www.example.com\\",\\n \\"DomainType\\": \\"system_init\\",\\n \\"LockMode\\": \\"unlock\\",\\n \\"DefaultDomain\\": false,\\n \\"CreateTime\\": 1649830226000,\\n \\"UpdateTime\\": 1649830226000,\\n \\"Filing\\": {\\n \\"IcpNumber\\": \\"xICPxxxxxx-xx\\"\\n },\\n \\"BrandId\\": \\"brand_xxxx\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListDomains',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDomains'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListDomains',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/*'],
],
],
],
],
],
'ListEiamInstances' => [
'summary' => 'Queries the list of EIAM 2.0 and EIAM 1.0 instances.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6GKEFM'],
],
'parameters' => [
[
'name' => 'InstanceIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of instance IDs.',
'type' => 'array',
'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
[
'name' => 'InstanceRegionId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The region to which the instances belong.', 'type' => 'string', 'example' => 'cn-hangzhou', 'maxLength' => 32, 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'Instances' => [
'description' => 'The list of instances.',
'type' => 'array',
'items' => [
'description' => 'The instance details.',
'type' => 'object',
'properties' => [
'Description' => ['title' => '', 'description' => 'The description of the instance.', 'type' => 'string', 'example' => 'Production environment'],
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_eypq6ljgyeuwmlw672sulxxxxx'],
'StartTime' => ['title' => '', 'description' => 'The time when the instance was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1677810869300'],
'SSODomain' => ['title' => '', 'description' => 'The SSO domain name of the instance.', 'type' => 'string', 'example' => 'xxxx.aliyunidaas.com'],
'DeveloperAPIPrivateDomain' => ['title' => '', 'description' => 'The private domain name of the developer API for the instance.', 'type' => 'string', 'example' => 'eiam-developerapi-cn.vpc-proxy.aliyuncs.com'],
'DeveloperAPIPublicDomain' => ['title' => '', 'description' => 'The public domain name of the developer API for the instance.', 'type' => 'string', 'example' => 'eiam-developerapi.cn-hangzhou.aliyuncs.com'],
'OpenAPIPrivateDomain' => ['title' => '', 'description' => 'The private domain name of the OpenAPI for the instance.', 'type' => 'string', 'example' => 'eiam-cn.vpc-proxy.aliyuncs.com'],
'OpenAPIPublicDomain' => ['title' => '', 'description' => 'The public domain name of the OpenAPI for the instance.', 'type' => 'string', 'example' => 'eiam.cn-hangzhou.aliyuncs.com'],
'InstanceStatus' => ['title' => '', 'description' => 'The instance status.', 'type' => 'string', 'example' => 'RUNNING'],
'InstanceVersion' => [
'title' => '',
'description' => 'The instance version.',
'enumValueTitles' => ['EIAM 2.0' => 'EIAM 2.0', 'EIAM 1.0' => 'EIAM 1.0'],
'type' => 'string',
'example' => 'EIAM 2.0',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List iDaaS instances',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEiamInstances'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListEiamInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Instances\\": [\\n {\\n \\"Description\\": \\"Production environment\\",\\n \\"InstanceId\\": \\"idaas_eypq6ljgyeuwmlw672sulxxxxx\\",\\n \\"StartTime\\": 1677810869300,\\n \\"SSODomain\\": \\"xxxx.aliyunidaas.com\\",\\n \\"DeveloperAPIPrivateDomain\\": \\"eiam-developerapi-cn.vpc-proxy.aliyuncs.com\\",\\n \\"DeveloperAPIPublicDomain\\": \\"eiam-developerapi.cn-hangzhou.aliyuncs.com\\",\\n \\"OpenAPIPrivateDomain\\": \\"eiam-cn.vpc-proxy.aliyuncs.com\\",\\n \\"OpenAPIPublicDomain\\": \\"eiam.cn-hangzhou.aliyuncs.com\\",\\n \\"InstanceStatus\\": \\"RUNNING\\",\\n \\"InstanceVersion\\": \\"EIAM 2.0\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListEiamRegions' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasXM4LQ1'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'Regions' => [
'description' => 'The list of regions.',
'type' => 'array',
'items' => [
'description' => 'The region object.',
'type' => 'object',
'properties' => [
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'LocalName' => ['description' => 'The name of the region.', 'type' => 'string', 'example' => '华东1(杭州)', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListEiamRegions',
'summary' => 'Lists the regions available for EIAM 1.0 and EIAM 2.0.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEiamRegions'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'eiam:ListEiamRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LocalName\\": \\"华东1(杭州)\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListEventTypes' => [
'summary' => 'Queries the event list.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasXM4LQ1'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page number of the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'EventTypes' => [
'description' => 'The list of event types.',
'type' => 'array',
'items' => [
'description' => 'The list of event types.',
'type' => 'object',
'properties' => [
'EventType' => ['title' => '', 'description' => 'The event type.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:event:user:create'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query event list',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListEventTypes',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"EventTypes\\": [\\n {\\n \\"EventType\\": \\"urn:alibaba:idaas:event:user:create\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListFederatedCredentialProviders' => [
'summary' => 'Queries a list of federated trust sources.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'PreviousToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The token used to query the previous page.', 'type' => 'string', 'example' => 'PTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The maximum number of entries per page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'FederatedCredentialProviderName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The name of the federated trust source.', 'type' => 'string', 'required' => false, 'example' => 'test', 'maxLength' => 256],
],
[
'name' => 'FederatedCredentialProviderType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The type of the federated trust source.', 'type' => 'string', 'required' => false, 'example' => 'pkcs7', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned by this call.', 'type' => 'string', 'example' => 'NTxxxexample'],
'PreviousToken' => ['title' => '', 'description' => 'The pagination token returned by this call.', 'type' => 'string', 'example' => 'PTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The maximum number of entries per page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'FederatedCredentialProviders' => [
'description' => 'The list of federated trust sources.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_dd4n3rnknybjjxuu5gq6ovqxXXX'],
'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729061324000'],
'UpdateTime' => ['title' => '', 'description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729061324000'],
'Status' => ['title' => '', 'description' => 'The status.', 'type' => 'string', 'example' => 'enabled'],
'Description' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'test'],
'FederatedCredentialProviderType' => ['title' => '', 'description' => 'The type of the federated trust source.', 'type' => 'string', 'example' => 'pkcs7'],
'NetworkAccessEndpointId' => ['title' => '', 'description' => 'The network access endpoint ID.', 'type' => 'string', 'example' => 'inae_public'],
'FederatedCredentialProviderName' => ['title' => '', 'description' => 'The name of the federated trust source.', 'type' => 'string', 'example' => 'pkcs7test'],
'FederatedCredentialProviderId' => ['title' => '', 'description' => 'The federated trust source ID.', 'type' => 'string', 'example' => 'fcp_asda123XXX'],
'Pkcs7ProviderConfig' => [
'title' => '',
'description' => 'The PKCS7 configuration.',
'type' => 'object',
'properties' => [
'SignatureEffectiveTime' => ['title' => '', 'description' => 'The signature effective time.', 'type' => 'integer', 'format' => 'int64', 'example' => '3600'],
'TrustAnchorSource' => ['title' => '', 'description' => 'The certificate trust anchor source.', 'type' => 'string', 'example' => 'alibaba_cloud'],
'CmsVerificationMode' => ['title' => '', 'description' => 'The CMS verification mode.', 'type' => 'string', 'example' => 'cert'],
'SigningTimeValueExpression' => ['title' => '', 'description' => 'The expression used to retrieve the signing time.', 'type' => 'string', 'example' => 'pkcs7.payload.jsonData.audience.signingTime'."\n"],
'Certificates' => [
'title' => '',
'description' => 'The list of PKCS7 certificates.',
'type' => 'array',
'items' => [
'description' => 'The certificate object.',
'type' => 'object',
'properties' => [
'CertificateMetadata' => [
'title' => '',
'description' => 'The certificate metadata.',
'type' => 'object',
'properties' => [
'NotBefore' => ['title' => '', 'description' => 'The effective period of the certificate.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729061324000'],
'NotAfter' => ['title' => '', 'description' => 'The time when the certificate expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729061324000'],
],
'example' => '',
],
'Fingerprint' => ['title' => '', 'description' => 'The certificate fingerprint.', 'type' => 'string', 'example' => '2b18947a6a9fc7764fd8b5fb18a863b0c6daxxx'],
'Content' => ['title' => '', 'description' => 'The certificate content.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----'."\n"
.'MIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z'."\n"
.'-----END CERTIFICATE-----'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
'TrustCondition' => ['title' => '', 'description' => 'The trust condition.', 'type' => 'string', 'example' => 'IsNullOrEmpty("certNo")'."\n"],
],
'example' => '',
],
'OidcProviderConfig' => [
'title' => '',
'description' => 'The OIDC configuration.',
'type' => 'object',
'properties' => [
'JwksUri' => ['title' => '', 'description' => 'The JWKS endpoint.', 'type' => 'string', 'example' => 'https://example.com'],
'Issuer' => ['title' => '', 'description' => 'Issuer', 'type' => 'string', 'example' => 'https://example.com'],
'Audiences' => [
'title' => '',
'description' => 'The list of audiences for the OIDC credential.',
'type' => 'array',
'items' => ['description' => 'The audience.', 'type' => 'string', 'example' => 'https://example.com', 'title' => ''],
'example' => '',
],
'JwksLastObtainedTime' => ['title' => '', 'description' => 'The time when the JWKS was last obtained.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729061324000'],
'StaticJwks' => ['title' => '', 'description' => 'The statically obtained JWKS.', 'type' => 'string', 'example' => '{'."\n"
.' "keys": ['."\n"
.' {'."\n"
.' "kty": "RSA",'."\n"
.' "e": "AQAB",'."\n"
.' "use": "sig",'."\n"
.' "kid": "KEY2RzsjRrimRASiAhCjBo18YwDoxpYHnHtv",'."\n"
.' "n": "qrsfFfSZngqKOxVE29ZIR4SXkwKq029B3HLDAZui_Pwaxwn8FssR9QdwsljZS06BTDp10vhPgqMB7s7TmHulL3I4WuSB-l4uXTXXXX"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'],
'JwksSource' => ['title' => '', 'description' => 'The JWKS source.', 'type' => 'string', 'example' => 'static'],
'TrustCondition' => ['title' => '', 'description' => 'The trust condition.', 'type' => 'string', 'example' => 'IsNullOrEmpty("jwt.issuer")'."\n"],
'DynamicJwks' => ['title' => '', 'description' => 'The dynamically obtained JWKS.', 'type' => 'string', 'example' => '{'."\n"
.' "keys": ['."\n"
.' {'."\n"
.' "kty": "RSA",'."\n"
.' "e": "AQAB",'."\n"
.' "use": "sig",'."\n"
.' "kid": "KEY2RzsjRrimRASiAhCjBo18YwDoxpYHnHtv",'."\n"
.' "n": "qrsfFfSZngqKOxVE29ZIR4SXkwKq029B3HLDAZui_Pwaxwn8FssR9QdwsljZS06BTDp10vhPgqMB7s7TmHulL3I4WuSB-l4uXTXXXX"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'],
],
'example' => '',
],
'PrivateCaProviderConfig' => [
'title' => '',
'description' => 'The private CA configuration.',
'type' => 'object',
'properties' => [
'TrustAnchorSource' => ['title' => '', 'description' => 'The method used to retrieve the root certificate.', 'type' => 'string', 'example' => 'custom'],
'Certificates' => [
'title' => '',
'description' => 'The root certificates.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CertificateMetadata' => [
'title' => '',
'description' => 'The certificate metadata.',
'type' => 'object',
'properties' => [
'NotBefore' => ['title' => '', 'description' => 'The effective period of the certificate.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729061324000'],
'NotAfter' => ['title' => '', 'description' => 'The time when the certificate expires.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729061324000'],
],
'example' => '',
],
'Fingerprint' => ['title' => '', 'description' => 'The root certificate fingerprint.', 'type' => 'string', 'example' => '2b18947a6a9fc7764fd8b5fb18a863b0c6daxxx'],
'Content' => ['title' => '', 'description' => 'The root certificate content.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----'."\n"
.'MIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z'."\n"
.'-----END CERTIFICATE-----'],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
'TrustCondition' => ['title' => '', 'description' => 'The trust condition.', 'type' => 'string', 'example' => 'IsNullOrEmpty("certNo")'."\n"],
],
'example' => '',
],
'CloudIdPProviderConfig' => [
'title' => '',
'type' => 'object',
'properties' => [
'IdentityProviderId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
],
'description' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List federated trust sources',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListFederatedCredentialProviders',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"PreviousToken\\": \\"PTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"FederatedCredentialProviders\\": [\\n {\\n \\"InstanceId\\": \\"idaas_dd4n3rnknybjjxuu5gq6ovqxXXX\\",\\n \\"CreateTime\\": 1729061324000,\\n \\"UpdateTime\\": 1729061324000,\\n \\"Status\\": \\"enabled\\",\\n \\"Description\\": \\"test\\",\\n \\"FederatedCredentialProviderType\\": \\"pkcs7\\",\\n \\"NetworkAccessEndpointId\\": \\"inae_public\\",\\n \\"FederatedCredentialProviderName\\": \\"pkcs7test\\",\\n \\"FederatedCredentialProviderId\\": \\"fcp_asda123XXX\\",\\n \\"Pkcs7ProviderConfig\\": {\\n \\"SignatureEffectiveTime\\": 3600,\\n \\"TrustAnchorSource\\": \\"alibaba_cloud\\",\\n \\"CmsVerificationMode\\": \\"cert\\",\\n \\"SigningTimeValueExpression\\": \\"pkcs7.payload.jsonData.audience.signingTime\\\\n\\",\\n \\"Certificates\\": [\\n {\\n \\"CertificateMetadata\\": {\\n \\"NotBefore\\": 1729061324000,\\n \\"NotAfter\\": 1729061324000\\n },\\n \\"Fingerprint\\": \\"2b18947a6a9fc7764fd8b5fb18a863b0c6daxxx\\",\\n \\"Content\\": \\"-----BEGIN CERTIFICATE-----\\\\nMIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z\\\\n-----END CERTIFICATE-----\\"\\n }\\n ],\\n \\"TrustCondition\\": \\"IsNullOrEmpty(\\\\\\"certNo\\\\\\")\\\\n\\"\\n },\\n \\"OidcProviderConfig\\": {\\n \\"JwksUri\\": \\"https://example.com\\",\\n \\"Issuer\\": \\"https://example.com\\",\\n \\"Audiences\\": [\\n \\"https://example.com\\"\\n ],\\n \\"JwksLastObtainedTime\\": 1729061324000,\\n \\"StaticJwks\\": \\"{\\\\n \\\\\\"keys\\\\\\": [\\\\n {\\\\n \\\\\\"kty\\\\\\": \\\\\\"RSA\\\\\\",\\\\n \\\\\\"e\\\\\\": \\\\\\"AQAB\\\\\\",\\\\n \\\\\\"use\\\\\\": \\\\\\"sig\\\\\\",\\\\n \\\\\\"kid\\\\\\": \\\\\\"KEY2RzsjRrimRASiAhCjBo18YwDoxpYHnHtv\\\\\\",\\\\n \\\\\\"n\\\\\\": \\\\\\"qrsfFfSZngqKOxVE29ZIR4SXkwKq029B3HLDAZui_Pwaxwn8FssR9QdwsljZS06BTDp10vhPgqMB7s7TmHulL3I4WuSB-l4uXTXXXX\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"JwksSource\\": \\"static\\",\\n \\"TrustCondition\\": \\"IsNullOrEmpty(\\\\\\"jwt.issuer\\\\\\")\\\\n\\",\\n \\"DynamicJwks\\": \\"{\\\\n \\\\\\"keys\\\\\\": [\\\\n {\\\\n \\\\\\"kty\\\\\\": \\\\\\"RSA\\\\\\",\\\\n \\\\\\"e\\\\\\": \\\\\\"AQAB\\\\\\",\\\\n \\\\\\"use\\\\\\": \\\\\\"sig\\\\\\",\\\\n \\\\\\"kid\\\\\\": \\\\\\"KEY2RzsjRrimRASiAhCjBo18YwDoxpYHnHtv\\\\\\",\\\\n \\\\\\"n\\\\\\": \\\\\\"qrsfFfSZngqKOxVE29ZIR4SXkwKq029B3HLDAZui_Pwaxwn8FssR9QdwsljZS06BTDp10vhPgqMB7s7TmHulL3I4WuSB-l4uXTXXXX\\\\\\"\\\\n }\\\\n ]\\\\n}\\"\\n },\\n \\"PrivateCaProviderConfig\\": {\\n \\"TrustAnchorSource\\": \\"custom\\",\\n \\"Certificates\\": [\\n {\\n \\"CertificateMetadata\\": {\\n \\"NotBefore\\": 1729061324000,\\n \\"NotAfter\\": 1729061324000\\n },\\n \\"Fingerprint\\": \\"2b18947a6a9fc7764fd8b5fb18a863b0c6daxxx\\",\\n \\"Content\\": \\"-----BEGIN CERTIFICATE-----\\\\nMIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z\\\\n-----END CERTIFICATE-----\\"\\n }\\n ],\\n \\"TrustCondition\\": \\"IsNullOrEmpty(\\\\\\"certNo\\\\\\")\\\\n\\"\\n },\\n \\"CloudIdPProviderConfig\\": {\\n \\"IdentityProviderId\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
],
'ListGroups' => [
'summary' => 'List EIAM account groups.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas1LGU5E'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'GroupIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Group ID list.',
'type' => 'array',
'items' => ['description' => 'Group ID.', 'type' => 'string', 'required' => false, 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Group name. The query uses exact matching.', 'type' => 'string', 'example' => 'name_test', 'required' => false],
],
[
'name' => 'GroupNameStartsWith',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Group name prefix. The query uses prefix matching.', 'type' => 'string', 'example' => 'name', 'required' => false],
],
[
'name' => 'GroupExternalId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Group external ID.', 'type' => 'string', 'example' => 'group_external_id', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'Total number of matched entries. The maximum number of entries returned in a single request is determined by pageSize.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Groups' => [
'description' => 'Account group list.',
'type' => 'array',
'items' => [
'description' => 'Account group object.',
'type' => 'object',
'properties' => [
'GroupId' => ['title' => '', 'description' => 'Group ID.', 'type' => 'string', 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
'GroupName' => ['title' => '', 'description' => 'Group name.', 'type' => 'string', 'example' => 'group_name'],
'Description' => ['title' => '', 'description' => 'Group description.', 'type' => 'string', 'example' => 'test group'],
'GroupExternalId' => ['title' => '', 'description' => 'Group external ID, used for association with external systems. Defaults to the account group ID.', 'type' => 'string', 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
'GroupSourceType' => ['title' => '', 'description' => 'Group source type. Currently, only self-built is supported. Valid values:'."\n"
.'- build_in: self-built.', 'type' => 'string', 'example' => 'build_in'],
'GroupSourceId' => ['title' => '', 'description' => 'Group source ID. If created by importing from other sources, this is the external source ID. Defaults to the instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'CreateTime' => ['title' => '', 'description' => 'Group creation time in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'UpdateTime' => ['title' => '', 'description' => 'Group last update time in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'InstanceId' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List EIAM Account Group Information',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroups'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"Groups\\": [\\n {\\n \\"GroupId\\": \\"group_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"GroupName\\": \\"group_name\\",\\n \\"Description\\": \\"test group\\",\\n \\"GroupExternalId\\": \\"group_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"GroupSourceType\\": \\"build_in\\",\\n \\"GroupSourceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"CreateTime\\": 1652085686179,\\n \\"UpdateTime\\": 1652085686179,\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListGroupsForApplication' => [
'summary' => 'Performs a paged query to list the groups authorized to access an application. The response returns the group IDs. To obtain detailed information for a group, you can call the GetGroup operation.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas7VNWU7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number of the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'title' => '', 'required' => false],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'GroupIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'A list of group IDs. You can specify up to 100 group IDs in a single operation.',
'type' => 'array',
'items' => ['description' => 'The group ID.', 'type' => 'string', 'required' => false, 'example' => 'group_miu8e4t4d7i4u7uwezgr54xxxx', 'title' => ''],
'required' => false,
'example' => 'group_miu8e4t4d7i4u7uwezgr54xxxx',
],
],
[
'name' => 'ApplicationRoleId',
'in' => 'query',
'schema' => ['description' => 'The application role ID.', 'type' => 'string', 'example' => 'app_role_mkv7rgt4ds8d8v0qtzev2mxxxx', 'maxLength' => 64, 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'Groups' => [
'description' => 'The list of groups.',
'type' => 'array',
'items' => [
'description' => 'The ID of the group.',
'type' => 'object',
'properties' => [
'GroupId' => ['description' => 'The group ID.', 'type' => 'string', 'example' => 'group_miu8e4t4d7i4u7uwezgr54xxxx', 'title' => ''],
'ApplicationRoles' => [
'description' => 'The list of application roles. This parameter is not returned for SAML applications.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApplicationRoleId' => ['description' => 'The ID of the application role.', 'type' => 'string', 'example' => 'app_role_mkv7rgt4ds8d8v0qtzev2mxxxx', 'title' => ''],
],
'description' => 'The application role object.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"Groups\\": [\\n {\\n \\"GroupId\\": \\"group_miu8e4t4d7i4u7uwezgr54xxxx\\",\\n \\"ApplicationRoles\\": [\\n {\\n \\"ApplicationRoleId\\": \\"app_role_mkv7rgt4ds8d8v0qtzev2mxxxx\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListGroupsForApplication',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupsForApplication'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListGroupsForApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
],
'ListGroupsForAuthorizationRule' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to start the next paged query.'."\n"
."\n"
.'- If you do not specify this parameter, the query starts from the first page.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'title' => '', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return on each page.'."\n"
."\n"
.'- Default value: 20.'."\n"
."\n"
.'- The value cannot exceed 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'title' => '', 'required' => false],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The filter conditions.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the filter field. Valid values:'."\n"
."\n"
.'- GroupId: The group ID.', 'type' => 'string', 'example' => 'GroupId', 'title' => '', 'required' => false],
'Value' => [
'description' => 'The values of the filter field.',
'type' => 'array',
'items' => ['description' => 'The value of the filter field.', 'type' => 'string', 'required' => false, 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx', 'title' => ''],
'example' => '',
'title' => '',
'required' => false,
],
],
'description' => 'The filter conditions.',
'required' => false,
'title' => '',
'example' => '',
],
'example' => '',
'title' => '',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'NextToken' => ['description' => 'The token that is returned for the next page.', 'type' => 'string', 'example' => 'NTxxxexample', 'title' => ''],
'MaxResults' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'Groups' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'title' => ''],
'GroupId' => ['description' => 'The group ID.', 'type' => 'string', 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx', 'title' => ''],
'ValidityType' => ['description' => 'The type of the validity period of the relationship. Valid values:'."\n"
."\n"
.'- permanent: permanent'."\n"
."\n"
.'- time\\_bound: custom time range', 'type' => 'string', 'title' => '', 'example' => 'permanent'],
'ValidityPeriod' => [
'description' => 'The time range of the validity period. This parameter takes effect only when **ValidityType** is set to **time\\_bound**.',
'type' => 'object',
'properties' => [
'StartTime' => ['description' => 'The start time of the validity period. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1704042061000'],
'EndTime' => ['description' => 'The end time of the validity period. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1704042061000'],
],
'title' => '',
'example' => '',
],
],
'description' => 'The group data object.',
'title' => '',
'example' => '',
],
'description' => 'The list of groups.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListGroupsForAuthorizationRule',
'summary' => 'Lists the groups associated with an authorization rule.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListGroupsForAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/AuthorizationRule/{#AuthorizationRuleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"Groups\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"GroupId\\": \\"group_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"ValidityType\\": \\"permanent\\",\\n \\"ValidityPeriod\\": {\\n \\"StartTime\\": 1704042061000,\\n \\"EndTime\\": 1704042061000\\n }\\n }\\n ]\\n}","type":"json"}]',
],
'ListGroupsForResourceServer' => [
'summary' => 'Lists the scopes authorized for groups on a specified resource server. This operation supports cursor-based pagination.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token for the next page of results. You do not need to provide this parameter for the first request. For subsequent requests, set this to the `NextToken` value from the previous response.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'title' => '', 'required' => false],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource server application.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => 'The name of the filter condition. The only valid value is GroupIds.',
'type' => 'string',
'example' => 'GroupIds',
'enum' => ['GroupIds', 'GroupId'],
'title' => '',
'required' => false,
],
'Value' => [
'type' => 'array',
'items' => ['description' => 'A value for the filter condition.', 'type' => 'string', 'example' => 'group_mkv7rgt4d7i4u7zqtzev2mxxxx', 'title' => '', 'required' => false],
'maxItems' => 100,
'minItems' => 1,
'description' => 'The values for the filter condition.',
'required' => false,
'title' => '',
'example' => '',
],
],
'description' => 'A filter condition.',
'required' => false,
'title' => '',
'example' => '',
],
'title' => '',
'description' => 'The filter conditions.',
'required' => false,
'example' => '',
],
],
[
'name' => 'ResourceServerScopeId',
'in' => 'query',
'schema' => ['description' => 'The ID of the scope.', 'type' => 'string', 'example' => 'ress_nbte4bb3qqqnaq73rlmkqixxxx', 'maxLength' => 64, 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries that meet the filter criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'NextToken' => ['description' => 'The token to retrieve the next page of results. A null or empty value indicates that all results have been returned.', 'type' => 'string', 'example' => 'NTxxxexample', 'title' => ''],
'Groups' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'idaas_qsw77zl5vrllwzyrrfwbmpxxxx', 'title' => ''],
'GroupId' => ['description' => 'The ID of the group.', 'type' => 'string', 'example' => 'group_nbsomva32b6utec3hgi7scxxxx', 'title' => ''],
'ResourceServerScopes' => [
'description' => 'The list of authorized scopes.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ResourceServerScopeId' => ['description' => 'The ID of the scope.', 'type' => 'string', 'example' => 'ress_nbte4bb3qqqnaq73rlmkqixxxx', 'title' => ''],
'ResourceServerScopeName' => ['description' => 'The name of the scope.', 'type' => 'string', 'example' => 'Read User Info', 'title' => ''],
],
'description' => 'Information about a scope.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => 'Information about a group.',
'title' => '',
'example' => '',
],
'description' => 'The list of groups.',
'title' => '',
'example' => '',
],
'MaxResults' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListGroupsForResourceServer',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"Groups\\": [\\n {\\n \\"InstanceId\\": \\"idaas_qsw77zl5vrllwzyrrfwbmpxxxx\\",\\n \\"GroupId\\": \\"group_nbsomva32b6utec3hgi7scxxxx\\",\\n \\"ResourceServerScopes\\": [\\n {\\n \\"ResourceServerScopeId\\": \\"ress_nbte4bb3qqqnaq73rlmkqixxxx\\",\\n \\"ResourceServerScopeName\\": \\"Read User Info\\"\\n }\\n ]\\n }\\n ],\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
],
'ListGroupsForUser' => [
'summary' => 'Queries the list of account groups to which a specified EIAM account belongs.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '165221',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page size. Default value: 20. Maximum value: 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of matching records. The maximum number of records returned per page is determined by PageSize.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'Groups' => [
'description' => 'The list of account groups.',
'type' => 'array',
'items' => [
'description' => 'The account group object information.',
'type' => 'object',
'properties' => [
'GroupId' => ['title' => '', 'description' => 'The account group ID.', 'type' => 'string', 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
'GroupMemberRelationSourceId' => ['description' => 'The source ID of the group member relationship.'."\n"
."\n"
.'For the build_in type, this defaults to the instance ID. For other types, this corresponds to the enterprise ID of the respective source. For example, for a DingTalk source, this corresponds to the corpId of the DingTalk enterprise.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'title' => ''],
'GroupMemberRelationSourceType' => ['description' => 'The source type of the group member relationship. Valid values:'."\n"
."\n"
.'build_in: built-in.'."\n"
."\n"
.'ding_talk: imported from DingTalk.'."\n"
."\n"
.'ad: imported from AD.'."\n"
."\n"
.'ldap: imported from LDAP.'."\n"
."\n"
.'we_com: imported from WeCom.', 'type' => 'string', 'example' => 'build_in', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List account groups of an EIAM account',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupsForUser'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 1000,\\n \\"Groups\\": [\\n {\\n \\"GroupId\\": \\"group_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"GroupMemberRelationSourceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"GroupMemberRelationSourceType\\": \\"build_in\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListIdentityProviders' => [
'summary' => 'Query the list of identity providers.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasOO9F76'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The direction of the identity provider.',
'enumValueTitles' => ['pull' => 'Inbound', 'push' => 'Outbound'],
'type' => 'string',
'example' => 'pull',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'Total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'IdentityProviders' => [
'description' => 'List of identity provider information.',
'type' => 'array',
'items' => [
'description' => 'Identity provider information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'example' => 'idaas_pbf4dth34l2qb7mydpntXXX'],
'IdentityProviderId' => ['title' => '', 'description' => 'Identity provider ID.', 'type' => 'string', 'example' => 'idp_m5b5wd5s2hpq4t6iaehhXXX'],
'IdentityProviderExternalId' => ['title' => '', 'description' => 'External ID of the identity provider.', 'type' => 'string', 'example' => 'test_123'],
'Description' => ['title' => '', 'description' => 'Description of the identity provider.', 'type' => 'string', 'example' => 'None'],
'IdentityProviderName' => ['title' => '', 'description' => 'Name of the identity provider.', 'type' => 'string', 'example' => 'xxxx'."\n"],
'UdPullStatus' => ['title' => '', 'description' => 'Whether the inbound sync feature is supported. Valid values:'."\n"
."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'disabled'],
'AuthnSourceType' => ['title' => '', 'description' => 'The authentication source type, OIDC or SAML. Valid values:'."\n"
."\n"
.'- OIDC: urn:alibaba:idaas:authntype:oidc'."\n"
."\n"
.'- SAML: urn:alibaba:idaas:authntype:saml2', 'type' => 'string', 'example' => 'urn:alibaba:idaas:authntype:oidc'],
'AuthnSourceSupplier' => ['title' => '', 'description' => 'The authentication source product, such as Okta, Google, or Azure AD.'."\n"
.'Valid values:'."\n"
."\n"
.'- DingTalk: urn:alibaba:idaas:idp:alibaba:dingtalk'."\n"
."\n"
.'- LDAP: urn:alibaba:idaas:idp:unknown:ldap'."\n"
."\n"
.'- Alibaba Cloud IDaaS: urn:alibaba:idaas:idp:alibaba:idaas'."\n"
."\n"
.'- WeCom: urn:alibaba:idaas:idp:tencent:wecom'."\n"
."\n"
.'- Lark: urn:alibaba:idaas:idp:bytedance:lark'."\n"
."\n"
.'- Active Directory: urn:alibaba:idaas:idp:microsoft:ad'."\n"
."\n"
.'- Azure Active Directory: urn:alibaba:idaas:idp:microsoft:aad'."\n"
."\n"
.'- Alibaba Cloud SASE: urn:alibaba:idaas:idp:alibaba:sase', 'type' => 'string', 'example' => 'urn:alibaba:idaas:idp:bytedance:lark'],
'AuthnStatus' => ['title' => '', 'description' => 'Whether the corresponding IdP supports authentication. Valid values:'."\n"
."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'disabled'],
'IncrementalCallbackStatus' => ['title' => '', 'description' => 'The incremental callback status, indicating whether incremental callback data from the IdP is processed. Valid values:'."\n"
."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'enabled'],
'UdPullTargetScope' => ['title' => '', 'description' => 'The target node for synchronization.', 'type' => 'string', 'example' => 'ou_2buqmxsa3ltyqkjgpwfijurXXX'],
'IdentityProviderType' => ['title' => '', 'description' => 'The synchronization type of the identity provider.'."\n"
."\n"
.'- Inbound DingTalk: urn:alibaba:idaas:idp:alibaba:dingtalk:pull'."\n"
."\n"
.'- Outbound DingTalk: urn:alibaba:idaas:idp:alibaba:dingtalk:push'."\n"
."\n"
.'- Inbound WeCom: urn:alibaba:idaas:idp:tencent:wecom:pull'."\n"
."\n"
.'- Inbound Lark: urn:alibaba:idaas:idp:bytedance:lark:pull'."\n"
."\n"
.'- Inbound AD: urn:alibaba:idaas:idp:microsoft:ad:pull'."\n"
."\n"
.'- Inbound LDAP: urn:alibaba:idaas:idp:unknown:ldap:pull'."\n"
."\n"
.'- Standard OIDC: urn:alibaba:idaas:idp:standard:oidc'."\n"
."\n"
.'- SASE Customized OIDC: urn:alibaba:idaas:idp:alibaba:sase', 'type' => 'string', 'example' => 'urn:alibaba:idaas:idp:bytedance:lark:pull'],
'AdvancedStatus' => ['title' => '', 'description' => 'Whether the advanced configuration is enabled. Valid values:'."\n"
."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'disabled'],
'UdPushStatus' => ['title' => '', 'description' => 'Whether the outbound sync feature is enabled. Valid values:'."\n"
."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'disabled'],
'LockReason' => ['title' => '', 'description' => 'The lock reason.', 'type' => 'string', 'example' => 'financial'],
'LastStatusCheckJobResult' => ['description' => 'The last status check result. Before synchronization, a sync task can only be triggered when the identity provider status check result is success.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'CreateTime' => ['description' => 'The creation time, in Unix timestamp format, measured in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1712561597000', 'title' => ''],
'UpdateTime' => ['description' => 'The update time, in Unix timestamp format, measured in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1712561597000', 'title' => ''],
'LogoUrl' => ['title' => '', 'description' => 'The custom logo URL of the identity provider.', 'type' => 'string', 'example' => 'https://cdn-cn-hangzhou.aliyunidaas.com/xx/logos/xx'],
'PeriodicSyncStatus' => ['title' => '', 'description' => 'The periodic sync status, indicating whether the data differences between EIAM and the identity provider are periodically checked.', 'type' => 'string', 'example' => 'disabled'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List Identity Providers',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIdentityProviders'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"IdentityProviders\\": [\\n {\\n \\"InstanceId\\": \\"idaas_pbf4dth34l2qb7mydpntXXX\\",\\n \\"IdentityProviderId\\": \\"idp_m5b5wd5s2hpq4t6iaehhXXX\\",\\n \\"IdentityProviderExternalId\\": \\"test_123\\",\\n \\"Description\\": \\"None\\",\\n \\"IdentityProviderName\\": \\"xxxx\\\\n\\",\\n \\"UdPullStatus\\": \\"disabled\\",\\n \\"AuthnSourceType\\": \\"urn:alibaba:idaas:authntype:oidc\\",\\n \\"AuthnSourceSupplier\\": \\"urn:alibaba:idaas:idp:bytedance:lark\\",\\n \\"AuthnStatus\\": \\"disabled\\",\\n \\"IncrementalCallbackStatus\\": \\"enabled\\",\\n \\"UdPullTargetScope\\": \\"ou_2buqmxsa3ltyqkjgpwfijurXXX\\",\\n \\"IdentityProviderType\\": \\"urn:alibaba:idaas:idp:bytedance:lark:pull\\",\\n \\"AdvancedStatus\\": \\"disabled\\",\\n \\"UdPushStatus\\": \\"disabled\\",\\n \\"LockReason\\": \\"financial\\",\\n \\"LastStatusCheckJobResult\\": \\"success\\",\\n \\"CreateTime\\": 1712561597000,\\n \\"UpdateTime\\": 1712561597000,\\n \\"LogoUrl\\": \\"https://cdn-cn-hangzhou.aliyunidaas.com/xx/logos/xx\\",\\n \\"PeriodicSyncStatus\\": \\"disabled\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListIdentityProvidersForNetworkAccessEndpoint' => [
'summary' => 'Retrieves information about Identity Providers (IdPs) for a network endpoint.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGNRASW'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The query token.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'title' => '', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'title' => '', 'required' => false],
],
[
'name' => 'NetworkAccessEndpointId',
'in' => 'query',
'schema' => ['description' => 'The network endpoint ID.', 'type' => 'string', 'required' => true, 'example' => 'nae_ms5ewjcjzed3ysaau5t5kxxxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'NextToken' => ['description' => 'The token that is returned from the call.', 'type' => 'string', 'example' => 'NTxxxexample', 'title' => ''],
'IdentityProvidersForNetworkAccessEndpoint' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'idaas_elk5evwagodqlmwpfehasxxxxx'],
'IdentityProviderId' => ['description' => 'The ID of the IdP.', 'type' => 'string', 'title' => '', 'example' => 'idp_nbq7i4ylodmm64iy6t5muxxxxx'],
'IdentityProviderName' => ['description' => 'The name of the IdP.', 'type' => 'string', 'title' => '', 'example' => 'OIDC Provider'],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => 'The collection of IdPs for the network endpoint.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListIdentityProvidersForNetworkAccessEndpoint',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListIdentityProvidersForNetworkAccessEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"IdentityProvidersForNetworkAccessEndpoint\\": [\\n {\\n \\"InstanceId\\": \\"idaas_elk5evwagodqlmwpfehasxxxxx\\",\\n \\"IdentityProviderId\\": \\"idp_nbq7i4ylodmm64iy6t5muxxxxx\\",\\n \\"IdentityProviderName\\": \\"OIDC Provider\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListInstances' => [
'summary' => 'Queries information about one or more EIAM instances.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6GKEFM'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of instance IDs.',
'type' => 'array',
'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance status. Valid values:'."\n"
.'- creating: Being created.'."\n"
.'- running: Running.', 'type' => 'string', 'example' => 'running', 'required' => false],
],
[
'name' => 'Edition',
'in' => 'query',
'schema' => ['description' => 'The license edition. Valid values:'."\n"
.'- free: Free Edition.'."\n"
.'- trial: Trial Edition.'."\n"
.'- scalability: Scalability Edition.'."\n"
.'- standard: Standard Edition.'."\n"
.'- enterprise: Enterprise Edition.', 'type' => 'string', 'required' => false, 'example' => 'free', 'title' => ''],
],
[
'name' => 'CrossRegionReplication',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The cross-region replication status.', 'type' => 'string', 'example' => 'disabled', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Instances' => [
'description' => 'The list of instance information.',
'type' => 'array',
'items' => [
'description' => 'The instance information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_eypq6ljgyeuwmlw672sulxxxxx'],
'CreateTime' => ['title' => '', 'description' => 'The instance creation time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1550115455000'],
'Status' => ['title' => '', 'description' => 'The instance status. Valid values:'."\n"
.'- creating: Being created.'."\n"
.'- running: Running.', 'type' => 'string', 'example' => 'running'],
'Description' => ['title' => '', 'description' => 'The instance description.', 'type' => 'string', 'example' => 'instance_for_test'],
'DefaultEndpoint' => [
'title' => '',
'description' => 'The default endpoint of the instance.',
'type' => 'object',
'properties' => [
'Endpoint' => ['title' => '', 'description' => 'The endpoint address of the instance.', 'type' => 'string', 'example' => 'example-xxx.aliyunidaas.com'."\n"],
'Status' => ['title' => '', 'description' => 'The endpoint status. Valid values:'."\n"
.'- resolved: Resolved.'."\n"
.'- unresolved: Not resolved.', 'type' => 'string', 'example' => 'resolved'],
],
'example' => '',
],
'ServiceManaged' => ['title' => '', 'description' => 'Indicates whether the instance is managed by an Alibaba Cloud service.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'ManagedServiceCode' => ['title' => '', 'description' => 'The service code of the Alibaba Cloud service that manages the instance.', 'type' => 'string', 'example' => 'sase'],
'CrossRegionReplication' => ['title' => '', 'description' => 'Indicates whether cross-region replication is enabled. Valid values: enabled or disabled.', 'type' => 'string', 'example' => 'enabled'],
'CrossRegionReplicationRole' => ['title' => '', 'description' => 'The cross-region replication role. Valid values: primary (primary instance) or backup (backup instance).', 'type' => 'string', 'example' => 'primary'],
'InstanceFailoverStatus' => ['title' => '', 'description' => 'The instance failover activation status. Valid values: active (activated) or inactive (not activated).', 'type' => 'string', 'example' => 'inactive'],
'ReplicationConfiguration' => [
'title' => '',
'description' => 'The replication configuration. This parameter is returned only when CrossRegionReplication is set to enabled.',
'type' => 'object',
'properties' => [
'ReplicationCreateTime' => ['title' => '', 'description' => 'The time when the disaster recovery data replication was created, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1778499337000'],
'PrimaryInstanceId' => ['title' => '', 'description' => 'The instance ID of the primary instance.', 'type' => 'string', 'example' => 'idaas_xxxxxx'],
'PrimaryInstanceRegionId' => ['title' => '', 'description' => 'The region ID of the primary instance.', 'type' => 'string', 'example' => 'cn-hangzhou'],
'BackupInstanceId' => ['title' => '', 'description' => 'The instance ID of the backup instance.', 'type' => 'string', 'example' => 'idaas_xxxxxx'],
'BackupInstanceRegionId' => ['title' => '', 'description' => 'The region ID of the backup instance.', 'type' => 'string', 'example' => 'cn-beijing'],
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"idaas_eypq6ljgyeuwmlw672sulxxxxx\\",\\n \\"CreateTime\\": 1550115455000,\\n \\"Status\\": \\"running\\",\\n \\"Description\\": \\"instance_for_test\\",\\n \\"DefaultEndpoint\\": {\\n \\"Endpoint\\": \\"example-xxx.aliyunidaas.com\\\\n\\",\\n \\"Status\\": \\"resolved\\"\\n },\\n \\"ServiceManaged\\": true,\\n \\"ManagedServiceCode\\": \\"sase\\",\\n \\"CrossRegionReplication\\": \\"enabled\\",\\n \\"CrossRegionReplicationRole\\": \\"primary\\",\\n \\"InstanceFailoverStatus\\": \\"inactive\\",\\n \\"ReplicationConfiguration\\": {\\n \\"ReplicationCreateTime\\": 1778499337000,\\n \\"PrimaryInstanceId\\": \\"idaas_xxxxxx\\",\\n \\"PrimaryInstanceRegionId\\": \\"cn-hangzhou\\",\\n \\"BackupInstanceId\\": \\"idaas_xxxxxx\\",\\n \\"BackupInstanceRegionId\\": \\"cn-beijing\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
'title' => 'List EIAM instances',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'],
],
],
'ramActions' => [],
],
'ListNetworkAccessEndpointAvailableRegions' => [
'summary' => 'Lists the available regions for creating network access endpoints in IDaaS EIAM.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasXM4LQ1'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'Regions' => [
'description' => 'The collection of available regions.',
'type' => 'array',
'items' => [
'description' => 'The region information.',
'type' => 'object',
'properties' => [
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'LocalName' => ['description' => 'The region name.', 'type' => 'string', 'example' => 'China (Hangzhou)', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LocalName\\": \\"China (Hangzhou)\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListNetworkAccessEndpointAvailableRegions',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNetworkAccessEndpointAvailableRegions'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListNetworkAccessEndpointAvailableRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListNetworkAccessEndpointAvailableZones' => [
'summary' => 'Queries the list of zones that support the creation of network endpoints in a specified region for IDaaS EIAM.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGNRASW'],
],
'parameters' => [
[
'name' => 'NaeRegionId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the region supported by dedicated network endpoints.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'Zones' => [
'description' => 'The list of zones that support network endpoints in the current region.',
'type' => 'array',
'items' => [
'description' => 'The zone information.',
'type' => 'object',
'properties' => [
'ZoneId' => ['title' => '', 'description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-j'],
'LocalName' => ['title' => '', 'description' => 'The zone name.', 'type' => 'string', 'example' => 'China (Hangzhou) Zone J'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query zones supported by network endpoints',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNetworkAccessEndpointAvailableZones'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListNetworkAccessEndpointAvailableZones',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Zones\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"LocalName\\": \\"China (Hangzhou) Zone J\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListNetworkAccessEndpoints' => [
'summary' => 'Lists the network endpoints for an IDaaS EIAM instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGNRASW'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token used for the next query. Set this parameter to the NextToken value returned from the previous API call. Leave this parameter empty for the first query.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'title' => '', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. The maximum value is 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'title' => '', 'required' => false],
],
[
'name' => 'NetworkAccessEndpointType',
'in' => 'query',
'schema' => ['description' => 'The type of the network endpoint. Valid values:'."\n"
."\n"
.'- shared: a shared network endpoint.'."\n"
."\n"
.'- private: a private network endpoint.'."\n"
."\n"
.'The default value is private.', 'type' => 'string', 'example' => 'private', 'default' => 'private', 'title' => '', 'required' => false],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'The ID of the VPC to which the private network endpoint is connected. This parameter does not take effect when NetworkAccessEndpointType is set to shared.', 'type' => 'string', 'example' => 'vpc-examplexxx', 'title' => '', 'required' => false],
],
[
'name' => 'VpcRegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the VPC to which the private network endpoint is connected. The value of this parameter must be a region returned by the ListNetworkAccessEndpointAvailableRegions operation. This parameter does not take effect when NetworkAccessEndpointType is set to shared.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => '', 'required' => false],
],
[
'name' => 'NetworkAccessEndpointStatus',
'in' => 'query',
'schema' => ['description' => 'The status of the network endpoint. Valid values:'."\n"
."\n"
.'- pending: The endpoint is pending initialization.'."\n"
."\n"
.'- creating: The endpoint is being created.'."\n"
."\n"
.'- running: The endpoint is running.'."\n"
."\n"
.'- deleting: The endpoint is being deleted.'."\n"
."\n"
.'This parameter does not take effect when NetworkAccessEndpointType is set to shared.', 'type' => 'string', 'example' => 'running', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'NextToken' => ['description' => 'The token returned for the next query.', 'type' => 'string', 'example' => 'NTxxxexample', 'title' => ''],
'NetworkAccessEndpoints' => [
'description' => 'A collection of network endpoints.',
'type' => 'array',
'items' => [
'description' => 'The network endpoint information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'title' => ''],
'NetworkAccessEndpointId' => ['description' => 'The network endpoint ID.', 'type' => 'string', 'example' => 'nae_examplexxx', 'title' => ''],
'NetworkAccessEndpointName' => [
'description' => 'The name of the network endpoint.',
'enumValueTitles' => [],
'type' => 'string',
'example' => 'VPC access endpoint for xx service',
'title' => '',
],
'VpcId' => ['description' => 'The ID of the VPC to which the private network endpoint is connected.', 'type' => 'string', 'example' => 'vpc-examplexxx', 'title' => ''],
'VpcRegionId' => ['description' => 'The region ID of the VPC to which the private network endpoint is connected.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'VSwitchIds' => [
'title' => '',
'description' => 'A list of vSwitches to which the private network endpoint is connected.',
'type' => 'array',
'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-2vc8z0f90z4k6xxxxx', 'title' => ''],
'example' => 'vsw-examplexxx',
],
'SecurityGroupId' => ['description' => 'The ID of the security group used by the private network endpoint.', 'type' => 'string', 'example' => 'sg-examplexxx', 'title' => ''],
'Status' => ['description' => 'The status of the network endpoint. Valid values:'."\n"
."\n"
.'- pending: The endpoint is pending initialization.'."\n"
."\n"
.'- creating: The endpoint is being created.'."\n"
."\n"
.'- running: The endpoint is running.'."\n"
."\n"
.'- deleting: The endpoint is being deleted.', 'type' => 'string', 'example' => 'running', 'title' => ''],
'NetworkAccessEndpointType' => ['description' => 'The type of the network endpoint. Valid values:'."\n"
."\n"
.'- shared: a shared network endpoint.'."\n"
."\n"
.'- private: a private network endpoint.', 'type' => 'string', 'example' => 'private', 'title' => ''],
'CreateTime' => ['description' => 'The time when the network endpoint was created. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000', 'title' => ''],
'UpdateTime' => ['description' => 'The time when the network endpoint was last updated. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"NetworkAccessEndpoints\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"NetworkAccessEndpointId\\": \\"nae_examplexxx\\",\\n \\"NetworkAccessEndpointName\\": \\"VPC access endpoint for xx service\\",\\n \\"VpcId\\": \\"vpc-examplexxx\\",\\n \\"VpcRegionId\\": \\"cn-hangzhou\\",\\n \\"VSwitchIds\\": [\\n \\"vsw-2vc8z0f90z4k6xxxxx\\"\\n ],\\n \\"SecurityGroupId\\": \\"sg-examplexxx\\",\\n \\"Status\\": \\"running\\",\\n \\"NetworkAccessEndpointType\\": \\"private\\",\\n \\"CreateTime\\": 1649830226000,\\n \\"UpdateTime\\": 1649830226000\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListNetworkAccessEndpoints',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNetworkAccessEndpoints'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListNetworkAccessEndpoints',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/*'],
],
],
],
],
],
'ListNetworkAccessPaths' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGNRASW'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NetworkAccessEndpointId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The dedicated network access endpoint ID.', 'type' => 'string', 'required' => true, 'example' => 'nae_examplexxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'NetworkAccessPaths' => [
'description' => 'The list of network access endpoint access paths.',
'type' => 'array',
'items' => [
'description' => 'The network access endpoint access path information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'NetworkAccessEndpointId' => ['title' => '', 'description' => 'The dedicated network access endpoint ID.', 'type' => 'string', 'example' => 'nae_examplexxx'],
'NetworkAccessPathId' => ['title' => '', 'description' => 'The ID of the dedicated network access endpoint access path.', 'type' => 'string', 'example' => 'nap_examplexxx'],
'NetworkInterfaceId' => ['title' => '', 'description' => 'The ENI ID used by the dedicated network access endpoint access path.', 'type' => 'string', 'example' => 'eni-examplexxx'],
'VSwitchId' => ['title' => '', 'description' => 'The vSwitch ID to which the ENI of the dedicated network access endpoint access path belongs.', 'type' => 'string', 'example' => 'vsw-examplexxx'],
'PrivateIpAddress' => ['title' => '', 'description' => 'The private endpoint of the ENI used by the dedicated network access endpoint access path on the private network.', 'type' => 'string', 'example' => 'cn-hangzhou'],
'Status' => ['title' => '', 'description' => 'The status of the dedicated network access endpoint access path. Valid values:'."\n"
.' '."\n"
.'- pending: pending initialization.'."\n"
.'- creating: being created.'."\n"
.'- running: running.'."\n"
.'- deleting: being deleted.', 'type' => 'string', 'example' => 'running'],
'CreateTime' => ['title' => '', 'description' => 'The time when the dedicated network access endpoint access path was created, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the dedicated network access endpoint access path was last updated, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query access paths of a network access endpoint',
'summary' => 'Queries the list of access paths under a specified network access endpoint.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNetworkAccessPaths'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListNetworkAccessPaths',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessPath', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}/networkaccesspath/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"NetworkAccessPaths\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"NetworkAccessEndpointId\\": \\"nae_examplexxx\\",\\n \\"NetworkAccessPathId\\": \\"nap_examplexxx\\",\\n \\"NetworkInterfaceId\\": \\"eni-examplexxx\\",\\n \\"VSwitchId\\": \\"vsw-examplexxx\\",\\n \\"PrivateIpAddress\\": \\"cn-hangzhou\\",\\n \\"Status\\": \\"running\\",\\n \\"CreateTime\\": 1649830226000,\\n \\"UpdateTime\\": 1649830226000\\n }\\n ]\\n}","type":"json"}]',
],
'ListNetworkZones' => [
'summary' => 'Queries the list of network zone objects.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231620',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'PreviousToken',
'in' => 'query',
'schema' => ['description' => 'The pagination token for the previous page.', 'type' => 'string', 'required' => false, 'example' => 'PTxxxxxexample', 'title' => ''],
],
[
'name' => 'NetworkZoneIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The collection of network zone IDs.',
'type' => 'array',
'items' => ['description' => 'The network zone ID.', 'type' => 'string', 'required' => false, 'example' => 'network_m6fbr2bcbcadu3bcdpgzcpxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token returned by this call.', 'type' => 'string', 'example' => 'NTxxxexample'],
'PreviousToken' => ['description' => 'The pagination token for the previous page.', 'type' => 'string', 'example' => 'PTxxxxxexample', 'title' => ''],
'NetworkZones' => [
'description' => 'The list of network zones.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'NetworkZoneId' => ['title' => '', 'description' => 'The network zone ID.', 'type' => 'string', 'example' => 'network_m223wbvc3sn3uakfnxvhbxxxxx'],
'NetworkZoneName' => ['title' => '', 'description' => 'The network zone name.', 'type' => 'string', 'example' => 'test_name'],
'Description' => ['title' => '', 'description' => 'The network zone description.', 'type' => 'string', 'example' => 'test'],
'NetworkZoneType' => [
'title' => '',
'description' => 'The network zone type.',
'enumValueTitles' => ['arn:alibaba:idaas:network:zone:classic' => 'Classic network.', 'arn:alibaba:idaas:network:zone:vpc' => 'Virtual private cloud (VPC).'],
'type' => 'string',
'example' => 'arn:alibaba:idaas:network:zone:classic',
],
'VpcId' => ['title' => '', 'description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp1usdmfqcgoy5ebxxxxx'],
'Ipv4Cidrs' => [
'description' => 'The IPv4 CIDR blocks of the network zone.',
'type' => 'array',
'items' => ['description' => 'The IPv4 address or CIDR block.', 'type' => 'string', 'example' => '140.xxx.11.0/xx', 'title' => ''],
'title' => '',
'example' => '',
],
'Ipv6Cidrs' => [
'description' => 'The IPv6 CIDR blocks of the network zone.',
'type' => 'array',
'items' => ['description' => 'The IPv6 address or CIDR block.', 'type' => 'string', 'example' => '2001:xxxx:4801:53::xx', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Query network zone objects',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListNetworkZones',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"PreviousToken\\": \\"PTxxxxxexample\\",\\n \\"NetworkZones\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"NetworkZoneId\\": \\"network_m223wbvc3sn3uakfnxvhbxxxxx\\",\\n \\"NetworkZoneName\\": \\"test_name\\",\\n \\"Description\\": \\"test\\",\\n \\"NetworkZoneType\\": \\"arn:alibaba:idaas:network:zone:classic\\",\\n \\"VpcId\\": \\"vpc-bp1usdmfqcgoy5ebxxxxx\\",\\n \\"Ipv4Cidrs\\": [\\n \\"140.xxx.11.0/xx\\"\\n ],\\n \\"Ipv6Cidrs\\": [\\n \\"2001:xxxx:4801:53::xx\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'ListOrganizationalUnitParents' => [
'summary' => 'Queries all ancestor organizations of a specified EIAM organization. The organizations in the result list are sorted in hierarchical order from the top level to the bottom level.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasZCZ2SC'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The organization ID.', 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'Parents' => [
'description' => 'The list of parent organizations.',
'type' => 'array',
'items' => [
'description' => 'The parent organization object.',
'type' => 'object',
'properties' => [
'OrganizationalUnitId' => ['title' => '', 'description' => 'The organization ID.', 'type' => 'string', 'example' => 'ou_4lag76zc2km5ssg5vsmm2lznvu'],
'ParentId' => ['title' => '', 'description' => 'The parent organization ID.', 'type' => 'string', 'example' => 'ou_x3beoyepv2ls5iwuge3xhjkwbm'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List all ancestor organizations of an EIAM organization',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrganizationalUnitParents'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Parents\\": [\\n {\\n \\"OrganizationalUnitId\\": \\"ou_4lag76zc2km5ssg5vsmm2lznvu\\",\\n \\"ParentId\\": \\"ou_x3beoyepv2ls5iwuge3xhjkwbm\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListOrganizationalUnits' => [
'summary' => 'Performs a paged query for EIAM organizational units.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas3S4NKL'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page number of the page to return. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries to return on each page. Default value: 20. Maximum value: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '20', 'example' => '20'],
],
[
'name' => 'OrganizationalUnitIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of organizational unit IDs. The number of IDs in the list cannot exceed 100.',
'type' => 'array',
'items' => ['description' => 'The organizational unit ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx'],
'required' => false,
'example' => '[ou_wovwffm62xifdziem7an7xxxxx]',
],
],
[
'name' => 'OrganizationalUnitName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The name of the organizational unit. An exact match is used for the query.', 'type' => 'string', 'required' => false, 'maxLength' => 64, 'example' => 'name_001'],
],
[
'name' => 'OrganizationalUnitNameStartsWith',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The prefix of the name of the organizational unit. A left-side match is used for the query.', 'type' => 'string', 'required' => false, 'maxLength' => 64, 'example' => 'name'],
],
[
'name' => 'ParentId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the parent organizational unit.', 'type' => 'string', 'required' => false, 'maxLength' => 64, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries that are returned. This value is the total number of matched entries. The maximum number of entries that can be returned in a single request is specified by PageSize.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'OrganizationalUnits' => [
'description' => 'The list of organizational units.',
'type' => 'array',
'items' => [
'description' => 'The data object of the organizational unit.',
'type' => 'object',
'properties' => [
'OrganizationalUnitId' => ['title' => '', 'description' => 'The organizational unit ID.', 'type' => 'string', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx'],
'OrganizationalUnitName' => ['title' => '', 'description' => 'The name of the organizational unit.', 'type' => 'string', 'example' => 'test_organizationalUnit_name'],
'ParentId' => ['title' => '', 'description' => 'The ID of the parent organizational unit.', 'type' => 'string', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx'],
'OrganizationalUnitExternalId' => ['title' => '', 'description' => 'The external ID of the organizational unit. This ID is used to map the data of the organizational unit to the data of an external system. By default, the value of this parameter is the organizational unit ID.'."\n"
."\n"
.'Note: The external ID must be unique within the same source type and source ID.', 'type' => 'string', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx'],
'OrganizationalUnitSourceType' => ['title' => '', 'description' => 'The source type of the organizational unit. Valid values:'."\n"
."\n"
.'- build\\_in: The organizational unit is created in IDaaS.'."\n"
.'- ding\\_talk: The organizational unit is imported from DingTalk.'."\n"
.'- ad: The organizational unit is imported from Active Directory (AD).'."\n"
.'- ldap: The organizational unit is imported from a Lightweight Directory Access Protocol (LDAP) directory.'."\n"
.'- we\\_com: The organizational unit is imported from WeCom.', 'type' => 'string', 'example' => 'build_in'],
'OrganizationalUnitSourceId' => ['title' => '', 'description' => 'The source ID of the organizational unit.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'CreateTime' => ['title' => '', 'description' => 'The time when the organizational unit was created. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the organizational unit was last updated. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'Description' => ['title' => '', 'description' => 'The description of the organizational unit.', 'type' => 'string', 'example' => 'Test organization'],
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'Leaf' => ['title' => '', 'description' => 'Indicates whether the organizational unit is a leaf node. A value of true indicates that the organizational unit has no child nodes. A value of false indicates that the organizational unit has child nodes.', 'type' => 'boolean', 'example' => 'false'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 1000,\\n \\"OrganizationalUnits\\": [\\n {\\n \\"OrganizationalUnitId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"OrganizationalUnitName\\": \\"test_organizationalUnit_name\\",\\n \\"ParentId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"OrganizationalUnitExternalId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"OrganizationalUnitSourceType\\": \\"build_in\\",\\n \\"OrganizationalUnitSourceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"CreateTime\\": 1652085686179,\\n \\"UpdateTime\\": 1652085686179,\\n \\"Description\\": \\"Test organization\\",\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"Leaf\\": false\\n }\\n ]\\n}","type":"json"}]',
'title' => 'ListOrganizationalUnits',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrganizationalUnits'],
],
],
'ramActions' => [],
],
'ListOrganizationalUnitsForApplication' => [
'summary' => 'Performs a paged query to list the organizations that are granted access to an application. The response returns the IDs of the organizations. To obtain detailed information about a specific organization, call the GetOrganizationalUnit operation.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas3S4NKL'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'title' => '', 'required' => false],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'OrganizationalUnitIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of organization IDs. A single request can contain up to 100 organization IDs.',
'type' => 'array',
'items' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => false, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'title' => ''],
'required' => false,
'example' => 'ou_wovwffm62xifdziem7an7xxxxx',
],
],
[
'name' => 'ApplicationRoleId',
'in' => 'query',
'schema' => ['description' => '应用角色ID。', 'type' => 'string', 'example' => 'app_role_mkv7rgt4ds8d8v0qtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'OrganizationalUnits' => [
'description' => 'The list of organizations.',
'type' => 'array',
'items' => [
'description' => 'The ID of the organization.',
'type' => 'object',
'properties' => [
'OrganizationalUnitId' => ['description' => 'The organization ID.', 'type' => 'string', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'title' => ''],
'ApplicationRoles' => [
'description' => 'The list of application roles.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApplicationRoleId' => ['description' => 'The ID of the application role.', 'type' => 'string', 'example' => 'app_role_mkv7rgt4ds8d8v0qtzev2mxxxx', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'ListOrganizationalUnitsForApplication',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrganizationalUnitsForApplication'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListOrganizationalUnitsForApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"OrganizationalUnits\\": [\\n {\\n \\"OrganizationalUnitId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"ApplicationRoles\\": [\\n {\\n \\"ApplicationRoleId\\": \\"app_role_mkv7rgt4ds8d8v0qtzev2mxxxx\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'ListOrganizationalUnitsForResourceServer' => [
'summary' => 'Retrieves a cursor-paginated list of scopes that the current resource server has granted to an organization.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The pagination token. To retrieve the next page of results, set this parameter to the NextToken value from the previous response.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'title' => '', 'required' => false],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The resource server application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '500', 'minimum' => '1', 'example' => '20', 'default' => '20', 'required' => false, 'title' => ''],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => 'The filter key.',
'type' => 'string',
'example' => 'OrganizationalUnitIds',
'enum' => ['OrganizationalUnitIds', 'OrganizationalUnitId'],
'title' => '',
'required' => false,
],
'Value' => [
'type' => 'array',
'items' => ['description' => 'A filter value.', 'type' => 'string', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'required' => false, 'title' => ''],
'maxItems' => 100,
'minItems' => 1,
'description' => 'The list of filter values.',
'required' => false,
'title' => '',
'example' => '',
],
],
'description' => 'A filter condition.',
'required' => false,
'title' => '',
'example' => '',
],
'title' => '',
'description' => 'The list of filter conditions.',
'required' => false,
'example' => '',
],
],
[
'name' => 'ResourceServerScopeId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource server scope.', 'type' => 'string', 'example' => 'ress_nbte4bb3qqqnaq73rlmkqixxxx', 'maxLength' => 64, 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of results.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'NextToken' => ['description' => 'A token to retrieve the next page of results.', 'type' => 'string', 'example' => 'NTxxxexample', 'title' => ''],
'OrganizationalUnits' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_qsw77zl5vrllwzyrrfwbmpxxxx', 'title' => ''],
'OrganizationalUnitId' => ['description' => 'The organizational unit ID.', 'type' => 'string', 'example' => 'ou_nbsomva32b6utec3hgi7scxxxx', 'title' => ''],
'ResourceServerScopes' => [
'description' => 'A list of scopes.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ResourceServerScopeId' => ['description' => 'The scope ID.', 'type' => 'string', 'example' => 'ress_nbte4bb3qqqnaq73rlmkqixxxx', 'title' => ''],
'ResourceServerScopeName' => ['description' => 'The scope name.', 'type' => 'string', 'example' => 'Read User Info', 'title' => ''],
],
'description' => 'The details of a scope.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => 'The details of an organizational unit.',
'title' => '',
'example' => '',
],
'description' => 'A list of organizational units.',
'title' => '',
'example' => '',
],
'MaxResults' => ['description' => 'The maximum number of results per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListOrganizationalUnitsForResourceServer',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"OrganizationalUnits\\": [\\n {\\n \\"InstanceId\\": \\"idaas_qsw77zl5vrllwzyrrfwbmpxxxx\\",\\n \\"OrganizationalUnitId\\": \\"ou_nbsomva32b6utec3hgi7scxxxx\\",\\n \\"ResourceServerScopes\\": [\\n {\\n \\"ResourceServerScopeId\\": \\"ress_nbte4bb3qqqnaq73rlmkqixxxx\\",\\n \\"ResourceServerScopeName\\": \\"Read User Info\\"\\n }\\n ]\\n }\\n ],\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
],
'ListRegions' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasXM4LQ1'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'Regions' => [
'description' => 'The supported regions.',
'type' => 'array',
'items' => [
'description' => 'The supported region.',
'type' => 'object',
'properties' => [
'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'LocalName' => ['description' => 'The name of the region.', 'type' => 'string', 'example' => '华东1(杭州)', 'title' => ''],
'RegionEndpoint' => ['description' => 'The endpoint of the region.', 'type' => 'string', 'title' => '', 'example' => 'eiam.cn-hangzhou.aliyuncs.com'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'ListRegions',
'summary' => 'Queries a list of supported Alibaba Cloud regions.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LocalName\\": \\"华东1(杭州)\\",\\n \\"RegionEndpoint\\": \\"eiam.cn-hangzhou.aliyuncs.com\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListResourceServerScopes' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token (NextToken) used to retrieve the next page of results. Set this parameter to the NextToken value returned in the previous API call. Leave this parameter empty for the first query.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ResourceServerScopeName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The scope permission name.', 'type' => 'string', 'example' => '读取全部用户', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'ResourceServerScopeValue',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The scope permission value.', 'type' => 'string', 'example' => 'User:Write:ALL', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'PreviousToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token for the previous page. Set this parameter to the PreviousToken value returned in the previous API call.', 'type' => 'string', 'example' => 'PTxxxxxexample', 'required' => false],
],
[
'name' => 'ResourceServerScopeType',
'in' => 'query',
'schema' => [
'description' => 'The scope permission type.',
'enumValueTitles' => ['urn:alibaba:idaas:resourceserver:scope:application' => 'Machine permission.', 'urn:alibaba:idaas:resourceserver:scope:application_delegated' => 'urn:alibaba:idaas:resourceserver:scope:application_delegated', 'urn:alibaba:idaas:resourceserver:scope:delegated' => 'User permission.'],
'type' => 'string',
'maxLength' => 256,
'required' => false,
'example' => 'urn:alibaba:idaas:resourceserver:scope:delegated',
'title' => '',
],
],
[
'name' => 'AuthorizationType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The authorization type.',
'enumValueTitles' => ['authorize_required' => 'Manual authorization.', 'default_all' => 'Automatic authorization.'],
'type' => 'string',
'example' => 'authorize_required',
'enum' => ['authorize_required', 'default_all'],
'required' => false,
],
],
[
'name' => 'ResourceServerScopeIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The list of scope permission IDs.',
'type' => 'array',
'items' => ['description' => 'The scope permission ID.', 'type' => 'string', 'required' => false, 'example' => 'ress_neg35flu6byysxwutaxu3dxxxx', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token for the next page.', 'type' => 'string', 'example' => 'NTxxxexample'],
'MaxResults' => ['description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'ResourceServerScopes' => [
'description' => 'The list of scope permissions under the ResourceServer.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_xxxxxxxxxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_xxxxxxxxxxx'],
'ResourceServerScopeId' => ['title' => '', 'description' => 'The scope permission ID.', 'type' => 'string', 'example' => 'rss_xxxxxxxxxxx'],
'ResourceServerScopeName' => ['title' => '', 'description' => 'The scope permission name.', 'type' => 'string', 'example' => '读取全部用户'],
'ResourceServerScopeValue' => ['title' => '', 'description' => 'The scope permission value.', 'type' => 'string', 'example' => 'User:Write:ALL'],
'ResourceServerScopeType' => ['title' => '', 'description' => 'The scope permission type.', 'type' => 'string', 'example' => 'urn:alibaba:idaas:resourceserver:scope:delegated'],
'AuthorizationType' => [
'title' => '',
'description' => 'The authorization type.',
'enumValueTitles' => ['authorize_required' => 'Manual authorization.', 'default_all' => 'Automatic authorization.'],
'type' => 'string',
'example' => 'authorize_required',
'enum' => ['authorize_required', 'default_all'],
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PreviousToken' => ['title' => '', 'description' => 'The pagination token for the previous page.', 'type' => 'string', 'example' => 'PTxxxexample'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query scope permissions under a specified resourceServer',
'summary' => 'Queries the list of scope permissions under a specified ResourceServer by using a cursor.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListResourceServerScopes',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ResourceServerScope', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/resourceserverscope/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"ResourceServerScopes\\": [\\n {\\n \\"InstanceId\\": \\"idaas_xxxxxxxxxxx\\",\\n \\"ApplicationId\\": \\"app_xxxxxxxxxxx\\",\\n \\"ResourceServerScopeId\\": \\"rss_xxxxxxxxxxx\\",\\n \\"ResourceServerScopeName\\": \\"读取全部用户\\",\\n \\"ResourceServerScopeValue\\": \\"User:Write:ALL\\",\\n \\"ResourceServerScopeType\\": \\"urn:alibaba:idaas:resourceserver:scope:delegated\\",\\n \\"AuthorizationType\\": \\"authorize_required\\"\\n }\\n ],\\n \\"PreviousToken\\": \\"PTxxxexample\\"\\n}","type":"json"}]',
],
'ListResourceServersForUser' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas60YEMV'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token. Set this parameter to the NextToken value returned in the previous API call.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'required' => true, 'example' => 'user_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of filter conditions.',
'type' => 'array',
'items' => [
'description' => 'The filter condition.',
'type' => 'object',
'properties' => [
'Name' => [
'title' => '',
'description' => 'The name of the filter condition.',
'type' => 'string',
'example' => 'ApplicationIds',
'enum' => ['ApplicationIds'],
'required' => false,
],
'Value' => [
'title' => '',
'description' => 'The list of filter condition values.',
'type' => 'array',
'items' => ['title' => '', 'description' => 'The filter condition value.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'required' => false],
'required' => false,
'maxItems' => 100,
'minItems' => 1,
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The pagination token for the next page.', 'type' => 'string', 'example' => 'NTxxxexample'],
'ResourceServers' => [
'description' => 'The list of ResourceServer applications.',
'type' => 'array',
'items' => [
'description' => 'The ResourceServer application information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_qsw77zl5vrllwzyrrfwbmpxxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The ResourceServer application ID.', 'type' => 'string', 'example' => 'app_nbsomva32b6utec3hgi7scxxxx'],
'ResourceServerScopes' => [
'title' => '',
'description' => 'The list of authorized Scope permissions.',
'type' => 'array',
'items' => [
'description' => 'The Scope permission information.',
'type' => 'object',
'properties' => [
'ResourceServerScopeId' => ['title' => '', 'description' => 'The Scope permission ID.', 'type' => 'string', 'example' => 'ress_nbte4bb3qqqnaq73rlmkqixxxx'],
'ResourceServerScopeName' => ['title' => '', 'description' => 'The Scope permission name.', 'type' => 'string', 'example' => 'Read All User'],
'HasDirectAuthorization' => [
'title' => '',
'description' => 'Indicates whether direct authorization exists. Valid values:'."\n"
.'- true: Direct authorization exists.'."\n"
.'- false: Direct authorization does not exist.',
'enumValueTitles' => ['true' => 'Yes.', 'false' => 'No.'],
'type' => 'boolean',
'example' => 'true',
],
'HasInheritAuthorization' => [
'title' => '',
'description' => 'Indicates whether inherited authorization exists.',
'enumValueTitles' => ['true' => 'Yes.', 'false' => 'No.'],
'type' => 'boolean',
'example' => 'false',
],
],
'title' => '',
'example' => '',
],
'example' => '',
],
'ResourceServerIdentifier' => ['title' => '', 'description' => 'The unique identifier of the ResourceServer.', 'type' => 'string', 'example' => 'urn:idaas:test'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'MaxResults' => ['description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query resourceServer and scope permissions granted to the current account',
'summary' => 'Queries the list of ResourceServer and Scope permissions granted to the current account by using a cursor-based approach.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListResourceServersForUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"ResourceServers\\": [\\n {\\n \\"InstanceId\\": \\"idaas_qsw77zl5vrllwzyrrfwbmpxxxx\\",\\n \\"ApplicationId\\": \\"app_nbsomva32b6utec3hgi7scxxxx\\",\\n \\"ResourceServerScopes\\": [\\n {\\n \\"ResourceServerScopeId\\": \\"ress_nbte4bb3qqqnaq73rlmkqixxxx\\",\\n \\"ResourceServerScopeName\\": \\"Read All User\\",\\n \\"HasDirectAuthorization\\": true,\\n \\"HasInheritAuthorization\\": false\\n }\\n ],\\n \\"ResourceServerIdentifier\\": \\"urn:idaas:test\\"\\n }\\n ],\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
],
'ListSynchronizationJobs' => [
'summary' => 'Query the list of synchronization job details.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '117235',
'abilityTreeNodes' => ['FEATUREidaasLILYPH'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'PageNumber',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['title' => '', 'description' => 'Page number, starting from 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Page size. Maximum value: 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'required' => false],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Token for querying the next page. This parameter is not returned when there are no more pages.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Number of rows per page for paginated queries. Maximum value: 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'required' => false],
],
[
'name' => 'TargetType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Synchronization target type. Valid values:'."\n"
."\n"
.'- identity_provider: identity provider'."\n"
."\n"
.'- application: application', 'type' => 'string', 'example' => 'identity_provider', 'required' => false],
],
[
'name' => 'TargetIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'List of synchronization target IDs. [idp_111XXXX,idp_222XXXX]',
'type' => 'array',
'items' => ['description' => 'Synchronization target ID', 'type' => 'string', 'required' => false, 'example' => 'idp_my664lwkhpicbyzirog3xxxxx', 'title' => ''],
'required' => false,
'example' => 'target_001',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Synchronization start time in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'."\n"
."\n", 'required' => false],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Synchronization end time in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000', 'required' => false],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Synchronization job direction. Valid values:'."\n"
."\n"
.'- ingress: inbound'."\n"
."\n"
.'- egress: outbound', 'type' => 'string', 'example' => 'ingress', 'maxLength' => 64, 'required' => false],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Synchronization job status. Valid values:'."\n"
."\n"
.'- pending: initial state'."\n"
."\n"
.'- running: running'."\n"
."\n"
.'- failed: failed'."\n"
."\n"
.'- partial_success: partially succeeded'."\n"
."\n"
.'- success: succeeded', 'type' => 'string', 'example' => 'running', 'maxLength' => 64, 'required' => false],
],
[
'name' => 'Filters',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Filter parameters',
'type' => 'array',
'items' => [
'description' => 'Filter parameters',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'Dynamic parameter name', 'type' => 'string', 'required' => false, 'example' => 'qps', 'title' => ''],
'Values' => [
'description' => 'Dynamic parameter values',
'type' => 'array',
'items' => ['description' => 'Dynamic parameter values', 'type' => 'string', 'required' => false, 'example' => '[]', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'Total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The query token value returned by this request.', 'type' => 'string', 'example' => 'NTxxxexample'],
'SynchronizationJobs' => [
'description' => 'List of synchronization jobs',
'type' => 'array',
'items' => [
'description' => 'Synchronization job details.',
'type' => 'object',
'properties' => [
'SynchronizationJobId' => ['title' => '', 'description' => 'Synchronization job ID', 'type' => 'string', 'example' => 'sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx'."\n"],
'TargetType' => ['title' => '', 'description' => 'Synchronization target type. Valid values:'."\n"
."\n"
.'- identity_provider: identity provider'."\n"
."\n"
.'- application: application', 'type' => 'string', 'example' => 'identity_provider'],
'TargetId' => ['title' => '', 'description' => 'Synchronization target ID', 'type' => 'string', 'example' => 'idp_my664lwkhpicbyzirog3xxxxx'."\n"],
'Direction' => ['title' => '', 'description' => 'Synchronization job direction. Valid values:'."\n"
."\n"
.'- ingress: inbound'."\n"
."\n"
.'- egress: outbound', 'type' => 'string', 'example' => 'ingress'],
'StartTime' => ['title' => '', 'description' => 'Synchronization start time in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
'EndTime' => ['title' => '', 'description' => 'Synchronization end time in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
'TriggerType' => ['title' => '', 'description' => 'Synchronization trigger type. Valid values:'."\n"
."\n"
.'- auto: automatically triggered'."\n"
."\n"
.'- manual: manually triggered', 'type' => 'string', 'example' => 'auto'],
'Status' => ['title' => '', 'description' => 'Synchronization job status. Valid values:'."\n"
."\n"
.'- pending: initial state'."\n"
."\n"
.'- running: running'."\n"
."\n"
.'- failed: failed'."\n"
."\n"
.'- partial_success: partially succeeded'."\n"
."\n"
.'- success: succeeded', 'type' => 'string', 'example' => 'success'],
'Result' => [
'title' => '',
'description' => 'Synchronization job result',
'type' => 'object',
'properties' => [
'UserStatistics' => [
'title' => '',
'description' => 'User synchronization result statistics',
'type' => 'object',
'properties' => [
'Created' => [
'title' => '',
'description' => 'Creation result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Updated' => [
'title' => '',
'description' => 'Update result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Binded' => [
'title' => '',
'description' => 'Binding result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Deleted' => [
'title' => '',
'description' => 'Deletion result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Same' => [
'title' => '',
'description' => 'Unchanged result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Pushed' => [
'title' => '',
'description' => 'Push result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Exported' => [
'description' => 'Export result statistics',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
'Success' => ['description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'Failed' => ['description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'Skipped' => ['description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
'OrganizationalUnitStatistics' => [
'title' => '',
'description' => 'Organizational unit synchronization result statistics',
'type' => 'object',
'properties' => [
'Created' => [
'title' => '',
'description' => 'Creation result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Updated' => [
'title' => '',
'description' => 'Update result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Binded' => [
'title' => '',
'description' => 'Binding result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Deleted' => [
'title' => '',
'description' => 'Deletion result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Same' => [
'title' => '',
'description' => 'Unchanged result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Pushed' => [
'title' => '',
'description' => 'Push result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
],
'example' => '',
],
'GroupStatistics' => [
'title' => '',
'description' => 'Group synchronization result statistics',
'type' => 'object',
'properties' => [
'Created' => [
'title' => '',
'description' => 'Creation result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Updated' => [
'title' => '',
'description' => 'Update result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Binded' => [
'title' => '',
'description' => 'Binding result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Deleted' => [
'title' => '',
'description' => 'Deletion result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Same' => [
'title' => '',
'description' => 'Unchanged result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Pushed' => [
'title' => '',
'description' => 'Push result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
],
'example' => '',
],
'GroupMemberStatistics' => [
'title' => '',
'description' => 'Group member synchronization result statistics',
'type' => 'object',
'properties' => [
'Created' => [
'title' => '',
'description' => 'Creation result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Updated' => [
'title' => '',
'description' => 'Update result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Binded' => [
'title' => '',
'description' => 'Binding result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Deleted' => [
'title' => '',
'description' => 'Deletion result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Same' => [
'title' => '',
'description' => 'Unchanged result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
'Pushed' => [
'title' => '',
'description' => 'Push result statistics',
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'Success' => ['title' => '', 'description' => 'Success count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Failed' => ['title' => '', 'description' => 'Failure count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Skipped' => ['title' => '', 'description' => 'Skipped count', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'example' => '',
],
],
'example' => '',
],
'ErrorMessage' => ['title' => '', 'description' => 'Synchronization result error message', 'type' => 'string', 'example' => 'The specified parameter Username is required!'],
'ErrorCode' => ['title' => '', 'description' => 'Synchronization result error code', 'type' => 'string', 'example' => 'MissingParameter.Username'],
],
'example' => '',
],
'Description' => ['title' => '', 'description' => 'Synchronization job description', 'type' => 'string', 'example' => ' Description', 'maxLength' => 128],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List Synchronization Jobs',
'description' => 'The following two methods are supported for viewing returned data:'."\n"
."\n"
.'- Method 1: When querying the first page, you only need to set MaxResults to limit the number of entries returned. The NextToken in the response serves as the credential for querying subsequent pages. When querying subsequent pages, set the NextToken parameter to the NextToken value obtained from the previous response as the query credential, and set MaxResults to limit the number of entries returned. If there are no more pages, NextToken is no longer returned. The maximum value of MaxResults is 100.'."\n"
."\n"
.'- Method 2: Set the number of entries returned per page using PageSize, and set the page number using PageNumber.'."\n"
."\n"
.'You can only choose one of the above two methods. When a large number of entries are returned, Method 1 is recommended. If the MaxResults or NextToken parameter is set, the PageSize and PageNumber request parameters become invalid.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSynchronizationJobs'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListSynchronizationJobs',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'SynchronizationJob', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"SynchronizationJobs\\": [\\n {\\n \\"SynchronizationJobId\\": \\"sync_0000347vjovtcf41li0fgsd98gn24q9njxxxxx\\\\n\\",\\n \\"TargetType\\": \\"identity_provider\\",\\n \\"TargetId\\": \\"idp_my664lwkhpicbyzirog3xxxxx\\\\n\\",\\n \\"Direction\\": \\"ingress\\",\\n \\"StartTime\\": 1649830226000,\\n \\"EndTime\\": 1649830226000,\\n \\"TriggerType\\": \\"auto\\",\\n \\"Status\\": \\"success\\",\\n \\"Result\\": {\\n \\"UserStatistics\\": {\\n \\"Created\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Updated\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Binded\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Deleted\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Same\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Pushed\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Exported\\": {\\n \\"Total\\": 5,\\n \\"Success\\": 2,\\n \\"Failed\\": 2,\\n \\"Skipped\\": 1\\n }\\n },\\n \\"OrganizationalUnitStatistics\\": {\\n \\"Created\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Updated\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Binded\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Deleted\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Same\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Pushed\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n }\\n },\\n \\"GroupStatistics\\": {\\n \\"Created\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Updated\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Binded\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Deleted\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Same\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Pushed\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n }\\n },\\n \\"GroupMemberStatistics\\": {\\n \\"Created\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Updated\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Binded\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Deleted\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Same\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n },\\n \\"Pushed\\": {\\n \\"Total\\": 3,\\n \\"Success\\": 1,\\n \\"Failed\\": 1,\\n \\"Skipped\\": 1\\n }\\n },\\n \\"ErrorMessage\\": \\"The specified parameter Username is required!\\",\\n \\"ErrorCode\\": \\"MissingParameter.Username\\"\\n },\\n \\"Description\\": \\" Description\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListUserAuthnSourceMappings' => [
'summary' => 'Lists the mappings for third-party logon accounts.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The query token.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'title' => '', 'required' => false],
],
[
'name' => 'PreviousToken',
'in' => 'query',
'schema' => ['description' => 'The token for the previous page of results.', 'type' => 'string', 'example' => 'PTxxxxxexample', 'title' => '', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '20', 'default' => '20', 'title' => ''],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'user_ue2jvisn35exxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['description' => 'The ID of the source identity provider (IdP).', 'type' => 'string', 'example' => 'idp_11111', 'maxLength' => 64, 'title' => '', 'required' => false],
],
[
'name' => 'UserExternalId',
'in' => 'query',
'schema' => ['description' => 'The external ID.', 'type' => 'string', 'example' => 'xxxxxx', 'maxLength' => 64, 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'NextToken' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'example' => 'NTxxxexample', 'title' => ''],
'PreviousToken' => ['description' => 'The token to retrieve the previous page of results.', 'type' => 'string', 'example' => 'PTxxxexample', 'title' => ''],
'MaxResults' => ['description' => 'The maximum number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'example' => '20', 'title' => ''],
'UserAuthnSourceMappings' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'title' => '', 'example' => 'user_ue2jvisn35exxxxx'],
'UserExternalId' => ['description' => 'The external ID.', 'type' => 'string', 'title' => '', 'example' => 'xxxxxx'],
'AuthnSourceType' => ['description' => 'The authentication source type.', 'type' => 'string', 'title' => '', 'example' => 'urn:alibaba:idaas:authntype:oidc'],
'IdentityProviderId' => ['description' => 'The source IdP ID.', 'type' => 'string', 'title' => '', 'example' => 'idp_my664lwkhpicbyzirog3xxxxx'],
'CreateTime' => ['description' => 'The time when the binding was created.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1762309642177'],
'UpdateTime' => ['description' => 'The time when the binding was last updated.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1762309642177'],
'ExternalData' => ['description' => 'Information about the associated third-party account.', 'type' => 'string', 'example' => '{\\"userId\\":\\"xxxx\\",\\"name\\":\\"xxx\\",\\"bindTime\\":\\"1766050298872\\",\\"description\\":\\"bind request id: reqpre_xxx\\"}', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => 'A list of bindings for third-party account logons.',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListUserAuthnSourceMappings',
'description' => 'This operation queries only the applications that are directly assigned to an organization. You can use the **ApplicationIds** parameter to filter the applications.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListUserAuthnSourceMappings',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"PreviousToken\\": \\"PTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"UserAuthnSourceMappings\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"UserId\\": \\"user_ue2jvisn35exxxxx\\",\\n \\"UserExternalId\\": \\"xxxxxx\\",\\n \\"AuthnSourceType\\": \\"urn:alibaba:idaas:authntype:oidc\\",\\n \\"IdentityProviderId\\": \\"idp_my664lwkhpicbyzirog3xxxxx\\",\\n \\"CreateTime\\": 1762309642177,\\n \\"UpdateTime\\": 1762309642177,\\n \\"ExternalData\\": \\"{\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bindTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1766050298872\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"bind request id: reqpre_xxx\\\\\\\\\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListUsers' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasY4QW79'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries per page. Default value: 20. Maximum value: 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'UserIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of account IDs.',
'type' => 'array',
'items' => ['description' => 'The account ID.', 'type' => 'string', 'required' => false, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'title' => ''],
'required' => false,
'example' => '20',
],
],
[
'name' => 'UsernameStartsWith',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The username prefix. A left-match query is used.', 'type' => 'string', 'example' => 'name_001', 'maxLength' => 256, 'required' => false],
],
[
'name' => 'DisplayNameStartsWith',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The display name prefix. A left-match query is used.', 'type' => 'string', 'example' => 'name', 'maxLength' => 256, 'required' => false],
],
[
'name' => 'PhoneRegion',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The phone region code. Example: The region code for the Chinese mainland is 86, without the 00 or + prefix.', 'type' => 'string', 'example' => '86', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The phone number of the account.', 'type' => 'string', 'example' => '156xxxxxxx', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The email address of the account.', 'type' => 'string', 'example' => 'user@example.com', 'maxLength' => 256, 'required' => false],
],
[
'name' => 'UserExternalId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The external ID, which is used to associate external data with IDaaS accounts.'."\n"
."\n"
.'Note: The external ID must be unique within the same source type and source ID.', 'type' => 'string', 'example' => 'id_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 256, 'required' => false],
],
[
'name' => 'UserSourceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The source ID of the account.'."\n"
."\n"
.'For self-built accounts, the default value is the instance ID. For other types, the value corresponds to the enterprise ID of the respective source. For example, for a DingTalk source, the value corresponds to the corpId of the DingTalk enterprise.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 256, 'required' => false],
],
[
'name' => 'UserSourceType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The source type of the account. Valid values:'."\n"
.'- build\\_in: self-built.'."\n"
.'- ding\\_talk: imported from DingTalk.'."\n"
.'- ad: imported from AD.'."\n"
.'- ldap: imported from LDAP.'."\n"
.'- we\\_com: imported from WeCom.', 'type' => 'string', 'example' => 'build_in', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account status. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enable', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'OrganizationalUnitId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The organizational unit ID.', 'type' => 'string', 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64, 'required' => false],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'required' => false, 'example' => 'NTxxxxexample'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page for paging.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Users' => [
'description' => 'The list of account data.',
'type' => 'array',
'items' => [
'description' => 'The account data.',
'type' => 'object',
'properties' => [
'UserId' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx'],
'Username' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => 'name001'],
'DisplayName' => ['title' => '', 'description' => 'The display name of the account.', 'type' => 'string', 'example' => 'display_name001'],
'PasswordSet' => ['title' => '', 'description' => 'Indicates whether a password has been set.', 'type' => 'boolean', 'example' => 'false'],
'PhoneRegion' => ['title' => '', 'description' => 'The phone region code. Example: The region code for the Chinese mainland is 86, without the 00 or + prefix.', 'type' => 'string', 'example' => '86'],
'PhoneNumber' => ['title' => '', 'description' => 'The phone number of the account.', 'type' => 'string', 'example' => '156xxxxxxx'],
'PhoneNumberVerified' => ['title' => '', 'description' => 'Indicates whether the phone number has been verified. A value of true indicates that the phone number has been verified by the user or set as verified by the administrator. A value of false indicates that the phone number has not been verified.', 'type' => 'boolean', 'example' => 'true'],
'Email' => ['title' => '', 'description' => 'The email address of the account.', 'type' => 'string', 'example' => 'user@example.com'],
'EmailVerified' => ['title' => '', 'description' => 'Indicates whether the email address has been verified. A value of true indicates that the email address has been verified by the user or set as verified by the administrator. A value of false indicates that the email address has not been verified.', 'type' => 'boolean', 'example' => 'true'],
'UserExternalId' => ['title' => '', 'description' => 'The external ID of the account, which is used to associate external data with IDaaS accounts. The default value is the IDaaS account ID.'."\n"
."\n"
.'Note: The external ID must be unique within the same source type and source ID.', 'type' => 'string', 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx'],
'UserSourceType' => ['title' => '', 'description' => 'The source type of the account. Valid values:'."\n"
.'- build_in: self-built.'."\n"
.'- ding_talk: imported from DingTalk.'."\n"
.'- ad: imported from AD.'."\n"
.'- ldap: imported from LDAP.', 'type' => 'string', 'example' => 'build_in'],
'UserSourceId' => ['title' => '', 'description' => 'The source ID of the account.'."\n"
."\n"
.'For self-built accounts, the default value is the instance ID. For other types, the value corresponds to the enterprise ID of the respective source. For example, for a DingTalk source, the value corresponds to the corpId of the DingTalk enterprise.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'Status' => ['title' => '', 'description' => 'The account status. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enabled'],
'AccountExpireTime' => ['title' => '', 'description' => 'The account expiration time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'PasswordExpireTime' => ['title' => '', 'description' => 'The password expiration time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'RegisterTime' => ['title' => '', 'description' => 'The account registration time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'LockExpireTime' => ['title' => '', 'description' => 'The account lock expiration time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'CreateTime' => ['title' => '', 'description' => 'The account creation time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the account was last updated, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1652085686179'],
'Description' => ['title' => '', 'description' => 'The description of the account.', 'type' => 'string', 'example' => 'xxxx'],
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'NextToken' => ['title' => '', 'description' => 'The pagination token.', 'type' => 'string', 'example' => 'NTxxxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The number of entries per page for paging.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'List EIAM account information',
'summary' => 'Queries EIAM account information by using paging.',
'description' => 'This operation queries only the direct permissions of an organizational unit, which are the applications directly assigned to the organizational unit. When you call this operation, you can use the **ApplicationIds** parameter to filter applications.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsers'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"Username\\": \\"name001\\",\\n \\"DisplayName\\": \\"display_name001\\",\\n \\"PasswordSet\\": false,\\n \\"PhoneRegion\\": \\"86\\",\\n \\"PhoneNumber\\": \\"156xxxxxxx\\",\\n \\"PhoneNumberVerified\\": true,\\n \\"Email\\": \\"user@example.com\\",\\n \\"EmailVerified\\": true,\\n \\"UserExternalId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"UserSourceType\\": \\"build_in\\",\\n \\"UserSourceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"Status\\": \\"enabled\\",\\n \\"AccountExpireTime\\": 1652085686179,\\n \\"PasswordExpireTime\\": 1652085686179,\\n \\"RegisterTime\\": 1652085686179,\\n \\"LockExpireTime\\": 1652085686179,\\n \\"CreateTime\\": 1652085686179,\\n \\"UpdateTime\\": 1652085686179,\\n \\"Description\\": \\"xxxx\\",\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\"\\n }\\n ],\\n \\"NextToken\\": \\"NTxxxxxexample\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
],
'ListUsersForApplication' => [
'summary' => 'Performs a paged query to list the accounts that have been granted access to an application. The response includes account IDs. To retrieve detailed information about an account, call the GetUser operation.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'default' => '20', 'title' => '', 'required' => false],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'UserIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of account IDs. A maximum of 100 account IDs are supported in a single request.',
'type' => 'array',
'items' => ['description' => 'The account ID.', 'type' => 'string', 'required' => false, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'title' => ''],
'required' => false,
'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx',
],
],
[
'name' => 'ApplicationRoleId',
'in' => 'query',
'schema' => ['description' => '应用角色ID。', 'type' => 'string', 'example' => 'app_role_mkv7rgt4ds8d8v0qtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'Users' => [
'description' => 'The list of accounts.',
'type' => 'array',
'items' => [
'description' => 'The account.',
'type' => 'object',
'properties' => [
'UserId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'title' => ''],
'ApplicationRoles' => [
'description' => 'The list of application roles.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ApplicationRoleId' => ['description' => 'The application role ID.', 'type' => 'string', 'example' => 'app_role_mkv7rgt4ds8d8v0qtzev2mxxxx', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'ListUsersForApplication',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsersForApplication'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListUsersForApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"ApplicationRoles\\": [\\n {\\n \\"ApplicationRoleId\\": \\"app_role_mkv7rgt4ds8d8v0qtzev2mxxxx\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'ListUsersForAuthorizationRule' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The token that marks the starting position for the next page of results.'."\n"
."\n"
.'- If not specified, the query starts from the first page.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The maximum number of entries per page.'."\n"
."\n"
.'- Default value: 20.'."\n"
."\n"
.'- Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The filter conditions.',
'type' => 'array',
'items' => [
'description' => 'The filter conditions.',
'type' => 'object',
'properties' => [
'Name' => ['title' => '', 'description' => 'The name of the filter field. Valid values:'."\n"
."\n"
.'- UserId: the account ID.', 'type' => 'string', 'example' => 'UserId', 'required' => false],
'Value' => [
'title' => '',
'description' => 'The values of the filter field.',
'type' => 'array',
'items' => ['description' => 'The value of the filter field.', 'type' => 'string', 'required' => false, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'NextToken' => ['title' => '', 'description' => 'The token returned for the next page of results. Use this token in the next request to retrieve the next page.', 'type' => 'string', 'example' => 'NTxxxexample'],
'MaxResults' => ['title' => '', 'description' => 'The number of entries per page in a paged query. This is the paging size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'Users' => [
'description' => 'The list of account data.',
'type' => 'array',
'items' => [
'description' => 'The account data.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'UserId' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx'],
'ValidityType' => ['title' => '', 'description' => 'The validity type of the relationship. Valid values:'."\n"
.'- permanent: permanent'."\n"
.'- time_bound: custom time range.', 'type' => 'string', 'example' => 'permanent'],
'ValidityPeriod' => [
'title' => '',
'description' => 'The time range of the validity period. This parameter takes effect only when ValidityType is set to time_bound.',
'type' => 'object',
'properties' => [
'StartTime' => ['title' => '', 'description' => 'The start time of the validity period, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000'],
'EndTime' => ['title' => '', 'description' => 'The end time of the validity period, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000'],
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'List accounts associated with an authorization rule',
'summary' => 'Lists the accounts associated with an authorization rule.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListUsersForAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"MaxResults\\": 20,\\n \\"Users\\": [\\n {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"UserId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"ValidityType\\": \\"permanent\\",\\n \\"ValidityPeriod\\": {\\n \\"StartTime\\": 1704042061000,\\n \\"EndTime\\": 1704042061000\\n }\\n }\\n ]\\n}","type":"json"}]',
],
'ListUsersForGroup' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '165220',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries per page. The default value is 20. The maximum value is 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '20', 'example' => '20'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The group ID.', 'type' => 'string', 'required' => true, 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
],
[
'name' => 'UserIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'A list of account IDs. The list can contain a maximum of 100 IDs.',
'type' => 'array',
'items' => ['description' => 'The account ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx'],
'required' => false,
'example' => '[ou_001]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'TotalCount' => ['title' => '', 'description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'Users' => [
'description' => 'The list of account objects.',
'type' => 'array',
'items' => [
'description' => 'The account object.',
'type' => 'object',
'properties' => [
'UserId' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx'],
'GroupMemberRelationSourceId' => ['description' => 'The source ID of the group member relationship.'."\n"
."\n"
.'If the group is created in EIAM, the value of this parameter is the instance ID. For other types of groups, the value is the enterprise ID from the source. For example, if the group is imported from DingTalk, the value is the corpId of the DingTalk enterprise.', 'type' => 'string', 'title' => '', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'GroupMemberRelationSourceType' => ['description' => 'The source type of the group member relationship. Valid values:'."\n"
."\n"
.'build\\_in: The group is created in EIAM.'."\n"
."\n"
.'ding\\_talk: The group is imported from DingTalk.'."\n"
."\n"
.'ad: The group is imported from Active Directory (AD).'."\n"
."\n"
.'ldap: The group is imported from LDAP.'."\n"
."\n"
.'we\\_com: The group is imported from WeCom.', 'type' => 'string', 'title' => '', 'example' => 'build_in'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListUsersForGroup',
'summary' => 'Lists the users in a specified EIAM account group.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsersForGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 1000,\\n \\"Users\\": [\\n {\\n \\"UserId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"GroupMemberRelationSourceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"GroupMemberRelationSourceType\\": \\"build_in\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListUsersForResourceServer' => [
'summary' => 'List the scope permissions granted by a Resource Server to user accounts using cursor-based pagination.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token for the next page. Set this parameter to the value of NextToken returned by the previous API call.', 'type' => 'string', 'example' => 'NTxxxxxexample', 'title' => '', 'required' => false],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the Resource Server application.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page for paged queries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'Filter',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => 'The name of the filter condition.',
'type' => 'string',
'example' => 'UserIds',
'enum' => ['UserIds'],
'title' => '',
'required' => false,
],
'Value' => [
'type' => 'array',
'items' => ['description' => 'A value for the filter condition.', 'type' => 'string', 'example' => 'user_mkv7rgt4d7i4u7zqtzev2mxxxx', 'title' => '', 'required' => false],
'maxItems' => 100,
'minItems' => 1,
'title' => '',
'description' => 'A list of values for the filter condition.',
'required' => false,
'example' => '',
],
],
'description' => 'A filter condition.',
'required' => false,
'title' => '',
'example' => '',
],
'title' => '',
'description' => 'A list of filter conditions.',
'required' => false,
'example' => '',
],
],
[
'name' => 'ResourceServerScopeId',
'in' => 'query',
'schema' => ['description' => '权限唯一标识。', 'type' => 'string', 'example' => 'ress_nbte4bb3qqqnaq73rlmkqixxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'NextToken' => ['description' => 'The token for the next page.', 'type' => 'string', 'example' => 'NTxxxexample', 'title' => ''],
'Users' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'idaas_qsw77zl5vrllwzyrrfwbmpxxxx', 'title' => ''],
'UserId' => ['description' => 'The ID of the user account.', 'type' => 'string', 'example' => 'user_nbsomva32b6utec3hgi7scxxxx', 'title' => ''],
'ResourceServerScopes' => [
'description' => 'A list of granted scope permissions.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ResourceServerScopeId' => ['description' => 'The ID of the scope permission.', 'type' => 'string', 'example' => 'ress_nbte4bb3qqqnaq73rlmkqixxxx', 'title' => ''],
'ResourceServerScopeName' => ['description' => 'The name of the scope permission.', 'type' => 'string', 'example' => 'Read All User', 'title' => ''],
],
'description' => 'Information about a scope permission.',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => 'Information about a user account.',
'title' => '',
'example' => '',
],
'description' => 'A list of user accounts.',
'title' => '',
'example' => '',
],
'MaxResults' => ['description' => 'The number of entries per page for paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListUsersForResourceServer',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"NTxxxexample\\",\\n \\"Users\\": [\\n {\\n \\"InstanceId\\": \\"idaas_qsw77zl5vrllwzyrrfwbmpxxxx\\",\\n \\"UserId\\": \\"user_nbsomva32b6utec3hgi7scxxxx\\",\\n \\"ResourceServerScopes\\": [\\n {\\n \\"ResourceServerScopeId\\": \\"ress_nbte4bb3qqqnaq73rlmkqixxxx\\",\\n \\"ResourceServerScopeName\\": \\"Read All User\\"\\n }\\n ]\\n }\\n ],\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
],
'ObtainApplicationClientSecret' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasJH3YY9'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'SecretId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client secret ID of the application.', 'type' => 'string', 'required' => true, 'example' => ' sci_k52x2ru63rlkflina5utgkxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ApplicationClientSecret' => [
'description' => 'The client secret information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'ClientId' => ['title' => '', 'description' => 'The client ID of the application.', 'type' => 'string', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'SecretId' => ['title' => '', 'description' => 'The client secret ID of the application.', 'type' => 'string', 'example' => ' sci_k52x2ru63rlkflina5utgkxxxx'],
'ClientSecret' => ['title' => '', 'description' => 'The client secret of the application.', 'type' => 'string', 'example' => 'CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx'],
'Status' => [
'title' => '',
'description' => 'The status of the client secret. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.',
'enumValueTitles' => ['disabled' => 'Disabled.', 'enabled' => 'Enabled.'],
'type' => 'string',
'example' => 'enabled',
],
'LastUsedTime' => ['title' => '', 'description' => 'The time when the client secret was last used. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
'ExpirationTime' => ['title' => '', 'description' => 'The expiration time of the client secret. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1749830226000'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query a client secret of an EIAM application',
'summary' => 'Retrieves the client secret of an EIAM application. The returned secret is not masked. To retrieve masked secrets, call the ListApplicationClientSecrets operation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ObtainApplicationClientSecret'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ObtainApplicationClientSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/{#SecretId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationClientSecret\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"ApplicationId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"ClientId\\": \\"app_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"SecretId\\": \\" sci_k52x2ru63rlkflina5utgkxxxx\\",\\n \\"ClientSecret\\": \\"CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx\\",\\n \\"Status\\": \\"enabled\\",\\n \\"LastUsedTime\\": 1649830226000,\\n \\"ExpirationTime\\": 1749830226000\\n }\\n}","type":"json"}]',
],
'ObtainApplicationToken' => [
'summary' => 'Queries a specified application token.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasSQHOGI'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationTokenId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application token ID.', 'type' => 'string', 'required' => true, 'example' => 'token_sfrwerxxxxxxxxxxxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'ApplicationToken' => [
'description' => 'The application token.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The IDaaS EIAM instance ID.', 'type' => 'string', 'example' => 'idaas_ki6hd7ihir4ybawogqk6kqxxxx'],
'ApplicationId' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'example' => 'app_na2r73a65s7o4zbs7nj5gxxxx'],
'ApplicationTokenId' => ['title' => '', 'description' => 'The application token ID.', 'type' => 'string', 'example' => 'token_m7aso6v4efvu2otfq3jdzxxxx'],
'ApplicationTokenType' => ['title' => '', 'description' => 'The application token type.', 'type' => 'string', 'example' => 'bearer_token'],
'ApplicationToken' => ['title' => '', 'description' => 'The application token.', 'type' => 'string', 'example' => 'SATFwqX8zxGf83pJcJw78KFGjmrft4erWeZYBGS8oE7NN6qoE217yaJpUdMb1UuuGqhDiF43sCA4CF91CTL5iGntqwyLuaAcS9FJ9HfGadE5a7TjiwVafwrBxxxxx'],
'Status' => ['title' => '', 'description' => 'The enabling status.', 'type' => 'string', 'example' => 'enabled'],
'ExpirationTime' => ['description' => 'The expiration time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1735610950000', 'title' => ''],
'LastUsedTime' => ['title' => '', 'description' => 'The last used time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1735610930000'],
'CreateTime' => ['description' => 'The time when the application token was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1735610930000', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query a specified application token',
'description' => 'When you change an application from the enabled state to the disabled state, all features of the application become unavailable, such as SSO and account synchronization. Make sure that you are aware of the risks that may result from this operation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ObtainApplicationToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/{#ApplicationTokenId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"ApplicationToken\\": {\\n \\"InstanceId\\": \\"idaas_ki6hd7ihir4ybawogqk6kqxxxx\\",\\n \\"ApplicationId\\": \\"app_na2r73a65s7o4zbs7nj5gxxxx\\",\\n \\"ApplicationTokenId\\": \\"token_m7aso6v4efvu2otfq3jdzxxxx\\",\\n \\"ApplicationTokenType\\": \\"bearer_token\\",\\n \\"ApplicationToken\\": \\"SATFwqX8zxGf83pJcJw78KFGjmrft4erWeZYBGS8oE7NN6qoE217yaJpUdMb1UuuGqhDiF43sCA4CF91CTL5iGntqwyLuaAcS9FJ9HfGadE5a7TjiwVafwrBxxxxx\\",\\n \\"Status\\": \\"enabled\\",\\n \\"ExpirationTime\\": 1735610950000,\\n \\"LastUsedTime\\": 1735610930000,\\n \\"CreateTime\\": 1735610930000\\n }\\n}","type":"json"}]',
],
'ObtainCredential' => [
'summary' => 'Queries a credential resource that contains sensitive information.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'CredentialId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The credential ID.', 'type' => 'string', 'required' => true, 'example' => 'cred_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'Credential' => [
'description' => 'The credential information.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'CredentialId' => ['title' => '', 'description' => 'The credential ID.', 'type' => 'string', 'example' => 'cred_mkv7rgt4d7i4u7zqtzev2mxxxx'],
'Status' => ['title' => '', 'description' => 'The credential status. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enabled'],
'CredentialIdentifier' => ['title' => '', 'description' => 'The credential identifier.', 'type' => 'string', 'example' => 'credential_identifier_test'],
'CredentialName' => ['title' => '', 'description' => 'The credential name.', 'type' => 'string', 'example' => 'credential_name'],
'CredentialSubjectType' => ['title' => '', 'description' => 'The type of the subject to which the credential belongs. Valid values:'."\n"
.'- authentication_token_provider: authentication token provider.', 'type' => 'string', 'example' => 'authentication_token_provider'],
'CredentialSubjectId' => ['title' => '', 'description' => 'The ID of the subject to which the credential belongs.', 'type' => 'string', 'example' => 'apt_werthgfdsasffxxxxx'],
'CredentialScenarioLabel' => ['title' => '', 'description' => 'The scenarios label of the credential. Valid values:'."\n"
.'- llm: large language model.'."\n"
.'- saas: third-party SaaS service.', 'type' => 'string', 'example' => 'llm'],
'CredentialType' => ['title' => '', 'description' => 'The credential type. Valid values:'."\n"
.'- api_key: API key authentication credential.'."\n"
.'- oauth_client: OAuth client authentication credential.', 'type' => 'string', 'example' => 'api_key'],
'CredentialCreationType' => ['title' => '', 'description' => 'The creation type of the credential. Valid values:'."\n"
.'- system_init: Created by the system.'."\n"
.'- user_custom: Created by the user.', 'type' => 'string', 'example' => 'user_custom'],
'Description' => ['title' => '', 'description' => 'The credential description.', 'type' => 'string', 'example' => 'credential_description'],
'CreateTime' => ['title' => '', 'description' => 'The creation time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830225000'],
'UpdateTime' => ['title' => '', 'description' => 'The update time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830227000'],
'CredentialContent' => [
'title' => '',
'description' => 'The credential content.',
'type' => 'object',
'properties' => [
'OAuthClientContent' => [
'title' => '',
'description' => 'The credential content of the OAuth client authentication credential type.',
'type' => 'object',
'properties' => [
'ClientId' => ['title' => '', 'description' => 'The client_id of the OAuth protocol.', 'type' => 'string', 'example' => 'dmvncmxersdxxxxxx'],
'ClientSecret' => ['title' => '', 'description' => 'The client_secret of the OAuth protocol.', 'type' => 'string', 'example' => 'nsklnertyt5ddwizncxxxx'],
],
'example' => '',
],
'ApiKeyContent' => [
'description' => 'The credential content of the API key credential type.',
'type' => 'object',
'properties' => [
'ApiKey' => ['title' => '', 'description' => 'The API key content.', 'type' => 'string', 'example' => 'nsklncmwizncxxxx'],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
'CredentialSharingScope' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
'ExclusiveUserId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
'CredentialExternalId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query a credential with sensitive information',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ObtainCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"Credential\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"CredentialId\\": \\"cred_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"Status\\": \\"enabled\\",\\n \\"CredentialIdentifier\\": \\"credential_identifier_test\\",\\n \\"CredentialName\\": \\"credential_name\\",\\n \\"CredentialSubjectType\\": \\"authentication_token_provider\\",\\n \\"CredentialSubjectId\\": \\"apt_werthgfdsasffxxxxx\\",\\n \\"CredentialScenarioLabel\\": \\"llm\\",\\n \\"CredentialType\\": \\"api_key\\",\\n \\"CredentialCreationType\\": \\"user_custom\\",\\n \\"Description\\": \\"credential_description\\",\\n \\"CreateTime\\": 1649830225000,\\n \\"UpdateTime\\": 1649830227000,\\n \\"CredentialContent\\": {\\n \\"OAuthClientContent\\": {\\n \\"ClientId\\": \\"dmvncmxersdxxxxxx\\",\\n \\"ClientSecret\\": \\"nsklnertyt5ddwizncxxxx\\"\\n },\\n \\"ApiKeyContent\\": {\\n \\"ApiKey\\": \\"nsklncmwizncxxxx\\"\\n }\\n },\\n \\"CredentialSharingScope\\": \\"\\",\\n \\"ExclusiveUserId\\": \\"\\",\\n \\"CredentialExternalId\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'ObtainDomainProxyToken' => [
'summary' => 'Queries the proxy token of an EIAM instance domain name.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGK16FE'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'DomainId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The domain name ID.', 'type' => 'string', 'required' => true, 'example' => 'dm_examplexxxxx'],
],
[
'name' => 'DomainProxyTokenId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The domain proxy token ID.', 'type' => 'string', 'required' => true, 'example' => 'pt_examplexxxx'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
'DomainProxyToken' => [
'description' => 'The proxy token information object.',
'type' => 'object',
'properties' => [
'InstanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
'DomainProxyTokenId' => ['title' => '', 'description' => 'The domain proxy token ID.', 'type' => 'string', 'example' => 'pt_examplexxxx'],
'DomainProxyToken' => ['title' => '', 'description' => 'The domain proxy token.', 'type' => 'string', 'example' => 'PTxxxxxxxx'],
'DomainId' => ['title' => '', 'description' => 'The domain name ID.', 'type' => 'string', 'example' => 'dm_examplexxxx'],
'Status' => ['title' => '', 'description' => 'The token status. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enabled'],
'CreateTime' => ['title' => '', 'description' => 'The time when the domain proxy token was created, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
'UpdateTime' => ['title' => '', 'description' => 'The time when the domain proxy token was last updated, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
'LastUsedTime' => ['title' => '', 'description' => 'The time when the domain proxy token was last used, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1649830226000'],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Query proxy token information of an EIAM instance domain name',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ObtainDomainProxyToken'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"DomainProxyToken\\": {\\n \\"InstanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"DomainProxyTokenId\\": \\"pt_examplexxxx\\",\\n \\"DomainProxyToken\\": \\"PTxxxxxxxx\\",\\n \\"DomainId\\": \\"dm_examplexxxx\\",\\n \\"Status\\": \\"enabled\\",\\n \\"CreateTime\\": 1649830226000,\\n \\"UpdateTime\\": 1649830226000,\\n \\"LastUsedTime\\": 1649830226000\\n }\\n}","type":"json"}]',
'translator' => 'machine',
],
'RemoveApplicationAccountFromUser' => [
'summary' => 'Deletes an application account of a specified employee under the current application.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas51QHX0', 'FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'eiam-111ccc1111', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_11111', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'user_example', 'maxLength' => 64],
],
[
'name' => 'ApplicationAccountId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application account ID.', 'type' => 'string', 'required' => true, 'example' => 'act_example', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Delete an application account of a specified employee under the current application',
'description' => 'This operation only queries the direct permissions of the organization, that is, applications directly assigned to the organization. When you call this operation, you can use the **ApplicationIds** parameter to filter applications.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RemoveApplicationAccountFromUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationaccount/{#ApplicationAccountId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RemoveApplicationFromAuthorizationRule' => [
'summary' => 'Removes an application from an authorization rule.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Remove an application from an authorization rule',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RemoveApplicationFromAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RemoveCustomPrivacyPoliciesFromBrand' => [
'summary' => 'Removes custom terms associated with a brand.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasLY3IT7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'BrandId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The brand ID.', 'type' => 'string', 'required' => true, 'example' => 'brand_xxxx'],
],
[
'name' => 'CustomPrivacyPolicyIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of term IDs.',
'type' => 'array',
'items' => ['description' => 'The term ID.', 'type' => 'string', 'required' => false, 'example' => 'pp_xxxx', 'title' => ''],
'required' => true,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Remove custom terms from a brand',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:RemoveCustomPrivacyPoliciesFromBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#PolicyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RemoveGroupFromAuthorizationRule' => [
'summary' => 'Removes an application from an authorization rule.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['description' => 'The ID of the authorization rule.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => 'The group ID.', 'type' => 'string', 'required' => true, 'example' => 'group_miu8e4t4d7i4u7uwezgr54xxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'RemoveGroupFromAuthorizationRule',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RemoveGroupFromAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RemoveUserFromAuthorizationRule' => [
'summary' => 'Removes an account from an authorization rule.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Remove an account from an authorization rule',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RemoveUserFromAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RemoveUserFromOrganizationalUnits' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYZ4AR1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The organization IDs. You can remove an account from a maximum of 100 organizations.'."\n",
'type' => 'array',
'items' => ['description' => 'The organization ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'title' => ''],
'required' => true,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'RemoveUserFromOrganizationalUnits',
'summary' => 'Removes an Employee Identity and Access Management (EIAM) account from multiple EIAM organizations of Identity as a Service (IDaaS). You cannot remove an account from a primary organization.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUserFromOrganizationalUnits'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RemoveUsersFromGroup' => [
'summary' => 'Removes Employee Identity and Access Management (EIAM) accounts from an EIAM group of Identity as a Service (IDaaS).',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasIEJFYH'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The group ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
],
[
'name' => 'UserIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The account IDs. A maximum of 100 accounts can be removed from a group.'."\n",
'type' => 'array',
'items' => ['description' => 'The account ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'title' => ''],
'required' => true,
'example' => '[ou_001]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'RemoveUsersFromGroup',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsersFromGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RenewFreeLicenseEndTime' => [
'summary' => 'Renews a Free Edition instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '238214',
'abilityTreeNodes' => ['FEATUREidaas92IAAU'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Renew a free edition instance',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:RenewFreeLicenseEndTime',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RevokeApplicationFromGroups' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas7VNWU7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'GroupIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of group IDs. You can specify up to 100 group IDs in a single request.',
'type' => 'array',
'items' => ['description' => 'The group ID.', 'type' => 'string', 'required' => false, 'example' => 'group_miu8e4t4d7i4u7uwezgr54xxxx', 'title' => ''],
'required' => true,
'example' => 'group_miu8e4t4d7i4u7uwezgr54xxxx',
],
],
[
'name' => 'ApplicationRoleId',
'in' => 'query',
'schema' => ['description' => 'The application role ID.', 'type' => 'string', 'example' => 'app_role_mkv7rgt4ds8d8v0qtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Revoke the permissions of multiple EIAM groups to access an application',
'summary' => 'Revokes the permissions of multiple Employee Identity and Access Management (EIAM) groups to access an application in a batch.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeApplicationFromGroups'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeApplicationFromGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RevokeApplicationFromOrganizationalUnits' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas3S4NKL'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'OrganizationalUnitIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'A list of organizational unit IDs. A single operation supports up to 100 organizational unit IDs.',
'type' => 'array',
'items' => ['description' => 'The organizational unit ID.', 'type' => 'string', 'required' => false, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'title' => ''],
'required' => true,
'example' => 'ou_wovwffm62xifdziem7an7xxxxx',
],
],
[
'name' => 'ApplicationRoleId',
'in' => 'query',
'schema' => ['description' => '应用角色ID。', 'type' => 'string', 'example' => 'app_role_mkv7rgt4ds8d8v0qtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'RevokeApplicationFromOrganizationalUnits',
'summary' => 'Revokes application access from multiple EIAM organizations in a batch operation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeApplicationFromOrganizationalUnits'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeApplicationFromOrganizationalUnits',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RevokeApplicationFromUsers' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'UserIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of account IDs. A maximum of 100 account IDs are supported in a single operation.',
'type' => 'array',
'items' => ['description' => 'The account ID.', 'type' => 'string', 'required' => false, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'title' => ''],
'required' => true,
'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx',
],
],
[
'name' => 'ApplicationRoleId',
'in' => 'query',
'schema' => ['description' => 'The application role ID.', 'type' => 'string', 'example' => 'app_role_mkv7rgt4ds8d8v0qtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'title' => '',
'example' => '',
],
],
],
'title' => 'Revoke permissions of multiple EIAM accounts to access an application',
'summary' => 'Revokes the permissions of multiple Enterprise Identity Access Management (EIAM) accounts to access an application in a batch.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeApplicationFromUsers'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeApplicationFromUsers',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RevokeResourceServerFromClient' => [
'summary' => 'Cancels the authorization granted by a specified ResourceServer to a Client application.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the Client application.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ResourceServerApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the ResourceServer application.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Cancel authorization granted by a resourceServer to a client application',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeResourceServerFromClient',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RevokeResourceServerScopesFromClient' => [
'summary' => 'Revokes the scope permissions of a specified ResourceServer from a client application.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The unique identifier of the client application.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ResourceServerApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The unique identifier of the ResourceServer application.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ResourceServerScopeIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of scope permission IDs under the ResourceServer.',
'type' => 'array',
'items' => ['description' => 'The scope permission ID.', 'type' => 'string', 'required' => false, 'example' => 'ress_neg35flu6byysxwutaxu3dxxxx', 'title' => ''],
'required' => true,
'example' => '["ress_XXXXX","ress_XXXXX"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Revoke scope permissions of a resourceServer from a client application',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeResourceServerScopesFromClient',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RevokeResourceServerScopesFromGroup' => [
'summary' => 'Revokes the authorization of Scope permissions under a specified ResourceServer from a group.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID of the ResourceServer.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ResourceServerScopeIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of Scope permission IDs under the ResourceServer.',
'type' => 'array',
'items' => ['description' => 'The Scope permission ID.', 'type' => 'string', 'required' => false, 'example' => 'ress_neg35flu6byysxwutaxu3dxxxx', 'title' => ''],
'required' => true,
'example' => '["ress_XXXXX","ress_XXXXX"]',
'maxItems' => 100,
'minItems' => 1,
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The group ID.', 'type' => 'string', 'required' => true, 'example' => 'group_mkv7rgt4d7i4u7zqtzev2mxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Revoke scope permissions of a specified resourceServer from a group',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeResourceServerScopesFromGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RevokeResourceServerScopesFromOrganizationalUnit' => [
'summary' => 'Revokes the authorization of Scope permissions under a specified ResourceServer from an organizational unit.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The organizational unit ID.', 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ResourceServer application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ResourceServerScopeIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of Scope permission IDs under the ResourceServer.',
'type' => 'array',
'items' => ['description' => 'The Scope permission ID.', 'type' => 'string', 'required' => false, 'example' => 'ress_neg35flu6byysxwutaxu3dxxxx', 'title' => ''],
'required' => true,
'example' => '["ress_XXXXX","ress_XXXXX"]',
'maxItems' => 100,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Revoke scope permissions under a specified resourceServer from an organizational unit',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeResourceServerScopesFromOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/{#OrganizationalUnitId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RevokeResourceServerScopesFromUser' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'user_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID of the ResourceServer.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ResourceServerScopeIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of Scope permission IDs under the ResourceServer.',
'type' => 'array',
'items' => ['description' => 'The Scope permission ID.', 'type' => 'string', 'required' => false, 'example' => 'ress_neg35flu6byysxwutaxu3dxxxx', 'title' => ''],
'required' => true,
'example' => '["ress_XXXXX","ress_XXXXX"]',
'maxItems' => 100,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Revoke scope permissions under a specified resourceServer from an account',
'summary' => 'Revokes the Scope permissions under a specified ResourceServer from an account.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeResourceServerScopesFromUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'RunSynchronizationJob' => [
'summary' => 'Creates and immediately runs a new synchronization task.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231891',
'abilityTreeNodes' => ['FEATUREidaas9JORH7', 'FEATUREidaasPA75HM', 'FEATUREidaasGZQMMT', 'FEATUREidaas6Z5KX0', 'FEATUREidaas9961RX', 'FEATUREidaasLILYPH', 'FEATUREidaas02PFKG', 'FEATUREidaas50G2LR'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'TargetId',
'in' => 'query',
'schema' => ['description' => 'The ID of the synchronization target.', 'type' => 'string', 'required' => true, 'example' => 'idp_my664lwkhpicbyzirog3ngxxxxx'."\n", 'maxLength' => 128, 'title' => ''],
],
[
'name' => 'TargetType',
'in' => 'query',
'schema' => ['description' => 'The type of the synchronization target. Valid values:'."\n"
."\n"
.'- identity\\_provider: The identity provider.'."\n"
."\n"
.'- application: The application.', 'type' => 'string', 'required' => true, 'example' => 'identity_provider', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the synchronization task.', 'type' => 'string', 'example' => 'description_text', 'maxLength' => 128, 'required' => false, 'title' => ''],
],
[
'name' => 'UserIdentityTypes',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'array',
'items' => [
'description' => 'The unique user identifier.',
'type' => 'string',
'enum' => ['username', 'email', 'phoneNumber', 'externalId'],
'title' => '',
'required' => false,
'example' => 'ding_talk',
],
'required' => false,
'description' => 'The list of unique user identifiers.',
'title' => '',
'example' => '',
],
],
[
'name' => 'SynchronizationScopeConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'object',
'properties' => [
'OrganizationalUnitIds' => [
'type' => 'array',
'items' => ['description' => 'The organizational unit ID.', 'type' => 'string', 'required' => false, 'example' => 'ou_denmyslajnzh4f4hkuob5sxxxx', 'title' => ''],
'required' => false,
'description' => 'The list of organizational unit IDs.',
'title' => '',
'example' => '',
],
'GroupIds' => [
'type' => 'array',
'items' => ['description' => 'The group ID.', 'type' => 'string', 'required' => false, 'example' => 'group_hrgy65sk32ry4d7476bkexxxx', 'title' => ''],
'required' => false,
'description' => 'The list of group IDs.',
'title' => '',
'example' => '',
],
'UserIds' => [
'type' => 'array',
'items' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => 'user_rgy65sk32ry4d747xxxx', 'title' => ''],
'required' => false,
'description' => 'The list of user IDs.',
'title' => '',
'example' => '',
],
],
'required' => false,
'description' => 'The configuration of the synchronization scope.',
'title' => '',
'example' => '',
],
],
[
'name' => 'PasswordInitialization',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to initialize the password.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
'SynchronizationJobId' => [
'description' => 'The ID of the synchronization task.',
'properties' => [],
'type' => 'string',
'title' => '',
'example' => 'sync_0000347vjovtcf41li0fgsd98gn24q9nj9xxxxx'."\n",
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'UnsupportedAction.IdentityProviderBeingLocked', 'errorMessage' => 'The current identity source is locked, temporarily unable to operate.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\",\\n \\"SynchronizationJobId\\": \\"sync_0000347vjovtcf41li0fgsd98gn24q9nj9xxxxx\\\\n\\"\\n}","type":"json"}]',
'title' => 'RunSynchronizationJob',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunSynchronizationJob'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:RunSynchronizationJob',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'SynchronizationJob', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/*'],
],
],
],
],
],
'SetApplicationGrantScope' => [
'summary' => 'Configures the permissions of the Developer API feature of an Employee Identity and Access Management (EIAM) application.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasA4SIXV', 'FEATUREidaas60YEMV'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the application that you want to configure.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'."\n", 'maxLength' => 64],
],
[
'name' => 'GrantScopes',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The permissions of the Developer API feature.'."\n",
'type' => 'array',
'items' => ['description' => 'The permissions of the Developer API feature. Valid values:'."\n"
."\n"
.'* urn:alibaba:idaas:scope:user:read_all: the permission to query all users.'."\n"
.'* urn:alibaba:idaas:scope:user:manage_all: the permission to manage all users.'."\n"
.'* urn:alibaba:idaas:scope:organizational_unit:read_all: the permission to query all organizations.'."\n"
.'* urn:alibaba:idaas:scope:organizational_unit:manage_all: the permission to manage all organizations.'."\n", 'type' => 'string', 'required' => false, 'example' => 'urn:alibaba:idaas:scope:user:read_all', 'title' => ''],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'SetApplicationGrantScope',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetApplicationGrantScope'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetApplicationGrantScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetApplicationProvisioningConfig' => [
'summary' => 'Sets the account synchronization configuration for an EIAM application.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ProvisionProtocolType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account synchronization protocol type. Valid values:'."\n"
.'- idaas\\_callback: IDaaS custom event callback-based account synchronization.'."\n"
.'- scim2: System for Cross-domain Identity Management protocol-based synchronization.', 'type' => 'string', 'required' => true, 'example' => 'idaas_callback', 'maxLength' => 64],
],
[
'name' => 'CallbackProvisioningConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The application event callback synchronization configuration. This parameter is required when ProvisionProtocolType is set to idaas\\_callback.',
'type' => 'object',
'properties' => [
'CallbackUrl' => ['title' => '', 'description' => 'The destination URL where the application receives IDaaS event callbacks.', 'type' => 'string', 'example' => 'https://example.com/event/callback', 'required' => false],
'EncryptKey' => ['title' => '', 'description' => 'The symmetric encryption and decryption key for IDaaS event callbacks. The key uses the AES256 algorithm and is in hexadecimal encoding format.', 'type' => 'string', 'example' => 'ad3b248**************************b3561a73d7', 'required' => false],
'EncryptRequired' => ['title' => '', 'description' => 'Specifies whether IDaaS event callback messages are encrypted. Valid values:'."\n"
.'- true: Encrypted.'."\n"
.'- false: Not encrypted. Messages are transmitted in plaintext.', 'type' => 'boolean', 'example' => 'true', 'required' => false],
'ListenEventScopes' => [
'title' => '',
'description' => 'The list of IDaaS event callback message types to listen for.',
'type' => 'array',
'items' => ['description' => 'The IDaaS event callback message type. For valid values, refer to References: [Address book events](https://help.aliyun.com/document_detail/410178.htm).'."\n"
.'The IDaaS event callback message type. For valid values, refer to References: [Address book events](https://www.alibabacloud.com/help/zh/idaas/eiam/developer-reference/callback-events?spm=a2c63.p38356.0.0.3f1334e3ZckNrD).', 'type' => 'string', 'required' => false, 'example' => 'urn:alibaba:idaas:app:event:ud:user:create'."\n", 'title' => ''],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'ScimProvisioningConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The IDaaS System for Cross-domain Identity Management protocol synchronization configuration parameters. This parameter is required when ProvisionProtocolType is set to scim2.',
'type' => 'object',
'properties' => [
'ScimBaseUrl' => ['title' => '', 'description' => 'The base URL where the application accepts IDaaS synchronization requests based on the System for Cross-domain Identity Management protocol.', 'type' => 'string', 'example' => 'https://example.com/scim', 'required' => false],
'AuthnConfiguration' => [
'title' => '',
'description' => 'The System for Cross-domain Identity Management protocol synchronization configuration parameters.',
'type' => 'object',
'properties' => [
'AuthnMode' => ['title' => '', 'description' => 'The authorization pattern for the System for Cross-domain Identity Management protocol API. Valid values:'."\n"
.'- oauth2: OAuth2 pattern.', 'type' => 'string', 'example' => 'oauth2', 'required' => false],
'GrantType' => ['title' => '', 'description' => 'The System for Cross-domain Identity Management protocol authorization pattern. Valid values:'."\n"
.'- client\\_credentials: Client credentials pattern.'."\n"
.'- bearer\\_token: Bearer token pattern.', 'type' => 'string', 'example' => 'bearer_token', 'required' => false],
'AuthnParam' => [
'title' => '',
'description' => 'The authorization configuration parameters. Usage:'."\n"
.'- If GrantType is set to client\\_credentials, you can update ClientId, ClientSecret, and AuthnMethod.'."\n"
.'- If GrantType is set to bearer\\_token, you can update AccessToken.',
'type' => 'object',
'properties' => [
'AccessToken' => ['title' => '', 'description' => 'The access token. This field can be updated when GrantType is set to bearer\\_token.', 'type' => 'string', 'example' => 'k52x2ru63rlkflina5utgkxxxx', 'required' => false],
'TokenEndpoint' => ['title' => '', 'description' => 'The token endpoint.', 'type' => 'string', 'example' => 'https://www.example.com/oauth/token', 'required' => false],
'ClientId' => ['title' => '', 'description' => 'The client ID of the application.', 'type' => 'string', 'example' => 'mkv7rgt4d7i4u7zqtzev2mxxxx', 'required' => false],
'ClientSecret' => ['title' => '', 'description' => 'The client secret of the application.', 'type' => 'string', 'example' => 'CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx', 'required' => false],
'AuthnMethod' => ['title' => '', 'description' => 'The System for Cross-domain Identity Management protocol authentication pattern. Valid values:'."\n"
.'- client\\_secret\\_basic: Passes the secret through the request header.'."\n"
.'- client\\_secret\\_post: Passes the secret through the request body.', 'type' => 'string', 'example' => 'client_secret_basic', 'required' => false],
],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
'ProvisioningActions' => [
'title' => '',
'description' => 'The System for Cross-domain Identity Management protocol target resource operation actions. Valid values:'."\n"
.'- urn:alibaba:idaas:app:scim:User:CREATE: Account creation.'."\n"
.'- urn:alibaba:idaas:app:scim:User:UPDATE: Account update.'."\n"
.'- urn:alibaba:idaas:app:scim:User:DELETE: Account deletion.',
'type' => 'array',
'items' => ['description' => 'The System for Cross-domain Identity Management protocol target resource operation action.', 'type' => 'string', 'required' => false, 'example' => 'urn:alibaba:idaas:app:scim:User:CREATE', 'title' => ''],
'required' => false,
'example' => '',
],
'FullPushScopes' => [
'title' => '',
'description' => 'The System for Cross-domain Identity Management protocol full push scope. Valid values:'."\n"
.'- urn:alibaba:idaas:app:scim:User:PUSH: Full user synchronization.',
'type' => 'array',
'items' => ['description' => 'The System for Cross-domain Identity Management protocol full push scope.', 'type' => 'string', 'required' => false, 'example' => 'urn:alibaba:idaas:app:scim:User:PUSH', 'title' => ''],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'ProvisionPassword',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether IDaaS user event callbacks synchronize passwords. Valid values:'."\n"
.'- true: Passwords are synchronized.'."\n"
.'- false: Passwords are not synchronized.', 'type' => 'boolean', 'example' => 'true', 'required' => false],
],
[
'name' => 'NetworkAccessEndpointId',
'in' => 'query',
'schema' => ['description' => 'The network endpoint ID.', 'type' => 'string', 'required' => false, 'example' => 'nae_examplexxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter.ListenEventScopes', 'errorMessage' => 'The specified event scope contains an unsupported event type.', 'description' => ''],
],
],
'title' => 'Set account synchronization configuration for an EIAM application',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetApplicationProvisioningConfig'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetApplicationProvisioningConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetApplicationProvisioningScope' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '137232',
'abilityTreeNodes' => ['FEATUREidaas60YEMV'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of organizational units that are authorized for account synchronization.'."\n",
'type' => 'array',
'items' => ['description' => 'An organizational unit that is authorized for account synchronization.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
[
'name' => 'GroupIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'List of groups that are authorized to be synchronized from',
'type' => 'array',
'items' => ['description' => 'The ID of the group', 'type' => 'string', 'required' => false, 'example' => 'group_miu8e4t4d7i4u7uwezgr54xxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'SetApplicationProvisioningScope',
'summary' => 'Sets the account synchronization scope of applications in Identity as a Service (IDaaS) Employee IAM (EIAM). This scope is the same as the scope within which developers can call the DeveloperAPI to query and manage accounts.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetApplicationProvisioningScope'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetApplicationProvisioningScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetApplicationProvisioningUserPrimaryOrganizationalUnit' => [
'summary' => 'Sets the primary organizational unit for an application\'s user provisioning.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasSQHOGI'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'UserPrimaryOrganizationalUnitId',
'in' => 'query',
'schema' => ['description' => 'The organization ID.', 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'SetApplicationProvisioningUserPrimaryOrganizationalUnit',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetApplicationProvisioningUserPrimaryOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetApplicationResourceServerIdentifier' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ResourceServerIdentifier',
'in' => 'query',
'schema' => ['description' => 'The unique identifier of the resource server.', 'type' => 'string', 'required' => true, 'example' => 'http://gateway.com', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of the request. Generate a unique value from your client for this parameter. The client token can contain only ASCII characters and cannot be longer than 64 characters. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/en/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => false, 'example' => 'client-token-example'."\n", 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'SetApplicationResourceServerIdentifier',
'summary' => 'Sets the unique identifier for a resource server. This identifier is used as the aud (audience) claim in a JSON Web Token (JWT) to specify the service that is intended to accept the token.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetApplicationResourceServerIdentifier',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetApplicationSsoConfig' => [
'summary' => 'Sets the single sign-on (SSO) configuration properties for an EIAM application.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '142626',
'abilityTreeNodes' => ['FEATUREidaasDDL9A8'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'SamlSsoConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The SSO configuration parameters for a SAML protocol-based application.',
'type' => 'object',
'properties' => [
'SpSsoAcsUrl' => ['title' => '', 'description' => 'The SAML assertion consumer service (ACS) URL of the application (SP).', 'type' => 'string', 'example' => 'https://signin.aliyun.com/saml-role/sso', 'required' => false],
'SpEntityId' => ['title' => '', 'description' => 'The SAML EntityId of the application (SP).', 'type' => 'string', 'example' => 'urn:alibaba:cloudcomputing', 'required' => false],
'NameIdFormat' => [
'title' => '',
'description' => 'The NameID format defined by the SAML protocol standard. Valid values:'."\n"
.'- urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified: Unspecified. The application determines how to parse the NameID.'."\n"
.'- urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress: Email address format.'."\n"
.'- urn:oasis:names:tc:SAML:2.0:nameid-format:persistent: Persistent NameID.'."\n"
.'- urn:oasis:names:tc:SAML:2.0:nameid-format:transient: Transient NameID.',
'enumValueTitles' => ['urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified' => 'Unspecified. Default value.', 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress' => 'Email address format.', 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent' => 'Persistent.', 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient' => 'Transient.'],
'type' => 'string',
'example' => 'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified',
'required' => false,
],
'NameIdValueExpression' => ['title' => '', 'description' => 'The expression used to generate the actual NameID value for the SAML protocol.', 'type' => 'string', 'example' => 'user.email', 'required' => false],
'DefaultRelayState' => ['title' => '', 'description' => 'The default RelayState value. When the single sign-on (SSO) request is initiated by EIAM, the SAML Response provided by EIAM specifies the RelayState as this value.', 'type' => 'string', 'example' => 'https://home.console.aliyun.com', 'required' => false],
'SignatureAlgorithm' => [
'title' => '',
'description' => 'The SAML assertion signature algorithm.',
'enumValueTitles' => ['RSA-SHA256' => 'RSA-SHA256 algorithm.'],
'type' => 'string',
'example' => 'RSA-SHA256',
'required' => false,
],
'ResponseSigned' => ['title' => '', 'description' => 'Specifies whether the Response needs to be signed. ResponseSigned and AssertionSigned cannot both be set to false.'."\n"
.'- true: The Response is signed.'."\n"
.'- false: The Response is not signed.', 'type' => 'boolean', 'example' => 'true', 'required' => false],
'AssertionSigned' => ['title' => '', 'description' => 'Specifies whether the Assertion needs to be signed. ResponseSigned and AssertionSigned cannot both be set to false.'."\n"
.'- true: The Assertion is signed.'."\n"
.'- false: The Assertion is not signed.', 'type' => 'boolean', 'example' => 'true', 'required' => false],
'AttributeStatements' => [
'title' => '',
'description' => 'The additional user attribute configurations included in the SAML assertion.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AttributeName' => ['title' => '', 'description' => 'The Name of the attribute in the SAML assertion.', 'type' => 'string', 'example' => 'https://www.aliyun.com/SAML-Role/Attributes/RoleSessionName', 'required' => false],
'AttributeValueExpression' => ['title' => '', 'description' => 'The value expression of the attribute in the SAML assertion.', 'type' => 'string', 'example' => 'user.username', 'required' => false],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
'IdPEntityId' => ['title' => '', 'description' => 'The Entity ID that represents the IdP identity in the SAML protocol. URL format and URN format are supported.', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/'],
'OptionalRelayStates' => [
'description' => 'The optional RelayState configurations.',
'type' => 'array',
'items' => [
'description' => 'The optional RelayState configurations.',
'type' => 'object',
'properties' => [
'RelayState' => ['description' => 'The RelayState value.', 'type' => 'string', 'maxLength' => 256, 'required' => false, 'example' => 'https://ram.console.aliyun.com/', 'title' => ''],
'DisplayName' => ['description' => 'The display name of the RelayState.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => 'Ram', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'OidcSsoConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The SSO configuration parameters for an OIDC protocol-based application.',
'type' => 'object',
'properties' => [
'RedirectUris' => [
'title' => '',
'description' => 'The list of RedirectUris supported by the application.',
'type' => 'array',
'items' => ['description' => 'The RedirectUri supported by the application.', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/oidc/login/callback', 'title' => ''],
'required' => false,
'example' => '',
],
'PostLogoutRedirectUris' => [
'title' => '',
'description' => 'The list of logout callback addresses supported by the application.',
'type' => 'array',
'items' => ['description' => 'The whitelisted logout callback address of the application. The post\\_logout\\_redirect\\_uri parameter can be specified when the application initiates a Logout request.', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/oidc/logout/callback', 'title' => ''],
'required' => false,
'example' => '',
],
'GrantTypes' => [
'title' => '',
'description' => 'The list of supported OIDC protocol grant types.',
'type' => 'array',
'items' => ['description' => 'The supported OIDC protocol grant type. Valid values:'."\n"
.'- authorization\\_code: Authorization code mode.'."\n"
.'- implicit: Implicit mode.'."\n"
.'- refresh\\_token: Token refresh mode.'."\n"
.'- urn:ietf:params:oauth:grant-type:device\\_code: Device mode.'."\n"
.'- password: Password mode.', 'type' => 'string', 'required' => false, 'example' => 'authorization_code', 'title' => ''],
'required' => false,
'example' => 'authorization_code',
],
'ResponseTypes' => [
'title' => '',
'description' => 'The response types supported by the application when OidcSsoConfig.GrantTypes includes the implicit mode.',
'type' => 'array',
'items' => ['description' => 'The OIDC standard parameter ResponseType. This parameter takes effect only when GrantTypes includes the implicit mode. Valid values:'."\n"
.'- token: Returns only the access token.'."\n"
.'- id\\_token: Returns only the ID token.'."\n"
.'- token id\\_token: Returns both the access token and the ID token.', 'type' => 'string', 'required' => false, 'example' => 'token id_token', 'title' => ''],
'required' => false,
'example' => 'token id_token',
],
'GrantScopes' => [
'title' => '',
'description' => 'The OIDC standard parameter scope, which specifies the scope of user attributes that can be returned by the userinfo endpoint or the ID token.',
'type' => 'array',
'items' => ['description' => 'The OIDC standard parameter scope, which specifies the scope of user attributes that can be returned by the userinfo endpoint or the ID token. Valid values:'."\n"
.'- openid: OIDC standard parameter. The unique user ID.'."\n"
.'- profile: Detailed user information.'."\n"
.'- email: User email information.'."\n"
.'- phone: User phone information.', 'type' => 'string', 'required' => false, 'example' => 'openid', 'title' => ''],
'required' => false,
'example' => 'profile,email',
],
'PasswordTotpMfaRequired' => ['title' => '', 'description' => 'Specifies whether TOTP-based secondary authentication is required for the password mode. This parameter takes effect only when the GrantTypes of the OIDC application includes the password mode.', 'type' => 'boolean', 'example' => 'true', 'required' => false],
'PasswordAuthenticationSourceId' => ['title' => '', 'description' => 'The ID of the identity authentication source used for the password mode. This parameter takes effect only when the GrantTypes of the OIDC application includes the password mode.', 'type' => 'string', 'example' => 'ia_password', 'required' => false],
'PkceRequired' => ['title' => '', 'description' => 'Specifies whether the application SSO requires PKCE (RFC 7636).', 'type' => 'boolean', 'example' => 'true', 'required' => false],
'PkceChallengeMethods' => [
'title' => '',
'description' => 'The algorithm used to calculate the Code Challenge in PKCE.',
'type' => 'array',
'items' => ['description' => 'The algorithm used to calculate the Code Challenge in PKCE. Valid values:'."\n"
.'- plain: Plain text.'."\n"
.'- S256: SHA-256 algorithm.', 'type' => 'string', 'required' => false, 'example' => 'S256', 'title' => ''],
'required' => false,
'example' => 'S256',
],
'AccessTokenEffectiveTime' => ['title' => '', 'description' => 'The validity period of the issued access token. Unit: seconds. Default value: 1200 (20 minutes).', 'type' => 'integer', 'format' => 'int64', 'example' => '1200', 'required' => false],
'CodeEffectiveTime' => ['title' => '', 'description' => 'The validity period of the issued code. Unit: seconds. Default value: 60 (1 minute).', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'required' => false],
'IdTokenEffectiveTime' => ['title' => '', 'description' => 'The validity period of the issued ID token. Unit: seconds. Default value: 300 (5 minutes).', 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'required' => false],
'RefreshTokenEffective' => ['title' => '', 'description' => 'The validity period of the issued refresh token. Unit: seconds. Default value: 86400 (1 day).', 'type' => 'integer', 'format' => 'int64', 'example' => '86400', 'required' => false],
'CustomClaims' => [
'title' => '',
'description' => 'The custom user information included in the ID token response.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ClaimName' => ['title' => '', 'description' => 'The name of the returned claim.', 'type' => 'string', 'example' => '"Role"', 'required' => false],
'ClaimValueExpression' => ['title' => '', 'description' => 'The value expression of the returned claim.', 'type' => 'string', 'example' => 'user.dict.applicationRole', 'required' => false],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
'SubjectIdExpression' => ['title' => '', 'description' => 'The custom expression for the sub value returned in the ID token.', 'type' => 'string', 'example' => 'user.userid', 'maxLength' => 128, 'default' => 'user.userid', 'required' => false],
'AllowedPublicClient' => ['title' => '', 'description' => 'Specifies whether the application is allowed to act as a public client to request the IDaaS EIAM authorization server. Only the authorization code mode and device mode support this feature. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'InitLoginType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The initialization single sign-on (SSO) method. Valid values:'."\n"
.'- only\\_app\\_init\\_sso: Only application-initiated SSO. This is the default value for OIDC protocol applications. When a SAML application specifies this method, InitLoginUrl must be specified.'."\n"
.'- idaas\\_or\\_app\\_init\\_sso: SSO initiated from the IDaaS portal or the application. This is the default value for SAML protocol applications. When an OIDC protocol application specifies this method, InitLoginUrl must be specified.', 'type' => 'string', 'example' => 'only_app_init_sso', 'required' => false],
],
[
'name' => 'InitLoginUrl',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The URL that triggers the initialization single sign-on (SSO).'."\n"
.'When an OIDC protocol application sets InitLoginType to idaas\\_or\\_app\\_init\\_sso, this parameter is required.'."\n"
.'When a SAML protocol application sets InitLoginType to only\\_app\\_init\\_sso, this parameter is required.', 'type' => 'string', 'example' => 'http://127.0.0.1:8000/start_login?enterprise_code=ABCDEF', 'required' => false],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.', 'type' => 'string', 'required' => false, 'example' => 'client-examplexxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Set SSO configuration for an EIAM application',
'description' => 'In EIAM, application management supports adding applications that use multiple single sign-on (SSO) protocols (SAML 2.0 and OIDC). However, each application supports only one SSO protocol, which is specified during creation and cannot be changed. Specify the corresponding SSO configuration property parameters based on the SSO protocol type supported by the application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetApplicationSsoConfig'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:SetApplicationSsoConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetDefaultDomain' => [
'summary' => 'Sets a specified domain name of an EIAM instance as the default domain name.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGK16FE'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'DomainId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The domain name ID.', 'type' => 'string', 'required' => true, 'example' => 'dm_examplexxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Set a specified EIAM instance domain name as the default domain name',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDefaultDomain'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetDefaultDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetForgetPasswordConfiguration' => [
'summary' => 'Sets the forgot password policy for an EIAM instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas41RG68'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'eiam-111ccc1111', 'maxLength' => 64],
],
[
'name' => 'ForgetPasswordStatus',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The forgot password configuration status. Valid values:'."\n"
.'- enabled: enabled.'."\n"
.'- disabled: disabled.', 'type' => 'string', 'required' => true, 'example' => 'enabled', 'maxLength' => 32],
],
[
'name' => 'AuthenticationChannels',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of authentication channels. Valid values:'."\n"
.'- email: email.'."\n"
.'- sms: text message.',
'type' => 'array',
'items' => ['description' => 'The forgot password authentication channel. This parameter is required when ForgetPasswordStatus is set to enabled. Valid values:'."\n"
.'- email: email.'."\n"
.'- sms: text message.', 'type' => 'string', 'required' => false, 'example' => 'sms', 'title' => ''],
'required' => false,
'example' => 'email',
'maxLength' => 32,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Set EIAM forgot password policy',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetForgetPasswordConfiguration'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetForgetPasswordConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetIdentityProviderAuthnConfiguration' => [
'summary' => 'Modify Authentication Information',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '139720',
'abilityTreeNodes' => ['FEATUREidaas5N7SJ6'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Identity provider ID.', 'type' => 'string', 'required' => true, 'example' => 'idp_11111', 'maxLength' => 64],
],
[
'name' => 'BindingConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Account binding rule configuration.',
'type' => 'object',
'properties' => [
'MappingBindingStatus' => ['title' => '', 'description' => 'Indicates whether the manual account binding feature is enabled.', 'type' => 'string', 'example' => 'enabled', 'required' => false],
'AutoMatchUserStatus' => ['title' => '', 'description' => 'Indicates whether automatic account matching is enabled.', 'type' => 'string', 'example' => 'disabled', 'required' => false],
'AutoMatchUserProfileExpressions' => [
'title' => '',
'description' => 'Rules for automatic account matching.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TargetField' => ['title' => '', 'description' => 'The name of the mapping target attribute.', 'type' => 'string', 'required' => true, 'example' => 'user.username'],
'SourceValueExpression' => ['title' => '', 'description' => 'The value expression of the mapping attribute.', 'type' => 'string', 'required' => true, 'example' => 'idpUser.userId'],
'ExpressionMappingType' => ['title' => '', 'description' => 'The type of the expression.', 'type' => 'string', 'required' => true, 'example' => 'field'],
'TargetFieldDescription' => ['title' => '', 'description' => 'The description of the mapping target attribute.', 'type' => 'string', 'required' => false, 'example' => 'username'],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'LdapAuthnConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'AD/LDAP authentication configuration.',
'type' => 'object',
'properties' => [
'AutoUpdatePasswordStatus' => ['title' => '', 'description' => 'Indicates whether automatic password update is supported.', 'type' => 'string', 'example' => 'enabled', 'required' => false],
'UserObjectClass' => ['title' => '', 'description' => 'The user ObjectClass.', 'type' => 'string', 'example' => 'posixAccount', 'required' => false],
'UserLoginIdentifier' => ['title' => '', 'description' => 'The user login identifier.', 'type' => 'string', 'example' => 'email', 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'AutoCreateUserConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Automatic account creation rule configuration.',
'type' => 'object',
'properties' => [
'AutoCreateUserStatus' => ['title' => '', 'description' => 'Indicates whether automatic account creation is enabled.', 'type' => 'string', 'example' => 'disabled', 'required' => false],
'TargetOrganizationalUnitIds' => [
'description' => 'The organizational unit IDs.',
'type' => 'array',
'items' => ['description' => 'The organizational unit ID.', 'type' => 'string', 'required' => false, 'example' => 'ou_122xxxx', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'AutoUpdateUserConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'Automatic account update configuration.',
'type' => 'object',
'properties' => [
'AutoUpdateUserStatus' => ['description' => 'Indicates whether automatic account update is enabled.', 'type' => 'string', 'required' => false, 'example' => 'disabled', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ModifyAuthenticationInfo',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetIdentityProviderUdPullConfiguration' => [
'summary' => 'Modifies the inbound synchronization configuration of an Identity Provider (IdP).',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '134734',
'abilityTreeNodes' => ['FEATUREidaas3ZGGWT'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The identity provider ID.', 'type' => 'string', 'required' => true, 'example' => 'idp_my664lwkhpicbyzirog3xxxxx', 'maxLength' => 64],
],
[
'name' => 'IncrementalCallbackStatus',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether to process incremental callback data from the IdP. Valid values:'."\n"
."\n"
.'- disabled: Disabled.'."\n"
."\n"
.'- enabled: Enabled.', 'type' => 'string', 'required' => true, 'example' => 'disabled', 'maxLength' => 32],
],
[
'name' => 'GroupSyncStatus',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['title' => '', 'description' => 'The group synchronization status. Valid values:'."\n"
.'- disabled: Disabled.'."\n"
."\n"
.'- enabled: Enabled.', 'type' => 'string', 'required' => false, 'example' => 'disabled', 'maxLength' => 32],
],
[
'name' => 'UdSyncScopeConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The inbound synchronization scope configuration.',
'type' => 'object',
'properties' => [
'SourceScopes' => [
'title' => '',
'description' => 'The list of source nodes for synchronization.',
'type' => 'array',
'items' => ['description' => 'The source node for synchronization.', 'type' => 'string', 'required' => false, 'example' => 'ou_asdaq1addsxzdq1XXX', 'title' => ''],
'required' => false,
'example' => '',
],
'TargetScope' => ['title' => '', 'description' => 'The target node for synchronization.', 'type' => 'string', 'example' => 'ou_asdaq1addsxzdq1XXX', 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'PullProtectedRule',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The inbound synchronization protection rule.',
'type' => 'object',
'properties' => [
'UserDeletedThreshold' => ['title' => '', 'description' => 'The threshold for the number of deleted accounts. If the number of deleted users exceeds this value, the synchronization task is terminated.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'required' => false],
'OrganizationalUnitDeletedThreshold' => ['title' => '', 'description' => 'The threshold for the number of deleted organizational units. If the number of deleted organizational units exceeds this value, the synchronization task is terminated.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false],
'GroupDeletedThreshold' => ['title' => '', 'description' => 'The threshold for the number of deleted groups. If the number of deleted groups exceeds this value, the synchronization task is terminated.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'LdapUdPullConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The LDAP synchronization configuration.',
'type' => 'object',
'properties' => [
'UserObjectClass' => ['title' => '', 'description' => 'The user ObjectClass.', 'type' => 'string', 'example' => 'userPrincipalName, mail'."\n", 'required' => false],
'OrganizationUnitObjectClass' => ['title' => '', 'description' => 'The organizational unit ObjectClass.', 'type' => 'string', 'example' => 'organizationUnit,top'."\n", 'required' => false],
'UserObjectClassCustomFilter' => ['title' => '', 'description' => 'The custom filter for users.', 'type' => 'string', 'example' => '(|(cn=test)(mail=test@test.com))'."\n", 'required' => false],
'GroupObjectClass' => ['title' => '', 'description' => 'The group ObjectClass.', 'type' => 'string', 'example' => 'group', 'required' => false],
'GroupMemberAttributeName' => ['title' => '', 'description' => 'The group member identifier.', 'type' => 'string', 'example' => 'member', 'required' => false],
'GroupObjectClassCustomFilter' => ['title' => '', 'description' => 'The custom filter for groups.', 'type' => 'string', 'example' => '(|(cn=test)(group=test@test.com))'."\n", 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'PeriodicSyncStatus',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether to periodically verify data differences between IDaaS and the identity provider. Valid values:'."\n"
."\n"
.'- disabled: Disabled.'."\n"
."\n"
.'- enabled: Enabled.', 'type' => 'string', 'example' => 'disabled', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'PeriodicSyncConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The periodic synchronization configuration.',
'type' => 'object',
'properties' => [
'PeriodicSyncType' => [
'title' => '',
'description' => 'The type of periodic synchronization.',
'type' => 'string',
'example' => 'cron',
'enum' => ['cron', 'time'],
'required' => false,
],
'PeriodicSyncCron' => ['title' => '', 'description' => 'The cron expression. This parameter is required when periodicSyncType is set to cron.', 'type' => 'string', 'example' => '0 45 1 * * ?', 'required' => false],
'PeriodicSyncTimes' => [
'title' => '',
'description' => 'The execution time points. This parameter is required when periodicSyncType is set to time. For example, [3, 5] indicates that the task runs once between 3:00 and 4:00 and once between 5:00 and 6:00.',
'type' => 'array',
'items' => ['description' => 'The execution time point.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Set idP inbound synchronization configuration',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetIdentityProviderUdPullConfiguration'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetIdentityProviderUdPushConfiguration' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'eiam-111ccc1111', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['description' => 'The ID of the identity provider.', 'type' => 'string', 'required' => true, 'example' => 'idp_11111', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'IncrementalCallbackStatus',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to process incremental callback data from the IdP.', 'type' => 'string', 'required' => true, 'example' => 'disabled', 'maxLength' => 32, 'title' => ''],
],
[
'name' => 'PeriodicSyncStatus',
'in' => 'query',
'schema' => ['description' => 'The status of periodic synchronization.', 'type' => 'string', 'example' => 'disabled', 'title' => '', 'required' => false],
],
[
'name' => 'UdSyncScopeConfigs',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The push synchronization configurations.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SourceScopes' => [
'description' => 'The source nodes for synchronization.',
'type' => 'array',
'items' => ['description' => 'A source node for synchronization.', 'type' => 'string', 'required' => false, 'example' => 'ou_1212xxxx', 'title' => ''],
'example' => '',
'title' => '',
'required' => false,
],
'TargetScope' => ['description' => 'The target node for synchronization.', 'type' => 'string', 'example' => '6537211', 'title' => '', 'required' => false],
],
'description' => 'A push synchronization configuration.',
'required' => false,
'title' => '',
'example' => '',
],
'example' => '',
'title' => '',
'required' => false,
],
],
[
'name' => 'PeriodicSyncConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'object',
'properties' => [
'PeriodicSyncType' => ['description' => 'The type of periodic synchronization.', 'type' => 'string', 'example' => 'cron', 'title' => '', 'required' => false],
'PeriodicSyncCron' => ['description' => 'The cron expression.', 'type' => 'string', 'example' => '0 45 1 * * ?', 'title' => '', 'required' => false],
'PeriodicSyncTimes' => [
'type' => 'array',
'items' => ['description' => 'A time point.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => '', 'required' => false],
'title' => '',
'description' => 'A collection of time points.',
'required' => false,
'example' => '',
],
],
'title' => '',
'description' => 'The configuration for periodic synchronization.',
'required' => false,
'example' => '',
],
],
[
'name' => 'LdapUdPushConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'object',
'properties' => [
'UserObjectClass' => ['description' => 'The object class for users.', 'type' => 'string', 'example' => 'user,top', 'title' => '', 'required' => false],
'OrganizationUnitObjectClass' => ['description' => 'The object class for organizations.', 'type' => 'string', 'example' => 'ou,top', 'title' => '', 'required' => false],
'UserRdn' => ['description' => 'The Relative Distinguished Name (RDN) for users.', 'type' => 'string', 'example' => 'cn', 'title' => '', 'required' => false],
'OrganizationalUnitRdn' => ['description' => 'The RDN for organizations.', 'type' => 'string', 'example' => 'ou', 'title' => '', 'required' => false],
'PasswordSyncStatus' => ['description' => 'Specifies whether to synchronize passwords.', 'type' => 'string', 'example' => 'enabled', 'title' => '', 'required' => false],
],
'title' => '',
'description' => 'The configurations for LDAP push synchronization.',
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'SetIdentityProviderUdPushConfiguration',
'summary' => 'Modifies the push configuration for an identity provider (IdP).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetInstanceControlConfiguration' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '237884',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ControlElements',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The instance control elements.',
'type' => 'array',
'items' => [
'description' => 'The instance control elements.',
'type' => 'object',
'properties' => [
'ElementName' => ['title' => '', 'description' => 'The name of the instance control element.', 'type' => 'string', 'example' => 'human_verification', 'maxLength' => 64, 'required' => false],
'Status' => ['title' => '', 'description' => 'The status of the instance control element.', 'type' => 'string', 'example' => 'enabled', 'maxLength' => 64, 'required' => false],
'HumanVerificationConfig' => [
'description' => 'The CAPTCHA authenticate configuration.',
'type' => 'object',
'properties' => [
'HumanVerificationType' => ['description' => 'The CAPTCHA type.', 'type' => 'string', 'required' => false, 'example' => 'urn:alibaba:idaas:humanverification:alibaba-cloud-slider-verification', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Set instance control elements',
'summary' => 'Sets the control elements of an instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetInstanceControlConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetInstanceGlobalizationConfig' => [
'summary' => 'Sets the language and time zone information for an instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6GKEFM'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The language type.', 'type' => 'string', 'required' => true, 'example' => 'zh-Hans-CN'],
],
[
'name' => 'TimeZone',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The time zone.', 'type' => 'string', 'required' => true, 'example' => 'Asia/Shanghai'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Set instance language and time zone information',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetInstanceGlobalizationConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetLoginRedirectApplicationForBrand' => [
'summary' => 'Set login redirect application for brand',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCPBRTZ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'BrandId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Brand ID.', 'type' => 'string', 'required' => true, 'example' => 'brand_xxxx'],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'SetLoginRedirectApplicationForBrand',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetLoginRedirectApplicationForBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetPasswordComplexityConfiguration' => [
'summary' => 'Sets the password complexity policy for a specified EIAM instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6KLVYX'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'PasswordMinLength',
'in' => 'query',
'schema' => ['description' => 'The minimum password length.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'maxLength' => 32, 'title' => ''],
],
[
'name' => 'PasswordComplexityRules',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of password complexity rules.',
'type' => 'array',
'items' => [
'description' => 'The object to which the rule applies.',
'type' => 'object',
'properties' => [
'PasswordCheckType' => ['description' => 'The password check type. Valid values:'."\n"
."\n"
.'- inclusion\\_upper\\_case: The password must contain uppercase letters.'."\n"
."\n"
.'- inclusion\\_lower\\_case: The password must contain lowercase letters.'."\n"
."\n"
.'- inclusion\\_special\\_case: The password must contain special characters. The special characters are \\`( @ % + \\ / \' ! # $ ^ ? : , ( ) { } \\[ ] \\~ - \\_ . )\\`.'."\n"
."\n"
.'- inclusion\\_number: The password must contain digits.'."\n"
."\n"
.'- exclusion\\_username: The password cannot contain the username.'."\n"
."\n"
.'- exclusion\\_email: The password cannot contain the mailbox.'."\n"
."\n"
.'- exclusion\\_phone\\_number: The password cannot contain the phone number.'."\n"
."\n"
.'- exclusion\\_display\\_name: The password cannot contain the display name.', 'type' => 'string', 'example' => 'inclusion_upper_case', 'maxLength' => 64, 'title' => '', 'required' => false],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
[
'name' => 'DisabledWeakPasswordLogin',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to disable logon with a weak password.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
'title' => 'SetPasswordComplexityConfiguration',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetPasswordComplexityConfiguration'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetPasswordComplexityConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
],
'SetPasswordExpirationConfiguration' => [
'summary' => 'Sets the password expiration policy for a specified Enterprise Identity and Access Management (EIAM) instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasSOLMDG'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'PasswordExpirationStatus',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The password expiration configuration status. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'required' => true, 'example' => 'enabled', 'maxLength' => 32],
],
[
'name' => 'PasswordValidMaxDay',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The validity period of a password, in days. This parameter is required when PasswordExpirationStatus is set to enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '180', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'PasswordExpirationAction',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The action to take when a password expires. This parameter is required when PasswordExpirationStatus is set to enabled. Valid values:'."\n"
.'- forbid\\_login: Prohibit logon.'."\n"
.'- force\\_update\\_password: Force password change.'."\n"
.'- remind\\_update\\_password: Remind to change password.', 'type' => 'string', 'example' => 'force_update_password', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'PasswordExpirationNotificationStatus',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The password expiration notification status. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enabled', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'PasswordExpirationNotificationChannels',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of password expiration notification channels. This parameter is required when PasswordExpirationNotificationStatus is set to enabled.',
'type' => 'array',
'items' => ['description' => 'The password expiration notification channel. Valid values:'."\n"
.'- login: User logon.'."\n"
.'- email: Email.'."\n"
.'- sms: SMS.', 'type' => 'string', 'required' => false, 'example' => 'login', 'title' => ''],
'required' => false,
'example' => 'login',
'maxLength' => 32,
],
],
[
'name' => 'PasswordExpirationNotificationDuration',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The password expiration notification time, in days. This parameter is required when PasswordExpirationNotificationStatus is set to enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'PasswordForcedUpdateDuration',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The forced password change time, in days. The value of this parameter must be greater than the value of PasswordExpirationNotificationDuration.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'EffectiveAuthenticationSourceIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The list of effective authentication source IDs.',
'type' => 'array',
'items' => ['description' => 'The effective authentication source ID.', 'type' => 'string', 'required' => false, 'example' => 'ia_passwordxxxx', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Set EIAM password expiration policy',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetPasswordExpirationConfiguration'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetPasswordExpirationConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetPasswordHistoryConfiguration' => [
'summary' => 'Sets the password history policy for a specified Enterprise Identity and Access Management (EIAM) instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6L2G67'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'PasswordHistoryStatus',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The status of the password history configuration. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'required' => true, 'example' => 'enabled', 'maxLength' => 32],
],
[
'name' => 'PasswordHistoryMaxRetention',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of recent password records to retain. This parameter is required when PasswordHistoryStatus is set to enabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'maxLength' => 32, 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Set EIAM password history policy',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetPasswordHistoryConfiguration'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:SetPasswordHistoryConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetPasswordInitializationConfiguration' => [
'summary' => 'Sets the password initialization policy for a specified EIAM instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6KLVYX'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'PasswordInitializationStatus',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The password initialization configuration status. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'required' => true, 'example' => 'enabled', 'maxLength' => 32],
],
[
'name' => 'PasswordInitializationType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The password initialization method. This parameter is required when PasswordInitializationStatus is set to enabled. Valid values:'."\n"
.'- random: Random.', 'type' => 'string', 'example' => 'random', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'PasswordForcedUpdateStatus',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The password forced update status. Valid values:'."\n"
.'- enabled: Enabled.'."\n"
.'- disabled: Disabled.', 'type' => 'string', 'example' => 'enabled', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'PasswordInitializationNotificationChannels',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of password initialization notification channels.',
'type' => 'array',
'items' => ['description' => 'The password initialization notification channel. This parameter is required when PasswordForcedUpdateStatus is set to enabled. Valid values:'."\n"
.'- email: Email.'."\n"
.'- sms: SMS.', 'type' => 'string', 'required' => false, 'example' => 'email', 'title' => ''],
'required' => false,
'example' => 'email',
'maxLength' => 32,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Set EIAM password initialization policy',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetPasswordInitializationConfiguration'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetPasswordInitializationConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetPrimaryClientPublicKey' => [
'summary' => 'Sets the specified client public key as the primary key for an application.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ClientPublicKeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the client public key for the application.', 'type' => 'string', 'required' => true, 'example' => 'KEYEqDnDJhztiEAwSin7MZoxGcihzCAuxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token used to ensure the idempotence of a request. You must generate a unique value for this parameter from your client. The token can contain only ASCII characters and cannot be more than 64 characters in length. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'SetPrimaryClientPublicKey',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetPrimaryClientPublicKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/{#ClientPublicKeyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetUserPrimaryOrganizationalUnit' => [
'summary' => 'Updates the primary organizational unit to which an Identity as a Service (IDaaS) Employee Identity and Access Management (EIAM) account belongs. This account will be removed from the previous primary organizational unit and added to the new primary organization.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYZ4AR1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the new primary organizational unit.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'SetUserPrimaryOrganizationalUnit',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUserPrimaryOrganizationalUnit'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'SetWebAuthnConfiguration' => [
'summary' => 'Sets the WebAuthn configuration.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasKRQSDS'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'EnableUserSelfRegistration',
'in' => 'query',
'schema' => ['description' => 'Allow user self-registration of WebAuthn authenticators.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''],
],
[
'name' => 'EnableMetadataServiceVerification',
'in' => 'query',
'schema' => ['description' => 'Enable WebAuthn authenticator MDS verification.', 'type' => 'boolean', 'example' => 'true', 'title' => '', 'required' => false],
],
[
'name' => 'EnableAaguidVerification',
'in' => 'query',
'schema' => ['description' => 'Enable AAGUID verification.', 'type' => 'boolean', 'example' => 'true', 'title' => '', 'required' => false],
],
[
'name' => 'Aaguids',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'List of AAGUIDs and their names.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => 'AAGUID name.', 'type' => 'string', 'example' => 'Touch ID', 'title' => '', 'required' => false],
'Aaguid' => ['description' => 'AAGUID.', 'type' => 'string', 'example' => 'adce0002-35bc-c60a-648b-0b25f1f05503', 'title' => '', 'required' => false],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
'title' => '',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'SetWebAuthnConfiguration',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetWebAuthnConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UnbindTotpAuthenticator' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => 'User ID', 'type' => 'string', 'required' => true, 'example' => 'user_1asdfghjmnbcxxxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UnbindTotpAuthenticator',
'summary' => 'Detaches the TOTP authenticator for a specified user.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UnbindUserAuthnSourceMapping' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'title' => '', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'title' => '', 'example' => 'user_ue2jvisn35exxxxx'],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['description' => 'The ID of the source identity provider.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'title' => '', 'example' => 'idp_my664lwkhpicbyzirog3xxxxx'],
],
[
'name' => 'UserExternalId',
'in' => 'query',
'schema' => ['description' => 'The external ID associated with the user.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'title' => '', 'example' => 'xxxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UnbindUserAuthnSourceMapping',
'summary' => 'Unbinds a third-party logon account from a user.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UnbindUserAuthnSourceMapping',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UnlockUser' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas1FXU07', 'FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Unlock an EIAM account',
'summary' => 'Unlocks a locked EIAM account.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockUser'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateApplicationAdvancedConfig' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ', 'FEATUREidaasJXI2A5'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ScimServerAdvancedConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The SCIM server advanced configuration.',
'type' => 'object',
'properties' => [
'UserCustomFieldNamespace' => ['title' => '', 'description' => 'The namespace of user extended fields.', 'type' => 'string', 'example' => 'urn:ietf:params:scim:schemas:extension:customfield:2.0:User', 'required' => false],
'SupportedUserCustomFieldIds' => [
'title' => '',
'description' => 'The list of supported user custom field IDs.',
'type' => 'array',
'items' => ['description' => 'The supported user custom field ID.', 'type' => 'string', 'required' => false, 'example' => 'ufd_ymjguxxxxxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Modify application advanced configuration',
'summary' => 'Modifies the advanced configuration of an application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationAdvancedConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateApplicationAuthorizationType' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the application that you want to modify.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization type of the application. Valid values:'."\n"
."\n"
.'* authorize_required: Only the user with explicit authorization can access the application.'."\n"
.'* default_all: By default, all users can access the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'authorize_required', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateApplicationAuthorizationType',
'summary' => 'Modifies the authorization type of an Employee Identity and Access Management (EIAM) application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApplicationAuthorizationType'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationAuthorizationType',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateApplicationClientSecretExpirationTime' => [
'summary' => 'Updates the expiration time of a specified ClientSecret for an application.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasLLYTIX'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'SecretId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client secret.', 'type' => 'string', 'required' => true, 'example' => 'sct_11111', 'maxLength' => 64],
],
[
'name' => 'ExpirationTime',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The expiration time of the client secret. The value is a UNIX timestamp in milliseconds. The minimum validity period that can be set is 1 day, and the maximum validity period is 3 years.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1735530123762', 'maxLength' => 128],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Update the client secret validity period of an EIAM application',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationClientSecretExpirationTime',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/{#SecretId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateApplicationDescription' => [
'summary' => 'Modifies the description of an Employee Identity and Access Management (EIAM) application.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ', 'FEATUREidaasJXI2A5'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk2676xxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the application that you want to modify.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the application.', 'type' => 'string', 'example' => 'Demo application for testing', 'maxLength' => 128, 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
'title' => 'UpdateApplicationDescription',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApplicationDescription'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
],
'UpdateApplicationFederatedCredential' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationFederatedCredentialId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application federated credential ID.', 'type' => 'string', 'required' => true, 'example' => 'afc_aaaaa1111', 'maxLength' => 64],
],
[
'name' => 'VerificationCondition',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The verification condition.', 'type' => 'string', 'example' => 'IsNullOrEmpty("")', 'required' => false],
],
[
'name' => 'AttributeMappings',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The attribute mappings.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SourceValueExpression' => ['title' => '', 'description' => 'The source value expression.', 'type' => 'string', 'example' => 'Append(client.applicationFederatedCredentialId, ":", cert.subject.CN, ":", cert.serialNumber)', 'required' => false],
'TargetField' => ['title' => '', 'description' => 'The target field.', 'type' => 'string', 'example' => 'client.activeSubjectUrn'."\n", 'required' => false],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
[
'name' => 'OidcVerificationConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The OIDC structured configuration (structured mode + oidc type).',
'type' => 'object',
'properties' => [
'Profile' => ['description' => 'The OIDC scenario profile. Valid values: generic, kubernetes, gcp_vm, and azure_vm.', 'type' => 'string', 'example' => 'kubernetes', 'maxLength' => 32, 'title' => ''],
'KubernetesConfig' => [
'description' => 'The Kubernetes scenario configuration.',
'type' => 'object',
'properties' => [
'Namespace' => ['description' => 'The Kubernetes namespace.', 'type' => 'string', 'example' => 'default', 'maxLength' => 128, 'title' => ''],
'ServiceAccountName' => ['description' => 'The Kubernetes service account name.', 'type' => 'string', 'example' => 'my-sa', 'maxLength' => 128, 'title' => ''],
'PodNamePrefix' => ['description' => 'The pod name prefix.', 'type' => 'string', 'example' => 'my-pod-', 'maxLength' => 128, 'title' => ''],
],
'example' => '',
'title' => '',
],
'GcpVmConfig' => [
'description' => 'The GCP VM scenario configuration.',
'type' => 'object',
'properties' => [
'ServiceAccountId' => ['description' => 'The sub value corresponding to the service account.', 'type' => 'string', 'example' => '123456789', 'maxLength' => 128, 'title' => ''],
'InstanceIds' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
'ProjectId' => ['type' => 'string', 'maxLength' => 128, 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
'title' => '',
],
'AzureVmConfig' => [
'description' => 'The Azure VM scenario configuration.',
'type' => 'object',
'properties' => [
'ResourceGroupName' => ['type' => 'string', 'maxLength' => 128, 'description' => '', 'title' => '', 'example' => ''],
'VmNames' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
'SubscriptionId' => ['type' => 'string', 'maxLength' => 128, 'description' => '', 'title' => '', 'example' => ''],
'PrincipalId' => ['type' => 'string', 'maxLength' => 128, 'description' => '', 'title' => '', 'example' => ''],
],
'example' => '',
'title' => '',
],
'GenericConfig' => [
'type' => 'object',
'properties' => [
'Subject' => ['type' => 'string', 'maxLength' => 128, 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'example' => '',
'title' => '',
],
],
[
'name' => 'Pkcs7VerificationConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The PKCS#7 structured configuration (structured mode + pkcs7 type).',
'type' => 'object',
'properties' => [
'InstanceIds' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'example' => '',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Update application federated credential',
'summary' => 'Updates a federated credential for an application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationFederatedCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/{#ApplicationFederatedCredentialId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateApplicationFederatedCredentialDescription' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationFederatedCredentialId',
'in' => 'query',
'schema' => ['description' => 'The ID of the application\'s federated credential.', 'type' => 'string', 'required' => true, 'example' => 'afc_aaaaa1111', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the federated credential.', 'type' => 'string', 'example' => 'test', 'maxLength' => 128, 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateApplicationFederatedCredentialDescription',
'summary' => 'Updates the description of a federated credential for an application.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationFederatedCredentialDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/{#ApplicationFederatedCredentialId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateApplicationInfo' => [
'summary' => 'Updates the basic information of an application.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '114493',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'Ram Account SSO', 'maxLength' => 64],
],
[
'name' => 'LogoUrl',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The URL of the application logo.', 'type' => 'string', 'example' => 'https://example.aliyuncs.com/logo.png', 'maxLength' => 512, 'required' => false],
],
[
'name' => 'ApplicationVisibility',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The application visibility settings.',
'type' => 'array',
'items' => ['description' => 'The application visibility enum element.', 'type' => 'string', 'required' => false, 'example' => 'web', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The idempotence token.', 'type' => 'string', 'required' => false, 'example' => 'client-token-example'."\n", 'title' => ''],
],
[
'name' => 'CustomFields',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Operation' => [
'type' => 'string',
'maxLength' => 32,
'enum' => ['add', 'replace', 'remove'],
'description' => '',
'title' => '',
'example' => '',
],
'FieldName' => ['type' => 'string', 'maxLength' => 64, 'description' => '', 'title' => '', 'example' => ''],
'FieldValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'maxItems' => 200,
'description' => '',
'title' => '',
'example' => '',
],
],
[
'name' => 'ApplicationOwner',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'object',
'properties' => [
'UserIds' => [
'type' => 'array',
'items' => ['type' => 'string', 'maxLength' => 64, 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
'GroupIds' => [
'type' => 'array',
'items' => ['type' => 'string', 'maxLength' => 64, 'description' => '', 'title' => '', 'example' => ''],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'gatewayOptions' => [
'gatewayProtocols' => [],
],
'title' => 'Update application basic information',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateApplicationRole' => [
'summary' => 'Updates an application role.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationRoleName',
'in' => 'query',
'schema' => ['description' => 'The name of the application role.', 'type' => 'string', 'required' => true, 'example' => 'Admin Role', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationRoleId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'The ID of the application role.', 'type' => 'string', 'required' => true, 'example' => 'approle_01kh2vuo8v9splv8maak1d22rxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You must make sure that the token is unique for each request. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/en/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateApplicationRole',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationrole/{#ApplicationRoleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateApplicationRoleDescription' => [
'summary' => 'Modifies the description of an application role.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasYLK5S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'ApplicationRoleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The application role ID.', 'type' => 'string', 'required' => true, 'example' => 'approle_01kh2vuo8v9splv8maak1d22rxxxx', 'maxLength' => 64],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description of the application role.', 'type' => 'string', 'required' => false, 'example' => 'Admin Role Description'."\n", 'maxLength' => 128],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Modify application role description',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationRoleDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationrole/{#ApplicationRoleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateApplicationSsoFormParams' => [
'summary' => 'Updates the SSO parameters for an application template.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas40OLQJ', 'FEATUREidaasJXI2A5'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'eiam-111ccc1111', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the application.', 'type' => 'string', 'required' => true, 'example' => 'app_11111', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationTemplateParams',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The parameters for creating the application template.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TemplateParamName' => ['description' => 'The name of a parameter for creating the application template.', 'type' => 'string', 'example' => 'aliyunUid', 'title' => '', 'required' => false],
'TemplateParamValue' => ['description' => 'The value of the parameter for creating the application template.', 'type' => 'string', 'example' => '123456789', 'title' => '', 'required' => false],
],
'description' => 'The parameters for modifying the template.',
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'example' => '',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateApplicationSsoFormParams',
'description' => 'Updates the single sign-on (SSO) parameters for an application template from the marketplace.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationSsoFormParams',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateApplicationTokenExpirationTime' => [
'summary' => 'Updates the expiration time of an application token.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasSQHOGI'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'title' => '', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'title' => '', 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx'],
],
[
'name' => 'ApplicationTokenId',
'in' => 'query',
'schema' => ['description' => 'The application token ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'title' => '', 'example' => 'token_sfrwerxxxxxxxxxxxxxx'],
],
[
'name' => 'ExpirationTime',
'in' => 'query',
'schema' => ['description' => 'The expiration time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maxLength' => 128, 'title' => '', 'example' => '1735530123762'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateApplicationTokenExpirationTime',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationTokenExpirationTime',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/{#ApplicationTokenId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateAuthorizationRule' => [
'summary' => 'Updates the basic properties of an authorization rule.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'AuthorizationRuleName',
'in' => 'query',
'schema' => ['description' => 'The name of the authorization rule. The name can be up to 64 characters long.', 'type' => 'string', 'example' => 'test_rule', 'maxLength' => 64, 'title' => '', 'required' => false],
],
[
'name' => 'AuthorizationResourceScope',
'in' => 'query',
'schema' => ['description' => 'The scope of the authorized resources. Valid values:'."\n"
."\n"
.'- global: global resources within the project.'."\n"
."\n"
.'- custom: specified resources within the project.', 'type' => 'string', 'example' => 'global', 'maxLength' => 64, 'title' => '', 'required' => false],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'A client token that ensures the idempotence of the request. Generate a unique value for this parameter from your client. The token can contain only ASCII characters and must be no more than 64 characters in length. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateAuthorizationRule',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateAuthorizationRuleApplicationAttachment' => [
'summary' => 'Updates the properties of the relationship between an authorization rule and an application.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'title' => ''],
],
[
'name' => 'ValidityType',
'in' => 'query',
'schema' => ['description' => 'The validity type of the relationship. Valid values:'."\n"
."\n"
.'- permanent: The relationship is permanent.'."\n"
."\n"
.'- time\\_bound: The relationship is valid for a custom time range.', 'type' => 'string', 'required' => true, 'example' => 'permanent', 'maxLength' => 32, 'title' => ''],
],
[
'name' => 'ValidityPeriod',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The time range of the validity period. This parameter takes effect only when **ValidityType** is set to **time\\_bound**.',
'type' => 'object',
'properties' => [
'StartTime' => ['description' => 'The start time of the validity period. This is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000', 'maxLength' => 64, 'title' => '', 'required' => false],
'EndTime' => ['description' => 'The end time of the validity period. This is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704062061000', 'maxLength' => 64, 'title' => '', 'required' => false],
],
'example' => '',
'title' => '',
'required' => false,
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'A client token to ensure the idempotence of the request. Generate a unique value from your client for this parameter. The ClientToken can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateAuthorizationRuleApplicationAttachment',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateAuthorizationRuleApplicationAttachment',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateAuthorizationRuleDescription' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description of the authorization rule. The description can be up to 128 characters in length.', 'type' => 'string', 'example' => 'this is a test rule', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but make sure that the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References: [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Update the description of an authorization rule',
'summary' => 'Updates the description of an authorization rule.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateAuthorizationRuleDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateAuthorizationRuleGroupAttachment' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The group ID.', 'type' => 'string', 'required' => true, 'example' => 'group_miu8e4t4d7i4u7uwezgr54xxxx', 'maxLength' => 64],
],
[
'name' => 'ValidityType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The validity type of the relationship. Valid values:'."\n"
."\n"
.'- permanent: permanent'."\n"
.'- time_bound: custom time range.', 'type' => 'string', 'required' => true, 'example' => 'permanent', 'maxLength' => 32],
],
[
'name' => 'ValidityPeriod',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The time range of the validity period. This parameter takes effect only when **ValidityType** is set to **time_bound**.',
'type' => 'object',
'properties' => [
'StartTime' => ['title' => '', 'description' => 'The start time of the validity period, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000', 'maxLength' => 64, 'required' => false],
'EndTime' => ['title' => '', 'description' => 'The end time of the validity period, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704062061000', 'maxLength' => 64, 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Update relationship properties between an authorization rule and a group',
'summary' => 'Updates the relationship properties between an authorization rule and a group.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateAuthorizationRuleGroupAttachment',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateAuthorizationRuleUserAttachment' => [
'summary' => 'Updates the relationship properties between an authorization rule and an account.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasHRHJG3'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationRuleId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization rule ID.', 'type' => 'string', 'required' => true, 'example' => 'arrule_01kf143ug06fg7m9f43u7vahxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 64],
],
[
'name' => 'ValidityType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The validity type of the relationship. Valid values:'."\n"
.'- permanent: permanent'."\n"
.'- time_bound: custom time range.', 'type' => 'string', 'required' => true, 'example' => 'permanent', 'maxLength' => 32],
],
[
'name' => 'ValidityPeriod',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The time range of the validity period. This parameter takes effect only when **ValidityType** is set to **time_bound**.',
'type' => 'object',
'properties' => [
'StartTime' => ['title' => '', 'description' => 'The start time of the validity period, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704042061000', 'maxLength' => 64, 'required' => false],
'EndTime' => ['title' => '', 'description' => 'The end time of the validity period, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1704062061000', 'maxLength' => 64, 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Update relationship properties between an authorization rule and an account',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateAuthorizationRuleUserAttachment',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateAuthorizationServer' => [
'summary' => 'Updates the configuration of an authorization server.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationServerId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization server ID.', 'type' => 'string', 'required' => true, 'example' => 'iauths_system', 'maxLength' => 64],
],
[
'name' => 'AuthorizationServerName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The name of the authorization server.', 'type' => 'string', 'example' => 'my_authorization_server', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'IssuerMode',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The issuer mode.', 'type' => 'string', 'example' => 'dynamic', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'IssuerDomain',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The domain name used by the issuer.', 'type' => 'string', 'example' => 'xxxx.aliyunidaas.com', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but you must make sure that the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References: [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'abc123xyz'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Update an authorization server',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateAuthorizationServerDescription' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'AuthorizationServerId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authorization server ID.', 'type' => 'string', 'required' => true, 'example' => 'iauths_system', 'maxLength' => 64],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description of the authorization server.', 'type' => 'string', 'example' => 'description of authorization server', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotence of the request. Generate a parameter value from your client to ensure that the value is unique among different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters in length. For more information, refer to References: [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'abc123xyz'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Update authorization server description',
'summary' => 'Updates the description of an authorization server.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateBrand' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCPBRTZ'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'BrandId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The brand ID.', 'type' => 'string', 'required' => true, 'example' => 'brand_xxxx'],
],
[
'name' => 'BrandName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The brand name.', 'type' => 'string', 'required' => true, 'example' => 'Custom Brand'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Update a brand',
'summary' => 'Modifies a brand.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateCloudAccount' => [
'summary' => 'Updates the basic information of an Alibaba Cloud account.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CloudAccountId',
'in' => 'query',
'schema' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'required' => true, 'example' => 'ca_01kmegjc11qa1txxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CloudAccountName',
'in' => 'query',
'schema' => ['description' => 'The name of the Alibaba Cloud account.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'example' => 'cloud_account_xxx', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token used to ensure the idempotence of the request. Generate a value from your client that is unique across different requests. The token can contain only ASCII characters and must be no more than 64 characters in length. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateCloudAccount',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCloudAccount',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateCloudAccountDescription' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CloudAccountId',
'in' => 'query',
'schema' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'required' => true, 'example' => 'ca_01kmegjc11qa1txxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => 'cloud_account_description', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of the request. Generate a unique value for this parameter from your client for each request. The ClientToken can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateCloudAccountDescription',
'summary' => 'Updates the description of an Alibaba Cloud account.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCloudAccountDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateCloudAccountRoleDescription' => [
'summary' => 'Updates the description of a cloud role.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CloudAccountId',
'in' => 'query',
'schema' => ['description' => 'The cloud account ID.', 'type' => 'string', 'required' => true, 'example' => 'ca_01kmegjc11qa1txxxxx', 'title' => ''],
],
[
'name' => 'CloudAccountRoleId',
'in' => 'query',
'schema' => ['description' => 'The cloud role ID.', 'type' => 'string', 'required' => true, 'example' => 'carole_01kmek49aqxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the cloud role.', 'type' => 'string', 'required' => false, 'example' => 'cloud_account_role_description', 'maxLength' => 128, 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token used to ensure the idempotence of the request. Generate a unique value for this parameter from your client. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'example' => 'client-token-example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateCloudAccountRoleDescription',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCloudAccountRoleDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}/cloudaccountrole/{#CloudAccountRoleId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateConditionalAccessPolicy' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231635',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ConditionalAccessPolicyId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The conditional access policy ID.', 'type' => 'string', 'required' => true, 'example' => 'cap_11111', 'maxLength' => 64],
],
[
'name' => 'ConditionalAccessPolicyName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The conditional access policy name.', 'type' => 'string', 'required' => true, 'example' => 'My conditional access policy', 'maxLength' => 64],
],
[
'name' => 'DecisionType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The execution type of the conditional access policy.', 'type' => 'string', 'required' => true, 'example' => 'reportOnly', 'maxLength' => 32],
],
[
'name' => 'DecisionConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The action configuration of the conditional access policy.',
'type' => 'object',
'properties' => [
'Effect' => ['title' => '', 'description' => 'The decision action of the conditional access policy.', 'type' => 'string', 'example' => 'allow', 'required' => false],
'MfaType' => ['title' => '', 'description' => 'The MFA type of the conditional access policy.', 'type' => 'string', 'example' => 'directly_access', 'required' => false],
'MfaAuthenticationIntervalSeconds' => ['title' => '', 'description' => 'The interval in seconds for repeated MFA authentication of the conditional access policy.', 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'required' => false],
'MfaAuthenticationMethods' => [
'title' => '',
'description' => 'The MFA methods allowed by the conditional access policy.',
'type' => 'array',
'items' => ['description' => 'The MFA methods allowed by the conditional access policy. Valid values:'."\n"
.'- ia_otp_sms: SMS verification code.'."\n"
.'- ia_otp_email: Email verification code.'."\n"
.'- ia_totp: OTP dynamic password.'."\n"
.'- ia_webauthn: WebAuthn.', 'type' => 'string', 'required' => false, 'example' => 'ia_otp_sms', 'title' => ''],
'required' => false,
'example' => '',
],
'ActiveSessionReuseStatus' => ['description' => 'Specifies whether to enable session reuse.', 'type' => 'string', 'example' => 'enabled', 'required' => false, 'title' => ''],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'ConditionsConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The condition configuration of the conditional access policy.',
'type' => 'object',
'properties' => [
'Applications' => [
'title' => '',
'description' => 'The target applications of the conditional access policy.',
'type' => 'object',
'properties' => [
'IncludeApplications' => [
'title' => '',
'description' => 'The included applications.',
'type' => 'array',
'items' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'app_xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'ExcludeApplications' => [
'title' => '',
'description' => 'The excluded applications.',
'type' => 'array',
'items' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'app_xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
'Users' => [
'title' => '',
'description' => 'The target users of the conditional access policy.',
'type' => 'object',
'properties' => [
'IncludeUsers' => [
'title' => '',
'description' => 'The included users.',
'type' => 'array',
'items' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => 'user_xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'ExcludeUsers' => [
'title' => '',
'description' => 'The excluded users.',
'type' => 'array',
'items' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => 'user_xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'IncludeGroups' => [
'title' => '',
'description' => 'The included user groups.',
'type' => 'array',
'items' => ['description' => 'The user group ID.', 'type' => 'string', 'required' => false, 'example' => 'group_xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'ExcludeGroups' => [
'title' => '',
'description' => 'The excluded user groups.',
'type' => 'array',
'items' => ['description' => 'The user group ID.', 'type' => 'string', 'required' => false, 'example' => 'group_xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'IncludeOrganizationalUnits' => [
'title' => '',
'description' => 'The included organizational units.',
'type' => 'array',
'items' => ['description' => 'The organizational unit ID.', 'type' => 'string', 'required' => false, 'example' => 'ou_xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'ExcludeOrganizationalUnits' => [
'title' => '',
'description' => 'The excluded organizational units.',
'type' => 'array',
'items' => ['description' => 'The organizational unit ID.', 'type' => 'string', 'required' => false, 'example' => 'ou_xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
'NetworkZones' => [
'title' => '',
'description' => 'The network zones of the conditional access policy.',
'type' => 'object',
'properties' => [
'IncludeNetworkZones' => [
'title' => '',
'description' => 'The included network zones.',
'type' => 'array',
'items' => ['description' => 'The network zone ID.', 'type' => 'string', 'required' => false, 'example' => 'network_xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
'ExcludeNetworkZones' => [
'title' => '',
'description' => 'The excluded network zones.',
'type' => 'array',
'items' => ['description' => 'The network zone ID.', 'type' => 'string', 'required' => false, 'example' => 'network_xxxxx', 'title' => ''],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The priority of the conditional access policy.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. The value of this parameter is generated by the client and must be unique across different requests.', 'type' => 'string', 'required' => false, 'example' => 'client-examplexxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Update a conditional access policy',
'summary' => 'Updates a conditional access policy.',
'description' => 'Updates a conditional access policy.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConditionalAccessPolicy'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateConditionalAccessPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/{#ConditionalAccessPolicyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateConditionalAccessPolicyDescription' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231636',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'ConditionalAccessPolicyId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The conditional access policy ID.', 'type' => 'string', 'required' => true, 'example' => 'cap_11111', 'maxLength' => 64],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description of the conditional access policy.', 'type' => 'string', 'required' => true, 'example' => 'Test description', 'maxLength' => 128],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. The value of this parameter is generated by the client and must be unique across different requests.', 'type' => 'string', 'required' => false, 'example' => 'client-examplexxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Update conditional access policy description',
'summary' => 'Updates the description of a conditional access policy.',
'description' => 'Updates the description of a conditional access policy.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConditionalAccessPolicyDescription'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
'translator' => 'machine',
],
'UpdateCredential' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CredentialId',
'in' => 'query',
'schema' => ['description' => 'The credential ID.', 'type' => 'string', 'required' => true, 'example' => 'cred_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CredentialName',
'in' => 'query',
'schema' => ['description' => 'The credential name.', 'type' => 'string', 'example' => 'credential_name', 'maxLength' => 64, 'title' => '', 'required' => false],
],
[
'name' => 'CredentialContent',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => 'The credential content.',
'type' => 'object',
'properties' => [
'OAuthClientContent' => [
'description' => 'The credential content for an OAuth client authentication credential type.',
'type' => 'object',
'properties' => [
'ClientId' => ['description' => 'The client\\_id in the OAuth protocol.', 'type' => 'string', 'example' => 'dmvncmxersdxxxxxx', 'title' => '', 'required' => false],
'ClientSecret' => ['description' => 'The client\\_secret in the OAuth protocol.', 'type' => 'string', 'example' => 'nsklncmwizncxxxx', 'title' => '', 'required' => false],
],
'example' => '',
'title' => '',
'required' => false,
],
'ApiKeyContent' => [
'description' => 'The credential content for an API key credential type.',
'type' => 'object',
'properties' => [
'ApiKey' => ['description' => 'The API key value.', 'type' => 'string', 'example' => 'nsklnertyt5ddwizncxxxx', 'title' => '', 'required' => false],
],
'example' => '',
'title' => '',
'required' => false,
],
],
'required' => false,
'example' => '',
'title' => '',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'Ensures idempotence. Generate a unique value on your client for each request. The ClientToken value must contain only ASCII characters and cannot exceed 64 characters. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'maxLength' => 64, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateCredential',
'summary' => 'Update basic information for a credential.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateCredentialDescription' => [
'summary' => 'Updates the description of a credential.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'CredentialId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The credential ID.', 'type' => 'string', 'required' => true, 'example' => 'cred_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description of the credential.', 'type' => 'string', 'example' => 'credential_description', 'maxLength' => 128, 'required' => false],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Update the description of a credential',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCredentialDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateCredentialProvider' => [
'summary' => 'Updates a credential provider.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'CredentialProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The credential provider ID.', 'type' => 'string', 'required' => true, 'example' => 'atp_01kr2cmj5gxxx4fvmls2e93dxxxxx', 'maxLength' => 64],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The idempotency token that ensures the idempotence of the request.'."\n"
."\n"
.'Generate a unique parameter value from your client to ensure that the value is unique among different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters in length. For more information, see References: [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).', 'type' => 'string', 'required' => true, 'example' => 'client-token-example'],
],
[
'name' => 'CredentialProviderName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The credential provider name.'."\n"
."\n"
.'> The name cannot exceed 64 characters in length.', 'type' => 'string', 'example' => 'test_example_name', 'maxLength' => 64, 'required' => false],
],
[
'name' => 'CredentialProviderConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The credential provider configuration.',
'type' => 'object',
'properties' => [
'OAuthProviderConfig' => [
'title' => '',
'description' => 'The configuration of the OAuth credential provider.',
'type' => 'object',
'properties' => [
'ClientSecret' => ['title' => '', 'description' => 'The client_secret in the OAuth protocol, which is the client secret.'."\n"
."\n"
.'> The value cannot exceed 1024 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'client_secret_example_xxx'],
'TokenEndpoint' => ['title' => '', 'description' => 'The token endpoint of the OAuth protocol.'."\n"
."\n"
.'> The value must start with `http://` or `https://` and cannot exceed 1024 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/token'],
'Scope' => ['title' => '', 'description' => 'The scope in the OAuth protocol, which specifies the permission scope.'."\n"
."\n"
.'> The Scope configuration at the credential provider serves as the default value. If the scope parameter is not specified when calling the DeveloperAPI to obtain an OAuth Access Token, the Scope configuration at the credential provider is used for issuance.'."\n"
."\n"
.'>Separate multiple Scope values with spaces. To clear the Scope configuration, pass an empty string.>'."\n"
."\n"
.'Restrictions on a single Scope value:'."\n"
.'1. Allowed characters: lowercase letters, digits, and special characters `|/:_-.`'."\n"
.'2. Must contain at least one lowercase letter or digit.'."\n"
.'3. Must start with a special character `.`, a lowercase letter, or a digit.'."\n"
.'4. Cannot exceed 1024 characters in length.', 'type' => 'string', 'example' => 'example:test_01 example:test_02', 'required' => false],
],
'required' => false,
'example' => '',
],
'JwtProviderConfig' => [
'title' => '',
'description' => 'The configuration of the JWT credential provider.',
'type' => 'object',
'properties' => [
'Expiration' => ['title' => '', 'description' => 'The validity period of the JWT, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '900', 'required' => false],
'ExpirationCleanupEnabled' => ['title' => '', 'description' => 'Specifies whether to enable JWT expiration cleanup.', 'type' => 'boolean', 'example' => 'true', 'required' => false],
'DerivedShortTokenEnabled' => ['title' => '', 'description' => 'Specifies whether to enable the JWT derived short token feature.', 'type' => 'boolean', 'example' => 'false', 'required' => false],
'AllowedTokenIssuers' => [
'title' => '',
'description' => 'The list of allowed JWT issuers.'."\n"
."\n"
.'> The list cannot contain more than 200 entries.'."\n"
."\n"
.'>To clear the issuer list, pass an empty list or an empty string.>',
'type' => 'array',
'items' => ['title' => '', 'description' => 'The allowed JWT issuer.'."\n"
."\n"
.'> The value cannot exceed 1024 characters in length.', 'type' => 'string', 'example' => 'https://test.issuer.com', 'required' => false],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Update a credential provider',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateCredentialProviderDescription' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasDPGRH1'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CredentialProviderId',
'in' => 'query',
'schema' => ['description' => 'The ID of the credential provider.', 'type' => 'string', 'required' => true, 'example' => 'atp_01kr2cmj5gxxx4fvmls2e93dxxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'A description of the credential provider.'."\n"
."\n"
.'> The description can be up to 128 characters long.', 'type' => 'string', 'required' => false, 'example' => 'This is an example description', 'maxLength' => 128, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'UpdateCredentialProviderDescription',
'summary' => 'Update the description of a credential provider.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCredentialProviderDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateCustomPrivacyPolicy' => [
'summary' => 'Updates a custom privacy policy.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas4TD7D0'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'CustomPrivacyPolicyName',
'in' => 'query',
'schema' => ['description' => 'The name of the custom privacy policy.', 'type' => 'string', 'required' => false, 'example' => 'Custom Privacy Policy Name', 'title' => ''],
],
[
'name' => 'UserConsentType',
'in' => 'query',
'schema' => [
'description' => 'The consent type for the custom privacy policy.',
'enumValueTitles' => ['explicit_consent' => 'Users must manually select the checkbox to agree.', 'implied_consent' => 'Users agree by default.'],
'type' => 'string',
'required' => false,
'example' => 'implied_consent',
'title' => '',
],
],
[
'name' => 'CustomPrivacyPolicyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the custom privacy policy.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'example' => 'pp_neagxpoznsjdtxxxxx', 'title' => ''],
],
[
'name' => 'DefaultLanguageCode',
'in' => 'query',
'schema' => ['description' => 'The default language of the policy. The value is the LanguageCode returned by the ListLanguages operation.', 'type' => 'string', 'required' => false, 'example' => 'zh-Hans-CN', 'title' => ''],
],
[
'name' => 'CustomPrivacyPolicyContents',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CustomPrivacyPolicyTip' => ['description' => 'The prompt for the custom privacy policy content.', 'type' => 'string', 'required' => false, 'example' => 'Please read and agree:', 'title' => ''],
'LanguageCode' => ['description' => 'The language of the custom privacy policy. The value is the LanguageCode returned by the ListLanguages operation.', 'type' => 'string', 'required' => false, 'example' => 'zh-Hans-CN', 'title' => ''],
'CustomPrivacyPolicyItems' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CustomPrivacyPolicyItemName' => ['description' => 'The name of the custom privacy policy item.', 'type' => 'string', 'required' => false, 'example' => 'Item Name', 'title' => ''],
'CustomPrivacyPolicyItemUrl' => ['description' => 'The endpoint of the custom privacy policy item. The value must start with https\\://.', 'type' => 'string', 'required' => false, 'example' => 'https://example.com', 'title' => ''],
],
'description' => 'The items of the custom privacy policy.',
'required' => false,
'title' => '',
'example' => '',
],
'description' => 'The items of the custom privacy policy.',
'required' => false,
'title' => '',
'example' => '',
],
],
'description' => 'The details of the custom privacy policy content.',
'required' => false,
'title' => '',
'example' => '',
],
'description' => 'The details of the custom privacy policy content.',
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateCustomPrivacyPolicy',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCustomPrivacyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#CustomPrivacyPolicyId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateDomainBrand' => [
'summary' => 'Updates the brand associated with a domain name.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6GKEFM'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'title' => '', 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
],
[
'name' => 'DomainId',
'in' => 'query',
'schema' => ['description' => 'The domain name ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dm_examplexxxxx'],
],
[
'name' => 'BrandId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => true, 'description' => 'The brand ID.', 'title' => '', 'example' => 'brand_xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateDomainBrand',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateDomainBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateDomainIcpNumber' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGK16FE'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'DomainId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Domain ID.', 'type' => 'string', 'required' => true, 'example' => 'dm_examplexxxxx'],
],
[
'name' => 'IcpNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ICP filing number associated with the domain.', 'type' => 'string', 'required' => true, 'example' => '浙xx-xxxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateDomainIcpNumber',
'summary' => 'Updates the ICP filing number of a domain.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateDomainIcpNumber',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateFederatedCredentialProvider' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'FederatedCredentialProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The federated trust source ID.', 'type' => 'string', 'required' => true, 'example' => 'fcp_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'FederatedCredentialProviderName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The federated trust source name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'maxLength' => 64],
],
[
'name' => 'NetworkAccessEndpointId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The network access endpoint ID.', 'type' => 'string', 'required' => false, 'example' => 'nae_public', 'maxLength' => 64],
],
[
'name' => 'PrivateCaProviderConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The private CA configuration.',
'type' => 'object',
'properties' => [
'TrustAnchorSource' => ['title' => '', 'description' => 'The method used to retrieve the root certificate.', 'type' => 'string', 'required' => true, 'example' => 'custom', 'maxLength' => 32],
'Certificates' => [
'title' => '',
'description' => 'The list of root certificates.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Content' => ['title' => '', 'description' => 'The content of the root certificate.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----'."\n"
.'MIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z'."\n"
.'-----END CERTIFICATE-----', 'required' => false],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
'TrustCondition' => ['title' => '', 'description' => 'The trust condition of the root certificate.', 'type' => 'string', 'example' => 'IsNullOrEmpty("jwt.issuer")', 'maxLength' => 10240, 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'OidcProviderConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The OIDC configuration.',
'type' => 'object',
'properties' => [
'JwksSource' => ['title' => '', 'description' => 'The JWKS source.', 'type' => 'string', 'required' => true, 'example' => 'static', 'maxLength' => 32],
'JwksUri' => ['title' => '', 'description' => 'The JWKS endpoint.', 'type' => 'string', 'example' => 'https://example.com/jwks', 'maxLength' => 1024, 'required' => false],
'StaticJwks' => ['title' => '', 'description' => 'The statically retrieved JWKS.', 'type' => 'string', 'example' => '{'."\n"
.' "keys": ['."\n"
.' {'."\n"
.' "kty": "RSA",'."\n"
.' "e": "AQAB",'."\n"
.' "use": "sig",'."\n"
.' "kid": "KEY2RzsjRrimRASiAhCjBo18YwDoxpYHnHtv",'."\n"
.' "n": "qrsfFfSZngqKOxVE29ZIR4SXkwKq029B3HLDAZui_Pwaxwn8FssR9QdwsljZS06BTDp10vhPgqMB7s7TmHulL3I4WuSB-l4uXTXXXX"'."\n"
.' }'."\n"
.' ]'."\n"
.'}', 'required' => false],
'Audiences' => [
'description' => 'The list of audiences.',
'type' => 'array',
'items' => ['description' => 'The audience.', 'type' => 'string', 'required' => false, 'example' => 'https://example.com', 'title' => ''],
'required' => false,
'title' => '',
'example' => '',
],
'TrustCondition' => ['title' => '', 'description' => 'The trust condition.', 'type' => 'string', 'example' => 'IsNullOrEmpty("jwt.issuer")', 'maxLength' => 10240, 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'Pkcs7ProviderConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The PKCS7 configuration.',
'type' => 'object',
'properties' => [
'TrustAnchorSource' => ['title' => '', 'description' => 'The source of the certificate trust anchor.', 'type' => 'string', 'required' => true, 'example' => 'custom', 'maxLength' => 32],
'Certificates' => [
'title' => '',
'description' => 'The list of PKCS7 certificates.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Content' => ['title' => '', 'description' => 'The content of the root certificate.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----'."\n"
.'MIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z'."\n"
.'-----END CERTIFICATE-----', 'required' => false],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
'TrustCondition' => ['title' => '', 'description' => 'The trust condition.', 'type' => 'string', 'example' => 'IsNullOrEmpty("jwt.issuer")', 'maxLength' => 10240, 'required' => false],
'CmsVerificationMode' => ['title' => '', 'description' => 'The CMS verification mode.', 'type' => 'string', 'required' => false, 'example' => 'cert', 'maxLength' => 32],
'SignatureEffectiveTime' => ['title' => '', 'description' => 'The validity period of the signature.', 'type' => 'integer', 'format' => 'int64', 'example' => '1200', 'required' => false],
'SigningTimeValueExpression' => ['title' => '', 'description' => 'The expression used to retrieve the signing time.', 'type' => 'string', 'example' => 'pkcs7.signingTime', 'required' => false],
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Update a federated trust source',
'summary' => 'Updates a federated trust source.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateFederatedCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/{#FederatedCredentialProviderId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateFederatedCredentialProviderDescription' => [
'summary' => 'Updates the description of a federated trust source.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasH5ECOY'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'FederatedCredentialProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The federated trust source ID.', 'type' => 'string', 'required' => true, 'example' => 'fcp_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description of the federated trust source.', 'type' => 'string', 'example' => 'test', 'maxLength' => 128, 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Update the description of a federated trust source',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateFederatedCredentialProviderDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/{#FederatedCredentialProviderId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateGroup' => [
'summary' => 'Updates the information about an account group in Identity as a Service (IDaaS) Employee Identity and Access Management (EIAM). If the information is empty, the information is not updated by default.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas7VNWU7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The group ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The name of the group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'name_test'],
],
[
'name' => 'GroupExternalId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The external ID of the group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateGroup',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateGroupDescription' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas7VNWU7'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the account group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description of the account group.', 'type' => 'string', 'required' => false, 'example' => 'group_d6sbsuumeta4h66ec3il7yxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateGroupDescription',
'summary' => 'Updates the description of an Identity as a Service (IDaaS) Employee Identity and Access Management (EIAM) account group.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroupDescription'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateIdentityProvider' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '139717',
'abilityTreeNodes' => ['FEATUREidaas2HJ3XK'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'IdentityProviderId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Identity provider ID.', 'type' => 'string', 'required' => true, 'example' => 'idp_my664lwkhpicbyzirog3xxxxx', 'maxLength' => 64],
],
[
'name' => 'IdentityProviderName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Identity provider name.', 'type' => 'string', 'example' => 'test', 'required' => false],
],
[
'name' => 'LdapConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'AD/LDAP basic information.',
'type' => 'object',
'properties' => [
'AdministratorPassword' => ['title' => '', 'description' => 'Administrator password.', 'type' => 'string', 'example' => 'xxxxxx', 'required' => false],
'AdministratorUsername' => ['title' => '', 'description' => 'Administrator username.', 'type' => 'string', 'example' => 'DC=example,DC=com', 'required' => false],
'CertificateFingerprintStatus' => ['title' => '', 'description' => 'Whether to verify the fingerprint certificate. Valid values:'."\n"
."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'enabled', 'required' => false],
'CertificateFingerprints' => [
'title' => '',
'description' => 'Certificate fingerprint list.',
'type' => 'array',
'items' => ['description' => 'Certificate fingerprint in SHA256 format of the public key.', 'type' => 'string', 'required' => false, 'example' => 'ahshssakjdhaksjdhasjdha', 'title' => ''],
'required' => false,
'example' => '',
],
'LdapProtocol' => ['title' => '', 'description' => 'Communication protocol.', 'type' => 'string', 'example' => 'ldap', 'required' => false],
'LdapServerHost' => ['title' => '', 'description' => 'Server address.', 'type' => 'string', 'example' => '123.xx.xx.89', 'required' => false],
'LdapServerPort' => ['title' => '', 'description' => 'Port number.', 'type' => 'integer', 'format' => 'int32', 'example' => '636', 'required' => false],
'StartTlsStatus' => ['title' => '', 'description' => 'Whether StartTLS is enabled. Valid values:'."\n"
.'- Disabled: disabled'."\n"
."\n"
.'- Enabled: enabled', 'type' => 'string', 'example' => 'enabled', 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'DingtalkAppConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'DingTalk configuration basic information.',
'type' => 'object',
'properties' => [
'AppKey' => ['title' => '', 'description' => 'AppKey of the DingTalk first-party application.', 'type' => 'string', 'required' => false, 'example' => '49nyeaqumk7f'],
'AppSecret' => ['title' => '', 'description' => 'AppSecret of the DingTalk first-party application.', 'type' => 'string', 'required' => false, 'example' => '86nozWFL2CxgwnhKiXaG8dN4keLPkUNc5xxxx'],
'EncryptKey' => ['description' => 'EncryptKey of the DingTalk application.', 'type' => 'string', 'required' => false, 'example' => 'VkdWw91mdkrjVFr3ObNwefap21dfxxxx', 'title' => ''],
'VerificationToken' => ['description' => 'VerificationToken of the DingTalk application.', 'type' => 'string', 'required' => false, 'example' => 'myDingApp_VerifyTokenxxxxx', 'title' => ''],
'DingtalkLoginVersion' => ['title' => '', 'description' => 'DingTalk QR code login version.', 'type' => 'string', 'example' => 'new_version', 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'WeComConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'WeCom basic information.',
'type' => 'object',
'properties' => [
'AgentId' => ['title' => '', 'description' => 'AgentId of the WeCom self-built application.', 'type' => 'string', 'example' => '1237403', 'required' => false],
'AuthorizeCallbackDomain' => ['title' => '', 'description' => 'Authorization callback domain.', 'type' => 'string', 'example' => 'https://xxx.aliyunidaas.com/xxxxx', 'required' => false],
'CorpSecret' => ['title' => '', 'description' => 'CorpSecret of the WeCom self-built application.', 'type' => 'string', 'example' => 'CSEHDddddddxxxxuxkJEHPveWRXBGqVqRsxxxx', 'required' => false],
'TrustableDomain' => ['title' => '', 'description' => 'Trusted domain.', 'type' => 'string', 'example' => 'https://xxx.aliyunidaas.com', 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'OidcConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'OIDC-related configuration.',
'type' => 'object',
'properties' => [
'AuthnParam' => [
'title' => '',
'description' => 'OIDC client authentication configuration.',
'type' => 'object',
'properties' => [
'AuthnMethod' => ['title' => '', 'description' => 'OIDC authentication method. Valid values:'."\n"
."\n"
.'- client_secret_basic'."\n"
."\n"
.'- client_secret_post', 'type' => 'string', 'example' => 'client_secret_post', 'required' => false],
'ClientSecret' => ['title' => '', 'description' => 'OIDC client secret.', 'type' => 'string', 'example' => 'CSEHDddddddxxxxuxkJEHPveWRXBGqVqRsxxxx', 'required' => false],
],
'required' => false,
'example' => '',
],
'EndpointConfig' => [
'title' => '',
'description' => 'OIDC endpoint configuration.',
'type' => 'object',
'properties' => [
'AuthorizationEndpoint' => ['title' => '', 'description' => 'OIDC authorization endpoint.', 'type' => 'string', 'example' => 'https://example.com/oauth/authorize', 'required' => false],
'Issuer' => ['title' => '', 'description' => 'OIDC issuer information.', 'type' => 'string', 'example' => 'https://example.com/oauth', 'required' => false],
'JwksUri' => ['title' => '', 'description' => 'OIDC JWKS URI.', 'type' => 'string', 'example' => 'https://example.com/oauth/jwks', 'required' => false],
'TokenEndpoint' => ['title' => '', 'description' => 'OIDC token endpoint.', 'type' => 'string', 'example' => 'https://example.com/oauth/token', 'required' => false],
'UserinfoEndpoint' => ['title' => '', 'description' => 'OIDC UserInfo endpoint.', 'type' => 'string', 'example' => 'https://example.com/oauth/userinfo', 'required' => false],
],
'required' => false,
'example' => '',
],
'GrantScopes' => [
'title' => '',
'description' => 'OIDC grant scopes list.',
'type' => 'array',
'items' => ['description' => 'OIDC grant scope.', 'type' => 'string', 'required' => false, 'example' => 'ou_asdaq1addsxzdq1xxxx', 'title' => ''],
'required' => false,
'example' => 'openid',
],
'GrantType' => ['title' => '', 'description' => 'OIDC grant type.', 'type' => 'string', 'example' => 'authorization_code', 'required' => false],
'PkceChallengeMethod' => ['title' => '', 'description' => 'PKCE algorithm.'."\n"
.'- SHA256: S256'."\n"
."\n"
.'- Plain text: plain', 'type' => 'string', 'example' => 'S256', 'required' => false],
'PkceRequired' => ['title' => '', 'description' => 'Whether to use PKCE in AuthorizationCode grant mode.', 'type' => 'boolean', 'example' => 'true', 'required' => false],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'NetworkAccessEndpointId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Network access endpoint ID.', 'type' => 'string', 'example' => 'nae_examplexxxx', 'required' => false],
],
[
'name' => 'LarkConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'Lark configuration information.',
'type' => 'object',
'properties' => [
'AppId' => ['title' => '', 'description' => 'Lark application AppId.', 'type' => 'string', 'example' => 'cli_xxxx', 'required' => false],
'AppSecret' => ['title' => '', 'description' => 'Lark application AppSecret.', 'type' => 'string', 'example' => 'KiiLzh5Dueh4wbLxxxx', 'required' => false],
'EncryptKey' => ['title' => '', 'description' => 'EncryptKey of the Lark self-built application.', 'type' => 'string', 'required' => false, 'example' => 'VkdWw91mdkrjVFr3ObNwefap21dfbZbKxxxx'],
'VerificationToken' => ['title' => '', 'description' => 'VerificationToken of the Lark self-built application.', 'type' => 'string', 'required' => false, 'example' => 'feishuVerifyTokenxxxxx'],
],
'required' => false,
'example' => '',
],
],
[
'name' => 'LogoUrl',
'in' => 'query',
'schema' => ['description' => 'Application logo URL.', 'type' => 'string', 'required' => false, 'example' => 'idaas-image://idaas_23aqr2ye554csg33dqpch5exxxx/tmp/d17d9adc-a943-45e7-ba0c-2838dddea678xxxx', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotency of the request. The value of this parameter is generated by the client to ensure uniqueness among different requests.', 'type' => 'string', 'required' => false, 'example' => 'client-examplexxx', 'title' => ''],
],
[
'name' => 'SamlConfig',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'object',
'properties' => [
'IdPEntityId' => ['type' => 'string', 'required' => false, 'example' => 'http://dc.test.com/adfs/services/trust', 'description' => '', 'title' => ''],
'IdPSsoUrl' => ['type' => 'string', 'required' => false, 'example' => 'https://dc.test.com/adfs/ls/', 'description' => '', 'title' => ''],
'Certificates' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Content' => ['type' => 'string', 'example' => '-----BEGIN CERTIFICATE----- MIIC0jCCAbqgAwIBAgIQXXXXX-----END CERTIFICATE-----', 'description' => '', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'RequireRequestSigned' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''],
'BindingMethod' => [
'type' => 'string',
'required' => false,
'example' => 'HTTP-REDIRECT',
'enum' => ['HTTP-REDIRECT', 'HTTP-POST'],
'description' => '',
'title' => '',
],
'MaxClockSkew' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '180', 'description' => '', 'title' => ''],
'WantResponseSigned' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
'WantAssertionsSigned' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter.OidcIssuer', 'errorMessage' => 'OidcIssuer format check failed, it must be an address that starts with http or https.', 'description' => 'OidcIssuer format check failed, it must be an address that starts with http or https.'],
],
],
'title' => 'UpdateIdentityProvider',
'summary' => 'Updates the basic configuration of an identity provider.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIdentityProvider'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateInstanceDescription' => [
'summary' => 'Modifies the description of a specified EIAM instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas6GKEFM'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID of the instance whose description you want to modify.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The new description of the instance.', 'type' => 'string', 'example' => 'For production use.', 'maxLength' => 128, 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'Update EIAM instance description',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceDescription'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateInstanceDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#instanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateNetworkAccessEndpointName' => [
'summary' => 'Modifies the name of a private network access endpoint.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasGNRASW'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'NetworkAccessEndpointId',
'in' => 'query',
'schema' => ['description' => 'The ID of the private network access endpoint.', 'type' => 'string', 'required' => true, 'example' => 'nae_examplexxxx', 'title' => ''],
],
[
'name' => 'NetworkAccessEndpointName',
'in' => 'query',
'schema' => ['description' => 'The name of the private network access endpoint. The endpoint type must be private.', 'type' => 'string', 'required' => true, 'example' => 'VPC access endpoint for xx service', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
'title' => 'UpdateNetworkAccessEndpointName',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateNetworkAccessEndpointName'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateNetworkAccessEndpointName',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}'],
],
],
],
],
],
'UpdateNetworkZone' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231619',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'NetworkZoneId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The network zone ID.', 'type' => 'string', 'required' => true, 'example' => 'network_11111', 'maxLength' => 64],
],
[
'name' => 'NetworkZoneName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The network zone name.', 'type' => 'string', 'required' => true, 'example' => 'IPV4Test', 'maxLength' => 64],
],
[
'name' => 'Ipv4Cidrs',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The IPv4 CIDR blocks of the network zone.',
'type' => 'array',
'items' => ['description' => 'The IPv4 CIDR block.', 'type' => 'string', 'required' => false, 'example' => '140.xxx.11.0/xx', 'title' => ''],
'required' => false,
'example' => '',
],
],
[
'name' => 'Ipv6Cidrs',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The IPv6 CIDR blocks of the network zone.',
'type' => 'array',
'items' => ['description' => 'The IPv6 CIDR block.', 'type' => 'string', 'required' => false, 'example' => 'xxxx::/16', 'title' => ''],
'required' => false,
'example' => '',
],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc_xxxxx', 'maxLength' => 64, 'required' => false],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The idempotence token.', 'type' => 'string', 'required' => false, 'example' => 'client-token-examplexxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Update a network zone object',
'summary' => 'Updates a network zone object.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateNetworkZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/{#NetworkZoneId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateNetworkZoneDescription' => [
'summary' => 'Updates the description of a network zone.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '231621',
'abilityTreeNodes' => ['FEATUREidaas0REDLU'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'NetworkZoneId',
'in' => 'query',
'schema' => ['description' => 'The network zone ID.', 'type' => 'string', 'required' => true, 'example' => 'network_m5wsaclfvfrf5623xnirgxxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the network zone.', 'type' => 'string', 'example' => 'Test description', 'required' => true, 'maxLength' => 128, 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token. It is used to ensure the idempotence of the request.', 'type' => 'string', 'required' => false, 'example' => 'client-token-examplexxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'UpdateNetworkZoneDescription',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateNetworkZoneDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/{#NetworkZoneId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateOrganizationalUnit' => [
'summary' => 'Updates the basic information about an Employee Identity and Access Management (EIAM) organization. The basic information about the organization is not updated by default if no parameter is specified.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas3S4NKL'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The organization ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The name of the organization. The name can be up to 128 characters in length and must be unique in the same parent organization.', 'type' => 'string', 'required' => false, 'example' => 'ou_name', 'maxLength' => 128],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'UpdateOrganizationalUnit',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOrganizationalUnit'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateOrganizationalUnitDescription' => [
'summary' => 'Modifies the description of an Employee Identity and Access Management (EIAM) organization.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas3S4NKL'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The organization ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description of the organization. The value can be up to 256 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'organizationalUnit_test', 'maxLength' => 256],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateOrganizationalUnitDescription',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOrganizationalUnitDescription'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateOrganizationalUnitParentId' => [
'summary' => 'Updates the parent organization ID of an organization in Identity as a Service (IDaaS) Employee Identity and Access Management (EIAM). In this case, the organization is moved from a parent node to a new node.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaas3S4NKL'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'OrganizationalUnitId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The organization ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
[
'name' => 'ParentId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The parent organization ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', 'maxLength' => 64],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateOrganizationalUnitParentId',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOrganizationalUnitParentId'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateResourceServerScope' => [
'summary' => 'Updates a scope permission for a specified resource server.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasAAD0EO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ApplicationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the ResourceServer application.', 'type' => 'string', 'required' => true, 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ResourceServerScopeId',
'in' => 'query',
'schema' => ['description' => 'The ID of the scope permission for the resource server.', 'type' => 'string', 'required' => true, 'example' => 'ress_neg35flu6byysxwutaxu3dxxxx', 'maxLength' => 64, 'title' => ''],
],
[
'name' => 'ResourceServerScopeName',
'in' => 'query',
'schema' => ['description' => 'The name of the scope permission.', 'type' => 'string', 'required' => true, 'example' => 'Read All User', 'maxLength' => 32, 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateResourceServerScope',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateResourceServerScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ResourceServerScope', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/resourceserverscope/{#ResourceServerScopeId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateUser' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.', 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 64],
],
[
'name' => 'Username',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account name. The name can contain letters, digits, underscores (_), periods (.), at signs (@), and hyphens (-). The name can be up to 256 characters in length.', 'type' => 'string', 'example' => 'username_test', 'maxLength' => 256, 'required' => false],
],
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The display name of the account. The name can be up to 256 characters in length.', 'type' => 'string', 'example' => 'test_name', 'maxLength' => 256, 'required' => false],
],
[
'name' => 'PhoneRegion',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The phone region code. Example: 86 for the Chinese mainland, without the 00 or + prefix. This parameter is required if a phone number is specified.', 'type' => 'string', 'example' => '86', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The phone number. The value must be 6 to 15 digits in length.', 'type' => 'string', 'example' => '156xxxxxxxxx', 'maxLength' => 32, 'required' => false],
],
[
'name' => 'PhoneNumberVerified',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether the phone number is verified as a trusted phone number. This parameter is required if a phone number is specified. If no special business requirements exist, set this parameter to true.', 'type' => 'boolean', 'example' => 'true', 'maxLength' => 64, 'required' => false],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The email address. The prefix of the email address can contain uppercase letters, lowercase letters, digits, periods (.), underscores (_), and hyphens (-).', 'type' => 'string', 'example' => 'example@example.com', 'maxLength' => 256, 'required' => false],
],
[
'name' => 'EmailVerified',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether the email address is verified. This parameter is required if an email address is specified. If no special business requirements exist, set this parameter to true.', 'type' => 'boolean', 'example' => 'true', 'maxLength' => 64, 'required' => false],
],
[
'name' => 'CustomFields',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The list of custom field objects.',
'type' => 'array',
'items' => [
'description' => 'The custom field object.',
'type' => 'object',
'properties' => [
'FieldName' => ['title' => '', 'description' => 'The identifier of the custom field. Create the custom field in advance. For more information, refer to the custom fields module in the console.', 'type' => 'string', 'example' => 'nick_name', 'maxLength' => 64, 'required' => false],
'FieldValue' => ['title' => '', 'description' => 'The value of the custom field. The value must comply with the property constraints of the corresponding custom field.', 'type' => 'string', 'example' => 'test_value', 'maxLength' => 1024, 'required' => false],
'Operation' => ['title' => '', 'description' => 'The operation type for the custom field. Valid values:'."\n"
.'- add: adds a custom field value to the account.'."\n"
.'- replace: replaces an existing custom field value of the account. If the custom field value does not exist, the operation is converted to an add operation.'."\n"
.'- remove: removes the custom field value from the account.', 'type' => 'string', 'example' => 'add', 'maxLength' => 64, 'required' => false],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'ResourceDuplicated.Username', 'errorMessage' => 'The specified resource: Username already exist.', 'description' => 'Duplicate user name'],
],
],
'title' => 'Update the basic information of an EIAM account',
'summary' => 'Updates the basic information of an EIAM account.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUser'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateUserDescription' => [
'summary' => 'Updates a user\'s description.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasCRU1S2'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the user.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The description. The maximum length is 256 characters.', 'type' => 'string', 'required' => false, 'maxLength' => 256, 'example' => 'this is a test.'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateUserDescription',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserDescription'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
'UpdateUserPassword' => [
'summary' => 'Updates the password information of an Employee Identity and Access Management (EIAM) account of Identity as a Service (IDaaS). The password must meet the requirements of the password policies that are configured in the IDaaS console.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREidaasWBT5FD'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', 'maxLength' => 64],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', 'maxLength' => 64],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The new password of the account. For more information about the password format, see the "Password Policies" topic.'."\n", 'type' => 'string', 'required' => true, 'example' => '123456', 'maxLength' => 64],
],
[
'name' => 'PasswordForcedUpdateStatus',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether to enable forcible password change upon first logon. Default value: disabled. Valid values:'."\n"
."\n"
.'* enabled'."\n"
.'* disabled'."\n", 'type' => 'string', 'required' => false, 'example' => 'enabled', 'maxLength' => 64],
],
[
'name' => 'UserNotificationChannels',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '',
'description' => 'The methods for receiving password notifications.'."\n",
'type' => 'array',
'items' => ['description' => 'The method for receiving password notifications. Valid values:'."\n"
."\n"
.'* email: by email'."\n"
.'* sms: by text message'."\n", 'type' => 'string', 'required' => false, 'example' => 'email', 'title' => ''],
'required' => false,
'example' => 'sms',
'maxLength' => 64,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0441BD79-92F3-53AA-8657-F8CE4A2B912A'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'UpdateUserPassword',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserPassword'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0441BD79-92F3-53AA-8657-F8CE4A2B912A\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'eiam.cn-hongkong.aliyuncs.com', 'endpoint' => 'eiam.cn-hongkong.aliyuncs.com', 'vpc' => 'eiam-hk.vpc-proxy.aliyuncs.com'],
['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'eiam.ap-northeast-2.aliyuncs.com', 'endpoint' => 'eiam.ap-northeast-2.aliyuncs.com', 'vpc' => 'eiam-sel.vpc-proxy.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'eiam.ap-southeast-1.aliyuncs.com', 'endpoint' => 'eiam.ap-southeast-1.aliyuncs.com', 'vpc' => 'eiam-sg.vpc-proxy.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'eiam.ap-southeast-5.aliyuncs.com', 'endpoint' => 'eiam.ap-southeast-5.aliyuncs.com', 'vpc' => 'eiam-jk.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'eiam.cn-hangzhou.aliyuncs.com', 'endpoint' => 'eiam.cn-hangzhou.aliyuncs.com', 'vpc' => 'eiam-cn.vpc-proxy.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'eiam.eu-central-1.aliyuncs.com', 'endpoint' => 'eiam.eu-central-1.aliyuncs.com', 'vpc' => 'eiam-eu.vpc-proxy.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error, please try again later.', 'http_code' => 500, 'description' => ''],
['code' => 'InvalidParameter.OidcIssuer', 'message' => 'OidcIssuer format check failed, it must be an address that starts with http or https.', 'http_code' => 400, 'description' => 'OidcIssuer format check failed, it must be an address that starts with http or https.'],
['code' => 'ResourceDuplicated.Username', 'message' => 'The specified resource: Username already exist.', 'http_code' => 403, 'description' => 'Duplicate user name'],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPasswordExpirationConfiguration'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableApplicationApiInvoke'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsers'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableApplicationSso'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ObtainApplicationClientSecret'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetApplicationProvisioningScope'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApplicationDescription'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplicationProvisioningConfig'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConditionalAccessPolicy'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableApplication'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApplication'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUserFromOrganizationalUnits'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConditionalAccessPoliciesForNetworkZone'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetApplicationGrantScope'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDomainDnsChallenge'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDomainProxyTokens'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceDescription'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPasswordHistoryConfiguration'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsersForGroup'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetPasswordExpirationConfiguration'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDomains'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ObtainDomainProxyToken'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSynchronizationJob'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplicationProvisioningScope'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDomainProxyToken'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateConditionalAccessPolicy'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplicationClientSecrets'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrganizationalUnitParents'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSynchronizationJobs'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableConditionalAccessPolicy'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIdentityProvider'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNetworkAccessEndpointAvailableRegions'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeApplicationFromOrganizationalUnits'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetPasswordInitializationConfiguration'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableConditionalAccessPolicy'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableApplication'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroup'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteNetworkAccessEndpoint'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupsForApplication'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDomainProxyToken'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNetworkAccessEndpoints'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUsersToGroup'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableInitDomainAutoRedirect'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOrganizationalUnit'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIdentityProviderUdPullConfiguration'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrganizationalUnit'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDefaultDomain'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPasswordInitializationConfiguration'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableApplicationClientSecret'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableIdentityProviderUdPull'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOrganizationalUnitDescription'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroup'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUser'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplicationsForOrganizationalUnit'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsersFromGroup'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetPasswordHistoryConfiguration'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConditionalAccessPolicyDescription'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDomain'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeApplicationFromUsers'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetApplicationProvisioningConfig'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUser'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplicationSsoConfig'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetForgetPasswordConfiguration'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIdentityProviders'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableInitDomainAutoRedirect'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableApplicationProvisioning'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConditionalAccessPolicies'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplicationsForUser'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConditionalAccessPolicy'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEiamRegions'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrganizationalUnits'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserPassword'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableDomainProxyToken'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNetworkAccessPaths'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableApplicationApiInvoke'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetApplicationSsoConfig'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateOrganizationalUnitParentId'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIdentityProvider'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AuthorizeApplicationToOrganizationalUnits'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableUser'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableUser'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceLicense'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplicationGrantScope'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGroup'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsersForApplication'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApplicationClientSecret'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateNetworkAccessEndpointName'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApplication'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteOrganizationalUnit'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroupsForUser'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOrganizationalUnit'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroupDescription'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AuthorizeApplicationToGroups'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPasswordComplexityConfiguration'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUser'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroups'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AuthorizeApplicationToUsers'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableDomainProxyToken'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteOrganizationalUnitChildren'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateUserDescription'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockUser'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrganizationalUnitsForApplication'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateNetworkAccessEndpoint'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetUserPrimaryOrganizationalUnit'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRegions'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateApplicationAuthorizationType'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIdentityProvider'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDomain'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIdentityProvider'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNetworkAccessEndpointAvailableZones'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableApplicationSso'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEiamInstances'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApplicationClientSecret'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunSynchronizationJob'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetForgetPasswordConfiguration'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevokeApplicationFromGroups'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableIdentityProviderUdPull'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUserToOrganizationalUnits'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConditionalAccessPolicy'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDomain'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApplications'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNetworkAccessEndpoint'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetIdentityProviderUdPullConfiguration'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableApplicationClientSecret'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApplication'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetPasswordComplexityConfiguration'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableApplicationProvisioning'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGroup'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRootOrganizationalUnit'],
],
],
'ram' => [
'productCode' => 'EIAM',
'productName' => 'Identity as a Service',
'ramCodes' => ['eiam'],
'ramLevel' => 'RESOURCE',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'ListConditionalAccessPoliciesForApplication',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListConditionalAccessPoliciesForApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/*'],
],
],
],
[
'apiName' => 'EnableBrand',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
],
],
],
[
'apiName' => 'ListOrganizationalUnitsForResourceServer',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListOrganizationalUnitsForResourceServer',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'ListGroupsForApplication',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListGroupsForApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'CheckApplicationProvisioningUserPrimaryOrganizationalUnit',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'eiam:CheckApplicationProvisioningUserPrimaryOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'BindUserAuthnSourceMapping',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:BindUserAuthnSourceMapping',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'DisableApplicationToken',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/{#ApplicationTokenId}'],
],
],
],
[
'apiName' => 'CreateApplicationToken',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateApplicationToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/*'],
],
],
],
[
'apiName' => 'SetUserPrimaryOrganizationalUnit',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetUserPrimaryOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'DisableCustomField',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableCustomField',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomField', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customfield/{#FieldId}'],
],
],
],
[
'apiName' => 'GetInstanceModuleInfo',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetInstanceModuleInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DisableApplicationM2MClient',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationM2MClient',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'ListApplicationsForUser',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationsForUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'SetPasswordInitializationConfiguration',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetPasswordInitializationConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'GetPasswordExpirationConfiguration',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetPasswordExpirationConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'GetDomain',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}'],
],
],
],
[
'apiName' => 'CreateApplicationFederatedCredential',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateApplicationFederatedCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/*'],
],
],
],
[
'apiName' => 'CreateAuthorizationResource',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateAuthorizationResource',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationResource', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}/authorizationresource/*'],
],
],
],
[
'apiName' => 'DeleteUser',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'ListAuthorizationRulesForApplication',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListAuthorizationRulesForApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'UpdateCloudAccount',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCloudAccount',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}'],
],
],
],
[
'apiName' => 'GetNetworkAccessEndpoint',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetNetworkAccessEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}'],
],
],
],
[
'apiName' => 'DeleteApplicationFederatedCredential',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteApplicationFederatedCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/{#ApplicationFederatedCredentialId}'],
],
],
],
[
'apiName' => 'CreateDomainProxyToken',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateDomainProxyToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'DomainProxyToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}/domainproxytoken/*'],
],
],
],
[
'apiName' => 'AddApplicationToAuthorizationRule',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AddApplicationToAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'GenerateUploadAuth',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:GenerateUploadAuth',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DeleteApplicationClientSecret',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteApplicationClientSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/{#SecretId}'],
],
],
],
[
'apiName' => 'ListGroupsForAuthorizationRule',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListGroupsForAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/AuthorizationRule/{#AuthorizationRuleId}'],
],
],
],
[
'apiName' => 'DisableApplicationFederatedCredential',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationFederatedCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/{#ApplicationFederatedCredentialId}'],
],
],
],
[
'apiName' => 'EnableApplicationToken',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/{#ApplicationTokenId}'],
],
],
],
[
'apiName' => 'ListOrganizationalUnitParents',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListOrganizationalUnitParents',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/{#OrganizationalUnitId}'],
],
],
],
[
'apiName' => 'DeleteCustomField',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteCustomField',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomField', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customfield/{#FieldId}'],
],
],
],
[
'apiName' => 'EnableCredential',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}'],
],
],
],
[
'apiName' => 'SetApplicationResourceServerIdentifier',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetApplicationResourceServerIdentifier',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'GetInstanceQuota',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetInstanceQuota',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'GetApplicationProvisioningConfig',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationProvisioningConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'UpdateConditionalAccessPolicyDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateConditionalAccessPolicyDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/{#ConditionalAccessPolicyId}'],
],
],
],
[
'apiName' => 'GetApplicationProvisioningScope',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationProvisioningScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'EnableDomainProxyToken',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableDomainProxyToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'DomainProxyToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}/domainproxytoken/{#DomainProxyTokenId}'],
],
],
],
[
'apiName' => 'AuthorizeResourceServerScopesToGroup',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AuthorizeResourceServerScopesToGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
[
'apiName' => 'EnableInternalAuthenticationSource',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableInternalAuthenticationSource',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthenticationSource', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authenticationsource/{#AuthenticationSourceId}'],
],
],
],
[
'apiName' => 'ListEiamRegions',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'eiam:ListEiamRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteCustomPrivacyPolicy',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteCustomPrivacyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#CustomPrivacyPolicyId}'],
],
],
],
[
'apiName' => 'ListCustomPrivacyPoliciesForBrand',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListCustomPrivacyPoliciesForBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
],
],
],
[
'apiName' => 'UpdateApplicationClientSecretExpirationTime',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationClientSecretExpirationTime',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/{#SecretId}'],
],
],
],
[
'apiName' => 'DisableConditionalAccessPolicy',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableConditionalAccessPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/{#ConditionalAccessPolicyId}'],
],
],
],
[
'apiName' => 'ListConditionalAccessPoliciesForUser',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListConditionalAccessPoliciesForUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/*'],
],
],
],
[
'apiName' => 'ListCloudAccountRoles',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListCloudAccountRoles',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}/cloudaccountrole/*'],
],
],
],
[
'apiName' => 'CreateDomain',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/*'],
],
],
],
[
'apiName' => 'EnableIdentityProviderUdPull',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableIdentityProviderUdPull',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'DeleteGroup',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
[
'apiName' => 'RemoveApplicationFromAuthorizationRule',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RemoveApplicationFromAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'AddUserToAuthorizationRule',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AddUserToAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'GetInstanceTrialStatus',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetInstanceTrialStatus',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'GetIdentityProviderUdPushConfiguration',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetIdentityProviderUdPushConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'DisableIdentityProviderUdPull',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableIdentityProviderUdPull',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'UnbindTotpAuthenticator',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UnbindTotpAuthenticator',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'UpdateAuthorizationRuleApplicationAttachment',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateAuthorizationRuleApplicationAttachment',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'CreateCustomField',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateCustomField',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomField', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customfield/*'],
],
],
],
[
'apiName' => 'CreateInstance',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/*'],
],
],
],
[
'apiName' => 'CreateApplicationRole',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateApplicationRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationrole/*'],
],
],
],
[
'apiName' => 'RemoveUserFromAuthorizationRule',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RemoveUserFromAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'GetCustomField',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetCustomField',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomField', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customfield/{#FieldId}'],
],
],
],
[
'apiName' => 'SetInstanceGlobalizationConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetInstanceGlobalizationConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ObtainApplicationToken',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ObtainApplicationToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/{#ApplicationTokenId}'],
],
],
],
[
'apiName' => 'ListNetworkAccessPaths',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListNetworkAccessPaths',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessPath', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}/networkaccesspath/*'],
],
],
],
[
'apiName' => 'GetRootOrganizationalUnit',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetRootOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DeleteAuthorizationRule',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}'],
],
],
],
[
'apiName' => 'CreateApplication',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/*'],
],
],
],
[
'apiName' => 'ListCustomPrivacyPolicies',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListCustomPrivacyPolicies',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/*'],
],
],
],
[
'apiName' => 'SetDefaultDomain',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetDefaultDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}'],
],
],
],
[
'apiName' => 'ObtainApplicationClientSecret',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ObtainApplicationClientSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/{#SecretId}'],
],
],
],
[
'apiName' => 'CreateCredential',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/*'],
],
],
],
[
'apiName' => 'GetCustomPrivacyPolicy',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetCustomPrivacyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#CustomPrivacyPolicyId}'],
],
],
],
[
'apiName' => 'UpdateFederatedCredentialProvider',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateFederatedCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/{#FederatedCredentialProviderId}'],
],
],
],
[
'apiName' => 'CreateBrand',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/*'],
],
],
],
[
'apiName' => 'ListEiamInstances',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListEiamInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/*'],
],
],
],
[
'apiName' => 'UpdateCustomPrivacyPolicy',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCustomPrivacyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#CustomPrivacyPolicyId}'],
],
],
],
[
'apiName' => 'GenerateDownloadUrlForSynchronizationJob',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'eiam:GenerateDownloadUrlForSynchronizationJob',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'SynchronizationJob', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/{#SynchronizationJobId}'],
],
],
],
[
'apiName' => 'AddUserToOrganizationalUnits',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AddUserToOrganizationalUnits',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'ListCredentialProviders',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListCredentialProviders',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/*'],
],
],
],
[
'apiName' => 'ListApplicationAccounts',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationAccounts',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationaccount/*'],
],
],
],
[
'apiName' => 'DeleteBrand',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
],
],
],
[
'apiName' => 'ExecIdentityProviderMetadataUrlResolution',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ExecIdentityProviderMetadataUrlResolution',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DisableIdentityProviderAuthn',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableIdentityProviderAuthn',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'UpdateCloudAccountRoleDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCloudAccountRoleDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}/cloudaccountrole/{#CloudAccountRoleId}'],
],
],
],
[
'apiName' => 'ListBrands',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListBrands',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/*'],
],
],
],
[
'apiName' => 'GetBrand',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
],
],
],
[
'apiName' => 'ObtainCredential',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ObtainCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}'],
],
],
],
[
'apiName' => 'AuthorizeApplicationToOrganizationalUnits',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AuthorizeApplicationToOrganizationalUnits',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'UpdateApplicationInfo',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'GetInstanceGlobalizationConfig',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetInstanceGlobalizationConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ListApplicationSupportedProvisionProtocolTypes',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationSupportedProvisionProtocolTypes',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'SetIdentityProviderUdPushConfiguration',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetIdentityProviderUdPushConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'CreateCredentialProvider',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/*'],
],
],
],
[
'apiName' => 'DeleteCredential',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}'],
],
],
],
[
'apiName' => 'GetConditionalAccessPolicy',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetConditionalAccessPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/{#ConditionalAccessPolicyId}'],
],
],
],
[
'apiName' => 'UpdateNetworkAccessEndpointName',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateNetworkAccessEndpointName',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}'],
],
],
],
[
'apiName' => 'EnableInitDomainAutoRedirect',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableInitDomainAutoRedirect',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/*'],
],
],
],
[
'apiName' => 'AddGroupToAuthorizationRule',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AddGroupToAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
[
'apiName' => 'UpdateCloudAccountDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCloudAccountDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}'],
],
],
],
[
'apiName' => 'CreateApplicationClientSecret',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateApplicationClientSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/*'],
],
],
],
[
'apiName' => 'UpdateConditionalAccessPolicy',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateConditionalAccessPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/{#ConditionalAccessPolicyId}'],
],
],
],
[
'apiName' => 'UpdateDomainIcpNumber',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateDomainIcpNumber',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}'],
],
],
],
[
'apiName' => 'DeleteResourceServerScope',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteResourceServerScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ResourceServerScope', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/resourceserverscope/{#ResourceServerScopeId}'],
],
],
],
[
'apiName' => 'GetCloudAccount',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetCloudAccount',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}'],
],
],
],
[
'apiName' => 'AuthorizeResourceServerScopesToUser',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AuthorizeResourceServerScopesToUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'GetIdentityProviderStatusCheckJob',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetIdentityProviderStatusCheckJob',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'UpdateOrganizationalUnitDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateOrganizationalUnitDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/{#OrganizationalUnitId}'],
],
],
],
[
'apiName' => 'UpdateCredentialProvider',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}'],
],
],
],
[
'apiName' => 'UpdateCredential',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}'],
],
],
],
[
'apiName' => 'DeleteDomainProxyToken',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteDomainProxyToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'DomainProxyToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}/domainproxytoken/{#DomainProxyTokenId}'],
],
],
],
[
'apiName' => 'DeleteWebAuthnAuthenticator',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteWebAuthnAuthenticator',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Authenticator', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}/authenticator/{#AuthenticatorId}'],
],
],
],
[
'apiName' => 'CreateCloudAccountRole',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateCloudAccountRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}/cloudaccountrole/*'],
],
],
],
[
'apiName' => 'DisableUser',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'CreateCloudAccount',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateCloudAccount',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/*'],
],
],
],
[
'apiName' => 'EnableIdentityProviderAuthn',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableIdentityProviderAuthn',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'ListAuthorizationResources',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListAuthorizationResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'SetApplicationProvisioningScope',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetApplicationProvisioningScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'RevokeApplicationFromOrganizationalUnits',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeApplicationFromOrganizationalUnits',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'DeleteIdentityProvider',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteIdentityProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'GetClientPublicKey',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetClientPublicKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/{#ClientPublicKeyId}'],
],
],
],
[
'apiName' => 'EnableCredentialProvider',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}'],
],
],
],
[
'apiName' => 'DeleteCredentialProvider',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}'],
],
],
],
[
'apiName' => 'UpdateNetworkZone',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateNetworkZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/{#NetworkZoneId}'],
],
],
],
[
'apiName' => 'EnableCustomField',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableCustomField',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomField', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customfield/{#FieldId}'],
],
],
],
[
'apiName' => 'UpdateGroup',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
[
'apiName' => 'GetForgetPasswordConfiguration',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetForgetPasswordConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthenticationSource', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'EnableApplicationApiInvoke',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationApiInvoke',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'SetApplicationProvisioningUserPrimaryOrganizationalUnit',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetApplicationProvisioningUserPrimaryOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'ListUsersForResourceServer',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListUsersForResourceServer',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'GenerateWebAuthnAuthenticatorRegistrationUrl',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:GenerateWebAuthnAuthenticatorRegistrationUrl',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Authenticator', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}/authenticator/*'],
],
],
],
[
'apiName' => 'ListApplicationRoles',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationRoles',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationrole/*'],
],
],
],
[
'apiName' => 'ListApplicationFederatedCredentials',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationFederatedCredentials',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/*'],
],
],
],
[
'apiName' => 'DeleteCloudAccountRole',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteCloudAccountRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/${#CloudAccountId}/cloudaccountrole/{#CloudAccountRoleId}'],
],
],
],
[
'apiName' => 'AddCustomPrivacyPoliciesToBrand',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:AddCustomPrivacyPoliciesToBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#PolicyId}'],
],
],
],
[
'apiName' => 'EnableApplicationProvisioning',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationProvisioning',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'DeleteCloudAccount',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteCloudAccount',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}'],
],
],
],
[
'apiName' => 'RunSynchronizationJob',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:RunSynchronizationJob',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'SynchronizationJob', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/*'],
],
],
],
[
'apiName' => 'AuthorizeApplicationToGroups',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AuthorizeApplicationToGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'SetPrimaryClientPublicKey',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetPrimaryClientPublicKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/{#ClientPublicKeyId}'],
],
],
],
[
'apiName' => 'UpdateApplicationTokenExpirationTime',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationTokenExpirationTime',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/{#ApplicationTokenId}'],
],
],
],
[
'apiName' => 'EnableApplicationResourceServer',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationResourceServer',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'SetApplicationProvisioningConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetApplicationProvisioningConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'RemoveApplicationAccountFromUser',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RemoveApplicationAccountFromUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationaccount/{#ApplicationAccountId}'],
],
],
],
[
'apiName' => 'ListOrganizationalUnitsForApplication',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListOrganizationalUnitsForApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'UpdateCredentialDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCredentialDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}'],
],
],
],
[
'apiName' => 'CreateGroup',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/*'],
],
],
],
[
'apiName' => 'GetAuthorizationServer',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetAuthorizationServer',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationServer', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationserver/{#AuthorizationServerId}'],
],
],
],
[
'apiName' => 'ListApplicationsForNetworkAccessEndpoint',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListApplicationsForNetworkAccessEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}'],
],
],
],
[
'apiName' => 'EnableApplicationClientSecret',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationClientSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/{#SecretId}'],
],
],
],
[
'apiName' => 'RemoveUsersFromGroup',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RemoveUsersFromGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
[
'apiName' => 'RevokeResourceServerFromClient',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeResourceServerFromClient',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'UpdateAuthorizationRuleDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateAuthorizationRuleDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}'],
],
],
],
[
'apiName' => 'GetResourceServerScope',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetResourceServerScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ResourceServerScope', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/resourceserverscope/{#ResourceServerScopeId}'],
],
],
],
[
'apiName' => 'ListResourceServersForUser',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListResourceServersForUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'UpdateApplicationFederatedCredentialDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationFederatedCredentialDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/{#ApplicationFederatedCredentialId}'],
],
],
],
[
'apiName' => 'GetApplicationProvisioningUserPrimaryOrganizationalUnit',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationProvisioningUserPrimaryOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'DisableApplicationClientSecret',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationClientSecret',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/{#SecretId}'],
],
],
],
[
'apiName' => 'UpdateAuthorizationServer',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateAuthorizationServer',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationServer', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationserver/{#AuthorizationServerId}'],
],
],
],
[
'apiName' => 'UpdateBrand',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
],
],
],
[
'apiName' => 'GetDomainDnsChallenge',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetDomainDnsChallenge',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/*'],
],
],
],
[
'apiName' => 'UpdateResourceServerScope',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateResourceServerScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ResourceServerScope', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/resourceserverscope/{#ResourceServerScopeId}'],
],
],
],
[
'apiName' => 'GetAuthorizationRule',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}'],
],
],
],
[
'apiName' => 'GenerateOauthToken',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'eiam:GenerateOauthToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'ListUsersForApplication',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListUsersForApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'CheckInstanceModuleStatus',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:CheckInstanceModuleStatus',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateApplicationAdvancedConfig',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationAdvancedConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'DisableCloudAccountRole',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableCloudAccountRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/${#CloudAccountId}/cloudaccountrole/{#CloudAccountRoleId}'],
],
],
],
[
'apiName' => 'SetPasswordExpirationConfiguration',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetPasswordExpirationConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'GetCredentialProvider',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}'],
],
],
],
[
'apiName' => 'ListApplicationsForOrganizationalUnit',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationsForOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/{#OrganizationalUnitId}'],
],
],
],
[
'apiName' => 'GetIdentityProvider',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetIdentityProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'GetNetworkZone',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetNetworkZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/{#NetworkZoneId}'],
],
],
],
[
'apiName' => 'ListApplications',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplications',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/*'],
],
],
],
[
'apiName' => 'ListFederatedCredentialProviders',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListFederatedCredentialProviders',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/*'],
],
],
],
[
'apiName' => 'DisableCredentialProvider',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}'],
],
],
],
[
'apiName' => 'GetIdentityProviderUdPullConfiguration',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetIdentityProviderUdPullConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'DisableCredential',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}'],
],
],
],
[
'apiName' => 'SetApplicationGrantScope',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetApplicationGrantScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'UpdateApplicationSsoFormParams',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationSsoFormParams',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'DisableApplicationResourceServer',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationResourceServer',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'GetPasswordComplexityConfiguration',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetPasswordComplexityConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DisableClientPublicKey',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableClientPublicKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/{#ClientPublicKeyId}'],
],
],
],
[
'apiName' => 'ListClientPublicKeys',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListClientPublicKeys',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/*'],
],
],
],
[
'apiName' => 'UnbindUserAuthnSourceMapping',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UnbindUserAuthnSourceMapping',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'GetApplicationFederatedCredential',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationFederatedCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/{#ApplicationFederatedCredentialId}'],
],
],
],
[
'apiName' => 'CreateIdentityProviderStatusCheckJob',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateIdentityProviderStatusCheckJob',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'GetApplication',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'DisableInternalAuthenticationSource',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableInternalAuthenticationSource',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthenticationSource', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authenticationsource/{#AuthenticationSourceId}'],
],
],
],
[
'apiName' => 'RevokeResourceServerScopesFromGroup',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeResourceServerScopesFromGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
[
'apiName' => 'GenerateFileImportTemplate',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:GenerateFileImportTemplate',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateCredentialProviderDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateCredentialProviderDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}'],
],
],
],
[
'apiName' => 'SetIdentityProviderUdPullConfiguration',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetIdentityProviderUdPullConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'EnableFederatedCredentialProvider',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableFederatedCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/{#FederatedCredentialProviderId}'],
],
],
],
[
'apiName' => 'GetCredential',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}'],
],
],
],
[
'apiName' => 'EnableIdentityProviderAdvancedAbility',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableIdentityProviderAdvancedAbility',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'EnableCloudAccountRole',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableCloudAccountRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}/cloudaccountrole/{#CloudAccountRoleId}'],
],
],
],
[
'apiName' => 'GetUser',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'DeleteFederatedCredentialProvider',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteFederatedCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/{#FederatedCredentialProviderId}'],
],
],
],
[
'apiName' => 'GetPasswordHistoryConfiguration',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetPasswordHistoryConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateApplicationDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'GetOrganizationalUnit',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/{#OrganizationalUnitId}'],
],
],
],
[
'apiName' => 'GetInstanceLicense',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetInstanceLicense',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'AuthorizeResourceServerToClient',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:AuthorizeResourceServerToClient',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'GetFederatedCredentialProvider',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetFederatedCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/{#FederatedCredentialProviderId}'],
],
],
],
[
'apiName' => 'DeleteClientPublicKey',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteClientPublicKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/{#ClientPublicKeyId}'],
],
],
],
[
'apiName' => 'UpdateApplicationRole',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationrole/{#ApplicationRoleId}'],
],
],
],
[
'apiName' => 'UpdateApplicationRoleDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationRoleDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationrole/{#ApplicationRoleId}'],
],
],
],
[
'apiName' => 'CheckInstanceForDelete',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:CheckInstanceForDelete',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'EnableApplicationM2MClient',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationM2MClient',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'GetIdentityProviderAdvancedConfiguration',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetIdentityProviderAdvancedConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'DisableCustomPrivacyPolicy',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableCustomPrivacyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#CustomPrivacyPolicyId}'],
],
],
],
[
'apiName' => 'EnableClientPublicKey',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableClientPublicKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/{#ClientPublicKeyId}'],
],
],
],
[
'apiName' => 'UpdateInstanceDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateInstanceDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#instanceId}'],
],
],
],
[
'apiName' => 'ListNetworkAccessEndpointAvailableZones',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListNetworkAccessEndpointAvailableZones',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteOrganizationalUnitChildren',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteOrganizationalUnitChildren',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/{#OrganizationalUnitId}'],
],
],
],
[
'apiName' => 'GetPasswordInitializationConfiguration',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetPasswordInitializationConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'GetInstance',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ListGroupsForUser',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListGroupsForUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'DisableApplication',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'CreateCustomPrivacyPolicy',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateCustomPrivacyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/*'],
],
],
],
[
'apiName' => 'DisableResourceServerCustomSubject',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableResourceServerCustomSubject',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'CreateFederatedCredentialProvider',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateFederatedCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/*'],
],
],
],
[
'apiName' => 'UpdateAuthorizationRuleGroupAttachment',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateAuthorizationRuleGroupAttachment',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
[
'apiName' => 'SetPasswordComplexityConfiguration',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetPasswordComplexityConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateUserDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateUserDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'ListInstances',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/*'],
],
],
],
[
'apiName' => 'GetApplicationTemplate',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationTemplate',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationTemplate', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:applicationtemplate/{#ApplicationTemplateId}'],
],
],
],
[
'apiName' => 'UpdateAuthorizationRule',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}'],
],
],
],
[
'apiName' => 'DeleteNetworkAccessEndpoint',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteNetworkAccessEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}'],
],
],
],
[
'apiName' => 'EnableResourceServerCustomSubject',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableResourceServerCustomSubject',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'ListResourceServerScopes',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListResourceServerScopes',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ResourceServerScope', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/resourceserverscope/*'],
],
],
],
[
'apiName' => 'ListAuthorizationRules',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListAuthorizationRules',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/*'],
],
],
],
[
'apiName' => 'DeleteOrganizationalUnit',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/{#OrganizationalUnitId}'],
],
],
],
[
'apiName' => 'ListAuthorizationServers',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListAuthorizationServers',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'DeleteNetworkZone',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteNetworkZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/{#NetworkZoneId}'],
],
],
],
[
'apiName' => 'GetAuthorizationResource',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetAuthorizationResource',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationResource', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}/authorizationresource/{#AuthorizationResourceId}'],
],
],
],
[
'apiName' => 'RevokeResourceServerScopesFromOrganizationalUnit',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeResourceServerScopesFromOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/{#OrganizationalUnitId}'],
],
],
],
[
'apiName' => 'SetApplicationSsoConfig',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:SetApplicationSsoConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'AuthorizeApplicationToUsers',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:AuthorizeApplicationToUsers',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'DeleteUsers',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteUsers',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/*'],
],
],
],
[
'apiName' => 'ListConditionalAccessPoliciesForNetworkZone',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListConditionalAccessPoliciesForNetworkZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/*'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/{#NetworkZoneId}'],
],
],
],
[
'apiName' => 'DeleteApplicationRole',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteApplicationRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationrole/{#ApplicationRoleId}'],
],
],
],
[
'apiName' => 'RevokeResourceServerScopesFromUser',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeResourceServerScopesFromUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'DeleteInstance',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ListAuthorizationRulesForGroup',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListAuthorizationRulesForGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
[
'apiName' => 'GetLoginRedirectApplicationForBrand',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetLoginRedirectApplicationForBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
],
],
],
[
'apiName' => 'AuthorizeResourceServerScopesToClient',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AuthorizeResourceServerScopesToClient',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'RevokeApplicationFromUsers',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeApplicationFromUsers',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'DeleteConditionalAccessPolicy',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteConditionalAccessPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/{#ConditionalAccessPolicyId}'],
],
],
],
[
'apiName' => 'CreateInstanceTrialLicense',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateInstanceTrialLicense',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateOrganizationalUnitParentId',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateOrganizationalUnitParentId',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/{#OrganizationalUnitId}'],
],
],
],
[
'apiName' => 'AuthorizeResourceServerScopesToOrganizationalUnit',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AuthorizeResourceServerScopesToOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/{#OrganizationalUnitId}'],
],
],
],
[
'apiName' => 'ListIdentityProvidersForNetworkAccessEndpoint',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListIdentityProvidersForNetworkAccessEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}'],
],
],
],
[
'apiName' => 'RemoveCustomPrivacyPoliciesFromBrand',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:RemoveCustomPrivacyPoliciesFromBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#PolicyId}'],
],
],
],
[
'apiName' => 'SetIdentityProviderAuthnConfiguration',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetIdentityProviderAuthnConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'CreateAuthorizationRule',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/*'],
],
],
],
[
'apiName' => 'EnableUser',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'ListNetworkAccessEndpointAvailableRegions',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListNetworkAccessEndpointAvailableRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetApplicationRole',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationrole/{#ApplicationRoleId}'],
],
],
],
[
'apiName' => 'EnableApplicationFederatedCredential',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationFederatedCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/{#ApplicationFederatedCredentialId}'],
],
],
],
[
'apiName' => 'GetApplicationSsoConfig',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationSsoConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'ListCredentials',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListCredentials',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/*'],
],
],
],
[
'apiName' => 'DeleteDomain',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteDomain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}'],
],
],
],
[
'apiName' => 'UpdateIdentityProvider',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateIdentityProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'EnableCustomPrivacyPolicy',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableCustomPrivacyPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#CustomPrivacyPolicyId}'],
],
],
],
[
'apiName' => 'GetSynchronizationJob',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetSynchronizationJob',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'SynchronizationJob', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/{#SynchronizationJobId}'],
],
],
],
[
'apiName' => 'ListSynchronizationJobs',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListSynchronizationJobs',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'SynchronizationJob', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/*'],
],
],
],
[
'apiName' => 'ListApplicationAccountsForUser',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListApplicationAccountsForUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationaccount/*'],
],
],
],
[
'apiName' => 'AddUsersToGroup',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AddUsersToGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
[
'apiName' => 'ListDomains',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListDomains',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/*'],
],
],
],
[
'apiName' => 'SetLoginRedirectApplicationForBrand',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetLoginRedirectApplicationForBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'UpdateOrganizationalUnit',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/{#OrganizationalUnitId}'],
],
],
],
[
'apiName' => 'GetInstanceControlConfiguration',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetInstanceControlConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ListUsersForGroup',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListUsersForGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
[
'apiName' => 'EnableApplicationSso',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplicationSso',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'GetServiceQuota',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetServiceQuota',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteAuthorizationResource',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteAuthorizationResource',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationResource', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}/authorizationresource/{#AuthorizationResourceId}'],
],
],
],
[
'apiName' => 'UpdateNetworkZoneDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateNetworkZoneDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/{#NetworkZoneId}'],
],
],
],
[
'apiName' => 'DisableFederatedCredentialProvider',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableFederatedCredentialProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/{#FederatedCredentialProviderId}'],
],
],
],
[
'apiName' => 'RenewFreeLicenseEndTime',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:RenewFreeLicenseEndTime',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateUser',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'CreateUser',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/*'],
],
],
],
[
'apiName' => 'SetPasswordHistoryConfiguration',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:SetPasswordHistoryConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'EnableAuthorizationRule',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}'],
],
],
],
[
'apiName' => 'ListIdentityProviders',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListIdentityProviders',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/*'],
],
],
],
[
'apiName' => 'ListApplicationsForNetworkZone',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationsForNetworkZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/{#NetworkZoneId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/*'],
],
],
],
[
'apiName' => 'UpdateDomainBrand',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateDomainBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}'],
],
],
],
[
'apiName' => 'UpdateAuthorizationRuleUserAttachment',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateAuthorizationRuleUserAttachment',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'UpdateFederatedCredentialProviderDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateFederatedCredentialProviderDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/{#FederatedCredentialProviderId}'],
],
],
],
[
'apiName' => 'ListGroups',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/*'],
],
],
],
[
'apiName' => 'DisableApplicationApiInvoke',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationApiInvoke',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'DisableBrand',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableBrand',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
],
],
],
[
'apiName' => 'ListAuthorizationRulesForUser',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListAuthorizationRulesForUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'ListApplicationsForGroup',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListApplicationsForGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
[
'apiName' => 'DisableIdentityProviderAdvancedAbility',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableIdentityProviderAdvancedAbility',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
],
],
],
[
'apiName' => 'SetForgetPasswordConfiguration',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetForgetPasswordConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'SetInstanceControlConfiguration',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetInstanceControlConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'UpdateUserPassword',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateUserPassword',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'ListGroupsForResourceServer',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListGroupsForResourceServer',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'EnableApplication',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'ListUsers',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListUsers',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/*'],
],
],
],
[
'apiName' => 'CreateResourceServerScope',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateResourceServerScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ResourceServerScope', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/resourceserverscope/*'],
],
],
],
[
'apiName' => 'RevokeApplicationFromGroups',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeApplicationFromGroups',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'DisableAuthorizationRule',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}'],
],
],
],
[
'apiName' => 'ListApplicationsForAuthorizationRule',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationsForAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/AuthorizationRule/{#AuthorizationRuleId}'],
],
],
],
[
'apiName' => 'CreateNetworkAccessEndpoint',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateNetworkAccessEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/*'],
],
],
],
[
'apiName' => 'ListApplicationTokens',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationTokens',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/*'],
],
],
],
[
'apiName' => 'ListCloudAccounts',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListCloudAccounts',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/*'],
],
],
],
[
'apiName' => 'CreateNetworkZone',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateNetworkZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/*'],
],
],
],
[
'apiName' => 'SetWebAuthnConfiguration',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:SetWebAuthnConfiguration',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'GetGroup',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
[
'apiName' => 'DisableApplicationSso',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationSso',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'CreateClientPublicKey',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'eiam:CreateClientPublicKey',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/*'],
],
],
],
[
'apiName' => 'ListEventTypes',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListEventTypes',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateGroupDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateGroupDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
[
'apiName' => 'ListUserAuthnSourceMappings',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListUserAuthnSourceMappings',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/*'],
],
],
],
[
'apiName' => 'ListNetworkAccessEndpoints',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListNetworkAccessEndpoints',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/*'],
],
],
],
[
'apiName' => 'DeleteApplication',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteApplication',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'RemoveUserFromOrganizationalUnits',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RemoveUserFromOrganizationalUnits',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'CreateIdentityProvider',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateIdentityProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/*'],
],
],
],
[
'apiName' => 'DisableApplicationProvisioning',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableApplicationProvisioning',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'DisableDomainProxyToken',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableDomainProxyToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'DomainProxyToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}/domainproxytoken/{#DomainProxyTokenId}'],
],
],
],
[
'apiName' => 'UpdateApplicationFederatedCredential',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationFederatedCredential',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/{#ApplicationFederatedCredentialId}'],
],
],
],
[
'apiName' => 'ListActionTrackEventTypes',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListActionTrackEventTypes',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
],
],
],
[
'apiName' => 'ListRegions',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ListRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListConditionalAccessPolicies',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListConditionalAccessPolicies',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/*'],
],
],
],
[
'apiName' => 'ListNetworkZones',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListNetworkZones',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/*'],
],
],
],
[
'apiName' => 'GetCloudAccountRole',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetCloudAccountRole',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/${#CloudAccountId}/cloudaccountrole/{#CloudAccountRoleId}'],
],
],
],
[
'apiName' => 'UpdateApplicationAuthorizationType',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateApplicationAuthorizationType',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'GetApplicationGrantScope',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationGrantScope',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'RemoveGroupFromAuthorizationRule',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RemoveGroupFromAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
],
],
],
[
'apiName' => 'CreateConditionalAccessPolicy',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateConditionalAccessPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/*'],
],
],
],
[
'apiName' => 'UpdateAuthorizationServerDescription',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UpdateAuthorizationServerDescription',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationServer', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationserver/{#AuthorizationServerId}'],
],
],
],
[
'apiName' => 'DisableInitDomainAutoRedirect',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:DisableInitDomainAutoRedirect',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/*'],
],
],
],
[
'apiName' => 'ListApplicationClientSecrets',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationClientSecrets',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/*'],
],
],
],
[
'apiName' => 'UnlockUser',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:UnlockUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
],
],
],
[
'apiName' => 'ListUsersForAuthorizationRule',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListUsersForAuthorizationRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
],
],
],
[
'apiName' => 'RevokeResourceServerScopesFromClient',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:RevokeResourceServerScopesFromClient',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
[
'apiName' => 'CreateOrganizationalUnit',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:CreateOrganizationalUnit',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/*'],
],
],
],
[
'apiName' => 'EnableConditionalAccessPolicy',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'eiam:EnableConditionalAccessPolicy',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/{#ConditionalAccessPolicyId}'],
],
],
],
[
'apiName' => 'ListDomainProxyTokens',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListDomainProxyTokens',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'DomainProxyToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}/domainproxytoken/*'],
],
],
],
[
'apiName' => 'ListApplicationFederatedCredentialsForProvider',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListApplicationFederatedCredentialsForProvider',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/*/applicationfederatedcredential/*'],
],
],
],
[
'apiName' => 'ObtainDomainProxyToken',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:ObtainDomainProxyToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'DomainProxyToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}/domainproxytoken/{#DomainProxyTokenId}'],
],
],
],
[
'apiName' => 'AddApplicationAccountToUser',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'eiam:AddApplicationAccountToUser',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationaccount/*'],
],
],
],
[
'apiName' => 'DeleteApplicationToken',
'description' => '',
'operationType' => 'delete',
'ramAction' => [
'action' => 'eiam:DeleteApplicationToken',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/{#ApplicationTokenId}'],
],
],
],
[
'apiName' => 'ListOrganizationalUnits',
'description' => '',
'operationType' => 'list',
'ramAction' => [
'action' => 'eiam:ListOrganizationalUnits',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/*'],
],
],
],
[
'apiName' => 'GetApplicationAdvancedConfig',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'eiam:GetApplicationAdvancedConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'EIAM', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'always', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}'],
['validationType' => 'always', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/*'],
['validationType' => 'always', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/{#BrandId}'],
['validationType' => 'always', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}'],
['validationType' => 'always', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/{#IdentityProviderId}'],
['validationType' => 'always', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/{#ApplicationTokenId}'],
['validationType' => 'always', 'resourceType' => 'ApplicationToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationtoken/*'],
['validationType' => 'always', 'resourceType' => 'CustomField', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customfield/{#FieldId}'],
['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
['validationType' => 'always', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}'],
['validationType' => 'always', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/*'],
['validationType' => 'always', 'resourceType' => 'AuthorizationResource', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}/authorizationresource/*'],
['validationType' => 'always', 'resourceType' => 'CloudAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}'],
['validationType' => 'always', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}'],
['validationType' => 'always', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationfederatedcredential/{#ApplicationFederatedCredentialId}'],
['validationType' => 'always', 'resourceType' => 'DomainProxyToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}/domainproxytoken/*'],
['validationType' => 'always', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/{#SecretId}'],
['validationType' => 'always', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/AuthorizationRule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/{#OrganizationalUnitId}'],
['validationType' => 'always', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/{#CredentialId}'],
['validationType' => 'always', 'resourceType' => 'ConditionalAccessPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/{#ConditionalAccessPolicyId}'],
['validationType' => 'always', 'resourceType' => 'DomainProxyToken', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}/domainproxytoken/{#DomainProxyTokenId}'],
['validationType' => 'always', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/{#GroupId}'],
['validationType' => 'always', 'resourceType' => 'AuthenticationSource', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authenticationsource/{#AuthenticationSourceId}'],
['validationType' => 'always', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#CustomPrivacyPolicyId}'],
['validationType' => 'always', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}/cloudaccountrole/*'],
['validationType' => 'always', 'resourceType' => 'Domain', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/*'],
['validationType' => 'always', 'resourceType' => 'CustomField', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customfield/*'],
['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/*'],
['validationType' => 'always', 'resourceType' => 'ApplicationRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationrole/*'],
['validationType' => 'always', 'resourceType' => 'NetworkAccessPath', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}/networkaccesspath/*'],
['validationType' => 'always', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}'],
['validationType' => 'always', 'resourceType' => 'Application', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/*'],
['validationType' => 'always', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/*'],
['validationType' => 'always', 'resourceType' => 'Credential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credential/*'],
['validationType' => 'always', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/{#FederatedCredentialProviderId}'],
['validationType' => 'always', 'resourceType' => 'Brand', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/*'],
['validationType' => 'always', 'resourceType' => 'SynchronizationJob', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/{#SynchronizationJobId}'],
['validationType' => 'always', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/*'],
['validationType' => 'always', 'resourceType' => 'ApplicationAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationaccount/*'],
['validationType' => 'always', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/{#CloudAccountId}/cloudaccountrole/{#CloudAccountRoleId}'],
['validationType' => 'always', 'resourceType' => 'Secret', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/secret/*'],
['validationType' => 'always', 'resourceType' => 'ResourceServerScope', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/resourceserverscope/{#ResourceServerScopeId}'],
['validationType' => 'always', 'resourceType' => 'CredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}'],
['validationType' => 'always', 'resourceType' => 'Authenticator', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}/authenticator/{#AuthenticatorId}'],
['validationType' => 'always', 'resourceType' => 'CloudAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/*'],
['validationType' => 'always', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/{#ClientPublicKeyId}'],
['validationType' => 'always', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/{#NetworkZoneId}'],
['validationType' => 'always', 'resourceType' => 'AuthenticationSource', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}'],
['validationType' => 'always', 'resourceType' => 'Authenticator', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/{#UserId}/authenticator/*'],
['validationType' => 'always', 'resourceType' => 'CloudAccountRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/cloudaccount/${#CloudAccountId}/cloudaccountrole/{#CloudAccountRoleId}'],
['validationType' => 'always', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/{#PolicyId}'],
['validationType' => 'always', 'resourceType' => 'SynchronizationJob', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/synchronizationjob/*'],
['validationType' => 'always', 'resourceType' => 'ApplicationAccount', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationaccount/{#ApplicationAccountId}'],
['validationType' => 'always', 'resourceType' => 'Group', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/group/*'],
['validationType' => 'always', 'resourceType' => 'AuthorizationServer', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationserver/{#AuthorizationServerId}'],
['validationType' => 'always', 'resourceType' => 'FederatedCredentialProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/federatedcredentialprovider/*'],
['validationType' => 'always', 'resourceType' => 'ClientPublicKey', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/clientpublickey/*'],
['validationType' => 'always', 'resourceType' => 'ApplicationRole', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/applicationrole/{#ApplicationRoleId}'],
['validationType' => 'always', 'resourceType' => 'CustomPrivacyPolicy', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/customprivacypolicy/*'],
['validationType' => 'always', 'resourceType' => 'ApplicationTemplate', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:applicationtemplate/{#ApplicationTemplateId}'],
['validationType' => 'always', 'resourceType' => 'ResourceServerScope', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/{#ApplicationId}/resourceserverscope/*'],
['validationType' => 'always', 'resourceType' => 'AuthorizationRule', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/*'],
['validationType' => 'always', 'resourceType' => 'AuthorizationResource', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/authorizationrule/{#AuthorizationRuleId}/authorizationresource/{#AuthorizationResourceId}'],
['validationType' => 'always', 'resourceType' => 'User', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/*'],
['validationType' => 'always', 'resourceType' => 'IdentityProvider', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/identityprovider/*'],
['validationType' => 'always', 'resourceType' => 'NetworkAccessEndpoint', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/*'],
['validationType' => 'always', 'resourceType' => 'NetworkZone', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkzone/*'],
['validationType' => 'always', 'resourceType' => 'OrganizationalUnit', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/organizationalunit/*'],
['validationType' => 'always', 'resourceType' => 'ApplicationFederatedCredential', 'arn' => 'acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/application/*/applicationfederatedcredential/*'],
],
],
];