@alicloud/eiam20211201 2.16.0 → 2.16.1

package/src/models/CreateCredentialProviderRequest.ts

@@ -5,12 +5,14 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCredentialProviderRequestCredentialProviderConfigJwtProviderConfig extends $dara.Model {
   /**
    * @remarks
-   * 签发出的JWT中的issuer字段的允许列表。
+   * The list of allowed issuers for JWTs.
+   * 
+   * > The list can contain a maximum of 200 issuers.
    */
   allowedTokenIssuers?: string[];
   /**
    * @remarks
-   * 是否开启JWT派生短令牌能力。
+   * Specifies whether to enable the short-lived token derivation feature for JWTs.
    * 
    * @example
    * false
@@ -18,7 +20,7 @@ export class CreateCredentialProviderRequestCredentialProviderConfigJwtProviderC
   derivedShortTokenEnabled?: boolean;
   /**
    * @remarks
-   * JWT的有效时长，单位秒。
+   * The validity period of the JSON Web Token (JWT). Unit: seconds.
    * 
    * @example
    * 900
@@ -26,7 +28,7 @@ export class CreateCredentialProviderRequestCredentialProviderConfigJwtProviderC
   expiration?: number;
   /**
    * @remarks
-   * 是否开启JWT过期清理。
+   * Specifies whether to enable the cleanup of expired JWTs.
    * 
    * @example
    * true
@@ -65,7 +67,9 @@ export class CreateCredentialProviderRequestCredentialProviderConfigJwtProviderC
 export class CreateCredentialProviderRequestCredentialProviderConfigOAuthProviderConfig extends $dara.Model {
   /**
    * @remarks
-   * OAuth协议中的client_id，客户端ID。
+   * The client ID. This parameter corresponds to the client_id parameter in the OAuth protocol.
+   * 
+   * > The client ID cannot exceed 128 characters in length.
    * 
    * This parameter is required.
    * 
@@ -75,7 +79,9 @@ export class CreateCredentialProviderRequestCredentialProviderConfigOAuthProvide
   clientId?: string;
   /**
    * @remarks
-   * OAuth协议中的client_secret，客户端密钥。
+   * The client key. This parameter corresponds to the client_secret parameter in the OAuth protocol.
+   * 
+   * > The client key cannot exceed 1024 characters in length.
    * 
    * This parameter is required.
    * 
@@ -85,7 +91,25 @@ export class CreateCredentialProviderRequestCredentialProviderConfigOAuthProvide
   clientSecret?: string;
   /**
    * @remarks
-   * OAuth协议中的scope，权限范围。
+   * The scope of permissions. This parameter corresponds to the scope parameter in the OAuth protocol.
+   * 
+   * > The scope that you configure for the OAuth credential provider is used as a fallback value. If you do not specify the scope parameter when you call a DeveloperAPI operation to obtain an OAuth access token, the scope that you configure for the credential provider is used.
+   * 
+   * >Notice: 
+   * 
+   * Separate multiple scopes with spaces.
+   * 
+   * 
+   * 
+   * The following limits apply to a single scope:
+   * 
+   * 1. The scope can contain lowercase letters, digits, and the following special characters: `|/:_-.`
+   * 
+   * 2. The scope must contain lowercase letters or digits.
+   * 
+   * 3. The scope must start with a special character `.`, a lowercase letter, or a digit.
+   * 
+   * 4. The scope cannot exceed 1024 characters in length.
    * 
    * @example
    * example:test_01 example:test_02
@@ -93,7 +117,9 @@ export class CreateCredentialProviderRequestCredentialProviderConfigOAuthProvide
   scope?: string;
   /**
    * @remarks
-   * OAuth协议的Token端点。
+   * The token endpoint. This parameter corresponds to the token endpoint in the OAuth protocol.
+   * 
+   * > The value must start with `http://` or `https://` and cannot exceed 1024 characters in length.
    * 
    * This parameter is required.
    * 
@@ -131,12 +157,12 @@ export class CreateCredentialProviderRequestCredentialProviderConfigOAuthProvide
 export class CreateCredentialProviderRequestCredentialProviderConfig extends $dara.Model {
   /**
    * @remarks
-   * JWT身份提供商配置。
+   * The configuration of the JWT credential provider.
    */
   jwtProviderConfig?: CreateCredentialProviderRequestCredentialProviderConfigJwtProviderConfig;
   /**
    * @remarks
-   * OAuth 2LO机用类型的提供商的配置。
+   * The configuration of the OAuth credential provider.
    */
   OAuthProviderConfig?: CreateCredentialProviderRequestCredentialProviderConfigOAuthProviderConfig;
   static names(): { [key: string]: string } {
@@ -171,7 +197,9 @@ export class CreateCredentialProviderRequestCredentialProviderConfig extends $da
 export class CreateCredentialProviderRequest extends $dara.Model {
   /**
    * @remarks
-   * 保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。
+   * The idempotence token. It is used to ensure the idempotence of the request.
+   * 
+   * Generate a parameter value from your client to make sure that the value is unique among different requests. The ClientToken parameter can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).
    * 
    * This parameter is required.
    * 
@@ -181,12 +209,14 @@ export class CreateCredentialProviderRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * 认证令牌提供商的配置。
+   * The configuration of the credential provider.
    */
   credentialProviderConfig?: CreateCredentialProviderRequestCredentialProviderConfig;
   /**
    * @remarks
-   * 认证令牌提供商的业务标识。是一个具备可读性的唯一标识。
+   * The identifier of the credential provider.
+   * 
+   * > The identifier can contain uppercase letters, lowercase letters, digits, and the following special characters: `.-_`. The identifier cannot exceed 64 characters in length.
    * 
    * This parameter is required.
    * 
@@ -196,7 +226,9 @@ export class CreateCredentialProviderRequest extends $dara.Model {
   credentialProviderIdentifier?: string;
   /**
    * @remarks
-   * 认证令牌提供商名称。
+   * The name of the credential provider.
+   * 
+   * > The name cannot exceed 64 characters in length.
    * 
    * This parameter is required.
    * 
@@ -206,7 +238,11 @@ export class CreateCredentialProviderRequest extends $dara.Model {
   credentialProviderName?: string;
   /**
    * @remarks
-   * 认证令牌提供商的类型。
+   * The type of the credential provider. Valid values:
+   * 
+   * - oauth: OAuth credential provider
+   * 
+   * - jwt: JWT credential provider
    * 
    * This parameter is required.
    * 
@@ -216,7 +252,9 @@ export class CreateCredentialProviderRequest extends $dara.Model {
   credentialProviderType?: string;
   /**
    * @remarks
-   * 描述。
+   * The description.
+   * 
+   * > The description cannot exceed 128 characters in length.
    * 
    * @example
    * This is an example description
@@ -224,7 +262,7 @@ export class CreateCredentialProviderRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/CreateCredentialProviderResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateCredentialProviderResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the credential provider.
+   * 
    * @example
    * atp_01kr2cmj5gxxx4fvmls2e93dxxxxx
    */
   credentialProviderId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
    */

package/src/models/CreateCredentialRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCredentialRequestCredentialContentApiKeyContent extends $dara.Model {
   /**
    * @remarks
-   * API Key 凭证类型的凭据内容。
+   * The API key.
    * 
    * @example
    * nsklnertyt5ddwizncxxxx
@@ -35,7 +35,7 @@ export class CreateCredentialRequestCredentialContentApiKeyContent extends $dara
 export class CreateCredentialRequestCredentialContentOAuthClientContent extends $dara.Model {
   /**
    * @remarks
-   * OAuth协议的client_id。
+   * The `client_id` of the OAuth protocol.
    * 
    * @example
    * dmvncmxersdxxxxxx
@@ -43,7 +43,7 @@ export class CreateCredentialRequestCredentialContentOAuthClientContent extends
   clientId?: string;
   /**
    * @remarks
-   * OAuth协议的client_secret。
+   * The `client_secret` of the OAuth protocol.
    * 
    * @example
    * nsklncmwizncxxxx
@@ -75,12 +75,12 @@ export class CreateCredentialRequestCredentialContentOAuthClientContent extends
 export class CreateCredentialRequestCredentialContent extends $dara.Model {
   /**
    * @remarks
-   * Api Key的内容。
+   * The credential content of the API key type.
    */
   apiKeyContent?: CreateCredentialRequestCredentialContentApiKeyContent;
   /**
    * @remarks
-   * OAuth客户端认证凭证类型的凭据内容。
+   * The credential content of the OAuth client type.
    */
   OAuthClientContent?: CreateCredentialRequestCredentialContentOAuthClientContent;
   static names(): { [key: string]: string } {
@@ -115,7 +115,7 @@ export class CreateCredentialRequestCredentialContent extends $dara.Model {
 export class CreateCredentialRequest extends $dara.Model {
   /**
    * @remarks
-   * 保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。
+   * A client-generated token that ensures the idempotence of the request. This token must be a unique value that contains only ASCII characters and is no more than 64 characters long. For more information, see [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).
    * 
    * This parameter is required.
    * 
@@ -125,7 +125,7 @@ export class CreateCredentialRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * 凭据的内容。
+   * The credential content.
    * 
    * This parameter is required.
    */
@@ -133,7 +133,7 @@ export class CreateCredentialRequest extends $dara.Model {
   credentialExternalId?: string;
   /**
    * @remarks
-   * 凭据标识。
+   * The credential identifier.
    * 
    * This parameter is required.
    * 
@@ -143,7 +143,7 @@ export class CreateCredentialRequest extends $dara.Model {
   credentialIdentifier?: string;
   /**
    * @remarks
-   * 凭据名称。
+   * The credential name.
    * 
    * This parameter is required.
    * 
@@ -153,7 +153,11 @@ export class CreateCredentialRequest extends $dara.Model {
   credentialName?: string;
   /**
    * @remarks
-   * 凭据的使用场景标签。
+   * The use case label of the credential. Valid values:
+   * 
+   * - `llm`: large language model.
+   * 
+   * - `saas`: third-party SaaS.
    * 
    * @example
    * llm
@@ -162,7 +166,7 @@ export class CreateCredentialRequest extends $dara.Model {
   credentialSharingScope?: string;
   /**
    * @remarks
-   * 凭据所属的主体ID。
+   * The ID of the credential\\"s subject.
    * 
    * @example
    * apt_werthgfdsasffxxxxx
@@ -170,7 +174,9 @@ export class CreateCredentialRequest extends $dara.Model {
   credentialSubjectId?: string;
   /**
    * @remarks
-   * 凭据所属的主体类型。
+   * The subject type of the credential. Valid value:
+   * 
+   * - `authentication_token_provider`: an authentication token provider.
    * 
    * @example
    * authentication_token_provider
@@ -178,7 +184,11 @@ export class CreateCredentialRequest extends $dara.Model {
   credentialSubjectType?: string;
   /**
    * @remarks
-   * 凭据类型。
+   * The credential type. Valid values:
+   * 
+   * - `api_key`: an API key.
+   * 
+   * - `oauth_client`: an OAuth client.
    * 
    * This parameter is required.
    * 
@@ -188,7 +198,7 @@ export class CreateCredentialRequest extends $dara.Model {
   credentialType?: string;
   /**
    * @remarks
-   * 描述
+   * The credential description.
    * 
    * @example
    * credential_description
@@ -197,7 +207,7 @@ export class CreateCredentialRequest extends $dara.Model {
   exclusiveUserId?: string;
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/CreateCredentialResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateCredentialResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The credential ID.
+   * 
    * @example
    * cred_mkv7rgt4d7i4u7zqtzev2mxxxx
    */
   credentialId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
    */

package/src/models/CreateCustomFieldRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCustomFieldRequestFieldDataConfigItems extends $dara.Model {
   /**
    * @remarks
-   * 配置项展示名
+   * The display name of the configuration item. The display name can be up to 128 characters in length.
    * 
    * @example
    * string
@@ -13,7 +13,13 @@ export class CreateCustomFieldRequestFieldDataConfigItems extends $dara.Model {
   displayName?: string;
   /**
    * @remarks
-   * 配置项状态，枚举值，enabled、disabled
+   * The status of the configuration item. Valid values:
+   * 
+   * - enabled: The configuration item is enabled.
+   * 
+   * - disabled: The configuration item is disabled.
+   * 
+   * If a configuration item is disabled, it is unavailable when you create or update the field value for an entity.
    * 
    * @example
    * string
@@ -21,7 +27,7 @@ export class CreateCustomFieldRequestFieldDataConfigItems extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * 配置项展示值
+   * The value of the configuration item. The value can be up to 64 characters in length.
    * 
    * @example
    * string
@@ -55,7 +61,7 @@ export class CreateCustomFieldRequestFieldDataConfigItems extends $dara.Model {
 export class CreateCustomFieldRequestFieldDataConfig extends $dara.Model {
   /**
    * @remarks
-   * 字段值配置项，必须与数据类型一致，只能新增数据项，不可删除，项字段：displayName、value、status
+   * A list of field configuration items. The list can contain up to 100 items.
    * 
    * @example
    * string
@@ -88,7 +94,7 @@ export class CreateCustomFieldRequestFieldDataConfig extends $dara.Model {
 export class CreateCustomFieldRequest extends $dara.Model {
   /**
    * @remarks
-   * 字段默认值，必须与数据类型一致
+   * The default value of the field. If the field has configuration items, the default value must be one of the enabled configuration items. The default value can be up to 1024 characters in length.
    * 
    * @example
    * string
@@ -96,15 +102,15 @@ export class CreateCustomFieldRequest extends $dara.Model {
   defaultValue?: string;
   /**
    * @remarks
-   * 对字段的描述信息
+   * The description of the field. The description can be up to 512 characters in length.
    * 
    * @example
-   * 字段测试
+   * Field test
    */
   description?: string;
   /**
    * @remarks
-   * 是否加密，默认false
+   * Indicates whether to encrypt the field value. If you set this parameter to true, the system encrypts the data value before storing it.
    * 
    * @example
    * false
@@ -112,7 +118,9 @@ export class CreateCustomFieldRequest extends $dara.Model {
   encrypted?: boolean;
   /**
    * @remarks
-   * 字段归属实体。实体包括账户、组、组织
+   * The entity to which the field belongs. Valid value:
+   * 
+   * - user: an account.
    * 
    * This parameter is required.
    * 
@@ -122,12 +130,18 @@ export class CreateCustomFieldRequest extends $dara.Model {
   entityType?: string;
   /**
    * @remarks
-   * 字段值配置项，必须与数据类型一致
+   * The configuration items of the field value.
    */
   fieldDataConfig?: CreateCustomFieldRequestFieldDataConfig;
   /**
    * @remarks
-   * 数据类型，枚举值：string、number、boolean
+   * The data type of the field. Valid values:
+   * 
+   * - string: a string.
+   * 
+   * - number: a number. The number can be up to 32 digits in length and can be a positive integer or a decimal.
+   * 
+   * - boolean: a Boolean value.
    * 
    * This parameter is required.
    * 
@@ -137,7 +151,7 @@ export class CreateCustomFieldRequest extends $dara.Model {
   fieldDataType?: string;
   /**
    * @remarks
-   * 字段展示名，长度不超过128字符
+   * The display name of the field. The display name can be up to 64 characters in length.
    * 
    * This parameter is required.
    * 
@@ -147,7 +161,13 @@ export class CreateCustomFieldRequest extends $dara.Model {
   fieldDisplayName?: string;
   /**
    * @remarks
-   * 字段展示类型，枚举值，select、checkbox、input
+   * The display type of the field. Valid values:
+   * 
+   * - input: a text box. This display type supports the string and number data types.
+   * 
+   * - select: a drop-down list. This display type supports the string and Boolean data types.
+   * 
+   * - checkbox: a check box. This display type supports the string data type.
    * 
    * This parameter is required.
    * 
@@ -157,7 +177,7 @@ export class CreateCustomFieldRequest extends $dara.Model {
   fieldDisplayType?: string;
   /**
    * @remarks
-   * 字段标识，英文字母、下划线
+   * The name of the field. The name can be up to 40 characters in length and can contain lowercase letters and underscores (_). It cannot start with an underscore (_).
    * 
    * This parameter is required.
    * 
@@ -167,7 +187,7 @@ export class CreateCustomFieldRequest extends $dara.Model {
   fieldName?: string;
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    * 
@@ -177,7 +197,7 @@ export class CreateCustomFieldRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * 是否必填，默认false
+   * Indicates whether the field is required.
    * 
    * @example
    * false
@@ -185,7 +205,7 @@ export class CreateCustomFieldRequest extends $dara.Model {
   required?: boolean;
   /**
    * @remarks
-   * 是否唯一，默认false
+   * Indicates whether the field value is unique. If you set this parameter to true, the value of this field must be unique for the specified entity type.
    * 
    * @example
    * false
@@ -193,7 +213,13 @@ export class CreateCustomFieldRequest extends $dara.Model {
   unique?: boolean;
   /**
    * @remarks
-   * 用户端(portal侧)权限，hide、read_only、read_write，默认read_only
+   * The permission on the field in the portal. Valid values:
+   * 
+   * - hide: The field is not visible in the portal.
+   * 
+   * - read_only: The field is visible but cannot be modified in the portal.
+   * 
+   * - read_write: The field is visible and can be modified in the portal.
    * 
    * @example
    * false

package/src/models/CreateCustomFieldResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateCustomFieldResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The field ID.
+   * 
    * @example
    * ufd_001
    */
   fieldId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
    */

package/src/models/CreateCustomPrivacyPolicyRequest.ts

@@ -5,15 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCustomPrivacyPolicyRequestCustomPrivacyPolicyContentsCustomPrivacyPolicyItems extends $dara.Model {
   /**
    * @remarks
-   * 自定义条款名称
+   * The name of the custom privacy policy item.
    * 
    * @example
-   * xxxx隐私政策条款
+   * Custom Privacy Policy Name
    */
   customPrivacyPolicyItemName?: string;
   /**
    * @remarks
-   * 自定义条款访问地址
+   * The endpoint of the custom privacy policy item.
    * 
    * @example
    * http://www.xxxx.com
@@ -45,20 +45,20 @@ export class CreateCustomPrivacyPolicyRequestCustomPrivacyPolicyContentsCustomPr
 export class CreateCustomPrivacyPolicyRequestCustomPrivacyPolicyContents extends $dara.Model {
   /**
    * @remarks
-   * 自定义条款项
+   * The items of the custom privacy policy.
    */
   customPrivacyPolicyItems?: CreateCustomPrivacyPolicyRequestCustomPrivacyPolicyContentsCustomPrivacyPolicyItems[];
   /**
    * @remarks
-   * 自定义条款提示
+   * The prompt for the custom privacy policy.
    * 
    * @example
-   * 登录视为同意此条款
+   * Please read and agree：
    */
   customPrivacyPolicyTip?: string;
   /**
    * @remarks
-   * 自定义条款所属语言
+   * The language of the custom privacy policy. The value is the LanguageCode returned by the ListLanguages operation.
    * 
    * @example
    * zh-Hans-CN
@@ -94,18 +94,21 @@ export class CreateCustomPrivacyPolicyRequestCustomPrivacyPolicyContents extends
 
 export class CreateCustomPrivacyPolicyRequest extends $dara.Model {
   /**
+   * @remarks
+   * A client token used to ensure the idempotence of the request. The client generates this value to make sure that it is unique among different requests. The value can be up to 64 ASCII characters in length and cannot contain non-ASCII characters.
+   * 
    * @example
    * client-token-example
    */
   clientToken?: string;
   /**
    * @remarks
-   * 自定义条款内容详情
+   * The details of the custom privacy policy content.
    */
   customPrivacyPolicyContents?: CreateCustomPrivacyPolicyRequestCustomPrivacyPolicyContents[];
   /**
    * @remarks
-   * 自定义条款名称
+   * The name of the custom privacy policy.
    * 
    * This parameter is required.
    * 
@@ -115,7 +118,7 @@ export class CreateCustomPrivacyPolicyRequest extends $dara.Model {
   customPrivacyPolicyName?: string;
   /**
    * @remarks
-   * 默认条款语言，若其他语言未配置条款，则使用默认的
+   * The default language of the privacy policy.
    * 
    * @example
    * zh-Hans-CN
@@ -123,7 +126,7 @@ export class CreateCustomPrivacyPolicyRequest extends $dara.Model {
   defaultLanguageCode?: string;
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    * 
@@ -133,7 +136,7 @@ export class CreateCustomPrivacyPolicyRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * 自定义条款状态
+   * The status of the custom privacy policy.
    * 
    * @example
    * enabled
@@ -141,7 +144,7 @@ export class CreateCustomPrivacyPolicyRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * 手动勾选同意，还是默认同意
+   * The consent type for the privacy policy.
    * 
    * @example
    * implied_consent

package/src/models/CreateCustomPrivacyPolicyResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateCustomPrivacyPolicyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the custom privacy policy.
+   * 
    * @example
    * pp_neagxpoznsjdtxxxxx
    */
   customPrivacyPolicyId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
    */