@alicloud/eiam20211201 2.17.0 → 2.17.2

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/ObtainApplicationClientSecretResponseBody.ts

@@ -29,7 +29,7 @@ export class ObtainApplicationClientSecretResponseBodyApplicationClientSecret ex
   clientSecret?: string;
   /**
    * @remarks
-   * The expiration time of the client secret. This is a UNIX timestamp. Unit: milliseconds.
+   * The expiration time of the client secret. The value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1749830226000
@@ -45,7 +45,7 @@ export class ObtainApplicationClientSecretResponseBodyApplicationClientSecret ex
   instanceId?: string;
   /**
    * @remarks
-   * The last time the client secret was used. This is a UNIX timestamp. Unit: milliseconds.
+   * The time when the client secret was last used. The value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1649830226000
@@ -62,10 +62,8 @@ export class ObtainApplicationClientSecretResponseBodyApplicationClientSecret ex
   /**
    * @remarks
    * The status of the client secret. Valid values:
-   * 
-   * - enabled: The secret is enabled.
-   * 
-   * - disabled: The secret is disabled.
+   * - enabled: Enabled.
+   * - disabled: Disabled.
    * 
    * @example
    * enabled
@@ -109,7 +107,7 @@ export class ObtainApplicationClientSecretResponseBodyApplicationClientSecret ex
 export class ObtainApplicationClientSecretResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The secret information.
+   * The client secret information.
    */
   applicationClientSecret?: ObtainApplicationClientSecretResponseBodyApplicationClientSecret;
   /**

package/src/models/ObtainApplicationTokenResponseBody.ts

@@ -29,7 +29,7 @@ export class ObtainApplicationTokenResponseBodyApplicationToken extends $dara.Mo
   applicationTokenId?: string;
   /**
    * @remarks
-   * The type of the application token.
+   * The application token type.
    * 
    * @example
    * bearer_token
@@ -53,7 +53,7 @@ export class ObtainApplicationTokenResponseBodyApplicationToken extends $dara.Mo
   expirationTime?: number;
   /**
    * @remarks
-   * The ID of the IDaaS EIAM instance.
+   * The IDaaS EIAM instance ID.
    * 
    * @example
    * idaas_ki6hd7ihir4ybawogqk6kqxxxx
@@ -61,7 +61,7 @@ export class ObtainApplicationTokenResponseBodyApplicationToken extends $dara.Mo
   instanceId?: string;
   /**
    * @remarks
-   * The time when the token was last used.
+   * The last used time.
    * 
    * @example
    * 1735610930000
@@ -69,7 +69,7 @@ export class ObtainApplicationTokenResponseBodyApplicationToken extends $dara.Mo
   lastUsedTime?: number;
   /**
    * @remarks
-   * The status.
+   * The enabling status.
    * 
    * @example
    * enabled

package/src/models/ObtainCredentialResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ObtainCredentialResponseBodyCredentialCredentialContentApiKeyContent extends $dara.Model {
   /**
    * @remarks
-   * The API key.
+   * The API key content.
    * 
    * @example
    * nsklncmwizncxxxx
@@ -35,7 +35,7 @@ export class ObtainCredentialResponseBodyCredentialCredentialContentApiKeyConten
 export class ObtainCredentialResponseBodyCredentialCredentialContentOAuthClientContent extends $dara.Model {
   /**
    * @remarks
-   * The client ID.
+   * The client_id of the OAuth protocol.
    * 
    * @example
    * dmvncmxersdxxxxxx
@@ -43,7 +43,7 @@ export class ObtainCredentialResponseBodyCredentialCredentialContentOAuthClientC
   clientId?: string;
   /**
    * @remarks
-   * The client secret.
+   * The client_secret of the OAuth protocol.
    * 
    * @example
    * nsklnertyt5ddwizncxxxx
@@ -75,12 +75,12 @@ export class ObtainCredentialResponseBodyCredentialCredentialContentOAuthClientC
 export class ObtainCredentialResponseBodyCredentialCredentialContent extends $dara.Model {
   /**
    * @remarks
-   * The details of the API key credential.
+   * The credential content of the API key credential type.
    */
   apiKeyContent?: ObtainCredentialResponseBodyCredentialCredentialContentApiKeyContent;
   /**
    * @remarks
-   * The details of the OAuth 2.0 client credential.
+   * The credential content of the OAuth client authentication credential type.
    */
   OAuthClientContent?: ObtainCredentialResponseBodyCredentialCredentialContentOAuthClientContent;
   static names(): { [key: string]: string } {
@@ -115,7 +115,7 @@ export class ObtainCredentialResponseBodyCredentialCredentialContent extends $da
 export class ObtainCredentialResponseBodyCredential extends $dara.Model {
   /**
    * @remarks
-   * The time when the credential was created. This value is a Unix timestamp in milliseconds.
+   * The creation time, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1649830225000
@@ -128,11 +128,9 @@ export class ObtainCredentialResponseBodyCredential extends $dara.Model {
   credentialContent?: ObtainCredentialResponseBodyCredentialCredentialContent;
   /**
    * @remarks
-   * The credential creation type. Valid values:
-   * 
-   * - `system_init`: The system created the credential.
-   * 
-   * - `user_custom`: A user created the credential.
+   * The creation type of the credential. Valid values:
+   * - system_init: Created by the system.
+   * - user_custom: Created by the user.
    * 
    * @example
    * user_custom
@@ -165,11 +163,9 @@ export class ObtainCredentialResponseBodyCredential extends $dara.Model {
   credentialName?: string;
   /**
    * @remarks
-   * The credential scenario label. Valid values:
-   * 
-   * - `llm`: The credential is used for an LLM.
-   * 
-   * - `saas`: The credential is used for a SaaS application.
+   * The scenarios label of the credential. Valid values:
+   * - llm: large language model.
+   * - saas: third-party SaaS service.
    * 
    * @example
    * llm
@@ -178,7 +174,7 @@ export class ObtainCredentialResponseBodyCredential extends $dara.Model {
   credentialSharingScope?: string;
   /**
    * @remarks
-   * The credential subject ID.
+   * The ID of the subject to which the credential belongs.
    * 
    * @example
    * apt_werthgfdsasffxxxxx
@@ -186,9 +182,8 @@ export class ObtainCredentialResponseBodyCredential extends $dara.Model {
   credentialSubjectId?: string;
   /**
    * @remarks
-   * The credential subject type. Valid value:
-   * 
-   * - `authentication_token_provider`: The credential subject is an authentication token provider.
+   * The type of the subject to which the credential belongs. Valid values:
+   * - authentication_token_provider: authentication token provider.
    * 
    * @example
    * authentication_token_provider
@@ -197,10 +192,8 @@ export class ObtainCredentialResponseBodyCredential extends $dara.Model {
   /**
    * @remarks
    * The credential type. Valid values:
-   * 
-   * - `api_key`: An API key.
-   * 
-   * - `oauth_client`: An OAuth 2.0 client credential.
+   * - api_key: API key authentication credential.
+   * - oauth_client: OAuth client authentication credential.
    * 
    * @example
    * api_key
@@ -208,7 +201,7 @@ export class ObtainCredentialResponseBodyCredential extends $dara.Model {
   credentialType?: string;
   /**
    * @remarks
-   * The description.
+   * The credential description.
    * 
    * @example
    * credential_description
@@ -225,11 +218,9 @@ export class ObtainCredentialResponseBodyCredential extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The status. Valid values:
-   * 
-   * - `enabled`: The credential can be used.
-   * 
-   * - `disabled`: The credential cannot be used.
+   * The credential status. Valid values:
+   * - enabled: Enabled.
+   * - disabled: Disabled.
    * 
    * @example
    * enabled
@@ -237,7 +228,7 @@ export class ObtainCredentialResponseBodyCredential extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The time when the credential was last updated. This value is a Unix timestamp in milliseconds.
+   * The update time, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1649830227000
@@ -302,7 +293,7 @@ export class ObtainCredentialResponseBodyCredential extends $dara.Model {
 export class ObtainCredentialResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The credential details.
+   * The credential information.
    */
   credential?: ObtainCredentialResponseBodyCredential;
   /**

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.
    *