@alicloud/eiam20211201 2.16.1 → 2.17.0

package/src/models/CreateCustomFieldRequest.ts

@@ -5,7 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCustomFieldRequestFieldDataConfigItems extends $dara.Model {
   /**
    * @remarks
-   * The display name of the configuration item. The display name can be up to 128 characters in length.
+   * The display name of the configuration item.
+   * Maximum length: 128 characters.
    * 
    * @example
    * string
@@ -14,12 +15,10 @@ export class CreateCustomFieldRequestFieldDataConfigItems extends $dara.Model {
   /**
    * @remarks
    * The status of the configuration item. Valid values:
+   * - enabled: Enabled.
+   * - disabled: Disabled.
    * 
-   * - enabled: The configuration item is enabled.
-   * 
-   * - disabled: The configuration item is disabled.
-   * 
-   * If a configuration item is disabled, it is unavailable when you create or update the field value for an entity.
+   * If a configuration item is disabled, it cannot be used when creating or updating entity field values.
    * 
    * @example
    * string
@@ -27,7 +26,8 @@ export class CreateCustomFieldRequestFieldDataConfigItems extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The value of the configuration item. The value can be up to 64 characters in length.
+   * The display value of the configuration item.
+   * Maximum length: 64 characters.
    * 
    * @example
    * string
@@ -61,7 +61,7 @@ export class CreateCustomFieldRequestFieldDataConfigItems extends $dara.Model {
 export class CreateCustomFieldRequestFieldDataConfig extends $dara.Model {
   /**
    * @remarks
-   * A list of field configuration items. The list can contain up to 100 items.
+   * The list of field configuration items. Maximum number of items: 100.
    * 
    * @example
    * string
@@ -94,7 +94,8 @@ export class CreateCustomFieldRequestFieldDataConfig extends $dara.Model {
 export class CreateCustomFieldRequest extends $dara.Model {
   /**
    * @remarks
-   * The default value of the field. If the field has configuration items, the default value must be one of the enabled configuration items. The default value can be up to 1024 characters in length.
+   * The default value of the field.
+   * 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.
    * 
    * @example
    * string
@@ -102,7 +103,8 @@ export class CreateCustomFieldRequest extends $dara.Model {
   defaultValue?: string;
   /**
    * @remarks
-   * The description of the field. The description can be up to 512 characters in length.
+   * The field description.
+   * Maximum length: 512 characters.
    * 
    * @example
    * Field test
@@ -110,7 +112,8 @@ export class CreateCustomFieldRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Indicates whether to encrypt the field value. If you set this parameter to true, the system encrypts the data value before storing it.
+   * Specifies whether to encrypt the field.
+   * If this parameter is set to true, the data value is encrypted at the storage layer.
    * 
    * @example
    * false
@@ -118,9 +121,8 @@ export class CreateCustomFieldRequest extends $dara.Model {
   encrypted?: boolean;
   /**
    * @remarks
-   * The entity to which the field belongs. Valid value:
-   * 
-   * - user: an account.
+   * The entity to which the field belongs. Valid values:
+   * - user: account.
    * 
    * This parameter is required.
    * 
@@ -130,18 +132,15 @@ export class CreateCustomFieldRequest extends $dara.Model {
   entityType?: string;
   /**
    * @remarks
-   * The configuration items of the field value.
+   * The field value configuration items.
    */
   fieldDataConfig?: CreateCustomFieldRequestFieldDataConfig;
   /**
    * @remarks
    * The data type of the field. Valid values:
-   * 
-   * - string: a string.
-   * 
-   * - number: a number. The number can be up to 32 digits in length and can be a positive integer or a decimal.
-   * 
-   * - boolean: a Boolean value.
+   * - string: string.
+   * - number: number. Maximum length: 32 characters. Positive integers and decimals are supported.
+   * - boolean: Boolean.
    * 
    * This parameter is required.
    * 
@@ -151,7 +150,8 @@ export class CreateCustomFieldRequest extends $dara.Model {
   fieldDataType?: string;
   /**
    * @remarks
-   * The display name of the field. The display name can be up to 64 characters in length.
+   * The field display name.
+   * Maximum length: 64 characters.
    * 
    * This parameter is required.
    * 
@@ -161,13 +161,10 @@ export class CreateCustomFieldRequest extends $dara.Model {
   fieldDisplayName?: string;
   /**
    * @remarks
-   * The display type of the field. Valid values:
-   * 
-   * - input: a text box. This display type supports the string and number data types.
-   * 
-   * - select: a drop-down list. This display type supports the string and Boolean data types.
-   * 
-   * - checkbox: a check box. This display type supports the string data type.
+   * The field display type. Valid values:
+   * - input: text input box. Supported data types: string and number.
+   * - select: drop-down list. Supported data types: string and boolean.
+   * - checkbox: multi-select box. Supported data types: string.
    * 
    * This parameter is required.
    * 
@@ -177,7 +174,8 @@ export class CreateCustomFieldRequest extends $dara.Model {
   fieldDisplayType?: string;
   /**
    * @remarks
-   * The name of the field. The name can be up to 40 characters in length and can contain lowercase letters and underscores (_). It cannot start with an underscore (_).
+   * The field identifier.
+   * Maximum length: 40 characters. The value can contain lowercase letters and underscores, and cannot start with an underscore.
    * 
    * This parameter is required.
    * 
@@ -197,7 +195,7 @@ export class CreateCustomFieldRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * Indicates whether the field is required.
+   * Specifies whether the field is required.
    * 
    * @example
    * false
@@ -205,7 +203,8 @@ export class CreateCustomFieldRequest extends $dara.Model {
   required?: boolean;
   /**
    * @remarks
-   * Indicates whether the field value is unique. If you set this parameter to true, the value of this field must be unique for the specified entity type.
+   * Specifies whether the field value is unique.
+   * If this parameter is set to true, the field value must be unique within the corresponding entity type and cannot be duplicated.
    * 
    * @example
    * false
@@ -213,13 +212,10 @@ export class CreateCustomFieldRequest extends $dara.Model {
   unique?: boolean;
   /**
    * @remarks
-   * The permission on the field in the portal. Valid values:
-   * 
-   * - hide: The field is not visible in the portal.
-   * 
-   * - read_only: The field is visible but cannot be modified in the portal.
-   * 
-   * - read_write: The field is visible and can be modified in the portal.
+   * The field permission on the portal side. Valid values:
+   * - hide: Not visible on the portal side.
+   * - read_only: Visible on the portal side but cannot be edited or updated.
+   * - read_write: Visible and editable on the portal side.
    * 
    * @example
    * false

package/src/models/CreateDomainProxyTokenRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDomainProxyTokenRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the domain name.
+   * The domain name ID.
    * 
    * This parameter is required.
    * 

package/src/models/CreateDomainProxyTokenResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDomainProxyTokenResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the proxy token of the domain name.
+   * The domain proxy token ID.
    * 
    * @example
    * pt_mtohn73423stghoivjmi4jwxxx

package/src/models/CreateInstanceTrialLicenseResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateInstanceTrialLicenseResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The unique ID of the license.
+   * The unique identifier of the License.
    * 
    * @example
    * license_463hfmewi2njxxxx

package/src/models/CreateNetworkAccessEndpointRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateNetworkAccessEndpointRequest extends $dara.Model {
   /**
    * @remarks
-   * Idempotent token.
+   * 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).
    * 
    * @example
    * client-token-example
@@ -13,7 +13,7 @@ export class CreateNetworkAccessEndpointRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The region ID of the VPC.
+   * Instance ID.
    * 
    * This parameter is required.
    * 
@@ -23,7 +23,7 @@ export class CreateNetworkAccessEndpointRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * Private network endpoint name.
+   * Network access endpoint name.
    * 
    * This parameter is required.
    * 
@@ -33,7 +33,7 @@ export class CreateNetworkAccessEndpointRequest extends $dara.Model {
   networkAccessEndpointName?: string;
   /**
    * @remarks
-   * The IDs of vSwitches.
+   * List of specified vSwitches connected to the network access endpoint.
    * 
    * @example
    * vsw-examplexxx
@@ -41,7 +41,7 @@ export class CreateNetworkAccessEndpointRequest extends $dara.Model {
   vSwitchIds?: string[];
   /**
    * @remarks
-   * The ID of the VPC.
+   * VPC ID connected to the network access endpoint.
    * 
    * This parameter is required.
    * 
@@ -51,7 +51,7 @@ export class CreateNetworkAccessEndpointRequest extends $dara.Model {
   vpcId?: string;
   /**
    * @remarks
-   * The region ID of the outbound VPC.
+   * Region of the VPC ID connected to the network access endpoint.
    * 
    * This parameter is required.
    * 

package/src/models/CreateNetworkAccessEndpointResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateNetworkAccessEndpointResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The unique identifier of the network access endpoint.
+   * Network access endpoint ID.
    * 
    * @example
    * nae_examplexxxx
@@ -13,7 +13,7 @@ export class CreateNetworkAccessEndpointResponseBody extends $dara.Model {
   networkAccessEndpointId?: string;
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A

package/src/models/CreateNetworkZoneRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateNetworkZoneRequest extends $dara.Model {
   /**
    * @remarks
-   * The idempotence token.
+   * Idempotency token.
    * 
    * @example
    * client-token-example
@@ -13,7 +13,7 @@ export class CreateNetworkZoneRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The description of the network zone.
+   * Network zone description.
    * 
    * @example
    * Test description
@@ -21,7 +21,7 @@ export class CreateNetworkZoneRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The instance ID.
+   * Instance ID.
    * 
    * This parameter is required.
    * 
@@ -31,7 +31,7 @@ export class CreateNetworkZoneRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The IPv4 CIDR blocks of the network zone.
+   * Network zone IPv4 CIDR blocks.
    * 
    * @example
    * 0.0.0.0/0
@@ -39,7 +39,7 @@ export class CreateNetworkZoneRequest extends $dara.Model {
   ipv4Cidrs?: string[];
   /**
    * @remarks
-   * The IPv6 CIDR blocks of the network zone.
+   * Network zone IPv6 CIDR blocks.
    * 
    * @example
    * ::/0
@@ -47,7 +47,7 @@ export class CreateNetworkZoneRequest extends $dara.Model {
   ipv6Cidrs?: string[];
   /**
    * @remarks
-   * The name of the network zone.
+   * Network zone name.
    * 
    * This parameter is required.
    * 
@@ -57,7 +57,7 @@ export class CreateNetworkZoneRequest extends $dara.Model {
   networkZoneName?: string;
   /**
    * @remarks
-   * The type of the network zone.
+   * Network zone type.
    * 
    * This parameter is required.
    * 
@@ -67,7 +67,7 @@ export class CreateNetworkZoneRequest extends $dara.Model {
   networkZoneType?: string;
   /**
    * @remarks
-   * The ID of the VPC.
+   * VPC ID.
    * 
    * @example
    * vpc_xxxxx

package/src/models/CreateNetworkZoneResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateNetworkZoneResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the network zone.
+   * Network zone ID.
    * 
    * @example
    * network_m6a57vre4g3h7m725yrq6pxxxx
@@ -13,7 +13,7 @@ export class CreateNetworkZoneResponseBody extends $dara.Model {
   networkZoneId?: string;
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A

package/src/models/DeleteAuthorizationResourceRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteAuthorizationResourceRequest extends $dara.Model {
   /**
    * @remarks
-   * The authorization resource ID.
+   * The authorized resource ID.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteBrandRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteBrandRequest extends $dara.Model {
   /**
    * @remarks
-   * The brand ID.
+   * Brand ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class DeleteBrandRequest extends $dara.Model {
   brandId?: string;
   /**
    * @remarks
-   * The instance ID.
+   * Instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteBrandResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteBrandResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A

package/src/models/DeleteCustomPrivacyPolicyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteCustomPrivacyPolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * The custom privacy policy ID.
+   * The custom clause ID.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteDomainProxyTokenRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteDomainProxyTokenRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the domain name.
+   * The domain name ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class DeleteDomainProxyTokenRequest extends $dara.Model {
   domainId?: string;
   /**
    * @remarks
-   * The ID of the proxy token of the domain name.
+   * The domain proxy token ID.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteDomainRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteDomainRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the domain name.
+   * The domain name ID.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteInstanceRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteInstanceRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the instance to be deleted.
+   * The instance ID of the instance to delete.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteNetworkAccessEndpointRequest.ts

@@ -15,7 +15,7 @@ export class DeleteNetworkAccessEndpointRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * Network Access Endpoint ID.
+   * The ID of the dedicated network access endpoint. Only network access endpoints whose NetworkEndpointType is private can be deleted.
    * 
    * This parameter is required.
    * 

package/src/models/DisableAuthorizationRuleRequest.ts

@@ -15,7 +15,7 @@ export class DisableAuthorizationRuleRequest extends $dara.Model {
   authorizationRuleId?: string;
   /**
    * @remarks
-   * A client token to ensure the idempotence of the request. Generate a unique value from your client for this parameter. The value 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).
+   * 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).
    * 
    * This parameter is required.
    * 

package/src/models/DisableBrandRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DisableBrandRequest extends $dara.Model {
   /**
    * @remarks
-   * The branding ID.
+   * The brand ID.
    * 
    * This parameter is required.
    * 

package/src/models/DisableConditionalAccessPolicyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DisableConditionalAccessPolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the conditional access policy.
+   * The conditional access policy ID.
    * 
    * This parameter is required.
    * 

package/src/models/DisableCustomPrivacyPolicyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DisableCustomPrivacyPolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the custom privacy policy.
+   * The ID of the custom term.
    * 
    * This parameter is required.
    * 

package/src/models/DisableDomainProxyTokenRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DisableDomainProxyTokenRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the domain name.
+   * The domain ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class DisableDomainProxyTokenRequest extends $dara.Model {
   domainId?: string;
   /**
    * @remarks
-   * The ID of the proxy token of the domain name.
+   * The domain proxy token ID.
    * 
    * This parameter is required.
    * 

package/src/models/DisableInitDomainAutoRedirectRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DisableInitDomainAutoRedirectRequest extends $dara.Model {
   /**
    * @remarks
-   * The instance ID.
+   * Instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/DisableInitDomainAutoRedirectResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DisableInitDomainAutoRedirectResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A

package/src/models/EnableAuthorizationRuleRequest.ts

@@ -15,7 +15,7 @@ export class EnableAuthorizationRuleRequest extends $dara.Model {
   authorizationRuleId?: string;
   /**
    * @remarks
-   * A unique, client-generated token to ensure the idempotence of the 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/zh/ecs/developer-reference/how-to-ensure-idempotence).
+   * 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).
    * 
    * This parameter is required.
    * 

package/src/models/EnableBrandRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class EnableBrandRequest extends $dara.Model {
   /**
    * @remarks
-   * The branding ID.
+   * The brand ID.
    * 
    * This parameter is required.
    * 

package/src/models/EnableConditionalAccessPolicyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class EnableConditionalAccessPolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the conditional access policy.
+   * The conditional access policy ID.
    * 
    * This parameter is required.
    * 

package/src/models/EnableCustomPrivacyPolicyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class EnableCustomPrivacyPolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * The custom privacy policy ID.
+   * The ID of the custom clause.
    * 
    * This parameter is required.
    * 

package/src/models/EnableDomainProxyTokenRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class EnableDomainProxyTokenRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the domain name.
+   * The domain name ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class EnableDomainProxyTokenRequest extends $dara.Model {
   domainId?: string;
   /**
    * @remarks
-   * The ID of the proxy token of the domain name.
+   * The domain proxy token ID.
    * 
    * This parameter is required.
    * 

package/src/models/EnableInitDomainAutoRedirectRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class EnableInitDomainAutoRedirectRequest extends $dara.Model {
   /**
    * @remarks
-   * The instance ID.
+   * Instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/EnableInitDomainAutoRedirectResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class EnableInitDomainAutoRedirectResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A

package/src/models/GenerateDownloadUrlForSynchronizationJobRequest.ts

@@ -15,7 +15,7 @@ export class GenerateDownloadUrlForSynchronizationJobRequest extends $dara.Model
   instanceId?: string;
   /**
    * @remarks
-   * The ID of the sync task.
+   * The synchronization task ID.
    * 
    * This parameter is required.
    * 

package/src/models/GenerateFileImportTemplateRequest.ts

@@ -15,7 +15,10 @@ export class GenerateFileImportTemplateRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The synchronization target type.
+   * The synchronization target type. Valid values:
+   * - identity_provider: identity provider
+   * - application: application
+   * - eiam_v2_user_import: IDaaS 2.0 user import.
    * 
    * This parameter is required.
    *