@alicloud/cloudsso20210515 1.4.1 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/client.ts CHANGED
@@ -1517,6 +1517,69 @@ export class DeprovisionAccessConfigurationResponse extends $tea.Model {
1517
1517
  }
1518
1518
  }
1519
1519
 
1520
+ export class DisableDelegateAccountRequest extends $tea.Model {
1521
+ accountId?: string;
1522
+ static names(): { [key: string]: string } {
1523
+ return {
1524
+ accountId: 'AccountId',
1525
+ };
1526
+ }
1527
+
1528
+ static types(): { [key: string]: any } {
1529
+ return {
1530
+ accountId: 'string',
1531
+ };
1532
+ }
1533
+
1534
+ constructor(map?: { [key: string]: any }) {
1535
+ super(map);
1536
+ }
1537
+ }
1538
+
1539
+ export class DisableDelegateAccountResponseBody extends $tea.Model {
1540
+ requestId?: string;
1541
+ static names(): { [key: string]: string } {
1542
+ return {
1543
+ requestId: 'RequestId',
1544
+ };
1545
+ }
1546
+
1547
+ static types(): { [key: string]: any } {
1548
+ return {
1549
+ requestId: 'string',
1550
+ };
1551
+ }
1552
+
1553
+ constructor(map?: { [key: string]: any }) {
1554
+ super(map);
1555
+ }
1556
+ }
1557
+
1558
+ export class DisableDelegateAccountResponse extends $tea.Model {
1559
+ headers?: { [key: string]: string };
1560
+ statusCode?: number;
1561
+ body?: DisableDelegateAccountResponseBody;
1562
+ static names(): { [key: string]: string } {
1563
+ return {
1564
+ headers: 'headers',
1565
+ statusCode: 'statusCode',
1566
+ body: 'body',
1567
+ };
1568
+ }
1569
+
1570
+ static types(): { [key: string]: any } {
1571
+ return {
1572
+ headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
1573
+ statusCode: 'number',
1574
+ body: DisableDelegateAccountResponseBody,
1575
+ };
1576
+ }
1577
+
1578
+ constructor(map?: { [key: string]: any }) {
1579
+ super(map);
1580
+ }
1581
+ }
1582
+
1520
1583
  export class DisableServiceResponseBody extends $tea.Model {
1521
1584
  requestId?: string;
1522
1585
  static names(): { [key: string]: string } {
@@ -1561,6 +1624,69 @@ export class DisableServiceResponse extends $tea.Model {
1561
1624
  }
1562
1625
  }
1563
1626
 
1627
+ export class EnableDelegateAccountRequest extends $tea.Model {
1628
+ accountId?: string;
1629
+ static names(): { [key: string]: string } {
1630
+ return {
1631
+ accountId: 'AccountId',
1632
+ };
1633
+ }
1634
+
1635
+ static types(): { [key: string]: any } {
1636
+ return {
1637
+ accountId: 'string',
1638
+ };
1639
+ }
1640
+
1641
+ constructor(map?: { [key: string]: any }) {
1642
+ super(map);
1643
+ }
1644
+ }
1645
+
1646
+ export class EnableDelegateAccountResponseBody extends $tea.Model {
1647
+ requestId?: string;
1648
+ static names(): { [key: string]: string } {
1649
+ return {
1650
+ requestId: 'RequestId',
1651
+ };
1652
+ }
1653
+
1654
+ static types(): { [key: string]: any } {
1655
+ return {
1656
+ requestId: 'string',
1657
+ };
1658
+ }
1659
+
1660
+ constructor(map?: { [key: string]: any }) {
1661
+ super(map);
1662
+ }
1663
+ }
1664
+
1665
+ export class EnableDelegateAccountResponse extends $tea.Model {
1666
+ headers?: { [key: string]: string };
1667
+ statusCode?: number;
1668
+ body?: EnableDelegateAccountResponseBody;
1669
+ static names(): { [key: string]: string } {
1670
+ return {
1671
+ headers: 'headers',
1672
+ statusCode: 'statusCode',
1673
+ body: 'body',
1674
+ };
1675
+ }
1676
+
1677
+ static types(): { [key: string]: any } {
1678
+ return {
1679
+ headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
1680
+ statusCode: 'number',
1681
+ body: EnableDelegateAccountResponseBody,
1682
+ };
1683
+ }
1684
+
1685
+ constructor(map?: { [key: string]: any }) {
1686
+ super(map);
1687
+ }
1688
+ }
1689
+
1564
1690
  export class EnableServiceResponseBody extends $tea.Model {
1565
1691
  requestId?: string;
1566
1692
  static names(): { [key: string]: string } {
@@ -8327,12 +8453,14 @@ export default class Client extends OpenApi {
8327
8453
  }
8328
8454
 
8329
8455
  /**
8330
- * You can add up to two SAML signing certificates.
8331
- * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
8332
- *
8333
- * @param request AddExternalSAMLIdPCertificateRequest
8334
- * @param runtime runtime options for this request RuntimeOptions
8335
- * @return AddExternalSAMLIdPCertificateResponse
8456
+ * @summary Adds a Security Assertion Markup Language (SAML) signing certificate.
8457
+ *
8458
+ * @description You can add up to two SAML signing certificates.
8459
+ * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
8460
+ *
8461
+ * @param request AddExternalSAMLIdPCertificateRequest
8462
+ * @param runtime runtime options for this request RuntimeOptions
8463
+ * @return AddExternalSAMLIdPCertificateResponse
8336
8464
  */
8337
8465
  async addExternalSAMLIdPCertificateWithOptions(request: AddExternalSAMLIdPCertificateRequest, runtime: $Util.RuntimeOptions): Promise<AddExternalSAMLIdPCertificateResponse> {
8338
8466
  Util.validateModel(request);
@@ -8363,11 +8491,13 @@ export default class Client extends OpenApi {
8363
8491
  }
8364
8492
 
8365
8493
  /**
8366
- * You can add up to two SAML signing certificates.
8367
- * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
8368
- *
8369
- * @param request AddExternalSAMLIdPCertificateRequest
8370
- * @return AddExternalSAMLIdPCertificateResponse
8494
+ * @summary Adds a Security Assertion Markup Language (SAML) signing certificate.
8495
+ *
8496
+ * @description You can add up to two SAML signing certificates.
8497
+ * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
8498
+ *
8499
+ * @param request AddExternalSAMLIdPCertificateRequest
8500
+ * @return AddExternalSAMLIdPCertificateResponse
8371
8501
  */
8372
8502
  async addExternalSAMLIdPCertificate(request: AddExternalSAMLIdPCertificateRequest): Promise<AddExternalSAMLIdPCertificateResponse> {
8373
8503
  let runtime = new $Util.RuntimeOptions({ });
@@ -8375,11 +8505,13 @@ export default class Client extends OpenApi {
8375
8505
  }
8376
8506
 
8377
8507
  /**
8378
- * This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
8379
- *
8380
- * @param request AddPermissionPolicyToAccessConfigurationRequest
8381
- * @param runtime runtime options for this request RuntimeOptions
8382
- * @return AddPermissionPolicyToAccessConfigurationResponse
8508
+ * @summary Adds a policy to an access configuration.
8509
+ *
8510
+ * @description This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
8511
+ *
8512
+ * @param request AddPermissionPolicyToAccessConfigurationRequest
8513
+ * @param runtime runtime options for this request RuntimeOptions
8514
+ * @return AddPermissionPolicyToAccessConfigurationResponse
8383
8515
  */
8384
8516
  async addPermissionPolicyToAccessConfigurationWithOptions(request: AddPermissionPolicyToAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<AddPermissionPolicyToAccessConfigurationResponse> {
8385
8517
  Util.validateModel(request);
@@ -8422,10 +8554,12 @@ export default class Client extends OpenApi {
8422
8554
  }
8423
8555
 
8424
8556
  /**
8425
- * This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
8426
- *
8427
- * @param request AddPermissionPolicyToAccessConfigurationRequest
8428
- * @return AddPermissionPolicyToAccessConfigurationResponse
8557
+ * @summary Adds a policy to an access configuration.
8558
+ *
8559
+ * @description This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
8560
+ *
8561
+ * @param request AddPermissionPolicyToAccessConfigurationRequest
8562
+ * @return AddPermissionPolicyToAccessConfigurationResponse
8429
8563
  */
8430
8564
  async addPermissionPolicyToAccessConfiguration(request: AddPermissionPolicyToAccessConfigurationRequest): Promise<AddPermissionPolicyToAccessConfigurationResponse> {
8431
8565
  let runtime = new $Util.RuntimeOptions({ });
@@ -8433,12 +8567,14 @@ export default class Client extends OpenApi {
8433
8567
  }
8434
8568
 
8435
8569
  /**
8436
- * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot add a user to a group that is synchronized by using SCIM.
8437
- * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
8438
- *
8439
- * @param request AddUserToGroupRequest
8440
- * @param runtime runtime options for this request RuntimeOptions
8441
- * @return AddUserToGroupResponse
8570
+ * @summary Adds a user to a group.
8571
+ *
8572
+ * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot add a user to a group that is synchronized by using SCIM.
8573
+ * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
8574
+ *
8575
+ * @param request AddUserToGroupRequest
8576
+ * @param runtime runtime options for this request RuntimeOptions
8577
+ * @return AddUserToGroupResponse
8442
8578
  */
8443
8579
  async addUserToGroupWithOptions(request: AddUserToGroupRequest, runtime: $Util.RuntimeOptions): Promise<AddUserToGroupResponse> {
8444
8580
  Util.validateModel(request);
@@ -8473,11 +8609,13 @@ export default class Client extends OpenApi {
8473
8609
  }
8474
8610
 
8475
8611
  /**
8476
- * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot add a user to a group that is synchronized by using SCIM.
8477
- * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
8478
- *
8479
- * @param request AddUserToGroupRequest
8480
- * @return AddUserToGroupResponse
8612
+ * @summary Adds a user to a group.
8613
+ *
8614
+ * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot add a user to a group that is synchronized by using SCIM.
8615
+ * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
8616
+ *
8617
+ * @param request AddUserToGroupRequest
8618
+ * @return AddUserToGroupResponse
8481
8619
  */
8482
8620
  async addUserToGroup(request: AddUserToGroupRequest): Promise<AddUserToGroupResponse> {
8483
8621
  let runtime = new $Util.RuntimeOptions({ });
@@ -8485,12 +8623,14 @@ export default class Client extends OpenApi {
8485
8623
  }
8486
8624
 
8487
8625
  /**
8488
- * If single sign-on (SSO) logon is disabled, you can clear the configurations of a SAML IdP. If SSO logon is enabled, you cannot clear the configurations.
8489
- * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
8490
- *
8491
- * @param request ClearExternalSAMLIdentityProviderRequest
8492
- * @param runtime runtime options for this request RuntimeOptions
8493
- * @return ClearExternalSAMLIdentityProviderResponse
8626
+ * @summary Clears the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
8627
+ *
8628
+ * @description If single sign-on (SSO) logon is disabled, you can clear the configurations of a SAML IdP. If SSO logon is enabled, you cannot clear the configurations.
8629
+ * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
8630
+ *
8631
+ * @param request ClearExternalSAMLIdentityProviderRequest
8632
+ * @param runtime runtime options for this request RuntimeOptions
8633
+ * @return ClearExternalSAMLIdentityProviderResponse
8494
8634
  */
8495
8635
  async clearExternalSAMLIdentityProviderWithOptions(request: ClearExternalSAMLIdentityProviderRequest, runtime: $Util.RuntimeOptions): Promise<ClearExternalSAMLIdentityProviderResponse> {
8496
8636
  Util.validateModel(request);
@@ -8517,11 +8657,13 @@ export default class Client extends OpenApi {
8517
8657
  }
8518
8658
 
8519
8659
  /**
8520
- * If single sign-on (SSO) logon is disabled, you can clear the configurations of a SAML IdP. If SSO logon is enabled, you cannot clear the configurations.
8521
- * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
8522
- *
8523
- * @param request ClearExternalSAMLIdentityProviderRequest
8524
- * @return ClearExternalSAMLIdentityProviderResponse
8660
+ * @summary Clears the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
8661
+ *
8662
+ * @description If single sign-on (SSO) logon is disabled, you can clear the configurations of a SAML IdP. If SSO logon is enabled, you cannot clear the configurations.
8663
+ * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
8664
+ *
8665
+ * @param request ClearExternalSAMLIdentityProviderRequest
8666
+ * @return ClearExternalSAMLIdentityProviderResponse
8525
8667
  */
8526
8668
  async clearExternalSAMLIdentityProvider(request: ClearExternalSAMLIdentityProviderRequest): Promise<ClearExternalSAMLIdentityProviderResponse> {
8527
8669
  let runtime = new $Util.RuntimeOptions({ });
@@ -8529,13 +8671,15 @@ export default class Client extends OpenApi {
8529
8671
  }
8530
8672
 
8531
8673
  /**
8532
- * When you call this operation, an asynchronous task is created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
8533
- * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](~~266726~~).
8534
- * This topic provides an example on how to assign access permissions on the account `114240524784****` in your resource directory to the CloudSSO user `u-00q8wbq42wiltcrk****` by using the access configuration `ac-00jhtfl8thteu6uj****`. After the call is successful, the CloudSSO user can access resources within the account in the resource directory.
8535
- *
8536
- * @param request CreateAccessAssignmentRequest
8537
- * @param runtime runtime options for this request RuntimeOptions
8538
- * @return CreateAccessAssignmentResponse
8674
+ * @summary Assigns access permissions on an account in your resource directory to a user or a group by using an access configuration.
8675
+ *
8676
+ * @description When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
8677
+ * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](https://help.aliyun.com/document_detail/266726.html).
8678
+ * This topic provides an example on how to assign access permissions on the account `114240524784****` in your resource directory to the CloudSSO user `u-00q8wbq42wiltcrk****` by using the access configuration `ac-00jhtfl8thteu6uj****`. After the call is successful, the CloudSSO user can access resources within the account in the resource directory.
8679
+ *
8680
+ * @param request CreateAccessAssignmentRequest
8681
+ * @param runtime runtime options for this request RuntimeOptions
8682
+ * @return CreateAccessAssignmentResponse
8539
8683
  */
8540
8684
  async createAccessAssignmentWithOptions(request: CreateAccessAssignmentRequest, runtime: $Util.RuntimeOptions): Promise<CreateAccessAssignmentResponse> {
8541
8685
  Util.validateModel(request);
@@ -8582,12 +8726,14 @@ export default class Client extends OpenApi {
8582
8726
  }
8583
8727
 
8584
8728
  /**
8585
- * When you call this operation, an asynchronous task is created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
8586
- * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](~~266726~~).
8587
- * This topic provides an example on how to assign access permissions on the account `114240524784****` in your resource directory to the CloudSSO user `u-00q8wbq42wiltcrk****` by using the access configuration `ac-00jhtfl8thteu6uj****`. After the call is successful, the CloudSSO user can access resources within the account in the resource directory.
8588
- *
8589
- * @param request CreateAccessAssignmentRequest
8590
- * @return CreateAccessAssignmentResponse
8729
+ * @summary Assigns access permissions on an account in your resource directory to a user or a group by using an access configuration.
8730
+ *
8731
+ * @description When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
8732
+ * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](https://help.aliyun.com/document_detail/266726.html).
8733
+ * This topic provides an example on how to assign access permissions on the account `114240524784****` in your resource directory to the CloudSSO user `u-00q8wbq42wiltcrk****` by using the access configuration `ac-00jhtfl8thteu6uj****`. After the call is successful, the CloudSSO user can access resources within the account in the resource directory.
8734
+ *
8735
+ * @param request CreateAccessAssignmentRequest
8736
+ * @return CreateAccessAssignmentResponse
8591
8737
  */
8592
8738
  async createAccessAssignment(request: CreateAccessAssignmentRequest): Promise<CreateAccessAssignmentResponse> {
8593
8739
  let runtime = new $Util.RuntimeOptions({ });
@@ -8595,12 +8741,14 @@ export default class Client extends OpenApi {
8595
8741
  }
8596
8742
 
8597
8743
  /**
8598
- * For more information about access configurations, see [Overview of access configurations](~~266737~~).
8599
- * This topic provides an example on how to create an access configuration named `ECS-Admin`.
8600
- *
8601
- * @param request CreateAccessConfigurationRequest
8602
- * @param runtime runtime options for this request RuntimeOptions
8603
- * @return CreateAccessConfigurationResponse
8744
+ * @summary Creates an access configuration.
8745
+ *
8746
+ * @description For more information about access configurations, see [Overview of access configurations](https://help.aliyun.com/document_detail/266737.html).
8747
+ * This topic provides an example on how to create an access configuration named `ECS-Admin`.
8748
+ *
8749
+ * @param request CreateAccessConfigurationRequest
8750
+ * @param runtime runtime options for this request RuntimeOptions
8751
+ * @return CreateAccessConfigurationResponse
8604
8752
  */
8605
8753
  async createAccessConfigurationWithOptions(request: CreateAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<CreateAccessConfigurationResponse> {
8606
8754
  Util.validateModel(request);
@@ -8643,11 +8791,13 @@ export default class Client extends OpenApi {
8643
8791
  }
8644
8792
 
8645
8793
  /**
8646
- * For more information about access configurations, see [Overview of access configurations](~~266737~~).
8647
- * This topic provides an example on how to create an access configuration named `ECS-Admin`.
8648
- *
8649
- * @param request CreateAccessConfigurationRequest
8650
- * @return CreateAccessConfigurationResponse
8794
+ * @summary Creates an access configuration.
8795
+ *
8796
+ * @description For more information about access configurations, see [Overview of access configurations](https://help.aliyun.com/document_detail/266737.html).
8797
+ * This topic provides an example on how to create an access configuration named `ECS-Admin`.
8798
+ *
8799
+ * @param request CreateAccessConfigurationRequest
8800
+ * @return CreateAccessConfigurationResponse
8651
8801
  */
8652
8802
  async createAccessConfiguration(request: CreateAccessConfigurationRequest): Promise<CreateAccessConfigurationResponse> {
8653
8803
  let runtime = new $Util.RuntimeOptions({ });
@@ -8655,16 +8805,18 @@ export default class Client extends OpenApi {
8655
8805
  }
8656
8806
 
8657
8807
  /**
8658
- * A directory is a CloudSSO instance. Before you can use CloudSSO, you must create a directory. The directory is used to manage all CloudSSO resources.
8659
- * To create a directory, you must select a region. Alibaba Cloud stores data in the directory only in the region that you select. However, you can deploy Alibaba Cloud resources including Elastic Compute Service (ECS) instances and ApsaraDB RDS instances in other regions. You can also use your cloud account for logons and access the Alibaba Cloud resources in other regions. You can select a region to create a directory based on your security compliance requirements and the geographic location of specific users. If you do not have strict security compliance requirements, we recommend that you select a region that is the closest to the geographical location of the specific users. This way, access to cloud resources is accelerated. You can create the CloudSSO directory in the China (Shanghai), China (Hong Kong), US (Silicon Valley), or Germany (Frankfurt) region.
8660
- * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
8661
- * ## Limits
8662
- * - You can create only one directory for a management account.
8663
- * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
8664
- *
8665
- * @param request CreateDirectoryRequest
8666
- * @param runtime runtime options for this request RuntimeOptions
8667
- * @return CreateDirectoryResponse
8808
+ * @summary Creates a directory.
8809
+ *
8810
+ * @description A directory is a CloudSSO instance. Before you can use CloudSSO, you must create a directory. The directory is used to manage all CloudSSO resources.
8811
+ * To create a directory, you must select a region. Alibaba Cloud stores data in the directory only in the region that you select. However, you can deploy Alibaba Cloud resources including Elastic Compute Service (ECS) instances and ApsaraDB RDS instances in other regions. You can also use your cloud account for logons and access the Alibaba Cloud resources in other regions. You can select a region to create a directory based on your security compliance requirements and the geographic location of specific users. If you do not have strict security compliance requirements, we recommend that you select a region that is the closest to the geographical location of the specific users. This way, access to cloud resources is accelerated. You can create the CloudSSO directory in the China (Shanghai), China (Hong Kong), US (Silicon Valley), or Germany (Frankfurt) region.
8812
+ * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
8813
+ * ## Limits
8814
+ * - You can create only one directory for a management account.
8815
+ * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
8816
+ *
8817
+ * @param request CreateDirectoryRequest
8818
+ * @param runtime runtime options for this request RuntimeOptions
8819
+ * @return CreateDirectoryResponse
8668
8820
  */
8669
8821
  async createDirectoryWithOptions(request: CreateDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<CreateDirectoryResponse> {
8670
8822
  Util.validateModel(request);
@@ -8691,15 +8843,17 @@ export default class Client extends OpenApi {
8691
8843
  }
8692
8844
 
8693
8845
  /**
8694
- * A directory is a CloudSSO instance. Before you can use CloudSSO, you must create a directory. The directory is used to manage all CloudSSO resources.
8695
- * To create a directory, you must select a region. Alibaba Cloud stores data in the directory only in the region that you select. However, you can deploy Alibaba Cloud resources including Elastic Compute Service (ECS) instances and ApsaraDB RDS instances in other regions. You can also use your cloud account for logons and access the Alibaba Cloud resources in other regions. You can select a region to create a directory based on your security compliance requirements and the geographic location of specific users. If you do not have strict security compliance requirements, we recommend that you select a region that is the closest to the geographical location of the specific users. This way, access to cloud resources is accelerated. You can create the CloudSSO directory in the China (Shanghai), China (Hong Kong), US (Silicon Valley), or Germany (Frankfurt) region.
8696
- * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
8697
- * ## Limits
8698
- * - You can create only one directory for a management account.
8699
- * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
8700
- *
8701
- * @param request CreateDirectoryRequest
8702
- * @return CreateDirectoryResponse
8846
+ * @summary Creates a directory.
8847
+ *
8848
+ * @description A directory is a CloudSSO instance. Before you can use CloudSSO, you must create a directory. The directory is used to manage all CloudSSO resources.
8849
+ * To create a directory, you must select a region. Alibaba Cloud stores data in the directory only in the region that you select. However, you can deploy Alibaba Cloud resources including Elastic Compute Service (ECS) instances and ApsaraDB RDS instances in other regions. You can also use your cloud account for logons and access the Alibaba Cloud resources in other regions. You can select a region to create a directory based on your security compliance requirements and the geographic location of specific users. If you do not have strict security compliance requirements, we recommend that you select a region that is the closest to the geographical location of the specific users. This way, access to cloud resources is accelerated. You can create the CloudSSO directory in the China (Shanghai), China (Hong Kong), US (Silicon Valley), or Germany (Frankfurt) region.
8850
+ * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
8851
+ * ## Limits
8852
+ * - You can create only one directory for a management account.
8853
+ * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
8854
+ *
8855
+ * @param request CreateDirectoryRequest
8856
+ * @return CreateDirectoryResponse
8703
8857
  */
8704
8858
  async createDirectory(request: CreateDirectoryRequest): Promise<CreateDirectoryResponse> {
8705
8859
  let runtime = new $Util.RuntimeOptions({ });
@@ -8707,11 +8861,13 @@ export default class Client extends OpenApi {
8707
8861
  }
8708
8862
 
8709
8863
  /**
8710
- * This topic provides an example on how to create a group named `TestGroup`.
8711
- *
8712
- * @param request CreateGroupRequest
8713
- * @param runtime runtime options for this request RuntimeOptions
8714
- * @return CreateGroupResponse
8864
+ * @summary Creates a group.
8865
+ *
8866
+ * @description This topic provides an example on how to create a group named `TestGroup`.
8867
+ *
8868
+ * @param request CreateGroupRequest
8869
+ * @param runtime runtime options for this request RuntimeOptions
8870
+ * @return CreateGroupResponse
8715
8871
  */
8716
8872
  async createGroupWithOptions(request: CreateGroupRequest, runtime: $Util.RuntimeOptions): Promise<CreateGroupResponse> {
8717
8873
  Util.validateModel(request);
@@ -8746,10 +8902,12 @@ export default class Client extends OpenApi {
8746
8902
  }
8747
8903
 
8748
8904
  /**
8749
- * This topic provides an example on how to create a group named `TestGroup`.
8750
- *
8751
- * @param request CreateGroupRequest
8752
- * @return CreateGroupResponse
8905
+ * @summary Creates a group.
8906
+ *
8907
+ * @description This topic provides an example on how to create a group named `TestGroup`.
8908
+ *
8909
+ * @param request CreateGroupRequest
8910
+ * @return CreateGroupResponse
8753
8911
  */
8754
8912
  async createGroup(request: CreateGroupRequest): Promise<CreateGroupResponse> {
8755
8913
  let runtime = new $Util.RuntimeOptions({ });
@@ -8757,12 +8915,14 @@ export default class Client extends OpenApi {
8757
8915
  }
8758
8916
 
8759
8917
  /**
8760
- * SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
8761
- * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
8762
- *
8763
- * @param request CreateSCIMServerCredentialRequest
8764
- * @param runtime runtime options for this request RuntimeOptions
8765
- * @return CreateSCIMServerCredentialResponse
8918
+ * @summary Creates a Cross-domain Identity Management (SCIM) credential.
8919
+ *
8920
+ * @description SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
8921
+ * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
8922
+ *
8923
+ * @param request CreateSCIMServerCredentialRequest
8924
+ * @param runtime runtime options for this request RuntimeOptions
8925
+ * @return CreateSCIMServerCredentialResponse
8766
8926
  */
8767
8927
  async createSCIMServerCredentialWithOptions(request: CreateSCIMServerCredentialRequest, runtime: $Util.RuntimeOptions): Promise<CreateSCIMServerCredentialResponse> {
8768
8928
  Util.validateModel(request);
@@ -8789,11 +8949,13 @@ export default class Client extends OpenApi {
8789
8949
  }
8790
8950
 
8791
8951
  /**
8792
- * SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
8793
- * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
8794
- *
8795
- * @param request CreateSCIMServerCredentialRequest
8796
- * @return CreateSCIMServerCredentialResponse
8952
+ * @summary Creates a Cross-domain Identity Management (SCIM) credential.
8953
+ *
8954
+ * @description SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
8955
+ * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
8956
+ *
8957
+ * @param request CreateSCIMServerCredentialRequest
8958
+ * @return CreateSCIMServerCredentialResponse
8797
8959
  */
8798
8960
  async createSCIMServerCredential(request: CreateSCIMServerCredentialRequest): Promise<CreateSCIMServerCredentialResponse> {
8799
8961
  let runtime = new $Util.RuntimeOptions({ });
@@ -8801,11 +8963,13 @@ export default class Client extends OpenApi {
8801
8963
  }
8802
8964
 
8803
8965
  /**
8804
- * This topic provides an example on how to create a user named `Alice`.
8805
- *
8806
- * @param request CreateUserRequest
8807
- * @param runtime runtime options for this request RuntimeOptions
8808
- * @return CreateUserResponse
8966
+ * @summary Creates a user.
8967
+ *
8968
+ * @description This topic provides an example on how to create a user named `Alice`.
8969
+ *
8970
+ * @param request CreateUserRequest
8971
+ * @param runtime runtime options for this request RuntimeOptions
8972
+ * @return CreateUserResponse
8809
8973
  */
8810
8974
  async createUserWithOptions(request: CreateUserRequest, runtime: $Util.RuntimeOptions): Promise<CreateUserResponse> {
8811
8975
  Util.validateModel(request);
@@ -8860,16 +9024,25 @@ export default class Client extends OpenApi {
8860
9024
  }
8861
9025
 
8862
9026
  /**
8863
- * This topic provides an example on how to create a user named `Alice`.
8864
- *
8865
- * @param request CreateUserRequest
8866
- * @return CreateUserResponse
9027
+ * @summary Creates a user.
9028
+ *
9029
+ * @description This topic provides an example on how to create a user named `Alice`.
9030
+ *
9031
+ * @param request CreateUserRequest
9032
+ * @return CreateUserResponse
8867
9033
  */
8868
9034
  async createUser(request: CreateUserRequest): Promise<CreateUserResponse> {
8869
9035
  let runtime = new $Util.RuntimeOptions({ });
8870
9036
  return await this.createUserWithOptions(request, runtime);
8871
9037
  }
8872
9038
 
9039
+ /**
9040
+ * @summary Creates a Resource Access Management (RAM) user provisioning.
9041
+ *
9042
+ * @param request CreateUserProvisioningRequest
9043
+ * @param runtime runtime options for this request RuntimeOptions
9044
+ * @return CreateUserProvisioningResponse
9045
+ */
8873
9046
  async createUserProvisioningWithOptions(request: CreateUserProvisioningRequest, runtime: $Util.RuntimeOptions): Promise<CreateUserProvisioningResponse> {
8874
9047
  Util.validateModel(request);
8875
9048
  let query = { };
@@ -8922,18 +9095,26 @@ export default class Client extends OpenApi {
8922
9095
  return $tea.cast<CreateUserProvisioningResponse>(await this.callApi(params, req, runtime), new CreateUserProvisioningResponse({}));
8923
9096
  }
8924
9097
 
9098
+ /**
9099
+ * @summary Creates a Resource Access Management (RAM) user provisioning.
9100
+ *
9101
+ * @param request CreateUserProvisioningRequest
9102
+ * @return CreateUserProvisioningResponse
9103
+ */
8925
9104
  async createUserProvisioning(request: CreateUserProvisioningRequest): Promise<CreateUserProvisioningResponse> {
8926
9105
  let runtime = new $Util.RuntimeOptions({ });
8927
9106
  return await this.createUserProvisioningWithOptions(request, runtime);
8928
9107
  }
8929
9108
 
8930
9109
  /**
8931
- * When you call this operation, an asynchronous task is created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
8932
- * This topic provides an example on how to remove the access permissions on the account `114240524784****` in the resource directory from the CloudSSO user `u-00q8wbq42wiltcrk****`. The access permissions are assigned by using the access configuration `ac-00jhtfl8thteu6uj****`.
8933
- *
8934
- * @param request DeleteAccessAssignmentRequest
8935
- * @param runtime runtime options for this request RuntimeOptions
8936
- * @return DeleteAccessAssignmentResponse
9110
+ * @summary Removes the access permissions on an account in a resource directory.
9111
+ *
9112
+ * @description When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
9113
+ * This topic provides an example on how to remove the access permissions on the account `114240524784****` in the resource directory from the CloudSSO user `u-00q8wbq42wiltcrk****`. The access permissions are assigned by using the access configuration `ac-00jhtfl8thteu6uj****`.
9114
+ *
9115
+ * @param request DeleteAccessAssignmentRequest
9116
+ * @param runtime runtime options for this request RuntimeOptions
9117
+ * @return DeleteAccessAssignmentResponse
8937
9118
  */
8938
9119
  async deleteAccessAssignmentWithOptions(request: DeleteAccessAssignmentRequest, runtime: $Util.RuntimeOptions): Promise<DeleteAccessAssignmentResponse> {
8939
9120
  Util.validateModel(request);
@@ -8984,11 +9165,13 @@ export default class Client extends OpenApi {
8984
9165
  }
8985
9166
 
8986
9167
  /**
8987
- * When you call this operation, an asynchronous task is created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
8988
- * This topic provides an example on how to remove the access permissions on the account `114240524784****` in the resource directory from the CloudSSO user `u-00q8wbq42wiltcrk****`. The access permissions are assigned by using the access configuration `ac-00jhtfl8thteu6uj****`.
8989
- *
8990
- * @param request DeleteAccessAssignmentRequest
8991
- * @return DeleteAccessAssignmentResponse
9168
+ * @summary Removes the access permissions on an account in a resource directory.
9169
+ *
9170
+ * @description When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
9171
+ * This topic provides an example on how to remove the access permissions on the account `114240524784****` in the resource directory from the CloudSSO user `u-00q8wbq42wiltcrk****`. The access permissions are assigned by using the access configuration `ac-00jhtfl8thteu6uj****`.
9172
+ *
9173
+ * @param request DeleteAccessAssignmentRequest
9174
+ * @return DeleteAccessAssignmentResponse
8992
9175
  */
8993
9176
  async deleteAccessAssignment(request: DeleteAccessAssignmentRequest): Promise<DeleteAccessAssignmentResponse> {
8994
9177
  let runtime = new $Util.RuntimeOptions({ });
@@ -8996,13 +9179,15 @@ export default class Client extends OpenApi {
8996
9179
  }
8997
9180
 
8998
9181
  /**
8999
- * This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
9000
- * ## Prerequisites
9001
- * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](~~338352~~).
9002
- *
9003
- * @param request DeleteAccessConfigurationRequest
9004
- * @param runtime runtime options for this request RuntimeOptions
9005
- * @return DeleteAccessConfigurationResponse
9182
+ * @summary Deletes an access configuration.
9183
+ *
9184
+ * @description This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
9185
+ * ## Prerequisites
9186
+ * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](https://help.aliyun.com/document_detail/338352.html).
9187
+ *
9188
+ * @param request DeleteAccessConfigurationRequest
9189
+ * @param runtime runtime options for this request RuntimeOptions
9190
+ * @return DeleteAccessConfigurationResponse
9006
9191
  */
9007
9192
  async deleteAccessConfigurationWithOptions(request: DeleteAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeleteAccessConfigurationResponse> {
9008
9193
  Util.validateModel(request);
@@ -9037,12 +9222,14 @@ export default class Client extends OpenApi {
9037
9222
  }
9038
9223
 
9039
9224
  /**
9040
- * This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
9041
- * ## Prerequisites
9042
- * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](~~338352~~).
9043
- *
9044
- * @param request DeleteAccessConfigurationRequest
9045
- * @return DeleteAccessConfigurationResponse
9225
+ * @summary Deletes an access configuration.
9226
+ *
9227
+ * @description This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
9228
+ * ## Prerequisites
9229
+ * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](https://help.aliyun.com/document_detail/338352.html).
9230
+ *
9231
+ * @param request DeleteAccessConfigurationRequest
9232
+ * @return DeleteAccessConfigurationResponse
9046
9233
  */
9047
9234
  async deleteAccessConfiguration(request: DeleteAccessConfigurationRequest): Promise<DeleteAccessConfigurationResponse> {
9048
9235
  let runtime = new $Util.RuntimeOptions({ });
@@ -9050,19 +9237,21 @@ export default class Client extends OpenApi {
9050
9237
  }
9051
9238
 
9052
9239
  /**
9053
- * This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
9054
- * ## Prerequisites
9055
- * No resources are contained in the directory that you want to delete.
9056
- * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](~~338350~~).
9057
- * * Users are deleted. For more information, see [DeleteUser](~~341671~~).
9058
- * * Groups are deleted. For more information, see [DeleteGroup](~~341821~~).
9059
- * * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](~~336907~~).
9060
- * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](~~341842~~).
9061
- * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](~~341573~~).
9062
- *
9063
- * @param request DeleteDirectoryRequest
9064
- * @param runtime runtime options for this request RuntimeOptions
9065
- * @return DeleteDirectoryResponse
9240
+ * @summary Deletes a directory.
9241
+ *
9242
+ * @description This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
9243
+ * ## Prerequisites
9244
+ * No resources are contained in the directory that you want to delete.
9245
+ * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
9246
+ * * Users are deleted. For more information, see [DeleteUser](https://help.aliyun.com/document_detail/341671.html).
9247
+ * * Groups are deleted. For more information, see [DeleteGroup](https://help.aliyun.com/document_detail/341821.html).
9248
+ * * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](https://help.aliyun.com/document_detail/336907.html).
9249
+ * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](https://help.aliyun.com/document_detail/341842.html).
9250
+ * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](https://help.aliyun.com/document_detail/341573.html).
9251
+ *
9252
+ * @param request DeleteDirectoryRequest
9253
+ * @param runtime runtime options for this request RuntimeOptions
9254
+ * @return DeleteDirectoryResponse
9066
9255
  */
9067
9256
  async deleteDirectoryWithOptions(request: DeleteDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<DeleteDirectoryResponse> {
9068
9257
  Util.validateModel(request);
@@ -9089,18 +9278,20 @@ export default class Client extends OpenApi {
9089
9278
  }
9090
9279
 
9091
9280
  /**
9092
- * This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
9093
- * ## Prerequisites
9094
- * No resources are contained in the directory that you want to delete.
9095
- * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](~~338350~~).
9096
- * * Users are deleted. For more information, see [DeleteUser](~~341671~~).
9097
- * * Groups are deleted. For more information, see [DeleteGroup](~~341821~~).
9098
- * * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](~~336907~~).
9099
- * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](~~341842~~).
9100
- * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](~~341573~~).
9101
- *
9102
- * @param request DeleteDirectoryRequest
9103
- * @return DeleteDirectoryResponse
9281
+ * @summary Deletes a directory.
9282
+ *
9283
+ * @description This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
9284
+ * ## Prerequisites
9285
+ * No resources are contained in the directory that you want to delete.
9286
+ * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
9287
+ * * Users are deleted. For more information, see [DeleteUser](https://help.aliyun.com/document_detail/341671.html).
9288
+ * * Groups are deleted. For more information, see [DeleteGroup](https://help.aliyun.com/document_detail/341821.html).
9289
+ * * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](https://help.aliyun.com/document_detail/336907.html).
9290
+ * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](https://help.aliyun.com/document_detail/341842.html).
9291
+ * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](https://help.aliyun.com/document_detail/341573.html).
9292
+ *
9293
+ * @param request DeleteDirectoryRequest
9294
+ * @return DeleteDirectoryResponse
9104
9295
  */
9105
9296
  async deleteDirectory(request: DeleteDirectoryRequest): Promise<DeleteDirectoryResponse> {
9106
9297
  let runtime = new $Util.RuntimeOptions({ });
@@ -9108,15 +9299,17 @@ export default class Client extends OpenApi {
9108
9299
  }
9109
9300
 
9110
9301
  /**
9111
- * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
9112
- * ## Prerequisites
9113
- * The group that you want to delete is not associated with the following resources. If the group is associated with the resources, the deletion fails.
9114
- * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](~~335116~~).
9115
- * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](~~338350~~).
9116
- *
9117
- * @param request DeleteGroupRequest
9118
- * @param runtime runtime options for this request RuntimeOptions
9119
- * @return DeleteGroupResponse
9302
+ * @summary Deletes a group.
9303
+ *
9304
+ * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
9305
+ * ## Prerequisites
9306
+ * The group that you want to delete is not associated with the following resources. If the group is associated with the resources, the deletion fails.
9307
+ * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
9308
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
9309
+ *
9310
+ * @param request DeleteGroupRequest
9311
+ * @param runtime runtime options for this request RuntimeOptions
9312
+ * @return DeleteGroupResponse
9120
9313
  */
9121
9314
  async deleteGroupWithOptions(request: DeleteGroupRequest, runtime: $Util.RuntimeOptions): Promise<DeleteGroupResponse> {
9122
9315
  Util.validateModel(request);
@@ -9147,14 +9340,16 @@ export default class Client extends OpenApi {
9147
9340
  }
9148
9341
 
9149
9342
  /**
9150
- * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
9151
- * ## Prerequisites
9152
- * The group that you want to delete is not associated with the following resources. If the group is associated with the resources, the deletion fails.
9153
- * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](~~335116~~).
9154
- * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](~~338350~~).
9155
- *
9156
- * @param request DeleteGroupRequest
9157
- * @return DeleteGroupResponse
9343
+ * @summary Deletes a group.
9344
+ *
9345
+ * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
9346
+ * ## Prerequisites
9347
+ * The group that you want to delete is not associated with the following resources. If the group is associated with the resources, the deletion fails.
9348
+ * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
9349
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
9350
+ *
9351
+ * @param request DeleteGroupRequest
9352
+ * @return DeleteGroupResponse
9158
9353
  */
9159
9354
  async deleteGroup(request: DeleteGroupRequest): Promise<DeleteGroupResponse> {
9160
9355
  let runtime = new $Util.RuntimeOptions({ });
@@ -9162,11 +9357,13 @@ export default class Client extends OpenApi {
9162
9357
  }
9163
9358
 
9164
9359
  /**
9165
- * This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
9166
- *
9167
- * @param request DeleteMFADeviceForUserRequest
9168
- * @param runtime runtime options for this request RuntimeOptions
9169
- * @return DeleteMFADeviceForUserResponse
9360
+ * @summary Unbinds a multi-factor authentication (MFA) device from a user.
9361
+ *
9362
+ * @description This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
9363
+ *
9364
+ * @param request DeleteMFADeviceForUserRequest
9365
+ * @param runtime runtime options for this request RuntimeOptions
9366
+ * @return DeleteMFADeviceForUserResponse
9170
9367
  */
9171
9368
  async deleteMFADeviceForUserWithOptions(request: DeleteMFADeviceForUserRequest, runtime: $Util.RuntimeOptions): Promise<DeleteMFADeviceForUserResponse> {
9172
9369
  Util.validateModel(request);
@@ -9201,10 +9398,12 @@ export default class Client extends OpenApi {
9201
9398
  }
9202
9399
 
9203
9400
  /**
9204
- * This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
9205
- *
9206
- * @param request DeleteMFADeviceForUserRequest
9207
- * @return DeleteMFADeviceForUserResponse
9401
+ * @summary Unbinds a multi-factor authentication (MFA) device from a user.
9402
+ *
9403
+ * @description This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
9404
+ *
9405
+ * @param request DeleteMFADeviceForUserRequest
9406
+ * @return DeleteMFADeviceForUserResponse
9208
9407
  */
9209
9408
  async deleteMFADeviceForUser(request: DeleteMFADeviceForUserRequest): Promise<DeleteMFADeviceForUserResponse> {
9210
9409
  let runtime = new $Util.RuntimeOptions({ });
@@ -9212,12 +9411,14 @@ export default class Client extends OpenApi {
9212
9411
  }
9213
9412
 
9214
9413
  /**
9215
- * After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
9216
- * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
9217
- *
9218
- * @param request DeleteSCIMServerCredentialRequest
9219
- * @param runtime runtime options for this request RuntimeOptions
9220
- * @return DeleteSCIMServerCredentialResponse
9414
+ * @summary Deletes a Cross-domain Identity Management (SCIM) credential.
9415
+ *
9416
+ * @description After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
9417
+ * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
9418
+ *
9419
+ * @param request DeleteSCIMServerCredentialRequest
9420
+ * @param runtime runtime options for this request RuntimeOptions
9421
+ * @return DeleteSCIMServerCredentialResponse
9221
9422
  */
9222
9423
  async deleteSCIMServerCredentialWithOptions(request: DeleteSCIMServerCredentialRequest, runtime: $Util.RuntimeOptions): Promise<DeleteSCIMServerCredentialResponse> {
9223
9424
  Util.validateModel(request);
@@ -9248,11 +9449,13 @@ export default class Client extends OpenApi {
9248
9449
  }
9249
9450
 
9250
9451
  /**
9251
- * After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
9252
- * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
9253
- *
9254
- * @param request DeleteSCIMServerCredentialRequest
9255
- * @return DeleteSCIMServerCredentialResponse
9452
+ * @summary Deletes a Cross-domain Identity Management (SCIM) credential.
9453
+ *
9454
+ * @description After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
9455
+ * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
9456
+ *
9457
+ * @param request DeleteSCIMServerCredentialRequest
9458
+ * @return DeleteSCIMServerCredentialResponse
9256
9459
  */
9257
9460
  async deleteSCIMServerCredential(request: DeleteSCIMServerCredentialRequest): Promise<DeleteSCIMServerCredentialResponse> {
9258
9461
  let runtime = new $Util.RuntimeOptions({ });
@@ -9260,16 +9463,18 @@ export default class Client extends OpenApi {
9260
9463
  }
9261
9464
 
9262
9465
  /**
9263
- * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
9264
- * ## Prerequisites
9265
- * The user that you want to delete is not associated with the following resources. If the user is associated with the resources, the deletion fails.
9266
- * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](~~341675~~).
9267
- * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](~~338350~~).
9268
- * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](~~335116~~).
9269
- *
9270
- * @param request DeleteUserRequest
9271
- * @param runtime runtime options for this request RuntimeOptions
9272
- * @return DeleteUserResponse
9466
+ * @summary Deletes a user.
9467
+ *
9468
+ * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
9469
+ * ## Prerequisites
9470
+ * The user that you want to delete is not associated with the following resources. If the user is associated with the resources, the deletion fails.
9471
+ * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](https://help.aliyun.com/document_detail/341675.html).
9472
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
9473
+ * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
9474
+ *
9475
+ * @param request DeleteUserRequest
9476
+ * @param runtime runtime options for this request RuntimeOptions
9477
+ * @return DeleteUserResponse
9273
9478
  */
9274
9479
  async deleteUserWithOptions(request: DeleteUserRequest, runtime: $Util.RuntimeOptions): Promise<DeleteUserResponse> {
9275
9480
  Util.validateModel(request);
@@ -9300,21 +9505,30 @@ export default class Client extends OpenApi {
9300
9505
  }
9301
9506
 
9302
9507
  /**
9303
- * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
9304
- * ## Prerequisites
9305
- * The user that you want to delete is not associated with the following resources. If the user is associated with the resources, the deletion fails.
9306
- * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](~~341675~~).
9307
- * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](~~338350~~).
9308
- * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](~~335116~~).
9309
- *
9310
- * @param request DeleteUserRequest
9311
- * @return DeleteUserResponse
9508
+ * @summary Deletes a user.
9509
+ *
9510
+ * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
9511
+ * ## Prerequisites
9512
+ * The user that you want to delete is not associated with the following resources. If the user is associated with the resources, the deletion fails.
9513
+ * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](https://help.aliyun.com/document_detail/341675.html).
9514
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
9515
+ * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
9516
+ *
9517
+ * @param request DeleteUserRequest
9518
+ * @return DeleteUserResponse
9312
9519
  */
9313
9520
  async deleteUser(request: DeleteUserRequest): Promise<DeleteUserResponse> {
9314
9521
  let runtime = new $Util.RuntimeOptions({ });
9315
9522
  return await this.deleteUserWithOptions(request, runtime);
9316
9523
  }
9317
9524
 
9525
+ /**
9526
+ * @summary Deletes a Resource Access Management (RAM) user provisioning.
9527
+ *
9528
+ * @param request DeleteUserProvisioningRequest
9529
+ * @param runtime runtime options for this request RuntimeOptions
9530
+ * @return DeleteUserProvisioningResponse
9531
+ */
9318
9532
  async deleteUserProvisioningWithOptions(request: DeleteUserProvisioningRequest, runtime: $Util.RuntimeOptions): Promise<DeleteUserProvisioningResponse> {
9319
9533
  Util.validateModel(request);
9320
9534
  let query = { };
@@ -9347,11 +9561,24 @@ export default class Client extends OpenApi {
9347
9561
  return $tea.cast<DeleteUserProvisioningResponse>(await this.callApi(params, req, runtime), new DeleteUserProvisioningResponse({}));
9348
9562
  }
9349
9563
 
9564
+ /**
9565
+ * @summary Deletes a Resource Access Management (RAM) user provisioning.
9566
+ *
9567
+ * @param request DeleteUserProvisioningRequest
9568
+ * @return DeleteUserProvisioningResponse
9569
+ */
9350
9570
  async deleteUserProvisioning(request: DeleteUserProvisioningRequest): Promise<DeleteUserProvisioningResponse> {
9351
9571
  let runtime = new $Util.RuntimeOptions({ });
9352
9572
  return await this.deleteUserProvisioningWithOptions(request, runtime);
9353
9573
  }
9354
9574
 
9575
+ /**
9576
+ * @summary Deletes a Resource Access Management (RAM) user provisioning event.
9577
+ *
9578
+ * @param request DeleteUserProvisioningEventRequest
9579
+ * @param runtime runtime options for this request RuntimeOptions
9580
+ * @return DeleteUserProvisioningEventResponse
9581
+ */
9355
9582
  async deleteUserProvisioningEventWithOptions(request: DeleteUserProvisioningEventRequest, runtime: $Util.RuntimeOptions): Promise<DeleteUserProvisioningEventResponse> {
9356
9583
  Util.validateModel(request);
9357
9584
  let query = { };
@@ -9384,18 +9611,26 @@ export default class Client extends OpenApi {
9384
9611
  return $tea.cast<DeleteUserProvisioningEventResponse>(await this.callApi(params, req, runtime), new DeleteUserProvisioningEventResponse({}));
9385
9612
  }
9386
9613
 
9614
+ /**
9615
+ * @summary Deletes a Resource Access Management (RAM) user provisioning event.
9616
+ *
9617
+ * @param request DeleteUserProvisioningEventRequest
9618
+ * @return DeleteUserProvisioningEventResponse
9619
+ */
9387
9620
  async deleteUserProvisioningEvent(request: DeleteUserProvisioningEventRequest): Promise<DeleteUserProvisioningEventResponse> {
9388
9621
  let runtime = new $Util.RuntimeOptions({ });
9389
9622
  return await this.deleteUserProvisioningEventWithOptions(request, runtime);
9390
9623
  }
9391
9624
 
9392
9625
  /**
9393
- * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
9394
- * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
9395
- *
9396
- * @param request DeprovisionAccessConfigurationRequest
9397
- * @param runtime runtime options for this request RuntimeOptions
9398
- * @return DeprovisionAccessConfigurationResponse
9626
+ * @summary De-provisions an access configuration from an account in your resource directory.
9627
+ *
9628
+ * @description When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
9629
+ * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
9630
+ *
9631
+ * @param request DeprovisionAccessConfigurationRequest
9632
+ * @param runtime runtime options for this request RuntimeOptions
9633
+ * @return DeprovisionAccessConfigurationResponse
9399
9634
  */
9400
9635
  async deprovisionAccessConfigurationWithOptions(request: DeprovisionAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeprovisionAccessConfigurationResponse> {
9401
9636
  Util.validateModel(request);
@@ -9434,11 +9669,13 @@ export default class Client extends OpenApi {
9434
9669
  }
9435
9670
 
9436
9671
  /**
9437
- * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
9438
- * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
9439
- *
9440
- * @param request DeprovisionAccessConfigurationRequest
9441
- * @return DeprovisionAccessConfigurationResponse
9672
+ * @summary De-provisions an access configuration from an account in your resource directory.
9673
+ *
9674
+ * @description When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
9675
+ * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
9676
+ *
9677
+ * @param request DeprovisionAccessConfigurationRequest
9678
+ * @return DeprovisionAccessConfigurationResponse
9442
9679
  */
9443
9680
  async deprovisionAccessConfiguration(request: DeprovisionAccessConfigurationRequest): Promise<DeprovisionAccessConfigurationResponse> {
9444
9681
  let runtime = new $Util.RuntimeOptions({ });
@@ -9446,11 +9683,55 @@ export default class Client extends OpenApi {
9446
9683
  }
9447
9684
 
9448
9685
  /**
9449
- * If your CloudSSO has no directory, you can disable CloudSSO based on your business requirements. After you disable CloudSSO, you can enable it at any time.
9450
- *
9451
- * @param request DisableServiceRequest
9452
- * @param runtime runtime options for this request RuntimeOptions
9453
- * @return DisableServiceResponse
9686
+ * @summary DisableDelegateAccount
9687
+ *
9688
+ * @param request DisableDelegateAccountRequest
9689
+ * @param runtime runtime options for this request RuntimeOptions
9690
+ * @return DisableDelegateAccountResponse
9691
+ */
9692
+ async disableDelegateAccountWithOptions(request: DisableDelegateAccountRequest, runtime: $Util.RuntimeOptions): Promise<DisableDelegateAccountResponse> {
9693
+ Util.validateModel(request);
9694
+ let query = { };
9695
+ if (!Util.isUnset(request.accountId)) {
9696
+ query["AccountId"] = request.accountId;
9697
+ }
9698
+
9699
+ let req = new $OpenApi.OpenApiRequest({
9700
+ query: OpenApiUtil.query(query),
9701
+ });
9702
+ let params = new $OpenApi.Params({
9703
+ action: "DisableDelegateAccount",
9704
+ version: "2021-05-15",
9705
+ protocol: "HTTPS",
9706
+ pathname: "/",
9707
+ method: "POST",
9708
+ authType: "AK",
9709
+ style: "RPC",
9710
+ reqBodyType: "formData",
9711
+ bodyType: "json",
9712
+ });
9713
+ return $tea.cast<DisableDelegateAccountResponse>(await this.callApi(params, req, runtime), new DisableDelegateAccountResponse({}));
9714
+ }
9715
+
9716
+ /**
9717
+ * @summary DisableDelegateAccount
9718
+ *
9719
+ * @param request DisableDelegateAccountRequest
9720
+ * @return DisableDelegateAccountResponse
9721
+ */
9722
+ async disableDelegateAccount(request: DisableDelegateAccountRequest): Promise<DisableDelegateAccountResponse> {
9723
+ let runtime = new $Util.RuntimeOptions({ });
9724
+ return await this.disableDelegateAccountWithOptions(request, runtime);
9725
+ }
9726
+
9727
+ /**
9728
+ * @summary Disables CloudSSO.
9729
+ *
9730
+ * @description If your CloudSSO has no directory, you can disable CloudSSO based on your business requirements. After you disable CloudSSO, you can enable it at any time.
9731
+ *
9732
+ * @param request DisableServiceRequest
9733
+ * @param runtime runtime options for this request RuntimeOptions
9734
+ * @return DisableServiceResponse
9454
9735
  */
9455
9736
  async disableServiceWithOptions(runtime: $Util.RuntimeOptions): Promise<DisableServiceResponse> {
9456
9737
  let req = new $OpenApi.OpenApiRequest({ });
@@ -9469,9 +9750,11 @@ export default class Client extends OpenApi {
9469
9750
  }
9470
9751
 
9471
9752
  /**
9472
- * If your CloudSSO has no directory, you can disable CloudSSO based on your business requirements. After you disable CloudSSO, you can enable it at any time.
9473
- *
9474
- * @return DisableServiceResponse
9753
+ * @summary Disables CloudSSO.
9754
+ *
9755
+ * @description If your CloudSSO has no directory, you can disable CloudSSO based on your business requirements. After you disable CloudSSO, you can enable it at any time.
9756
+ *
9757
+ * @return DisableServiceResponse
9475
9758
  */
9476
9759
  async disableService(): Promise<DisableServiceResponse> {
9477
9760
  let runtime = new $Util.RuntimeOptions({ });
@@ -9479,12 +9762,56 @@ export default class Client extends OpenApi {
9479
9762
  }
9480
9763
 
9481
9764
  /**
9482
- * You can call this operation only if your account belongs to the management account that is used to enable a resource directory and has permissions to enable CloudSSO. For more information, see [Enable CloudSSO](~~262819~~).
9483
- * If you call this operation, you agree to the [Alibaba Cloud International Website Product Terms of Service](https://www.alibabacloud.com/help/doc-detail/42416.htm).
9484
- *
9485
- * @param request EnableServiceRequest
9486
- * @param runtime runtime options for this request RuntimeOptions
9487
- * @return EnableServiceResponse
9765
+ * @summary EnableDelegateAccount
9766
+ *
9767
+ * @param request EnableDelegateAccountRequest
9768
+ * @param runtime runtime options for this request RuntimeOptions
9769
+ * @return EnableDelegateAccountResponse
9770
+ */
9771
+ async enableDelegateAccountWithOptions(request: EnableDelegateAccountRequest, runtime: $Util.RuntimeOptions): Promise<EnableDelegateAccountResponse> {
9772
+ Util.validateModel(request);
9773
+ let query = { };
9774
+ if (!Util.isUnset(request.accountId)) {
9775
+ query["AccountId"] = request.accountId;
9776
+ }
9777
+
9778
+ let req = new $OpenApi.OpenApiRequest({
9779
+ query: OpenApiUtil.query(query),
9780
+ });
9781
+ let params = new $OpenApi.Params({
9782
+ action: "EnableDelegateAccount",
9783
+ version: "2021-05-15",
9784
+ protocol: "HTTPS",
9785
+ pathname: "/",
9786
+ method: "POST",
9787
+ authType: "AK",
9788
+ style: "RPC",
9789
+ reqBodyType: "formData",
9790
+ bodyType: "json",
9791
+ });
9792
+ return $tea.cast<EnableDelegateAccountResponse>(await this.callApi(params, req, runtime), new EnableDelegateAccountResponse({}));
9793
+ }
9794
+
9795
+ /**
9796
+ * @summary EnableDelegateAccount
9797
+ *
9798
+ * @param request EnableDelegateAccountRequest
9799
+ * @return EnableDelegateAccountResponse
9800
+ */
9801
+ async enableDelegateAccount(request: EnableDelegateAccountRequest): Promise<EnableDelegateAccountResponse> {
9802
+ let runtime = new $Util.RuntimeOptions({ });
9803
+ return await this.enableDelegateAccountWithOptions(request, runtime);
9804
+ }
9805
+
9806
+ /**
9807
+ * @summary Enables CloudSSO.
9808
+ *
9809
+ * @description You can call this operation only if your account belongs to the management account that is used to enable a resource directory and has permissions to enable CloudSSO. For more information, see [Enable CloudSSO](https://help.aliyun.com/document_detail/262819.html).
9810
+ * If you call this operation, you agree to the [Alibaba Cloud International Website Product Terms of Service](https://www.alibabacloud.com/help/doc-detail/42416.htm).
9811
+ *
9812
+ * @param request EnableServiceRequest
9813
+ * @param runtime runtime options for this request RuntimeOptions
9814
+ * @return EnableServiceResponse
9488
9815
  */
9489
9816
  async enableServiceWithOptions(runtime: $Util.RuntimeOptions): Promise<EnableServiceResponse> {
9490
9817
  let req = new $OpenApi.OpenApiRequest({ });
@@ -9503,10 +9830,12 @@ export default class Client extends OpenApi {
9503
9830
  }
9504
9831
 
9505
9832
  /**
9506
- * You can call this operation only if your account belongs to the management account that is used to enable a resource directory and has permissions to enable CloudSSO. For more information, see [Enable CloudSSO](~~262819~~).
9507
- * If you call this operation, you agree to the [Alibaba Cloud International Website Product Terms of Service](https://www.alibabacloud.com/help/doc-detail/42416.htm).
9508
- *
9509
- * @return EnableServiceResponse
9833
+ * @summary Enables CloudSSO.
9834
+ *
9835
+ * @description You can call this operation only if your account belongs to the management account that is used to enable a resource directory and has permissions to enable CloudSSO. For more information, see [Enable CloudSSO](https://help.aliyun.com/document_detail/262819.html).
9836
+ * If you call this operation, you agree to the [Alibaba Cloud International Website Product Terms of Service](https://www.alibabacloud.com/help/doc-detail/42416.htm).
9837
+ *
9838
+ * @return EnableServiceResponse
9510
9839
  */
9511
9840
  async enableService(): Promise<EnableServiceResponse> {
9512
9841
  let runtime = new $Util.RuntimeOptions({ });
@@ -9514,11 +9843,13 @@ export default class Client extends OpenApi {
9514
9843
  }
9515
9844
 
9516
9845
  /**
9517
- * This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
9518
- *
9519
- * @param request GetAccessConfigurationRequest
9520
- * @param runtime runtime options for this request RuntimeOptions
9521
- * @return GetAccessConfigurationResponse
9846
+ * @summary Queries information about an access configuration.
9847
+ *
9848
+ * @description This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
9849
+ *
9850
+ * @param request GetAccessConfigurationRequest
9851
+ * @param runtime runtime options for this request RuntimeOptions
9852
+ * @return GetAccessConfigurationResponse
9522
9853
  */
9523
9854
  async getAccessConfigurationWithOptions(request: GetAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<GetAccessConfigurationResponse> {
9524
9855
  Util.validateModel(request);
@@ -9549,10 +9880,12 @@ export default class Client extends OpenApi {
9549
9880
  }
9550
9881
 
9551
9882
  /**
9552
- * This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
9553
- *
9554
- * @param request GetAccessConfigurationRequest
9555
- * @return GetAccessConfigurationResponse
9883
+ * @summary Queries information about an access configuration.
9884
+ *
9885
+ * @description This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
9886
+ *
9887
+ * @param request GetAccessConfigurationRequest
9888
+ * @return GetAccessConfigurationResponse
9556
9889
  */
9557
9890
  async getAccessConfiguration(request: GetAccessConfigurationRequest): Promise<GetAccessConfigurationResponse> {
9558
9891
  let runtime = new $Util.RuntimeOptions({ });
@@ -9560,11 +9893,13 @@ export default class Client extends OpenApi {
9560
9893
  }
9561
9894
 
9562
9895
  /**
9563
- * This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
9564
- *
9565
- * @param request GetDirectoryRequest
9566
- * @param runtime runtime options for this request RuntimeOptions
9567
- * @return GetDirectoryResponse
9896
+ * @summary Queries information about a directory.
9897
+ *
9898
+ * @description This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
9899
+ *
9900
+ * @param request GetDirectoryRequest
9901
+ * @param runtime runtime options for this request RuntimeOptions
9902
+ * @return GetDirectoryResponse
9568
9903
  */
9569
9904
  async getDirectoryWithOptions(request: GetDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<GetDirectoryResponse> {
9570
9905
  Util.validateModel(request);
@@ -9591,10 +9926,12 @@ export default class Client extends OpenApi {
9591
9926
  }
9592
9927
 
9593
9928
  /**
9594
- * This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
9595
- *
9596
- * @param request GetDirectoryRequest
9597
- * @return GetDirectoryResponse
9929
+ * @summary Queries information about a directory.
9930
+ *
9931
+ * @description This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
9932
+ *
9933
+ * @param request GetDirectoryRequest
9934
+ * @return GetDirectoryResponse
9598
9935
  */
9599
9936
  async getDirectory(request: GetDirectoryRequest): Promise<GetDirectoryResponse> {
9600
9937
  let runtime = new $Util.RuntimeOptions({ });
@@ -9602,12 +9939,14 @@ export default class Client extends OpenApi {
9602
9939
  }
9603
9940
 
9604
9941
  /**
9605
- * During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an identity provider (IdP).
9606
- * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
9607
- *
9608
- * @param request GetDirectorySAMLServiceProviderInfoRequest
9609
- * @param runtime runtime options for this request RuntimeOptions
9610
- * @return GetDirectorySAMLServiceProviderInfoResponse
9942
+ * @summary Queries information about a Security Assertion Markup Language (SAML) service provider (SP).
9943
+ *
9944
+ * @description During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an identity provider (IdP).
9945
+ * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
9946
+ *
9947
+ * @param request GetDirectorySAMLServiceProviderInfoRequest
9948
+ * @param runtime runtime options for this request RuntimeOptions
9949
+ * @return GetDirectorySAMLServiceProviderInfoResponse
9611
9950
  */
9612
9951
  async getDirectorySAMLServiceProviderInfoWithOptions(request: GetDirectorySAMLServiceProviderInfoRequest, runtime: $Util.RuntimeOptions): Promise<GetDirectorySAMLServiceProviderInfoResponse> {
9613
9952
  Util.validateModel(request);
@@ -9634,11 +9973,13 @@ export default class Client extends OpenApi {
9634
9973
  }
9635
9974
 
9636
9975
  /**
9637
- * During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an identity provider (IdP).
9638
- * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
9639
- *
9640
- * @param request GetDirectorySAMLServiceProviderInfoRequest
9641
- * @return GetDirectorySAMLServiceProviderInfoResponse
9976
+ * @summary Queries information about a Security Assertion Markup Language (SAML) service provider (SP).
9977
+ *
9978
+ * @description During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an identity provider (IdP).
9979
+ * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
9980
+ *
9981
+ * @param request GetDirectorySAMLServiceProviderInfoRequest
9982
+ * @return GetDirectorySAMLServiceProviderInfoResponse
9642
9983
  */
9643
9984
  async getDirectorySAMLServiceProviderInfo(request: GetDirectorySAMLServiceProviderInfoRequest): Promise<GetDirectorySAMLServiceProviderInfoResponse> {
9644
9985
  let runtime = new $Util.RuntimeOptions({ });
@@ -9646,14 +9987,16 @@ export default class Client extends OpenApi {
9646
9987
  }
9647
9988
 
9648
9989
  /**
9649
- * ### [](#)
9650
- * This topic provides an example on how to query the statistics of a directory whose ID is `d-00fc2p61****`. The statistics include the number of users, quota for users, number of groups, quota for groups, number of access configurations, quota for access configurations, quota for system policies that can be configured for an access configuration, number of access permissions that are assigned, number of System for Cross-domain Identity Management (SCIM) credentials, number of asynchronous tasks, status of single sign-on (SSO), and status of SCIM synchronization.
9651
- * ### [](#qps)Limit
9652
- * You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.
9653
- *
9654
- * @param request GetDirectoryStatisticsRequest
9655
- * @param runtime runtime options for this request RuntimeOptions
9656
- * @return GetDirectoryStatisticsResponse
9990
+ * @summary Queries the statistics of a directory.
9991
+ *
9992
+ * @description ### [](#)
9993
+ * This topic provides an example on how to query the statistics of a directory whose ID is `d-00fc2p61****`. The statistics include the number of users, quota for users, number of groups, quota for groups, number of access configurations, quota for access configurations, quota for system policies that can be configured for an access configuration, number of access permissions that are assigned, number of System for Cross-domain Identity Management (SCIM) credentials, number of asynchronous tasks, status of single sign-on (SSO), and status of SCIM synchronization.
9994
+ * ### [](#qps)Limit
9995
+ * You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.
9996
+ *
9997
+ * @param request GetDirectoryStatisticsRequest
9998
+ * @param runtime runtime options for this request RuntimeOptions
9999
+ * @return GetDirectoryStatisticsResponse
9657
10000
  */
9658
10001
  async getDirectoryStatisticsWithOptions(request: GetDirectoryStatisticsRequest, runtime: $Util.RuntimeOptions): Promise<GetDirectoryStatisticsResponse> {
9659
10002
  Util.validateModel(request);
@@ -9680,13 +10023,15 @@ export default class Client extends OpenApi {
9680
10023
  }
9681
10024
 
9682
10025
  /**
9683
- * ### [](#)
9684
- * This topic provides an example on how to query the statistics of a directory whose ID is `d-00fc2p61****`. The statistics include the number of users, quota for users, number of groups, quota for groups, number of access configurations, quota for access configurations, quota for system policies that can be configured for an access configuration, number of access permissions that are assigned, number of System for Cross-domain Identity Management (SCIM) credentials, number of asynchronous tasks, status of single sign-on (SSO), and status of SCIM synchronization.
9685
- * ### [](#qps)Limit
9686
- * You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.
9687
- *
9688
- * @param request GetDirectoryStatisticsRequest
9689
- * @return GetDirectoryStatisticsResponse
10026
+ * @summary Queries the statistics of a directory.
10027
+ *
10028
+ * @description ### [](#)
10029
+ * This topic provides an example on how to query the statistics of a directory whose ID is `d-00fc2p61****`. The statistics include the number of users, quota for users, number of groups, quota for groups, number of access configurations, quota for access configurations, quota for system policies that can be configured for an access configuration, number of access permissions that are assigned, number of System for Cross-domain Identity Management (SCIM) credentials, number of asynchronous tasks, status of single sign-on (SSO), and status of SCIM synchronization.
10030
+ * ### [](#qps)Limit
10031
+ * You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.
10032
+ *
10033
+ * @param request GetDirectoryStatisticsRequest
10034
+ * @return GetDirectoryStatisticsResponse
9690
10035
  */
9691
10036
  async getDirectoryStatistics(request: GetDirectoryStatisticsRequest): Promise<GetDirectoryStatisticsResponse> {
9692
10037
  let runtime = new $Util.RuntimeOptions({ });
@@ -9694,11 +10039,13 @@ export default class Client extends OpenApi {
9694
10039
  }
9695
10040
 
9696
10041
  /**
9697
- * This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
9698
- *
9699
- * @param request GetExternalSAMLIdentityProviderRequest
9700
- * @param runtime runtime options for this request RuntimeOptions
9701
- * @return GetExternalSAMLIdentityProviderResponse
10042
+ * @summary Queries the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
10043
+ *
10044
+ * @description This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
10045
+ *
10046
+ * @param request GetExternalSAMLIdentityProviderRequest
10047
+ * @param runtime runtime options for this request RuntimeOptions
10048
+ * @return GetExternalSAMLIdentityProviderResponse
9702
10049
  */
9703
10050
  async getExternalSAMLIdentityProviderWithOptions(request: GetExternalSAMLIdentityProviderRequest, runtime: $Util.RuntimeOptions): Promise<GetExternalSAMLIdentityProviderResponse> {
9704
10051
  Util.validateModel(request);
@@ -9725,10 +10072,12 @@ export default class Client extends OpenApi {
9725
10072
  }
9726
10073
 
9727
10074
  /**
9728
- * This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
9729
- *
9730
- * @param request GetExternalSAMLIdentityProviderRequest
9731
- * @return GetExternalSAMLIdentityProviderResponse
10075
+ * @summary Queries the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
10076
+ *
10077
+ * @description This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
10078
+ *
10079
+ * @param request GetExternalSAMLIdentityProviderRequest
10080
+ * @return GetExternalSAMLIdentityProviderResponse
9732
10081
  */
9733
10082
  async getExternalSAMLIdentityProvider(request: GetExternalSAMLIdentityProviderRequest): Promise<GetExternalSAMLIdentityProviderResponse> {
9734
10083
  let runtime = new $Util.RuntimeOptions({ });
@@ -9736,11 +10085,13 @@ export default class Client extends OpenApi {
9736
10085
  }
9737
10086
 
9738
10087
  /**
9739
- * This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
9740
- *
9741
- * @param request GetGroupRequest
9742
- * @param runtime runtime options for this request RuntimeOptions
9743
- * @return GetGroupResponse
10088
+ * @summary Queries information about a group.
10089
+ *
10090
+ * @description This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
10091
+ *
10092
+ * @param request GetGroupRequest
10093
+ * @param runtime runtime options for this request RuntimeOptions
10094
+ * @return GetGroupResponse
9744
10095
  */
9745
10096
  async getGroupWithOptions(request: GetGroupRequest, runtime: $Util.RuntimeOptions): Promise<GetGroupResponse> {
9746
10097
  Util.validateModel(request);
@@ -9771,16 +10122,25 @@ export default class Client extends OpenApi {
9771
10122
  }
9772
10123
 
9773
10124
  /**
9774
- * This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
9775
- *
9776
- * @param request GetGroupRequest
9777
- * @return GetGroupResponse
10125
+ * @summary Queries information about a group.
10126
+ *
10127
+ * @description This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
10128
+ *
10129
+ * @param request GetGroupRequest
10130
+ * @return GetGroupResponse
9778
10131
  */
9779
10132
  async getGroup(request: GetGroupRequest): Promise<GetGroupResponse> {
9780
10133
  let runtime = new $Util.RuntimeOptions({ });
9781
10134
  return await this.getGroupWithOptions(request, runtime);
9782
10135
  }
9783
10136
 
10137
+ /**
10138
+ * @summary Queries the logon preference of CloudSSO users.
10139
+ *
10140
+ * @param request GetLoginPreferenceRequest
10141
+ * @param runtime runtime options for this request RuntimeOptions
10142
+ * @return GetLoginPreferenceResponse
10143
+ */
9784
10144
  async getLoginPreferenceWithOptions(request: GetLoginPreferenceRequest, runtime: $Util.RuntimeOptions): Promise<GetLoginPreferenceResponse> {
9785
10145
  Util.validateModel(request);
9786
10146
  let query = { };
@@ -9805,18 +10165,26 @@ export default class Client extends OpenApi {
9805
10165
  return $tea.cast<GetLoginPreferenceResponse>(await this.callApi(params, req, runtime), new GetLoginPreferenceResponse({}));
9806
10166
  }
9807
10167
 
10168
+ /**
10169
+ * @summary Queries the logon preference of CloudSSO users.
10170
+ *
10171
+ * @param request GetLoginPreferenceRequest
10172
+ * @return GetLoginPreferenceResponse
10173
+ */
9808
10174
  async getLoginPreference(request: GetLoginPreferenceRequest): Promise<GetLoginPreferenceResponse> {
9809
10175
  let runtime = new $Util.RuntimeOptions({ });
9810
10176
  return await this.getLoginPreferenceWithOptions(request, runtime);
9811
10177
  }
9812
10178
 
9813
10179
  /**
9814
- * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
9815
- * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
9816
- *
9817
- * @param request GetMFAAuthenticationSettingInfoRequest
9818
- * @param runtime runtime options for this request RuntimeOptions
9819
- * @return GetMFAAuthenticationSettingInfoResponse
10180
+ * @summary Queries the multi-factor authentication (MFA) setting of all users.
10181
+ *
10182
+ * @description If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
10183
+ * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
10184
+ *
10185
+ * @param request GetMFAAuthenticationSettingInfoRequest
10186
+ * @param runtime runtime options for this request RuntimeOptions
10187
+ * @return GetMFAAuthenticationSettingInfoResponse
9820
10188
  */
9821
10189
  async getMFAAuthenticationSettingInfoWithOptions(request: GetMFAAuthenticationSettingInfoRequest, runtime: $Util.RuntimeOptions): Promise<GetMFAAuthenticationSettingInfoResponse> {
9822
10190
  Util.validateModel(request);
@@ -9843,11 +10211,13 @@ export default class Client extends OpenApi {
9843
10211
  }
9844
10212
 
9845
10213
  /**
9846
- * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
9847
- * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
9848
- *
9849
- * @param request GetMFAAuthenticationSettingInfoRequest
9850
- * @return GetMFAAuthenticationSettingInfoResponse
10214
+ * @summary Queries the multi-factor authentication (MFA) setting of all users.
10215
+ *
10216
+ * @description If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
10217
+ * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
10218
+ *
10219
+ * @param request GetMFAAuthenticationSettingInfoRequest
10220
+ * @return GetMFAAuthenticationSettingInfoResponse
9851
10221
  */
9852
10222
  async getMFAAuthenticationSettingInfo(request: GetMFAAuthenticationSettingInfoRequest): Promise<GetMFAAuthenticationSettingInfoResponse> {
9853
10223
  let runtime = new $Util.RuntimeOptions({ });
@@ -9855,12 +10225,14 @@ export default class Client extends OpenApi {
9855
10225
  }
9856
10226
 
9857
10227
  /**
9858
- * > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](~~611286~~) operation to query more detailed information.
9859
- * This topic provides an example on how to query the MFA setting of the users that belong to the directory named `d-00fc2p61****`. The returned result shows that MFA is enabled for all the users.
9860
- *
9861
- * @param request GetMFAAuthenticationSettingsRequest
9862
- * @param runtime runtime options for this request RuntimeOptions
9863
- * @return GetMFAAuthenticationSettingsResponse
10228
+ * @summary Queries the multi-factor authentication (MFA) setting of all users.
10229
+ *
10230
+ * @description > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](https://help.aliyun.com/document_detail/611286.html) operation to query more detailed information.
10231
+ * This topic provides an example on how to query the MFA setting of the users that belong to the directory named `d-00fc2p61****`. The returned result shows that MFA is enabled for all the users.
10232
+ *
10233
+ * @param request GetMFAAuthenticationSettingsRequest
10234
+ * @param runtime runtime options for this request RuntimeOptions
10235
+ * @return GetMFAAuthenticationSettingsResponse
9864
10236
  */
9865
10237
  async getMFAAuthenticationSettingsWithOptions(request: GetMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<GetMFAAuthenticationSettingsResponse> {
9866
10238
  Util.validateModel(request);
@@ -9887,11 +10259,13 @@ export default class Client extends OpenApi {
9887
10259
  }
9888
10260
 
9889
10261
  /**
9890
- * > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](~~611286~~) operation to query more detailed information.
9891
- * This topic provides an example on how to query the MFA setting of the users that belong to the directory named `d-00fc2p61****`. The returned result shows that MFA is enabled for all the users.
9892
- *
9893
- * @param request GetMFAAuthenticationSettingsRequest
9894
- * @return GetMFAAuthenticationSettingsResponse
10262
+ * @summary Queries the multi-factor authentication (MFA) setting of all users.
10263
+ *
10264
+ * @description > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](https://help.aliyun.com/document_detail/611286.html) operation to query more detailed information.
10265
+ * This topic provides an example on how to query the MFA setting of the users that belong to the directory named `d-00fc2p61****`. The returned result shows that MFA is enabled for all the users.
10266
+ *
10267
+ * @param request GetMFAAuthenticationSettingsRequest
10268
+ * @return GetMFAAuthenticationSettingsResponse
9895
10269
  */
9896
10270
  async getMFAAuthenticationSettings(request: GetMFAAuthenticationSettingsRequest): Promise<GetMFAAuthenticationSettingsResponse> {
9897
10271
  let runtime = new $Util.RuntimeOptions({ });
@@ -9899,11 +10273,13 @@ export default class Client extends OpenApi {
9899
10273
  }
9900
10274
 
9901
10275
  /**
9902
- * This topic provides an example on how to check whether MFA is enabled for users in the directory whose ID is `00fc2p61****`. The returned result shows that MFA is in the Enabled state.
9903
- *
9904
- * @param request GetMFAAuthenticationStatusRequest
9905
- * @param runtime runtime options for this request RuntimeOptions
9906
- * @return GetMFAAuthenticationStatusResponse
10276
+ * @summary Checks whether multi-factor authentication (MFA) is enabled for users.
10277
+ *
10278
+ * @description This topic provides an example on how to check whether MFA is enabled for users in the directory whose ID is `00fc2p61****`. The returned result shows that MFA is in the Enabled state.
10279
+ *
10280
+ * @param request GetMFAAuthenticationStatusRequest
10281
+ * @param runtime runtime options for this request RuntimeOptions
10282
+ * @return GetMFAAuthenticationStatusResponse
9907
10283
  */
9908
10284
  async getMFAAuthenticationStatusWithOptions(request: GetMFAAuthenticationStatusRequest, runtime: $Util.RuntimeOptions): Promise<GetMFAAuthenticationStatusResponse> {
9909
10285
  Util.validateModel(request);
@@ -9930,16 +10306,25 @@ export default class Client extends OpenApi {
9930
10306
  }
9931
10307
 
9932
10308
  /**
9933
- * This topic provides an example on how to check whether MFA is enabled for users in the directory whose ID is `00fc2p61****`. The returned result shows that MFA is in the Enabled state.
9934
- *
9935
- * @param request GetMFAAuthenticationStatusRequest
9936
- * @return GetMFAAuthenticationStatusResponse
10309
+ * @summary Checks whether multi-factor authentication (MFA) is enabled for users.
10310
+ *
10311
+ * @description This topic provides an example on how to check whether MFA is enabled for users in the directory whose ID is `00fc2p61****`. The returned result shows that MFA is in the Enabled state.
10312
+ *
10313
+ * @param request GetMFAAuthenticationStatusRequest
10314
+ * @return GetMFAAuthenticationStatusResponse
9937
10315
  */
9938
10316
  async getMFAAuthenticationStatus(request: GetMFAAuthenticationStatusRequest): Promise<GetMFAAuthenticationStatusResponse> {
9939
10317
  let runtime = new $Util.RuntimeOptions({ });
9940
10318
  return await this.getMFAAuthenticationStatusWithOptions(request, runtime);
9941
10319
  }
9942
10320
 
10321
+ /**
10322
+ * @summary Queries the password policy of CloudSSO users.
10323
+ *
10324
+ * @param request GetPasswordPolicyRequest
10325
+ * @param runtime runtime options for this request RuntimeOptions
10326
+ * @return GetPasswordPolicyResponse
10327
+ */
9943
10328
  async getPasswordPolicyWithOptions(request: GetPasswordPolicyRequest, runtime: $Util.RuntimeOptions): Promise<GetPasswordPolicyResponse> {
9944
10329
  Util.validateModel(request);
9945
10330
  let query = { };
@@ -9964,17 +10349,25 @@ export default class Client extends OpenApi {
9964
10349
  return $tea.cast<GetPasswordPolicyResponse>(await this.callApi(params, req, runtime), new GetPasswordPolicyResponse({}));
9965
10350
  }
9966
10351
 
10352
+ /**
10353
+ * @summary Queries the password policy of CloudSSO users.
10354
+ *
10355
+ * @param request GetPasswordPolicyRequest
10356
+ * @return GetPasswordPolicyResponse
10357
+ */
9967
10358
  async getPasswordPolicy(request: GetPasswordPolicyRequest): Promise<GetPasswordPolicyResponse> {
9968
10359
  let runtime = new $Util.RuntimeOptions({ });
9969
10360
  return await this.getPasswordPolicyWithOptions(request, runtime);
9970
10361
  }
9971
10362
 
9972
10363
  /**
9973
- * This topic provides an example on how to query the status of SCIM synchronization within the directory `d-00fc2p61****`. The returned result shows that SCIM synchronization is in the Enabled state.
9974
- *
9975
- * @param request GetSCIMSynchronizationStatusRequest
9976
- * @param runtime runtime options for this request RuntimeOptions
9977
- * @return GetSCIMSynchronizationStatusResponse
10364
+ * @summary Queries the status of System for Cross-domain Identity Management (SCIM) synchronization.
10365
+ *
10366
+ * @description This topic provides an example on how to query the status of SCIM synchronization within the directory `d-00fc2p61****`. The returned result shows that SCIM synchronization is in the Enabled state.
10367
+ *
10368
+ * @param request GetSCIMSynchronizationStatusRequest
10369
+ * @param runtime runtime options for this request RuntimeOptions
10370
+ * @return GetSCIMSynchronizationStatusResponse
9978
10371
  */
9979
10372
  async getSCIMSynchronizationStatusWithOptions(request: GetSCIMSynchronizationStatusRequest, runtime: $Util.RuntimeOptions): Promise<GetSCIMSynchronizationStatusResponse> {
9980
10373
  Util.validateModel(request);
@@ -10001,16 +10394,25 @@ export default class Client extends OpenApi {
10001
10394
  }
10002
10395
 
10003
10396
  /**
10004
- * This topic provides an example on how to query the status of SCIM synchronization within the directory `d-00fc2p61****`. The returned result shows that SCIM synchronization is in the Enabled state.
10005
- *
10006
- * @param request GetSCIMSynchronizationStatusRequest
10007
- * @return GetSCIMSynchronizationStatusResponse
10397
+ * @summary Queries the status of System for Cross-domain Identity Management (SCIM) synchronization.
10398
+ *
10399
+ * @description This topic provides an example on how to query the status of SCIM synchronization within the directory `d-00fc2p61****`. The returned result shows that SCIM synchronization is in the Enabled state.
10400
+ *
10401
+ * @param request GetSCIMSynchronizationStatusRequest
10402
+ * @return GetSCIMSynchronizationStatusResponse
10008
10403
  */
10009
10404
  async getSCIMSynchronizationStatus(request: GetSCIMSynchronizationStatusRequest): Promise<GetSCIMSynchronizationStatusResponse> {
10010
10405
  let runtime = new $Util.RuntimeOptions({ });
10011
10406
  return await this.getSCIMSynchronizationStatusWithOptions(request, runtime);
10012
10407
  }
10013
10408
 
10409
+ /**
10410
+ * @summary Queries the status of CloudSSO.
10411
+ *
10412
+ * @param request GetServiceStatusRequest
10413
+ * @param runtime runtime options for this request RuntimeOptions
10414
+ * @return GetServiceStatusResponse
10415
+ */
10014
10416
  async getServiceStatusWithOptions(runtime: $Util.RuntimeOptions): Promise<GetServiceStatusResponse> {
10015
10417
  let req = new $OpenApi.OpenApiRequest({ });
10016
10418
  let params = new $OpenApi.Params({
@@ -10027,17 +10429,24 @@ export default class Client extends OpenApi {
10027
10429
  return $tea.cast<GetServiceStatusResponse>(await this.callApi(params, req, runtime), new GetServiceStatusResponse({}));
10028
10430
  }
10029
10431
 
10432
+ /**
10433
+ * @summary Queries the status of CloudSSO.
10434
+ *
10435
+ * @return GetServiceStatusResponse
10436
+ */
10030
10437
  async getServiceStatus(): Promise<GetServiceStatusResponse> {
10031
10438
  let runtime = new $Util.RuntimeOptions({ });
10032
10439
  return await this.getServiceStatusWithOptions(runtime);
10033
10440
  }
10034
10441
 
10035
10442
  /**
10036
- * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
10037
- *
10038
- * @param request GetTaskRequest
10039
- * @param runtime runtime options for this request RuntimeOptions
10040
- * @return GetTaskResponse
10443
+ * @summary Queries information about an asynchronous task.
10444
+ *
10445
+ * @description This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
10446
+ *
10447
+ * @param request GetTaskRequest
10448
+ * @param runtime runtime options for this request RuntimeOptions
10449
+ * @return GetTaskResponse
10041
10450
  */
10042
10451
  async getTaskWithOptions(request: GetTaskRequest, runtime: $Util.RuntimeOptions): Promise<GetTaskResponse> {
10043
10452
  Util.validateModel(request);
@@ -10068,10 +10477,12 @@ export default class Client extends OpenApi {
10068
10477
  }
10069
10478
 
10070
10479
  /**
10071
- * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
10072
- *
10073
- * @param request GetTaskRequest
10074
- * @return GetTaskResponse
10480
+ * @summary Queries information about an asynchronous task.
10481
+ *
10482
+ * @description This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
10483
+ *
10484
+ * @param request GetTaskRequest
10485
+ * @return GetTaskResponse
10075
10486
  */
10076
10487
  async getTask(request: GetTaskRequest): Promise<GetTaskResponse> {
10077
10488
  let runtime = new $Util.RuntimeOptions({ });
@@ -10079,12 +10490,14 @@ export default class Client extends OpenApi {
10079
10490
  }
10080
10491
 
10081
10492
  /**
10082
- * You can call the GetTaskStatus operation to query the status of an asynchronous task. If you want to query more information about an asynchronous task, call the [GetTask](~~340670~~) operation.
10083
- * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
10084
- *
10085
- * @param request GetTaskStatusRequest
10086
- * @param runtime runtime options for this request RuntimeOptions
10087
- * @return GetTaskStatusResponse
10493
+ * @summary Queries the status of an asynchronous task.
10494
+ *
10495
+ * @description You can call the GetTaskStatus operation to query the status of an asynchronous task. If you want to query more information about an asynchronous task, call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation.
10496
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
10497
+ *
10498
+ * @param request GetTaskStatusRequest
10499
+ * @param runtime runtime options for this request RuntimeOptions
10500
+ * @return GetTaskStatusResponse
10088
10501
  */
10089
10502
  async getTaskStatusWithOptions(request: GetTaskStatusRequest, runtime: $Util.RuntimeOptions): Promise<GetTaskStatusResponse> {
10090
10503
  Util.validateModel(request);
@@ -10115,11 +10528,13 @@ export default class Client extends OpenApi {
10115
10528
  }
10116
10529
 
10117
10530
  /**
10118
- * You can call the GetTaskStatus operation to query the status of an asynchronous task. If you want to query more information about an asynchronous task, call the [GetTask](~~340670~~) operation.
10119
- * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
10120
- *
10121
- * @param request GetTaskStatusRequest
10122
- * @return GetTaskStatusResponse
10531
+ * @summary Queries the status of an asynchronous task.
10532
+ *
10533
+ * @description You can call the GetTaskStatus operation to query the status of an asynchronous task. If you want to query more information about an asynchronous task, call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation.
10534
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
10535
+ *
10536
+ * @param request GetTaskStatusRequest
10537
+ * @return GetTaskStatusResponse
10123
10538
  */
10124
10539
  async getTaskStatus(request: GetTaskStatusRequest): Promise<GetTaskStatusResponse> {
10125
10540
  let runtime = new $Util.RuntimeOptions({ });
@@ -10127,11 +10542,13 @@ export default class Client extends OpenApi {
10127
10542
  }
10128
10543
 
10129
10544
  /**
10130
- * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
10131
- *
10132
- * @param request GetUserRequest
10133
- * @param runtime runtime options for this request RuntimeOptions
10134
- * @return GetUserResponse
10545
+ * @summary Queries information about a user.
10546
+ *
10547
+ * @description This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
10548
+ *
10549
+ * @param request GetUserRequest
10550
+ * @param runtime runtime options for this request RuntimeOptions
10551
+ * @return GetUserResponse
10135
10552
  */
10136
10553
  async getUserWithOptions(request: GetUserRequest, runtime: $Util.RuntimeOptions): Promise<GetUserResponse> {
10137
10554
  Util.validateModel(request);
@@ -10162,16 +10579,25 @@ export default class Client extends OpenApi {
10162
10579
  }
10163
10580
 
10164
10581
  /**
10165
- * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
10166
- *
10167
- * @param request GetUserRequest
10168
- * @return GetUserResponse
10582
+ * @summary Queries information about a user.
10583
+ *
10584
+ * @description This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
10585
+ *
10586
+ * @param request GetUserRequest
10587
+ * @return GetUserResponse
10169
10588
  */
10170
10589
  async getUser(request: GetUserRequest): Promise<GetUserResponse> {
10171
10590
  let runtime = new $Util.RuntimeOptions({ });
10172
10591
  return await this.getUserWithOptions(request, runtime);
10173
10592
  }
10174
10593
 
10594
+ /**
10595
+ * @summary Queries the ID of a user in a resource directory by using the ExternalId parameter.
10596
+ *
10597
+ * @param tmpReq GetUserIdRequest
10598
+ * @param runtime runtime options for this request RuntimeOptions
10599
+ * @return GetUserIdResponse
10600
+ */
10175
10601
  async getUserIdWithOptions(tmpReq: GetUserIdRequest, runtime: $Util.RuntimeOptions): Promise<GetUserIdResponse> {
10176
10602
  Util.validateModel(tmpReq);
10177
10603
  let request = new GetUserIdShrinkRequest({ });
@@ -10206,17 +10632,25 @@ export default class Client extends OpenApi {
10206
10632
  return $tea.cast<GetUserIdResponse>(await this.callApi(params, req, runtime), new GetUserIdResponse({}));
10207
10633
  }
10208
10634
 
10635
+ /**
10636
+ * @summary Queries the ID of a user in a resource directory by using the ExternalId parameter.
10637
+ *
10638
+ * @param request GetUserIdRequest
10639
+ * @return GetUserIdResponse
10640
+ */
10209
10641
  async getUserId(request: GetUserIdRequest): Promise<GetUserIdResponse> {
10210
10642
  let runtime = new $Util.RuntimeOptions({ });
10211
10643
  return await this.getUserIdWithOptions(request, runtime);
10212
10644
  }
10213
10645
 
10214
10646
  /**
10215
- * This topic provides an example on how to query the MFA setting of the user named `u-00q8wbq42wiltcrk****`. The returned result shows that MFA is enabled for the user.
10216
- *
10217
- * @param request GetUserMFAAuthenticationSettingsRequest
10218
- * @param runtime runtime options for this request RuntimeOptions
10219
- * @return GetUserMFAAuthenticationSettingsResponse
10647
+ * @summary Queries the multi-factor authentication (MFA) setting of a single user.
10648
+ *
10649
+ * @description This topic provides an example on how to query the MFA setting of the user named `u-00q8wbq42wiltcrk****`. The returned result shows that MFA is enabled for the user.
10650
+ *
10651
+ * @param request GetUserMFAAuthenticationSettingsRequest
10652
+ * @param runtime runtime options for this request RuntimeOptions
10653
+ * @return GetUserMFAAuthenticationSettingsResponse
10220
10654
  */
10221
10655
  async getUserMFAAuthenticationSettingsWithOptions(request: GetUserMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<GetUserMFAAuthenticationSettingsResponse> {
10222
10656
  Util.validateModel(request);
@@ -10247,16 +10681,25 @@ export default class Client extends OpenApi {
10247
10681
  }
10248
10682
 
10249
10683
  /**
10250
- * This topic provides an example on how to query the MFA setting of the user named `u-00q8wbq42wiltcrk****`. The returned result shows that MFA is enabled for the user.
10251
- *
10252
- * @param request GetUserMFAAuthenticationSettingsRequest
10253
- * @return GetUserMFAAuthenticationSettingsResponse
10684
+ * @summary Queries the multi-factor authentication (MFA) setting of a single user.
10685
+ *
10686
+ * @description This topic provides an example on how to query the MFA setting of the user named `u-00q8wbq42wiltcrk****`. The returned result shows that MFA is enabled for the user.
10687
+ *
10688
+ * @param request GetUserMFAAuthenticationSettingsRequest
10689
+ * @return GetUserMFAAuthenticationSettingsResponse
10254
10690
  */
10255
10691
  async getUserMFAAuthenticationSettings(request: GetUserMFAAuthenticationSettingsRequest): Promise<GetUserMFAAuthenticationSettingsResponse> {
10256
10692
  let runtime = new $Util.RuntimeOptions({ });
10257
10693
  return await this.getUserMFAAuthenticationSettingsWithOptions(request, runtime);
10258
10694
  }
10259
10695
 
10696
+ /**
10697
+ * @summary Queries a Resource Access Management (RAM) user provisioning.
10698
+ *
10699
+ * @param request GetUserProvisioningRequest
10700
+ * @param runtime runtime options for this request RuntimeOptions
10701
+ * @return GetUserProvisioningResponse
10702
+ */
10260
10703
  async getUserProvisioningWithOptions(request: GetUserProvisioningRequest, runtime: $Util.RuntimeOptions): Promise<GetUserProvisioningResponse> {
10261
10704
  Util.validateModel(request);
10262
10705
  let query = { };
@@ -10285,11 +10728,24 @@ export default class Client extends OpenApi {
10285
10728
  return $tea.cast<GetUserProvisioningResponse>(await this.callApi(params, req, runtime), new GetUserProvisioningResponse({}));
10286
10729
  }
10287
10730
 
10731
+ /**
10732
+ * @summary Queries a Resource Access Management (RAM) user provisioning.
10733
+ *
10734
+ * @param request GetUserProvisioningRequest
10735
+ * @return GetUserProvisioningResponse
10736
+ */
10288
10737
  async getUserProvisioning(request: GetUserProvisioningRequest): Promise<GetUserProvisioningResponse> {
10289
10738
  let runtime = new $Util.RuntimeOptions({ });
10290
10739
  return await this.getUserProvisioningWithOptions(request, runtime);
10291
10740
  }
10292
10741
 
10742
+ /**
10743
+ * @summary Queries the global configurations of a Resource Access Management (RAM) user provisioning.
10744
+ *
10745
+ * @param request GetUserProvisioningConfigurationRequest
10746
+ * @param runtime runtime options for this request RuntimeOptions
10747
+ * @return GetUserProvisioningConfigurationResponse
10748
+ */
10293
10749
  async getUserProvisioningConfigurationWithOptions(request: GetUserProvisioningConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<GetUserProvisioningConfigurationResponse> {
10294
10750
  Util.validateModel(request);
10295
10751
  let query = { };
@@ -10314,11 +10770,24 @@ export default class Client extends OpenApi {
10314
10770
  return $tea.cast<GetUserProvisioningConfigurationResponse>(await this.callApi(params, req, runtime), new GetUserProvisioningConfigurationResponse({}));
10315
10771
  }
10316
10772
 
10773
+ /**
10774
+ * @summary Queries the global configurations of a Resource Access Management (RAM) user provisioning.
10775
+ *
10776
+ * @param request GetUserProvisioningConfigurationRequest
10777
+ * @return GetUserProvisioningConfigurationResponse
10778
+ */
10317
10779
  async getUserProvisioningConfiguration(request: GetUserProvisioningConfigurationRequest): Promise<GetUserProvisioningConfigurationResponse> {
10318
10780
  let runtime = new $Util.RuntimeOptions({ });
10319
10781
  return await this.getUserProvisioningConfigurationWithOptions(request, runtime);
10320
10782
  }
10321
10783
 
10784
+ /**
10785
+ * @summary Queries a Resource Access Management (RAM) user provisioning event.
10786
+ *
10787
+ * @param request GetUserProvisioningEventRequest
10788
+ * @param runtime runtime options for this request RuntimeOptions
10789
+ * @return GetUserProvisioningEventResponse
10790
+ */
10322
10791
  async getUserProvisioningEventWithOptions(request: GetUserProvisioningEventRequest, runtime: $Util.RuntimeOptions): Promise<GetUserProvisioningEventResponse> {
10323
10792
  Util.validateModel(request);
10324
10793
  let query = { };
@@ -10347,11 +10816,24 @@ export default class Client extends OpenApi {
10347
10816
  return $tea.cast<GetUserProvisioningEventResponse>(await this.callApi(params, req, runtime), new GetUserProvisioningEventResponse({}));
10348
10817
  }
10349
10818
 
10819
+ /**
10820
+ * @summary Queries a Resource Access Management (RAM) user provisioning event.
10821
+ *
10822
+ * @param request GetUserProvisioningEventRequest
10823
+ * @return GetUserProvisioningEventResponse
10824
+ */
10350
10825
  async getUserProvisioningEvent(request: GetUserProvisioningEventRequest): Promise<GetUserProvisioningEventResponse> {
10351
10826
  let runtime = new $Util.RuntimeOptions({ });
10352
10827
  return await this.getUserProvisioningEventWithOptions(request, runtime);
10353
10828
  }
10354
10829
 
10830
+ /**
10831
+ * @summary Queries statistics of Resource Access Management (RAM) user provisioning events that are created for the member in a resource directory.
10832
+ *
10833
+ * @param request GetUserProvisioningRdAccountStatisticsRequest
10834
+ * @param runtime runtime options for this request RuntimeOptions
10835
+ * @return GetUserProvisioningRdAccountStatisticsResponse
10836
+ */
10355
10837
  async getUserProvisioningRdAccountStatisticsWithOptions(request: GetUserProvisioningRdAccountStatisticsRequest, runtime: $Util.RuntimeOptions): Promise<GetUserProvisioningRdAccountStatisticsResponse> {
10356
10838
  Util.validateModel(request);
10357
10839
  let query = { };
@@ -10380,11 +10862,24 @@ export default class Client extends OpenApi {
10380
10862
  return $tea.cast<GetUserProvisioningRdAccountStatisticsResponse>(await this.callApi(params, req, runtime), new GetUserProvisioningRdAccountStatisticsResponse({}));
10381
10863
  }
10382
10864
 
10865
+ /**
10866
+ * @summary Queries statistics of Resource Access Management (RAM) user provisioning events that are created for the member in a resource directory.
10867
+ *
10868
+ * @param request GetUserProvisioningRdAccountStatisticsRequest
10869
+ * @return GetUserProvisioningRdAccountStatisticsResponse
10870
+ */
10383
10871
  async getUserProvisioningRdAccountStatistics(request: GetUserProvisioningRdAccountStatisticsRequest): Promise<GetUserProvisioningRdAccountStatisticsResponse> {
10384
10872
  let runtime = new $Util.RuntimeOptions({ });
10385
10873
  return await this.getUserProvisioningRdAccountStatisticsWithOptions(request, runtime);
10386
10874
  }
10387
10875
 
10876
+ /**
10877
+ * @summary Queries the statistics of a Resource Access Management (RAM) user provisioning.
10878
+ *
10879
+ * @param request GetUserProvisioningStatisticsRequest
10880
+ * @param runtime runtime options for this request RuntimeOptions
10881
+ * @return GetUserProvisioningStatisticsResponse
10882
+ */
10388
10883
  async getUserProvisioningStatisticsWithOptions(request: GetUserProvisioningStatisticsRequest, runtime: $Util.RuntimeOptions): Promise<GetUserProvisioningStatisticsResponse> {
10389
10884
  Util.validateModel(request);
10390
10885
  let query = { };
@@ -10413,17 +10908,25 @@ export default class Client extends OpenApi {
10413
10908
  return $tea.cast<GetUserProvisioningStatisticsResponse>(await this.callApi(params, req, runtime), new GetUserProvisioningStatisticsResponse({}));
10414
10909
  }
10415
10910
 
10911
+ /**
10912
+ * @summary Queries the statistics of a Resource Access Management (RAM) user provisioning.
10913
+ *
10914
+ * @param request GetUserProvisioningStatisticsRequest
10915
+ * @return GetUserProvisioningStatisticsResponse
10916
+ */
10416
10917
  async getUserProvisioningStatistics(request: GetUserProvisioningStatisticsRequest): Promise<GetUserProvisioningStatisticsResponse> {
10417
10918
  let runtime = new $Util.RuntimeOptions({ });
10418
10919
  return await this.getUserProvisioningStatisticsWithOptions(request, runtime);
10419
10920
  }
10420
10921
 
10421
10922
  /**
10422
- * This topic provides an example on how to query the assigned access permissions on the account `114240524784****` in your resource directory. The returned result shows that access permissions on the account in your resource directory is assigned to one user.
10423
- *
10424
- * @param request ListAccessAssignmentsRequest
10425
- * @param runtime runtime options for this request RuntimeOptions
10426
- * @return ListAccessAssignmentsResponse
10923
+ * @summary Queries the access permissions that are assigned.
10924
+ *
10925
+ * @description This topic provides an example on how to query the assigned access permissions on the account `114240524784****` in your resource directory. The returned result shows that access permissions on the account in your resource directory is assigned to one user.
10926
+ *
10927
+ * @param request ListAccessAssignmentsRequest
10928
+ * @param runtime runtime options for this request RuntimeOptions
10929
+ * @return ListAccessAssignmentsResponse
10427
10930
  */
10428
10931
  async listAccessAssignmentsWithOptions(request: ListAccessAssignmentsRequest, runtime: $Util.RuntimeOptions): Promise<ListAccessAssignmentsResponse> {
10429
10932
  Util.validateModel(request);
@@ -10478,10 +10981,12 @@ export default class Client extends OpenApi {
10478
10981
  }
10479
10982
 
10480
10983
  /**
10481
- * This topic provides an example on how to query the assigned access permissions on the account `114240524784****` in your resource directory. The returned result shows that access permissions on the account in your resource directory is assigned to one user.
10482
- *
10483
- * @param request ListAccessAssignmentsRequest
10484
- * @return ListAccessAssignmentsResponse
10984
+ * @summary Queries the access permissions that are assigned.
10985
+ *
10986
+ * @description This topic provides an example on how to query the assigned access permissions on the account `114240524784****` in your resource directory. The returned result shows that access permissions on the account in your resource directory is assigned to one user.
10987
+ *
10988
+ * @param request ListAccessAssignmentsRequest
10989
+ * @return ListAccessAssignmentsResponse
10485
10990
  */
10486
10991
  async listAccessAssignments(request: ListAccessAssignmentsRequest): Promise<ListAccessAssignmentsResponse> {
10487
10992
  let runtime = new $Util.RuntimeOptions({ });
@@ -10489,11 +10994,13 @@ export default class Client extends OpenApi {
10489
10994
  }
10490
10995
 
10491
10996
  /**
10492
- * This topic provides an example on how to query the accounts for which the access permission `ac-00ccule7tadaijxc****` is provisioned. The returned result shows that the access configuration is provisioned for two accounts in your resource directory.
10493
- *
10494
- * @param request ListAccessConfigurationProvisioningsRequest
10495
- * @param runtime runtime options for this request RuntimeOptions
10496
- * @return ListAccessConfigurationProvisioningsResponse
10997
+ * @summary Queries the access configurations that are provisioned.
10998
+ *
10999
+ * @description This topic provides an example on how to query the accounts for which the access permission `ac-00ccule7tadaijxc****` is provisioned. The returned result shows that the access configuration is provisioned for two accounts in your resource directory.
11000
+ *
11001
+ * @param request ListAccessConfigurationProvisioningsRequest
11002
+ * @param runtime runtime options for this request RuntimeOptions
11003
+ * @return ListAccessConfigurationProvisioningsResponse
10497
11004
  */
10498
11005
  async listAccessConfigurationProvisioningsWithOptions(request: ListAccessConfigurationProvisioningsRequest, runtime: $Util.RuntimeOptions): Promise<ListAccessConfigurationProvisioningsResponse> {
10499
11006
  Util.validateModel(request);
@@ -10544,10 +11051,12 @@ export default class Client extends OpenApi {
10544
11051
  }
10545
11052
 
10546
11053
  /**
10547
- * This topic provides an example on how to query the accounts for which the access permission `ac-00ccule7tadaijxc****` is provisioned. The returned result shows that the access configuration is provisioned for two accounts in your resource directory.
10548
- *
10549
- * @param request ListAccessConfigurationProvisioningsRequest
10550
- * @return ListAccessConfigurationProvisioningsResponse
11054
+ * @summary Queries the access configurations that are provisioned.
11055
+ *
11056
+ * @description This topic provides an example on how to query the accounts for which the access permission `ac-00ccule7tadaijxc****` is provisioned. The returned result shows that the access configuration is provisioned for two accounts in your resource directory.
11057
+ *
11058
+ * @param request ListAccessConfigurationProvisioningsRequest
11059
+ * @return ListAccessConfigurationProvisioningsResponse
10551
11060
  */
10552
11061
  async listAccessConfigurationProvisionings(request: ListAccessConfigurationProvisioningsRequest): Promise<ListAccessConfigurationProvisioningsResponse> {
10553
11062
  let runtime = new $Util.RuntimeOptions({ });
@@ -10555,11 +11064,13 @@ export default class Client extends OpenApi {
10555
11064
  }
10556
11065
 
10557
11066
  /**
10558
- * This topic provides an example on how to query the access configurations within the directory `d-00fc2p61****`. The returned result shows that the directory contains the `VPC-Admin` and `ECS-Admin` access configurations.
10559
- *
10560
- * @param request ListAccessConfigurationsRequest
10561
- * @param runtime runtime options for this request RuntimeOptions
10562
- * @return ListAccessConfigurationsResponse
11067
+ * @summary Queries access configurations.
11068
+ *
11069
+ * @description This topic provides an example on how to query the access configurations within the directory `d-00fc2p61****`. The returned result shows that the directory contains the `VPC-Admin` and `ECS-Admin` access configurations.
11070
+ *
11071
+ * @param request ListAccessConfigurationsRequest
11072
+ * @param runtime runtime options for this request RuntimeOptions
11073
+ * @return ListAccessConfigurationsResponse
10563
11074
  */
10564
11075
  async listAccessConfigurationsWithOptions(request: ListAccessConfigurationsRequest, runtime: $Util.RuntimeOptions): Promise<ListAccessConfigurationsResponse> {
10565
11076
  Util.validateModel(request);
@@ -10602,10 +11113,12 @@ export default class Client extends OpenApi {
10602
11113
  }
10603
11114
 
10604
11115
  /**
10605
- * This topic provides an example on how to query the access configurations within the directory `d-00fc2p61****`. The returned result shows that the directory contains the `VPC-Admin` and `ECS-Admin` access configurations.
10606
- *
10607
- * @param request ListAccessConfigurationsRequest
10608
- * @return ListAccessConfigurationsResponse
11116
+ * @summary Queries access configurations.
11117
+ *
11118
+ * @description This topic provides an example on how to query the access configurations within the directory `d-00fc2p61****`. The returned result shows that the directory contains the `VPC-Admin` and `ECS-Admin` access configurations.
11119
+ *
11120
+ * @param request ListAccessConfigurationsRequest
11121
+ * @return ListAccessConfigurationsResponse
10609
11122
  */
10610
11123
  async listAccessConfigurations(request: ListAccessConfigurationsRequest): Promise<ListAccessConfigurationsResponse> {
10611
11124
  let runtime = new $Util.RuntimeOptions({ });
@@ -10613,11 +11126,13 @@ export default class Client extends OpenApi {
10613
11126
  }
10614
11127
 
10615
11128
  /**
10616
- * This topic provides an example on how to query the directories within your Alibaba Cloud account. The returned result shows that only one directory with the ID `d-00fc2p61****` is created within your Alibaba Cloud account.
10617
- *
10618
- * @param request ListDirectoriesRequest
10619
- * @param runtime runtime options for this request RuntimeOptions
10620
- * @return ListDirectoriesResponse
11129
+ * @summary Queries directories.
11130
+ *
11131
+ * @description This topic provides an example on how to query the directories within your Alibaba Cloud account. The returned result shows that only one directory with the ID `d-00fc2p61****` is created within your Alibaba Cloud account.
11132
+ *
11133
+ * @param request ListDirectoriesRequest
11134
+ * @param runtime runtime options for this request RuntimeOptions
11135
+ * @return ListDirectoriesResponse
10621
11136
  */
10622
11137
  async listDirectoriesWithOptions(runtime: $Util.RuntimeOptions): Promise<ListDirectoriesResponse> {
10623
11138
  let req = new $OpenApi.OpenApiRequest({ });
@@ -10636,9 +11151,11 @@ export default class Client extends OpenApi {
10636
11151
  }
10637
11152
 
10638
11153
  /**
10639
- * This topic provides an example on how to query the directories within your Alibaba Cloud account. The returned result shows that only one directory with the ID `d-00fc2p61****` is created within your Alibaba Cloud account.
10640
- *
10641
- * @return ListDirectoriesResponse
11154
+ * @summary Queries directories.
11155
+ *
11156
+ * @description This topic provides an example on how to query the directories within your Alibaba Cloud account. The returned result shows that only one directory with the ID `d-00fc2p61****` is created within your Alibaba Cloud account.
11157
+ *
11158
+ * @return ListDirectoriesResponse
10642
11159
  */
10643
11160
  async listDirectories(): Promise<ListDirectoriesResponse> {
10644
11161
  let runtime = new $Util.RuntimeOptions({ });
@@ -10646,11 +11163,13 @@ export default class Client extends OpenApi {
10646
11163
  }
10647
11164
 
10648
11165
  /**
10649
- * This topic provides an example on how to query the SAML signing certificates within the directory `d-00fc2p61****`. The returned result shows that the directory contains one SAML signing certificate.
10650
- *
10651
- * @param request ListExternalSAMLIdPCertificatesRequest
10652
- * @param runtime runtime options for this request RuntimeOptions
10653
- * @return ListExternalSAMLIdPCertificatesResponse
11166
+ * @summary Queries Security Assertion Markup Language (SAML) signing certificates.
11167
+ *
11168
+ * @description This topic provides an example on how to query the SAML signing certificates within the directory `d-00fc2p61****`. The returned result shows that the directory contains one SAML signing certificate.
11169
+ *
11170
+ * @param request ListExternalSAMLIdPCertificatesRequest
11171
+ * @param runtime runtime options for this request RuntimeOptions
11172
+ * @return ListExternalSAMLIdPCertificatesResponse
10654
11173
  */
10655
11174
  async listExternalSAMLIdPCertificatesWithOptions(request: ListExternalSAMLIdPCertificatesRequest, runtime: $Util.RuntimeOptions): Promise<ListExternalSAMLIdPCertificatesResponse> {
10656
11175
  Util.validateModel(request);
@@ -10677,10 +11196,12 @@ export default class Client extends OpenApi {
10677
11196
  }
10678
11197
 
10679
11198
  /**
10680
- * This topic provides an example on how to query the SAML signing certificates within the directory `d-00fc2p61****`. The returned result shows that the directory contains one SAML signing certificate.
10681
- *
10682
- * @param request ListExternalSAMLIdPCertificatesRequest
10683
- * @return ListExternalSAMLIdPCertificatesResponse
11199
+ * @summary Queries Security Assertion Markup Language (SAML) signing certificates.
11200
+ *
11201
+ * @description This topic provides an example on how to query the SAML signing certificates within the directory `d-00fc2p61****`. The returned result shows that the directory contains one SAML signing certificate.
11202
+ *
11203
+ * @param request ListExternalSAMLIdPCertificatesRequest
11204
+ * @return ListExternalSAMLIdPCertificatesResponse
10684
11205
  */
10685
11206
  async listExternalSAMLIdPCertificates(request: ListExternalSAMLIdPCertificatesRequest): Promise<ListExternalSAMLIdPCertificatesResponse> {
10686
11207
  let runtime = new $Util.RuntimeOptions({ });
@@ -10688,11 +11209,13 @@ export default class Client extends OpenApi {
10688
11209
  }
10689
11210
 
10690
11211
  /**
10691
- * This topic provides an example on how to query the users in the group `g-00jqzghi2n3o5hkh****`. The returned result shows that the group contains the user `Alice` and the user `user1`.
10692
- *
10693
- * @param request ListGroupMembersRequest
10694
- * @param runtime runtime options for this request RuntimeOptions
10695
- * @return ListGroupMembersResponse
11212
+ * @summary Queries the users in a group.
11213
+ *
11214
+ * @description This topic provides an example on how to query the users in the group `g-00jqzghi2n3o5hkh****`. The returned result shows that the group contains the user `Alice` and the user `user1`.
11215
+ *
11216
+ * @param request ListGroupMembersRequest
11217
+ * @param runtime runtime options for this request RuntimeOptions
11218
+ * @return ListGroupMembersResponse
10696
11219
  */
10697
11220
  async listGroupMembersWithOptions(request: ListGroupMembersRequest, runtime: $Util.RuntimeOptions): Promise<ListGroupMembersResponse> {
10698
11221
  Util.validateModel(request);
@@ -10731,10 +11254,12 @@ export default class Client extends OpenApi {
10731
11254
  }
10732
11255
 
10733
11256
  /**
10734
- * This topic provides an example on how to query the users in the group `g-00jqzghi2n3o5hkh****`. The returned result shows that the group contains the user `Alice` and the user `user1`.
10735
- *
10736
- * @param request ListGroupMembersRequest
10737
- * @return ListGroupMembersResponse
11257
+ * @summary Queries the users in a group.
11258
+ *
11259
+ * @description This topic provides an example on how to query the users in the group `g-00jqzghi2n3o5hkh****`. The returned result shows that the group contains the user `Alice` and the user `user1`.
11260
+ *
11261
+ * @param request ListGroupMembersRequest
11262
+ * @return ListGroupMembersResponse
10738
11263
  */
10739
11264
  async listGroupMembers(request: ListGroupMembersRequest): Promise<ListGroupMembersResponse> {
10740
11265
  let runtime = new $Util.RuntimeOptions({ });
@@ -10742,11 +11267,13 @@ export default class Client extends OpenApi {
10742
11267
  }
10743
11268
 
10744
11269
  /**
10745
- * This topic provides an example on how to query the groups in the directory `d-00fc2p61****`. The returned result shows that the directory contains three groups. The groups `group1` and `group2` are synchronized from an external identity provider (IdP). The group `TestGroup` is manually created in CloudSSO.
10746
- *
10747
- * @param request ListGroupsRequest
10748
- * @param runtime runtime options for this request RuntimeOptions
10749
- * @return ListGroupsResponse
11270
+ * @summary Queries groups.
11271
+ *
11272
+ * @description This topic provides an example on how to query the groups in the directory `d-00fc2p61****`. The returned result shows that the directory contains three groups. The groups `group1` and `group2` are synchronized from an external identity provider (IdP). The group `TestGroup` is manually created in CloudSSO.
11273
+ *
11274
+ * @param request ListGroupsRequest
11275
+ * @param runtime runtime options for this request RuntimeOptions
11276
+ * @return ListGroupsResponse
10750
11277
  */
10751
11278
  async listGroupsWithOptions(request: ListGroupsRequest, runtime: $Util.RuntimeOptions): Promise<ListGroupsResponse> {
10752
11279
  Util.validateModel(request);
@@ -10789,10 +11316,12 @@ export default class Client extends OpenApi {
10789
11316
  }
10790
11317
 
10791
11318
  /**
10792
- * This topic provides an example on how to query the groups in the directory `d-00fc2p61****`. The returned result shows that the directory contains three groups. The groups `group1` and `group2` are synchronized from an external identity provider (IdP). The group `TestGroup` is manually created in CloudSSO.
10793
- *
10794
- * @param request ListGroupsRequest
10795
- * @return ListGroupsResponse
11319
+ * @summary Queries groups.
11320
+ *
11321
+ * @description This topic provides an example on how to query the groups in the directory `d-00fc2p61****`. The returned result shows that the directory contains three groups. The groups `group1` and `group2` are synchronized from an external identity provider (IdP). The group `TestGroup` is manually created in CloudSSO.
11322
+ *
11323
+ * @param request ListGroupsRequest
11324
+ * @return ListGroupsResponse
10796
11325
  */
10797
11326
  async listGroups(request: ListGroupsRequest): Promise<ListGroupsResponse> {
10798
11327
  let runtime = new $Util.RuntimeOptions({ });
@@ -10800,11 +11329,13 @@ export default class Client extends OpenApi {
10800
11329
  }
10801
11330
 
10802
11331
  /**
10803
- * This topic provides an example on how to query the groups to which the user `u-00q8wbq42wiltcrk****` is added. The returned result shows that the user is added to both the `TestGroup` and the `group1` groups.
10804
- *
10805
- * @param request ListJoinedGroupsForUserRequest
10806
- * @param runtime runtime options for this request RuntimeOptions
10807
- * @return ListJoinedGroupsForUserResponse
11332
+ * @summary Queries the groups to which a user is added.
11333
+ *
11334
+ * @description This topic provides an example on how to query the groups to which the user `u-00q8wbq42wiltcrk****` is added. The returned result shows that the user is added to both the `TestGroup` and the `group1` groups.
11335
+ *
11336
+ * @param request ListJoinedGroupsForUserRequest
11337
+ * @param runtime runtime options for this request RuntimeOptions
11338
+ * @return ListJoinedGroupsForUserResponse
10808
11339
  */
10809
11340
  async listJoinedGroupsForUserWithOptions(request: ListJoinedGroupsForUserRequest, runtime: $Util.RuntimeOptions): Promise<ListJoinedGroupsForUserResponse> {
10810
11341
  Util.validateModel(request);
@@ -10843,10 +11374,12 @@ export default class Client extends OpenApi {
10843
11374
  }
10844
11375
 
10845
11376
  /**
10846
- * This topic provides an example on how to query the groups to which the user `u-00q8wbq42wiltcrk****` is added. The returned result shows that the user is added to both the `TestGroup` and the `group1` groups.
10847
- *
10848
- * @param request ListJoinedGroupsForUserRequest
10849
- * @return ListJoinedGroupsForUserResponse
11377
+ * @summary Queries the groups to which a user is added.
11378
+ *
11379
+ * @description This topic provides an example on how to query the groups to which the user `u-00q8wbq42wiltcrk****` is added. The returned result shows that the user is added to both the `TestGroup` and the `group1` groups.
11380
+ *
11381
+ * @param request ListJoinedGroupsForUserRequest
11382
+ * @return ListJoinedGroupsForUserResponse
10850
11383
  */
10851
11384
  async listJoinedGroupsForUser(request: ListJoinedGroupsForUserRequest): Promise<ListJoinedGroupsForUserResponse> {
10852
11385
  let runtime = new $Util.RuntimeOptions({ });
@@ -10854,11 +11387,13 @@ export default class Client extends OpenApi {
10854
11387
  }
10855
11388
 
10856
11389
  /**
10857
- * This topic provides an example on how to query the MFA devices that are bound to the user `u-00q8wbq42wiltcrk****`. The returned result shows that the MFA device named `Alice-MFA1` is bound to the user.
10858
- *
10859
- * @param request ListMFADevicesForUserRequest
10860
- * @param runtime runtime options for this request RuntimeOptions
10861
- * @return ListMFADevicesForUserResponse
11390
+ * @summary Queries the multi-factor authentication (MFA) devices that are bound to a user. Up to two MFA devices can be bound to a user.
11391
+ *
11392
+ * @description This topic provides an example on how to query the MFA devices that are bound to the user `u-00q8wbq42wiltcrk****`. The returned result shows that the MFA device named `Alice-MFA1` is bound to the user.
11393
+ *
11394
+ * @param request ListMFADevicesForUserRequest
11395
+ * @param runtime runtime options for this request RuntimeOptions
11396
+ * @return ListMFADevicesForUserResponse
10862
11397
  */
10863
11398
  async listMFADevicesForUserWithOptions(request: ListMFADevicesForUserRequest, runtime: $Util.RuntimeOptions): Promise<ListMFADevicesForUserResponse> {
10864
11399
  Util.validateModel(request);
@@ -10889,10 +11424,12 @@ export default class Client extends OpenApi {
10889
11424
  }
10890
11425
 
10891
11426
  /**
10892
- * This topic provides an example on how to query the MFA devices that are bound to the user `u-00q8wbq42wiltcrk****`. The returned result shows that the MFA device named `Alice-MFA1` is bound to the user.
10893
- *
10894
- * @param request ListMFADevicesForUserRequest
10895
- * @return ListMFADevicesForUserResponse
11427
+ * @summary Queries the multi-factor authentication (MFA) devices that are bound to a user. Up to two MFA devices can be bound to a user.
11428
+ *
11429
+ * @description This topic provides an example on how to query the MFA devices that are bound to the user `u-00q8wbq42wiltcrk****`. The returned result shows that the MFA device named `Alice-MFA1` is bound to the user.
11430
+ *
11431
+ * @param request ListMFADevicesForUserRequest
11432
+ * @return ListMFADevicesForUserResponse
10896
11433
  */
10897
11434
  async listMFADevicesForUser(request: ListMFADevicesForUserRequest): Promise<ListMFADevicesForUserResponse> {
10898
11435
  let runtime = new $Util.RuntimeOptions({ });
@@ -10900,11 +11437,13 @@ export default class Client extends OpenApi {
10900
11437
  }
10901
11438
 
10902
11439
  /**
10903
- * This topic provides an example on how to query the policies that are created for the access configuration `ac-00jhtfl8thteu6uj****`. The returned result shows that the access configuration contains one system policy and one inline policy.
10904
- *
10905
- * @param request ListPermissionPoliciesInAccessConfigurationRequest
10906
- * @param runtime runtime options for this request RuntimeOptions
10907
- * @return ListPermissionPoliciesInAccessConfigurationResponse
11440
+ * @summary Queries the policies that are created for an access configuration.
11441
+ *
11442
+ * @description This topic provides an example on how to query the policies that are created for the access configuration `ac-00jhtfl8thteu6uj****`. The returned result shows that the access configuration contains one system policy and one inline policy.
11443
+ *
11444
+ * @param request ListPermissionPoliciesInAccessConfigurationRequest
11445
+ * @param runtime runtime options for this request RuntimeOptions
11446
+ * @return ListPermissionPoliciesInAccessConfigurationResponse
10908
11447
  */
10909
11448
  async listPermissionPoliciesInAccessConfigurationWithOptions(request: ListPermissionPoliciesInAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ListPermissionPoliciesInAccessConfigurationResponse> {
10910
11449
  Util.validateModel(request);
@@ -10939,10 +11478,12 @@ export default class Client extends OpenApi {
10939
11478
  }
10940
11479
 
10941
11480
  /**
10942
- * This topic provides an example on how to query the policies that are created for the access configuration `ac-00jhtfl8thteu6uj****`. The returned result shows that the access configuration contains one system policy and one inline policy.
10943
- *
10944
- * @param request ListPermissionPoliciesInAccessConfigurationRequest
10945
- * @return ListPermissionPoliciesInAccessConfigurationResponse
11481
+ * @summary Queries the policies that are created for an access configuration.
11482
+ *
11483
+ * @description This topic provides an example on how to query the policies that are created for the access configuration `ac-00jhtfl8thteu6uj****`. The returned result shows that the access configuration contains one system policy and one inline policy.
11484
+ *
11485
+ * @param request ListPermissionPoliciesInAccessConfigurationRequest
11486
+ * @return ListPermissionPoliciesInAccessConfigurationResponse
10946
11487
  */
10947
11488
  async listPermissionPoliciesInAccessConfiguration(request: ListPermissionPoliciesInAccessConfigurationRequest): Promise<ListPermissionPoliciesInAccessConfigurationResponse> {
10948
11489
  let runtime = new $Util.RuntimeOptions({ });
@@ -10950,11 +11491,13 @@ export default class Client extends OpenApi {
10950
11491
  }
10951
11492
 
10952
11493
  /**
10953
- * This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
10954
- *
10955
- * @param request ListSCIMServerCredentialsRequest
10956
- * @param runtime runtime options for this request RuntimeOptions
10957
- * @return ListSCIMServerCredentialsResponse
11494
+ * @summary Queries Cross-domain Identity Management (SCIM) credentials.
11495
+ *
11496
+ * @description This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
11497
+ *
11498
+ * @param request ListSCIMServerCredentialsRequest
11499
+ * @param runtime runtime options for this request RuntimeOptions
11500
+ * @return ListSCIMServerCredentialsResponse
10958
11501
  */
10959
11502
  async listSCIMServerCredentialsWithOptions(request: ListSCIMServerCredentialsRequest, runtime: $Util.RuntimeOptions): Promise<ListSCIMServerCredentialsResponse> {
10960
11503
  Util.validateModel(request);
@@ -10981,10 +11524,12 @@ export default class Client extends OpenApi {
10981
11524
  }
10982
11525
 
10983
11526
  /**
10984
- * This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
10985
- *
10986
- * @param request ListSCIMServerCredentialsRequest
10987
- * @return ListSCIMServerCredentialsResponse
11527
+ * @summary Queries Cross-domain Identity Management (SCIM) credentials.
11528
+ *
11529
+ * @description This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
11530
+ *
11531
+ * @param request ListSCIMServerCredentialsRequest
11532
+ * @return ListSCIMServerCredentialsResponse
10988
11533
  */
10989
11534
  async listSCIMServerCredentials(request: ListSCIMServerCredentialsRequest): Promise<ListSCIMServerCredentialsResponse> {
10990
11535
  let runtime = new $Util.RuntimeOptions({ });
@@ -10992,12 +11537,14 @@ export default class Client extends OpenApi {
10992
11537
  }
10993
11538
 
10994
11539
  /**
10995
- * By default, this operation queries the tasks within the previous 24 hours. This operation allows you to query the tasks within a maximum of 7 days. You can specify the start time of the query by using `Filter`.
10996
- * This topic provides an example on how to query the tasks within the previous 24 hours.
10997
- *
10998
- * @param request ListTasksRequest
10999
- * @param runtime runtime options for this request RuntimeOptions
11000
- * @return ListTasksResponse
11540
+ * @summary Queries asynchronous tasks.
11541
+ *
11542
+ * @description By default, this operation queries the tasks within the previous 24 hours. This operation allows you to query the tasks within a maximum of 7 days. You can specify the start time of the query by using `Filter`.
11543
+ * This topic provides an example on how to query the tasks within the previous 24 hours.
11544
+ *
11545
+ * @param request ListTasksRequest
11546
+ * @param runtime runtime options for this request RuntimeOptions
11547
+ * @return ListTasksResponse
11001
11548
  */
11002
11549
  async listTasksWithOptions(request: ListTasksRequest, runtime: $Util.RuntimeOptions): Promise<ListTasksResponse> {
11003
11550
  Util.validateModel(request);
@@ -11064,17 +11611,26 @@ export default class Client extends OpenApi {
11064
11611
  }
11065
11612
 
11066
11613
  /**
11067
- * By default, this operation queries the tasks within the previous 24 hours. This operation allows you to query the tasks within a maximum of 7 days. You can specify the start time of the query by using `Filter`.
11068
- * This topic provides an example on how to query the tasks within the previous 24 hours.
11069
- *
11070
- * @param request ListTasksRequest
11071
- * @return ListTasksResponse
11614
+ * @summary Queries asynchronous tasks.
11615
+ *
11616
+ * @description By default, this operation queries the tasks within the previous 24 hours. This operation allows you to query the tasks within a maximum of 7 days. You can specify the start time of the query by using `Filter`.
11617
+ * This topic provides an example on how to query the tasks within the previous 24 hours.
11618
+ *
11619
+ * @param request ListTasksRequest
11620
+ * @return ListTasksResponse
11072
11621
  */
11073
11622
  async listTasks(request: ListTasksRequest): Promise<ListTasksResponse> {
11074
11623
  let runtime = new $Util.RuntimeOptions({ });
11075
11624
  return await this.listTasksWithOptions(request, runtime);
11076
11625
  }
11077
11626
 
11627
+ /**
11628
+ * @summary Queries Resource Access Management (RAM) user provisioning events.
11629
+ *
11630
+ * @param request ListUserProvisioningEventsRequest
11631
+ * @param runtime runtime options for this request RuntimeOptions
11632
+ * @return ListUserProvisioningEventsResponse
11633
+ */
11078
11634
  async listUserProvisioningEventsWithOptions(request: ListUserProvisioningEventsRequest, runtime: $Util.RuntimeOptions): Promise<ListUserProvisioningEventsResponse> {
11079
11635
  Util.validateModel(request);
11080
11636
  let query = { };
@@ -11111,11 +11667,24 @@ export default class Client extends OpenApi {
11111
11667
  return $tea.cast<ListUserProvisioningEventsResponse>(await this.callApi(params, req, runtime), new ListUserProvisioningEventsResponse({}));
11112
11668
  }
11113
11669
 
11670
+ /**
11671
+ * @summary Queries Resource Access Management (RAM) user provisioning events.
11672
+ *
11673
+ * @param request ListUserProvisioningEventsRequest
11674
+ * @return ListUserProvisioningEventsResponse
11675
+ */
11114
11676
  async listUserProvisioningEvents(request: ListUserProvisioningEventsRequest): Promise<ListUserProvisioningEventsResponse> {
11115
11677
  let runtime = new $Util.RuntimeOptions({ });
11116
11678
  return await this.listUserProvisioningEventsWithOptions(request, runtime);
11117
11679
  }
11118
11680
 
11681
+ /**
11682
+ * @summary Queries Resource Access Management (RAM) user provisionings.
11683
+ *
11684
+ * @param request ListUserProvisioningsRequest
11685
+ * @param runtime runtime options for this request RuntimeOptions
11686
+ * @return ListUserProvisioningsResponse
11687
+ */
11119
11688
  async listUserProvisioningsWithOptions(request: ListUserProvisioningsRequest, runtime: $Util.RuntimeOptions): Promise<ListUserProvisioningsResponse> {
11120
11689
  Util.validateModel(request);
11121
11690
  let query = { };
@@ -11164,17 +11733,25 @@ export default class Client extends OpenApi {
11164
11733
  return $tea.cast<ListUserProvisioningsResponse>(await this.callApi(params, req, runtime), new ListUserProvisioningsResponse({}));
11165
11734
  }
11166
11735
 
11736
+ /**
11737
+ * @summary Queries Resource Access Management (RAM) user provisionings.
11738
+ *
11739
+ * @param request ListUserProvisioningsRequest
11740
+ * @return ListUserProvisioningsResponse
11741
+ */
11167
11742
  async listUserProvisionings(request: ListUserProvisioningsRequest): Promise<ListUserProvisioningsResponse> {
11168
11743
  let runtime = new $Util.RuntimeOptions({ });
11169
11744
  return await this.listUserProvisioningsWithOptions(request, runtime);
11170
11745
  }
11171
11746
 
11172
11747
  /**
11173
- * This topic provides an example on how to query users in the `d-00fc2p61****` directory. The returned result shows that the directory contains two users. The user `AliceLee` is synchronized from an external identity provider (IdP). The user `user1` is manually created within CloudSSO.
11174
- *
11175
- * @param request ListUsersRequest
11176
- * @param runtime runtime options for this request RuntimeOptions
11177
- * @return ListUsersResponse
11748
+ * @summary Queries users.
11749
+ *
11750
+ * @description This topic provides an example on how to query users in the `d-00fc2p61****` directory. The returned result shows that the directory contains two users. The user `AliceLee` is synchronized from an external identity provider (IdP). The user `user1` is manually created within CloudSSO.
11751
+ *
11752
+ * @param request ListUsersRequest
11753
+ * @param runtime runtime options for this request RuntimeOptions
11754
+ * @return ListUsersResponse
11178
11755
  */
11179
11756
  async listUsersWithOptions(request: ListUsersRequest, runtime: $Util.RuntimeOptions): Promise<ListUsersResponse> {
11180
11757
  Util.validateModel(request);
@@ -11221,10 +11798,12 @@ export default class Client extends OpenApi {
11221
11798
  }
11222
11799
 
11223
11800
  /**
11224
- * This topic provides an example on how to query users in the `d-00fc2p61****` directory. The returned result shows that the directory contains two users. The user `AliceLee` is synchronized from an external identity provider (IdP). The user `user1` is manually created within CloudSSO.
11225
- *
11226
- * @param request ListUsersRequest
11227
- * @return ListUsersResponse
11801
+ * @summary Queries users.
11802
+ *
11803
+ * @description This topic provides an example on how to query users in the `d-00fc2p61****` directory. The returned result shows that the directory contains two users. The user `AliceLee` is synchronized from an external identity provider (IdP). The user `user1` is manually created within CloudSSO.
11804
+ *
11805
+ * @param request ListUsersRequest
11806
+ * @return ListUsersResponse
11228
11807
  */
11229
11808
  async listUsers(request: ListUsersRequest): Promise<ListUsersResponse> {
11230
11809
  let runtime = new $Util.RuntimeOptions({ });
@@ -11232,12 +11811,14 @@ export default class Client extends OpenApi {
11232
11811
  }
11233
11812
 
11234
11813
  /**
11235
- * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
11236
- * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
11237
- *
11238
- * @param request ProvisionAccessConfigurationRequest
11239
- * @param runtime runtime options for this request RuntimeOptions
11240
- * @return ProvisionAccessConfigurationResponse
11814
+ * @summary Provisions an access configuration for an account in your resource directory.
11815
+ *
11816
+ * @description When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
11817
+ * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
11818
+ *
11819
+ * @param request ProvisionAccessConfigurationRequest
11820
+ * @param runtime runtime options for this request RuntimeOptions
11821
+ * @return ProvisionAccessConfigurationResponse
11241
11822
  */
11242
11823
  async provisionAccessConfigurationWithOptions(request: ProvisionAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ProvisionAccessConfigurationResponse> {
11243
11824
  Util.validateModel(request);
@@ -11276,11 +11857,13 @@ export default class Client extends OpenApi {
11276
11857
  }
11277
11858
 
11278
11859
  /**
11279
- * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
11280
- * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
11281
- *
11282
- * @param request ProvisionAccessConfigurationRequest
11283
- * @return ProvisionAccessConfigurationResponse
11860
+ * @summary Provisions an access configuration for an account in your resource directory.
11861
+ *
11862
+ * @description When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
11863
+ * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
11864
+ *
11865
+ * @param request ProvisionAccessConfigurationRequest
11866
+ * @return ProvisionAccessConfigurationResponse
11284
11867
  */
11285
11868
  async provisionAccessConfiguration(request: ProvisionAccessConfigurationRequest): Promise<ProvisionAccessConfigurationResponse> {
11286
11869
  let runtime = new $Util.RuntimeOptions({ });
@@ -11288,11 +11871,13 @@ export default class Client extends OpenApi {
11288
11871
  }
11289
11872
 
11290
11873
  /**
11291
- * This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
11292
- *
11293
- * @param request RemoveExternalSAMLIdPCertificateRequest
11294
- * @param runtime runtime options for this request RuntimeOptions
11295
- * @return RemoveExternalSAMLIdPCertificateResponse
11874
+ * @summary Removes a Security Assertion Markup Language (SAML) signing certificate.
11875
+ *
11876
+ * @description This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
11877
+ *
11878
+ * @param request RemoveExternalSAMLIdPCertificateRequest
11879
+ * @param runtime runtime options for this request RuntimeOptions
11880
+ * @return RemoveExternalSAMLIdPCertificateResponse
11296
11881
  */
11297
11882
  async removeExternalSAMLIdPCertificateWithOptions(request: RemoveExternalSAMLIdPCertificateRequest, runtime: $Util.RuntimeOptions): Promise<RemoveExternalSAMLIdPCertificateResponse> {
11298
11883
  Util.validateModel(request);
@@ -11323,10 +11908,12 @@ export default class Client extends OpenApi {
11323
11908
  }
11324
11909
 
11325
11910
  /**
11326
- * This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
11327
- *
11328
- * @param request RemoveExternalSAMLIdPCertificateRequest
11329
- * @return RemoveExternalSAMLIdPCertificateResponse
11911
+ * @summary Removes a Security Assertion Markup Language (SAML) signing certificate.
11912
+ *
11913
+ * @description This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
11914
+ *
11915
+ * @param request RemoveExternalSAMLIdPCertificateRequest
11916
+ * @return RemoveExternalSAMLIdPCertificateResponse
11330
11917
  */
11331
11918
  async removeExternalSAMLIdPCertificate(request: RemoveExternalSAMLIdPCertificateRequest): Promise<RemoveExternalSAMLIdPCertificateResponse> {
11332
11919
  let runtime = new $Util.RuntimeOptions({ });
@@ -11334,12 +11921,14 @@ export default class Client extends OpenApi {
11334
11921
  }
11335
11922
 
11336
11923
  /**
11337
- * After you remove an inline policy from an access configuration, the policy cannot be restored.
11338
- * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
11339
- *
11340
- * @param request RemovePermissionPolicyFromAccessConfigurationRequest
11341
- * @param runtime runtime options for this request RuntimeOptions
11342
- * @return RemovePermissionPolicyFromAccessConfigurationResponse
11924
+ * @summary Removes a policy from an access configuration.
11925
+ *
11926
+ * @description After you remove an inline policy from an access configuration, the policy cannot be restored.
11927
+ * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
11928
+ *
11929
+ * @param request RemovePermissionPolicyFromAccessConfigurationRequest
11930
+ * @param runtime runtime options for this request RuntimeOptions
11931
+ * @return RemovePermissionPolicyFromAccessConfigurationResponse
11343
11932
  */
11344
11933
  async removePermissionPolicyFromAccessConfigurationWithOptions(request: RemovePermissionPolicyFromAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<RemovePermissionPolicyFromAccessConfigurationResponse> {
11345
11934
  Util.validateModel(request);
@@ -11378,11 +11967,13 @@ export default class Client extends OpenApi {
11378
11967
  }
11379
11968
 
11380
11969
  /**
11381
- * After you remove an inline policy from an access configuration, the policy cannot be restored.
11382
- * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
11383
- *
11384
- * @param request RemovePermissionPolicyFromAccessConfigurationRequest
11385
- * @return RemovePermissionPolicyFromAccessConfigurationResponse
11970
+ * @summary Removes a policy from an access configuration.
11971
+ *
11972
+ * @description After you remove an inline policy from an access configuration, the policy cannot be restored.
11973
+ * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
11974
+ *
11975
+ * @param request RemovePermissionPolicyFromAccessConfigurationRequest
11976
+ * @return RemovePermissionPolicyFromAccessConfigurationResponse
11386
11977
  */
11387
11978
  async removePermissionPolicyFromAccessConfiguration(request: RemovePermissionPolicyFromAccessConfigurationRequest): Promise<RemovePermissionPolicyFromAccessConfigurationResponse> {
11388
11979
  let runtime = new $Util.RuntimeOptions({ });
@@ -11390,12 +11981,14 @@ export default class Client extends OpenApi {
11390
11981
  }
11391
11982
 
11392
11983
  /**
11393
- * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot remove a user from a group that is synchronized by using SCIM.
11394
- * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
11395
- *
11396
- * @param request RemoveUserFromGroupRequest
11397
- * @param runtime runtime options for this request RuntimeOptions
11398
- * @return RemoveUserFromGroupResponse
11984
+ * @summary Removes a user from a group.
11985
+ *
11986
+ * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot remove a user from a group that is synchronized by using SCIM.
11987
+ * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
11988
+ *
11989
+ * @param request RemoveUserFromGroupRequest
11990
+ * @param runtime runtime options for this request RuntimeOptions
11991
+ * @return RemoveUserFromGroupResponse
11399
11992
  */
11400
11993
  async removeUserFromGroupWithOptions(request: RemoveUserFromGroupRequest, runtime: $Util.RuntimeOptions): Promise<RemoveUserFromGroupResponse> {
11401
11994
  Util.validateModel(request);
@@ -11430,11 +12023,13 @@ export default class Client extends OpenApi {
11430
12023
  }
11431
12024
 
11432
12025
  /**
11433
- * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot remove a user from a group that is synchronized by using SCIM.
11434
- * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
11435
- *
11436
- * @param request RemoveUserFromGroupRequest
11437
- * @return RemoveUserFromGroupResponse
12026
+ * @summary Removes a user from a group.
12027
+ *
12028
+ * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot remove a user from a group that is synchronized by using SCIM.
12029
+ * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
12030
+ *
12031
+ * @param request RemoveUserFromGroupRequest
12032
+ * @return RemoveUserFromGroupResponse
11438
12033
  */
11439
12034
  async removeUserFromGroup(request: RemoveUserFromGroupRequest): Promise<RemoveUserFromGroupResponse> {
11440
12035
  let runtime = new $Util.RuntimeOptions({ });
@@ -11442,13 +12037,15 @@ export default class Client extends OpenApi {
11442
12037
  }
11443
12038
 
11444
12039
  /**
11445
- * If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
11446
- * > After you enable SSO logon, your password cannot be reset.
11447
- * This topic provides an example on how to reset the password of the user `u-00q8wbq42wiltcrk****`. The new password is automatically generated by the system.
11448
- *
11449
- * @param request ResetUserPasswordRequest
11450
- * @param runtime runtime options for this request RuntimeOptions
11451
- * @return ResetUserPasswordResponse
12040
+ * @summary Resets the password of a user.
12041
+ *
12042
+ * @description If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
12043
+ * > After you enable SSO logon, your password cannot be reset.
12044
+ * This topic provides an example on how to reset the password of the user `u-00q8wbq42wiltcrk****`. The new password is automatically generated by the system.
12045
+ *
12046
+ * @param request ResetUserPasswordRequest
12047
+ * @param runtime runtime options for this request RuntimeOptions
12048
+ * @return ResetUserPasswordResponse
11452
12049
  */
11453
12050
  async resetUserPasswordWithOptions(request: ResetUserPasswordRequest, runtime: $Util.RuntimeOptions): Promise<ResetUserPasswordResponse> {
11454
12051
  Util.validateModel(request);
@@ -11491,18 +12088,27 @@ export default class Client extends OpenApi {
11491
12088
  }
11492
12089
 
11493
12090
  /**
11494
- * If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
11495
- * > After you enable SSO logon, your password cannot be reset.
11496
- * This topic provides an example on how to reset the password of the user `u-00q8wbq42wiltcrk****`. The new password is automatically generated by the system.
11497
- *
11498
- * @param request ResetUserPasswordRequest
11499
- * @return ResetUserPasswordResponse
12091
+ * @summary Resets the password of a user.
12092
+ *
12093
+ * @description If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
12094
+ * > After you enable SSO logon, your password cannot be reset.
12095
+ * This topic provides an example on how to reset the password of the user `u-00q8wbq42wiltcrk****`. The new password is automatically generated by the system.
12096
+ *
12097
+ * @param request ResetUserPasswordRequest
12098
+ * @return ResetUserPasswordResponse
11500
12099
  */
11501
12100
  async resetUserPassword(request: ResetUserPasswordRequest): Promise<ResetUserPasswordResponse> {
11502
12101
  let runtime = new $Util.RuntimeOptions({ });
11503
12102
  return await this.resetUserPasswordWithOptions(request, runtime);
11504
12103
  }
11505
12104
 
12105
+ /**
12106
+ * @summary Retries a Resource Access Management (RAM) user provisioning event.
12107
+ *
12108
+ * @param request RetryUserProvisioningEventRequest
12109
+ * @param runtime runtime options for this request RuntimeOptions
12110
+ * @return RetryUserProvisioningEventResponse
12111
+ */
11506
12112
  async retryUserProvisioningEventWithOptions(request: RetryUserProvisioningEventRequest, runtime: $Util.RuntimeOptions): Promise<RetryUserProvisioningEventResponse> {
11507
12113
  Util.validateModel(request);
11508
12114
  let query = { };
@@ -11535,25 +12141,33 @@ export default class Client extends OpenApi {
11535
12141
  return $tea.cast<RetryUserProvisioningEventResponse>(await this.callApi(params, req, runtime), new RetryUserProvisioningEventResponse({}));
11536
12142
  }
11537
12143
 
12144
+ /**
12145
+ * @summary Retries a Resource Access Management (RAM) user provisioning event.
12146
+ *
12147
+ * @param request RetryUserProvisioningEventRequest
12148
+ * @return RetryUserProvisioningEventResponse
12149
+ */
11538
12150
  async retryUserProvisioningEvent(request: RetryUserProvisioningEventRequest): Promise<RetryUserProvisioningEventResponse> {
11539
12151
  let runtime = new $Util.RuntimeOptions({ });
11540
12152
  return await this.retryUserProvisioningEventWithOptions(request, runtime);
11541
12153
  }
11542
12154
 
11543
12155
  /**
11544
- * During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an IdP.
11545
- * You can use one of the following methods to configure a SAML IdP. You can obtain the required metadata file or parameter values from your IdP.
11546
- * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
11547
- * * Manually configure the IdP. You can manually specify the following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
11548
- * If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
11549
- * * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
11550
- * * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
11551
- * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
11552
- * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
11553
- *
11554
- * @param request SetExternalSAMLIdentityProviderRequest
11555
- * @param runtime runtime options for this request RuntimeOptions
11556
- * @return SetExternalSAMLIdentityProviderResponse
12156
+ * @summary Configures a Security Assertion Markup Language (SAML) identity provider (IdP).
12157
+ *
12158
+ * @description During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an IdP.
12159
+ * You can use one of the following methods to configure a SAML IdP. You can obtain the required metadata file or parameter values from your IdP.
12160
+ * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
12161
+ * * Manually configure the IdP. You can manually specify the following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
12162
+ * If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
12163
+ * * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
12164
+ * * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
12165
+ * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
12166
+ * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
12167
+ *
12168
+ * @param request SetExternalSAMLIdentityProviderRequest
12169
+ * @param runtime runtime options for this request RuntimeOptions
12170
+ * @return SetExternalSAMLIdentityProviderResponse
11557
12171
  */
11558
12172
  async setExternalSAMLIdentityProviderWithOptions(request: SetExternalSAMLIdentityProviderRequest, runtime: $Util.RuntimeOptions): Promise<SetExternalSAMLIdentityProviderResponse> {
11559
12173
  Util.validateModel(request);
@@ -11604,24 +12218,33 @@ export default class Client extends OpenApi {
11604
12218
  }
11605
12219
 
11606
12220
  /**
11607
- * During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an IdP.
11608
- * You can use one of the following methods to configure a SAML IdP. You can obtain the required metadata file or parameter values from your IdP.
11609
- * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
11610
- * * Manually configure the IdP. You can manually specify the following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
11611
- * If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
11612
- * * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
11613
- * * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
11614
- * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
11615
- * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
11616
- *
11617
- * @param request SetExternalSAMLIdentityProviderRequest
11618
- * @return SetExternalSAMLIdentityProviderResponse
12221
+ * @summary Configures a Security Assertion Markup Language (SAML) identity provider (IdP).
12222
+ *
12223
+ * @description During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an IdP.
12224
+ * You can use one of the following methods to configure a SAML IdP. You can obtain the required metadata file or parameter values from your IdP.
12225
+ * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
12226
+ * * Manually configure the IdP. You can manually specify the following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
12227
+ * If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
12228
+ * * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
12229
+ * * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
12230
+ * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
12231
+ * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
12232
+ *
12233
+ * @param request SetExternalSAMLIdentityProviderRequest
12234
+ * @return SetExternalSAMLIdentityProviderResponse
11619
12235
  */
11620
12236
  async setExternalSAMLIdentityProvider(request: SetExternalSAMLIdentityProviderRequest): Promise<SetExternalSAMLIdentityProviderResponse> {
11621
12237
  let runtime = new $Util.RuntimeOptions({ });
11622
12238
  return await this.setExternalSAMLIdentityProviderWithOptions(request, runtime);
11623
12239
  }
11624
12240
 
12241
+ /**
12242
+ * @summary Configures the logon preference of CloudSSO users.
12243
+ *
12244
+ * @param request SetLoginPreferenceRequest
12245
+ * @param runtime runtime options for this request RuntimeOptions
12246
+ * @return SetLoginPreferenceResponse
12247
+ */
11625
12248
  async setLoginPreferenceWithOptions(request: SetLoginPreferenceRequest, runtime: $Util.RuntimeOptions): Promise<SetLoginPreferenceResponse> {
11626
12249
  Util.validateModel(request);
11627
12250
  let query = { };
@@ -11650,18 +12273,26 @@ export default class Client extends OpenApi {
11650
12273
  return $tea.cast<SetLoginPreferenceResponse>(await this.callApi(params, req, runtime), new SetLoginPreferenceResponse({}));
11651
12274
  }
11652
12275
 
12276
+ /**
12277
+ * @summary Configures the logon preference of CloudSSO users.
12278
+ *
12279
+ * @param request SetLoginPreferenceRequest
12280
+ * @return SetLoginPreferenceResponse
12281
+ */
11653
12282
  async setLoginPreference(request: SetLoginPreferenceRequest): Promise<SetLoginPreferenceResponse> {
11654
12283
  let runtime = new $Util.RuntimeOptions({ });
11655
12284
  return await this.setLoginPreferenceWithOptions(request, runtime);
11656
12285
  }
11657
12286
 
11658
12287
  /**
11659
- * If a CloudSSO administrator enables username-password logon for users, CloudSSO automatically enables MFA to improve security. The administrator can call this operation to enable or disable MFA based on the business requirements.
11660
- * This topic provides an example on how to enable MFA for users.
11661
- *
11662
- * @param request SetMFAAuthenticationStatusRequest
11663
- * @param runtime runtime options for this request RuntimeOptions
11664
- * @return SetMFAAuthenticationStatusResponse
12288
+ * @summary Enables or disables multi-factor authentication (MFA) for users in a directory.
12289
+ *
12290
+ * @description If a CloudSSO administrator enables username-password logon for users, CloudSSO automatically enables MFA to improve security. The administrator can call this operation to enable or disable MFA based on the business requirements.
12291
+ * This topic provides an example on how to enable MFA for users.
12292
+ *
12293
+ * @param request SetMFAAuthenticationStatusRequest
12294
+ * @param runtime runtime options for this request RuntimeOptions
12295
+ * @return SetMFAAuthenticationStatusResponse
11665
12296
  */
11666
12297
  async setMFAAuthenticationStatusWithOptions(request: SetMFAAuthenticationStatusRequest, runtime: $Util.RuntimeOptions): Promise<SetMFAAuthenticationStatusResponse> {
11667
12298
  Util.validateModel(request);
@@ -11692,17 +12323,26 @@ export default class Client extends OpenApi {
11692
12323
  }
11693
12324
 
11694
12325
  /**
11695
- * If a CloudSSO administrator enables username-password logon for users, CloudSSO automatically enables MFA to improve security. The administrator can call this operation to enable or disable MFA based on the business requirements.
11696
- * This topic provides an example on how to enable MFA for users.
11697
- *
11698
- * @param request SetMFAAuthenticationStatusRequest
11699
- * @return SetMFAAuthenticationStatusResponse
12326
+ * @summary Enables or disables multi-factor authentication (MFA) for users in a directory.
12327
+ *
12328
+ * @description If a CloudSSO administrator enables username-password logon for users, CloudSSO automatically enables MFA to improve security. The administrator can call this operation to enable or disable MFA based on the business requirements.
12329
+ * This topic provides an example on how to enable MFA for users.
12330
+ *
12331
+ * @param request SetMFAAuthenticationStatusRequest
12332
+ * @return SetMFAAuthenticationStatusResponse
11700
12333
  */
11701
12334
  async setMFAAuthenticationStatus(request: SetMFAAuthenticationStatusRequest): Promise<SetMFAAuthenticationStatusResponse> {
11702
12335
  let runtime = new $Util.RuntimeOptions({ });
11703
12336
  return await this.setMFAAuthenticationStatusWithOptions(request, runtime);
11704
12337
  }
11705
12338
 
12339
+ /**
12340
+ * @summary Configures a password policy for CloudSSO users.
12341
+ *
12342
+ * @param request SetPasswordPolicyRequest
12343
+ * @param runtime runtime options for this request RuntimeOptions
12344
+ * @return SetPasswordPolicyResponse
12345
+ */
11706
12346
  async setPasswordPolicyWithOptions(request: SetPasswordPolicyRequest, runtime: $Util.RuntimeOptions): Promise<SetPasswordPolicyResponse> {
11707
12347
  Util.validateModel(request);
11708
12348
  let query = { };
@@ -11751,20 +12391,28 @@ export default class Client extends OpenApi {
11751
12391
  return $tea.cast<SetPasswordPolicyResponse>(await this.callApi(params, req, runtime), new SetPasswordPolicyResponse({}));
11752
12392
  }
11753
12393
 
12394
+ /**
12395
+ * @summary Configures a password policy for CloudSSO users.
12396
+ *
12397
+ * @param request SetPasswordPolicyRequest
12398
+ * @return SetPasswordPolicyResponse
12399
+ */
11754
12400
  async setPasswordPolicy(request: SetPasswordPolicyRequest): Promise<SetPasswordPolicyResponse> {
11755
12401
  let runtime = new $Util.RuntimeOptions({ });
11756
12402
  return await this.setPasswordPolicyWithOptions(request, runtime);
11757
12403
  }
11758
12404
 
11759
12405
  /**
11760
- * You can synchronize users or groups from an external identity provider (IdP) that supports SCIM 2.0 to CloudSSO only after SCIM synchronization is enabled. If you disable SCIM synchronization, you can no longer synchronize users or groups to CloudSSO. The following list describes the impacts after SCIM synchronization is enabled or disabled:
11761
- * * After you enable SCIM synchronization, you cannot modify or delete the users or groups that are synchronized to CloudSSO by using SCIM. In addition, you cannot add users to or remove users from the groups. However, you can change the passwords of the users and enable or disable the logon of the users.
11762
- * * After you disable SCIM synchronization, you can modify and delete the users and groups that are synchronized to CloudSSO by using SCIM. You can also add users to or remove users from the groups.
11763
- * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
11764
- *
11765
- * @param request SetSCIMSynchronizationStatusRequest
11766
- * @param runtime runtime options for this request RuntimeOptions
11767
- * @return SetSCIMSynchronizationStatusResponse
12406
+ * @summary Enables or disables Cross-domain Identity Management (SCIM) synchronization.
12407
+ *
12408
+ * @description You can synchronize users or groups from an external identity provider (IdP) that supports SCIM 2.0 to CloudSSO only after SCIM synchronization is enabled. If you disable SCIM synchronization, you can no longer synchronize users or groups to CloudSSO. The following list describes the impacts after SCIM synchronization is enabled or disabled:
12409
+ * * After you enable SCIM synchronization, you cannot modify or delete the users or groups that are synchronized to CloudSSO by using SCIM. In addition, you cannot add users to or remove users from the groups. However, you can change the passwords of the users and enable or disable the logon of the users.
12410
+ * * After you disable SCIM synchronization, you can modify and delete the users and groups that are synchronized to CloudSSO by using SCIM. You can also add users to or remove users from the groups.
12411
+ * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
12412
+ *
12413
+ * @param request SetSCIMSynchronizationStatusRequest
12414
+ * @param runtime runtime options for this request RuntimeOptions
12415
+ * @return SetSCIMSynchronizationStatusResponse
11768
12416
  */
11769
12417
  async setSCIMSynchronizationStatusWithOptions(request: SetSCIMSynchronizationStatusRequest, runtime: $Util.RuntimeOptions): Promise<SetSCIMSynchronizationStatusResponse> {
11770
12418
  Util.validateModel(request);
@@ -11795,13 +12443,15 @@ export default class Client extends OpenApi {
11795
12443
  }
11796
12444
 
11797
12445
  /**
11798
- * You can synchronize users or groups from an external identity provider (IdP) that supports SCIM 2.0 to CloudSSO only after SCIM synchronization is enabled. If you disable SCIM synchronization, you can no longer synchronize users or groups to CloudSSO. The following list describes the impacts after SCIM synchronization is enabled or disabled:
11799
- * * After you enable SCIM synchronization, you cannot modify or delete the users or groups that are synchronized to CloudSSO by using SCIM. In addition, you cannot add users to or remove users from the groups. However, you can change the passwords of the users and enable or disable the logon of the users.
11800
- * * After you disable SCIM synchronization, you can modify and delete the users and groups that are synchronized to CloudSSO by using SCIM. You can also add users to or remove users from the groups.
11801
- * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
11802
- *
11803
- * @param request SetSCIMSynchronizationStatusRequest
11804
- * @return SetSCIMSynchronizationStatusResponse
12446
+ * @summary Enables or disables Cross-domain Identity Management (SCIM) synchronization.
12447
+ *
12448
+ * @description You can synchronize users or groups from an external identity provider (IdP) that supports SCIM 2.0 to CloudSSO only after SCIM synchronization is enabled. If you disable SCIM synchronization, you can no longer synchronize users or groups to CloudSSO. The following list describes the impacts after SCIM synchronization is enabled or disabled:
12449
+ * * After you enable SCIM synchronization, you cannot modify or delete the users or groups that are synchronized to CloudSSO by using SCIM. In addition, you cannot add users to or remove users from the groups. However, you can change the passwords of the users and enable or disable the logon of the users.
12450
+ * * After you disable SCIM synchronization, you can modify and delete the users and groups that are synchronized to CloudSSO by using SCIM. You can also add users to or remove users from the groups.
12451
+ * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
12452
+ *
12453
+ * @param request SetSCIMSynchronizationStatusRequest
12454
+ * @return SetSCIMSynchronizationStatusResponse
11805
12455
  */
11806
12456
  async setSCIMSynchronizationStatus(request: SetSCIMSynchronizationStatusRequest): Promise<SetSCIMSynchronizationStatusResponse> {
11807
12457
  let runtime = new $Util.RuntimeOptions({ });
@@ -11809,12 +12459,14 @@ export default class Client extends OpenApi {
11809
12459
  }
11810
12460
 
11811
12461
  /**
11812
- * You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
11813
- * This topic provides an example on how to change the initial web page in the access configuration `ac-00jhtfl8thteu6uj****` to `https://cloudsso.console.aliyun.com`.
11814
- *
11815
- * @param request UpdateAccessConfigurationRequest
11816
- * @param runtime runtime options for this request RuntimeOptions
11817
- * @return UpdateAccessConfigurationResponse
12462
+ * @summary Modifies information about an access configuration.
12463
+ *
12464
+ * @description You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
12465
+ * This topic provides an example on how to change the initial web page in the access configuration `ac-00jhtfl8thteu6uj****` to `https://cloudsso.console.aliyun.com`.
12466
+ *
12467
+ * @param request UpdateAccessConfigurationRequest
12468
+ * @param runtime runtime options for this request RuntimeOptions
12469
+ * @return UpdateAccessConfigurationResponse
11818
12470
  */
11819
12471
  async updateAccessConfigurationWithOptions(request: UpdateAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<UpdateAccessConfigurationResponse> {
11820
12472
  Util.validateModel(request);
@@ -11857,11 +12509,13 @@ export default class Client extends OpenApi {
11857
12509
  }
11858
12510
 
11859
12511
  /**
11860
- * You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
11861
- * This topic provides an example on how to change the initial web page in the access configuration `ac-00jhtfl8thteu6uj****` to `https://cloudsso.console.aliyun.com`.
11862
- *
11863
- * @param request UpdateAccessConfigurationRequest
11864
- * @return UpdateAccessConfigurationResponse
12512
+ * @summary Modifies information about an access configuration.
12513
+ *
12514
+ * @description You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
12515
+ * This topic provides an example on how to change the initial web page in the access configuration `ac-00jhtfl8thteu6uj****` to `https://cloudsso.console.aliyun.com`.
12516
+ *
12517
+ * @param request UpdateAccessConfigurationRequest
12518
+ * @return UpdateAccessConfigurationResponse
11865
12519
  */
11866
12520
  async updateAccessConfiguration(request: UpdateAccessConfigurationRequest): Promise<UpdateAccessConfigurationResponse> {
11867
12521
  let runtime = new $Util.RuntimeOptions({ });
@@ -11869,12 +12523,14 @@ export default class Client extends OpenApi {
11869
12523
  }
11870
12524
 
11871
12525
  /**
11872
- * After you change the name of a directory, the URL that is used to log on to the Cloud SSO user portal is changed. You must notify the Cloud SSO users of the correct URL.
11873
- * This topic provides an example on how to change the name of a directory to `new-example`.
11874
- *
11875
- * @param request UpdateDirectoryRequest
11876
- * @param runtime runtime options for this request RuntimeOptions
11877
- * @return UpdateDirectoryResponse
12526
+ * @summary Changes the name of a directory.
12527
+ *
12528
+ * @description After you change the name of a directory, the URL that is used to log on to the Cloud SSO user portal is changed. You must notify the Cloud SSO users of the correct URL.
12529
+ * This topic provides an example on how to change the name of a directory to `new-example`.
12530
+ *
12531
+ * @param request UpdateDirectoryRequest
12532
+ * @param runtime runtime options for this request RuntimeOptions
12533
+ * @return UpdateDirectoryResponse
11878
12534
  */
11879
12535
  async updateDirectoryWithOptions(request: UpdateDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<UpdateDirectoryResponse> {
11880
12536
  Util.validateModel(request);
@@ -11905,11 +12561,13 @@ export default class Client extends OpenApi {
11905
12561
  }
11906
12562
 
11907
12563
  /**
11908
- * After you change the name of a directory, the URL that is used to log on to the Cloud SSO user portal is changed. You must notify the Cloud SSO users of the correct URL.
11909
- * This topic provides an example on how to change the name of a directory to `new-example`.
11910
- *
11911
- * @param request UpdateDirectoryRequest
11912
- * @return UpdateDirectoryResponse
12564
+ * @summary Changes the name of a directory.
12565
+ *
12566
+ * @description After you change the name of a directory, the URL that is used to log on to the Cloud SSO user portal is changed. You must notify the Cloud SSO users of the correct URL.
12567
+ * This topic provides an example on how to change the name of a directory to `new-example`.
12568
+ *
12569
+ * @param request UpdateDirectoryRequest
12570
+ * @return UpdateDirectoryResponse
11913
12571
  */
11914
12572
  async updateDirectory(request: UpdateDirectoryRequest): Promise<UpdateDirectoryResponse> {
11915
12573
  let runtime = new $Util.RuntimeOptions({ });
@@ -11917,13 +12575,15 @@ export default class Client extends OpenApi {
11917
12575
  }
11918
12576
 
11919
12577
  /**
11920
- * You can modify `GroupName` and `Description` for a group.
11921
- * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a group that is synchronized by using SCIM.
11922
- * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
11923
- *
11924
- * @param request UpdateGroupRequest
11925
- * @param runtime runtime options for this request RuntimeOptions
11926
- * @return UpdateGroupResponse
12578
+ * @summary Modifies information about a group.
12579
+ *
12580
+ * @description You can modify `GroupName` and `Description` for a group.
12581
+ * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a group that is synchronized by using SCIM.
12582
+ * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
12583
+ *
12584
+ * @param request UpdateGroupRequest
12585
+ * @param runtime runtime options for this request RuntimeOptions
12586
+ * @return UpdateGroupResponse
11927
12587
  */
11928
12588
  async updateGroupWithOptions(request: UpdateGroupRequest, runtime: $Util.RuntimeOptions): Promise<UpdateGroupResponse> {
11929
12589
  Util.validateModel(request);
@@ -11962,12 +12622,14 @@ export default class Client extends OpenApi {
11962
12622
  }
11963
12623
 
11964
12624
  /**
11965
- * You can modify `GroupName` and `Description` for a group.
11966
- * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a group that is synchronized by using SCIM.
11967
- * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
11968
- *
11969
- * @param request UpdateGroupRequest
11970
- * @return UpdateGroupResponse
12625
+ * @summary Modifies information about a group.
12626
+ *
12627
+ * @description You can modify `GroupName` and `Description` for a group.
12628
+ * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a group that is synchronized by using SCIM.
12629
+ * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
12630
+ *
12631
+ * @param request UpdateGroupRequest
12632
+ * @return UpdateGroupResponse
11971
12633
  */
11972
12634
  async updateGroup(request: UpdateGroupRequest): Promise<UpdateGroupResponse> {
11973
12635
  let runtime = new $Util.RuntimeOptions({ });
@@ -11975,11 +12637,13 @@ export default class Client extends OpenApi {
11975
12637
  }
11976
12638
 
11977
12639
  /**
11978
- * This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
11979
- *
11980
- * @param request UpdateInlinePolicyForAccessConfigurationRequest
11981
- * @param runtime runtime options for this request RuntimeOptions
11982
- * @return UpdateInlinePolicyForAccessConfigurationResponse
12640
+ * @summary Modifies an inline policy that is created for an access configuration.
12641
+ *
12642
+ * @description This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
12643
+ *
12644
+ * @param request UpdateInlinePolicyForAccessConfigurationRequest
12645
+ * @param runtime runtime options for this request RuntimeOptions
12646
+ * @return UpdateInlinePolicyForAccessConfigurationResponse
11983
12647
  */
11984
12648
  async updateInlinePolicyForAccessConfigurationWithOptions(request: UpdateInlinePolicyForAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<UpdateInlinePolicyForAccessConfigurationResponse> {
11985
12649
  Util.validateModel(request);
@@ -12018,10 +12682,12 @@ export default class Client extends OpenApi {
12018
12682
  }
12019
12683
 
12020
12684
  /**
12021
- * This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
12022
- *
12023
- * @param request UpdateInlinePolicyForAccessConfigurationRequest
12024
- * @return UpdateInlinePolicyForAccessConfigurationResponse
12685
+ * @summary Modifies an inline policy that is created for an access configuration.
12686
+ *
12687
+ * @description This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
12688
+ *
12689
+ * @param request UpdateInlinePolicyForAccessConfigurationRequest
12690
+ * @return UpdateInlinePolicyForAccessConfigurationResponse
12025
12691
  */
12026
12692
  async updateInlinePolicyForAccessConfiguration(request: UpdateInlinePolicyForAccessConfigurationRequest): Promise<UpdateInlinePolicyForAccessConfigurationResponse> {
12027
12693
  let runtime = new $Util.RuntimeOptions({ });
@@ -12029,12 +12695,14 @@ export default class Client extends OpenApi {
12029
12695
  }
12030
12696
 
12031
12697
  /**
12032
- * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
12033
- * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
12034
- *
12035
- * @param request UpdateMFAAuthenticationSettingsRequest
12036
- * @param runtime runtime options for this request RuntimeOptions
12037
- * @return UpdateMFAAuthenticationSettingsResponse
12698
+ * @summary Modifies the multi-factor authentication (MFA) setting of all users.
12699
+ *
12700
+ * @description If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
12701
+ * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
12702
+ *
12703
+ * @param request UpdateMFAAuthenticationSettingsRequest
12704
+ * @param runtime runtime options for this request RuntimeOptions
12705
+ * @return UpdateMFAAuthenticationSettingsResponse
12038
12706
  */
12039
12707
  async updateMFAAuthenticationSettingsWithOptions(request: UpdateMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<UpdateMFAAuthenticationSettingsResponse> {
12040
12708
  Util.validateModel(request);
@@ -12069,11 +12737,13 @@ export default class Client extends OpenApi {
12069
12737
  }
12070
12738
 
12071
12739
  /**
12072
- * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
12073
- * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
12074
- *
12075
- * @param request UpdateMFAAuthenticationSettingsRequest
12076
- * @return UpdateMFAAuthenticationSettingsResponse
12740
+ * @summary Modifies the multi-factor authentication (MFA) setting of all users.
12741
+ *
12742
+ * @description If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
12743
+ * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
12744
+ *
12745
+ * @param request UpdateMFAAuthenticationSettingsRequest
12746
+ * @return UpdateMFAAuthenticationSettingsResponse
12077
12747
  */
12078
12748
  async updateMFAAuthenticationSettings(request: UpdateMFAAuthenticationSettingsRequest): Promise<UpdateMFAAuthenticationSettingsResponse> {
12079
12749
  let runtime = new $Util.RuntimeOptions({ });
@@ -12081,11 +12751,13 @@ export default class Client extends OpenApi {
12081
12751
  }
12082
12752
 
12083
12753
  /**
12084
- * This topic provides an example on how to disable the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`. After the SCIM credential is disabled, the synchronization task that uses the SCIM credential fails. You can call this operation again to enable the SCIM credential.
12085
- *
12086
- * @param request UpdateSCIMServerCredentialStatusRequest
12087
- * @param runtime runtime options for this request RuntimeOptions
12088
- * @return UpdateSCIMServerCredentialStatusResponse
12754
+ * @summary Enables or disables a Cross-domain Identity Management (SCIM) credential.
12755
+ *
12756
+ * @description This topic provides an example on how to disable the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`. After the SCIM credential is disabled, the synchronization task that uses the SCIM credential fails. You can call this operation again to enable the SCIM credential.
12757
+ *
12758
+ * @param request UpdateSCIMServerCredentialStatusRequest
12759
+ * @param runtime runtime options for this request RuntimeOptions
12760
+ * @return UpdateSCIMServerCredentialStatusResponse
12089
12761
  */
12090
12762
  async updateSCIMServerCredentialStatusWithOptions(request: UpdateSCIMServerCredentialStatusRequest, runtime: $Util.RuntimeOptions): Promise<UpdateSCIMServerCredentialStatusResponse> {
12091
12763
  Util.validateModel(request);
@@ -12120,10 +12792,12 @@ export default class Client extends OpenApi {
12120
12792
  }
12121
12793
 
12122
12794
  /**
12123
- * This topic provides an example on how to disable the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`. After the SCIM credential is disabled, the synchronization task that uses the SCIM credential fails. You can call this operation again to enable the SCIM credential.
12124
- *
12125
- * @param request UpdateSCIMServerCredentialStatusRequest
12126
- * @return UpdateSCIMServerCredentialStatusResponse
12795
+ * @summary Enables or disables a Cross-domain Identity Management (SCIM) credential.
12796
+ *
12797
+ * @description This topic provides an example on how to disable the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`. After the SCIM credential is disabled, the synchronization task that uses the SCIM credential fails. You can call this operation again to enable the SCIM credential.
12798
+ *
12799
+ * @param request UpdateSCIMServerCredentialStatusRequest
12800
+ * @return UpdateSCIMServerCredentialStatusResponse
12127
12801
  */
12128
12802
  async updateSCIMServerCredentialStatus(request: UpdateSCIMServerCredentialStatusRequest): Promise<UpdateSCIMServerCredentialStatusResponse> {
12129
12803
  let runtime = new $Util.RuntimeOptions({ });
@@ -12131,13 +12805,15 @@ export default class Client extends OpenApi {
12131
12805
  }
12132
12806
 
12133
12807
  /**
12134
- * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
12135
- * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a user that is synchronized by using SCIM.
12136
- * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
12137
- *
12138
- * @param request UpdateUserRequest
12139
- * @param runtime runtime options for this request RuntimeOptions
12140
- * @return UpdateUserResponse
12808
+ * @summary Modifies information about a user.
12809
+ *
12810
+ * @description You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
12811
+ * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a user that is synchronized by using SCIM.
12812
+ * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
12813
+ *
12814
+ * @param request UpdateUserRequest
12815
+ * @param runtime runtime options for this request RuntimeOptions
12816
+ * @return UpdateUserResponse
12141
12817
  */
12142
12818
  async updateUserWithOptions(request: UpdateUserRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserResponse> {
12143
12819
  Util.validateModel(request);
@@ -12188,12 +12864,14 @@ export default class Client extends OpenApi {
12188
12864
  }
12189
12865
 
12190
12866
  /**
12191
- * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
12192
- * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a user that is synchronized by using SCIM.
12193
- * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
12194
- *
12195
- * @param request UpdateUserRequest
12196
- * @return UpdateUserResponse
12867
+ * @summary Modifies information about a user.
12868
+ *
12869
+ * @description You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
12870
+ * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a user that is synchronized by using SCIM.
12871
+ * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
12872
+ *
12873
+ * @param request UpdateUserRequest
12874
+ * @return UpdateUserResponse
12197
12875
  */
12198
12876
  async updateUser(request: UpdateUserRequest): Promise<UpdateUserResponse> {
12199
12877
  let runtime = new $Util.RuntimeOptions({ });
@@ -12201,13 +12879,15 @@ export default class Client extends OpenApi {
12201
12879
  }
12202
12880
 
12203
12881
  /**
12204
- * If you call the [UpdateMFAAuthenticationSettings](~~450134~~) operation to set the MFAAuthenticationSettings parameter to `Byuser`, user-specific settings are applied. Then, you must call the UpdateUserMFAAuthenticationSettings operation to configure MFA for each user.
12205
- * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
12206
- * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
12207
- *
12208
- * @param request UpdateUserMFAAuthenticationSettingsRequest
12209
- * @param runtime runtime options for this request RuntimeOptions
12210
- * @return UpdateUserMFAAuthenticationSettingsResponse
12882
+ * @summary Modifies the multi-factor authentication (MFA) setting of a single user.
12883
+ *
12884
+ * @description If you call the [UpdateMFAAuthenticationSettings](https://help.aliyun.com/document_detail/450134.html) operation to set the MFAAuthenticationSettings parameter to `Byuser`, user-specific settings are applied. Then, you must call the UpdateUserMFAAuthenticationSettings operation to configure MFA for each user.
12885
+ * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
12886
+ * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
12887
+ *
12888
+ * @param request UpdateUserMFAAuthenticationSettingsRequest
12889
+ * @param runtime runtime options for this request RuntimeOptions
12890
+ * @return UpdateUserMFAAuthenticationSettingsResponse
12211
12891
  */
12212
12892
  async updateUserMFAAuthenticationSettingsWithOptions(request: UpdateUserMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserMFAAuthenticationSettingsResponse> {
12213
12893
  Util.validateModel(request);
@@ -12242,18 +12922,27 @@ export default class Client extends OpenApi {
12242
12922
  }
12243
12923
 
12244
12924
  /**
12245
- * If you call the [UpdateMFAAuthenticationSettings](~~450134~~) operation to set the MFAAuthenticationSettings parameter to `Byuser`, user-specific settings are applied. Then, you must call the UpdateUserMFAAuthenticationSettings operation to configure MFA for each user.
12246
- * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
12247
- * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
12248
- *
12249
- * @param request UpdateUserMFAAuthenticationSettingsRequest
12250
- * @return UpdateUserMFAAuthenticationSettingsResponse
12925
+ * @summary Modifies the multi-factor authentication (MFA) setting of a single user.
12926
+ *
12927
+ * @description If you call the [UpdateMFAAuthenticationSettings](https://help.aliyun.com/document_detail/450134.html) operation to set the MFAAuthenticationSettings parameter to `Byuser`, user-specific settings are applied. Then, you must call the UpdateUserMFAAuthenticationSettings operation to configure MFA for each user.
12928
+ * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
12929
+ * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
12930
+ *
12931
+ * @param request UpdateUserMFAAuthenticationSettingsRequest
12932
+ * @return UpdateUserMFAAuthenticationSettingsResponse
12251
12933
  */
12252
12934
  async updateUserMFAAuthenticationSettings(request: UpdateUserMFAAuthenticationSettingsRequest): Promise<UpdateUserMFAAuthenticationSettingsResponse> {
12253
12935
  let runtime = new $Util.RuntimeOptions({ });
12254
12936
  return await this.updateUserMFAAuthenticationSettingsWithOptions(request, runtime);
12255
12937
  }
12256
12938
 
12939
+ /**
12940
+ * @summary Modifies a Resource Access Management (RAM) user provisioning.
12941
+ *
12942
+ * @param request UpdateUserProvisioningRequest
12943
+ * @param runtime runtime options for this request RuntimeOptions
12944
+ * @return UpdateUserProvisioningResponse
12945
+ */
12257
12946
  async updateUserProvisioningWithOptions(request: UpdateUserProvisioningRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserProvisioningResponse> {
12258
12947
  Util.validateModel(request);
12259
12948
  let query = { };
@@ -12294,11 +12983,24 @@ export default class Client extends OpenApi {
12294
12983
  return $tea.cast<UpdateUserProvisioningResponse>(await this.callApi(params, req, runtime), new UpdateUserProvisioningResponse({}));
12295
12984
  }
12296
12985
 
12986
+ /**
12987
+ * @summary Modifies a Resource Access Management (RAM) user provisioning.
12988
+ *
12989
+ * @param request UpdateUserProvisioningRequest
12990
+ * @return UpdateUserProvisioningResponse
12991
+ */
12297
12992
  async updateUserProvisioning(request: UpdateUserProvisioningRequest): Promise<UpdateUserProvisioningResponse> {
12298
12993
  let runtime = new $Util.RuntimeOptions({ });
12299
12994
  return await this.updateUserProvisioningWithOptions(request, runtime);
12300
12995
  }
12301
12996
 
12997
+ /**
12998
+ * @summary Modifies the global configurations of a Resource Access Management (RAM) user provisioning.
12999
+ *
13000
+ * @param request UpdateUserProvisioningConfigurationRequest
13001
+ * @param runtime runtime options for this request RuntimeOptions
13002
+ * @return UpdateUserProvisioningConfigurationResponse
13003
+ */
12302
13004
  async updateUserProvisioningConfigurationWithOptions(request: UpdateUserProvisioningConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserProvisioningConfigurationResponse> {
12303
13005
  Util.validateModel(request);
12304
13006
  let query = { };
@@ -12331,17 +13033,25 @@ export default class Client extends OpenApi {
12331
13033
  return $tea.cast<UpdateUserProvisioningConfigurationResponse>(await this.callApi(params, req, runtime), new UpdateUserProvisioningConfigurationResponse({}));
12332
13034
  }
12333
13035
 
13036
+ /**
13037
+ * @summary Modifies the global configurations of a Resource Access Management (RAM) user provisioning.
13038
+ *
13039
+ * @param request UpdateUserProvisioningConfigurationRequest
13040
+ * @return UpdateUserProvisioningConfigurationResponse
13041
+ */
12334
13042
  async updateUserProvisioningConfiguration(request: UpdateUserProvisioningConfigurationRequest): Promise<UpdateUserProvisioningConfigurationResponse> {
12335
13043
  let runtime = new $Util.RuntimeOptions({ });
12336
13044
  return await this.updateUserProvisioningConfigurationWithOptions(request, runtime);
12337
13045
  }
12338
13046
 
12339
13047
  /**
12340
- * This topic provides an example on how to change the status of the user whose ID is `u-00q8wbq42wiltcrk****` to Disabled. Users in the Disabled state cannot log on to the CloudSSO user portal.
12341
- *
12342
- * @param request UpdateUserStatusRequest
12343
- * @param runtime runtime options for this request RuntimeOptions
12344
- * @return UpdateUserStatusResponse
13048
+ * @summary Changes the status of a user.
13049
+ *
13050
+ * @description This topic provides an example on how to change the status of the user whose ID is `u-00q8wbq42wiltcrk****` to Disabled. Users in the Disabled state cannot log on to the CloudSSO user portal.
13051
+ *
13052
+ * @param request UpdateUserStatusRequest
13053
+ * @param runtime runtime options for this request RuntimeOptions
13054
+ * @return UpdateUserStatusResponse
12345
13055
  */
12346
13056
  async updateUserStatusWithOptions(request: UpdateUserStatusRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserStatusResponse> {
12347
13057
  Util.validateModel(request);
@@ -12376,10 +13086,12 @@ export default class Client extends OpenApi {
12376
13086
  }
12377
13087
 
12378
13088
  /**
12379
- * This topic provides an example on how to change the status of the user whose ID is `u-00q8wbq42wiltcrk****` to Disabled. Users in the Disabled state cannot log on to the CloudSSO user portal.
12380
- *
12381
- * @param request UpdateUserStatusRequest
12382
- * @return UpdateUserStatusResponse
13089
+ * @summary Changes the status of a user.
13090
+ *
13091
+ * @description This topic provides an example on how to change the status of the user whose ID is `u-00q8wbq42wiltcrk****` to Disabled. Users in the Disabled state cannot log on to the CloudSSO user portal.
13092
+ *
13093
+ * @param request UpdateUserStatusRequest
13094
+ * @return UpdateUserStatusResponse
12383
13095
  */
12384
13096
  async updateUserStatus(request: UpdateUserStatusRequest): Promise<UpdateUserStatusResponse> {
12385
13097
  let runtime = new $Util.RuntimeOptions({ });