@alicloud/eiam20211201 2.19.2 → 3.0.0

package/src/models/GetApplicationResponseBody.ts

@@ -3,7 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetApplicationResponseBodyApplicationApplicationOwner extends $dara.Model {
+  /**
+   * @remarks
+   * The list of group scopes for synchronization authorization.
+   */
   groupIds?: string[];
+  /**
+   * @remarks
+   * The list of user IDs.
+   */
   userIds?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -35,7 +43,21 @@ export class GetApplicationResponseBodyApplicationApplicationOwner extends $dara
 }
 
 export class GetApplicationResponseBodyApplicationCustomFields extends $dara.Model {
+  /**
+   * @remarks
+   * The identifier of the application custom field.
+   * 
+   * @example
+   * agent_source_id
+   */
   fieldName?: string;
+  /**
+   * @remarks
+   * The value of the application custom field. When FieldName is set to agentType, valid values are bailian, pai, dify, and volcano. When FieldName is set to agentExternalId, enter the corresponding value.
+   * 
+   * @example
+   * 38899
+   */
   fieldValue?: string;
   static names(): { [key: string]: string } {
     return {
@@ -63,7 +85,7 @@ export class GetApplicationResponseBodyApplicationCustomFields extends $dara.Mod
 export class GetApplicationResponseBodyApplication extends $dara.Model {
   /**
    * @remarks
-   * The status of the Developer API feature for the application. Valid values:
+   * The Developer API feature status of the application. Valid values:
    * - enabled: Enabled.
    * - disabled: Disabled.
    * 
@@ -102,9 +124,13 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
    * The application name.
    * 
    * @example
-   * SAML application
+   * SAML Application
    */
   applicationName?: string;
+  /**
+   * @remarks
+   * The application owner.
+   */
   applicationOwner?: GetApplicationResponseBodyApplicationApplicationOwner;
   /**
    * @remarks
@@ -118,7 +144,7 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   applicationSourceType?: string;
   /**
    * @remarks
-   * The ID of the application template associated during creation. This value is returned only when the application was created from an application template.
+   * The application template ID associated during creation. This value is returned only when the application was created from an application template.
    * 
    * @example
    * apt_rpa_tdsxxx
@@ -149,16 +175,20 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   clientId?: string;
   /**
    * @remarks
-   * The time when the application was created. The value is a UNIX timestamp in milliseconds.
+   * The time when the application was created, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1649830226000
    */
   createTime?: number;
+  /**
+   * @remarks
+   * The list of application custom fields.
+   */
   customFields?: GetApplicationResponseBodyApplicationCustomFields[];
   /**
    * @remarks
-   * Indicates whether the custom Subject field in the token is enabled. After this feature is enabled, the issued Access Token changes from \\<clientId\\> to \\<clientId\\>:\\<client.activeSubjectUrn\\>, where client.activeSubjectUrn is configured in the attribute mapping of the federated identity credential of the application.
+   * Indicates whether the custom Subject field in the token is enabled. After this feature is enabled, the issued Access Token changes from <clientId> to <clientId>:<client.activeSubjectUrn>, where client.activeSubjectUrn is configured in the attribute mapping of the federated identity credential of the application.
    * 
    * @example
    * enabled
@@ -169,7 +199,7 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
    * The application description.
    * 
    * @example
-   * An application for test environment
+   * An application for the test environment
    */
   description?: string;
   /**
@@ -217,7 +247,7 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   managedServiceCode?: string;
   /**
    * @remarks
-   * The unique identifier of the ResourceServer, which corresponds to the ResourceServer audience.
+   * The unique identifier of the ResourceServer, corresponding to the ResourceServer audience.
    * 
    * @example
    * https://www.example.com
@@ -247,6 +277,10 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
    * true
    */
   serviceManaged?: boolean;
+  /**
+   * @remarks
+   * The list of capabilities configured through smart configuration.
+   */
   smartConfigCapabilities?: string[];
   /**
    * @remarks
@@ -272,7 +306,7 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The time when the application was last updated. The value is a UNIX timestamp in milliseconds.
+   * The time when the application was last updated, in UNIX timestamp format. Unit: milliseconds.
    * 
    * @example
    * 1649830226000

package/src/models/GetApplicationTemplateRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetApplicationTemplateRequest extends $dara.Model {
   /**
    * @remarks
-   * The application template ID.
+   * The ID of the application template.
    * 
    * This parameter is required.
    * 

package/src/models/GetApplicationTemplateResponseBody.ts

@@ -35,7 +35,7 @@ export class GetApplicationTemplateResponseBodyApplicationTemplateSaleInfo exten
 export class GetApplicationTemplateResponseBodyApplicationTemplate extends $dara.Model {
   /**
    * @remarks
-   * The application template ID.
+   * The ID of the application template.
    * 
    * @example
    * apt_ramintlrole_ixxxxx
@@ -43,7 +43,7 @@ export class GetApplicationTemplateResponseBodyApplicationTemplate extends $dara
   applicationTemplateId?: string;
   /**
    * @remarks
-   * The application template name.
+   * The name of the application template.
    * 
    * @example
    * Alibaba Cloud
@@ -51,7 +51,7 @@ export class GetApplicationTemplateResponseBodyApplicationTemplate extends $dara
   applicationTemplateName?: string;
   /**
    * @remarks
-   * The time when the application template was created.
+   * The creation time of the application template. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1730341123000
@@ -59,7 +59,7 @@ export class GetApplicationTemplateResponseBodyApplicationTemplate extends $dara
   createTime?: number;
   /**
    * @remarks
-   * The application template description.
+   * The description of the application template.
    * 
    * @example
    * Alibaba Cloud SSO
@@ -83,7 +83,7 @@ export class GetApplicationTemplateResponseBodyApplicationTemplate extends $dara
   logoUrl?: string;
   /**
    * @remarks
-   * The service code of the Alibaba Cloud service that manages the application template.
+   * The service code of the cloud service that manages the application template.
    * 
    * @example
    * bastionhost
@@ -96,7 +96,7 @@ export class GetApplicationTemplateResponseBodyApplicationTemplate extends $dara
   saleInfo?: GetApplicationTemplateResponseBodyApplicationTemplateSaleInfo;
   /**
    * @remarks
-   * The console URL of the Alibaba Cloud service that manages the application template.
+   * The console URL of the cloud service that manages the application template.
    * 
    * @example
    * https://example.com/?p=bastion
@@ -104,7 +104,7 @@ export class GetApplicationTemplateResponseBodyApplicationTemplate extends $dara
   serviceConsoleUrl?: string;
   /**
    * @remarks
-   * Indicates whether the application template is managed by an Alibaba Cloud service.
+   * Indicates whether the application template is managed by a cloud service.
    * 
    * @example
    * true
@@ -117,7 +117,7 @@ export class GetApplicationTemplateResponseBodyApplicationTemplate extends $dara
   ssoTypes?: string[];
   /**
    * @remarks
-   * The time when the application template was last updated.
+   * The update time of the application template. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1730341124000

package/src/models/GetAuthorizationServerResponseBody.ts

@@ -53,7 +53,7 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
   authorizationServerId?: string;
   /**
    * @remarks
-   * The name of the authorization server.
+   * The authorization server name.
    * 
    * @example
    * System_Default
@@ -61,7 +61,7 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
   authorizationServerName?: string;
   /**
    * @remarks
-   * The time when the authorization server was created.
+   * The time when the authorization server was created. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1754620108295
@@ -77,7 +77,7 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
   creationType?: string;
   /**
    * @remarks
-   * The description of the authorization server.
+   * The authorization server description.
    * 
    * @example
    * description of authorization server
@@ -93,7 +93,7 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
   instanceId?: string;
   /**
    * @remarks
-   * The issuer of the authorization token.
+   * The authorization token issuer.
    * 
    * @example
    * https://xxxx.aliyunidaas.com/api/v2/iauths_system/oauth2
@@ -117,7 +117,7 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
   issuerMode?: string;
   /**
    * @remarks
-   * The time when the authorization server was last updated.
+   * The time when the authorization server was last updated. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1781608572164
@@ -125,12 +125,12 @@ export class GetAuthorizationServerResponseBodyAuthorizationServer extends $dara
   lastUpdateTime?: number;
   /**
    * @remarks
-   * The endpoint configuration of the authorization server.
+   * The authorization server endpoint configuration.
    */
   protocolEndpoint?: GetAuthorizationServerResponseBodyAuthorizationServerProtocolEndpoint;
   /**
    * @remarks
-   * The status of the authorization server.
+   * The authorization server status.
    * 
    * @example
    * ENABLE

package/src/models/GetClientPublicKeyResponseBody.ts

@@ -29,7 +29,7 @@ export class GetClientPublicKeyResponseBodyClientPublicKey extends $dara.Model {
   clientPublicKeyId?: string;
   /**
    * @remarks
-   * The creation time.
+   * The creation time. The value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1731305755000
@@ -45,7 +45,7 @@ export class GetClientPublicKeyResponseBodyClientPublicKey extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The last time the key pair was used.
+   * The last used time. The value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1771305755000

package/src/models/GetCloudAccountResponseBody.ts

@@ -50,7 +50,7 @@ export class GetCloudAccountResponseBodyCloudAccountCloudAccountHealthCheckResul
   errorReason?: GetCloudAccountResponseBodyCloudAccountCloudAccountHealthCheckResultErrorReason;
   /**
    * @remarks
-   * The time of the last health check. The value is a UNIX timestamp in milliseconds.
+   * The time of the last check. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1649830226000
@@ -59,9 +59,8 @@ export class GetCloudAccountResponseBodyCloudAccountCloudAccountHealthCheckResul
   /**
    * @remarks
    * The health check result of the cloud account. Valid values:
-   * 
-   * - success: Succeeded.
-   * - failed: Failed.
+   * - success: The check succeeded.
+   * - failed: The check failed.
    * 
    * @example
    * success
@@ -106,7 +105,7 @@ export class GetCloudAccountResponseBodyCloudAccountCloudAccountProviderConfig e
   audience?: string;
   /**
    * @remarks
-   * The authorization server ID.
+   * The ID of the authorization server.
    * 
    * @example
    * iauths_system
@@ -114,7 +113,7 @@ export class GetCloudAccountResponseBodyCloudAccountCloudAccountProviderConfig e
   authorizationServerId?: string;
   /**
    * @remarks
-   * Issuer。
+   * The issuer.
    * 
    * @example
    * https://xxxxx.aliyunidaas.com/api/v2/iauths_system/oauth2
@@ -122,7 +121,7 @@ export class GetCloudAccountResponseBodyCloudAccountCloudAccountProviderConfig e
   issuer?: string;
   /**
    * @remarks
-   * The signature verification public key endpoint.
+   * The public key endpoint for signature verification.
    * 
    * @example
    * https://xxxxx.aliyunidaas.com/api/v2/iauths_system/oauth2/jwks
@@ -158,7 +157,7 @@ export class GetCloudAccountResponseBodyCloudAccountCloudAccountProviderConfig e
 export class GetCloudAccountResponseBodyCloudAccountPrivilegeHostingError extends $dara.Model {
   /**
    * @remarks
-   * The failure error code.
+   * The error code of the failure.
    * 
    * @example
    * Error
@@ -166,7 +165,7 @@ export class GetCloudAccountResponseBodyCloudAccountPrivilegeHostingError extend
   errorCode?: string;
   /**
    * @remarks
-   * The failure message.
+   * The error message of the failure.
    * 
    * @example
    * test message
@@ -207,9 +206,9 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
   /**
    * @remarks
    * The health status of the cloud account. Valid values:
-   * - healthy: Healthy.
-   * - unhealthy: Unhealthy.
-   * - unknown: Unknown.
+   * - healthy: The cloud account is healthy.
+   * - unhealthy: The cloud account is unhealthy.
+   * - unknown: The health status is unknown.
    * 
    * @example
    * healthy
@@ -230,7 +229,7 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
   cloudAccountId?: string;
   /**
    * @remarks
-   * The cloud account name.
+   * The name of the cloud account.
    * 
    * @example
    * cloud_accout_xxxx
@@ -238,12 +237,12 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
   cloudAccountName?: string;
   /**
    * @remarks
-   * The identity provider configuration information.
+   * The configuration information of the identity provider.
    */
   cloudAccountProviderConfig?: GetCloudAccountResponseBodyCloudAccountCloudAccountProviderConfig;
   /**
    * @remarks
-   * The identity provider name.
+   * The name of the identity provider.
    * 
    * @example
    * idaas-eiam-oidc-provider
@@ -251,15 +250,7 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
   cloudAccountProviderName?: string;
   /**
    * @remarks
-   * The cloud account role creation type.
-   * 
-   * @example
-   * test
-   */
-  cloudAccountRoleCreationType?: string;
-  /**
-   * @remarks
-   * The cloud account site. Valid values:
+   * The site of the cloud account. Valid values:
    * - china_mainland: The Chinese mainland.
    * - global: Global.
    * 
@@ -269,8 +260,7 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
   cloudAccountSite?: string;
   /**
    * @remarks
-   * The cloud account type. Valid values:
-   * 
+   * The type of the cloud account. Valid values:
    * - alibaba_cloud: Alibaba Cloud.
    * 
    * @example
@@ -287,7 +277,7 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
   createTime?: number;
   /**
    * @remarks
-   * The cloud account description.
+   * The description of the cloud account.
    * 
    * @example
    * cloud_accout_description
@@ -303,23 +293,23 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The list of associated privilege application IDs.
+   * The list of associated privileged application IDs.
    */
   privilegeApplicationIds?: string[];
   /**
    * @remarks
-   * The reason for the privilege hosting or removal failure.
+   * The cause of the privilege hosting or removal failure.
    */
   privilegeHostingError?: GetCloudAccountResponseBodyCloudAccountPrivilegeHostingError;
   /**
    * @remarks
-   * The hosting state of the cloud account. The default value is hosting_unmanaged. Valid values:
+   * The hosting status of the cloud account. Default value: 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.
+   * - hosting_pending: Hosting. The hosting task has been submitted and is being executed asynchronously. Wait for the hosting process to complete to enter the final state.
+   * - hosting_completed: Hosting completed. The cloud account hosting process is executed successfully, and the relevant permission templates and hosting bindings have taken effect.
+   * - hosting_failed: Hosting failed. The hosting process encounters an exception. You can view the cause of the failure and initiate hosting again.
+   * - hosting_removing: Removing. The removal task has been submitted and is being executed asynchronously. Wait for the removal process to complete to enter the final state.
+   * - hosting_remove_failed: Removal failed. The removal process encounters an exception. You can view the cause of the failure and initiate removal again.
    * 
    * @example
    * hosting_unmanaged
@@ -327,9 +317,9 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
   privilegeHostingState?: string;
   /**
    * @remarks
-   * 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.
+   * The status of the privilege switch. Valid values:
+   * - enabled: Enabled. The resource is in the effective state and can be used normally.
+   * - disabled: Disabled. The resource is in the stopped state and no longer takes effect. You can enable it again to restore it.
    * 
    * @example
    * enabled
@@ -352,7 +342,6 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
       cloudAccountName: 'CloudAccountName',
       cloudAccountProviderConfig: 'CloudAccountProviderConfig',
       cloudAccountProviderName: 'CloudAccountProviderName',
-      cloudAccountRoleCreationType: 'CloudAccountRoleCreationType',
       cloudAccountSite: 'CloudAccountSite',
       cloudAccountVendorType: 'CloudAccountVendorType',
       createTime: 'CreateTime',
@@ -375,7 +364,6 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
       cloudAccountName: 'string',
       cloudAccountProviderConfig: GetCloudAccountResponseBodyCloudAccountCloudAccountProviderConfig,
       cloudAccountProviderName: 'string',
-      cloudAccountRoleCreationType: 'string',
       cloudAccountSite: 'string',
       cloudAccountVendorType: 'string',
       createTime: 'number',

package/src/models/GetConditionalAccessPolicyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetConditionalAccessPolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * Conditional access policy ID.
+   * The conditional access policy ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetConditionalAccessPolicyRequest extends $dara.Model {
   conditionalAccessPolicyId?: string;
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
    * This parameter is required.
    *