@alicloud/eiam20211201 2.16.0 → 2.17.0

package/src/models/ListUsersRequest.ts

@@ -5,15 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class ListUsersRequest extends $dara.Model {
   /**
    * @remarks
-   * Displayname
+   * The prefix of the display name. The query is performed based on the prefix.
    * 
    * @example
-   * name_001
+   * name
    */
   displayNameStartsWith?: string;
   /**
    * @remarks
-   * The email address of the user who owns the account.
+   * The email address of the user.
    * 
    * @example
    * user@example.com
@@ -21,7 +21,7 @@ export class ListUsersRequest extends $dara.Model {
   email?: string;
   /**
    * @remarks
-   * The ID of the instance.
+   * The instance ID.
    * 
    * This parameter is required.
    * 
@@ -29,7 +29,21 @@ export class ListUsersRequest extends $dara.Model {
    * idaas_ue2jvisn35ea5lmthk267xxxxx
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * The number of entries per page.
+   * 
+   * @example
+   * 20
+   */
   maxResults?: number;
+  /**
+   * @remarks
+   * The pagination token that is used in the next request to retrieve a new page of results.
+   * 
+   * @example
+   * NTxxxxexample
+   */
   nextToken?: string;
   /**
    * @remarks
@@ -41,7 +55,7 @@ export class ListUsersRequest extends $dara.Model {
   organizationalUnitId?: string;
   /**
    * @remarks
-   * The number of the page to return. Default value: 1.
+   * The page number. The default value is 1.
    * 
    * @example
    * 1
@@ -49,7 +63,7 @@ export class ListUsersRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. Default value: 20.
+   * The number of entries per page. The default value is 20. The maximum value is 100.
    * 
    * @example
    * 20
@@ -57,7 +71,7 @@ export class ListUsersRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The mobile number of the user who owns the account.
+   * The mobile number of the user.
    * 
    * @example
    * 156xxxxxxx
@@ -65,7 +79,7 @@ export class ListUsersRequest extends $dara.Model {
   phoneNumber?: string;
   /**
    * @remarks
-   * The country code of the mobile number. For example, the country code of China is 86 without 00 or +.
+   * The country calling code. For example, the country calling code of China is `86`. Do not add `00` or `+` to the country calling code.
    * 
    * @example
    * 86
@@ -73,10 +87,11 @@ export class ListUsersRequest extends $dara.Model {
   phoneRegion?: string;
   /**
    * @remarks
-   * The status of the account. Valid values:
+   * The status of the user. Valid values:
+   * 
+   * - `enabled`: The user is enabled.
    * 
-   * *   enabled: The account is enabled.
-   * *   disabled: The account is disabled.
+   * - `disabled`: The user is disabled.
    * 
    * @example
    * enable
@@ -84,9 +99,9 @@ export class ListUsersRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The external ID of the account. The external ID can be used by external data to map the data of the account in IDaaS EIAM.
+   * The external ID of the user. The external ID can be used to associate the user with a user in an external system.
    * 
-   * For accounts with the same source type and source ID, each account has a unique external ID.
+   * > The external ID must be unique within the same source type and source ID.
    * 
    * @example
    * id_wovwffm62xifdziem7an7xxxxx
@@ -94,14 +109,17 @@ export class ListUsersRequest extends $dara.Model {
   userExternalId?: string;
   /**
    * @remarks
-   * User ID set
+   * The list of user IDs.
+   * 
+   * @example
+   * 20
    */
   userIds?: string[];
   /**
    * @remarks
-   * The source ID of the account.
+   * The source ID of the user.
    * 
-   * If the account was created in IDaaS, its source ID is the ID of the IDaaS instance. If the account was imported, its source ID is the enterprise ID in the source. For example, if the account was imported from DingTalk, its source ID is the corpId value of the enterprise in DingTalk.
+   * 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.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
@@ -109,12 +127,17 @@ export class ListUsersRequest extends $dara.Model {
   userSourceId?: string;
   /**
    * @remarks
-   * The source type of the account. Valid values:
+   * 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.
    * 
-   * *   build_in: The account was created in IDaaS.
-   * *   ding_talk: The account was imported from DingTalk.
-   * *   ad: The account was imported from Microsoft Active Directory (AD).
-   * *   ldap: The account was imported from a Lightweight Directory Access Protocol (LDAP) service.
+   * - `we_com`: The user is imported from WeCom.
    * 
    * @example
    * build_in
@@ -122,7 +145,7 @@ export class ListUsersRequest extends $dara.Model {
   userSourceType?: string;
   /**
    * @remarks
-   * Username
+   * The prefix of the username. The query is performed based on the prefix.
    * 
    * @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 time when the account expires. This value is a UNIX timestamp. Unit: milliseconds.
+   * The account expiration time. This is a Unix timestamp in milliseconds.
    * 
    * @example
    * 1652085686179
@@ -13,7 +13,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   accountExpireTime?: number;
   /**
    * @remarks
-   * The time when the account was created. This value is a UNIX timestamp. Unit: milliseconds.
+   * The creation time. This is a Unix timestamp in milliseconds.
    * 
    * @example
    * 1652085686179
@@ -21,15 +21,15 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   createTime?: number;
   /**
    * @remarks
-   * The description of the account.
+   * The user description.
    * 
    * @example
-   * Test account
+   * xxxx
    */
   description?: string;
   /**
    * @remarks
-   * The display name of the account.
+   * The display name.
    * 
    * @example
    * display_name001
@@ -37,7 +37,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   displayName?: string;
   /**
    * @remarks
-   * The email address of the user who owns the account.
+   * The email address.
    * 
    * @example
    * user@example.com
@@ -45,7 +45,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   email?: string;
   /**
    * @remarks
-   * Indicates whether the email address has been verified. A value of true indicates that the email address has been verified by the user or has been set to the verified status by the administrator. A value of false indicates that the email address has not been verified.
+   * 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.
    * 
    * @example
    * true
@@ -53,7 +53,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   emailVerified?: boolean;
   /**
    * @remarks
-   * The ID of the instance
+   * The instance ID.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
@@ -61,7 +61,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The time when the account lock expires. This value is a UNIX timestamp. Unit: milliseconds.
+   * The account lock expiration time. This is a Unix timestamp in milliseconds.
    * 
    * @example
    * 1652085686179
@@ -69,7 +69,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   lockExpireTime?: number;
   /**
    * @remarks
-   * Time When Password Expires
+   * The password expiration time. This is a Unix timestamp in milliseconds.
    * 
    * @example
    * 1652085686179
@@ -85,7 +85,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   passwordSet?: boolean;
   /**
    * @remarks
-   * The mobile number of the user who owns the account.
+   * The phone number.
    * 
    * @example
    * 156xxxxxxx
@@ -93,7 +93,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   phoneNumber?: string;
   /**
    * @remarks
-   * Indicates whether the mobile number has been verified. A value of true indicates that the mobile number has been verified by the user or has been set to the verified status by the administrator. A value of false indicates that the mobile number has not been verified.
+   * 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.
    * 
    * @example
    * true
@@ -101,7 +101,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   phoneNumberVerified?: boolean;
   /**
    * @remarks
-   * The country code of the mobile number. For example, the country code of China is 86 without 00 or +.
+   * The country calling code. For example, specify `86` for Chinese mainland. Do not include `00` or a plus sign (+).
    * 
    * @example
    * 86
@@ -109,7 +109,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   phoneRegion?: string;
   /**
    * @remarks
-   * The time when the account was registered. This value is a UNIX timestamp. Unit: milliseconds.
+   * The registration time. This is a Unix timestamp in milliseconds.
    * 
    * @example
    * 1652085686179
@@ -117,10 +117,11 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   registerTime?: number;
   /**
    * @remarks
-   * The status of the account. Valid values:
+   * The status. Valid values:
    * 
-   * *   enabled: The account is enabled.
-   * *   disabled: The account is disabled.
+   * - `enabled`: The user is enabled.
+   * 
+   * - `disabled`: The user is disabled.
    * 
    * @example
    * enabled
@@ -128,7 +129,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The time when the account was last updated. The value is a UNIX timestamp. Unit: milliseconds.
+   * The last update time. This is a Unix timestamp in milliseconds.
    * 
    * @example
    * 1652085686179
@@ -136,9 +137,9 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   updateTime?: number;
   /**
    * @remarks
-   * The external ID of the account. The external ID can be used by external data to map the data of the account in IDaaS EIAM. By default, the external ID is the account ID.
+   * The external user ID. This ID maps data from an external system to a user in IDaaS. It defaults to the user ID.
    * 
-   * For accounts with the same source type and source ID, each account has a unique external ID.
+   * Note: The external user ID must be unique for the same source type and source ID.
    * 
    * @example
    * user_d6sbsuumeta4h66ec3il7yxxxx
@@ -146,7 +147,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   userExternalId?: string;
   /**
    * @remarks
-   * The ID of the account.
+   * The user ID.
    * 
    * @example
    * user_d6sbsuumeta4h66ec3il7yxxxx
@@ -154,9 +155,9 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   userId?: string;
   /**
    * @remarks
-   * The source ID of the account.
+   * The user source ID.
    * 
-   * If the account was created in IDaaS, its source ID is the ID of the IDaaS instance. If the account was imported, its source ID is the enterprise ID in the source. For example, if the account was imported from DingTalk, its source ID is the corpId value of the enterprise in DingTalk.
+   * 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.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
@@ -164,12 +165,15 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   userSourceId?: string;
   /**
    * @remarks
-   * The source type of the account. Valid values:
+   * 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.
    * 
-   * *   build_in: The account was created in IDaaS.
-   * *   ding_talk: The account was imported from DingTalk.
-   * *   ad: The account was imported from Microsoft Active Directory (AD).
-   * *   ldap: The account was imported from a Lightweight Directory Access Protocol (LDAP) service.
+   * - `ldap`: The user is imported from LDAP.
    * 
    * @example
    * build_in
@@ -177,7 +181,7 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
   userSourceType?: string;
   /**
    * @remarks
-   * The username of the account.
+   * The user name.
    * 
    * @example
    * name001
@@ -245,11 +249,25 @@ export class ListUsersResponseBodyUsers extends $dara.Model {
 }
 
 export class ListUsersResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The number of entries returned per page.
+   * 
+   * @example
+   * 20
+   */
   maxResults?: number;
+  /**
+   * @remarks
+   * The token used to retrieve the next page of results.
+   * 
+   * @example
+   * NTxxxxxexample
+   */
   nextToken?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
@@ -257,7 +275,7 @@ export class ListUsersResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The number of entries in the list.
+   * The total number of entries.
    * 
    * @example
    * 100
@@ -265,7 +283,7 @@ export class ListUsersResponseBody extends $dara.Model {
   totalCount?: number;
   /**
    * @remarks
-   * The list of data objects of accounts.
+   * The list of users.
    */
   users?: ListUsersResponseBodyUsers[];
   static names(): { [key: string]: string } {

package/src/models/ObtainApplicationClientSecretRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ObtainApplicationClientSecretRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the application whose client key you want to query.
+   * The application ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class ObtainApplicationClientSecretRequest extends $dara.Model {
   applicationId?: string;
   /**
    * @remarks
-   * The ID of the instance.
+   * The instance ID.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class ObtainApplicationClientSecretRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The client key ID of the application.
+   * The client secret ID of the application.
    * 
    * This parameter is required.
    * 

package/src/models/ObtainApplicationClientSecretResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ObtainApplicationClientSecretResponseBodyApplicationClientSecret extends $dara.Model {
   /**
    * @remarks
-   * The ID of the application whose client key you want to query.
+   * The application ID.
    * 
    * @example
    * app_mkv7rgt4d7i4u7zqtzev2mxxxx
@@ -21,16 +21,23 @@ export class ObtainApplicationClientSecretResponseBodyApplicationClientSecret ex
   clientId?: string;
   /**
    * @remarks
-   * The client key secret of the application.
+   * The client secret of the application.
    * 
    * @example
    * CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx
    */
   clientSecret?: string;
+  /**
+   * @remarks
+   * The expiration time of the client secret. This is a UNIX timestamp. Unit: milliseconds.
+   * 
+   * @example
+   * 1749830226000
+   */
   expirationTime?: number;
   /**
    * @remarks
-   * The ID of the instance.
+   * The instance ID.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
@@ -38,7 +45,7 @@ export class ObtainApplicationClientSecretResponseBodyApplicationClientSecret ex
   instanceId?: string;
   /**
    * @remarks
-   * The time when the client key was last used. The value is a UNIX timestamp. Unit: milliseconds.
+   * The last time the client secret was used. This is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1649830226000
@@ -46,7 +53,7 @@ export class ObtainApplicationClientSecretResponseBodyApplicationClientSecret ex
   lastUsedTime?: number;
   /**
    * @remarks
-   * The client key ID of the application.
+   * The client secret ID of the application.
    * 
    * @example
    * sci_k52x2ru63rlkflina5utgkxxxx
@@ -54,10 +61,11 @@ export class ObtainApplicationClientSecretResponseBodyApplicationClientSecret ex
   secretId?: string;
   /**
    * @remarks
-   * The status of the client key. Valid values:
+   * The status of the client secret. Valid values:
+   * 
+   * - enabled: The secret is enabled.
    * 
-   * *   Enabled: The client key is enabled.
-   * *   Disabled: The client key is disabled.
+   * - disabled: The secret is disabled.
    * 
    * @example
    * enabled
@@ -101,12 +109,12 @@ export class ObtainApplicationClientSecretResponseBodyApplicationClientSecret ex
 export class ObtainApplicationClientSecretResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The information about the client key.
+   * The secret information.
    */
   applicationClientSecret?: ObtainApplicationClientSecretResponseBodyApplicationClientSecret;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A

package/src/models/ObtainApplicationTokenRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ObtainApplicationTokenRequest extends $dara.Model {
   /**
    * @remarks
-   * IDaaS的应用资源ID。
+   * The application ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class ObtainApplicationTokenRequest extends $dara.Model {
   applicationId?: string;
   /**
    * @remarks
-   * IDaaS的应用资源TokenID。
+   * The application token ID.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class ObtainApplicationTokenRequest extends $dara.Model {
   applicationTokenId?: string;
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/ObtainApplicationTokenResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ObtainApplicationTokenResponseBodyApplicationToken extends $dara.Model {
   /**
    * @remarks
-   * IDaaS EIAM 应用Id
+   * The application ID.
    * 
    * @example
    * app_na2r73a65s7o4zbs7nj5gxxxx
@@ -13,7 +13,7 @@ export class ObtainApplicationTokenResponseBodyApplicationToken extends $dara.Mo
   applicationId?: string;
   /**
    * @remarks
-   * 客户端密钥
+   * The application token.
    * 
    * @example
    * SATFwqX8zxGf83pJcJw78KFGjmrft4erWeZYBGS8oE7NN6qoE217yaJpUdMb1UuuGqhDiF43sCA4CF91CTL5iGntqwyLuaAcS9FJ9HfGadE5a7TjiwVafwrBxxxxx
@@ -21,7 +21,7 @@ export class ObtainApplicationTokenResponseBodyApplicationToken extends $dara.Mo
   applicationToken?: string;
   /**
    * @remarks
-   * IDaaS EIAM 客户端ID
+   * The application token ID.
    * 
    * @example
    * token_m7aso6v4efvu2otfq3jdzxxxx
@@ -29,25 +29,31 @@ export class ObtainApplicationTokenResponseBodyApplicationToken extends $dara.Mo
   applicationTokenId?: string;
   /**
    * @remarks
-   * IDaaS EIAM 客户端密钥Id
+   * The type of the application token.
    * 
    * @example
    * bearer_token
    */
   applicationTokenType?: string;
   /**
+   * @remarks
+   * The time when the application token was created.
+   * 
    * @example
    * 1735610930000
    */
   createTime?: number;
   /**
+   * @remarks
+   * The expiration time.
+   * 
    * @example
    * 1735610950000
    */
   expirationTime?: number;
   /**
    * @remarks
-   * IDaaS EIAM 实例Id
+   * The ID of the IDaaS EIAM instance.
    * 
    * @example
    * idaas_ki6hd7ihir4ybawogqk6kqxxxx
@@ -55,7 +61,7 @@ export class ObtainApplicationTokenResponseBodyApplicationToken extends $dara.Mo
   instanceId?: string;
   /**
    * @remarks
-   * IDaaS EIAM 客户端密钥最近使用时间
+   * The time when the token was last used.
    * 
    * @example
    * 1735610930000
@@ -63,7 +69,7 @@ export class ObtainApplicationTokenResponseBodyApplicationToken extends $dara.Mo
   lastUsedTime?: number;
   /**
    * @remarks
-   * IDaaS EIAM 客户端密钥状态
+   * The status.
    * 
    * @example
    * enabled
@@ -107,8 +113,15 @@ export class ObtainApplicationTokenResponseBodyApplicationToken extends $dara.Mo
 }
 
 export class ObtainApplicationTokenResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The application token.
+   */
   applicationToken?: ObtainApplicationTokenResponseBodyApplicationToken;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
    */

package/src/models/ObtainCredentialRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ObtainCredentialRequest extends $dara.Model {
   /**
    * @remarks
-   * 凭据ID。
+   * The credential ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class ObtainCredentialRequest extends $dara.Model {
   credentialId?: string;
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    *