@alicloud/eiam20211201 2.16.0 → 2.16.1

package/src/models/ListCredentialProvidersResponseBody.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialProviderConfigJwtProviderConfig extends $dara.Model {
   /**
    * @remarks
-   * 签发出的JWT中的issuer字段的允许列表。
+   * List of allowed JWT issuers.
    */
   allowedTokenIssuers?: string[];
   /**
    * @remarks
-   * 是否开启JWT派生短令牌能力。
+   * Enable JWT derived short token capability.
    * 
    * @example
    * false
@@ -18,7 +18,7 @@ export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialPro
   derivedShortTokenEnabled?: boolean;
   /**
    * @remarks
-   * JWT的有效时长，单位秒。
+   * Validity period of the JWT, in seconds.
    * 
    * @example
    * 900
@@ -26,7 +26,7 @@ export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialPro
   expiration?: number;
   /**
    * @remarks
-   * 是否开启JWT过期清理。
+   * Enable JWT expiration cleanup.
    * 
    * @example
    * true
@@ -34,7 +34,7 @@ export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialPro
   expirationCleanupEnabled?: boolean;
   /**
    * @remarks
-   * JWT issuer。
+   * JWT issuer.
    * 
    * @example
    * https://test.issuer.com
@@ -42,7 +42,7 @@ export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialPro
   issuer?: string;
   /**
    * @remarks
-   * JWKs端点地址。
+   * JWKs endpoint address.
    * 
    * @example
    * https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks
@@ -85,7 +85,7 @@ export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialPro
 export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialProviderConfigOAuthProviderConfig extends $dara.Model {
   /**
    * @remarks
-   * OAuth协议中的client_id，客户端ID。
+   * The client_id in the OAuth protocol, also known as the client ID.
    * 
    * @example
    * client_id_example_xxx
@@ -93,7 +93,13 @@ export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialPro
   clientId?: string;
   /**
    * @remarks
-   * OAuth协议中的scope，权限范围。
+   * The scope in the OAuth protocol, which defines permission scope.
+   * 
+   * > The Scope configuration for the OAuth credential provider acts as a fallback. If you do not specify the scope parameter when calling the DeveloperAPI to get an OAuth Access Token, the credential provider\\"s Scope configuration is used for issuance.
+   * 
+   * >Notice: 
+   * 
+   * Multiple Scope values are separated by spaces.
    * 
    * @example
    * example:test_01 example:test_02
@@ -101,7 +107,7 @@ export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialPro
   scope?: string;
   /**
    * @remarks
-   * OAuth协议的Token端点。
+   * The Token endpoint of the OAuth protocol.
    * 
    * @example
    * https://example.com/token
@@ -135,17 +141,19 @@ export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialPro
 export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialProviderConfig extends $dara.Model {
   /**
    * @remarks
-   * JWT身份提供商配置。
+   * Configuration for JWT credential providers.
    */
   jwtProviderConfig?: ListCredentialProvidersResponseBodyCredentialProvidersCredentialProviderConfigJwtProviderConfig;
   /**
    * @remarks
-   * OAuth 2LO机用类型的提供商的配置。
+   * Configuration for OAuth credential providers.
    */
   OAuthProviderConfig?: ListCredentialProvidersResponseBodyCredentialProvidersCredentialProviderConfigOAuthProviderConfig;
   /**
    * @remarks
-   * 认证令牌提供商的敏感配置对应的凭据ID列表。
+   * List of credential IDs for the sensitive configuration of the credential provider.
+   * 
+   * > The system securely stores sensitive credential provider configuration as credentials.
    */
   providerCredentialIds?: string[];
   static names(): { [key: string]: string } {
@@ -185,7 +193,7 @@ export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialPro
 export class ListCredentialProvidersResponseBodyCredentialProviders extends $dara.Model {
   /**
    * @remarks
-   * 认证令牌提供商的创建时间，Unix时间戳。
+   * Creation time of the credential provider, in Unix timestamp format (milliseconds).
    * 
    * @example
    * 1649830225000
@@ -193,12 +201,16 @@ export class ListCredentialProvidersResponseBodyCredentialProviders extends $dar
   createTime?: number;
   /**
    * @remarks
-   * 认证令牌提供商的配置。
+   * Credential provider configuration.
    */
   credentialProviderConfig?: ListCredentialProvidersResponseBodyCredentialProvidersCredentialProviderConfig;
   /**
    * @remarks
-   * 认证令牌提供商的创建类型。
+   * Credential provider creation type. Valid values:
+   * 
+   * - system_init: System created.
+   * 
+   * - user_custom: User created.
    * 
    * @example
    * user_custom
@@ -206,7 +218,7 @@ export class ListCredentialProvidersResponseBodyCredentialProviders extends $dar
   credentialProviderCreationType?: string;
   /**
    * @remarks
-   * 认证令牌提供商ID。
+   * Credential provider ID.
    * 
    * @example
    * atp_01kr2cmj5gxxx4fvmls2e93dxxxxx
@@ -214,7 +226,7 @@ export class ListCredentialProvidersResponseBodyCredentialProviders extends $dar
   credentialProviderId?: string;
   /**
    * @remarks
-   * 认证令牌提供商的业务标识。
+   * Credential provider identifier.
    * 
    * @example
    * test_example_identifier
@@ -222,7 +234,7 @@ export class ListCredentialProvidersResponseBodyCredentialProviders extends $dar
   credentialProviderIdentifier?: string;
   /**
    * @remarks
-   * 认证令牌提供商名称。
+   * Credential provider name.
    * 
    * @example
    * test_example_name
@@ -230,7 +242,11 @@ export class ListCredentialProvidersResponseBodyCredentialProviders extends $dar
   credentialProviderName?: string;
   /**
    * @remarks
-   * 认证令牌提供商的类型。
+   * Credential provider type. Valid values:
+   * 
+   * - oauth: OAuth credential provider
+   * 
+   * - jwt: JWT credential provider
    * 
    * @example
    * oauth
@@ -238,7 +254,7 @@ export class ListCredentialProvidersResponseBodyCredentialProviders extends $dar
   credentialProviderType?: string;
   /**
    * @remarks
-   * 描述。
+   * Description.
    * 
    * @example
    * This is an example description
@@ -246,7 +262,7 @@ export class ListCredentialProvidersResponseBodyCredentialProviders extends $dar
   description?: string;
   /**
    * @remarks
-   * EIAM实例ID。
+   * Instance ID.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
@@ -254,7 +270,11 @@ export class ListCredentialProvidersResponseBodyCredentialProviders extends $dar
   instanceId?: string;
   /**
    * @remarks
-   * 认证令牌提供商的状态。
+   * Credential provider status. Valid values:
+   * 
+   * - enabled: Enabled.
+   * 
+   * - disabled: Disabled.
    * 
    * @example
    * enabled
@@ -262,7 +282,7 @@ export class ListCredentialProvidersResponseBodyCredentialProviders extends $dar
   status?: string;
   /**
    * @remarks
-   * 认证令牌提供商的更新时间，Unix时间戳。
+   * Update time of the credential provider, in Unix timestamp format (milliseconds).
    * 
    * @example
    * 1649830225000
@@ -313,10 +333,14 @@ export class ListCredentialProvidersResponseBodyCredentialProviders extends $dar
 }
 
 export class ListCredentialProvidersResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * List of credential providers.
+   */
   credentialProviders?: ListCredentialProvidersResponseBodyCredentialProviders[];
   /**
    * @remarks
-   * 分页查询时每页行数。
+   * Page size for paged queries.
    * 
    * @example
    * 20
@@ -324,18 +348,24 @@ export class ListCredentialProvidersResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * 本次调用返回的查询凭证（Token）值，用于下一次翻页查询。
+   * The query token returned by this call.
    * 
    * @example
    * NTxxxexample
    */
   nextToken?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
    */
   requestId?: string;
   /**
+   * @remarks
+   * Total count.
+   * 
    * @example
    * 100
    */

package/src/models/ListCredentialsRequest.ts

@@ -4,10 +4,19 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListCredentialsRequestFilter extends $dara.Model {
   /**
+   * @remarks
+   * The field to filter on. Valid value:
+   * 
+   * - `CredentialIdentifier`: the credential identifier.
+   * 
    * @example
    * CredentialIdentifier
    */
   name?: string;
+  /**
+   * @remarks
+   * The values for the specified filter field.
+   */
   value?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -37,13 +46,21 @@ export class ListCredentialsRequestFilter extends $dara.Model {
 
 export class ListCredentialsRequest extends $dara.Model {
   credentialExternalIds?: string[];
+  /**
+   * @remarks
+   * The credential IDs.
+   */
   credentialIds?: string[];
   credentialSharingScopes?: string[];
   credentialTypes?: string[];
+  /**
+   * @remarks
+   * The filter conditions.
+   */
   filter?: ListCredentialsRequestFilter[];
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    * 
@@ -53,7 +70,11 @@ export class ListCredentialsRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * 分页查询时每页行数。默认值为20，最大值为100。
+   * The number of entries per page.
+   * 
+   * - Default value: 20.
+   * 
+   * - Maximum value: 100.
    * 
    * @example
    * 20
@@ -61,12 +82,16 @@ export class ListCredentialsRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * 查询凭证（Token），取值为上一次API调用返回的NextToken参数值。
+   * The pagination token that is used in the next request to retrieve a new page of results.
    * 
    * @example
    * NTxxxxxexample
    */
   nextToken?: string;
+  /**
+   * @remarks
+   * The credential statuses.
+   */
   statuses?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListCredentialsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCredentialsResponseBodyCredentialsCredentialContentOAuthClientContent extends $dara.Model {
   /**
    * @remarks
-   * OAuth协议的client_id
+   * The client ID of the OAuth client.
    * 
    * @example
    * dmvncmxersdxxxxxx
@@ -35,7 +35,7 @@ export class ListCredentialsResponseBodyCredentialsCredentialContentOAuthClientC
 export class ListCredentialsResponseBodyCredentialsCredentialContent extends $dara.Model {
   /**
    * @remarks
-   * OAuth客户端认证凭证类型的凭据内容。
+   * The content of an OAuth client credential.
    */
   OAuthClientContent?: ListCredentialsResponseBodyCredentialsCredentialContentOAuthClientContent;
   static names(): { [key: string]: string } {
@@ -65,7 +65,7 @@ export class ListCredentialsResponseBodyCredentialsCredentialContent extends $da
 export class ListCredentialsResponseBodyCredentials extends $dara.Model {
   /**
    * @remarks
-   * 云角色创建时间
+   * The time the credential was created, provided as a Unix timestamp in milliseconds.
    * 
    * @example
    * 1649830225000
@@ -73,12 +73,16 @@ export class ListCredentialsResponseBodyCredentials extends $dara.Model {
   createTime?: number;
   /**
    * @remarks
-   * 凭据的内容。
+   * The content of the credential.
    */
   credentialContent?: ListCredentialsResponseBodyCredentialsCredentialContent;
   /**
    * @remarks
-   * 凭据的创建类型。
+   * The creation type of the credential. Valid values:
+   * 
+   * - `system_init`: Created by the system.
+   * 
+   * - `user_custom`: Created by a user.
    * 
    * @example
    * user_custom
@@ -87,7 +91,7 @@ export class ListCredentialsResponseBodyCredentials extends $dara.Model {
   credentialExternalId?: string;
   /**
    * @remarks
-   * 凭据ID。
+   * The ID of the credential.
    * 
    * @example
    * cred_mkv7rgt4d7i4u7zqtzev2mxxxx
@@ -95,7 +99,7 @@ export class ListCredentialsResponseBodyCredentials extends $dara.Model {
   credentialId?: string;
   /**
    * @remarks
-   * 凭据标识
+   * The identifier of the credential.
    * 
    * @example
    * credential_identifier_test
@@ -103,7 +107,7 @@ export class ListCredentialsResponseBodyCredentials extends $dara.Model {
   credentialIdentifier?: string;
   /**
    * @remarks
-   * 凭据名称
+   * The name of the credential.
    * 
    * @example
    * credential_name
@@ -111,7 +115,11 @@ export class ListCredentialsResponseBodyCredentials extends $dara.Model {
   credentialName?: string;
   /**
    * @remarks
-   * 凭据的使用场景标签。
+   * The use case label for the credential. Valid values:
+   * 
+   * - `llm`: A large language model.
+   * 
+   * - `saas`: A third-party SaaS service.
    * 
    * @example
    * llm
@@ -120,7 +128,7 @@ export class ListCredentialsResponseBodyCredentials extends $dara.Model {
   credentialSharingScope?: string;
   /**
    * @remarks
-   * 凭据所属的主体ID。
+   * The ID of the credential\\"s subject.
    * 
    * @example
    * apt_werthgfdsasffxxxxx
@@ -128,7 +136,9 @@ export class ListCredentialsResponseBodyCredentials extends $dara.Model {
   credentialSubjectId?: string;
   /**
    * @remarks
-   * 凭据所属的主体类型。
+   * The type of the credential\\"s subject. Valid value:
+   * 
+   * - `authentication_token_provider`: An authentication token provider.
    * 
    * @example
    * authentication_token_provider
@@ -136,7 +146,11 @@ export class ListCredentialsResponseBodyCredentials 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 ListCredentialsResponseBodyCredentials extends $dara.Model {
   credentialType?: string;
   /**
    * @remarks
-   * 描述
+   * The description of the credential.
    * 
    * @example
    * credential_description
@@ -153,7 +167,7 @@ export class ListCredentialsResponseBodyCredentials extends $dara.Model {
   exclusiveUserId?: string;
   /**
    * @remarks
-   * EIAM实例ID。
+   * The ID of the EIAM instance.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
@@ -161,7 +175,11 @@ export class ListCredentialsResponseBodyCredentials extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * 凭据状态
+   * The status of the credential. Valid values:
+   * 
+   * - `enabled`: The credential is enabled.
+   * 
+   * - `disabled`: The credential is disabled.
    * 
    * @example
    * enabled
@@ -169,7 +187,7 @@ export class ListCredentialsResponseBodyCredentials extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * 云角色更新时间
+   * The time the credential was last updated, provided as a Unix timestamp in milliseconds.
    * 
    * @example
    * 1649830227000
@@ -232,10 +250,14 @@ export class ListCredentialsResponseBodyCredentials extends $dara.Model {
 }
 
 export class ListCredentialsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * A list of credentials.
+   */
   credentials?: ListCredentialsResponseBodyCredentials[];
   /**
    * @remarks
-   * 分页查询时每页行数。
+   * The maximum number of entries to return per page.
    * 
    * @example
    * 20
@@ -243,18 +265,24 @@ export class ListCredentialsResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * 本次调用返回的查询凭证（Token）值，用于下一次翻页查询。
+   * The token used to retrieve the next page of results. If this parameter is not returned, it indicates all results have been returned.
    * 
    * @example
    * NTxxxexample
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 100
    */

package/src/models/ListCustomPrivacyPoliciesForBrandRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCustomPrivacyPoliciesForBrandRequest extends $dara.Model {
   /**
    * @remarks
-   * 品牌化Id
+   * The brand ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class ListCustomPrivacyPoliciesForBrandRequest extends $dara.Model {
   brandId?: string;
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class ListCustomPrivacyPoliciesForBrandRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * 分页查询时每页行数。默认值为20，最大值为100。
+   * The number of entries to return on each page.
    * 
    * @example
    * 20
@@ -33,7 +33,7 @@ export class ListCustomPrivacyPoliciesForBrandRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * 查询凭证（Token），取值为上一次API调用返回的NextToken参数值。
+   * The token that is used to retrieve the next page of results.
    * 
    * @example
    * NTxxxxxexample
@@ -41,7 +41,7 @@ export class ListCustomPrivacyPoliciesForBrandRequest extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * 查询上一页凭证（Token），取值为上一次API调用返回的previousToken参数值。
+   * The token that is used to retrieve the previous page of results.
    * 
    * @example
    * PTxxxxxexample

package/src/models/ListCustomPrivacyPoliciesForBrandResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCustomPrivacyPoliciesForBrandResponseBodyBrandCustomPrivacyPolicies extends $dara.Model {
   /**
    * @remarks
-   * 条款ID
+   * The privacy policy ID.
    * 
    * @example
    * pp_xxxx
@@ -33,10 +33,14 @@ export class ListCustomPrivacyPoliciesForBrandResponseBodyBrandCustomPrivacyPoli
 }
 
 export class ListCustomPrivacyPoliciesForBrandResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of custom privacy policies associated with the brand.
+   */
   brandCustomPrivacyPolicies?: ListCustomPrivacyPoliciesForBrandResponseBodyBrandCustomPrivacyPolicies[];
   /**
    * @remarks
-   * 分页查询时每页行数。
+   * The number of entries returned on each page.
    * 
    * @example
    * 20
@@ -44,7 +48,7 @@ export class ListCustomPrivacyPoliciesForBrandResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * 本次调用返回的查询凭证（Token）值，用于下一次翻页查询。
+   * The token to retrieve the next page of results.
    * 
    * @example
    * NTxxxexample
@@ -52,18 +56,24 @@ export class ListCustomPrivacyPoliciesForBrandResponseBody extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * 本次调用返回的查询凭证（Token）值，用于上一次翻页查询。
+   * The token to retrieve the previous page of results.
    * 
    * @example
    * PTxxxexample
    */
   previousToken?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 100
    */

package/src/models/ListCustomPrivacyPoliciesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListCustomPrivacyPoliciesRequest extends $dara.Model {
   /**
    * @remarks
-   * 自定义条款名称，左模糊匹配
+   * The name of the custom privacy policy. This parameter supports prefix matching.
    * 
    * @example
    * Custom
@@ -13,7 +13,7 @@ export class ListCustomPrivacyPoliciesRequest extends $dara.Model {
   customPrivacyPolicyNameStartsWith?: string;
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    * 
@@ -23,7 +23,7 @@ export class ListCustomPrivacyPoliciesRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * 分页查询时每页行数。默认值为20，最大值为100。
+   * The number of entries to return on each page.
    * 
    * @example
    * 20
@@ -31,7 +31,7 @@ export class ListCustomPrivacyPoliciesRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * 查询凭证（Token），取值为上一次API调用返回的NextToken参数值。
+   * The token that is used to retrieve the next page of results.
    * 
    * @example
    * NTxxxxxexample
@@ -39,7 +39,7 @@ export class ListCustomPrivacyPoliciesRequest extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * 查询上一页凭证（Token），取值为上一次API调用返回的previousToken参数值。
+   * The token that is used to retrieve the previous page of results.
    * 
    * @example
    * PTxxxxxexample