@alicloud/eiam20211201 2.19.0 → 2.19.2

package/src/client.ts

@@ -12,15 +12,6 @@ export default class Client extends OpenApi {
   constructor(config: $OpenApiUtil.Config) {
     super(config);
     this._endpointRule = "regional";
-    this._endpointMap = {
-      'cn-hongkong': "eiam.cn-hongkong.aliyuncs.com",
-      'ap-northeast-2': "eiam.ap-northeast-2.aliyuncs.com",
-      'ap-southeast-1': "eiam.ap-southeast-1.aliyuncs.com",
-      'ap-southeast-5': "eiam.ap-southeast-5.aliyuncs.com",
-      'cn-hangzhou': "eiam.cn-hangzhou.aliyuncs.com",
-      'cn-beijing': "eiam.cn-beijing.aliyuncs.com",
-      'eu-central-1': "eiam.eu-central-1.aliyuncs.com",
-    };
     this.checkConfig(config);
     this._endpoint = this.getEndpoint("eiam", this._regionId, this._endpointRule, this._network, this._suffix, this._endpointMap, this._endpoint);
   }
@@ -1021,7 +1012,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Determines whether an instance has the capability of a specific module.
+   * Checks whether an instance has the feature of a specific module.
    * 
    * @param request - CheckInstanceModuleStatusRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -1072,7 +1063,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Determines whether an instance has the capability of a specific module.
+   * Checks whether an instance has the feature of a specific module.
    * 
    * @param request - CheckInstanceModuleStatusRequest
    * @returns CheckInstanceModuleStatusResponse
@@ -1217,7 +1208,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Creates an application federated identity credential.
+   * Creates an application federated credential.
    * 
    * @param request - CreateApplicationFederatedCredentialRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -1288,7 +1279,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Creates an application federated identity credential.
+   * Creates an application federated credential.
    * 
    * @param request - CreateApplicationFederatedCredentialRequest
    * @returns CreateApplicationFederatedCredentialResponse
@@ -1647,10 +1638,11 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Creates a cloud account resource in a specified EIAM instance.
+   * Creates a cloud account resource under a specified EIAM instance.
    * 
    * @remarks
-   * *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.**
+   * <props="china">**Before you call this operation, make sure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/ecs/detail) of IDaaS EIAM.**
+   * <props="intl">**Before you call this operation, make sure that you fully understand the billing method of IDaaS EIAM.**
    * 
    * @param request - CreateCloudAccountRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -1709,10 +1701,11 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Creates a cloud account resource in a specified EIAM instance.
+   * Creates a cloud account resource under a specified EIAM instance.
    * 
    * @remarks
-   * *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.**
+   * <props="china">**Before you call this operation, make sure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/ecs/detail) of IDaaS EIAM.**
+   * <props="intl">**Before you call this operation, make sure that you fully understand the billing method of IDaaS EIAM.**
    * 
    * @param request - CreateCloudAccountRequest
    * @returns CreateCloudAccountResponse
@@ -2405,7 +2398,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Create an identity provider.
+   * Creates an identity provider.
    * 
    * @param request - CreateIdentityProviderRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -2504,7 +2497,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Create an identity provider.
+   * Creates an identity provider.
    * 
    * @param request - CreateIdentityProviderRequest
    * @returns CreateIdentityProviderResponse
