@alicloud/eiam20211201 2.19.0 → 2.19.2

package/src/models/GetBrandResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetBrandResponseBodyBrand extends $dara.Model {
   /**
    * @remarks
-   * Brand ID.
+   * The brand ID.
    * 
    * @example
    * brand_xxxx
@@ -13,7 +13,7 @@ export class GetBrandResponseBodyBrand extends $dara.Model {
   brandId?: string;
   /**
    * @remarks
-   * Brand name.
+   * The brand name.
    * 
    * @example
    * Custom Brand
@@ -21,7 +21,7 @@ export class GetBrandResponseBodyBrand extends $dara.Model {
   brandName?: string;
   /**
    * @remarks
-   * Brand type.
+   * The brand type.
    * 
    * @example
    * user_custom
@@ -29,7 +29,7 @@ export class GetBrandResponseBodyBrand extends $dara.Model {
   brandType?: string;
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
    * @example
    * idaas_ue2jvisn35ea5lmthk267xxxxx
@@ -37,19 +37,37 @@ export class GetBrandResponseBodyBrand extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * Brand status.
+   * The SMS gateway ID.
+   * 
+   * @example
+   * smsgw_01l9f0kunrrjhxxx
+   */
+  smsGatewayId?: string;
+  /**
+   * @remarks
+   * The brand status.
    * 
    * @example
    * enabled
    */
   status?: string;
+  /**
+   * @remarks
+   * The enabling status of system notifications.
+   * 
+   * @example
+   * enabled
+   */
+  systemNotificationStatus?: string;
   static names(): { [key: string]: string } {
     return {
       brandId: 'BrandId',
       brandName: 'BrandName',
       brandType: 'BrandType',
       instanceId: 'InstanceId',
+      smsGatewayId: 'SmsGatewayId',
       status: 'Status',
+      systemNotificationStatus: 'SystemNotificationStatus',
     };
   }
 
@@ -59,7 +77,9 @@ export class GetBrandResponseBodyBrand extends $dara.Model {
       brandName: 'string',
       brandType: 'string',
       instanceId: 'string',
+      smsGatewayId: 'string',
       status: 'string',
+      systemNotificationStatus: 'string',
     };
   }
 
