@alicloud/eiam20211201 2.19.3 → 3.0.0

package/src/models/ListConditionalAccessPoliciesResponseBody.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesConditionsConfigApplications 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 ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesC
 export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesConditionsConfigNetworkZones extends $dara.Model {
   /**
    * @remarks
-   * Excluded network zones.
+   * The excluded network zones.
    */
   excludeNetworkZones?: string[];
   /**
    * @remarks
-   * Included network zones.
+   * The included network zones.
    */
   includeNetworkZones?: string[];
   static names(): { [key: string]: string } {
@@ -85,32 +85,32 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesC
 export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesConditionsConfigUsers extends $dara.Model {
   /**
    * @remarks
-   * Excluded user groups.
+   * The excluded user groups.
    */
   excludeGroups?: string[];
   /**
    * @remarks
-   * Excluded organizational units.
+   * 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 organizational units.
+   * 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 ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesC
 export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesConditionsConfig extends $dara.Model {
   /**
    * @remarks
-   * Conditional access policy target applications.
+   * The target applications of the conditional access policy.
    */
   applications?: ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesConditionsConfigApplications;
   /**
    * @remarks
-   * Conditional access policy network zones.
+   * The network zones of the conditional access policy.
    */
   networkZones?: ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesConditionsConfigNetworkZones;
   /**
    * @remarks
-   * Conditional access policy target users.
+   * The target users of the conditional access policy.
    */
   users?: ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesConditionsConfigUsers;
   static names(): { [key: string]: string } {
@@ -215,7 +215,7 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesC
 export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesDecisionConfig extends $dara.Model {
   /**
    * @remarks
-   * Whether to enable secondary authentication session reuse.
+   * Indicates whether secondary authentication session reuse is enabled.
    * 
    * @example
    * disabled
@@ -223,9 +223,9 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesD
   activeSessionReuseStatus?: string;
   /**
    * @remarks
-   * Conditional access policy decision action:
-   * deny: Deny access.
-   * allow: Allow access.
+   * The decision action of the conditional access policy. Valid values:
+   * - deny: Deny.
+   * - allow: Allow.
    * 
    * @example
    * deny
@@ -233,7 +233,7 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesD
   effect?: string;
   /**
    * @remarks
-   * Conditional access policy re-authentication interval (seconds), ranging from 300 to 86400.
+   * The MFA re-authentication interval of the conditional access policy, in seconds. Valid values: 300 to 86400.
    * 
    * @example
    * 300
@@ -241,12 +241,12 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesD
   mfaAuthenticationIntervalSeconds?: number;
   /**
    * @remarks
-   * MFA types allowed by the conditional access policy.
+   * The MFA methods allowed by the conditional access policy.
    */
   mfaAuthenticationMethods?: string[];
   /**
    * @remarks
-   * Conditional access policy MFA type.
+   * The MFA type of the conditional access policy.
    * 
    * @example
    * directly_access
@@ -287,7 +287,7 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesD
 export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPolicies extends $dara.Model {
   /**
    * @remarks
-   * Conditional access policy ID.
+   * The conditional access policy ID.
    * 
    * @example
    * cp_xxxxx
@@ -295,15 +295,15 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPolicies
   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
@@ -311,12 +311,12 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPolicies
   conditionalAccessPolicyType?: string;
   /**
    * @remarks
-   * Conditional access policy conditions.
+   * The conditions configuration of the conditional access policy.
    */
   conditionsConfig?: ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesConditionsConfig;
   /**
    * @remarks
-   * Creation time.
+   * The creation time. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1741857554000
@@ -324,12 +324,12 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPolicies
   createTime?: number;
   /**
    * @remarks
-   * Conditional access policy execution action.
+   * The decision action configuration of the conditional access policy.
    */
   decisionConfig?: ListConditionalAccessPoliciesResponseBodyConditionalAccessPoliciesDecisionConfig;
   /**
    * @remarks
-   * Conditional access policy execution type.
+   * The decision type of the conditional access policy.
    * 
    * @example
    * enforcement
@@ -337,7 +337,7 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPolicies
   decisionType?: string;
   /**
    * @remarks
-   * Conditional access policy description.
+   * The description of the conditional access policy.
    * 
    * @example
    * My policy description
@@ -345,7 +345,7 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPolicies
   description?: string;
   /**
    * @remarks
-   * Conditional access policy evaluation point.
+   * The evaluation point of the conditional access policy.
    * 
    * @example
    * arn:alibaba:idaas:authn:access:rule:eval_at:after_step1
@@ -353,7 +353,7 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPolicies
   evaluateAt?: string;
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
    * @example
    * idaas_ksvv5c7f2l6uzh6oqspeks23ni
@@ -361,7 +361,7 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPolicies
   instanceId?: string;
   /**
    * @remarks
-   * Update time.
+   * The update time. This value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1741857554000
@@ -369,7 +369,7 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPolicies
   lastUpdatedTime?: number;
   /**
    * @remarks
-   * Priority, ranging from 1 to 100.
+   * The priority. Valid values: 1 to 100.
    * 
    * @example
    * 1
@@ -377,7 +377,7 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPolicies
   priority?: number;
   /**
    * @remarks
-   * Conditional access policy enabled/disabled status.
+   * The enabled or disabled status of the conditional access policy.
    * 
    * @example
    * disabled
@@ -437,12 +437,12 @@ export class ListConditionalAccessPoliciesResponseBodyConditionalAccessPolicies
 export class ListConditionalAccessPoliciesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Collection of conditional access policies.
+   * The collection of conditional access policies.
    */
   conditionalAccessPolicies?: ListConditionalAccessPoliciesResponseBodyConditionalAccessPolicies[];
   /**
    * @remarks
-   * The query token value returned by this call.
+   * The query token (Token) value returned by this call.
    * 
    * @example
    * NTxxxexample
@@ -450,7 +450,7 @@ export class ListConditionalAccessPoliciesResponseBody extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * Previous page query token.
+   * The pagination token for the previous page.
    * 
    * @example
    * PTxxxxxexample
@@ -458,7 +458,7 @@ export class ListConditionalAccessPoliciesResponseBody extends $dara.Model {
   previousToken?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
@@ -466,7 +466,7 @@ export class ListConditionalAccessPoliciesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Total number of items in the list.
+   * The total number of entries in the list.
    * 
    * @example
    * 100

package/src/models/ListCredentialProvidersRequest.ts

@@ -7,6 +7,9 @@ export class ListCredentialProvidersRequestFilter extends $dara.Model {
    * @remarks
    * The filter condition name. Valid values:
    * 
+   * - CredentialProviderName: the credential provider name.
+   * - CredentialProviderIdentifier: the credential provider identifier.
+   * 
    * @example
    * CredentialProviderName
    */
@@ -70,7 +73,7 @@ export class ListCredentialProvidersRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The maximum number of entries per page for a paged query.
+   * The number of entries per page in a paged query.
    * 
    * @example
    * 20

package/src/models/ListCredentialProvidersResponseBody.ts

@@ -10,7 +10,7 @@ export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialPro
   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 ListCredentialProvidersResponseBodyCredentialProvidersCredentialPro
   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 ListCredentialProvidersResponseBodyCredentialProvidersCredentialPro
   issuer?: string;
   /**
    * @remarks
-   * The JWKs endpoint URL.
+   * The JWKS endpoint URL.
    * 
    * @example
    * https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks
@@ -85,14 +85,20 @@ export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialPro
 export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialProviderConfigOAuthProviderConfig extends $dara.Model {
   /**
    * @remarks
-   * The endpoint URL used to guide users through authorization. Conditionally required: this parameter 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).
+   * - m2m: Machine-to-machine.
+   * - user_federation: User federation.
+   * 
+   * @example
+   * m2m
    */
   authorizationFlow?: string;
   /**
@@ -105,36 +111,70 @@ export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialPro
   clientId?: string;
   /**
    * @remarks
-   * The URL of the discovery document used to automatically obtain OAuth endpoint configurations. Conditionally optional: 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 method used to generate the PKCE code_challenge. Default value: s256.
+   * The algorithm used to compute 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 PKCE is enabled.
+   * 
+   * @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 specifies the permission scope.
    * 
+   * > The scope configured 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 configured on the credential provider is used for token issuance.
+   * 
+   * >Notice: Multiple scope values are separated by spaces.
+   * 
    * @example
    * example:test_01 example:test_02
    */
   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;
   /**
@@ -199,7 +239,9 @@ export class ListCredentialProvidersResponseBodyCredentialProvidersCredentialPro
   OAuthProviderConfig?: ListCredentialProvidersResponseBodyCredentialProvidersCredentialProviderConfigOAuthProviderConfig;
   /**
    * @remarks
-   * The list of credential IDs that correspond to the sensitive configurations of the credential provider.
+   * The list of credential IDs that correspond to the sensitive configuration of the credential provider.
+   * 
+   * > The system securely stores the sensitive configuration of the credential provider as credentials.
    */
   providerCredentialIds?: string[];
   static names(): { [key: string]: string } {
@@ -254,6 +296,9 @@ export class ListCredentialProvidersResponseBodyCredentialProviders extends $dar
    * @remarks
    * The creation type of the credential provider. Valid values:
    * 
+   * - system_init: Created by the system.
+   * - user_custom: Created by the user.
+   * 
    * @example
    * user_custom
    */
@@ -286,6 +331,9 @@ export class ListCredentialProvidersResponseBodyCredentialProviders extends $dar
    * @remarks
    * The credential provider type. Valid values:
    * 
+   * - oauth: OAuth credential provider
+   * - jwt: JWT credential provider
+   * 
    * @example
    * oauth
    */
@@ -310,6 +358,9 @@ export class ListCredentialProvidersResponseBodyCredentialProviders extends $dar
    * @remarks
    * The credential provider status. Valid values:
    * 
+   * - enabled: Enabled.
+   * - disabled: Disabled.
+   * 
    * @example
    * enabled
    */
@@ -374,7 +425,7 @@ export class ListCredentialProvidersResponseBody extends $dara.Model {
   credentialProviders?: ListCredentialProvidersResponseBodyCredentialProviders[];
   /**
    * @remarks
-   * The maximum number of entries per page for a paged query.
+   * The number of entries per page in a paged query.
    * 
    * @example
    * 20
@@ -382,7 +433,7 @@ export class ListCredentialProvidersResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token returned in this call.
+   * The pagination token returned by this call.
    * 
    * @example
    * NTxxxexample

package/src/models/ListEiamInstancesResponseBody.ts

@@ -45,7 +45,12 @@ export class ListEiamInstancesResponseBodyInstances extends $dara.Model {
   instanceStatus?: string;
   /**
    * @remarks
-   * The instance version.
+   * The instance version. Valid values:
+   * 
+   * - EIAM 2~0: EIAM 2.0.
+   * - EIAM 1~0: EIAM 1.0.
+   * [_single.resp.200.props.Instances.items.InstanceVersion.enum.EIAM 2~0]EIAM 2.0
+   * [_single.resp.200.props.Instances.items.InstanceVersion.enum.EIAM 1~0]EIAM 1.0
    * 
    * @example
    * EIAM 2.0
@@ -77,7 +82,7 @@ export class ListEiamInstancesResponseBodyInstances extends $dara.Model {
   SSODomain?: string;
   /**
    * @remarks
-   * The time when the instance was created.
+   * The time when the instance was created. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1677810869300

package/src/models/ListFederatedCredentialProvidersRequest.ts

@@ -39,7 +39,7 @@ export class ListFederatedCredentialProvidersRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token.
+   * The pagination token for the next page.
    * 
    * @example
    * NTxxxxxexample
@@ -47,7 +47,7 @@ export class ListFederatedCredentialProvidersRequest extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * The token used to query the previous page.
+   * The pagination token for the previous page.
    * 
    * @example
    * PTxxxxxexample

package/src/models/ListFederatedCredentialProvidersResponseBody.ts

@@ -3,6 +3,13 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListFederatedCredentialProvidersResponseBodyFederatedCredentialProvidersCloudIdPProviderConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the identity provider.
+   * 
+   * @example
+   * idp_1234567890
+   */
   identityProviderId?: string;
   static names(): { [key: string]: string } {
     return {
@@ -51,7 +58,7 @@ export class ListFederatedCredentialProvidersResponseBodyFederatedCredentialProv
   dynamicJwks?: string;
   /**
    * @remarks
-   * Issuer
+   * The token issuer identifier (Issuer).
    * 
    * @example
    * https://example.com
@@ -59,7 +66,7 @@ export class ListFederatedCredentialProvidersResponseBodyFederatedCredentialProv
   issuer?: string;
   /**
    * @remarks
-   * The time when the JWKS was last obtained.
+   * The time when the JWKS was last obtained. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1729061324000
@@ -253,7 +260,7 @@ export class ListFederatedCredentialProvidersResponseBodyFederatedCredentialProv
   cmsVerificationMode?: string;
   /**
    * @remarks
-   * The signature effective time.
+   * The signature effective time. The value indicates the duration for which the signature is valid, in seconds.
    * 
    * @example
    * 3600
@@ -261,7 +268,7 @@ export class ListFederatedCredentialProvidersResponseBodyFederatedCredentialProv
   signatureEffectiveTime?: number;
   /**
    * @remarks
-   * The expression used to retrieve the signing time.
+   * The expression used to obtain the signing time.
    * 
    * @example
    * pkcs7.payload.jsonData.audience.signingTime
@@ -365,7 +372,7 @@ export class ListFederatedCredentialProvidersResponseBodyFederatedCredentialProv
   certificateMetadata?: ListFederatedCredentialProvidersResponseBodyFederatedCredentialProvidersPrivateCaProviderConfigCertificatesCertificateMetadata;
   /**
    * @remarks
-   * The root certificate content.
+   * The content of the root certificate.
    * 
    * @example
    * -----BEGIN CERTIFICATE-----
@@ -375,7 +382,7 @@ export class ListFederatedCredentialProvidersResponseBodyFederatedCredentialProv
   content?: string;
   /**
    * @remarks
-   * The root certificate fingerprint.
+   * The fingerprint of the root certificate.
    * 
    * @example
    * 2b18947a6a9fc7764fd8b5fb18a863b0c6daxxx
@@ -460,10 +467,14 @@ export class ListFederatedCredentialProvidersResponseBodyFederatedCredentialProv
 }
 
 export class ListFederatedCredentialProvidersResponseBodyFederatedCredentialProviders extends $dara.Model {
+  /**
+   * @remarks
+   * The configuration of the cloud identity provider for federated credentials.
+   */
   cloudIdPProviderConfig?: ListFederatedCredentialProvidersResponseBodyFederatedCredentialProvidersCloudIdPProviderConfig;
   /**
    * @remarks
-   * The creation time.
+   * The creation time. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1729061324000
@@ -479,7 +490,7 @@ export class ListFederatedCredentialProvidersResponseBodyFederatedCredentialProv
   description?: string;
   /**
    * @remarks
-   * The federated trust source ID.
+   * The federated credential provider ID.
    * 
    * @example
    * fcp_asda123XXX
@@ -542,7 +553,7 @@ export class ListFederatedCredentialProvidersResponseBodyFederatedCredentialProv
   status?: string;
   /**
    * @remarks
-   * The update time.
+   * The update time. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1729061324000
@@ -608,7 +619,7 @@ export class ListFederatedCredentialProvidersResponseBodyFederatedCredentialProv
 export class ListFederatedCredentialProvidersResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The list of federated trust sources.
+   * The list of federated credential providers.
    */
   federatedCredentialProviders?: ListFederatedCredentialProvidersResponseBodyFederatedCredentialProviders[];
   /**
@@ -621,7 +632,7 @@ export class ListFederatedCredentialProvidersResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token returned by this call.
+   * The query token (Token) value returned by this call.
    * 
    * @example
    * NTxxxexample
@@ -629,7 +640,7 @@ export class ListFederatedCredentialProvidersResponseBody extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * The pagination token returned by this call.
+   * The query token (Token) value returned by this call.
    * 
    * @example
    * PTxxxexample