@alicloud/eiam20211201 2.16.0 → 2.16.1

package/src/models/GetApplicationProvisioningConfigResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioningConfigCallbackProvisioningConfig extends $dara.Model {
   /**
    * @remarks
-   * The URL that the application uses to receive IDaaS event callbacks.
+   * The destination address where the application receives IDaaS event callbacks.
    * 
    * @example
    * https://example.com/event/callback
@@ -13,7 +13,7 @@ export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioning
   callbackUrl?: string;
   /**
    * @remarks
-   * The symmetric key for IDaaS event callbacks. The key is an AES-256 encryption key in the HEX format.
+   * The symmetric key for encrypting and decrypting IDaaS event callbacks. This key uses the AES-256 algorithm and is in hexadecimal format.
    * 
    * @example
    * 1adfdfdfd******111
@@ -21,10 +21,11 @@ export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioning
   encryptKey?: string;
   /**
    * @remarks
-   * Indicates whether IDaaS event callback messages are encrypted. Valid values:
+   * Indicates whether to encrypt IDaaS event callback messages. Valid values:
    * 
-   * *   true: The messages are encrypted.
-   * *   false: The messages are transmitted in plaintext.
+   * - true: The messages are encrypted.
+   * 
+   * - false: The messages are not encrypted and are transmitted in plaintext.
    * 
    * @example
    * true
@@ -32,7 +33,7 @@ export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioning
   encryptRequired?: boolean;
   /**
    * @remarks
-   * The list of types of IDaaS event callback messages that are supported by the listener.
+   * The list of message types for the IDaaS event callback listener.
    */
   listenEventScopes?: string[];
   static names(): { [key: string]: string } {
@@ -68,7 +69,7 @@ export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioning
 export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioningConfigScimProvisioningConfigAuthnConfigurationAuthnParam extends $dara.Model {
   /**
    * @remarks
-   * The access token. This parameter is returned when the GrantType parameter is set to bearer_token.
+   * The access token. This parameter is required when GrantType is set to bearer_token.
    * 
    * @example
    * k52x2ru63rlkflina5utgkxxxx
@@ -76,10 +77,11 @@ export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioning
   accessToken?: string;
   /**
    * @remarks
-   * The authentication mode of the SCIM protocol. Valid values:
+   * The authentication mode for the SCIM protocol. Valid values:
+   * 
+   * - client_secret_basic: The key is passed in the request header.
    * 
-   * *   client_secret_basic: The client secret is passed in the request header.
-   * *   client_secret_post: The client secret is passed in the request body.
+   * - client_secret_post: The key is passed in the request body.
    * 
    * @example
    * client_secret_basic
@@ -141,9 +143,9 @@ export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioning
 export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioningConfigScimProvisioningConfigAuthnConfiguration extends $dara.Model {
   /**
    * @remarks
-   * The authentication mode of the SCIM protocol. Valid value:
+   * The authorization mode for the SCIM protocol interface. Valid values:
    * 
-   * *   oauth2: OAuth2.0 mode.
+   * - oauth2: OAuth2 mode.
    * 
    * @example
    * oauth2
@@ -151,18 +153,20 @@ export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioning
   authnMode?: string;
   /**
    * @remarks
-   * The configuration parameters related to authorization.
+   * The authorization configuration parameters. Usage:
    * 
-   * *   If the GrantType parameter is set to client_credentials, the configuration parameters ClientId, ClientSecret, and AuthnMethod are returned.
-   * *   If the GrantType parameter is set to bearer_token, the configuration parameter AccessToken is returned.
+   * - If GrantType is set to client_credentials, you must specify ClientId, ClientSecret, and AuthnMethod.
+   * 
+   * - If GrantType is set to bearer_token, you must specify AccessToken.
    */
   authnParam?: GetApplicationProvisioningConfigResponseBodyApplicationProvisioningConfigScimProvisioningConfigAuthnConfigurationAuthnParam;
   /**
    * @remarks
-   * The grant type of the SCIM protocol. Valid values:
+   * The authorization mode for the SCIM protocol. Valid values:
+   * 
+   * - client_credentials: client credentials mode.
    * 
-   * *   client_credentials: client mode.
-   * *   bearer_token: key mode.
+   * - bearer_token: bearer token mode.
    * 
    * @example
    * bearer_token
@@ -199,28 +203,30 @@ export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioning
 export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioningConfigScimProvisioningConfig extends $dara.Model {
   /**
    * @remarks
-   * The configuration parameters related to SCIM-based synchronization.
+   * The configuration parameters for SCIM protocol synchronization.
    */
   authnConfiguration?: GetApplicationProvisioningConfigResponseBodyApplicationProvisioningConfigScimProvisioningConfigAuthnConfiguration;
   /**
    * @remarks
-   * The full synchronization scope of the SCIM protocol. Valid value:
+   * The scope of a full push for the SCIM protocol. Valid values:
    * 
-   * *   urn:alibaba:idaas:app:scim:User:PUSH: full account data synchronization.
+   * - urn:alibaba:idaas:app:scim:User:PUSH: performs a full synchronization of users.
    */
   fullPushScopes?: string[];
   /**
    * @remarks
-   * The resource operations of the SCIM protocol. Valid values:
+   * The operations on the target resource for the SCIM protocol. Valid values:
    * 
-   * *   urn:alibaba:idaas:app:scim:User:CREATE: account creation.
-   * *   urn:alibaba:idaas:app:scim:User:UPDATE: account update.
-   * *   urn:alibaba:idaas:app:scim:User:DELETE: account deletion.
+   * - urn:alibaba:idaas:app:scim:User:CREATE: creates an account.
+   * 
+   * - urn:alibaba:idaas:app:scim:User:UPDATE: updates an account.
+   * 
+   * - urn:alibaba:idaas:app:scim:User:DELETE: deletes an account.
    */
   provisioningActions?: string[];
   /**
    * @remarks
-   * The base URL that the application uses to receive the SCIM protocol for IDaaS synchronization.
+   * The base URL where the application receives IDaaS SCIM protocol synchronization.
    * 
    * @example
    * https://example.com/scim
@@ -265,7 +271,7 @@ export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioning
 export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioningConfig extends $dara.Model {
   /**
    * @remarks
-   * The ID of the application.
+   * The application ID.
    * 
    * @example
    * app_mkv7rgt4d7i4u7zqtzev2mxxxx
@@ -273,15 +279,16 @@ export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioning
   applicationId?: string;
   /**
    * @remarks
-   * The configuration of the custom event callback protocol of IDaaS.
+   * The configuration parameters for the custom event callback protocol of IDaaS.
    */
   callbackProvisioningConfig?: GetApplicationProvisioningConfigResponseBodyApplicationProvisioningConfigCallbackProvisioningConfig;
   /**
    * @remarks
    * The rendering mode of the account synchronization page. Valid values:
    * 
-   * *   standard: standard mode
-   * *   template: template mode
+   * - standard: standard mode.
+   * 
+   * - template: template mode.
    * 
    * @example
    * standard
@@ -289,16 +296,23 @@ export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioning
   configOperateMode?: string;
   /**
    * @remarks
-   * The ID of the instance.
+   * The instance ID.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * The network endpoint ID.
+   * 
+   * @example
+   * nae_examplexxxx
+   */
   networkAccessEndpointId?: string;
   /**
    * @remarks
-   * The public key endpoint for signature verification of the synchronization callback information.
+   * The public key endpoint for signature verification of application synchronization callback messages.
    * 
    * @example
    * https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_ue2jvisn35ea5lmthk267xxxxx/app_mkv7rgt4d7i4u7zqtzev2mxxxx/provisioning/jwks
@@ -306,10 +320,11 @@ export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioning
   provisionJwksEndpoint?: string;
   /**
    * @remarks
-   * Indicates whether the password is synchronized in IDaaS user event callbacks. Valid values:
+   * Indicates whether to synchronize passwords in IDaaS user event callbacks. Valid values:
    * 
-   * *   true: The password is synchronized.
-   * *   false: The password is not synchronized.
+   * - true: Passwords are synchronized.
+   * 
+   * - false: Passwords are not synchronized.
    * 
    * @example
    * true
@@ -317,10 +332,11 @@ export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioning
   provisionPassword?: boolean;
   /**
    * @remarks
-   * The synchronization protocol type of the application. Valid values:
+   * The protocol type for application synchronization. Valid values:
+   * 
+   * - idaas_callback: the custom event callback protocol of IDaaS.
    * 
-   * *   idaas_callback: custom event callback protocol of IDaaS.
-   * *   scim2: System for Cross-domain Identity Management (SCIM) protocol.
+   * - scim2: the System for Cross-domain Identity Management (SCIM) protocol.
    * 
    * @example
    * idaas_callback
@@ -328,15 +344,16 @@ export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioning
   provisionProtocolType?: string;
   /**
    * @remarks
-   * The configuration of SCIM-based IDaaS synchronization.
+   * The configuration parameters for IDaaS SCIM protocol synchronization.
    */
   scimProvisioningConfig?: GetApplicationProvisioningConfigResponseBodyApplicationProvisioningConfigScimProvisioningConfig;
   /**
    * @remarks
    * The status of the IDaaS account synchronization feature. Valid values:
    * 
-   * *   enabled: The feature is enabled.
-   * *   disabled: The feature is disabled.
+   * - enabled: The feature is enabled.
+   * 
+   * - disabled: The feature is disabled.
    * 
    * @example
    * enabled
@@ -390,7 +407,7 @@ export class GetApplicationProvisioningConfigResponseBodyApplicationProvisioning
 export class GetApplicationProvisioningConfigResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The configuration of the account synchronization feature for the application.
+   * The account synchronization configuration of the application.
    */
   applicationProvisioningConfig?: GetApplicationProvisioningConfigResponseBodyApplicationProvisioningConfig;
   /**

package/src/models/GetApplicationProvisioningScopeResponseBody.ts

@@ -13,7 +13,7 @@ export class GetApplicationProvisioningScopeResponseBodyApplicationProvisioningS
    * Instance Indicates the maximum quota number of authorized agents.
    * 
    * @example
-   * 20
+   * 1000
    */
   maxQuota?: number;
   /**

package/src/models/GetApplicationProvisioningUserPrimaryOrganizationalUnitRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetApplicationProvisioningUserPrimaryOrganizationalUnitRequest extends $dara.Model {
   /**
    * @remarks
-   * IDaaS的应用资源ID。
+   * The application ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetApplicationProvisioningUserPrimaryOrganizationalUnitRequest exte
   applicationId?: string;
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/GetApplicationProvisioningUserPrimaryOrganizationalUnitResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetApplicationProvisioningUserPrimaryOrganizationalUnitResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
    */
   requestId?: string;
   /**
+   * @remarks
+   * The user\\"s primary organizational unit for application synchronization.
+   * 
    * @example
    * ou_12121xxxxxx
    */

package/src/models/GetApplicationRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetApplicationRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the application that you want to query.
+   * The application ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetApplicationRequest extends $dara.Model {
   applicationId?: string;
   /**
    * @remarks
-   * The ID of the instance.
+   * The instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/GetApplicationResponseBody.ts

@@ -3,7 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetApplicationResponseBodyApplicationApplicationOwner extends $dara.Model {
+  /**
+   * @remarks
+   * The group IDs of the application owners.
+   */
   groupIds?: string[];
+  /**
+   * @remarks
+   * The user IDs of the application owners.
+   */
   userIds?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -35,7 +43,15 @@ export class GetApplicationResponseBodyApplicationApplicationOwner extends $dara
 }
 
 export class GetApplicationResponseBodyApplicationCustomFields extends $dara.Model {
+  /**
+   * @remarks
+   * The custom field name.
+   */
   fieldName?: string;
+  /**
+   * @remarks
+   * The custom field value.
+   */
   fieldValue?: string;
   static names(): { [key: string]: string } {
     return {
@@ -63,44 +79,64 @@ export class GetApplicationResponseBodyApplicationCustomFields extends $dara.Mod
 export class GetApplicationResponseBodyApplication extends $dara.Model {
   /**
    * @remarks
-   * The status of the Developer API feature. Valid values:
+   * The status of the Developer API feature for the application. Valid values:
    * 
-   * *   Enabled: The Developer API feature is enabled.
-   * *   Disabled: The Developer API feature is disabled.
+   * - enabled
+   * 
+   * - disabled
    * 
    * @example
    * disabled
    */
   apiInvokeStatus?: string;
   /**
+   * @remarks
+   * The application creation type.
+   * 
    * @example
    * user_custom
    */
   applicationCreationType?: string;
   /**
    * @remarks
-   * The ID of the application.
+   * The application ID.
    * 
    * @example
    * app_mkv7rgt4d7i4u7zqtzev2mxxxx
    */
   applicationId?: string;
+  /**
+   * @remarks
+   * The identity type of the application. Valid values:
+   * 
+   * - application: application.
+   * 
+   * - agent: agent.
+   * 
+   * @example
+   * application
+   */
   applicationIdentityType?: string;
   /**
    * @remarks
-   * The name of the application.
+   * The application name.
    * 
    * @example
-   * SAML Application
+   * SAML application
    */
   applicationName?: string;
+  /**
+   * @remarks
+   * The application owners.
+   */
   applicationOwner?: GetApplicationResponseBodyApplicationApplicationOwner;
   /**
    * @remarks
-   * The origin of the application. Valid values:
+   * The source from which the application was created. Valid values:
+   * 
+   * - urn:alibaba:idaas:app:source:template: The application was created from a template.
    * 
-   * *   urn:alibaba:idaas:app:source:template: The application is created based on a template.
-   * *   urn:alibaba:idaas: The application is created based on the standard protocol.
+   * - urn:alibaba:idaas:app:source:standard: The application was created based on a standard protocol.
    * 
    * @example
    * urn:alibaba:idaas:app:source:template
@@ -108,7 +144,7 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   applicationSourceType?: string;
   /**
    * @remarks
-   * The ID of the template based on which the application is created. This parameter is returned only if the application is created based on a template.
+   * The ID of the application template that is associated with the application. This parameter is returned only if the application was created from a template.
    * 
    * @example
    * apt_rpa_tdsxxx
@@ -116,15 +152,16 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   applicationTemplateId?: string;
   /**
    * @remarks
-   * Application visibility
+   * The visibility of the application.
    */
   applicationVisibility?: string[];
   /**
    * @remarks
-   * The authorization type of the EIAM application. Valid values:
+   * The authorization type for application access. Valid values:
    * 
-   * *   authorize_required: Only the user with explicit authorization can access the application.
-   * *   default_all: By default, all users can access the application.
+   * - authorize_required: Explicit authorization is required for access.
+   * 
+   * - default_all: All members have access by default.
    * 
    * @example
    * authorize_required
@@ -140,29 +177,42 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   clientId?: string;
   /**
    * @remarks
-   * The time when the application was created. The value is a UNIX timestamp. Unit: milliseconds.
+   * The time when the application was created. This value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1649830226000
    */
   createTime?: number;
+  /**
+   * @remarks
+   * The custom fields of the application.
+   */
   customFields?: GetApplicationResponseBodyApplicationCustomFields[];
+  /**
+   * @remarks
+   * Indicates whether to customize the Subject field in the token. If this feature is enabled, the issued access token changes from \\<clientId> to \\<clientId>:\\<client.activeSubjectUrn>. The client.activeSubjectUrn is set in the attribute mapping of the application\\"s federated identity provider.
+   * 
+   * @example
+   * enabled
+   */
   customSubjectStatus?: string;
   /**
    * @remarks
    * The description of the application.
    * 
    * @example
-   * The application is applicable to the test environment.
+   * An application for test environment
    */
   description?: string;
   /**
    * @remarks
-   * The features that are supported by the application. The value is a JSON array. Valid values:
+   * The features that the application supports. This parameter is returned as a JSON array string. Valid values:
+   * 
+   * - sso: single sign-on (SSO).
    * 
-   * *   sso: The application supports SSO.
-   * *   provision: The application supports account synchronization.
-   * *   api_invoke: The application supports custom APIs.
+   * - provision: account synchronization.
+   * 
+   * - api_invoke: API calling.
    * 
    * @example
    * ["sso", "provision"]
@@ -170,7 +220,7 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   features?: string;
   /**
    * @remarks
-   * The ID of the instance.
+   * The instance ID.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
@@ -186,7 +236,7 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   logoUrl?: string;
   /**
    * @remarks
-   * M2M client status.
+   * The status of the M2M client.
    * 
    * @example
    * enabled
@@ -194,7 +244,7 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   m2MClientStatus?: string;
   /**
    * @remarks
-   * The service code of the cloud service that manages the application template.
+   * The service code of the cloud product that hosts the application template.
    * 
    * @example
    * rpa
@@ -202,28 +252,31 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   managedServiceCode?: string;
   /**
    * @remarks
-   * Unique identifier of the resource server
+   * The unique identifier of the resource server. This corresponds to the audience of the resource server.
    * 
    * @example
    * https://www.example.com
    */
   resourceServerIdentifier?: string;
   /**
+   * @remarks
+   * The source type of the resource server.
+   * 
    * @example
    * urn:cloud:idaas:resourceserver:source:custom
    */
   resourceServerSourceType?: string;
   /**
    * @remarks
-   * Resource server status.
+   * The status of the resource server.
    * 
    * @example
-   * disabled	enabled
+   * enabled
    */
   resourceServerStatus?: string;
   /**
    * @remarks
-   * Indicates whether the application template is managed by a cloud service.
+   * Indicates whether the application template is hosted by a cloud service.
    * 
    * @example
    * true
@@ -232,10 +285,15 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   smartConfigCapabilities?: string[];
   /**
    * @remarks
-   * The type of the single sign-on (SSO) protocol. Valid values:
+   * The single sign-on (SSO) protocol. Valid values:
+   * 
+   * - saml2: SAML 2.0.
+   * 
+   * - oidc: OpenID Connect.
    * 
-   * *   saml2: the Security Assertion Markup Language (SAML) 2.0 protocol.
-   * *   oidc: the OpenID Connect (OIDC) protocol.
+   * - oauth2/m2m: OAuth 2.0.
+   * 
+   * - oidc+oauth2/m2m: OpenID Connect and OAuth 2.0.
    * 
    * @example
    * saml2
@@ -243,10 +301,11 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   ssoType?: string;
   /**
    * @remarks
-   * The status of the application. Valid values:
+   * The application status. Valid values:
+   * 
+   * - enabled
    * 
-   * *   Enabled: The application is enabled.
-   * *   Disabled: The application is disabled.
+   * - disabled
    * 
    * @example
    * enabled
@@ -254,7 +313,7 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The time when the application was last updated. The value is a UNIX timestamp. Unit: milliseconds.
+   * The time when the application was last updated. This value is a UNIX timestamp. Unit: milliseconds.
    * 
    * @example
    * 1649830226000
@@ -350,12 +409,12 @@ export class GetApplicationResponseBodyApplication extends $dara.Model {
 export class GetApplicationResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The details of the application.
+   * The information about the application.
    */
   application?: GetApplicationResponseBodyApplication;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A

package/src/models/GetApplicationRoleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetApplicationRoleRequest extends $dara.Model {
   /**
    * @remarks
-   * IDaaS的应用资源ID。
+   * The ID of the application.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetApplicationRoleRequest extends $dara.Model {
   applicationId?: string;
   /**
    * @remarks
-   * 应用角色ID
+   * The ID of the application role.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class GetApplicationRoleRequest extends $dara.Model {
   applicationRoleId?: string;
   /**
    * @remarks
-   * IDaaS EIAM实例的ID。
+   * The ID of the instance.
    * 
    * This parameter is required.
    *