@alicloud/eiam20211201 2.16.0 → 2.16.1

package/src/models/GetCredentialProviderRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetCredentialProviderRequest extends $dara.Model {
   /**
    * @remarks
-   * 认证令牌提供商ID。
+   * Credential provider ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetCredentialProviderRequest extends $dara.Model {
   credentialProviderId?: string;
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * Instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/GetCredentialProviderResponseBody.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class GetCredentialProviderResponseBodyCredentialProviderCredentialProviderConfigJwtProviderConfig extends $dara.Model {
   /**
    * @remarks
-   * 签发出的JWT中的issuer字段的允许列表。
+   * List of allowed JWT issuers.
    */
   allowedTokenIssuers?: string[];
   /**
    * @remarks
-   * 是否开启JWT派生短令牌能力。
+   * Enable JWT derived short token.
    * 
    * @example
    * false
@@ -18,7 +18,7 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
   derivedShortTokenEnabled?: boolean;
   /**
    * @remarks
-   * JWT的有效时长，单位秒。
+   * Validity period of the JWT. Unit: seconds.
    * 
    * @example
    * 900
@@ -26,7 +26,7 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
   expiration?: number;
   /**
    * @remarks
-   * 是否开启JWT过期清理。
+   * Enable JWT expiration cleanup.
    * 
    * @example
    * true
@@ -34,7 +34,7 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
   expirationCleanupEnabled?: boolean;
   /**
    * @remarks
-   * JWT issuer。
+   * JWT issuer.
    * 
    * @example
    * https://test.issuer.com
@@ -42,7 +42,7 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
   issuer?: string;
   /**
    * @remarks
-   * JWKs端点地址。
+   * JWKs endpoint URL.
    * 
    * @example
    * https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks
@@ -85,7 +85,7 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
 export class GetCredentialProviderResponseBodyCredentialProviderCredentialProviderConfigOAuthProviderConfig extends $dara.Model {
   /**
    * @remarks
-   * OAuth协议中的client_id，客户端ID。
+   * Client ID, corresponding to client_id in the OAuth protocol.
    * 
    * @example
    * client_id_example_xxx
@@ -93,7 +93,13 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
   clientId?: string;
   /**
    * @remarks
-   * OAuth协议中的scope，权限范围。
+   * Scope, corresponding to scope in the OAuth protocol.
+   * 
+   * > The Scope value configured for the OAuth credential provider serves as the default. If you do not specify the scope parameter when calling the Developer API to obtain an OAuth access token, the system uses this default Scope value.
+   * 
+   * >Notice: 
+   * 
+   * Separate multiple Scope values with spaces.
    * 
    * @example
    * example:test_01 example:test_02
@@ -101,7 +107,7 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
   scope?: string;
   /**
    * @remarks
-   * OAuth协议的Token端点。
+   * Token endpoint, corresponding to the OAuth protocol.
    * 
    * @example
    * https://example.com/token
@@ -135,17 +141,19 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
 export class GetCredentialProviderResponseBodyCredentialProviderCredentialProviderConfig extends $dara.Model {
   /**
    * @remarks
-   * JWT身份提供商配置。
+   * Configuration for a JWT credential provider.
    */
   jwtProviderConfig?: GetCredentialProviderResponseBodyCredentialProviderCredentialProviderConfigJwtProviderConfig;
   /**
    * @remarks
-   * OAuth 2LO机用类型的提供商的配置。
+   * Configuration for an OAuth credential provider.
    */
   OAuthProviderConfig?: GetCredentialProviderResponseBodyCredentialProviderCredentialProviderConfigOAuthProviderConfig;
   /**
    * @remarks
-   * 认证令牌提供商的敏感配置对应的凭据ID列表。
+   * List of credential IDs for sensitive configurations of the credential provider.
+   * 
+   * > The system securely stores sensitive configuration information as credentials.
    */
   providerCredentialIds?: string[];
   static names(): { [key: string]: string } {
@@ -185,7 +193,7 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
 export class GetCredentialProviderResponseBodyCredentialProvider extends $dara.Model {
   /**
    * @remarks
-   * 认证令牌提供商的创建时间，Unix时间戳。
+   * Creation time of the credential provider, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1649830225000
@@ -193,12 +201,16 @@ export class GetCredentialProviderResponseBodyCredentialProvider extends $dara.M
   createTime?: number;
   /**
    * @remarks
-   * 认证令牌提供商的配置。
+   * Credential provider configuration.
    */
   credentialProviderConfig?: GetCredentialProviderResponseBodyCredentialProviderCredentialProviderConfig;
   /**
    * @remarks
-   * 认证令牌提供商的创建类型。
+   * Credential provider creation type. Valid values:
+   * 
+   * - system_init: Created by the system
+   * 
+   * - user_custom: Created by a user
    * 
    * @example
    * user_custom
@@ -206,7 +218,7 @@ export class GetCredentialProviderResponseBodyCredentialProvider extends $dara.M
   credentialProviderCreationType?: string;
   /**
    * @remarks
-   * 认证令牌提供商ID。
+   * Credential provider ID.
    * 
    * @example
    * atp_01kr2cmj5gxxx4fvmls2e93dxxxxx
@@ -214,7 +226,7 @@ export class GetCredentialProviderResponseBodyCredentialProvider extends $dara.M
   credentialProviderId?: string;
   /**
    * @remarks
-   * 认证令牌提供商的业务标识。
+   * Credential provider identifier.
    * 
    * @example
    * test_example_identifier
@@ -222,7 +234,7 @@ export class GetCredentialProviderResponseBodyCredentialProvider extends $dara.M
   credentialProviderIdentifier?: string;
   /**
    * @remarks
-   * 认证令牌提供商名称。
+   * Credential provider name.
    * 
    * @example
    * test_example_name
@@ -230,7 +242,11 @@ export class GetCredentialProviderResponseBodyCredentialProvider extends $dara.M
   credentialProviderName?: string;
   /**
    * @remarks
-   * 认证令牌提供商的类型。
+   * Credential provider type. Valid values:
+   * 
+   * - oauth: OAuth credential provider
+   * 
+   * - jwt: JWT credential provider
    * 
    * @example
    * oauth
@@ -238,7 +254,7 @@ export class GetCredentialProviderResponseBodyCredentialProvider extends $dara.M
   credentialProviderType?: string;
   /**
    * @remarks
-   * 描述。
+   * Description.
    * 
    * @example
    * This is an example description
@@ -246,7 +262,7 @@ export class GetCredentialProviderResponseBodyCredentialProvider extends $dara.M
   description?: string;
   /**
    * @remarks
-   * EIAM实例ID。
+   * Instance ID.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
@@ -254,7 +270,11 @@ export class GetCredentialProviderResponseBodyCredentialProvider extends $dara.M
   instanceId?: string;
   /**
    * @remarks
-   * 认证令牌提供商的状态。
+   * Credential provider status. Valid values:
+   * 
+   * - enabled: Enabled
+   * 
+   * - disabled: Disabled
    * 
    * @example
    * enabled
@@ -262,7 +282,7 @@ export class GetCredentialProviderResponseBodyCredentialProvider extends $dara.M
   status?: string;
   /**
    * @remarks
-   * 认证令牌提供商的更新时间，Unix时间戳。
+   * Update time of the credential provider, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1649830225000
@@ -313,8 +333,15 @@ export class GetCredentialProviderResponseBodyCredentialProvider extends $dara.M
 }
 
 export class GetCredentialProviderResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Credential provider.
+   */
   credentialProvider?: GetCredentialProviderResponseBodyCredentialProvider;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
    */

package/src/models/GetCredentialRequest.ts

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

package/src/models/GetCredentialResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetCredentialResponseBodyCredentialCredentialContentOAuthClientContent extends $dara.Model {
   /**
    * @remarks
-   * OAuth协议的client_id
+   * The OAuth client ID.
    * 
    * @example
    * dmvncmxersdxxxxxx
@@ -35,7 +35,7 @@ export class GetCredentialResponseBodyCredentialCredentialContentOAuthClientCont
 export class GetCredentialResponseBodyCredentialCredentialContent extends $dara.Model {
   /**
    * @remarks
-   * OAuth客户端认证凭证类型的凭据内容。
+   * The credential content for an OAuth client. This parameter is returned only when `CredentialType` is `oauth_client`.
    */
   OAuthClientContent?: GetCredentialResponseBodyCredentialCredentialContentOAuthClientContent;
   static names(): { [key: string]: string } {
@@ -65,7 +65,7 @@ export class GetCredentialResponseBodyCredentialCredentialContent extends $dara.
 export class GetCredentialResponseBodyCredential extends $dara.Model {
   /**
    * @remarks
-   * 云角色创建时间
+   * The creation time of the credential, in Unix timestamp format (milliseconds).
    * 
    * @example
    * 1649830225000
@@ -73,12 +73,16 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
   createTime?: number;
   /**
    * @remarks
-   * 凭据的内容。
+   * The content of the credential.
    */
   credentialContent?: GetCredentialResponseBodyCredentialCredentialContent;
   /**
    * @remarks
-   * 凭据的创建类型。
+   * How the credential was created. Valid values:
+   * 
+   * - `system_init`: The credential was created by the system.
+   * 
+   * - `user_custom`: The credential was created by a user.
    * 
    * @example
    * user_custom
@@ -87,7 +91,7 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
   credentialExternalId?: string;
   /**
    * @remarks
-   * 凭据ID。
+   * The ID of the credential.
    * 
    * @example
    * cred_mkv7rgt4d7i4u7zqtzev2mxxxx
@@ -95,7 +99,7 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
   credentialId?: string;
   /**
    * @remarks
-   * 凭据标识
+   * The identifier of the credential.
    * 
    * @example
    * credential_identifier_test
@@ -103,7 +107,7 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
   credentialIdentifier?: string;
   /**
    * @remarks
-   * 凭据名称
+   * The name of the credential.
    * 
    * @example
    * credential_name
@@ -111,7 +115,11 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
   credentialName?: string;
   /**
    * @remarks
-   * 凭据的使用场景标签。
+   * The use case of the credential. Valid values:
+   * 
+   * - `llm`: a large language model (LLM).
+   * 
+   * - `saas`: a third-party Software as a Service (SaaS) application.
    * 
    * @example
    * llm
@@ -120,7 +128,7 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
   credentialSharingScope?: string;
   /**
    * @remarks
-   * 凭据所属的主体ID。
+   * The ID of the subject that owns the credential.
    * 
    * @example
    * apt_werthgfdsasffxxxxx
@@ -128,7 +136,9 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
   credentialSubjectId?: string;
   /**
    * @remarks
-   * 凭据所属的主体类型。
+   * The type of the subject that owns the credential. Valid value:
+   * 
+   * - `authentication_token_provider`: The subject is an authentication token provider.
    * 
    * @example
    * authentication_token_provider
@@ -136,7 +146,11 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
   credentialSubjectType?: string;
   /**
    * @remarks
-   * 凭据类型。
+   * The type of the credential. Valid values:
+   * 
+   * - `api_key`: An API key.
+   * 
+   * - `oauth_client`: An OAuth client.
    * 
    * @example
    * api_key
@@ -144,7 +158,7 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
   credentialType?: string;
   /**
    * @remarks
-   * 描述
+   * The user-defined description of the credential.
    * 
    * @example
    * credential_description
@@ -153,7 +167,7 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
   exclusiveUserId?: string;
   /**
    * @remarks
-   * EIAM实例ID。
+   * The ID of the instance.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
@@ -161,7 +175,11 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * 凭据状态
+   * The status of the credential. Valid values:
+   * 
+   * - `enabled`: The credential is active.
+   * 
+   * - `disabled`: The credential is inactive.
    * 
    * @example
    * enabled
@@ -169,7 +187,7 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * 云角色更新时间
+   * The time the credential was last updated, in Unix timestamp format (milliseconds).
    * 
    * @example
    * 1649830227000
@@ -232,8 +250,15 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
 }
 
 export class GetCredentialResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The credential details.
+   */
   credential?: GetCredentialResponseBodyCredential;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
    */

package/src/models/GetCustomFieldRequest.ts

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

package/src/models/GetCustomFieldResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetCustomFieldResponseBodyCustomFieldFieldDataConfigItems extends $dara.Model {
   /**
    * @remarks
-   * 配置项展示名
+   * The display name of the configuration item.
    * 
    * @example
    * hobby
@@ -13,7 +13,7 @@ export class GetCustomFieldResponseBodyCustomFieldFieldDataConfigItems extends $
   displayName?: string;
   /**
    * @remarks
-   * 配置项状态, 枚举值，enabled、disabled
+   * The status of the configuration item.
    * 
    * @example
    * enabled
@@ -21,7 +21,7 @@ export class GetCustomFieldResponseBodyCustomFieldFieldDataConfigItems extends $
   status?: string;
   /**
    * @remarks
-   * 配置项值
+   * The value of the configuration item.
    * 
    * @example
    * game
@@ -55,7 +55,7 @@ export class GetCustomFieldResponseBodyCustomFieldFieldDataConfigItems extends $
 export class GetCustomFieldResponseBodyCustomFieldFieldDataConfig extends $dara.Model {
   /**
    * @remarks
-   * 字段配置项列表，displayName、value、status
+   * A list of field configuration items.
    */
   items?: GetCustomFieldResponseBodyCustomFieldFieldDataConfigItems[];
   static names(): { [key: string]: string } {
@@ -85,7 +85,7 @@ export class GetCustomFieldResponseBodyCustomFieldFieldDataConfig extends $dara.
 export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   /**
    * @remarks
-   * 扩展字段创建时间，Unix时间戳格式，单位为毫秒
+   * The creation time of the custom field, in UNIX timestamp format in milliseconds.
    * 
    * @example
    * 17642960730
@@ -93,7 +93,7 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   createTime?: number;
   /**
    * @remarks
-   * 字段默认值
+   * The default value of the field.
    * 
    * @example
    * test
@@ -101,7 +101,7 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   defaultValue?: string;
   /**
    * @remarks
-   * 扩展字段描述
+   * The description of the custom field.
    * 
    * @example
    * test
@@ -109,7 +109,7 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * 是否加密，默认false
+   * Indicates whether the field is encrypted.
    * 
    * @example
    * false
@@ -117,7 +117,7 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   encrypted?: boolean;
   /**
    * @remarks
-   * 字段所属实体类型
+   * The entity type to which the field belongs.
    * 
    * @example
    * user
@@ -125,12 +125,12 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   entityType?: string;
   /**
    * @remarks
-   * 字段值配置项
+   * Field value configuration items.
    */
   fieldDataConfig?: GetCustomFieldResponseBodyCustomFieldFieldDataConfig;
   /**
    * @remarks
-   * 数据类型，枚举值：string、number、boolean
+   * The data type.
    * 
    * @example
    * string
@@ -138,7 +138,7 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   fieldDataType?: string;
   /**
    * @remarks
-   * 字段展示名
+   * The display name of the field.
    * 
    * @example
    * userId
@@ -146,7 +146,7 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   fieldDisplayName?: string;
   /**
    * @remarks
-   * 字段展示类型，枚举值，select、checkbox、input、number
+   * The display type of the field.
    * 
    * @example
    * input
@@ -154,7 +154,7 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   fieldDisplayType?: string;
   /**
    * @remarks
-   * 字段ID
+   * The field ID.
    * 
    * @example
    * ufd_ncvy5trszg3zajaal5iofauy2q
@@ -162,7 +162,7 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   fieldId?: string;
   /**
    * @remarks
-   * 字段标识
+   * The field identifier.
    * 
    * @example
    * userId
@@ -170,7 +170,7 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   fieldName?: string;
   /**
    * @remarks
-   * 实例ID
+   * The instance ID.
    * 
    * @example
    * idaas_z4pwq7v5ankdimdelzo2zbmzo4
@@ -178,7 +178,7 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * 是否必填，默认false
+   * Indicates whether the field is required.
    * 
    * @example
    * false
@@ -186,7 +186,7 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   required?: boolean;
   /**
    * @remarks
-   * 扩展字段状态, 枚举类型：enabled，disabled
+   * The status of the custom field.
    * 
    * @example
    * enabled
@@ -194,7 +194,7 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * 是否唯一，默认false
+   * Indicates whether the field is unique.
    * 
    * @example
    * false
@@ -202,7 +202,7 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   unique?: boolean;
   /**
    * @remarks
-   * 扩展字段最近一次更新时间, Unix时间戳格式，单位为毫秒
+   * The last update time of the custom field, in UNIX timestamp format in milliseconds.
    * 
    * @example
    * 17642960730
@@ -210,7 +210,7 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
   updateTime?: number;
   /**
    * @remarks
-   * 用户端(portal侧)权限，hide、read_only、read_write，默认read_only
+   * User-side (portal) permissions.
    * 
    * @example
    * read_only
@@ -273,8 +273,15 @@ export class GetCustomFieldResponseBodyCustomField extends $dara.Model {
 }
 
 export class GetCustomFieldResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Custom field information.
+   */
   customField?: GetCustomFieldResponseBodyCustomField;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
    */

package/src/models/GetCustomPrivacyPolicyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetCustomPrivacyPolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * 自定义条款ID
+   * The ID of the custom privacy policy.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetCustomPrivacyPolicyRequest extends $dara.Model {
   customPrivacyPolicyId?: string;
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    *