@alicloud/eiam20211201 2.16.0 → 2.16.1

package/src/models/SetIdentityProviderUdPullConfigurationRequest.ts

@@ -5,23 +5,23 @@ import * as $dara from '@darabonba/typescript';
 export class SetIdentityProviderUdPullConfigurationRequestLdapUdPullConfig extends $dara.Model {
   /**
    * @remarks
-   * Group member attribute name
+   * The group member identifier.
    * 
    * @example
-   * memberxxx
+   * member
    */
   groupMemberAttributeName?: string;
   /**
    * @remarks
-   * GroupObjectClass
+   * The group objectClass.
    * 
    * @example
-   * groupxxx
+   * group
    */
   groupObjectClass?: string;
   /**
    * @remarks
-   * GroupObjectClass custom filter
+   * The custom group filter.
    * 
    * @example
    * (|(cn=test)(group=test@test.com))
@@ -29,23 +29,23 @@ export class SetIdentityProviderUdPullConfigurationRequestLdapUdPullConfig exten
   groupObjectClassCustomFilter?: string;
   /**
    * @remarks
-   * OrganizationUnitObjectClass
+   * The organizational unit objectClass.
    * 
    * @example
-   * organizationUnitxxx,top
+   * organizationUnit,top
    */
   organizationUnitObjectClass?: string;
   /**
    * @remarks
-   * UserObjectClass
+   * The user objectClass.
    * 
    * @example
-   * userPrincipalNamexxx, mail
+   * userPrincipalName, mail
    */
   userObjectClass?: string;
   /**
    * @remarks
-   * UserObjectClass custom filter
+   * The custom user filter.
    * 
    * @example
    * (|(cn=test)(mail=test@test.com))
@@ -85,7 +85,7 @@ export class SetIdentityProviderUdPullConfigurationRequestLdapUdPullConfig exten
 export class SetIdentityProviderUdPullConfigurationRequestPeriodicSyncConfig extends $dara.Model {
   /**
    * @remarks
-   * Periodic synchronize cron
+   * The cron expression. This parameter is required when periodicSyncType is set to cron.
    * 
    * @example
    * 0 45 1 * * ?
@@ -93,12 +93,12 @@ export class SetIdentityProviderUdPullConfigurationRequestPeriodicSyncConfig ext
   periodicSyncCron?: string;
   /**
    * @remarks
-   * Periodic synchronize times
+   * The time points for synchronization. This parameter is required when periodicSyncType is set to time. For example, if you set this parameter to [3, 5], the synchronization is performed from 03:00 to 04:00 and from 05:00 to 06:00.
    */
   periodicSyncTimes?: number[];
   /**
    * @remarks
-   * Periodic synchronize type
+   * The type.
    * 
    * @example
    * cron
@@ -135,7 +135,7 @@ export class SetIdentityProviderUdPullConfigurationRequestPeriodicSyncConfig ext
 export class SetIdentityProviderUdPullConfigurationRequestPullProtectedRule extends $dara.Model {
   /**
    * @remarks
-   * Group deleted threshold
+   * The threshold for the number of groups to be deleted. If the number of groups to be deleted exceeds this value, the synchronization task is stopped.
    * 
    * @example
    * 10
@@ -143,7 +143,7 @@ export class SetIdentityProviderUdPullConfigurationRequestPullProtectedRule exte
   groupDeletedThreshold?: number;
   /**
    * @remarks
-   * OrganizationalUnit deleted threshold
+   * The threshold for the number of organizational units to be deleted. If the number of organizational units to be deleted exceeds this value, the synchronization task is stopped.
    * 
    * @example
    * 10
@@ -151,7 +151,7 @@ export class SetIdentityProviderUdPullConfigurationRequestPullProtectedRule exte
   organizationalUnitDeletedThreshold?: number;
   /**
    * @remarks
-   * User deleted threshold
+   * The threshold for the number of users to be deleted. If the number of users to be deleted exceeds this value, the synchronization task is stopped.
    * 
    * @example
    * 30
@@ -185,12 +185,12 @@ export class SetIdentityProviderUdPullConfigurationRequestPullProtectedRule exte
 export class SetIdentityProviderUdPullConfigurationRequestUdSyncScopeConfig extends $dara.Model {
   /**
    * @remarks
-   * Synchronize source scopes
+   * The list of source nodes for synchronization.
    */
   sourceScopes?: string[];
   /**
    * @remarks
-   * Synchronize target scope
+   * The target node for synchronization.
    * 
    * @example
    * ou_asdaq1addsxzdq1XXX
@@ -225,7 +225,11 @@ export class SetIdentityProviderUdPullConfigurationRequestUdSyncScopeConfig exte
 export class SetIdentityProviderUdPullConfigurationRequest extends $dara.Model {
   /**
    * @remarks
-   * Group synchronization status.
+   * The group synchronization status. Valid values:
+   * 
+   * - disabled: The feature is disabled.
+   * 
+   * - enabled: The feature is enabled.
    * 
    * @example
    * disabled
@@ -233,7 +237,7 @@ export class SetIdentityProviderUdPullConfigurationRequest extends $dara.Model {
   groupSyncStatus?: string;
   /**
    * @remarks
-   * Identity provider ID
+   * The identity provider ID.
    * 
    * This parameter is required.
    * 
@@ -243,7 +247,11 @@ export class SetIdentityProviderUdPullConfigurationRequest extends $dara.Model {
   identityProviderId?: string;
   /**
    * @remarks
-   * Incremental callback status, whether to process incremental callback data from IdP.
+   * The status of incremental callback. This parameter specifies whether to process incremental callback data from the IdP. Valid values:
+   * 
+   * - disabled: The feature is disabled.
+   * 
+   * - enabled: The feature is enabled.
    * 
    * This parameter is required.
    * 
@@ -263,17 +271,21 @@ export class SetIdentityProviderUdPullConfigurationRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * Ldap ud pull config
+   * The configurations of LDAP synchronization.
    */
   ldapUdPullConfig?: SetIdentityProviderUdPullConfigurationRequestLdapUdPullConfig;
   /**
    * @remarks
-   * Periodic synchronize config
+   * The scheduled synchronization configuration.
    */
   periodicSyncConfig?: SetIdentityProviderUdPullConfigurationRequestPeriodicSyncConfig;
   /**
    * @remarks
-   * Periodic synchronize status
+   * The status of scheduled check. This parameter specifies whether to periodically check for data inconsistencies between IDaaS and the IdP. Valid values:
+   * 
+   * - disabled: The feature is disabled.
+   * 
+   * - enabled: The feature is enabled.
    * 
    * @example
    * disabled
@@ -281,12 +293,12 @@ export class SetIdentityProviderUdPullConfigurationRequest extends $dara.Model {
   periodicSyncStatus?: string;
   /**
    * @remarks
-   * Synchronize protected rule
+   * The inbound synchronization protection rule.
    */
   pullProtectedRule?: SetIdentityProviderUdPullConfigurationRequestPullProtectedRule;
   /**
    * @remarks
-   * Synchronize configuration information.
+   * The inbound synchronization configuration.
    */
   udSyncScopeConfig?: SetIdentityProviderUdPullConfigurationRequestUdSyncScopeConfig;
   static names(): { [key: string]: string } {

package/src/models/SetIdentityProviderUdPushConfigurationRequest.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class SetIdentityProviderUdPushConfigurationRequestLdapUdPushConfig extends $dara.Model {
   /**
+   * @remarks
+   * The object class for organizations.
+   * 
    * @example
    * ou,top
    */
   organizationUnitObjectClass?: string;
   /**
+   * @remarks
+   * The RDN for organizations.
+   * 
    * @example
    * ou
    */
   organizationalUnitRdn?: string;
   /**
+   * @remarks
+   * Specifies whether to synchronize passwords.
+   * 
    * @example
    * enabled
    */
   passwordSyncStatus?: string;
   /**
+   * @remarks
+   * The object class for users.
+   * 
    * @example
    * user,top
    */
   userObjectClass?: string;
   /**
+   * @remarks
+   * The Relative Distinguished Name (RDN) for users.
+   * 
    * @example
    * cn
    */
@@ -59,12 +74,22 @@ export class SetIdentityProviderUdPushConfigurationRequestLdapUdPushConfig exten
 
 export class SetIdentityProviderUdPushConfigurationRequestPeriodicSyncConfig extends $dara.Model {
   /**
+   * @remarks
+   * The cron expression.
+   * 
    * @example
    * 0 45 1 * * ?
    */
   periodicSyncCron?: string;
+  /**
+   * @remarks
+   * A collection of time points.
+   */
   periodicSyncTimes?: number[];
   /**
+   * @remarks
+   * The type of periodic synchronization.
+   * 
    * @example
    * cron
    */
@@ -100,12 +125,12 @@ export class SetIdentityProviderUdPushConfigurationRequestPeriodicSyncConfig ext
 export class SetIdentityProviderUdPushConfigurationRequestUdSyncScopeConfigs extends $dara.Model {
   /**
    * @remarks
-   * 同步来源节点
+   * The source nodes for synchronization.
    */
   sourceScopes?: string[];
   /**
    * @remarks
-   * 同步目标节点
+   * The target node for synchronization.
    * 
    * @example
    * 6537211
@@ -140,7 +165,7 @@ export class SetIdentityProviderUdPushConfigurationRequestUdSyncScopeConfigs ext
 export class SetIdentityProviderUdPushConfigurationRequest extends $dara.Model {
   /**
    * @remarks
-   * IDaaS的身份提供方主键id
+   * The ID of the identity provider.
    * 
    * This parameter is required.
    * 
@@ -150,7 +175,7 @@ export class SetIdentityProviderUdPushConfigurationRequest extends $dara.Model {
   identityProviderId?: string;
   /**
    * @remarks
-   * 增量回调状态，是否处理来自IdP的增量回调数据
+   * Specifies whether to process incremental callback data from the IdP.
    * 
    * This parameter is required.
    * 
@@ -160,7 +185,7 @@ export class SetIdentityProviderUdPushConfigurationRequest extends $dara.Model {
   incrementalCallbackStatus?: string;
   /**
    * @remarks
-   * IDaaS EIAM的实例id
+   * The instance ID.
    * 
    * This parameter is required.
    * 
@@ -168,16 +193,27 @@ export class SetIdentityProviderUdPushConfigurationRequest extends $dara.Model {
    * eiam-111ccc1111
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * The configurations for LDAP push synchronization.
+   */
   ldapUdPushConfig?: SetIdentityProviderUdPushConfigurationRequestLdapUdPushConfig;
+  /**
+   * @remarks
+   * The configuration for periodic synchronization.
+   */
   periodicSyncConfig?: SetIdentityProviderUdPushConfigurationRequestPeriodicSyncConfig;
   /**
+   * @remarks
+   * The status of periodic synchronization.
+   * 
    * @example
    * disabled
    */
   periodicSyncStatus?: string;
   /**
    * @remarks
-   * 同步出配置信息
+   * The push synchronization configurations.
    */
   udSyncScopeConfigs?: SetIdentityProviderUdPushConfigurationRequestUdSyncScopeConfigs[];
   static names(): { [key: string]: string } {

package/src/models/SetIdentityProviderUdPushConfigurationResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class SetIdentityProviderUdPushConfigurationResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
    */

package/src/models/SetInstanceControlConfigurationRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class SetInstanceControlConfigurationRequestControlElementsHumanVerificationConfig extends $dara.Model {
   /**
+   * @remarks
+   * The CAPTCHA type.
+   * 
    * @example
    * urn:alibaba:idaas:humanverification:alibaba-cloud-slider-verification
    */
@@ -32,16 +35,20 @@ export class SetInstanceControlConfigurationRequestControlElementsHumanVerificat
 export class SetInstanceControlConfigurationRequestControlElements extends $dara.Model {
   /**
    * @remarks
-   * 实例控制项名称，如human_verification。
+   * The name of the control item.
    * 
    * @example
    * human_verification
    */
   elementName?: string;
+  /**
+   * @remarks
+   * The CAPTCHA configuration.
+   */
   humanVerificationConfig?: SetInstanceControlConfigurationRequestControlElementsHumanVerificationConfig;
   /**
    * @remarks
-   * 实例控制项状态。
+   * The status of the control item.
    * 
    * @example
    * enabled
@@ -78,12 +85,12 @@ export class SetInstanceControlConfigurationRequestControlElements extends $dara
 export class SetInstanceControlConfigurationRequest extends $dara.Model {
   /**
    * @remarks
-   * 实例控制项。
+   * The control items for the instance.
    */
   controlElements?: SetInstanceControlConfigurationRequestControlElements[];
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/SetInstanceControlConfigurationResponseBody.ts

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

package/src/models/SetInstanceGlobalizationConfigRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class SetInstanceGlobalizationConfigRequest extends $dara.Model {
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class SetInstanceGlobalizationConfigRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * 语言类型
+   * The language.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class SetInstanceGlobalizationConfigRequest extends $dara.Model {
   language?: string;
   /**
    * @remarks
-   * 时区
+   * The time zone.
    * 
    * This parameter is required.
    * 

package/src/models/SetInstanceGlobalizationConfigResponseBody.ts

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

package/src/models/SetLoginRedirectApplicationForBrandRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class SetLoginRedirectApplicationForBrandRequest extends $dara.Model {
   /**
    * @remarks
-   * 应用ID
+   * The application ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class SetLoginRedirectApplicationForBrandRequest extends $dara.Model {
   applicationId?: string;
   /**
    * @remarks
-   * 品牌化Id
+   * The brand ID.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class SetLoginRedirectApplicationForBrandRequest extends $dara.Model {
   brandId?: string;
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/SetLoginRedirectApplicationForBrandResponseBody.ts

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

package/src/models/SetPasswordComplexityConfigurationRequest.ts

@@ -5,16 +5,23 @@ import * as $dara from '@darabonba/typescript';
 export class SetPasswordComplexityConfigurationRequestPasswordComplexityRules extends $dara.Model {
   /**
    * @remarks
-   * The type of the password check. Valid values:
+   * The password check type. Valid values:
    * 
-   * *   inclusion_upper_case: The password must contain uppercase letters.
-   * *   inclusion_lower_case: The password must contain lowercase letters.
-   * *   inclusion_special_case: The password must contain one or more of the following special characters: @ % + \\ / \\" ! # $ ^ ? : , ( ) { } [ ] ~ - _ .
-   * *   inclusion_number: The password must contain digits.
-   * *   exclusion_username: The password cannot contain a username.
-   * *   exclusion_email: The password cannot contain an email prefix.
-   * *   exclusion_phone_number: The password cannot contain a mobile number.
-   * *   exclusion_display_name: The password cannot contain a display name.
+   * - inclusion_upper_case: The password must contain uppercase letters.
+   * 
+   * - inclusion_lower_case: The password must contain lowercase letters.
+   * 
+   * - inclusion_special_case: The password must contain special characters. The special characters are \\`( @ % + \\ / \\" ! # $ ^ ? : , ( ) { } [ ] \\~ - _ . )\\`.
+   * 
+   * - inclusion_number: The password must contain digits.
+   * 
+   * - exclusion_username: The password cannot contain the username.
+   * 
+   * - exclusion_email: The password cannot contain the mailbox.
+   * 
+   * - exclusion_phone_number: The password cannot contain the phone number.
+   * 
+   * - exclusion_display_name: The password cannot contain the display name.
    * 
    * @example
    * inclusion_upper_case
@@ -42,6 +49,10 @@ export class SetPasswordComplexityConfigurationRequestPasswordComplexityRules ex
 }
 
 export class SetPasswordComplexityConfigurationRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to disable logon with a weak password.
+   */
   disabledWeakPasswordLogin?: boolean;
   /**
    * @remarks
@@ -55,12 +66,12 @@ export class SetPasswordComplexityConfigurationRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The password complexity rules.
+   * The list of password complexity rules.
    */
   passwordComplexityRules?: SetPasswordComplexityConfigurationRequestPasswordComplexityRules[];
   /**
    * @remarks
-   * The minimum number of characters in a password.
+   * The minimum password length.
    * 
    * This parameter is required.
    * 

package/src/models/SetPasswordExpirationConfigurationRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class SetPasswordExpirationConfigurationRequest extends $dara.Model {
   /**
    * @remarks
-   * Effective authentication sourceIds
+   * The list of IDs of authentication sources that take effect.
    */
   effectiveAuthenticationSourceIds?: string[];
   /**
@@ -20,11 +20,11 @@ export class SetPasswordExpirationConfigurationRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The action to take upon password expiration. This parameter must be specified when PasswordExpirationStatus is set to enabled. Valid values:
+   * The action to be performed when a password expires. This parameter is required when PasswordExpirationStatus is set to enabled. Valid values:
    * 
-   * *   forbid_login: Users cannot log on to IDaaS.
-   * *   force_update_password: Users must change the password.
-   * *   remind_update_password: IDaaS reminds users to change the password upon each logon.
+   * - forbid_login: Prohibit logon.
+   * - force_update_password: Force the user to change the password.
+   * - remind_update_password: Remind the user to change the password.
    * 
    * @example
    * force_update_password
@@ -32,7 +32,7 @@ export class SetPasswordExpirationConfigurationRequest extends $dara.Model {
   passwordExpirationAction?: string;
   /**
    * @remarks
-   * The methods for receiving password expiration notifications. This parameter must be specified when PasswordExpirationNotificationStatus is set to enabled.
+   * The list of notification channels for password expiration. This parameter is required when PasswordExpirationNotificationStatus is set to enabled.
    * 
    * @example
    * login
@@ -40,7 +40,7 @@ export class SetPasswordExpirationConfigurationRequest extends $dara.Model {
   passwordExpirationNotificationChannels?: string[];
   /**
    * @remarks
-   * The number of days before the expiration date during which password expiration notifications are sent. Unit: day. This parameter must be specified when PasswordExpirationNotificationStatus is set to enabled.
+   * The time when a password expiration notification is sent. Unit: days. This parameter is required when PasswordExpirationNotificationStatus is set to enabled.
    * 
    * @example
    * 7
@@ -48,10 +48,10 @@ export class SetPasswordExpirationConfigurationRequest extends $dara.Model {
   passwordExpirationNotificationDuration?: number;
   /**
    * @remarks
-   * Specifies whether to enable the password expiration notification feature. Valid values:
+   * The status of the password expiration notification. Valid values:
    * 
-   * *   enabled
-   * *   disabled
+   * - enabled: The password expiration notification is enabled.
+   * - disabled: The password expiration notification is disabled.
    * 
    * @example
    * enabled
@@ -59,10 +59,10 @@ export class SetPasswordExpirationConfigurationRequest extends $dara.Model {
   passwordExpirationNotificationStatus?: string;
   /**
    * @remarks
-   * Specifies whether to enable the password expiration feature. Valid values:
+   * The status of the password expiration configuration. Valid values:
    * 
-   * *   enabled
-   * *   disabled
+   * - enabled: The password expiration configuration is enabled.
+   * - disabled: The password expiration configuration is disabled.
    * 
    * This parameter is required.
    * 
@@ -72,7 +72,7 @@ export class SetPasswordExpirationConfigurationRequest extends $dara.Model {
   passwordExpirationStatus?: string;
   /**
    * @remarks
-   * The number of days before which users must change the password to prevent password expiration. Unit: day. You must set this parameter to a value greater than the value of PasswordExpirationNotificationDuration.
+   * The time when a user is forced to change the password. Unit: days. The value of this parameter must be greater than the value of PasswordExpirationNotificationDuration.
    * 
    * @example
    * 7
@@ -80,7 +80,7 @@ export class SetPasswordExpirationConfigurationRequest extends $dara.Model {
   passwordForcedUpdateDuration?: number;
   /**
    * @remarks
-   * The validity period of a password. Unit: day. This parameter must be specified when PasswordExpirationStatus is set to enabled.
+   * The validity period of a password in days. This parameter is required when PasswordExpirationStatus is set to enabled.
    * 
    * @example
    * 180

package/src/models/SetPrimaryClientPublicKeyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class SetPrimaryClientPublicKeyRequest extends $dara.Model {
   /**
    * @remarks
-   * IDaaS的应用资源ID。
+   * The application ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class SetPrimaryClientPublicKeyRequest extends $dara.Model {
   applicationId?: string;
   /**
    * @remarks
-   * 应用ClientPublicKey的ID
+   * The ID of the client public key for the application.
    * 
    * This parameter is required.
    * 
@@ -25,6 +25,8 @@ export class SetPrimaryClientPublicKeyRequest extends $dara.Model {
   clientPublicKeyId?: string;
   /**
    * @remarks
+   * 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).
+   * 
    * This parameter is required.
    * 
    * @example
@@ -33,7 +35,7 @@ export class SetPrimaryClientPublicKeyRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/SetPrimaryClientPublicKeyResponseBody.ts

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