@alicloud/eiam20211201 2.16.1 → 2.17.1

package/src/models/ListUsersForAuthorizationRuleRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class ListUsersForAuthorizationRuleRequestFilter extends $dara.Model {
   /**
    * @remarks
-   * The name of the field to filter. Valid value:
+   * The name of the filter field. Valid values:
    * 
-   * - UserId: The account ID.
+   * - UserId: the account ID.
    * 
    * @example
    * UserId
@@ -15,7 +15,7 @@ export class ListUsersForAuthorizationRuleRequestFilter extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The list of values for the filter field.
+   * The values of the filter field.
    */
   value?: string[];
   static names(): { [key: string]: string } {
@@ -72,11 +72,11 @@ export class ListUsersForAuthorizationRuleRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The maximum number of entries to return on each page.
+   * The maximum number of entries per page.
    * 
-   * - The default value is 20.
+   * - Default value: 20.
    * 
-   * - The maximum value is 100.
+   * - Maximum value: 100.
    * 
    * @example
    * 20
@@ -84,9 +84,9 @@ export class ListUsersForAuthorizationRuleRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The token that specifies the start of the next page for a paged query.
+   * The token that marks the starting position for the next page of results.
    * 
-   * - If this parameter is not specified, the query starts from the first page.
+   * - If not specified, the query starts from the first page.
    * 
    * @example
    * NTxxxxxexample

package/src/models/ListUsersForAuthorizationRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListUsersForAuthorizationRuleResponseBodyUsersValidityPeriod extends $dara.Model {
   /**
    * @remarks
-   * The end time of the validity period. This is a UNIX timestamp in milliseconds.
+   * The end time of the validity period, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1704042061000
@@ -13,7 +13,7 @@ export class ListUsersForAuthorizationRuleResponseBodyUsersValidityPeriod extend
   endTime?: number;
   /**
    * @remarks
-   * The start time of the validity period. This is a UNIX timestamp in milliseconds.
+   * The start time of the validity period, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1704042061000
@@ -61,16 +61,14 @@ export class ListUsersForAuthorizationRuleResponseBodyUsers extends $dara.Model
   userId?: string;
   /**
    * @remarks
-   * The time range of the validity period. This parameter takes effect only when **ValidityType** is set to **time_bound**.
+   * The time range of the validity period. This parameter takes effect only when ValidityType is set to time_bound.
    */
   validityPeriod?: ListUsersForAuthorizationRuleResponseBodyUsersValidityPeriod;
   /**
    * @remarks
-   * The type of the validity period for the relationship. Valid values:
-   * 
+   * The validity type of the relationship. Valid values:
    * - permanent: permanent
-   * 
-   * - time_bound: custom time range
+   * - time_bound: custom time range.
    * 
    * @example
    * permanent
@@ -109,7 +107,7 @@ export class ListUsersForAuthorizationRuleResponseBodyUsers extends $dara.Model
 export class ListUsersForAuthorizationRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The number of entries returned per page.
+   * The number of entries per page in a paged query. This is the paging size.
    * 
    * @example
    * 20
@@ -117,7 +115,7 @@ export class ListUsersForAuthorizationRuleResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The token returned from the current call. Use this token to start the next paged query.
+   * The token returned for the next page of results. Use this token in the next request to retrieve the next page.
    * 
    * @example
    * NTxxxexample
@@ -133,7 +131,7 @@ export class ListUsersForAuthorizationRuleResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries.
+   * The total number of entries returned.
    * 
    * @example
    * 100
@@ -141,7 +139,7 @@ export class ListUsersForAuthorizationRuleResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * The list of accounts.
+   * The list of account data.
    */
   users?: ListUsersForAuthorizationRuleResponseBodyUsers[];
   static names(): { [key: string]: string } {

package/src/models/ListUsersRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListUsersRequest extends $dara.Model {
   /**
    * @remarks
-   * The prefix of the display name. The query is performed based on the prefix.
+   * The display name prefix. A left-match query is used.
    * 
    * @example
    * name
@@ -13,7 +13,7 @@ export class ListUsersRequest extends $dara.Model {
   displayNameStartsWith?: string;
   /**
    * @remarks
-   * The email address of the user.
+   * The email address of the account.
    * 
    * @example
    * user@example.com
@@ -31,7 +31,7 @@ export class ListUsersRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of entries per page for paging.
    * 
    * @example
    * 20
@@ -39,7 +39,7 @@ export class ListUsersRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token that is used in the next request to retrieve a new page of results.
+   * The pagination token.
    * 
    * @example
    * NTxxxxexample
@@ -47,7 +47,7 @@ export class ListUsersRequest extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * The ID of the organizational unit.
+   * The organizational unit ID.
    * 
    * @example
    * ou_wovwffm62xifdziem7an7xxxxx
@@ -55,7 +55,7 @@ export class ListUsersRequest extends $dara.Model {
   organizationalUnitId?: string;
   /**
    * @remarks
-   * The page number. The default value is 1.
+   * The page number. Default value: 1.
    * 
    * @example
    * 1
@@ -63,7 +63,7 @@ export class ListUsersRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page. The default value is 20. The maximum value is 100.
+   * The number of entries per page. Default value: 20. Maximum value: 100.
    * 
    * @example
    * 20
@@ -71,7 +71,7 @@ export class ListUsersRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The mobile number of the user.
+   * The phone number of the account.
    * 
    * @example
    * 156xxxxxxx
@@ -79,7 +79,7 @@ export class ListUsersRequest extends $dara.Model {
   phoneNumber?: string;
   /**
    * @remarks
-   * The country calling code. For example, the country calling code of China is `86`. Do not add `00` or `+` to the country calling code.
+   * The phone region code. Example: The region code for the Chinese mainland is 86, without the 00 or + prefix.
    * 
    * @example
    * 86
@@ -87,11 +87,9 @@ export class ListUsersRequest extends $dara.Model {
   phoneRegion?: string;
   /**
    * @remarks
-   * The status of the user. Valid values:
-   * 
-   * - `enabled`: The user is enabled.
-   * 
-   * - `disabled`: The user is disabled.
+   * The account status. Valid values:
+   * - enabled: Enabled.
+   * - disabled: Disabled.
    * 
    * @example
    * enable
@@ -99,9 +97,9 @@ export class ListUsersRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The external ID of the user. The external ID can be used to associate the user with a user in an external system.
+   * The external ID, which is used to associate external data with IDaaS accounts.
    * 
-   * > The external ID must be unique within the same source type and source ID.
+   * Note: The external ID must be unique within the same source type and source ID.
    * 
    * @example
    * id_wovwffm62xifdziem7an7xxxxx
@@ -109,7 +107,7 @@ export class ListUsersRequest extends $dara.Model {
   userExternalId?: string;
   /**
    * @remarks
-   * The list of user IDs.
+   * The list of account IDs.
    * 
    * @example
    * 20
@@ -117,9 +115,9 @@ export class ListUsersRequest extends $dara.Model {
   userIds?: string[];
   /**
    * @remarks
-   * The source ID of the user.
+   * The source ID of the account.
    * 
-   * If the user is created in EIAM, the value of this parameter is the ID of the EIAM instance. If the user is imported from an external system, the value of this parameter is the enterprise ID of the user in the external system. For example, if the user is imported from DingTalk, the value of this parameter is the `corpId` of the enterprise in DingTalk.
+   * 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.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
@@ -127,17 +125,12 @@ export class ListUsersRequest extends $dara.Model {
   userSourceId?: string;
   /**
    * @remarks
-   * The source type of the user. Valid values:
-   * 
-   * - `build_in`: The user is created in EIAM.
-   * 
-   * - `ding_talk`: The user is imported from DingTalk.
-   * 
-   * - `ad`: The user is imported from Active Directory (AD).
-   * 
-   * - `ldap`: The user is imported from a Lightweight Directory Access Protocol (LDAP) directory.
-   * 
-   * - `we_com`: The user is imported from WeCom.
+   * The source type of the account. Valid values:
+   * - build_in: self-built.
+   * - ding_talk: imported from DingTalk.
+   * - ad: imported from AD.
+   * - ldap: imported from LDAP.
+   * - we_com: imported from WeCom.
    * 
    * @example
    * build_in
@@ -145,7 +138,7 @@ export class ListUsersRequest extends $dara.Model {
   userSourceType?: string;
   /**
    * @remarks
-   * The prefix of the username. The query is performed based on the prefix.
+   * The username prefix. A left-match query is used.
    * 
    * @example
    * name_001

package/src/models/ListUsersResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListUsersResponseBodyUsers extends $dara.Model {
   /**
    * @remarks
-   * The account expiration time. This is a Unix timestamp in milliseconds.
+   * The account expiration time, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1652085686179
@@ -13,7 +13,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   accountExpireTime?: number;
   /**
    * @remarks
-   * The creation time. This is a Unix timestamp in milliseconds.
+   * The account creation time, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1652085686179
@@ -21,7 +21,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   createTime?: number;
   /**
    * @remarks
-   * The user description.
+   * The description of the account.
    * 
    * @example
    * xxxx
@@ -29,7 +29,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The display name.
+   * The display name of the account.
    * 
    * @example
    * display_name001
@@ -37,7 +37,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   displayName?: string;
   /**
    * @remarks
-   * The email address.
+   * The email address of the account.
    * 
    * @example
    * user@example.com
@@ -45,7 +45,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   email?: string;
   /**
    * @remarks
-   * Indicates whether the email address is verified. `true` means the user has verified the email address or an administrator has marked it as verified. `false` means the email address is not verified.
+   * 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.
    * 
    * @example
    * true
@@ -61,7 +61,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The account lock expiration time. This is a Unix timestamp in milliseconds.
+   * The account lock expiration time, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1652085686179
@@ -69,7 +69,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   lockExpireTime?: number;
   /**
    * @remarks
-   * The password expiration time. This is a Unix timestamp in milliseconds.
+   * The password expiration time, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1652085686179
@@ -77,7 +77,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   passwordExpireTime?: number;
   /**
    * @remarks
-   * Indicates whether a password is set.
+   * Indicates whether a password has been set.
    * 
    * @example
    * false
@@ -85,7 +85,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   passwordSet?: boolean;
   /**
    * @remarks
-   * The phone number.
+   * The phone number of the account.
    * 
    * @example
    * 156xxxxxxx
@@ -93,7 +93,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   phoneNumber?: string;
   /**
    * @remarks
-   * Indicates whether the phone number is verified. `true` means the user has verified the phone number or an administrator has marked it as verified. `false` means the phone number is not verified.
+   * 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.
    * 
    * @example
    * true
@@ -101,7 +101,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   phoneNumberVerified?: boolean;
   /**
    * @remarks
-   * The country calling code. For example, specify `86` for Chinese mainland. Do not include `00` or a plus sign (+).
+   * The phone region code. Example: The region code for the Chinese mainland is 86, without the 00 or + prefix.
    * 
    * @example
    * 86
@@ -109,7 +109,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   phoneRegion?: string;
   /**
    * @remarks
-   * The registration time. This is a Unix timestamp in milliseconds.
+   * The account registration time, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1652085686179
@@ -117,11 +117,9 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   registerTime?: number;
   /**
    * @remarks
-   * The status. Valid values:
-   * 
-   * - `enabled`: The user is enabled.
-   * 
-   * - `disabled`: The user is disabled.
+   * The account status. Valid values:
+   * - enabled: Enabled.
+   * - disabled: Disabled.
    * 
    * @example
    * enabled
@@ -129,7 +127,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The last update time. This is a Unix timestamp in milliseconds.
+   * The time when the account was last updated, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1652085686179
@@ -137,9 +135,9 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   updateTime?: number;
   /**
    * @remarks
-   * The external user ID. This ID maps data from an external system to a user in IDaaS. It defaults to the user ID.
+   * The external ID of the account, which is used to associate external data with IDaaS accounts. The default value is the IDaaS account ID.
    * 
-   * Note: The external user ID must be unique for the same source type and source ID.
+   * Note: The external ID must be unique within the same source type and source ID.
    * 
    * @example
    * user_d6sbsuumeta4h66ec3il7yxxxx
@@ -147,7 +145,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   userExternalId?: string;
   /**
    * @remarks
-   * The user ID.
+   * The account ID.
    * 
    * @example
    * user_d6sbsuumeta4h66ec3il7yxxxx
@@ -155,9 +153,9 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   userId?: string;
   /**
    * @remarks
-   * The user source ID.
+   * The source ID of the account.
    * 
-   * If the user is built-in, this is the instance ID. For users from other sources, this is the enterprise ID from the source, such as the `corpId` for a DingTalk organization.
+   * 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.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
@@ -165,15 +163,11 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   userSourceId?: string;
   /**
    * @remarks
-   * The user source type. Valid values:
-   * 
-   * - `build_in`: The user is a built-in user.
-   * 
-   * - `ding_talk`: The user is imported from DingTalk.
-   * 
-   * - `ad`: The user is imported from AD.
-   * 
-   * - `ldap`: The user is imported from LDAP.
+   * The source type of the account. Valid values:
+   * - build_in: self-built.
+   * - ding_talk: imported from DingTalk.
+   * - ad: imported from AD.
+   * - ldap: imported from LDAP.
    * 
    * @example
    * build_in
@@ -181,7 +175,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   userSourceType?: string;
   /**
    * @remarks
-   * The user name.
+   * The username.
    * 
    * @example
    * name001
@@ -251,7 +245,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
 export class ListUsersResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The number of entries returned per page.
+   * The number of entries per page for paging.
    * 
    * @example
    * 20
@@ -259,7 +253,7 @@ export class ListUsersResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The token used to retrieve the next page of results.
+   * The pagination token.
    * 
    * @example
    * NTxxxxxexample
@@ -275,7 +269,7 @@ export class ListUsersResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries.
+   * The total number of entries returned.
    * 
    * @example
    * 100
@@ -283,7 +277,7 @@ export class ListUsersResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * The list of users.
+   * The list of account data.
    */
   users?: ListUsersResponseBodyUsers[];
   static names(): { [key: string]: string } {

package/src/models/ObtainDomainProxyTokenRequest.ts

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

package/src/models/ObtainDomainProxyTokenResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ObtainDomainProxyTokenResponseBodyDomainProxyToken extends $dara.Model {
   /**
    * @remarks
-   * The time when the domain name proxy token was created. This value is a UNIX timestamp. Unit: milliseconds.
+   * The time when the domain proxy token was created, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1649830226000
@@ -13,7 +13,7 @@ export class ObtainDomainProxyTokenResponseBodyDomainProxyToken extends $dara.Mo
   createTime?: number;
   /**
    * @remarks
-   * The domain ID.
+   * The domain name ID.
    * 
    * @example
    * dm_examplexxxx
@@ -21,7 +21,7 @@ export class ObtainDomainProxyTokenResponseBodyDomainProxyToken extends $dara.Mo
   domainId?: string;
   /**
    * @remarks
-   * The domain name proxy token.
+   * The domain proxy token.
    * 
    * @example
    * PTxxxxxxxx
@@ -29,7 +29,7 @@ export class ObtainDomainProxyTokenResponseBodyDomainProxyToken extends $dara.Mo
   domainProxyToken?: string;
   /**
    * @remarks
-   * The ID of the domain name proxy token.
+   * The domain proxy token ID.
    * 
    * @example
    * pt_examplexxxx
@@ -45,7 +45,7 @@ export class ObtainDomainProxyTokenResponseBodyDomainProxyToken extends $dara.Mo
   instanceId?: string;
   /**
    * @remarks
-   * The time when the domain name proxy token was last used. This value is a UNIX timestamp. Unit: milliseconds.
+   * The time when the domain proxy token was last used, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1649830226000
@@ -53,11 +53,10 @@ export class ObtainDomainProxyTokenResponseBodyDomainProxyToken extends $dara.Mo
   lastUsedTime?: number;
   /**
    * @remarks
-   * The status of the token. Valid values:
+   * The token status. Valid values:
+   * - enabled: Enabled.
    * 
-   * - enabled: The token is enabled.
-   * 
-   * - disabled: The token is disabled.
+   * - disabled: Disabled.
    * 
    * @example
    * enabled
@@ -65,7 +64,7 @@ export class ObtainDomainProxyTokenResponseBodyDomainProxyToken extends $dara.Mo
   status?: string;
   /**
    * @remarks
-   * The time when the domain name proxy token was last updated. This value is a UNIX timestamp. Unit: milliseconds.
+   * The time when the domain proxy token was last updated, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1649830226000
@@ -109,7 +108,7 @@ export class ObtainDomainProxyTokenResponseBodyDomainProxyToken extends $dara.Mo
 export class ObtainDomainProxyTokenResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The information about the proxy token.
+   * The proxy token information object.
    */
   domainProxyToken?: ObtainDomainProxyTokenResponseBodyDomainProxyToken;
   /**

package/src/models/RemoveCustomPrivacyPoliciesFromBrandRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RemoveCustomPrivacyPoliciesFromBrandRequest extends $dara.Model {
   /**
    * @remarks
-   * The branding ID.
+   * The brand ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class RemoveCustomPrivacyPoliciesFromBrandRequest extends $dara.Model {
   brandId?: string;
   /**
    * @remarks
-   * A list of policy IDs.
+   * The list of term IDs.
    * 
    * This parameter is required.
    */

package/src/models/SetDefaultDomainRequest.ts

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

package/src/models/SetForgetPasswordConfigurationRequest.ts

@@ -5,7 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class SetForgetPasswordConfigurationRequest extends $dara.Model {
   /**
    * @remarks
-   * The authentication channels. Valid values: email and sms.
+   * The list of authentication channels. Valid values:
+   * - email: email.
+   * - sms: text message.
    * 
    * @example
    * email
@@ -13,7 +15,9 @@ export class SetForgetPasswordConfigurationRequest extends $dara.Model {
   authenticationChannels?: string[];
   /**
    * @remarks
-   * The status of the forgot password feature. Valid values: enabled and disabled.
+   * The forgot password configuration status. Valid values:
+   * - enabled: enabled.
+   * - disabled: disabled.
    * 
    * This parameter is required.
    *