@alicloud/eiam20211201 2.17.0 → 2.17.1

package/src/models/ListGroupsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListGroupsResponseBodyGroups extends $dara.Model {
   /**
    * @remarks
-   * The time at which the group was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.
+   * Group creation time in Unix timestamp format, in milliseconds.
    * 
    * @example
    * 1652085686179
@@ -13,7 +13,7 @@ export class ListGroupsResponseBodyGroups extends $dara.Model {
   createTime?: number;
   /**
    * @remarks
-   * The description of the group.
+   * Group description.
    * 
    * @example
    * test group
@@ -21,7 +21,7 @@ export class ListGroupsResponseBodyGroups extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The external ID of the group, which can be used to associate the group with an external system. By default, the external ID is the group ID.
+   * Group external ID, used for association with external systems. Defaults to the account group ID.
    * 
    * @example
    * group_d6sbsuumeta4h66ec3il7yxxxx
@@ -29,7 +29,7 @@ export class ListGroupsResponseBodyGroups extends $dara.Model {
   groupExternalId?: string;
   /**
    * @remarks
-   * The group ID.
+   * Group ID.
    * 
    * @example
    * group_d6sbsuumeta4h66ec3il7yxxxx
@@ -37,7 +37,7 @@ export class ListGroupsResponseBodyGroups extends $dara.Model {
   groupId?: string;
   /**
    * @remarks
-   * The name of the group.
+   * Group name.
    * 
    * @example
    * group_name
@@ -45,7 +45,7 @@ export class ListGroupsResponseBodyGroups extends $dara.Model {
   groupName?: string;
   /**
    * @remarks
-   * The source ID of the group. If the group was imported from other services, this value indicates the external source ID. By default, the source ID is the instance ID.
+   * Group source ID. If created by importing from other sources, this is the external source ID. Defaults to the instance ID.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
@@ -53,7 +53,8 @@ export class ListGroupsResponseBodyGroups extends $dara.Model {
   groupSourceId?: string;
   /**
    * @remarks
-   * The source type of the group. Only build_in may be returned, which indicates that the group was created in IDaaS.
+   * Group source type. Currently, only self-built is supported. Valid values:
+   * - build_in: self-built.
    * 
    * @example
    * build_in
@@ -61,7 +62,7 @@ export class ListGroupsResponseBodyGroups extends $dara.Model {
   groupSourceType?: string;
   /**
    * @remarks
-   * The instance ID.
+   * Instance ID.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
@@ -69,7 +70,7 @@ export class ListGroupsResponseBodyGroups extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The time at which the group was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.
+   * Group last update time in Unix timestamp format, in milliseconds.
    * 
    * @example
    * 1652085686179
@@ -115,12 +116,12 @@ export class ListGroupsResponseBodyGroups extends $dara.Model {
 export class ListGroupsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The queried account groups.
+   * Account group list.
    */
   groups?: ListGroupsResponseBodyGroups[];
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
@@ -128,7 +129,7 @@ export class ListGroupsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned. The maximum number of entries returned at a time depends on the value of PageSize.
+   * Total number of matched entries. The maximum number of entries returned in a single request is determined by pageSize.
    * 
    * @example
    * 100

package/src/models/ListIdentityProvidersRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListIdentityProvidersRequest extends $dara.Model {
   /**
    * @remarks
-   * The data synchronization direction of the identity provider.
+   * The direction of the identity provider.
    * 
    * @example
    * pull
@@ -13,7 +13,7 @@ export class ListIdentityProvidersRequest extends $dara.Model {
   direction?: string;
   /**
    * @remarks
-   * The instance ID.
+   * Instance ID.
    * 
    * This parameter is required.
    * 
@@ -23,7 +23,7 @@ export class ListIdentityProvidersRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The page number.
+   * Page number.
    * 
    * @example
    * 1
@@ -31,7 +31,7 @@ export class ListIdentityProvidersRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page.
+   * Page size.
    * 
    * @example
    * 20

package/src/models/ListIdentityProvidersResponseBody.ts

@@ -5,11 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether advanced configuration is enabled. Valid values:
+   * Whether the advanced configuration is enabled. Valid values:
    * 
-   * - disabled: The feature is disabled.
+   * - Disabled: disabled
    * 
-   * - enabled: The feature is enabled.
+   * - Enabled: enabled
    * 
    * @example
    * disabled
@@ -42,7 +42,7 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   authnSourceSupplier?: string;
   /**
    * @remarks
-   * The authentication method type. Valid values:
+   * The authentication source type, OIDC or SAML. Valid values:
    * 
    * - OIDC: urn:alibaba:idaas:authntype:oidc
    * 
@@ -54,11 +54,11 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   authnSourceType?: string;
   /**
    * @remarks
-   * Indicates whether the identity provider supports authentication. Valid values:
+   * Whether the corresponding IdP supports authentication. Valid values:
    * 
-   * - disabled: Authentication is disabled.
+   * - Disabled: disabled
    * 
-   * - enabled: Authentication is enabled.
+   * - Enabled: enabled
    * 
    * @example
    * disabled
@@ -66,7 +66,7 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   authnStatus?: string;
   /**
    * @remarks
-   * The time when the identity provider was created. This is a UNIX timestamp. Unit: milliseconds.
+   * The creation time, in Unix timestamp format, measured in milliseconds.
    * 
    * @example
    * 1712561597000
@@ -74,7 +74,7 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   createTime?: number;
   /**
    * @remarks
-   * The description of the identity provider.
+   * Description of the identity provider.
    * 
    * @example
    * None
@@ -82,7 +82,7 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   description?: string;
   /**
    * @remarks
-   * The external ID of the identity provider.
+   * External ID of the identity provider.
    * 
    * @example
    * test_123
@@ -90,7 +90,7 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   identityProviderExternalId?: string;
   /**
    * @remarks
-   * The identity provider ID.
+   * Identity provider ID.
    * 
    * @example
    * idp_m5b5wd5s2hpq4t6iaehhXXX
@@ -98,7 +98,7 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   identityProviderId?: string;
   /**
    * @remarks
-   * The name of the identity provider.
+   * Name of the identity provider.
    * 
    * @example
    * xxxx
@@ -122,7 +122,7 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
    * 
    * - Standard OIDC: urn:alibaba:idaas:idp:standard:oidc
    * 
-   * - Custom OIDC for SASE: urn:alibaba:idaas:idp:alibaba:sase
+   * - SASE Customized OIDC: urn:alibaba:idaas:idp:alibaba:sase
    * 
    * @example
    * urn:alibaba:idaas:idp:bytedance:lark:pull
@@ -130,11 +130,11 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   identityProviderType?: string;
   /**
    * @remarks
-   * The incremental callback status. This indicates whether to process incremental callback data from the identity provider. Valid values:
+   * The incremental callback status, indicating whether incremental callback data from the IdP is processed. Valid values:
    * 
-   * - disabled: The feature is disabled.
+   * - Disabled: disabled
    * 
-   * - enabled: The feature is enabled.
+   * - Enabled: enabled
    * 
    * @example
    * enabled
@@ -142,7 +142,7 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   incrementalCallbackStatus?: string;
   /**
    * @remarks
-   * The instance ID.
+   * Instance ID.
    * 
    * @example
    * idaas_pbf4dth34l2qb7mydpntXXX
@@ -150,7 +150,7 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   instanceId?: string;
   /**
    * @remarks
-   * The result of the last status check. A sync task can be triggered only when the status check of the identity provider returns \\`success\\`.
+   * The last status check result. Before synchronization, a sync task can only be triggered when the identity provider status check result is success.
    * 
    * @example
    * success
@@ -158,7 +158,7 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   lastStatusCheckJobResult?: string;
   /**
    * @remarks
-   * The reason why the identity provider is locked.
+   * The lock reason.
    * 
    * @example
    * financial
@@ -166,7 +166,7 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   lockReason?: string;
   /**
    * @remarks
-   * The URL of the custom logo for the identity provider.
+   * The custom logo URL of the identity provider.
    * 
    * @example
    * https://cdn-cn-hangzhou.aliyunidaas.com/xx/logos/xx
@@ -174,7 +174,7 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   logoUrl?: string;
   /**
    * @remarks
-   * The periodic check status. This indicates whether to periodically check for data inconsistencies between IDaaS and the identity provider.
+   * The periodic sync status, indicating whether the data differences between EIAM and the identity provider are periodically checked.
    * 
    * @example
    * disabled
@@ -182,11 +182,11 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   periodicSyncStatus?: string;
   /**
    * @remarks
-   * Indicates whether inbound synchronization is enabled. Valid values:
+   * Whether the inbound sync feature is supported. Valid values:
    * 
-   * - disabled: The feature is disabled.
+   * - Disabled: disabled
    * 
-   * - enabled: The feature is enabled.
+   * - Enabled: enabled
    * 
    * @example
    * disabled
@@ -202,11 +202,11 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   udPullTargetScope?: string;
   /**
    * @remarks
-   * Indicates whether outbound synchronization is enabled. Valid values:
+   * Whether the outbound sync feature is enabled. Valid values:
    * 
-   * - disabled: The feature is disabled.
+   * - Disabled: disabled
    * 
-   * - enabled: The feature is enabled.
+   * - Enabled: enabled
    * 
    * @example
    * disabled
@@ -214,7 +214,7 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
   udPushStatus?: string;
   /**
    * @remarks
-   * The time when the identity provider was last updated. This is a UNIX timestamp. Unit: milliseconds.
+   * The update time, in Unix timestamp format, measured in milliseconds.
    * 
    * @example
    * 1712561597000
@@ -282,12 +282,12 @@ export class ListIdentityProvidersResponseBodyIdentityProviders extends $dara.Mo
 export class ListIdentityProvidersResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The list of identity providers.
+   * List of identity provider information.
    */
   identityProviders?: ListIdentityProvidersResponseBodyIdentityProviders[];
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
@@ -295,7 +295,7 @@ export class ListIdentityProvidersResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries.
+   * Total number of entries.
    * 
    * @example
    * 100

package/src/models/ListInstancesRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListInstancesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The cross-region replication status.
+   * 
    * @example
    * disabled
    */
@@ -13,7 +16,7 @@ export class ListInstancesRequest extends $dara.Model {
    * The license edition. Valid values:
    * - free: Free Edition.
    * - trial: Trial Edition.
-   * - scalability: Capability Expansion Edition.
+   * - scalability: Scalability Edition.
    * - standard: Standard Edition.
    * - enterprise: Enterprise Edition.
    * 

package/src/models/ListInstancesResponseBody.ts

@@ -13,9 +13,9 @@ export class ListInstancesResponseBodyInstancesDefaultEndpoint extends $dara.Mod
   endpoint?: string;
   /**
    * @remarks
-   * The status of the instance endpoint. Valid values:
+   * The endpoint status. Valid values:
    * - resolved: Resolved.
-   * - unresolved: Unresolved.
+   * - unresolved: Not resolved.
    * 
    * @example
    * resolved
@@ -46,26 +46,41 @@ export class ListInstancesResponseBodyInstancesDefaultEndpoint extends $dara.Mod
 
 export class ListInstancesResponseBodyInstancesReplicationConfiguration extends $dara.Model {
   /**
+   * @remarks
+   * The instance ID of the backup instance.
+   * 
    * @example
    * idaas_xxxxxx
    */
   backupInstanceId?: string;
   /**
+   * @remarks
+   * The region ID of the backup instance.
+   * 
    * @example
    * cn-beijing
    */
   backupInstanceRegionId?: string;
   /**
+   * @remarks
+   * The instance ID of the primary instance.
+   * 
    * @example
    * idaas_xxxxxx
    */
   primaryInstanceId?: string;
   /**
+   * @remarks
+   * The region ID of the primary instance.
+   * 
    * @example
    * cn-hangzhou
    */
   primaryInstanceRegionId?: string;
   /**
+   * @remarks
+   * The time when the disaster recovery data replication was created, in UNIX timestamp format. Unit: milliseconds.
+   * 
    * @example
    * 1778499337000
    */
@@ -102,18 +117,24 @@ export class ListInstancesResponseBodyInstancesReplicationConfiguration extends
 export class ListInstancesResponseBodyInstances extends $dara.Model {
   /**
    * @remarks
-   * The time when the instance was created. The value is a UNIX timestamp in milliseconds.
+   * The instance creation time, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1550115455000
    */
   createTime?: number;
   /**
+   * @remarks
+   * Indicates whether cross-region replication is enabled. Valid values: enabled or disabled.
+   * 
    * @example
    * enabled
    */
   crossRegionReplication?: string;
   /**
+   * @remarks
+   * The cross-region replication role. Valid values: primary (primary instance) or backup (backup instance).
+   * 
    * @example
    * primary
    */
@@ -125,13 +146,16 @@ export class ListInstancesResponseBodyInstances extends $dara.Model {
   defaultEndpoint?: ListInstancesResponseBodyInstancesDefaultEndpoint;
   /**
    * @remarks
-   * The description of the instance.
+   * The instance description.
    * 
    * @example
    * instance_for_test
    */
   description?: string;
   /**
+   * @remarks
+   * The instance failover activation status. Valid values: active (activated) or inactive (not activated).
+   * 
    * @example
    * inactive
    */
@@ -152,6 +176,10 @@ export class ListInstancesResponseBodyInstances extends $dara.Model {
    * sase
    */
   managedServiceCode?: string;
+  /**
+   * @remarks
+   * The replication configuration. This parameter is returned only when CrossRegionReplication is set to enabled.
+   */
   replicationConfiguration?: ListInstancesResponseBodyInstancesReplicationConfiguration;
   /**
    * @remarks
@@ -234,7 +262,7 @@ export class ListInstancesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries in the list.
+   * The total number of entries returned.
    * 
    * @example
    * 100

package/src/models/ListOrganizationalUnitParentsRequest.ts

@@ -15,7 +15,7 @@ export class ListOrganizationalUnitParentsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The organizational unit ID.
+   * The organization ID.
    * 
    * This parameter is required.
    * 

package/src/models/ListOrganizationalUnitParentsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListOrganizationalUnitParentsResponseBodyParents extends $dara.Model {
   /**
    * @remarks
-   * The organizational unit ID.
+   * The organization ID.
    * 
    * @example
    * ou_4lag76zc2km5ssg5vsmm2lznvu
@@ -13,7 +13,7 @@ export class ListOrganizationalUnitParentsResponseBodyParents extends $dara.Mode
   organizationalUnitId?: string;
   /**
    * @remarks
-   * The parent organizational unit ID.
+   * The parent organization ID.
    * 
    * @example
    * ou_x3beoyepv2ls5iwuge3xhjkwbm
@@ -45,7 +45,7 @@ export class ListOrganizationalUnitParentsResponseBodyParents extends $dara.Mode
 export class ListOrganizationalUnitParentsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The list of parent organizational units.
+   * The list of parent organizations.
    */
   parents?: ListOrganizationalUnitParentsResponseBodyParents[];
   /**

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