@alicloud/eiam20211201 2.19.0 → 2.19.1

package/src/models/CreateApplicationFederatedCredentialRequest.ts

@@ -43,9 +43,34 @@ export class CreateApplicationFederatedCredentialRequestAttributeMappings extend
 }
 
 export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigAzureVmConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The principal ID.
+   * 
+   * @example
+   * 5dee234a-1b4c-4ad7-a19f-fxxxxx
+   */
   principalId?: string;
+  /**
+   * @remarks
+   * The Azure resource group name.
+   * 
+   * @example
+   * user_default
+   */
   resourceGroupName?: string;
+  /**
+   * @remarks
+   * The subscription ID.
+   * 
+   * @example
+   * 4342a1f4-7e5d-4371-97dc-d4f33f4xxxx
+   */
   subscriptionId?: string;
+  /**
+   * @remarks
+   * The list of virtual machine names.
+   */
   vmNames?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -78,11 +103,22 @@ export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigAz
 }
 
 export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigGcpVmConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The list of GCP virtual machine instance IDs.
+   */
   instanceIds?: string[];
+  /**
+   * @remarks
+   * The GCP project ID to which the resource belongs.
+   * 
+   * @example
+   * turnkey-axiom-475109-xx
+   */
   projectId?: string;
   /**
    * @remarks
-   * The sub claim that corresponds to the service account.
+   * The sub claim corresponding to the service account.
    * 
    * @example
    * 123456789
@@ -117,6 +153,13 @@ export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigGc
 }
 
 export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigGenericConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The subject.
+   * 
+   * @example
+   * test_subject
+   */
   subject?: string;
   static names(): { [key: string]: string } {
     return {
@@ -142,7 +185,7 @@ export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigGe
 export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigKubernetesConfig extends $dara.Model {
   /**
    * @remarks
-   * The Kubernetes namespace.
+   * The K8s namespace.
    * 
    * @example
    * default
@@ -158,7 +201,7 @@ export class CreateApplicationFederatedCredentialRequestOidcVerificationConfigKu
   podNamePrefix?: string;
   /**
    * @remarks
-   * The Kubernetes service account name.
+   * The K8s service account name.
    * 
    * @example
    * my-sa
@@ -200,6 +243,10 @@ export class CreateApplicationFederatedCredentialRequestOidcVerificationConfig e
    * The GCP VM scenario configuration.
    */
   gcpVmConfig?: CreateApplicationFederatedCredentialRequestOidcVerificationConfigGcpVmConfig;
+  /**
+   * @remarks
+   * The generic scenario configuration.
+   */
   genericConfig?: CreateApplicationFederatedCredentialRequestOidcVerificationConfigGenericConfig;
   /**
    * @remarks
@@ -208,8 +255,7 @@ export class CreateApplicationFederatedCredentialRequestOidcVerificationConfig e
   kubernetesConfig?: CreateApplicationFederatedCredentialRequestOidcVerificationConfigKubernetesConfig;
   /**
    * @remarks
-   * The OIDC scenario profile. Valid values:
-   * 
+   * The OIDC scenario profile. Different profiles correspond to different configurations. Valid values:
    * - generic
    * - kubernetes
    * - gcp_vm
@@ -261,6 +307,10 @@ export class CreateApplicationFederatedCredentialRequestOidcVerificationConfig e
 }
 
 export class CreateApplicationFederatedCredentialRequestPkcs7VerificationConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The list of instance IDs.
+   */
   instanceIds?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -289,7 +339,7 @@ export class CreateApplicationFederatedCredentialRequestPkcs7VerificationConfig
 export class CreateApplicationFederatedCredentialRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the application federated identity credential.
+   * The application federated credential name.
    * 
    * This parameter is required.
    * 
@@ -299,7 +349,7 @@ export class CreateApplicationFederatedCredentialRequest extends $dara.Model {
   applicationFederatedCredentialName?: string;
   /**
    * @remarks
-   * The type of the application federated identity credential.
+   * The application federated credential type.
    * 
    * This parameter is required.
    * 
@@ -352,12 +402,12 @@ export class CreateApplicationFederatedCredentialRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The OIDC structured configuration. This parameter applies when the verification mode is structured and the credential type is oidc.
+   * The OIDC structured configuration.
    */
   oidcVerificationConfig?: CreateApplicationFederatedCredentialRequestOidcVerificationConfig;
   /**
    * @remarks
-   * The PKCS#7 structured configuration. This parameter applies when the verification mode is structured and the credential type is pkcs7.
+   * The PKCS#7 structured configuration.
    */
   pkcs7VerificationConfig?: CreateApplicationFederatedCredentialRequestPkcs7VerificationConfig;
   /**
@@ -371,9 +421,8 @@ export class CreateApplicationFederatedCredentialRequest extends $dara.Model {
   /**
    * @remarks
    * The verification mode. Valid values:
-   * 
-   * - freedom (default)
-   * - structured
+   * - freedom: free mode
+   * - structured: structured mode
    * 
    * @example
    * freedom

package/src/models/CreateApplicationFederatedCredentialResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateApplicationFederatedCredentialResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The application federated identity credential ID.
+   * The application federated credential ID.
    * 
    * @example
    * afc_asd123daxxxx

package/src/models/CreateCloudAccountRequest.ts

@@ -59,7 +59,7 @@ export class CreateCloudAccountRequest extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * Alibaba_cloud(Alibaba Cloud)
+   * alibaba_cloud(Alibaba Cloud)
    */
   cloudAccountVendorType?: string;
   /**

package/src/models/CreateTrustedOriginRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateTrustedOriginRequest 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 token can contain only ASCII characters and cannot exceed 64 characters in length.
+   * 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 value of ClientToken can contain only ASCII characters and cannot exceed 64 characters in length.
    * 
    * @example
    * client-token-example

package/src/models/GetApplicationFederatedCredentialResponseBody.ts

@@ -43,9 +43,34 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
 }
 
 export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCredentialOidcVerificationConfigAzureVmConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The principal ID.
+   * 
+   * @example
+   * 5dee234a-1b4c-4ad7-a19f-fxxxxx
+   */
   principalId?: string;
+  /**
+   * @remarks
+   * The Azure resource group name.
+   * 
+   * @example
+   * user_default
+   */
   resourceGroupName?: string;
+  /**
+   * @remarks
+   * The subscription ID.
+   * 
+   * @example
+   * 4342a1f4-7e5d-4371-97dc-d4f33f4xxxx
+   */
   subscriptionId?: string;
+  /**
+   * @remarks
+   * The list of virtual machine names.
+   */
   vmNames?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -80,13 +105,23 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
 export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCredentialOidcVerificationConfigGcpVmConfig extends $dara.Model {
   /**
    * @remarks
-   * The list of VM instance IDs. A maximum of 10 instance IDs are supported.
+   * The list of VM instance IDs.
    */
   instanceIds?: string[];
+  /**
+   * @remarks
+   * The GCP project ID.
+   * 
+   * @example
+   * turnkey-axiom-475109-xx
+   */
   projectId?: string;
   /**
    * @remarks
-   * The service account ID that corresponds to the sub claim.
+   * The subject corresponding to the service account.
+   * 
+   * @example
+   * 123456789
    */
   serviceAccountId?: string;
   static names(): { [key: string]: string } {
@@ -118,6 +153,13 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
 }
 
 export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCredentialOidcVerificationConfigGenericConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The subject identifier.
+   * 
+   * @example
+   * test_subject
+   */
   subject?: string;
   static names(): { [key: string]: string } {
     return {
@@ -143,17 +185,26 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
 export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCredentialOidcVerificationConfigKubernetesConfig extends $dara.Model {
   /**
    * @remarks
-   * The Kubernetes namespace.
+   * The K8s namespace.
+   * 
+   * @example
+   * default
    */
   namespace?: string;
   /**
    * @remarks
    * The pod name prefix.
+   * 
+   * @example
+   * test-pod
    */
   podNamePrefix?: string;
   /**
    * @remarks
-   * The Kubernetes service account name.
+   * The K8s service account name.
+   * 
+   * @example
+   * default
    */
   serviceAccountName?: string;
   static names(): { [key: string]: string } {
@@ -192,6 +243,10 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
    * The GCP VM scenario configuration.
    */
   gcpVmConfig?: GetApplicationFederatedCredentialResponseBodyApplicationFederatedCredentialOidcVerificationConfigGcpVmConfig;
+  /**
+   * @remarks
+   * The generic scenario configuration.
+   */
   genericConfig?: GetApplicationFederatedCredentialResponseBodyApplicationFederatedCredentialOidcVerificationConfigGenericConfig;
   /**
    * @remarks
@@ -200,7 +255,14 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
   kubernetesConfig?: GetApplicationFederatedCredentialResponseBodyApplicationFederatedCredentialOidcVerificationConfigKubernetesConfig;
   /**
    * @remarks
-   * The OIDC scenario profile. Valid values: generic, kubernetes, gcp_vm, and azure_vm.
+   * The OIDC scenario profile. Different profiles correspond to different configurations. Valid values:
+   * - generic
+   * - kubernetes
+   * - gcp_vm
+   * - azure_vm
+   * 
+   * @example
+   * kubernetes
    */
   profile?: string;
   static names(): { [key: string]: string } {
@@ -247,7 +309,7 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
 export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCredentialPkcs7VerificationConfig extends $dara.Model {
   /**
    * @remarks
-   * The list of allowed instance IDs. A maximum of 10 instance IDs are supported.
+   * The list of allowed instance IDs.
    */
   instanceIds?: string[];
   static names(): { [key: string]: string } {
@@ -314,7 +376,7 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
   attributeMappings?: GetApplicationFederatedCredentialResponseBodyApplicationFederatedCredentialAttributeMappings[];
   /**
    * @remarks
-   * The time when the credential was created.
+   * The creation time.
    * 
    * @example
    * 1758785994982
@@ -346,7 +408,7 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
   instanceId?: string;
   /**
    * @remarks
-   * The time when the credential was last used.
+   * The last used time.
    * 
    * @example
    * 1758785994982
@@ -354,12 +416,12 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
   lastUsedTime?: number;
   /**
    * @remarks
-   * The OIDC structured configuration. This parameter applies when the verification mode is structured and the credential type is oidc.
+   * The OIDC structured configuration.
    */
   oidcVerificationConfig?: GetApplicationFederatedCredentialResponseBodyApplicationFederatedCredentialOidcVerificationConfig;
   /**
    * @remarks
-   * The PKCS#7 structured configuration. This parameter applies when the verification mode is structured and the credential type is pkcs7.
+   * The PKCS#7 structured configuration.
    */
   pkcs7VerificationConfig?: GetApplicationFederatedCredentialResponseBodyApplicationFederatedCredentialPkcs7VerificationConfig;
   /**
@@ -372,7 +434,7 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
   status?: string;
   /**
    * @remarks
-   * The time when the credential was last updated.
+   * The update time.
    * 
    * @example
    * 1758785994982
@@ -388,7 +450,12 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
   verificationCondition?: string;
   /**
    * @remarks
-   * The verification mode. Valid values: freedom and structured.
+   * The verification mode. Valid values:
+   * - freedom: Free mode.
+   * - structured: Structured mode.
+   * 
+   * @example
+   * structured
    */
   verificationMode?: string;
   static names(): { [key: string]: string } {

package/src/models/GetAuthorizationRuleResponseBody.ts

@@ -41,7 +41,12 @@ export class GetAuthorizationRuleResponseBodyAuthorizationRule extends $dara.Mod
   authorizationRuleName?: string;
   /**
    * @remarks
-   * The scenario label of the authorization rule.
+   * The scenario label of the authorization rule. Valid values:
+   * - privileged_cloud_account: Privileged cloud account scenario.
+   * - asset: Asset scenario.
+   * 
+   * @example
+   * Asset
    */
   authorizationRuleScenarioLabel?: string;
   /**
@@ -74,7 +79,7 @@ export class GetAuthorizationRuleResponseBodyAuthorizationRule extends $dara.Mod
   authorizationRuleSubjectType?: string;
   /**
    * @remarks
-   * The creation time, in UNIX timestamp format, measured in milliseconds.
+   * The creation time, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1652085686179
@@ -116,7 +121,7 @@ export class GetAuthorizationRuleResponseBodyAuthorizationRule extends $dara.Mod
   status?: string;
   /**
    * @remarks
-   * The last update time, in UNIX timestamp format, measured in milliseconds.
+   * The last update time, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1652085686179

package/src/models/GetBrandRequest.ts

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

package/src/models/GetBrandResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetBrandResponseBodyBrand extends $dara.Model {
   /**
    * @remarks
-   * Brand ID.
+   * The brand ID.
    * 
    * @example
    * brand_xxxx
@@ -13,7 +13,7 @@ export class GetBrandResponseBodyBrand extends $dara.Model {
   brandId?: string;
   /**
    * @remarks
-   * Brand name.
+   * The brand name.
    * 
    * @example
    * Custom Brand
@@ -21,7 +21,7 @@ export class GetBrandResponseBodyBrand extends $dara.Model {
   brandName?: string;
   /**
    * @remarks
-   * Brand type.
+   * The brand type.
    * 
    * @example
    * user_custom
@@ -29,7 +29,7 @@ export class GetBrandResponseBodyBrand extends $dara.Model {
   brandType?: string;
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
@@ -37,19 +37,37 @@ export class GetBrandResponseBodyBrand extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * Brand status.
+   * The SMS gateway ID.
+   * 
+   * @example
+   * smsgw_01l9f0kunrrjhxxx
+   */
+  smsGatewayId?: string;
+  /**
+   * @remarks
+   * The brand status.
    * 
    * @example
    * enabled
    */
   status?: string;
+  /**
+   * @remarks
+   * The enabling status of system notifications.
+   * 
+   * @example
+   * enabled
+   */
+  systemNotificationStatus?: string;
   static names(): { [key: string]: string } {
     return {
       brandId: 'BrandId',
       brandName: 'BrandName',
       brandType: 'BrandType',
       instanceId: 'InstanceId',
+      smsGatewayId: 'SmsGatewayId',
       status: 'Status',
+      systemNotificationStatus: 'SystemNotificationStatus',
     };
   }
 
@@ -59,7 +77,9 @@ export class GetBrandResponseBodyBrand extends $dara.Model {
       brandName: 'string',
       brandType: 'string',
       instanceId: 'string',
+      smsGatewayId: 'string',
       status: 'string',
+      systemNotificationStatus: 'string',
     };
   }
 
@@ -75,12 +95,12 @@ export class GetBrandResponseBodyBrand extends $dara.Model {
 export class GetBrandResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Brand.
+   * The brand.
    */
   brand?: GetBrandResponseBodyBrand;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A

package/src/models/GetCloudAccountResponseBody.ts

@@ -13,7 +13,7 @@ export class GetCloudAccountResponseBodyCloudAccountCloudAccountHealthCheckResul
   errorCode?: string;
   /**
    * @remarks
-   * The error description.
+   * The error message.
    * 
    * @example
    * There is no permission.
@@ -45,7 +45,7 @@ export class GetCloudAccountResponseBodyCloudAccountCloudAccountHealthCheckResul
 export class GetCloudAccountResponseBodyCloudAccountCloudAccountHealthCheckResult extends $dara.Model {
   /**
    * @remarks
-   * The error reason. This field is returned when the health check status is unhealthy.
+   * The error reason. This field returns a value when the health check status is unhealthy.
    */
   errorReason?: GetCloudAccountResponseBodyCloudAccountCloudAccountHealthCheckResultErrorReason;
   /**
@@ -159,11 +159,17 @@ export class GetCloudAccountResponseBodyCloudAccountPrivilegeHostingError extend
   /**
    * @remarks
    * The failure error code.
+   * 
+   * @example
+   * Error
    */
   errorCode?: string;
   /**
    * @remarks
    * The failure message.
+   * 
+   * @example
+   * test message
    */
   errorMessage?: string;
   static names(): { [key: string]: string } {
@@ -232,7 +238,7 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
   cloudAccountName?: string;
   /**
    * @remarks
-   * The identity provider configuration.
+   * The identity provider configuration information.
    */
   cloudAccountProviderConfig?: GetCloudAccountResponseBodyCloudAccountCloudAccountProviderConfig;
   /**
@@ -243,10 +249,22 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
    * idaas-eiam-oidc-provider
    */
   cloudAccountProviderName?: string;
+  /**
+   * @remarks
+   * The cloud account role creation type.
+   * 
+   * @example
+   * test
+   */
   cloudAccountRoleCreationType?: string;
   /**
    * @remarks
-   * The cloud account site.
+   * The cloud account site. Valid values:
+   * - china_mainland: The Chinese mainland.
+   * - global: Global.
+   * 
+   * @example
+   * china_mainland
    */
   cloudAccountSite?: string;
   /**
@@ -295,12 +313,26 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
   privilegeHostingError?: GetCloudAccountResponseBodyCloudAccountPrivilegeHostingError;
   /**
    * @remarks
-   * The privilege hosting state, which indicates whether the privilege capability is available.
+   * The hosting state of the cloud account. The default value is hosting_unmanaged. Valid values:
+   * - hosting_unmanaged: Unmanaged. The cloud account has not initiated hosting and is in the initial state.
+   * - hosting_pending: Hosting in progress. The hosting task has been submitted and is being executed asynchronously. Wait for the hosting process to complete before the final state is reached.
+   * - hosting_completed: Hosting completed. The cloud account hosting process was executed successfully. The related permission templates and hosting bindings have taken effect.
+   * - hosting_failed: Hosting failed. The hosting process encountered an exception. View the failure reason and re-initiate hosting.
+   * - hosting_removing: Removal in progress. The removal task has been submitted and is being executed asynchronously. Wait for the removal process to complete before the final state is reached.
+   * - hosting_remove_failed: Removal failed. The removal process encountered an exception. View the failure reason and re-initiate removal.
+   * 
+   * @example
+   * hosting_unmanaged
    */
   privilegeHostingState?: string;
   /**
    * @remarks
-   * The privilege switch status, which indicates whether the privilege capability is enabled.
+   * The privilege switch status. Valid values:
+   * - enabled: Enabled. The resource is active and can be used normally.
+   * - disabled: Disabled. The resource is deactivated and no longer takes effect. You can re-enable it to restore functionality.
+   * 
+   * @example
+   * enabled
    */
   privilegeStatus?: string;
   /**

package/src/models/GetCloudAccountRoleResponseBody.ts

@@ -105,6 +105,15 @@ export class GetCloudAccountRoleResponseBodyCloudAccountRole extends $dara.Model
    * ca_01kmegjc11qa1txxxxx
    */
   cloudAccountId?: string;
+  /**
+   * @remarks
+   * The creation source. Valid values:
+   * - system_init: system-created. The role is automatically generated by the platform as a preset and typically cannot be modified or deleted.
+   * - user_custom: user-created. The role is manually created by a user and can be edited and managed throughout its lifecycle.
+   * 
+   * @example
+   * user_custom
+   */
   cloudAccountRoleCreationType?: string;
   /**
    * @remarks

package/src/models/ListApplicationFederatedCredentialsForProviderRequest.ts

@@ -23,7 +23,7 @@ export class ListApplicationFederatedCredentialsForProviderRequest extends $dara
   instanceId?: string;
   /**
    * @remarks
-   * The maximum number of entries to return per page in a paged query. This parameter is used for paging.
+   * The maximum number of entries per page for a paged query.
    * 
    * @example
    * 20
@@ -31,7 +31,7 @@ export class ListApplicationFederatedCredentialsForProviderRequest extends $dara
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token.
+   * The pagination token for the next page.
    * 
    * @example
    * NTxxxxxexample
@@ -39,7 +39,7 @@ export class ListApplicationFederatedCredentialsForProviderRequest extends $dara
   nextToken?: string;
   /**
    * @remarks
-   * The token used to retrieve the previous page.
+   * The pagination token for the previous page.
    * 
    * @example
    * PTxxxxxexample