@alicloud/eiam20211201 2.19.3 → 3.0.0

package/src/models/CreateTrustedOriginRequest.ts

@@ -33,7 +33,7 @@ export class CreateTrustedOriginRequest extends $dara.Model {
   origin?: string;
   /**
    * @remarks
-   * The name of the trusted origin used for management, display, and auditing. If not specified, the value is empty.
+   * The name of the trusted origin used for management, display, and auditing. If this parameter is not specified, the value is empty.
    * 
    * @example
    * Qoder Production Console

package/src/models/DeleteTrustedOriginRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteTrustedOriginRequest extends $dara.Model {
   /**
    * @remarks
-   * A client token that is used to ensure the idempotence of the request. Generate a parameter value from your client to ensure that the value is unique among different requests. The value of ClientToken can contain only ASCII characters and cannot exceed 64 characters in length.
+   * The idempotence token.
    * 
    * @example
    * client-token-example
@@ -13,7 +13,7 @@ export class DeleteTrustedOriginRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The ID of the IDaaS EIAM instance.
+   * The instance ID.
    * 
    * This parameter is required.
    * 
@@ -23,7 +23,7 @@ export class DeleteTrustedOriginRequest extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * The ID of the trusted origin.
+   * The trusted origin ID.
    * 
    * This parameter is required.
    * 

package/src/models/ExecIdentityProviderMetadataUrlResolutionRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ExecIdentityProviderMetadataUrlResolutionRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the identity provider in IDaaS.
+   * The identity provider ID in IDaaS.
    * 
    * @example
    * idp_mwpcwnhrimlr2horxXXXX
@@ -23,7 +23,7 @@ export class ExecIdentityProviderMetadataUrlResolutionRequest extends $dara.Mode
   instanceId?: string;
   /**
    * @remarks
-   * The network access endpoint ID.
+   * The network endpoint ID.
    * 
    * @example
    * inae_public
@@ -38,6 +38,9 @@ export class ExecIdentityProviderMetadataUrlResolutionRequest extends $dara.Mode
    */
   oidcIssuer?: string;
   /**
+   * @remarks
+   * The SAML metadata URL.
+   * 
    * @example
    * https://dc.test.com/FederationMetadata/2007-06/FederationMetadata.xml
    */

package/src/models/ExecIdentityProviderMetadataUrlResolutionResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProviderMetadataOidcOpenIdConfiguration extends $dara.Model {
   /**
    * @remarks
-   * The OAuth 2.0 authorization endpoint.
+   * The OAuth2 authorization endpoint.
    * 
    * @example
    * https://demo.com/oauth2/default/v1/authorize
@@ -13,7 +13,7 @@ export class ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProvid
   authorizationEndpoint?: string;
   /**
    * @remarks
-   * The OIDC issuer.
+   * The OIDC issuer information.
    * 
    * @example
    * https://demo.com/fe974231-3454-4b70-9326-70fb71e41bce/v2.0/
@@ -21,7 +21,7 @@ export class ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProvid
   issuer?: string;
   /**
    * @remarks
-   * The OIDC JSON Web Key Set (JWKS) URI.
+   * The OIDC JWKS URI.
    * 
    * @example
    * https://demo.com/oauth2/v1/keys
@@ -29,7 +29,7 @@ export class ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProvid
   jwksUri?: string;
   /**
    * @remarks
-   * The OAuth 2.0 token endpoint.
+   * The OAuth2 token endpoint.
    * 
    * @example
    * https://demo.com/api/bff/v1.2/developer/oidc/token
@@ -37,7 +37,7 @@ export class ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProvid
   tokenEndpoint?: string;
   /**
    * @remarks
-   * The OIDC userinfo endpoint.
+   * The OIDC UserInfo endpoint.
    * 
    * @example
    * https://demo.com/api/bff/v1.2/developer/oidc/userinfo
@@ -75,7 +75,7 @@ export class ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProvid
 export class ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProviderMetadataSamlMetadataConfigurationCertificates extends $dara.Model {
   /**
    * @remarks
-   * The content of the certificate.
+   * The certificate content.
    * 
    * @example
    * -----BEGIN CERTIFICATE----- MIIE+zCCA0egAwIBAgIJAJZY0ZY0ZY0Z -----END CERTIFICATE-----
@@ -105,12 +105,12 @@ export class ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProvid
 export class ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProviderMetadataSamlMetadataConfiguration extends $dara.Model {
   /**
    * @remarks
-   * The certificates.
+   * The list of IdP certificates.
    */
   certificates?: ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProviderMetadataSamlMetadataConfigurationCertificates[];
   /**
    * @remarks
-   * The entity ID of the SAML identity provider.
+   * The entity ID of the IdP.
    * 
    * @example
    * http://dc.test.com/adfs/services/trust
@@ -118,7 +118,7 @@ export class ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProvid
   idPEntityId?: string;
   /**
    * @remarks
-   * The SSO URL of the SAML identity provider.
+   * The single sign-on URL of the IdP.
    * 
    * @example
    * https://dc.test.com/adfs/ls/
@@ -155,12 +155,12 @@ export class ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProvid
 export class ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProviderMetadata extends $dara.Model {
   /**
    * @remarks
-   * The OIDC identity provider metadata.
+   * The metadata of the OIDC IdP.
    */
   oidcOpenIdConfiguration?: ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProviderMetadataOidcOpenIdConfiguration;
   /**
    * @remarks
-   * The SAML identity provider metadata.
+   * The metadata of the SAML IdP.
    */
   samlMetadataConfiguration?: ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProviderMetadataSamlMetadataConfiguration;
   static names(): { [key: string]: string } {
@@ -195,7 +195,7 @@ export class ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProvid
 export class ExecIdentityProviderMetadataUrlResolutionResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The identity provider metadata.
+   * The metadata of the identity provider.
    */
   identityProviderMetadata?: ExecIdentityProviderMetadataUrlResolutionResponseBodyIdentityProviderMetadata;
   /**

package/src/models/GenerateOauthTokenRequest.ts

@@ -23,6 +23,13 @@ export class GenerateOauthTokenRequest extends $dara.Model {
    * https://example.com
    */
   audience?: string;
+  /**
+   * @remarks
+   * The grant type.
+   * 
+   * @example
+   * client_credentials
+   */
   grantType?: string;
   /**
    * @remarks
@@ -34,15 +41,36 @@ export class GenerateOauthTokenRequest extends $dara.Model {
    * idaas_ue2jvisn35ea5lmthk267xxxxx
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * The requested token type.
+   * 
+   * @example
+   * urn:ietf:params:oauth:token-type:access_token
+   */
   requestedTokenType?: string;
   /**
    * @remarks
-   * The permission scopes.
+   * The permission scope.
    * 
    * This parameter is required.
    */
   scopeValues?: string[];
+  /**
+   * @remarks
+   * The subject token.
+   * 
+   * @example
+   * subject001
+   */
   subjectToken?: string;
+  /**
+   * @remarks
+   * The subject token type.
+   * 
+   * @example
+   * urn:ietf:params:oauth:token-type:access_token
+   */
   subjectTokenType?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/GenerateOauthTokenResponseBody.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class GenerateOauthTokenResponseBodyTokenResponse extends $dara.Model {
   /**
    * @remarks
-   * Access Token。
+   * The access token.
    * 
    * @example
-   * ***
+   * eyJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJlaWFtIn0.signature
    */
   accessToken?: string;
   /**
@@ -27,6 +27,13 @@ export class GenerateOauthTokenResponseBodyTokenResponse extends $dara.Model {
    * 1200
    */
   expiresIn?: number;
+  /**
+   * @remarks
+   * The issued token type.
+   * 
+   * @example
+   * standard
+   */
   issuedTokenType?: string;
   /**
    * @remarks

package/src/models/GetApplicationFederatedCredentialResponseBody.ts

@@ -45,7 +45,7 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
 export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCredentialOidcVerificationConfigAzureVmConfig extends $dara.Model {
   /**
    * @remarks
-   * The principal ID.
+   * The identity identifier.
    * 
    * @example
    * 5dee234a-1b4c-4ad7-a19f-fxxxxx
@@ -110,7 +110,7 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
   instanceIds?: string[];
   /**
    * @remarks
-   * The GCP project ID.
+   * The GCP project ID to which the resource belongs.
    * 
    * @example
    * turnkey-axiom-475109-xx
@@ -118,7 +118,7 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
   projectId?: string;
   /**
    * @remarks
-   * The subject corresponding to the service account.
+   * The sub claim that corresponds to the service account.
    * 
    * @example
    * 123456789
@@ -376,7 +376,7 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
   attributeMappings?: GetApplicationFederatedCredentialResponseBodyApplicationFederatedCredentialAttributeMappings[];
   /**
    * @remarks
-   * The creation time.
+   * The creation time. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1758785994982
@@ -408,7 +408,7 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
   instanceId?: string;
   /**
    * @remarks
-   * The last used time.
+   * The last used time. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1758785994982
@@ -434,7 +434,7 @@ export class GetApplicationFederatedCredentialResponseBodyApplicationFederatedCr
   status?: string;
   /**
    * @remarks
-   * The update time.
+   * The update time. The value is a UNIX timestamp in milliseconds.
    * 
    * @example
    * 1758785994982

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