@@ -75,12 +95,12 @@ export class GetBrandResponseBodyBrand extends $dara.Model {
 export class GetBrandResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Brand.
+   * The brand.
    */
   brand?: GetBrandResponseBodyBrand;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 0441BD79-92F3-53AA-8657-F8CE4A2B912A

package/src/models/GetCloudAccountResponseBody.ts

@@ -13,7 +13,7 @@ export class GetCloudAccountResponseBodyCloudAccountCloudAccountHealthCheckResul
   errorCode?: string;
   /**
    * @remarks
-   * The error description.
+   * The error message.
    * 
    * @example
    * There is no permission.
@@ -45,7 +45,7 @@ export class GetCloudAccountResponseBodyCloudAccountCloudAccountHealthCheckResul
 export class GetCloudAccountResponseBodyCloudAccountCloudAccountHealthCheckResult extends $dara.Model {
   /**
    * @remarks
-   * The error reason. This field is returned when the health check status is unhealthy.
+   * The error reason. This field returns a value when the health check status is unhealthy.
    */
   errorReason?: GetCloudAccountResponseBodyCloudAccountCloudAccountHealthCheckResultErrorReason;
   /**
@@ -159,11 +159,17 @@ export class GetCloudAccountResponseBodyCloudAccountPrivilegeHostingError extend
   /**
    * @remarks
    * The failure error code.
+   * 
+   * @example
+   * Error
    */
   errorCode?: string;
   /**
    * @remarks
    * The failure message.
+   * 
+   * @example
+   * test message
    */
   errorMessage?: string;
   static names(): { [key: string]: string } {
@@ -232,7 +238,7 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
   cloudAccountName?: string;
   /**
    * @remarks
-   * The identity provider configuration.
+   * The identity provider configuration information.
    */
   cloudAccountProviderConfig?: GetCloudAccountResponseBodyCloudAccountCloudAccountProviderConfig;
   /**
@@ -243,10 +249,22 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
    * idaas-eiam-oidc-provider
    */
   cloudAccountProviderName?: string;
+  /**
+   * @remarks
+   * The cloud account role creation type.
+   * 
+   * @example
+   * test
+   */
   cloudAccountRoleCreationType?: string;
   /**
    * @remarks
-   * The cloud account site.
+   * The cloud account site. Valid values:
+   * - china_mainland: The Chinese mainland.
+   * - global: Global.
+   * 
+   * @example
+   * china_mainland
    */
   cloudAccountSite?: string;
   /**
@@ -295,12 +313,26 @@ export class GetCloudAccountResponseBodyCloudAccount extends $dara.Model {
   privilegeHostingError?: GetCloudAccountResponseBodyCloudAccountPrivilegeHostingError;
   /**
    * @remarks
-   * The privilege hosting state, which indicates whether the privilege capability is available.
+   * The hosting state of the cloud account. The default value is 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.
+   * 
+   * @example
+   * hosting_unmanaged
    */
   privilegeHostingState?: string;
   /**
    * @remarks
-   * The privilege switch status, which indicates whether the privilege capability is enabled.
+   * 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.
+   * 
+   * @example
+   * enabled
    */
   privilegeStatus?: string;
   /**

package/src/models/GetCloudAccountRoleResponseBody.ts

@@ -105,6 +105,15 @@ export class GetCloudAccountRoleResponseBodyCloudAccountRole extends $dara.Model
    * ca_01kmegjc11qa1txxxxx
    */
   cloudAccountId?: string;
+  /**
+   * @remarks
+   * The creation source. Valid values:
+   * - system_init: system-created. The role is automatically generated by the platform as a preset and typically cannot be modified or deleted.
+   * - user_custom: user-created. The role is manually created by a user and can be edited and managed throughout its lifecycle.
+   * 
+   * @example
+   * user_custom
+   */
   cloudAccountRoleCreationType?: string;
   /**
    * @remarks

package/src/models/GetIdentityProviderResponseBody.ts

@@ -29,7 +29,7 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailDingtalkAppCon
   corpId?: string;
   /**
    * @remarks
-   * The DingTalk QR code logon version.
+   * The DingTalk QR code login version.
    * 
    * @example
    * old_version
@@ -40,7 +40,6 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailDingtalkAppCon
    * The DingTalk version. Valid values:
    * 
    * - public_dingtalk: Standard DingTalk.
-   * 
    * - private_dingtalk: Dedicated DingTalk.
    * 
    * @example
@@ -289,7 +288,7 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailEndpointMetada
 export class GetIdentityProviderResponseBodyIdentityProviderDetailLarkConfig extends $dara.Model {
   /**
    * @remarks
-   * The AppId of the Lark self-built application.
+   * The CorpId of the Lark custom application.
    * 
    * @example
    * cli_a7a99f53a317100c
@@ -297,7 +296,7 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailLarkConfig ext
   appId?: string;
   /**
    * @remarks
-   * The AppSecret of the Lark self-built application.
+   * The AppSecret of the Lark custom application.
    * 
    * @example
    * ***
@@ -305,7 +304,7 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailLarkConfig ext
   appSecret?: string;
   /**
    * @remarks
-   * The EncryptKey of the Lark self-built application.
+   * The EncryptKey of the Lark custom application.
    * 
    * @example
    * VkdWw91mdkrjVFr3ObNwefap21dfbZbK
@@ -321,7 +320,7 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailLarkConfig ext
   enterpriseNumber?: string;
   /**
    * @remarks
-   * The VerificationToken of the Lark self-built application.
+   * The VerificationToken of the Lark custom application.
    * 
    * @example
    * VkdWw91mdkrjVFr3ObNwefap21dfbZbK
@@ -375,11 +374,10 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailLdapConfig ext
   administratorUsername?: string;
   /**
    * @remarks
-   * Specifies whether to verify the certificate fingerprint. Valid values:
-   * 
-   * - disabled: Disabled.
+   * Indicates whether certificate fingerprint verification is enabled. Valid values:
    * 
-   * - enabled: Enabled.
+   * - disabled
+   * - enabled
    * 
    * @example
    * enabled
@@ -416,11 +414,11 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailLdapConfig ext
   ldapServerPort?: number;
   /**
    * @remarks
-   * Specifies whether StartTLS is enabled. Valid values:
+   * Indicates whether StartTLS is enabled. Valid values:
    * 
-   * - disabled: Disabled.
+   * - disabled: StartTLS is disabled.
    * 
-   * - enabled: Enabled.
+   * - enabled: StartTLS is enabled.
    * 
    * @example
    * enabled
@@ -613,7 +611,7 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailOidcConfig ext
   grantType?: string;
   /**
    * @remarks
-   * The PKCE algorithm. Valid values:
+   * The PKCE challenge method. Valid values:
    * 
    * - S256: SHA-256.
    * 
@@ -625,7 +623,7 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailOidcConfig ext
   pkceChallengeMethod?: string;
   /**
    * @remarks
-   * Specifies whether to use PKCE in the AuthorizationCode grant mode.
+   * Indicates whether PKCE is used in the authorization code grant mode.
    * 
    * @example
    * true
@@ -674,7 +672,7 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailOidcConfig ext
 export class GetIdentityProviderResponseBodyIdentityProviderDetailSamlConfigCertificatesCertificateMetadata extends $dara.Model {
   /**
    * @remarks
-   * The latest validity date of the certificate.
+   * The date after which the certificate is not valid.
    * 
    * @example
    * 1704067200000
@@ -682,7 +680,7 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailSamlConfigCert
   notAfter?: number;
   /**
    * @remarks
-   * The earliest validity date of the certificate.
+   * The date before which the certificate is not valid.
    * 
    * @example
    * 1672531200000
@@ -791,13 +789,21 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailSamlConfig ext
   maxClockSkew?: number;
   /**
    * @remarks
-   * Specifies whether the request must be signed.
+   * Indicates whether request signing is required.
    * 
    * @example
    * true
    */
   requireRequestSigned?: boolean;
+  /**
+   * @remarks
+   * Indicates whether the external IdP is required to sign the Assertion.
+   */
   wantAssertionsSigned?: boolean;
+  /**
+   * @remarks
+   * Indicates whether the external IdP is required to sign the Response.
+   */
   wantResponseSigned?: boolean;
   static names(): { [key: string]: string } {
     return {
@@ -840,12 +846,12 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailSamlConfig ext
 export class GetIdentityProviderResponseBodyIdentityProviderDetailUdPullConfigUdSyncScopeConfig extends $dara.Model {
   /**
    * @remarks
-   * The list of synchronization source nodes.
+   * The list of source nodes for synchronization.
    */
   sourceScopes?: string[];
   /**
    * @remarks
-   * The synchronization target node.
+   * The target node for synchronization.
    * 
    * @example
    * ou_123xxxx
@@ -880,11 +886,11 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailUdPullConfigUd
 export class GetIdentityProviderResponseBodyIdentityProviderDetailUdPullConfig extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether group synchronization is enabled. Valid values:
+   * Indicates whether group synchronization is enabled. Valid values:
    * 
-   * - disabled: Disabled.
+   * - disabled: Group synchronization is disabled.
    * 
-   * - enabled: Enabled.
+   * - enabled: Group synchronization is enabled.
    * 
    * @example
    * disabled
@@ -892,11 +898,11 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailUdPullConfig e
   groupSyncStatus?: string;
   /**
    * @remarks
-   * The incremental callback status. Specifies whether to process incremental callback data from the IdP. Valid values:
+   * The incremental callback status, which indicates whether incremental callback data from the IdP is processed. Valid values:
    * 
-   * - disabled: Disabled.
+   * - disabled: Incremental callback processing is disabled.
    * 
-   * - enabled: Enabled.
+   * - enabled: Incremental callback processing is enabled.
    * 
    * @example
    * disabled
@@ -938,12 +944,12 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailUdPullConfig e
 export class GetIdentityProviderResponseBodyIdentityProviderDetailUdPushConfigUdSyncScopeConfigs extends $dara.Model {
   /**
    * @remarks
-   * The list of synchronization source nodes.
+   * The list of source nodes for synchronization.
    */
   sourceScopes?: string[];
   /**
    * @remarks
-   * The synchronization target node.
+   * The target node for synchronization.
    * 
    * @example
    * ou_123xxxx
@@ -1034,7 +1040,7 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailWeComConfig ex
   authorizeCallbackDomain?: string;
   /**
    * @remarks
-   * The CorpId of the WeCom self-built application.
+   * The corpId of the WeCom self-built application.
    * 
    * @example
    * 3562012953454577801
@@ -1042,7 +1048,7 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailWeComConfig ex
   corpId?: string;
   /**
    * @remarks
-   * The CorpSecret of the WeCom self-built application.
+   * The corpSecret of the WeCom self-built application.
    * 
    * @example
    * weaseiszjskejskaj12sjeszojxxxx
@@ -1088,11 +1094,10 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetailWeComConfig ex
 export class GetIdentityProviderResponseBodyIdentityProviderDetail extends $dara.Model {
   /**
    * @remarks
-   * The advanced configuration status. Valid values:
-   * 
-   * - disabled: Disabled.
+   * The advanced configuration capability. Valid values:
    * 
-   * - enabled: Enabled.
+   * - disabled
+   * - enabled
    * 
    * @example
    * disabled
@@ -1103,19 +1108,12 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetail extends $dara
    * The authentication source product, such as Okta, Google, or Azure AD. Valid values:
    * 
    * - urn:alibaba:idaas:idp:alibaba:dingtalk: DingTalk.
-   * 
    * - urn:alibaba:idaas:idp:unknown:ldap: LDAP.
-   * 
    * - urn:alibaba:idaas:idp:alibaba:idaas: Alibaba Cloud IDaaS.
-   * 
    * - urn:alibaba:idaas:idp:tencent:wecom: WeCom.
-   * 
    * - urn:alibaba:idaas:idp:bytedance:lark: Lark.
-   * 
    * - urn:alibaba:idaas:idp:microsoft:ad: Active Directory.
-   * 
    * - urn:alibaba:idaas:idp:microsoft:aad: Azure Active Directory.
-   * 
    * - urn:alibaba:idaas:idp:alibaba:sase: Alibaba Cloud SASE.
    * 
    * @example
@@ -1124,10 +1122,9 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetail extends $dara
   authnSourceSupplier?: string;
   /**
    * @remarks
-   * The authentication method type, such as OIDC or SAML. Valid values:
+   * The authentication type, OIDC or SAML. Valid values:
    * 
    * - urn:alibaba:idaas:authntype:oidc: OIDC.
-   * 
    * - urn:alibaba:idaas:authntype:saml2: SAML.
    * 
    * @example
@@ -1136,11 +1133,10 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetail extends $dara
   authnSourceType?: string;
   /**
    * @remarks
-   * Specifies whether the corresponding IdP supports authentication. Valid values:
-   * 
-   * - disabled: Disabled.
+   * Indicates whether the corresponding IdP supports authentication. Valid values:
    * 
-   * - enabled: Enabled.
+   * - disabled
+   * - enabled
    * 
    * @example
    * disabled
@@ -1156,7 +1152,7 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetail extends $dara
   createTime?: number;
   /**
    * @remarks
-   * The description of the identity provider.
+   * The identity provider description.
    * 
    * @example
    * for poc test
@@ -1169,7 +1165,7 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetail extends $dara
   dingtalkAppConfig?: GetIdentityProviderResponseBodyIdentityProviderDetailDingtalkAppConfig;
   /**
    * @remarks
-   * The DingTalk synchronization configuration. This value is returned only for DingTalk identity providers.
+   * The DingTalk provisioning configuration. This value is returned only for the DingTalk type.
    */
   dingtalkProvisioningConfig?: GetIdentityProviderResponseBodyIdentityProviderDetailDingtalkProvisioningConfig;
   /**
@@ -1195,7 +1191,7 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetail extends $dara
   identityProviderId?: string;
   /**
    * @remarks
-   * The name of the identity provider.
+   * The identity provider name.
    * 
    * @example
    * test
@@ -1203,22 +1199,15 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetail extends $dara
   identityProviderName?: string;
   /**
    * @remarks
-   * The synchronization type of the identity provider. Valid values:
+   * The identity provider synchronization type. Valid values:
    * 
    * - urn:alibaba:idaas:idp:alibaba:dingtalk:pull: Inbound DingTalk.
-   * 
    * - urn:alibaba:idaas:idp:alibaba:dingtalk:push: Outbound DingTalk.
-   * 
    * - urn:alibaba:idaas:idp:tencent:wecom:pull: Inbound WeCom.
-   * 
    * - urn:alibaba:idaas:idp:bytedance:lark:pull: Inbound Lark.
-   * 
    * - urn:alibaba:idaas:idp:microsoft:ad:pull: Inbound AD.
-   * 
    * - urn:alibaba:idaas:idp:unknown:ldap:pull: Inbound LDAP.
-   * 
    * - urn:alibaba:idaas:idp:standard:oidc: Standard OIDC.
-   * 
    * - urn:alibaba:idaas:idp:alibaba:sase: SASE custom OIDC.
    * 
    * @example
@@ -1248,7 +1237,7 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetail extends $dara
   lastStatusCheckJobResult?: string;
   /**
    * @remarks
-   * The AD/LDAP identity provider configuration.
+   * The AD/LDAP identity provider information.
    */
   ldapConfig?: GetIdentityProviderResponseBodyIdentityProviderDetailLdapConfig;
   /**
@@ -1292,11 +1281,11 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetail extends $dara
   udPullConfig?: GetIdentityProviderResponseBodyIdentityProviderDetailUdPullConfig;
   /**
    * @remarks
-   * Specifies whether the inbound synchronization feature is supported. Valid values:
+   * Indicates whether inbound synchronization is supported. Valid values:
    * 
-   * - disabled: Disabled.
+   * - disabled: Inbound synchronization is disabled.
    * 
-   * - enabled: Enabled.
+   * - enabled: Inbound synchronization is enabled.
    * 
    * @example
    * disabled
@@ -1309,11 +1298,11 @@ export class GetIdentityProviderResponseBodyIdentityProviderDetail extends $dara
   udPushConfig?: GetIdentityProviderResponseBodyIdentityProviderDetailUdPushConfig;
   /**
    * @remarks
-   * Specifies whether the outbound synchronization feature is enabled. Valid values:
+   * Indicates whether outbound synchronization is enabled. Valid values:
    * 
-   * - disabled: Disabled.
+   * - disabled: Outbound synchronization is disabled.
    * 
-   * - enabled: Enabled.
+   * - enabled: Outbound synchronization is enabled.
    * 
    * @example
    * disabled

package/src/models/ListApplicationFederatedCredentialsForProviderRequest.ts

@@ -23,7 +23,7 @@ export class ListApplicationFederatedCredentialsForProviderRequest extends $dara
   instanceId?: string;
   /**
    * @remarks
-   * The maximum number of entries to return per page in a paged query. This parameter is used for paging.
+   * The maximum number of entries per page for a paged query.
    * 
    * @example
    * 20
@@ -31,7 +31,7 @@ export class ListApplicationFederatedCredentialsForProviderRequest extends $dara
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token.
+   * The pagination token for the next page.
    * 
    * @example
    * NTxxxxxexample
@@ -39,7 +39,7 @@ export class ListApplicationFederatedCredentialsForProviderRequest extends $dara
   nextToken?: string;
   /**
    * @remarks
-   * The token used to retrieve the previous page.
+   * The pagination token for the previous page.
    * 
    * @example
    * PTxxxxxexample