@alicloud/eiam20211201 2.17.0 → 2.17.1

package/src/models/CreateIdentityProviderResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateIdentityProviderResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the identity provider.
+   * Identity provider ID.
    * 
    * @example
    * idp_mwpcwnhrimlr2horxXXXX
@@ -13,7 +13,7 @@ export class CreateIdentityProviderResponseBody extends $dara.Model {
   identityProviderId?: string;
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A

package/src/models/CreateOrganizationalUnitRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateOrganizationalUnitRequest extends $dara.Model {
   /**
    * @remarks
-   * The description of the organization. The value can be up to 256 characters in length.
+   * The description. The maximum length is 256 characters.
    * 
    * @example
    * description
@@ -13,7 +13,7 @@ export class CreateOrganizationalUnitRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The instance ID.
+   * Instance ID.
    * 
    * This parameter is required.
    * 
@@ -23,7 +23,7 @@ export class CreateOrganizationalUnitRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The external ID of the organization, which can be used to associate the organization with an external system. By default, the external ID is the organization ID. The value can be up to 64 characters in length.
+   * External ID of the organization, which is used for association with an external system. The default value is the organization ID. The maximum length is 64 characters.
    * 
    * @example
    * ou_wovwffm62xifdziem7an7xxxxx
@@ -31,7 +31,7 @@ export class CreateOrganizationalUnitRequest extends $dara.Model {
   organizationalUnitExternalId?: string;
   /**
    * @remarks
-   * The name of the organization. The name can be up to 64 characters in length.
+   * Organization name. The maximum length is 64 characters.
    * 
    * This parameter is required.
    * 
@@ -41,7 +41,7 @@ export class CreateOrganizationalUnitRequest extends $dara.Model {
   organizationalUnitName?: string;
   /**
    * @remarks
-   * The parent organization ID.
+   * Parent organization ID.
    * 
    * This parameter is required.
    * 

package/src/models/CreateOrganizationalUnitResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateOrganizationalUnitResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The organization ID.
+   * Organization ID.
    * 
    * @example
    * ou_wovwffm62xifdziem7an7xxxxx
@@ -13,7 +13,7 @@ export class CreateOrganizationalUnitResponseBody extends $dara.Model {
   organizationalUnitId?: string;
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A

package/src/models/CreateUserRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateUserRequestCustomFields extends $dara.Model {
   /**
    * @remarks
-   * The identifier of the custom field. You must create this field in the console before you can use it in a request. For more information, see the Custom Fields module in the console.
+   * The identifier of the custom field. Create the custom field in advance. For more information, refer to the custom fields module in the console.
    * 
    * @example
    * age
@@ -13,7 +13,7 @@ export class CreateUserRequestCustomFields extends $dara.Model {
   fieldName?: string;
   /**
    * @remarks
-   * The value of the custom field. This value must comply with the constraints defined for the corresponding custom field.
+   * The value of the custom field. The value must comply with the attribute constraints of the corresponding custom field.
    * 
    * @example
    * 10
@@ -45,11 +45,9 @@ export class CreateUserRequestCustomFields extends $dara.Model {
 export class CreateUserRequestPasswordInitializationConfig extends $dara.Model {
   /**
    * @remarks
-   * The status of forced password update. This setting is disabled by default. Valid values:
-   * 
-   * - `enabled`: Enables forced password updates.
-   * 
-   * - `disabled`: Disables forced password updates.
+   * The forced password change status. By default, this feature is not enabled. Valid values:
+   * - enabled: Enabled.
+   * - disabled: Disabled.
    * 
    * @example
    * enabled
@@ -57,11 +55,9 @@ export class CreateUserRequestPasswordInitializationConfig extends $dara.Model {
   passwordForcedUpdateStatus?: string;
   /**
    * @remarks
-   * The priority of the password initialization policy. This setting is disabled by default. Valid values:
-   * 
-   * - `global`: The service uses the instance-level password initialization policy and ignores the policy specified in this request. For more information, see the password initialization policy settings.
-   * 
-   * - `custom`: The service uses the password initialization policy defined in this request. This includes the forced password update setting, the password initialization method, and the notification channels.
+   * The priority of the password initialization policy. By default, this parameter does not take effect. Valid values:
+   * - global: The global policy policy priority. The instance-level password initialization policy is used, and the password initialization policy specified in this request does not take effect. For more information, refer to the password initialization policy in password-related policies.
+   * - custom: The custom policy policy priority. The password initialization policy defined in this request is used, including whether to enable forced password change, the password initialization method, and the notification channel.
    * 
    * @example
    * global
@@ -69,9 +65,8 @@ export class CreateUserRequestPasswordInitializationConfig extends $dara.Model {
   passwordInitializationPolicyPriority?: string;
   /**
    * @remarks
-   * The password initialization type. Valid values:
-   * 
-   * - `random`: The system generates a random password.
+   * The password initialization method. Valid values:
+   * - random: random.
    * 
    * @example
    * random
@@ -118,7 +113,7 @@ export class CreateUserRequestPasswordInitializationConfig extends $dara.Model {
 export class CreateUserRequest extends $dara.Model {
   /**
    * @remarks
-   * A client-provided token to ensure the idempotence of the request. This value must be unique for each request. The token can contain only ASCII characters and must be no more than 64 characters long. For more information, see [How to ensure idempotence](~~~/doc-en/6a938a5b-2402-4c9d-b235-3733a1f813c9.dita).
+   * The client token that is used to ensure the idempotence of the request. You can use the client to generate a parameter value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References: How to ensure idempotence.
    * 
    * @example
    * client-token-example
@@ -134,7 +129,7 @@ export class CreateUserRequest extends $dara.Model {
   customFields?: CreateUserRequestCustomFields[];
   /**
    * @remarks
-   * The description. The maximum length is 256 characters.
+   * The description. The description can be up to 256 characters in length.
    * 
    * @example
    * description text
@@ -142,7 +137,7 @@ export class CreateUserRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The display name. The maximum length is 128 characters.
+   * The display name of the account. The display name can be up to 128 characters in length.
    * 
    * @example
    * name_001
@@ -150,7 +145,7 @@ export class CreateUserRequest extends $dara.Model {
   displayName?: string;
   /**
    * @remarks
-   * The email address. The local part of the address can contain uppercase letters, lowercase letters, digits, periods (.), underscores (_), or hyphens (-). The maximum length is 128 characters.
+   * The email address. The email prefix can contain uppercase letters, lowercase letters, digits, periods (.), underscores (_), and hyphens (-). The email address can be up to 128 characters in length.
    * 
    * @example
    * example@example.com
@@ -158,7 +153,7 @@ export class CreateUserRequest extends $dara.Model {
   email?: string;
   /**
    * @remarks
-   * Indicates whether the email address is verified. A verified address is considered trusted. This parameter is required if you specify the `Email` parameter. For typical use, set this to `true`.
+   * Specifies whether the email address is verified as a trusted email address. This parameter is required if Email is specified. If no special business requirement exists, set this parameter to true.
    * 
    * @example
    * true
@@ -166,7 +161,7 @@ export class CreateUserRequest extends $dara.Model {
   emailVerified?: boolean;
   /**
    * @remarks
-   * The ID of the instance.
+   * The instance ID.
    * 
    * This parameter is required.
    * 
@@ -176,12 +171,12 @@ export class CreateUserRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * A list of subordinate organizational unit IDs. A user can belong to multiple organizational units.
+   * The list of organizational unit IDs to which the account belongs. An account can belong to multiple organizational units.
    */
   organizationalUnitIds?: string[];
   /**
    * @remarks
-   * The password. The format must comply with the password policy.
+   * The password. The password must meet the requirements of the password policy.
    * 
    * @example
    * 123456
@@ -189,12 +184,12 @@ export class CreateUserRequest extends $dara.Model {
   password?: string;
   /**
    * @remarks
-   * The settings for the password initialization policy.
+   * The password initialization configuration.
    */
   passwordInitializationConfig?: CreateUserRequestPasswordInitializationConfig;
   /**
    * @remarks
-   * The phone number. It must be 6 to 15 digits long.
+   * The phone number. The value is a 6 to 15-digit number.
    * 
    * @example
    * 12345678901
@@ -202,7 +197,7 @@ export class CreateUserRequest extends $dara.Model {
   phoneNumber?: string;
   /**
    * @remarks
-   * Indicates whether the phone number is verified. A verified number is considered trusted. This parameter is required if you specify the `PhoneNumber` parameter. For typical use, set this to `true`.
+   * Specifies whether the phone number is verified as a trusted phone number. This parameter is required if PhoneNumber is specified. If no special business requirement exists, set this parameter to true.
    * 
    * @example
    * true
@@ -210,7 +205,7 @@ export class CreateUserRequest extends $dara.Model {
   phoneNumberVerified?: boolean;
   /**
    * @remarks
-   * The country code. It must contain 1 to 6 digits and must not include the plus sign (+).
+   * The phone region code. The value is a 1 to 6-digit number and does not include a plus sign (+).
    * 
    * @example
    * 86
@@ -228,7 +223,7 @@ export class CreateUserRequest extends $dara.Model {
   primaryOrganizationalUnitId?: string;
   /**
    * @remarks
-   * The external ID for associating the user with an external system. The maximum length is 128 characters. If this parameter is not specified, its value defaults to the system-generated user ID.
+   * The external ID of the account. This parameter is used to associate the account with an external system. The value can be up to 128 characters in length. If this parameter is not specified, the account ID is used by default.
    * 
    * @example
    * user_d6sbsuumeta4h66ec3il7yxxxx
@@ -236,7 +231,7 @@ export class CreateUserRequest extends $dara.Model {
   userExternalId?: string;
   /**
    * @remarks
-   * The username. It can contain letters, digits, and the following special characters: underscores (_), periods (.), at signs (@), and hyphens (-). The maximum length is 256 characters.
+   * The username. The username can contain letters, digits, underscores (_), periods (.), at signs (@), and hyphens (-). The username can be up to 256 characters in length.
    * 
    * This parameter is required.
    * 

package/src/models/CreateUserResponseBody.ts

@@ -13,7 +13,7 @@ export class CreateUserResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The user ID.
+   * The account ID.
    * 
    * @example
    * user_d6sbsuumeta4h66ec3il7yxxxx

package/src/models/DeleteGroupRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteGroupRequest extends $dara.Model {
   /**
    * @remarks
-   * The group ID.
+   * Group ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class DeleteGroupRequest extends $dara.Model {
   groupId?: string;
   /**
    * @remarks
-   * The instance ID.
+   * Instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteGroupResponseBody.ts

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

package/src/models/DeleteIdentityProviderRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteIdentityProviderRequest extends $dara.Model {
   /**
    * @remarks
-   * Identity provider ID.
+   * The identity provider ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class DeleteIdentityProviderRequest extends $dara.Model {
   identityProviderId?: string;
   /**
    * @remarks
-   * The ID of the instance.
+   * The instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteOrganizationalUnitChildrenRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteOrganizationalUnitChildrenRequest extends $dara.Model {
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class DeleteOrganizationalUnitChildrenRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * Organizational Unit ID.
+   * The organization ID.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteOrganizationalUnitChildrenResponseBody.ts

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

package/src/models/DeleteOrganizationalUnitRequest.ts

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

package/src/models/DisableIdentityProviderUdPullRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DisableIdentityProviderUdPullRequest extends $dara.Model {
   /**
    * @remarks
-   * Identity provider ID.
+   * The identity provider ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class DisableIdentityProviderUdPullRequest extends $dara.Model {
   identityProviderId?: string;
   /**
    * @remarks
-   * The ID of the instance.
+   * The instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/DisableIdentityProviderUdPullResponseBody.ts

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

package/src/models/DisableUserRequest.ts

@@ -15,7 +15,7 @@ export class DisableUserRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The ID of the account.
+   * The account ID.
    * 
    * This parameter is required.
    * 

package/src/models/EnableIdentityProviderAuthnRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class EnableIdentityProviderAuthnRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the identity provider (IdP).
+   * The identity provider ID.
    * 
    * This parameter is required.
    * 

package/src/models/EnableIdentityProviderUdPullRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class EnableIdentityProviderUdPullRequest extends $dara.Model {
   /**
    * @remarks
-   * Identity provider ID.
+   * The identity provider ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class EnableIdentityProviderUdPullRequest extends $dara.Model {
   identityProviderId?: string;
   /**
    * @remarks
-   * The ID of the instance.
+   * The instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/EnableIdentityProviderUdPullResponseBody.ts

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

package/src/models/GetAuthorizationServerRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetAuthorizationServerRequest extends $dara.Model {
   /**
    * @remarks
-   * IDaaS的授权服务器资源ID。
+   * The authorization server ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetAuthorizationServerRequest extends $dara.Model {
   authorizationServerId?: string;
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/GetAuthorizationServerResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAuthorizationServerResponseBodyAuthorizationServerProtocolEndpoint extends $dara.Model {
   /**
+   * @remarks
+   * The token endpoint of the authorization server.
+   * 
    * @example
    * https://xxxx.aliyunidaas.com/api/v2/iauths_system/oauth2/token
    */
   oauth2TokenEndpoint?: string;
   /**
+   * @remarks
+   * The JWKS endpoint of the authorization server.
+   * 
    * @example
    * https://xxxx.aliyunidaas.com/api/v2/iauths_system/oauth2/jwks
    */
@@ -39,7 +45,7 @@ export class GetAuthorizationServerResponseBodyAuthorizationServerProtocolEndpoi
 export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara.Model {
   /**
    * @remarks
-   * IDaaS EIAM 授权服务器ID
+   * The authorization server ID.
    * 
    * @example
    * iauths_system
@@ -47,7 +53,7 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
   authorizationServerId?: string;
   /**
    * @remarks
-   * IDaaS EIAM 授权服务器名称
+   * The name of the authorization server.
    * 
    * @example
    * System_Default
@@ -55,7 +61,7 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
   authorizationServerName?: string;
   /**
    * @remarks
-   * IDaaS EIAM 授权服务器创建时间
+   * The time when the authorization server was created.
    * 
    * @example
    * 1754620108295
@@ -63,7 +69,7 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
   createTime?: number;
   /**
    * @remarks
-   * 创建类型：system_init-系统默认创建，jwt_credential_provider-JWT凭据提供商创建，user_custom-用户创建
+   * The creation type.
    * 
    * @example
    * system_init
@@ -71,7 +77,7 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
   creationType?: string;
   /**
    * @remarks
-   * 授权服务器描述
+   * The description of the authorization server.
    * 
    * @example
    * description of authorization server
@@ -79,7 +85,7 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
   description?: string;
   /**
    * @remarks
-   * IDaaS EIAM 实例Id
+   * The instance ID.
    * 
    * @example
    * idaas_qzljgbhtwnnsywtdbz7yzy2any
@@ -87,7 +93,7 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
   instanceId?: string;
   /**
    * @remarks
-   * IDaaS EIAM 授权token颁发者
+   * The issuer of the authorization token.
    * 
    * @example
    * https://xxxx.aliyunidaas.com/api/v2/iauths_system/oauth2
@@ -95,7 +101,7 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
   issuer?: string;
   /**
    * @remarks
-   * Issuer使用的域名，可为初始化域名或已添加的自定义域名
+   * The domain name used by the issuer.
    * 
    * @example
    * xxxx.aliyunidaas.com
@@ -103,7 +109,7 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
   issuerDomain?: string;
   /**
    * @remarks
-   * Issuer模式：dynamic-动态基于请求域名，static-使用固定域名
+   * The issuer mode.
    * 
    * @example
    * static
@@ -111,16 +117,20 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
   issuerMode?: string;
   /**
    * @remarks
-   * IDaaS EIAM 授权服务器最近更新时间
+   * The time when the authorization server was last updated.
    * 
    * @example
    * 1781608572164
    */
   lastUpdateTime?: number;
+  /**
+   * @remarks
+   * The endpoint configuration of the authorization server.
+   */
   protocolEndpoint?: GetAuthorizationServerResponseBodyAuthorizationServerProtocolEndpoint;
   /**
    * @remarks
-   * IDaaS EIAM 授权服务器状态，enabled启用，disabled禁用
+   * The status of the authorization server.
    * 
    * @example
    * ENABLE
@@ -173,8 +183,15 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
 }
 
 export class GetAuthorizationServerResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The authorization server.
+   */
   authorizationServer?: GetAuthorizationServerResponseBodyAuthorizationServer;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
    */

package/src/models/GetCloudAccountRequest.ts

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