@alicloud/eiam20211201 2.19.2 → 3.0.0

package/src/models/CreateApplicationRequest.ts

@@ -3,7 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateApplicationRequestApplicationOwner extends $dara.Model {
+  /**
+   * @remarks
+   * The list of group IDs.
+   */
   groupIds?: string[];
+  /**
+   * @remarks
+   * The list of user IDs.
+   */
   userIds?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -35,7 +43,21 @@ export class CreateApplicationRequestApplicationOwner extends $dara.Model {
 }
 
 export class CreateApplicationRequestCustomFields extends $dara.Model {
+  /**
+   * @remarks
+   * The identifier of the application extension field.
+   * 
+   * @example
+   * agent_type
+   */
   fieldName?: string;
+  /**
+   * @remarks
+   * The value of the application extension field. When FieldName is set to agentType, valid values are bailian, pai, dify, and volcano. When FieldName is set to agentExternalId, enter the relevant value.
+   * 
+   * @example
+   * bailian
+   */
   fieldValue?: string;
   static names(): { [key: string]: string } {
     return {
@@ -81,6 +103,10 @@ export class CreateApplicationRequest extends $dara.Model {
    * Ram Account SSO
    */
   applicationName?: string;
+  /**
+   * @remarks
+   * The application owner.
+   */
   applicationOwner?: CreateApplicationRequestApplicationOwner;
   /**
    * @remarks
@@ -96,12 +122,16 @@ export class CreateApplicationRequest extends $dara.Model {
   applicationSourceType?: string;
   /**
    * @remarks
-   * The application template ID. This parameter is required when ApplicationSourceType is set to urn:alibaba:idaas:app:source:template.
+   * The application template ID. This parameter is required when the ApplicationSourceType parameter is set to urn:alibaba:idaas:app:source:template.
    * 
    * @example
    * apt_ramuser_mjqrsi
    */
   applicationTemplateId?: string;
+  /**
+   * @remarks
+   * The list of application extension fields.
+   */
   customFields?: CreateApplicationRequestCustomFields[];
   /**
    * @remarks
@@ -131,7 +161,7 @@ export class CreateApplicationRequest extends $dara.Model {
   logoUrl?: string;
   /**
    * @remarks
-   * The single sign-on protocol. Valid values:
+   * The single sign-on (SSO) protocol. Valid values:
    * - saml2: SAML 2.0 protocol.
    * - oidc: OpenID Connect protocol.
    * 

package/src/models/CreateApplicationTokenRequest.ts

@@ -25,7 +25,7 @@ export class CreateApplicationTokenRequest extends $dara.Model {
   applicationTokenType?: string;
   /**
    * @remarks
-   * The expiration time.
+   * The expiration time. Specify a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1735530123762

package/src/models/CreateCloudAccountRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCloudAccountRequest extends $dara.Model {
   /**
    * @remarks
-   * 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 ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see References [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).
+   * The client token that is used to ensure the idempotence of the request. Generate a parameter value from your client to ensure that the value is unique among different requests. The ClientToken value supports only ASCII characters and cannot exceed 64 characters in length. For more information, see References [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).
    * 
    * This parameter is required.
    * 
@@ -43,7 +43,7 @@ export class CreateCloudAccountRequest extends $dara.Model {
    * @remarks
    * The cloud account site. Valid values:
    * 
-   * - global: international site.
+   * - global: International site.
    * - china_mainland: China site.
    * 
    * @example

package/src/models/CreateCloudAccountRoleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCloudAccountRoleRequest extends $dara.Model {
   /**
    * @remarks
-   * A client token used to ensure the idempotence of the request. Generate a unique value for this parameter from your client. The token can contain only ASCII characters and must be no more than 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).
+   * 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](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class CreateCloudAccountRoleRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account.
+   * The cloud account ID.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class CreateCloudAccountRoleRequest extends $dara.Model {
   cloudAccountId?: string;
   /**
    * @remarks
-   * The name of the cloud role.
+   * The cloud role name.
    * 
    * This parameter is required.
    * 
@@ -35,9 +35,8 @@ export class CreateCloudAccountRoleRequest extends $dara.Model {
   cloudAccountRoleName?: string;
   /**
    * @remarks
-   * The type of the cloud role. The format of this parameter depends on the type of the Alibaba Cloud account. The supported value is:
-   * 
-   * - role: applies to Alibaba Cloud accounts.
+   * The cloud role type. The specific format depends on the cloud account type. Valid values:
+   * - role: applicable to Alibaba Cloud accounts.
    * 
    * @example
    * role
@@ -45,7 +44,7 @@ export class CreateCloudAccountRoleRequest extends $dara.Model {
   cloudAccountRoleType?: string;
   /**
    * @remarks
-   * The description of the cloud role.
+   * The cloud role description.
    * 
    * @example
    * cloud_account_role_description
@@ -53,7 +52,7 @@ export class CreateCloudAccountRoleRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The ID of the instance.
+   * The instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/CreateCloudAccountRoleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCloudAccountRoleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the cloud role.
+   * The cloud role ID.
    * 
    * @example
    * carole_01kmek49aqxxxx
@@ -13,7 +13,7 @@ export class CreateCloudAccountRoleResponseBody extends $dara.Model {
   cloudAccountRoleId?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A

package/src/models/CreateCredentialProviderRequest.ts

@@ -7,12 +7,12 @@ export class CreateCredentialProviderRequestCredentialProviderConfigJwtProviderC
    * @remarks
    * The list of allowed JWT issuers.
    * 
-   * > The list length cannot exceed 200.
+   * > The list cannot contain more than 200 entries.
    */
   allowedTokenIssuers?: string[];
   /**
    * @remarks
-   * Specifies whether to enable the JWT derived short token capability.
+   * Specifies whether to enable the JWT derived short token feature.
    * 
    * @example
    * false
@@ -20,7 +20,7 @@ export class CreateCredentialProviderRequestCredentialProviderConfigJwtProviderC
   derivedShortTokenEnabled?: boolean;
   /**
    * @remarks
-   * The validity duration of the JWT. Unit: seconds.
+   * The validity period of the JWT, in seconds.
    * 
    * @example
    * 900
@@ -67,17 +67,25 @@ export class CreateCredentialProviderRequestCredentialProviderConfigJwtProviderC
 export class CreateCredentialProviderRequestCredentialProviderConfigOAuthProviderConfig extends $dara.Model {
   /**
    * @remarks
-   * The endpoint address used to guide users through authorization. Conditionally required: required when AuthorizationFlow=user_federation and ProviderVendor=custom. For preset vendors, this can be automatically populated through DiscoveryUrl.
+   * The authorization endpoint of the OAuth protocol.
+   * 
+   * @example
+   * https://example.com/authorize
    */
   authorizationEndpoint?: string;
   /**
    * @remarks
-   * The OAuth authorization flow type. Valid values: m2m: machine-to-machine (2LO, Client Credentials). user_federation: user federation (3LO, Authorization Code).
+   * The OAuth authorization flow type. Valid values:
+   * - m2m: Machine-to-machine.
+   * - user_federation: User federation.
+   * 
+   * @example
+   * m2m
    */
   authorizationFlow?: string;
   /**
    * @remarks
-   * The client_id in the OAuth protocol.
+   * The client_id in the OAuth protocol, which is the client ID.
    * 
    * > The length cannot exceed 128 characters.
    * 
@@ -89,7 +97,7 @@ export class CreateCredentialProviderRequestCredentialProviderConfigOAuthProvide
   clientId?: string;
   /**
    * @remarks
-   * The client_secret in the OAuth protocol.
+   * The client_secret in the OAuth protocol, which is the client secret.
    * 
    * > The length cannot exceed 1024 characters.
    * 
@@ -101,35 +109,62 @@ export class CreateCredentialProviderRequestCredentialProviderConfigOAuthProvide
   clientSecret?: string;
   /**
    * @remarks
-   * The Discovery document URL used to automatically retrieve OAuth endpoint configurations. Conditionally optional: used when AuthorizationFlow=user_federation. If DiscoveryUrl is not provided, you must manually configure fields such as TokenEndpoint and AuthorizationEndpoint.
+   * The URL of the OAuth Discovery document.
+   * 
+   * @example
+   * https://example.com/.well-known/openid-configuration
    */
   discoveryUrl?: string;
+  /**
+   * @remarks
+   * The Issuer endpoint of the OAuth protocol.
+   * 
+   * @example
+   * https://example.com/issuer
+   */
   issuer?: string;
   /**
    * @remarks
-   * The PKCE code_challenge generation method. Default value: s256.
+   * The algorithm used to calculate the Code Challenge in PKCE. Valid values:
+   * - S256.
+   * - plain.
+   * 
+   * @example
+   * S256
    */
   pkceChallengeMethod?: string;
   /**
    * @remarks
-   * Specifies whether to use the PKCE extension to enhance security. We recommend that you always enable this feature.
+   * Specifies whether to enable PKCE.
+   * 
+   * @example
+   * true
    */
   pkceEnabled?: boolean;
   /**
    * @remarks
-   * The preset vendor or custom configuration. Optional. Default value: custom.
+   * The OAuth provider vendor type. Valid values:
+   * - custom: Custom.
+   * - dingtalk: DingTalk.
+   * - feishu: Lark.
+   * - github: GitHub.
+   * - microsoft: Microsoft.
+   * - google: Google.
+   * 
+   * @example
+   * custom
    */
   providerVendor?: string;
   /**
    * @remarks
-   * The scope in the OAuth protocol, which defines the permission range.
+   * The scope in the OAuth protocol, which specifies the permission scope.
    * 
-   * > The Scope configuration on the credential provider serves as the fallback value. If the scope parameter is not specified when calling the DeveloperAPI to obtain an OAuth Access Token, the Scope configuration on the credential provider is used for issuance.
+   * > The Scope configuration on the credential provider serves as the default value. If the scope parameter is not specified when calling the DeveloperAPI to obtain an OAuth Access Token, the Scope configuration on the credential provider is used for issuance.
    * 
    * >Notice: Separate multiple Scope values with spaces.
    * 
-   * Restrictions for each individual Scope value:
-   * 1. Allowed characters: lowercase letters, digits, and the special characters `|/:_-.`
+   * The following restrictions apply to each individual Scope value:
+   * 1. Allowed characters: lowercase letters, digits, and the special characters `|/:_-.`.
    * 2. Must contain at least one lowercase letter or digit.
    * 3. Must start with the special character `.`, a lowercase letter, or a digit.
    * 4. The length cannot exceed 1024 characters.
@@ -142,7 +177,7 @@ export class CreateCredentialProviderRequestCredentialProviderConfigOAuthProvide
    * @remarks
    * The token endpoint of the OAuth protocol.
    * 
-   * > Must start with `http://` or `https://`, and the length cannot exceed 1024 characters.
+   * > The value must start with `http://` or `https://`, and the length cannot exceed 1024 characters.
    * 
    * @example
    * https://example.com/token
@@ -234,7 +269,7 @@ export class CreateCredentialProviderRequest extends $dara.Model {
    * @remarks
    * The idempotency token that ensures the idempotence of the request.
    * 
-   * Generate a parameter value from your client to ensure uniqueness across different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters in length. For more information, see References [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).
+   * Generate a unique parameter value from your client to ensure that different requests have unique values. ClientToken supports only ASCII characters and cannot exceed 64 characters in length. For more information, see References [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).
    * 
    * This parameter is required.
    * 
@@ -249,7 +284,7 @@ export class CreateCredentialProviderRequest extends $dara.Model {
   credentialProviderConfig?: CreateCredentialProviderRequestCredentialProviderConfig;
   /**
    * @remarks
-   * The identifier of the credential provider.
+   * The business identifier of the credential provider.
    * 
    * > Allowed characters include uppercase and lowercase letters, digits, and the special characters `.-_`. The length cannot exceed 64 characters.
    * 

package/src/models/CreateCredentialRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateCredentialRequestCredentialContentApiKeyContent extends $dara.Model {
   /**
    * @remarks
-   * The API key content.
+   * The content of the API key.
    * 
    * @example
    * nsklnertyt5ddwizncxxxx
@@ -115,7 +115,7 @@ export class CreateCredentialRequestCredentialContent extends $dara.Model {
 export class CreateCredentialRequest extends $dara.Model {
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The ClientToken parameter supports only ASCII characters and cannot exceed 64 characters in length. For more information, see References: [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).
+   * Ensures the idempotence of the request. Generate a parameter value from your client to ensure that the value is unique across different requests. The ClientToken value supports only ASCII characters and cannot exceed 64 characters in length. For more information, see References: [How to ensure idempotence](https://www.alibabacloud.com/help/zh/ecs/developer-reference/how-to-ensure-idempotence).
    * 
    * This parameter is required.
    * 
@@ -125,11 +125,18 @@ export class CreateCredentialRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The credential content.
+   * The content of the credential.
    * 
    * This parameter is required.
    */
   credentialContent?: CreateCredentialRequestCredentialContent;
+  /**
+   * @remarks
+   * The external unique identifier of the credential.
+   * 
+   * @example
+   * test_external_id
+   */
   credentialExternalId?: string;
   /**
    * @remarks
@@ -161,10 +168,17 @@ export class CreateCredentialRequest extends $dara.Model {
    * llm
    */
   credentialScenarioLabel?: string;
+  /**
+   * @remarks
+   * The sharing scope of the credential.
+   * 
+   * @example
+   * user_exclusive
+   */
   credentialSharingScope?: string;
   /**
    * @remarks
-   * The subject ID of the credential.
+   * The subject ID to which the credential belongs.
    * 
    * @example
    * apt_werthgfdsasffxxxxx
@@ -172,7 +186,7 @@ export class CreateCredentialRequest extends $dara.Model {
   credentialSubjectId?: string;
   /**
    * @remarks
-   * The subject type of the credential. Valid values:
+   * The subject type to which the credential belongs. Valid values:
    * - authentication_token_provider: authentication token provider.
    * 
    * @example
@@ -193,12 +207,19 @@ export class CreateCredentialRequest extends $dara.Model {
   credentialType?: string;
   /**
    * @remarks
-   * The credential description.
+   * The description of the credential.
    * 
    * @example
    * credential_description
    */
   description?: string;
+  /**
+   * @remarks
+   * The exclusive user ID of the credential.
+   * 
+   * @example
+   * user_xxxx
+   */
   exclusiveUserId?: string;
   /**
    * @remarks

package/src/models/CreateFederatedCredentialProviderRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateFederatedCredentialProviderRequestCloudIdPProviderConfig extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the identity provider.
+   * 
    * @example
    * idp_m7hk2hbnew5ir3ycfabug6xxxx
    */
@@ -37,7 +40,7 @@ export class CreateFederatedCredentialProviderRequestOidcProviderConfig extends
   audiences?: string[];
   /**
    * @remarks
-   * Issuer
+   * The token issuer identifier (Issuer).
    * 
    * @example
    * https://example.com
@@ -279,7 +282,7 @@ export class CreateFederatedCredentialProviderRequestPrivateCaProviderConfig ext
   trustAnchorSource?: string;
   /**
    * @remarks
-   * The trust condition for the root certificate.
+   * The trust condition of the root certificate.
    * 
    * @example
    * IsNullOrEmpty("jwt.issuer")
@@ -314,6 +317,10 @@ export class CreateFederatedCredentialProviderRequestPrivateCaProviderConfig ext
 }
 
 export class CreateFederatedCredentialProviderRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The identity provider configuration.
+   */
   cloudIdPProviderConfig?: CreateFederatedCredentialProviderRequestCloudIdPProviderConfig;
   /**
    * @remarks