@@ -6684,7 +6677,8 @@ export default class Client extends OpenApi {
    * Enables a field.
    * 
    * @remarks
-   * *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.**.
+   * <props="china">**Before using this operation, make sure that you fully understand the billing methods and [pricing](https://www.aliyun.com/price/product#/ecs/detail) of IDaaS EIAM.**
+   * <props="intl">**Before using this operation, make sure that you fully understand the billing methods of IDaaS EIAM.**
    * 
    * @param request - EnableCustomFieldRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -6722,7 +6716,8 @@ export default class Client extends OpenApi {
    * Enables a field.
    * 
    * @remarks
-   * *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.**.
+   * <props="china">**Before using this operation, make sure that you fully understand the billing methods and [pricing](https://www.aliyun.com/price/product#/ecs/detail) of IDaaS EIAM.**
+   * <props="intl">**Before using this operation, make sure that you fully understand the billing methods of IDaaS EIAM.**
    * 
    * @param request - EnableCustomFieldRequest
    * @returns EnableCustomFieldResponse
@@ -7703,7 +7698,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Retrieves the federated identity credential of an application.
+   * Retrieves an application federated identity credential.
    * 
    * @param request - GetApplicationFederatedCredentialRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -7742,7 +7737,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Retrieves the federated identity credential of an application.
+   * Retrieves an application federated identity credential.
    * 
    * @param request - GetApplicationFederatedCredentialRequest
    * @returns GetApplicationFederatedCredentialResponse
@@ -7987,7 +7982,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Retrieves the single sign-on (SSO) configuration for an application in EIAM.
+   * Queries the single sign-on (SSO) configuration properties of an EIAM application.
    * 
    * @param request - GetApplicationSsoConfigRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -8022,7 +8017,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Retrieves the single sign-on (SSO) configuration for an application in EIAM.
+   * Queries the single sign-on (SSO) configuration properties of an EIAM application.
    * 
    * @param request - GetApplicationSsoConfigRequest
    * @returns GetApplicationSsoConfigResponse
@@ -8075,7 +8070,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Queries the information of an authorization resource.
+   * Queries the information about an authorization resource.
    * 
    * @param request - GetAuthorizationResourceRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -8114,7 +8109,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Queries the information of an authorization resource.
+   * Queries the information about an authorization resource.
    * 
    * @param request - GetAuthorizationResourceRequest
    * @returns GetAuthorizationResourceResponse
@@ -8217,7 +8212,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Get Brand Details
+   * Retrieves the details of a brand.
    * 
    * @param request - GetBrandRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -8252,7 +8247,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Get Brand Details
+   * Retrieves the details of a brand.
    * 
    * @param request - GetBrandRequest
    * @returns GetBrandResponse
@@ -10251,7 +10246,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Queries a list of application federated credentials.
+   * Queries the list of application federated identity credentials.
    * 
    * @param request - ListApplicationFederatedCredentialsRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -10302,7 +10297,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Queries a list of application federated credentials.
+   * Queries the list of application federated identity credentials.
    * 
    * @param request - ListApplicationFederatedCredentialsRequest
    * @returns ListApplicationFederatedCredentialsResponse
@@ -10981,10 +10976,10 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Queries a list of authorization resource information.
+   * Lists authorized resource information.
    * 
    * @remarks
-   * This operation queries only the direct permissions of an organization, that is, applications directly assigned to the organization. When calling this operation, you can use the **ApplicationIds** parameter to filter applications.
+   * This operation queries only the direct permissions of an organization, that is, applications directly assigned to the organization. When you call this operation, you can use the **ApplicationIds** parameter to filter applications.
    * 
    * @param request - ListAuthorizationResourcesRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -11031,10 +11026,10 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Queries a list of authorization resource information.
+   * Lists authorized resource information.
    * 
    * @remarks
-   * This operation queries only the direct permissions of an organization, that is, applications directly assigned to the organization. When calling this operation, you can use the **ApplicationIds** parameter to filter applications.
+   * This operation queries only the direct permissions of an organization, that is, applications directly assigned to the organization. When you call this operation, you can use the **ApplicationIds** parameter to filter applications.
    * 
    * @param request - ListAuthorizationResourcesRequest
    * @returns ListAuthorizationResourcesResponse
@@ -11419,7 +11414,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Queries the information about one or more cloud roles by using paging.
+   * Queries information about one or more cloud roles by using paging.
    * 
    * @param request - ListCloudAccountRolesRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -11466,7 +11461,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Queries the information about one or more cloud roles by using paging.
+   * Queries information about one or more cloud roles by using paging.
    * 
    * @param request - ListCloudAccountRolesRequest
    * @returns ListCloudAccountRolesResponse
@@ -11477,7 +11472,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Queries one or more cloud accounts by using paging.
+   * Queries information about one or more cloud accounts by using paging.
    * 
    * @param request - ListCloudAccountsRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -11520,7 +11515,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Queries one or more cloud accounts by using paging.
+   * Queries information about one or more cloud accounts by using paging.
    * 
    * @param request - ListCloudAccountsRequest
    * @returns ListCloudAccountsResponse
@@ -15350,10 +15345,10 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Sets the single sign-on (SSO) configuration properties for an EIAM application.
+   * Sets the single sign-on (SSO) configuration properties of an EIAM application.
    * 
    * @remarks
-   * 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.
+   * 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 afterward. Specify the corresponding SSO configuration property parameters based on the SSO protocol type supported by the current application.
    * 
    * @param request - SetApplicationSsoConfigRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -15408,10 +15403,10 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Sets the single sign-on (SSO) configuration properties for an EIAM application.
+   * Sets the single sign-on (SSO) configuration properties of an EIAM application.
    * 
    * @remarks
-   * 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.
+   * 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 afterward. Specify the corresponding SSO configuration property parameters based on the SSO protocol type supported by the current application.
    * 
    * @param request - SetApplicationSsoConfigRequest
    * @returns SetApplicationSsoConfigResponse
@@ -16614,7 +16609,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Updates a federated credential for an application.
+   * Updates an application federated identity credential.
    * 
    * @param request - UpdateApplicationFederatedCredentialRequest
    * @param runtime - runtime options for this request RuntimeOptions
@@ -16669,7 +16664,7 @@ export default class Client extends OpenApi {
   }
 
   /**
-   * Updates a federated credential for an application.
+   * Updates an application federated identity credential.
    * 
    * @param request - UpdateApplicationFederatedCredentialRequest
    * @returns UpdateApplicationFederatedCredentialResponse

package/src/models/CheckInstanceModuleStatusRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CheckInstanceModuleStatusRequest extends $dara.Model {
   /**
    * @remarks
-   * The secondary module identifier.
+   * The level-2 module identifier.
    * 
    * @example
    * urn:alibaba:idaas:license:module:ud:customField
@@ -23,7 +23,7 @@ export class CheckInstanceModuleStatusRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The primary module identifier.
+   * The level-1 module identifier.
    * 
    * This parameter is required.
    * 
@@ -31,11 +31,25 @@ export class CheckInstanceModuleStatusRequest extends $dara.Model {
    * urn:alibaba:idaas:license:module:ud
    */
   moduleKey?: string;
+  /**
+   * @remarks
+   * The resource label URN key.
+   * 
+   * @example
+   * urn:alibaba:idaas:license:label:template:app
+   */
   resourceLabelKey?: string;
+  /**
+   * @remarks
+   * The resource label name.
+   * 
+   * @example
+   * apt_ram_user_sso
+   */
   resourceLabelValue?: string;
   /**
    * @remarks
-   * The tertiary module identifier.
+   * The level-3 module identifier.
    * 
    * @example
    * urn:alibaba:idaas:license:module:idp:alibaba:dingtalk:pull:advanced_configuration

package/src/models/CreateApplicationFederatedCredentialRequest.ts

@@ -43,9 +43,34 @@ export class CreateApplicationFederatedCredentialRequestAttributeMappings extend
 }
 
 export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigAzureVmConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The principal ID.
+   * 
+   * @example
+   * 5dee234a-1b4c-4ad7-a19f-fxxxxx
+   */
   principalId?: string;
+  /**
+   * @remarks
+   * The Azure resource group name.
+   * 
+   * @example
+   * user_default
+   */
   resourceGroupName?: string;
+  /**
+   * @remarks
+   * The subscription ID.
+   * 
+   * @example
+   * 4342a1f4-7e5d-4371-97dc-d4f33f4xxxx
+   */
   subscriptionId?: string;
+  /**
+   * @remarks
+   * The list of virtual machine names.
+   */
   vmNames?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -78,11 +103,22 @@ export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigAz
 }
 
 export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigGcpVmConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The list of GCP virtual machine instance IDs.
+   */
   instanceIds?: string[];
+  /**
+   * @remarks
+   * The GCP project ID to which the resource belongs.
+   * 
+   * @example
+   * turnkey-axiom-475109-xx
+   */
   projectId?: string;
   /**
    * @remarks
-   * The sub claim that corresponds to the service account.
+   * The sub claim corresponding to the service account.
    * 
    * @example
    * 123456789
@@ -117,6 +153,13 @@ export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigGc
 }
 
 export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigGenericConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The subject.
+   * 
+   * @example
+   * test_subject
+   */
   subject?: string;
   static names(): { [key: string]: string } {
     return {
@@ -142,7 +185,7 @@ export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigGe
 export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigKubernetesConfig extends $dara.Model {
   /**
    * @remarks
-   * The Kubernetes namespace.
+   * The K8s namespace.
    * 
    * @example
    * default
@@ -158,7 +201,7 @@ export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigKu
   podNamePrefix?: string;
   /**
    * @remarks
-   * The Kubernetes service account name.
+   * The K8s service account name.
    * 
    * @example
    * my-sa
@@ -200,6 +243,10 @@ export class CreateApplicationFederatedCredentialRequestOidcVerificationConfig e
    * The GCP VM scenario configuration.
    */
   gcpVmConfig?: CreateApplicationFederatedCredentialRequestOidcVerificationConfigGcpVmConfig;
+  /**
+   * @remarks
+   * The generic scenario configuration.
+   */
   genericConfig?: CreateApplicationFederatedCredentialRequestOidcVerificationConfigGenericConfig;
   /**
    * @remarks
@@ -208,8 +255,7 @@ export class CreateApplicationFederatedCredentialRequestOidcVerificationConfig e
   kubernetesConfig?: CreateApplicationFederatedCredentialRequestOidcVerificationConfigKubernetesConfig;
   /**
    * @remarks
-   * The OIDC scenario profile. Valid values:
-   * 
+   * The OIDC scenario profile. Different profiles correspond to different configurations. Valid values:
    * - generic
    * - kubernetes
    * - gcp_vm
@@ -261,6 +307,10 @@ export class CreateApplicationFederatedCredentialRequestOidcVerificationConfig e
 }
 
 export class CreateApplicationFederatedCredentialRequestPkcs7VerificationConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The list of instance IDs.
+   */
   instanceIds?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -289,7 +339,7 @@ export class CreateApplicationFederatedCredentialRequestPkcs7VerificationConfig
 export class CreateApplicationFederatedCredentialRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the application federated identity credential.
+   * The application federated credential name.
    * 
    * This parameter is required.
    * 
@@ -299,7 +349,7 @@ export class CreateApplicationFederatedCredentialRequest extends $dara.Model {
   applicationFederatedCredentialName?: string;
   /**
    * @remarks
-   * The type of the application federated identity credential.
+   * The application federated credential type.
    * 
    * This parameter is required.
    * 
@@ -352,12 +402,12 @@ export class CreateApplicationFederatedCredentialRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The OIDC structured configuration. This parameter applies when the verification mode is structured and the credential type is oidc.
+   * The OIDC structured configuration.
    */
   oidcVerificationConfig?: CreateApplicationFederatedCredentialRequestOidcVerificationConfig;
   /**
    * @remarks
-   * The PKCS#7 structured configuration. This parameter applies when the verification mode is structured and the credential type is pkcs7.
+   * The PKCS#7 structured configuration.
    */
   pkcs7VerificationConfig?: CreateApplicationFederatedCredentialRequestPkcs7VerificationConfig;
   /**
@@ -371,9 +421,8 @@ export class CreateApplicationFederatedCredentialRequest extends $dara.Model {
   /**
    * @remarks
    * The verification mode. Valid values:
-   * 
-   * - freedom (default)
-   * - structured
+   * - freedom: free mode
+   * - structured: structured mode
    * 
    * @example
    * freedom

package/src/models/CreateApplicationFederatedCredentialResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateApplicationFederatedCredentialResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The application federated identity credential ID.
+   * The application federated credential ID.
    * 
    * @example
    * afc_asd123daxxxx

package/src/models/CreateCloudAccountRequest.ts

@@ -59,7 +59,7 @@ export class CreateCloudAccountRequest extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * Alibaba_cloud(Alibaba Cloud)
+   * alibaba_cloud(Alibaba Cloud)
    */
   cloudAccountVendorType?: string;
   /**