@alicloud/eiam20211201 2.19.2 → 3.0.0

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

package/src/models/GetCredentialResponseBody.ts

@@ -35,7 +35,7 @@ export class GetCredentialResponseBodyCredentialCredentialContentOAuthClientCont
 export class GetCredentialResponseBodyCredentialCredentialContent extends $dara.Model {
   /**
    * @remarks
-   * The content of the OAuth client credential.
+   * The credential content of the OAuth client authentication credential type.
    */
   OAuthClientContent?: GetCredentialResponseBodyCredentialCredentialContentOAuthClientContent;
   static names(): { [key: string]: string } {
@@ -73,7 +73,7 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
   createTime?: number;
   /**
    * @remarks
-   * The content of the credential.
+   * The credential content.
    */
   credentialContent?: GetCredentialResponseBodyCredentialCredentialContent;
   /**
@@ -86,6 +86,13 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
    * user_custom
    */
   credentialCreationType?: string;
+  /**
+   * @remarks
+   * The external unique identifier of the credential.
+   * 
+   * @example
+   * credential_external_1234567890
+   */
   credentialExternalId?: string;
   /**
    * @remarks
@@ -121,10 +128,17 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
    * llm
    */
   credentialScenarioLabel?: string;
+  /**
+   * @remarks
+   * The credential sharing scope.
+   * 
+   * @example
+   * common
+   */
   credentialSharingScope?: string;
   /**
    * @remarks
-   * The ID of the subject to which the credential belongs.
+   * The subject ID to which the credential belongs.
    * 
    * @example
    * apt_werthgfdsasffxxxxx
@@ -132,7 +146,7 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
   credentialSubjectId?: string;
   /**
    * @remarks
-   * The type of the subject to which the credential belongs. Valid values:
+   * The subject type to which the credential belongs. Valid values:
    * - authentication_token_provider: Authentication token provider.
    * 
    * @example
@@ -142,8 +156,8 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
   /**
    * @remarks
    * The credential type. Valid values:
-   * - api_key: API key credential.
-   * - oauth_client: OAuth client credential.
+   * - api_key: API key authentication credential.
+   * - oauth_client: OAuth client authentication credential.
    * 
    * @example
    * api_key
@@ -157,6 +171,13 @@ export class GetCredentialResponseBodyCredential extends $dara.Model {
    * credential_description
    */
   description?: string;
+  /**
+   * @remarks
+   * The exclusive account ID of the credential.
+   * 
+   * @example
+   * user_1234567890
+   */
   exclusiveUserId?: string;
   /**
    * @remarks

package/src/models/GetFederatedCredentialProviderRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetFederatedCredentialProviderRequest extends $dara.Model {
   /**
    * @remarks
-   * The federated credential provider ID.
+   * The federated trust source ID.
    * 
    * This parameter is required.
    *