@alicloud/eiam20211201 2.19.3 → 3.0.0

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.
    * 

package/src/models/GetConditionalAccessPolicyResponseBody.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyConditionsConfigApplications extends $dara.Model {
   /**
    * @remarks
-   * Excluded applications.
+   * The excluded applications.
    */
   excludeApplications?: string[];
   /**
    * @remarks
-   * Included applications.
+   * The included applications.
    */
   includeApplications?: string[];
   static names(): { [key: string]: string } {
@@ -45,12 +45,12 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyCondit
 export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyConditionsConfigNetworkZones extends $dara.Model {
   /**
    * @remarks
-   * Excluded network ranges.
+   * The excluded network zones.
    */
   excludeNetworkZones?: string[];
   /**
    * @remarks
-   * Included network ranges.
+   * The included network zones.
    */
   includeNetworkZones?: string[];
   static names(): { [key: string]: string } {
@@ -85,32 +85,32 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyCondit
 export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyConditionsConfigUsers extends $dara.Model {
   /**
    * @remarks
-   * Excluded user groups.
+   * The excluded user groups.
    */
   excludeGroups?: string[];
   /**
    * @remarks
-   * Excluded organizations.
+   * The excluded organizational units.
    */
   excludeOrganizationalUnits?: string[];
   /**
    * @remarks
-   * Excluded users.
+   * The excluded users.
    */
   excludeUsers?: string[];
   /**
    * @remarks
-   * Included user groups.
+   * The included user groups.
    */
   includeGroups?: string[];
   /**
    * @remarks
-   * Included organizations.
+   * The included organizational units.
    */
   includeOrganizationalUnits?: string[];
   /**
    * @remarks
-   * Included users.
+   * The included users.
    */
   includeUsers?: string[];
   static names(): { [key: string]: string } {
@@ -165,17 +165,17 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyCondit
 export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyConditionsConfig extends $dara.Model {
   /**
    * @remarks
-   * Target applications of the conditional access policy.
+   * The target applications of the conditional access policy.
    */
   applications?: GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyConditionsConfigApplications;
   /**
    * @remarks
-   * Network zones of the conditional access policy.
+   * The network zones of the conditional access policy.
    */
   networkZones?: GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyConditionsConfigNetworkZones;
   /**
    * @remarks
-   * Target users of the conditional access policy.
+   * The target users of the conditional access policy.
    */
   users?: GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyConditionsConfigUsers;
   static names(): { [key: string]: string } {
@@ -215,7 +215,7 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyCondit
 export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyDecisionConfig extends $dara.Model {
   /**
    * @remarks
-   * Whether session reuse is enabled.
+   * Indicates whether session reuse is enabled.
    * 
    * @example
    * enabled
@@ -223,7 +223,7 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyDecisi
   activeSessionReuseStatus?: string;
   /**
    * @remarks
-   * Decision action of the conditional access policy.
+   * The decision action of the conditional access policy.
    * 
    * @example
    * allow
@@ -231,7 +231,7 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyDecisi
   effect?: string;
   /**
    * @remarks
-   * Re-authentication interval (seconds) of the conditional access policy.
+   * The interval in seconds for MFA re-authentication in the conditional access policy.
    * 
    * @example
    * 300
@@ -239,12 +239,12 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyDecisi
   mfaAuthenticationIntervalSeconds?: number;
   /**
    * @remarks
-   * Allowed MFA types of the conditional access policy.
+   * The MFA types allowed by the conditional access policy.
    */
   mfaAuthenticationMethods?: string[];
   /**
    * @remarks
-   * MFA authentication type of the conditional access policy.
+   * The MFA authentication type of the conditional access policy.
    * 
    * @example
    * directly_access
@@ -285,7 +285,7 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyDecisi
 export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicy extends $dara.Model {
   /**
    * @remarks
-   * Conditional access policy ID.
+   * The conditional access policy ID.
    * 
    * @example
    * cp_xxxxx
@@ -293,15 +293,15 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicy exten
   conditionalAccessPolicyId?: string;
   /**
    * @remarks
-   * Conditional access policy name.
+   * The Policy Name of the conditional access policy.
    * 
    * @example
-   * My policy
+   * MyPolicy
    */
   conditionalAccessPolicyName?: string;
   /**
    * @remarks
-   * Conditional access policy type.
+   * The type of the conditional access policy.
    * 
    * @example
    * arn:alibaba:idaas:authn:access:policy:system
@@ -309,12 +309,12 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicy exten
   conditionalAccessPolicyType?: string;
   /**
    * @remarks
-   * Conditional access policy content.
+   * The conditions configuration of the conditional access policy.
    */
   conditionsConfig?: GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyConditionsConfig;
   /**
    * @remarks
-   * Creation time.
+   * The time when the conditional access policy was created. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1741857554000
@@ -322,12 +322,12 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicy exten
   createTime?: number;
   /**
    * @remarks
-   * Execution action of the conditional access policy.
+   * The decision action configuration of the conditional access policy.
    */
   decisionConfig?: GetConditionalAccessPolicyResponseBodyConditionalAccessPolicyDecisionConfig;
   /**
    * @remarks
-   * Execution type of the conditional access policy.
+   * The decision type of the conditional access policy.
    * 
    * @example
    * enforcement
@@ -335,7 +335,7 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicy exten
   decisionType?: string;
   /**
    * @remarks
-   * Conditional access policy description.
+   * The description of the conditional access policy.
    * 
    * @example
    * ga access port for ecs: internal-cn-hangzhou-docker-builder-2(i-bp19g1pheaailkk1xvr6)
@@ -343,7 +343,7 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicy exten
   description?: string;
   /**
    * @remarks
-   * Evaluation point of the conditional access policy.
+   * The evaluation point of the conditional access policy.
    * 
    * @example
    * arn:alibaba:idaas:authn:access:rule:eval_at:after_step1
@@ -351,7 +351,7 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicy exten
   evaluateAt?: string;
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
    * @example
    * idaas_qnx6fbrinlecptl5hld23lfkvy
@@ -359,7 +359,7 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicy exten
   instanceId?: string;
   /**
    * @remarks
-   * Update time.
+   * The time when the conditional access policy was last updated. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1741857554000
@@ -367,7 +367,7 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicy exten
   lastUpdatedTime?: number;
   /**
    * @remarks
-   * Priority.
+   * The priority of the conditional access policy.
    * 
    * @example
    * 5
@@ -375,7 +375,7 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicy exten
   priority?: number;
   /**
    * @remarks
-   * Enabled or disabled status of the conditional access policy.
+   * The enabled or disabled status of the conditional access policy.
    * 
    * @example
    * enabled
@@ -435,12 +435,12 @@ export class GetConditionalAccessPolicyResponseBodyConditionalAccessPolicy exten
 export class GetConditionalAccessPolicyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Details of the conditional access policy.
+   * The details of the conditional access policy.
    */
   conditionalAccessPolicy?: GetConditionalAccessPolicyResponseBodyConditionalAccessPolicy;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A

package/src/models/GetCredentialProviderResponseBody.ts

@@ -10,7 +10,7 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
   allowedTokenIssuers?: string[];
   /**
    * @remarks
-   * Specifies whether to enable the JWT derived short token capability.
+   * Indicates whether the JWT derived short token feature is enabled.
    * 
    * @example
    * false
@@ -26,7 +26,7 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
   expiration?: number;
   /**
    * @remarks
-   * Specifies whether to enable JWT expiration cleanup.
+   * Indicates whether JWT expiration cleanup is enabled.
    * 
    * @example
    * true
@@ -42,7 +42,7 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
   issuer?: string;
   /**
    * @remarks
-   * The JWKs endpoint address.
+   * The JWKs endpoint URL.
    * 
    * @example
    * https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks
@@ -85,17 +85,25 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
 export class GetCredentialProviderResponseBodyCredentialProviderCredentialProviderConfigOAuthProviderConfig extends $dara.Model {
   /**
    * @remarks
-   * The endpoint address used to guide users through authorization. This parameter is conditionally required: it is required when AuthorizationFlow is set to user_federation and ProviderVendor is set to custom. For preset vendors, this value 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.
    * 
    * @example
    * client_id_example_xxx
@@ -103,30 +111,57 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
   clientId?: string;
   /**
    * @remarks
-   * The URL of the discovery document used to automatically obtain OAuth endpoint configurations. This parameter is conditionally optional: it is used when AuthorizationFlow is set to 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.
+   * Indicates whether Proof Key for Code Exchange (PKCE) is enabled.
+   * 
+   * @example
+   * true
    */
   pkceEnabled?: boolean;
   /**
    * @remarks
-   * The preset vendor or custom configuration. This parameter is 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 specifies the permission scope.
    * 
-   * > The scope configuration of the OAuth 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 of the credential provider is used for token issuance.
+   * > The scope configuration of the OAuth credential provider serves as the default value. If the scope parameter is not specified when you call the DeveloperAPI to obtain an OAuth access token, the scope configuration of the credential provider is used for token issuance.
    * 
    * >Notice: Multiple scope values are separated by spaces.
    * 
@@ -136,7 +171,10 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
   scope?: string;
   /**
    * @remarks
-   * The redirect URI automatically generated by the system when the credential provider is created. Configure this value as the redirect_uri in the OAuth provider.
+   * The system-generated redirect URI.
+   * 
+   * @example
+   * https://example.com/callback
    */
   systemRedirectUri?: string;
   /**
@@ -243,7 +281,7 @@ export class GetCredentialProviderResponseBodyCredentialProviderCredentialProvid
 export class GetCredentialProviderResponseBodyCredentialProvider extends $dara.Model {
   /**
    * @remarks
-   * The time when the credential provider was created. The value is a UNIX timestamp in milliseconds.
+   * The creation time of the credential provider. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1649830225000
@@ -329,7 +367,7 @@ export class GetCredentialProviderResponseBodyCredentialProvider extends $dara.M
   status?: string;
   /**
    * @remarks
-   * The time when the credential provider was last updated. The value is a UNIX timestamp in milliseconds.
+   * The update time of the credential provider. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1649830225000