@alicloud/cloudsso20210515 1.0.1 → 1.1.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
@@ -1782,6 +1782,72 @@ export class GetGroupResponse extends $tea.Model {
1782
1782
  }
1783
1783
  }
1784
1784
 
1785
+ export class GetMFAAuthenticationSettingInfoRequest extends $tea.Model {
1786
+ directoryId?: string;
1787
+ static names(): { [key: string]: string } {
1788
+ return {
1789
+ directoryId: 'DirectoryId',
1790
+ };
1791
+ }
1792
+
1793
+ static types(): { [key: string]: any } {
1794
+ return {
1795
+ directoryId: 'string',
1796
+ };
1797
+ }
1798
+
1799
+ constructor(map?: { [key: string]: any }) {
1800
+ super(map);
1801
+ }
1802
+ }
1803
+
1804
+ export class GetMFAAuthenticationSettingInfoResponseBody extends $tea.Model {
1805
+ MFAAuthenticationSettingInfo?: GetMFAAuthenticationSettingInfoResponseBodyMFAAuthenticationSettingInfo;
1806
+ requestId?: string;
1807
+ static names(): { [key: string]: string } {
1808
+ return {
1809
+ MFAAuthenticationSettingInfo: 'MFAAuthenticationSettingInfo',
1810
+ requestId: 'RequestId',
1811
+ };
1812
+ }
1813
+
1814
+ static types(): { [key: string]: any } {
1815
+ return {
1816
+ MFAAuthenticationSettingInfo: GetMFAAuthenticationSettingInfoResponseBodyMFAAuthenticationSettingInfo,
1817
+ requestId: 'string',
1818
+ };
1819
+ }
1820
+
1821
+ constructor(map?: { [key: string]: any }) {
1822
+ super(map);
1823
+ }
1824
+ }
1825
+
1826
+ export class GetMFAAuthenticationSettingInfoResponse extends $tea.Model {
1827
+ headers: { [key: string]: string };
1828
+ statusCode: number;
1829
+ body: GetMFAAuthenticationSettingInfoResponseBody;
1830
+ static names(): { [key: string]: string } {
1831
+ return {
1832
+ headers: 'headers',
1833
+ statusCode: 'statusCode',
1834
+ body: 'body',
1835
+ };
1836
+ }
1837
+
1838
+ static types(): { [key: string]: any } {
1839
+ return {
1840
+ headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
1841
+ statusCode: 'number',
1842
+ body: GetMFAAuthenticationSettingInfoResponseBody,
1843
+ };
1844
+ }
1845
+
1846
+ constructor(map?: { [key: string]: any }) {
1847
+ super(map);
1848
+ }
1849
+ }
1850
+
1785
1851
  export class GetMFAAuthenticationSettingsRequest extends $tea.Model {
1786
1852
  directoryId?: string;
1787
1853
  static names(): { [key: string]: string } {
@@ -4261,10 +4327,12 @@ export class UpdateInlinePolicyForAccessConfigurationResponse extends $tea.Model
4261
4327
  export class UpdateMFAAuthenticationSettingsRequest extends $tea.Model {
4262
4328
  directoryId?: string;
4263
4329
  MFAAuthenticationSettings?: string;
4330
+ operationForRiskLogin?: string;
4264
4331
  static names(): { [key: string]: string } {
4265
4332
  return {
4266
4333
  directoryId: 'DirectoryId',
4267
4334
  MFAAuthenticationSettings: 'MFAAuthenticationSettings',
4335
+ operationForRiskLogin: 'OperationForRiskLogin',
4268
4336
  };
4269
4337
  }
4270
4338
 
@@ -4272,6 +4340,7 @@ export class UpdateMFAAuthenticationSettingsRequest extends $tea.Model {
4272
4340
  return {
4273
4341
  directoryId: 'string',
4274
4342
  MFAAuthenticationSettings: 'string',
4343
+ operationForRiskLogin: 'string',
4275
4344
  };
4276
4345
  }
4277
4346
 
@@ -5077,6 +5146,7 @@ export class GetDirectoryStatisticsResponseBodyDirectoryStatistics extends $tea.
5077
5146
  SCIMServerCredentialCount?: number;
5078
5147
  SCIMSyncEnabled?: boolean;
5079
5148
  SSOEnabled?: boolean;
5149
+ systemPolicyPerAccessConfigurationQuota?: number;
5080
5150
  userCount?: number;
5081
5151
  userQuota?: number;
5082
5152
  static names(): { [key: string]: string } {
@@ -5093,6 +5163,7 @@ export class GetDirectoryStatisticsResponseBodyDirectoryStatistics extends $tea.
5093
5163
  SCIMServerCredentialCount: 'SCIMServerCredentialCount',
5094
5164
  SCIMSyncEnabled: 'SCIMSyncEnabled',
5095
5165
  SSOEnabled: 'SSOEnabled',
5166
+ systemPolicyPerAccessConfigurationQuota: 'SystemPolicyPerAccessConfigurationQuota',
5096
5167
  userCount: 'UserCount',
5097
5168
  userQuota: 'UserQuota',
5098
5169
  };
@@ -5112,6 +5183,7 @@ export class GetDirectoryStatisticsResponseBodyDirectoryStatistics extends $tea.
5112
5183
  SCIMServerCredentialCount: 'number',
5113
5184
  SCIMSyncEnabled: 'boolean',
5114
5185
  SSOEnabled: 'boolean',
5186
+ systemPolicyPerAccessConfigurationQuota: 'number',
5115
5187
  userCount: 'number',
5116
5188
  userQuota: 'number',
5117
5189
  };
@@ -5199,6 +5271,28 @@ export class GetGroupResponseBodyGroup extends $tea.Model {
5199
5271
  }
5200
5272
  }
5201
5273
 
5274
+ export class GetMFAAuthenticationSettingInfoResponseBodyMFAAuthenticationSettingInfo extends $tea.Model {
5275
+ mfaAuthenticationAdvanceSettings?: string;
5276
+ operationForRiskLogin?: string;
5277
+ static names(): { [key: string]: string } {
5278
+ return {
5279
+ mfaAuthenticationAdvanceSettings: 'MfaAuthenticationAdvanceSettings',
5280
+ operationForRiskLogin: 'OperationForRiskLogin',
5281
+ };
5282
+ }
5283
+
5284
+ static types(): { [key: string]: any } {
5285
+ return {
5286
+ mfaAuthenticationAdvanceSettings: 'string',
5287
+ operationForRiskLogin: 'string',
5288
+ };
5289
+ }
5290
+
5291
+ constructor(map?: { [key: string]: any }) {
5292
+ super(map);
5293
+ }
5294
+ }
5295
+
5202
5296
  export class GetServiceStatusResponseBodyServiceStatus extends $tea.Model {
5203
5297
  accountId?: string;
5204
5298
  prerequisiteCheckResult?: string;
@@ -6212,6 +6306,16 @@ export default class Client extends OpenApi {
6212
6306
  return EndpointUtil.getEndpointRules(productId, regionId, endpointRule, network, suffix);
6213
6307
  }
6214
6308
 
6309
+ /**
6310
+ * You can add up to two SAML signing certificates.
6311
+ * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
6312
+ * ## Limits
6313
+ * 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.
6314
+ *
6315
+ * @param request AddExternalSAMLIdPCertificateRequest
6316
+ * @param runtime runtime options for this request RuntimeOptions
6317
+ * @return AddExternalSAMLIdPCertificateResponse
6318
+ */
6215
6319
  async addExternalSAMLIdPCertificateWithOptions(request: AddExternalSAMLIdPCertificateRequest, runtime: $Util.RuntimeOptions): Promise<AddExternalSAMLIdPCertificateResponse> {
6216
6320
  Util.validateModel(request);
6217
6321
  let query = { };
@@ -6240,11 +6344,29 @@ export default class Client extends OpenApi {
6240
6344
  return $tea.cast<AddExternalSAMLIdPCertificateResponse>(await this.callApi(params, req, runtime), new AddExternalSAMLIdPCertificateResponse({}));
6241
6345
  }
6242
6346
 
6347
+ /**
6348
+ * You can add up to two SAML signing certificates.
6349
+ * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
6350
+ * ## Limits
6351
+ * 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.
6352
+ *
6353
+ * @param request AddExternalSAMLIdPCertificateRequest
6354
+ * @return AddExternalSAMLIdPCertificateResponse
6355
+ */
6243
6356
  async addExternalSAMLIdPCertificate(request: AddExternalSAMLIdPCertificateRequest): Promise<AddExternalSAMLIdPCertificateResponse> {
6244
6357
  let runtime = new $Util.RuntimeOptions({ });
6245
6358
  return await this.addExternalSAMLIdPCertificateWithOptions(request, runtime);
6246
6359
  }
6247
6360
 
6361
+ /**
6362
+ * This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
6363
+ * ## Limits
6364
+ * 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.
6365
+ *
6366
+ * @param request AddPermissionPolicyToAccessConfigurationRequest
6367
+ * @param runtime runtime options for this request RuntimeOptions
6368
+ * @return AddPermissionPolicyToAccessConfigurationResponse
6369
+ */
6248
6370
  async addPermissionPolicyToAccessConfigurationWithOptions(request: AddPermissionPolicyToAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<AddPermissionPolicyToAccessConfigurationResponse> {
6249
6371
  Util.validateModel(request);
6250
6372
  let query = { };
@@ -6285,11 +6407,29 @@ export default class Client extends OpenApi {
6285
6407
  return $tea.cast<AddPermissionPolicyToAccessConfigurationResponse>(await this.callApi(params, req, runtime), new AddPermissionPolicyToAccessConfigurationResponse({}));
6286
6408
  }
6287
6409
 
6410
+ /**
6411
+ * This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
6412
+ * ## Limits
6413
+ * 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.
6414
+ *
6415
+ * @param request AddPermissionPolicyToAccessConfigurationRequest
6416
+ * @return AddPermissionPolicyToAccessConfigurationResponse
6417
+ */
6288
6418
  async addPermissionPolicyToAccessConfiguration(request: AddPermissionPolicyToAccessConfigurationRequest): Promise<AddPermissionPolicyToAccessConfigurationResponse> {
6289
6419
  let runtime = new $Util.RuntimeOptions({ });
6290
6420
  return await this.addPermissionPolicyToAccessConfigurationWithOptions(request, runtime);
6291
6421
  }
6292
6422
 
6423
+ /**
6424
+ * 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.
6425
+ * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
6426
+ * ## Limits
6427
+ * 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.
6428
+ *
6429
+ * @param request AddUserToGroupRequest
6430
+ * @param runtime runtime options for this request RuntimeOptions
6431
+ * @return AddUserToGroupResponse
6432
+ */
6293
6433
  async addUserToGroupWithOptions(request: AddUserToGroupRequest, runtime: $Util.RuntimeOptions): Promise<AddUserToGroupResponse> {
6294
6434
  Util.validateModel(request);
6295
6435
  let query = { };
@@ -6322,11 +6462,30 @@ export default class Client extends OpenApi {
6322
6462
  return $tea.cast<AddUserToGroupResponse>(await this.callApi(params, req, runtime), new AddUserToGroupResponse({}));
6323
6463
  }
6324
6464
 
6465
+ /**
6466
+ * 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.
6467
+ * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
6468
+ * ## Limits
6469
+ * 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.
6470
+ *
6471
+ * @param request AddUserToGroupRequest
6472
+ * @return AddUserToGroupResponse
6473
+ */
6325
6474
  async addUserToGroup(request: AddUserToGroupRequest): Promise<AddUserToGroupResponse> {
6326
6475
  let runtime = new $Util.RuntimeOptions({ });
6327
6476
  return await this.addUserToGroupWithOptions(request, runtime);
6328
6477
  }
6329
6478
 
6479
+ /**
6480
+ * 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.
6481
+ * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
6482
+ * ## Limits
6483
+ * 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.
6484
+ *
6485
+ * @param request ClearExternalSAMLIdentityProviderRequest
6486
+ * @param runtime runtime options for this request RuntimeOptions
6487
+ * @return ClearExternalSAMLIdentityProviderResponse
6488
+ */
6330
6489
  async clearExternalSAMLIdentityProviderWithOptions(request: ClearExternalSAMLIdentityProviderRequest, runtime: $Util.RuntimeOptions): Promise<ClearExternalSAMLIdentityProviderResponse> {
6331
6490
  Util.validateModel(request);
6332
6491
  let query = { };
@@ -6351,11 +6510,31 @@ export default class Client extends OpenApi {
6351
6510
  return $tea.cast<ClearExternalSAMLIdentityProviderResponse>(await this.callApi(params, req, runtime), new ClearExternalSAMLIdentityProviderResponse({}));
6352
6511
  }
6353
6512
 
6513
+ /**
6514
+ * 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.
6515
+ * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
6516
+ * ## Limits
6517
+ * 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.
6518
+ *
6519
+ * @param request ClearExternalSAMLIdentityProviderRequest
6520
+ * @return ClearExternalSAMLIdentityProviderResponse
6521
+ */
6354
6522
  async clearExternalSAMLIdentityProvider(request: ClearExternalSAMLIdentityProviderRequest): Promise<ClearExternalSAMLIdentityProviderResponse> {
6355
6523
  let runtime = new $Util.RuntimeOptions({ });
6356
6524
  return await this.clearExternalSAMLIdentityProviderWithOptions(request, runtime);
6357
6525
  }
6358
6526
 
6527
+ /**
6528
+ * When you call this operation, an asynchronous task is created. You can call the [GetTask](~~340670~~) operation to query the progress of task execution by using the value of the `TaskId` response parameter.
6529
+ * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](~~266726~~).
6530
+ * 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.
6531
+ * ## Limits
6532
+ * You can call this operation up to 20 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.
6533
+ *
6534
+ * @param request CreateAccessAssignmentRequest
6535
+ * @param runtime runtime options for this request RuntimeOptions
6536
+ * @return CreateAccessAssignmentResponse
6537
+ */
6359
6538
  async createAccessAssignmentWithOptions(request: CreateAccessAssignmentRequest, runtime: $Util.RuntimeOptions): Promise<CreateAccessAssignmentResponse> {
6360
6539
  Util.validateModel(request);
6361
6540
  let query = { };
@@ -6400,11 +6579,31 @@ export default class Client extends OpenApi {
6400
6579
  return $tea.cast<CreateAccessAssignmentResponse>(await this.callApi(params, req, runtime), new CreateAccessAssignmentResponse({}));
6401
6580
  }
6402
6581
 
6582
+ /**
6583
+ * When you call this operation, an asynchronous task is created. You can call the [GetTask](~~340670~~) operation to query the progress of task execution by using the value of the `TaskId` response parameter.
6584
+ * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](~~266726~~).
6585
+ * 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.
6586
+ * ## Limits
6587
+ * You can call this operation up to 20 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.
6588
+ *
6589
+ * @param request CreateAccessAssignmentRequest
6590
+ * @return CreateAccessAssignmentResponse
6591
+ */
6403
6592
  async createAccessAssignment(request: CreateAccessAssignmentRequest): Promise<CreateAccessAssignmentResponse> {
6404
6593
  let runtime = new $Util.RuntimeOptions({ });
6405
6594
  return await this.createAccessAssignmentWithOptions(request, runtime);
6406
6595
  }
6407
6596
 
6597
+ /**
6598
+ * For more information about access configurations, see [Overview of access configurations](~~266737~~).
6599
+ * This topic provides an example on how to create an access configuration named `ECS-Admin`.
6600
+ * ## Limits
6601
+ * 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.
6602
+ *
6603
+ * @param request CreateAccessConfigurationRequest
6604
+ * @param runtime runtime options for this request RuntimeOptions
6605
+ * @return CreateAccessConfigurationResponse
6606
+ */
6408
6607
  async createAccessConfigurationWithOptions(request: CreateAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<CreateAccessConfigurationResponse> {
6409
6608
  Util.validateModel(request);
6410
6609
  let query = { };
@@ -6445,11 +6644,34 @@ export default class Client extends OpenApi {
6445
6644
  return $tea.cast<CreateAccessConfigurationResponse>(await this.callApi(params, req, runtime), new CreateAccessConfigurationResponse({}));
6446
6645
  }
6447
6646
 
6647
+ /**
6648
+ * For more information about access configurations, see [Overview of access configurations](~~266737~~).
6649
+ * This topic provides an example on how to create an access configuration named `ECS-Admin`.
6650
+ * ## Limits
6651
+ * 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.
6652
+ *
6653
+ * @param request CreateAccessConfigurationRequest
6654
+ * @return CreateAccessConfigurationResponse
6655
+ */
6448
6656
  async createAccessConfiguration(request: CreateAccessConfigurationRequest): Promise<CreateAccessConfigurationResponse> {
6449
6657
  let runtime = new $Util.RuntimeOptions({ });
6450
6658
  return await this.createAccessConfigurationWithOptions(request, runtime);
6451
6659
  }
6452
6660
 
6661
+ /**
6662
+ * 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.
6663
+ * 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.
6664
+ * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
6665
+ * ## Limits
6666
+ * - You can create only one directory for a management account.
6667
+ * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
6668
+ * ## Limits
6669
+ * 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.
6670
+ *
6671
+ * @param request CreateDirectoryRequest
6672
+ * @param runtime runtime options for this request RuntimeOptions
6673
+ * @return CreateDirectoryResponse
6674
+ */
6453
6675
  async createDirectoryWithOptions(request: CreateDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<CreateDirectoryResponse> {
6454
6676
  Util.validateModel(request);
6455
6677
  let query = { };
@@ -6474,11 +6696,33 @@ export default class Client extends OpenApi {
6474
6696
  return $tea.cast<CreateDirectoryResponse>(await this.callApi(params, req, runtime), new CreateDirectoryResponse({}));
6475
6697
  }
6476
6698
 
6699
+ /**
6700
+ * 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.
6701
+ * 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.
6702
+ * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
6703
+ * ## Limits
6704
+ * - You can create only one directory for a management account.
6705
+ * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
6706
+ * ## Limits
6707
+ * 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.
6708
+ *
6709
+ * @param request CreateDirectoryRequest
6710
+ * @return CreateDirectoryResponse
6711
+ */
6477
6712
  async createDirectory(request: CreateDirectoryRequest): Promise<CreateDirectoryResponse> {
6478
6713
  let runtime = new $Util.RuntimeOptions({ });
6479
6714
  return await this.createDirectoryWithOptions(request, runtime);
6480
6715
  }
6481
6716
 
6717
+ /**
6718
+ * This topic provides an example on how to create a group named `TestGroup`.
6719
+ * ## Limits
6720
+ * 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.
6721
+ *
6722
+ * @param request CreateGroupRequest
6723
+ * @param runtime runtime options for this request RuntimeOptions
6724
+ * @return CreateGroupResponse
6725
+ */
6482
6726
  async createGroupWithOptions(request: CreateGroupRequest, runtime: $Util.RuntimeOptions): Promise<CreateGroupResponse> {
6483
6727
  Util.validateModel(request);
6484
6728
  let query = { };
@@ -6511,11 +6755,29 @@ export default class Client extends OpenApi {
6511
6755
  return $tea.cast<CreateGroupResponse>(await this.callApi(params, req, runtime), new CreateGroupResponse({}));
6512
6756
  }
6513
6757
 
6758
+ /**
6759
+ * This topic provides an example on how to create a group named `TestGroup`.
6760
+ * ## Limits
6761
+ * 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.
6762
+ *
6763
+ * @param request CreateGroupRequest
6764
+ * @return CreateGroupResponse
6765
+ */
6514
6766
  async createGroup(request: CreateGroupRequest): Promise<CreateGroupResponse> {
6515
6767
  let runtime = new $Util.RuntimeOptions({ });
6516
6768
  return await this.createGroupWithOptions(request, runtime);
6517
6769
  }
6518
6770
 
6771
+ /**
6772
+ * SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
6773
+ * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
6774
+ * ## Limits
6775
+ * 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.
6776
+ *
6777
+ * @param request CreateSCIMServerCredentialRequest
6778
+ * @param runtime runtime options for this request RuntimeOptions
6779
+ * @return CreateSCIMServerCredentialResponse
6780
+ */
6519
6781
  async createSCIMServerCredentialWithOptions(request: CreateSCIMServerCredentialRequest, runtime: $Util.RuntimeOptions): Promise<CreateSCIMServerCredentialResponse> {
6520
6782
  Util.validateModel(request);
6521
6783
  let query = { };
@@ -6540,11 +6802,29 @@ export default class Client extends OpenApi {
6540
6802
  return $tea.cast<CreateSCIMServerCredentialResponse>(await this.callApi(params, req, runtime), new CreateSCIMServerCredentialResponse({}));
6541
6803
  }
6542
6804
 
6805
+ /**
6806
+ * SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
6807
+ * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
6808
+ * ## Limits
6809
+ * 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.
6810
+ *
6811
+ * @param request CreateSCIMServerCredentialRequest
6812
+ * @return CreateSCIMServerCredentialResponse
6813
+ */
6543
6814
  async createSCIMServerCredential(request: CreateSCIMServerCredentialRequest): Promise<CreateSCIMServerCredentialResponse> {
6544
6815
  let runtime = new $Util.RuntimeOptions({ });
6545
6816
  return await this.createSCIMServerCredentialWithOptions(request, runtime);
6546
6817
  }
6547
6818
 
6819
+ /**
6820
+ * This topic provides an example on how to create a user named `Alice`.
6821
+ * ## Limits
6822
+ * 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.
6823
+ *
6824
+ * @param request CreateUserRequest
6825
+ * @param runtime runtime options for this request RuntimeOptions
6826
+ * @return CreateUserResponse
6827
+ */
6548
6828
  async createUserWithOptions(request: CreateUserRequest, runtime: $Util.RuntimeOptions): Promise<CreateUserResponse> {
6549
6829
  Util.validateModel(request);
6550
6830
  let query = { };
@@ -6597,11 +6877,29 @@ export default class Client extends OpenApi {
6597
6877
  return $tea.cast<CreateUserResponse>(await this.callApi(params, req, runtime), new CreateUserResponse({}));
6598
6878
  }
6599
6879
 
6880
+ /**
6881
+ * This topic provides an example on how to create a user named `Alice`.
6882
+ * ## Limits
6883
+ * 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.
6884
+ *
6885
+ * @param request CreateUserRequest
6886
+ * @return CreateUserResponse
6887
+ */
6600
6888
  async createUser(request: CreateUserRequest): Promise<CreateUserResponse> {
6601
6889
  let runtime = new $Util.RuntimeOptions({ });
6602
6890
  return await this.createUserWithOptions(request, runtime);
6603
6891
  }
6604
6892
 
6893
+ /**
6894
+ * 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.
6895
+ * 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****`.
6896
+ * ## Limits
6897
+ * You can call this operation up to 20 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.
6898
+ *
6899
+ * @param request DeleteAccessAssignmentRequest
6900
+ * @param runtime runtime options for this request RuntimeOptions
6901
+ * @return DeleteAccessAssignmentResponse
6902
+ */
6605
6903
  async deleteAccessAssignmentWithOptions(request: DeleteAccessAssignmentRequest, runtime: $Util.RuntimeOptions): Promise<DeleteAccessAssignmentResponse> {
6606
6904
  Util.validateModel(request);
6607
6905
  let query = { };
@@ -6650,11 +6948,31 @@ export default class Client extends OpenApi {
6650
6948
  return $tea.cast<DeleteAccessAssignmentResponse>(await this.callApi(params, req, runtime), new DeleteAccessAssignmentResponse({}));
6651
6949
  }
6652
6950
 
6951
+ /**
6952
+ * 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.
6953
+ * 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****`.
6954
+ * ## Limits
6955
+ * You can call this operation up to 20 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.
6956
+ *
6957
+ * @param request DeleteAccessAssignmentRequest
6958
+ * @return DeleteAccessAssignmentResponse
6959
+ */
6653
6960
  async deleteAccessAssignment(request: DeleteAccessAssignmentRequest): Promise<DeleteAccessAssignmentResponse> {
6654
6961
  let runtime = new $Util.RuntimeOptions({ });
6655
6962
  return await this.deleteAccessAssignmentWithOptions(request, runtime);
6656
6963
  }
6657
6964
 
6965
+ /**
6966
+ * This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
6967
+ * ## Prerequisites
6968
+ * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](~~338352~~).
6969
+ * ## Limits
6970
+ * 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.
6971
+ *
6972
+ * @param request DeleteAccessConfigurationRequest
6973
+ * @param runtime runtime options for this request RuntimeOptions
6974
+ * @return DeleteAccessConfigurationResponse
6975
+ */
6658
6976
  async deleteAccessConfigurationWithOptions(request: DeleteAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeleteAccessConfigurationResponse> {
6659
6977
  Util.validateModel(request);
6660
6978
  let query = { };
@@ -6687,11 +7005,38 @@ export default class Client extends OpenApi {
6687
7005
  return $tea.cast<DeleteAccessConfigurationResponse>(await this.callApi(params, req, runtime), new DeleteAccessConfigurationResponse({}));
6688
7006
  }
6689
7007
 
7008
+ /**
7009
+ * This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
7010
+ * ## Prerequisites
7011
+ * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](~~338352~~).
7012
+ * ## Limits
7013
+ * 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.
7014
+ *
7015
+ * @param request DeleteAccessConfigurationRequest
7016
+ * @return DeleteAccessConfigurationResponse
7017
+ */
6690
7018
  async deleteAccessConfiguration(request: DeleteAccessConfigurationRequest): Promise<DeleteAccessConfigurationResponse> {
6691
7019
  let runtime = new $Util.RuntimeOptions({ });
6692
7020
  return await this.deleteAccessConfigurationWithOptions(request, runtime);
6693
7021
  }
6694
7022
 
7023
+ /**
7024
+ * This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
7025
+ * ## Prerequisites
7026
+ * No resources are contained in the directory that you want to delete.
7027
+ * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](~~338350~~).
7028
+ * * Users are deleted. For more information, see [DeleteUser](~~341671~~).
7029
+ * * Groups are deleted. For more information, see [DeleteGroup](~~341821~~).
7030
+ * * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](~~336907~~).
7031
+ * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](~~341842~~).
7032
+ * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](~~341573~~).
7033
+ * ## Limits
7034
+ * 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.
7035
+ *
7036
+ * @param request DeleteDirectoryRequest
7037
+ * @param runtime runtime options for this request RuntimeOptions
7038
+ * @return DeleteDirectoryResponse
7039
+ */
6695
7040
  async deleteDirectoryWithOptions(request: DeleteDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<DeleteDirectoryResponse> {
6696
7041
  Util.validateModel(request);
6697
7042
  let query = { };
@@ -6716,11 +7061,40 @@ export default class Client extends OpenApi {
6716
7061
  return $tea.cast<DeleteDirectoryResponse>(await this.callApi(params, req, runtime), new DeleteDirectoryResponse({}));
6717
7062
  }
6718
7063
 
7064
+ /**
7065
+ * This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
7066
+ * ## Prerequisites
7067
+ * No resources are contained in the directory that you want to delete.
7068
+ * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](~~338350~~).
7069
+ * * Users are deleted. For more information, see [DeleteUser](~~341671~~).
7070
+ * * Groups are deleted. For more information, see [DeleteGroup](~~341821~~).
7071
+ * * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](~~336907~~).
7072
+ * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](~~341842~~).
7073
+ * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](~~341573~~).
7074
+ * ## Limits
7075
+ * 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.
7076
+ *
7077
+ * @param request DeleteDirectoryRequest
7078
+ * @return DeleteDirectoryResponse
7079
+ */
6719
7080
  async deleteDirectory(request: DeleteDirectoryRequest): Promise<DeleteDirectoryResponse> {
6720
7081
  let runtime = new $Util.RuntimeOptions({ });
6721
7082
  return await this.deleteDirectoryWithOptions(request, runtime);
6722
7083
  }
6723
7084
 
7085
+ /**
7086
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
7087
+ * ## Prerequisites
7088
+ * 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.
7089
+ * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](~~335116~~).
7090
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](~~338350~~).
7091
+ * ## Limits
7092
+ * 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.
7093
+ *
7094
+ * @param request DeleteGroupRequest
7095
+ * @param runtime runtime options for this request RuntimeOptions
7096
+ * @return DeleteGroupResponse
7097
+ */
6724
7098
  async deleteGroupWithOptions(request: DeleteGroupRequest, runtime: $Util.RuntimeOptions): Promise<DeleteGroupResponse> {
6725
7099
  Util.validateModel(request);
6726
7100
  let query = { };
@@ -6749,11 +7123,32 @@ export default class Client extends OpenApi {
6749
7123
  return $tea.cast<DeleteGroupResponse>(await this.callApi(params, req, runtime), new DeleteGroupResponse({}));
6750
7124
  }
6751
7125
 
7126
+ /**
7127
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
7128
+ * ## Prerequisites
7129
+ * 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.
7130
+ * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](~~335116~~).
7131
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](~~338350~~).
7132
+ * ## Limits
7133
+ * 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.
7134
+ *
7135
+ * @param request DeleteGroupRequest
7136
+ * @return DeleteGroupResponse
7137
+ */
6752
7138
  async deleteGroup(request: DeleteGroupRequest): Promise<DeleteGroupResponse> {
6753
7139
  let runtime = new $Util.RuntimeOptions({ });
6754
7140
  return await this.deleteGroupWithOptions(request, runtime);
6755
7141
  }
6756
7142
 
7143
+ /**
7144
+ * This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
7145
+ * ## Limits
7146
+ * 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.
7147
+ *
7148
+ * @param request DeleteMFADeviceForUserRequest
7149
+ * @param runtime runtime options for this request RuntimeOptions
7150
+ * @return DeleteMFADeviceForUserResponse
7151
+ */
6757
7152
  async deleteMFADeviceForUserWithOptions(request: DeleteMFADeviceForUserRequest, runtime: $Util.RuntimeOptions): Promise<DeleteMFADeviceForUserResponse> {
6758
7153
  Util.validateModel(request);
6759
7154
  let query = { };
@@ -6786,11 +7181,29 @@ export default class Client extends OpenApi {
6786
7181
  return $tea.cast<DeleteMFADeviceForUserResponse>(await this.callApi(params, req, runtime), new DeleteMFADeviceForUserResponse({}));
6787
7182
  }
6788
7183
 
7184
+ /**
7185
+ * This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
7186
+ * ## Limits
7187
+ * 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.
7188
+ *
7189
+ * @param request DeleteMFADeviceForUserRequest
7190
+ * @return DeleteMFADeviceForUserResponse
7191
+ */
6789
7192
  async deleteMFADeviceForUser(request: DeleteMFADeviceForUserRequest): Promise<DeleteMFADeviceForUserResponse> {
6790
7193
  let runtime = new $Util.RuntimeOptions({ });
6791
7194
  return await this.deleteMFADeviceForUserWithOptions(request, runtime);
6792
7195
  }
6793
7196
 
7197
+ /**
7198
+ * After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
7199
+ * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
7200
+ * ## Limits
7201
+ * 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.
7202
+ *
7203
+ * @param request DeleteSCIMServerCredentialRequest
7204
+ * @param runtime runtime options for this request RuntimeOptions
7205
+ * @return DeleteSCIMServerCredentialResponse
7206
+ */
6794
7207
  async deleteSCIMServerCredentialWithOptions(request: DeleteSCIMServerCredentialRequest, runtime: $Util.RuntimeOptions): Promise<DeleteSCIMServerCredentialResponse> {
6795
7208
  Util.validateModel(request);
6796
7209
  let query = { };
@@ -6819,11 +7232,34 @@ export default class Client extends OpenApi {
6819
7232
  return $tea.cast<DeleteSCIMServerCredentialResponse>(await this.callApi(params, req, runtime), new DeleteSCIMServerCredentialResponse({}));
6820
7233
  }
6821
7234
 
7235
+ /**
7236
+ * After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
7237
+ * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
7238
+ * ## Limits
7239
+ * 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.
7240
+ *
7241
+ * @param request DeleteSCIMServerCredentialRequest
7242
+ * @return DeleteSCIMServerCredentialResponse
7243
+ */
6822
7244
  async deleteSCIMServerCredential(request: DeleteSCIMServerCredentialRequest): Promise<DeleteSCIMServerCredentialResponse> {
6823
7245
  let runtime = new $Util.RuntimeOptions({ });
6824
7246
  return await this.deleteSCIMServerCredentialWithOptions(request, runtime);
6825
7247
  }
6826
7248
 
7249
+ /**
7250
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
7251
+ * ## Prerequisites
7252
+ * 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.
7253
+ * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](~~341675~~).
7254
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](~~338350~~).
7255
+ * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](~~335116~~).
7256
+ * ## Limits
7257
+ * 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.
7258
+ *
7259
+ * @param request DeleteUserRequest
7260
+ * @param runtime runtime options for this request RuntimeOptions
7261
+ * @return DeleteUserResponse
7262
+ */
6827
7263
  async deleteUserWithOptions(request: DeleteUserRequest, runtime: $Util.RuntimeOptions): Promise<DeleteUserResponse> {
6828
7264
  Util.validateModel(request);
6829
7265
  let query = { };
@@ -6852,11 +7288,34 @@ export default class Client extends OpenApi {
6852
7288
  return $tea.cast<DeleteUserResponse>(await this.callApi(params, req, runtime), new DeleteUserResponse({}));
6853
7289
  }
6854
7290
 
7291
+ /**
7292
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
7293
+ * ## Prerequisites
7294
+ * 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.
7295
+ * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](~~341675~~).
7296
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](~~338350~~).
7297
+ * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](~~335116~~).
7298
+ * ## Limits
7299
+ * 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.
7300
+ *
7301
+ * @param request DeleteUserRequest
7302
+ * @return DeleteUserResponse
7303
+ */
6855
7304
  async deleteUser(request: DeleteUserRequest): Promise<DeleteUserResponse> {
6856
7305
  let runtime = new $Util.RuntimeOptions({ });
6857
7306
  return await this.deleteUserWithOptions(request, runtime);
6858
7307
  }
6859
7308
 
7309
+ /**
7310
+ * 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.
7311
+ * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
7312
+ * ## Limits
7313
+ * You can call this operation up to 20 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.
7314
+ *
7315
+ * @param request DeprovisionAccessConfigurationRequest
7316
+ * @param runtime runtime options for this request RuntimeOptions
7317
+ * @return DeprovisionAccessConfigurationResponse
7318
+ */
6860
7319
  async deprovisionAccessConfigurationWithOptions(request: DeprovisionAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeprovisionAccessConfigurationResponse> {
6861
7320
  Util.validateModel(request);
6862
7321
  let query = { };
@@ -6893,11 +7352,29 @@ export default class Client extends OpenApi {
6893
7352
  return $tea.cast<DeprovisionAccessConfigurationResponse>(await this.callApi(params, req, runtime), new DeprovisionAccessConfigurationResponse({}));
6894
7353
  }
6895
7354
 
7355
+ /**
7356
+ * 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.
7357
+ * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
7358
+ * ## Limits
7359
+ * You can call this operation up to 20 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.
7360
+ *
7361
+ * @param request DeprovisionAccessConfigurationRequest
7362
+ * @return DeprovisionAccessConfigurationResponse
7363
+ */
6896
7364
  async deprovisionAccessConfiguration(request: DeprovisionAccessConfigurationRequest): Promise<DeprovisionAccessConfigurationResponse> {
6897
7365
  let runtime = new $Util.RuntimeOptions({ });
6898
7366
  return await this.deprovisionAccessConfigurationWithOptions(request, runtime);
6899
7367
  }
6900
7368
 
7369
+ /**
7370
+ * 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.
7371
+ * ## Limits
7372
+ * 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.
7373
+ *
7374
+ * @param request DisableServiceRequest
7375
+ * @param runtime runtime options for this request RuntimeOptions
7376
+ * @return DisableServiceResponse
7377
+ */
6901
7378
  async disableServiceWithOptions(runtime: $Util.RuntimeOptions): Promise<DisableServiceResponse> {
6902
7379
  let req = new $OpenApi.OpenApiRequest({ });
6903
7380
  let params = new $OpenApi.Params({
@@ -6914,11 +7391,28 @@ export default class Client extends OpenApi {
6914
7391
  return $tea.cast<DisableServiceResponse>(await this.callApi(params, req, runtime), new DisableServiceResponse({}));
6915
7392
  }
6916
7393
 
7394
+ /**
7395
+ * 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.
7396
+ * ## Limits
7397
+ * 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.
7398
+ *
7399
+ * @return DisableServiceResponse
7400
+ */
6917
7401
  async disableService(): Promise<DisableServiceResponse> {
6918
7402
  let runtime = new $Util.RuntimeOptions({ });
6919
7403
  return await this.disableServiceWithOptions(runtime);
6920
7404
  }
6921
7405
 
7406
+ /**
7407
+ * 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~~).
7408
+ * 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).
7409
+ * ## Limits
7410
+ * 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.
7411
+ *
7412
+ * @param request EnableServiceRequest
7413
+ * @param runtime runtime options for this request RuntimeOptions
7414
+ * @return EnableServiceResponse
7415
+ */
6922
7416
  async enableServiceWithOptions(runtime: $Util.RuntimeOptions): Promise<EnableServiceResponse> {
6923
7417
  let req = new $OpenApi.OpenApiRequest({ });
6924
7418
  let params = new $OpenApi.Params({
@@ -6935,11 +7429,27 @@ export default class Client extends OpenApi {
6935
7429
  return $tea.cast<EnableServiceResponse>(await this.callApi(params, req, runtime), new EnableServiceResponse({}));
6936
7430
  }
6937
7431
 
7432
+ /**
7433
+ * 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~~).
7434
+ * 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).
7435
+ * ## Limits
7436
+ * 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.
7437
+ *
7438
+ * @return EnableServiceResponse
7439
+ */
6938
7440
  async enableService(): Promise<EnableServiceResponse> {
6939
7441
  let runtime = new $Util.RuntimeOptions({ });
6940
7442
  return await this.enableServiceWithOptions(runtime);
6941
7443
  }
6942
7444
 
7445
+ /**
7446
+ * ## Usage notes
7447
+ * This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
7448
+ *
7449
+ * @param request GetAccessConfigurationRequest
7450
+ * @param runtime runtime options for this request RuntimeOptions
7451
+ * @return GetAccessConfigurationResponse
7452
+ */
6943
7453
  async getAccessConfigurationWithOptions(request: GetAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<GetAccessConfigurationResponse> {
6944
7454
  Util.validateModel(request);
6945
7455
  let query = { };
@@ -6968,11 +7478,27 @@ export default class Client extends OpenApi {
6968
7478
  return $tea.cast<GetAccessConfigurationResponse>(await this.callApi(params, req, runtime), new GetAccessConfigurationResponse({}));
6969
7479
  }
6970
7480
 
7481
+ /**
7482
+ * ## Usage notes
7483
+ * This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
7484
+ *
7485
+ * @param request GetAccessConfigurationRequest
7486
+ * @return GetAccessConfigurationResponse
7487
+ */
6971
7488
  async getAccessConfiguration(request: GetAccessConfigurationRequest): Promise<GetAccessConfigurationResponse> {
6972
7489
  let runtime = new $Util.RuntimeOptions({ });
6973
7490
  return await this.getAccessConfigurationWithOptions(request, runtime);
6974
7491
  }
6975
7492
 
7493
+ /**
7494
+ * This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
7495
+ * ## Limits
7496
+ * 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.
7497
+ *
7498
+ * @param request GetDirectoryRequest
7499
+ * @param runtime runtime options for this request RuntimeOptions
7500
+ * @return GetDirectoryResponse
7501
+ */
6976
7502
  async getDirectoryWithOptions(request: GetDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<GetDirectoryResponse> {
6977
7503
  Util.validateModel(request);
6978
7504
  let query = { };
@@ -6997,11 +7523,29 @@ export default class Client extends OpenApi {
6997
7523
  return $tea.cast<GetDirectoryResponse>(await this.callApi(params, req, runtime), new GetDirectoryResponse({}));
6998
7524
  }
6999
7525
 
7526
+ /**
7527
+ * This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
7528
+ * ## Limits
7529
+ * 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.
7530
+ *
7531
+ * @param request GetDirectoryRequest
7532
+ * @return GetDirectoryResponse
7533
+ */
7000
7534
  async getDirectory(request: GetDirectoryRequest): Promise<GetDirectoryResponse> {
7001
7535
  let runtime = new $Util.RuntimeOptions({ });
7002
7536
  return await this.getDirectoryWithOptions(request, runtime);
7003
7537
  }
7004
7538
 
7539
+ /**
7540
+ * 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).
7541
+ * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
7542
+ * ## Limits
7543
+ * 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.
7544
+ *
7545
+ * @param request GetDirectorySAMLServiceProviderInfoRequest
7546
+ * @param runtime runtime options for this request RuntimeOptions
7547
+ * @return GetDirectorySAMLServiceProviderInfoResponse
7548
+ */
7005
7549
  async getDirectorySAMLServiceProviderInfoWithOptions(request: GetDirectorySAMLServiceProviderInfoRequest, runtime: $Util.RuntimeOptions): Promise<GetDirectorySAMLServiceProviderInfoResponse> {
7006
7550
  Util.validateModel(request);
7007
7551
  let query = { };
@@ -7026,11 +7570,29 @@ export default class Client extends OpenApi {
7026
7570
  return $tea.cast<GetDirectorySAMLServiceProviderInfoResponse>(await this.callApi(params, req, runtime), new GetDirectorySAMLServiceProviderInfoResponse({}));
7027
7571
  }
7028
7572
 
7573
+ /**
7574
+ * 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).
7575
+ * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
7576
+ * ## Limits
7577
+ * 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.
7578
+ *
7579
+ * @param request GetDirectorySAMLServiceProviderInfoRequest
7580
+ * @return GetDirectorySAMLServiceProviderInfoResponse
7581
+ */
7029
7582
  async getDirectorySAMLServiceProviderInfo(request: GetDirectorySAMLServiceProviderInfoRequest): Promise<GetDirectorySAMLServiceProviderInfoResponse> {
7030
7583
  let runtime = new $Util.RuntimeOptions({ });
7031
7584
  return await this.getDirectorySAMLServiceProviderInfoWithOptions(request, runtime);
7032
7585
  }
7033
7586
 
7587
+ /**
7588
+ * 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, 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) logon, and status of SCIM synchronization.
7589
+ * ## Limits
7590
+ * 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.
7591
+ *
7592
+ * @param request GetDirectoryStatisticsRequest
7593
+ * @param runtime runtime options for this request RuntimeOptions
7594
+ * @return GetDirectoryStatisticsResponse
7595
+ */
7034
7596
  async getDirectoryStatisticsWithOptions(request: GetDirectoryStatisticsRequest, runtime: $Util.RuntimeOptions): Promise<GetDirectoryStatisticsResponse> {
7035
7597
  Util.validateModel(request);
7036
7598
  let query = { };
@@ -7055,11 +7617,28 @@ export default class Client extends OpenApi {
7055
7617
  return $tea.cast<GetDirectoryStatisticsResponse>(await this.callApi(params, req, runtime), new GetDirectoryStatisticsResponse({}));
7056
7618
  }
7057
7619
 
7620
+ /**
7621
+ * 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, 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) logon, and status of SCIM synchronization.
7622
+ * ## Limits
7623
+ * 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.
7624
+ *
7625
+ * @param request GetDirectoryStatisticsRequest
7626
+ * @return GetDirectoryStatisticsResponse
7627
+ */
7058
7628
  async getDirectoryStatistics(request: GetDirectoryStatisticsRequest): Promise<GetDirectoryStatisticsResponse> {
7059
7629
  let runtime = new $Util.RuntimeOptions({ });
7060
7630
  return await this.getDirectoryStatisticsWithOptions(request, runtime);
7061
7631
  }
7062
7632
 
7633
+ /**
7634
+ * This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
7635
+ * ## Limits
7636
+ * 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.
7637
+ *
7638
+ * @param request GetExternalSAMLIdentityProviderRequest
7639
+ * @param runtime runtime options for this request RuntimeOptions
7640
+ * @return GetExternalSAMLIdentityProviderResponse
7641
+ */
7063
7642
  async getExternalSAMLIdentityProviderWithOptions(request: GetExternalSAMLIdentityProviderRequest, runtime: $Util.RuntimeOptions): Promise<GetExternalSAMLIdentityProviderResponse> {
7064
7643
  Util.validateModel(request);
7065
7644
  let query = { };
@@ -7084,11 +7663,28 @@ export default class Client extends OpenApi {
7084
7663
  return $tea.cast<GetExternalSAMLIdentityProviderResponse>(await this.callApi(params, req, runtime), new GetExternalSAMLIdentityProviderResponse({}));
7085
7664
  }
7086
7665
 
7666
+ /**
7667
+ * This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
7668
+ * ## Limits
7669
+ * 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.
7670
+ *
7671
+ * @param request GetExternalSAMLIdentityProviderRequest
7672
+ * @return GetExternalSAMLIdentityProviderResponse
7673
+ */
7087
7674
  async getExternalSAMLIdentityProvider(request: GetExternalSAMLIdentityProviderRequest): Promise<GetExternalSAMLIdentityProviderResponse> {
7088
7675
  let runtime = new $Util.RuntimeOptions({ });
7089
7676
  return await this.getExternalSAMLIdentityProviderWithOptions(request, runtime);
7090
7677
  }
7091
7678
 
7679
+ /**
7680
+ * This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
7681
+ * ## Limits
7682
+ * 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.
7683
+ *
7684
+ * @param request GetGroupRequest
7685
+ * @param runtime runtime options for this request RuntimeOptions
7686
+ * @return GetGroupResponse
7687
+ */
7092
7688
  async getGroupWithOptions(request: GetGroupRequest, runtime: $Util.RuntimeOptions): Promise<GetGroupResponse> {
7093
7689
  Util.validateModel(request);
7094
7690
  let query = { };
@@ -7117,11 +7713,71 @@ export default class Client extends OpenApi {
7117
7713
  return $tea.cast<GetGroupResponse>(await this.callApi(params, req, runtime), new GetGroupResponse({}));
7118
7714
  }
7119
7715
 
7716
+ /**
7717
+ * This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
7718
+ * ## Limits
7719
+ * 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.
7720
+ *
7721
+ * @param request GetGroupRequest
7722
+ * @return GetGroupResponse
7723
+ */
7120
7724
  async getGroup(request: GetGroupRequest): Promise<GetGroupResponse> {
7121
7725
  let runtime = new $Util.RuntimeOptions({ });
7122
7726
  return await this.getGroupWithOptions(request, runtime);
7123
7727
  }
7124
7728
 
7729
+ /**
7730
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
7731
+ * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
7732
+ *
7733
+ * @param request GetMFAAuthenticationSettingInfoRequest
7734
+ * @param runtime runtime options for this request RuntimeOptions
7735
+ * @return GetMFAAuthenticationSettingInfoResponse
7736
+ */
7737
+ async getMFAAuthenticationSettingInfoWithOptions(request: GetMFAAuthenticationSettingInfoRequest, runtime: $Util.RuntimeOptions): Promise<GetMFAAuthenticationSettingInfoResponse> {
7738
+ Util.validateModel(request);
7739
+ let query = { };
7740
+ if (!Util.isUnset(request.directoryId)) {
7741
+ query["DirectoryId"] = request.directoryId;
7742
+ }
7743
+
7744
+ let req = new $OpenApi.OpenApiRequest({
7745
+ query: OpenApiUtil.query(query),
7746
+ });
7747
+ let params = new $OpenApi.Params({
7748
+ action: "GetMFAAuthenticationSettingInfo",
7749
+ version: "2021-05-15",
7750
+ protocol: "HTTPS",
7751
+ pathname: "/",
7752
+ method: "POST",
7753
+ authType: "AK",
7754
+ style: "RPC",
7755
+ reqBodyType: "formData",
7756
+ bodyType: "json",
7757
+ });
7758
+ return $tea.cast<GetMFAAuthenticationSettingInfoResponse>(await this.callApi(params, req, runtime), new GetMFAAuthenticationSettingInfoResponse({}));
7759
+ }
7760
+
7761
+ /**
7762
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
7763
+ * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
7764
+ *
7765
+ * @param request GetMFAAuthenticationSettingInfoRequest
7766
+ * @return GetMFAAuthenticationSettingInfoResponse
7767
+ */
7768
+ async getMFAAuthenticationSettingInfo(request: GetMFAAuthenticationSettingInfoRequest): Promise<GetMFAAuthenticationSettingInfoResponse> {
7769
+ let runtime = new $Util.RuntimeOptions({ });
7770
+ return await this.getMFAAuthenticationSettingInfoWithOptions(request, runtime);
7771
+ }
7772
+
7773
+ /**
7774
+ * > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](~~611286~~) operation to query more detailed information.
7775
+ * 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.
7776
+ *
7777
+ * @param request GetMFAAuthenticationSettingsRequest
7778
+ * @param runtime runtime options for this request RuntimeOptions
7779
+ * @return GetMFAAuthenticationSettingsResponse
7780
+ */
7125
7781
  async getMFAAuthenticationSettingsWithOptions(request: GetMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<GetMFAAuthenticationSettingsResponse> {
7126
7782
  Util.validateModel(request);
7127
7783
  let query = { };
@@ -7146,11 +7802,27 @@ export default class Client extends OpenApi {
7146
7802
  return $tea.cast<GetMFAAuthenticationSettingsResponse>(await this.callApi(params, req, runtime), new GetMFAAuthenticationSettingsResponse({}));
7147
7803
  }
7148
7804
 
7805
+ /**
7806
+ * > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](~~611286~~) operation to query more detailed information.
7807
+ * 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.
7808
+ *
7809
+ * @param request GetMFAAuthenticationSettingsRequest
7810
+ * @return GetMFAAuthenticationSettingsResponse
7811
+ */
7149
7812
  async getMFAAuthenticationSettings(request: GetMFAAuthenticationSettingsRequest): Promise<GetMFAAuthenticationSettingsResponse> {
7150
7813
  let runtime = new $Util.RuntimeOptions({ });
7151
7814
  return await this.getMFAAuthenticationSettingsWithOptions(request, runtime);
7152
7815
  }
7153
7816
 
7817
+ /**
7818
+ * 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.
7819
+ * ## Limits
7820
+ * 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.
7821
+ *
7822
+ * @param request GetMFAAuthenticationStatusRequest
7823
+ * @param runtime runtime options for this request RuntimeOptions
7824
+ * @return GetMFAAuthenticationStatusResponse
7825
+ */
7154
7826
  async getMFAAuthenticationStatusWithOptions(request: GetMFAAuthenticationStatusRequest, runtime: $Util.RuntimeOptions): Promise<GetMFAAuthenticationStatusResponse> {
7155
7827
  Util.validateModel(request);
7156
7828
  let query = { };
@@ -7175,11 +7847,28 @@ export default class Client extends OpenApi {
7175
7847
  return $tea.cast<GetMFAAuthenticationStatusResponse>(await this.callApi(params, req, runtime), new GetMFAAuthenticationStatusResponse({}));
7176
7848
  }
7177
7849
 
7850
+ /**
7851
+ * 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.
7852
+ * ## Limits
7853
+ * 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.
7854
+ *
7855
+ * @param request GetMFAAuthenticationStatusRequest
7856
+ * @return GetMFAAuthenticationStatusResponse
7857
+ */
7178
7858
  async getMFAAuthenticationStatus(request: GetMFAAuthenticationStatusRequest): Promise<GetMFAAuthenticationStatusResponse> {
7179
7859
  let runtime = new $Util.RuntimeOptions({ });
7180
7860
  return await this.getMFAAuthenticationStatusWithOptions(request, runtime);
7181
7861
  }
7182
7862
 
7863
+ /**
7864
+ * 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.
7865
+ * ## Limits
7866
+ * 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.
7867
+ *
7868
+ * @param request GetSCIMSynchronizationStatusRequest
7869
+ * @param runtime runtime options for this request RuntimeOptions
7870
+ * @return GetSCIMSynchronizationStatusResponse
7871
+ */
7183
7872
  async getSCIMSynchronizationStatusWithOptions(request: GetSCIMSynchronizationStatusRequest, runtime: $Util.RuntimeOptions): Promise<GetSCIMSynchronizationStatusResponse> {
7184
7873
  Util.validateModel(request);
7185
7874
  let query = { };
@@ -7204,11 +7893,27 @@ export default class Client extends OpenApi {
7204
7893
  return $tea.cast<GetSCIMSynchronizationStatusResponse>(await this.callApi(params, req, runtime), new GetSCIMSynchronizationStatusResponse({}));
7205
7894
  }
7206
7895
 
7896
+ /**
7897
+ * 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.
7898
+ * ## Limits
7899
+ * 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.
7900
+ *
7901
+ * @param request GetSCIMSynchronizationStatusRequest
7902
+ * @return GetSCIMSynchronizationStatusResponse
7903
+ */
7207
7904
  async getSCIMSynchronizationStatus(request: GetSCIMSynchronizationStatusRequest): Promise<GetSCIMSynchronizationStatusResponse> {
7208
7905
  let runtime = new $Util.RuntimeOptions({ });
7209
7906
  return await this.getSCIMSynchronizationStatusWithOptions(request, runtime);
7210
7907
  }
7211
7908
 
7909
+ /**
7910
+ * ## Limits
7911
+ * 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.
7912
+ *
7913
+ * @param request GetServiceStatusRequest
7914
+ * @param runtime runtime options for this request RuntimeOptions
7915
+ * @return GetServiceStatusResponse
7916
+ */
7212
7917
  async getServiceStatusWithOptions(runtime: $Util.RuntimeOptions): Promise<GetServiceStatusResponse> {
7213
7918
  let req = new $OpenApi.OpenApiRequest({ });
7214
7919
  let params = new $OpenApi.Params({
@@ -7225,11 +7930,26 @@ export default class Client extends OpenApi {
7225
7930
  return $tea.cast<GetServiceStatusResponse>(await this.callApi(params, req, runtime), new GetServiceStatusResponse({}));
7226
7931
  }
7227
7932
 
7933
+ /**
7934
+ * ## Limits
7935
+ * 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.
7936
+ *
7937
+ * @return GetServiceStatusResponse
7938
+ */
7228
7939
  async getServiceStatus(): Promise<GetServiceStatusResponse> {
7229
7940
  let runtime = new $Util.RuntimeOptions({ });
7230
7941
  return await this.getServiceStatusWithOptions(runtime);
7231
7942
  }
7232
7943
 
7944
+ /**
7945
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
7946
+ * ## Limits
7947
+ * You can call this operation up to 20 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.
7948
+ *
7949
+ * @param request GetTaskRequest
7950
+ * @param runtime runtime options for this request RuntimeOptions
7951
+ * @return GetTaskResponse
7952
+ */
7233
7953
  async getTaskWithOptions(request: GetTaskRequest, runtime: $Util.RuntimeOptions): Promise<GetTaskResponse> {
7234
7954
  Util.validateModel(request);
7235
7955
  let query = { };
@@ -7258,11 +7978,29 @@ export default class Client extends OpenApi {
7258
7978
  return $tea.cast<GetTaskResponse>(await this.callApi(params, req, runtime), new GetTaskResponse({}));
7259
7979
  }
7260
7980
 
7981
+ /**
7982
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
7983
+ * ## Limits
7984
+ * You can call this operation up to 20 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.
7985
+ *
7986
+ * @param request GetTaskRequest
7987
+ * @return GetTaskResponse
7988
+ */
7261
7989
  async getTask(request: GetTaskRequest): Promise<GetTaskResponse> {
7262
7990
  let runtime = new $Util.RuntimeOptions({ });
7263
7991
  return await this.getTaskWithOptions(request, runtime);
7264
7992
  }
7265
7993
 
7994
+ /**
7995
+ * 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, you can call the [GetTask](~~340670~~) operation.
7996
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
7997
+ * ## Limits
7998
+ * 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.
7999
+ *
8000
+ * @param request GetTaskStatusRequest
8001
+ * @param runtime runtime options for this request RuntimeOptions
8002
+ * @return GetTaskStatusResponse
8003
+ */
7266
8004
  async getTaskStatusWithOptions(request: GetTaskStatusRequest, runtime: $Util.RuntimeOptions): Promise<GetTaskStatusResponse> {
7267
8005
  Util.validateModel(request);
7268
8006
  let query = { };
@@ -7291,11 +8029,29 @@ export default class Client extends OpenApi {
7291
8029
  return $tea.cast<GetTaskStatusResponse>(await this.callApi(params, req, runtime), new GetTaskStatusResponse({}));
7292
8030
  }
7293
8031
 
8032
+ /**
8033
+ * 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, you can call the [GetTask](~~340670~~) operation.
8034
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
8035
+ * ## Limits
8036
+ * 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.
8037
+ *
8038
+ * @param request GetTaskStatusRequest
8039
+ * @return GetTaskStatusResponse
8040
+ */
7294
8041
  async getTaskStatus(request: GetTaskStatusRequest): Promise<GetTaskStatusResponse> {
7295
8042
  let runtime = new $Util.RuntimeOptions({ });
7296
8043
  return await this.getTaskStatusWithOptions(request, runtime);
7297
8044
  }
7298
8045
 
8046
+ /**
8047
+ * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
8048
+ * ## Limits
8049
+ * 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.
8050
+ *
8051
+ * @param request GetUserRequest
8052
+ * @param runtime runtime options for this request RuntimeOptions
8053
+ * @return GetUserResponse
8054
+ */
7299
8055
  async getUserWithOptions(request: GetUserRequest, runtime: $Util.RuntimeOptions): Promise<GetUserResponse> {
7300
8056
  Util.validateModel(request);
7301
8057
  let query = { };
@@ -7324,11 +8080,26 @@ export default class Client extends OpenApi {
7324
8080
  return $tea.cast<GetUserResponse>(await this.callApi(params, req, runtime), new GetUserResponse({}));
7325
8081
  }
7326
8082
 
8083
+ /**
8084
+ * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
8085
+ * ## Limits
8086
+ * 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.
8087
+ *
8088
+ * @param request GetUserRequest
8089
+ * @return GetUserResponse
8090
+ */
7327
8091
  async getUser(request: GetUserRequest): Promise<GetUserResponse> {
7328
8092
  let runtime = new $Util.RuntimeOptions({ });
7329
8093
  return await this.getUserWithOptions(request, runtime);
7330
8094
  }
7331
8095
 
8096
+ /**
8097
+ * 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.
8098
+ *
8099
+ * @param request GetUserMFAAuthenticationSettingsRequest
8100
+ * @param runtime runtime options for this request RuntimeOptions
8101
+ * @return GetUserMFAAuthenticationSettingsResponse
8102
+ */
7332
8103
  async getUserMFAAuthenticationSettingsWithOptions(request: GetUserMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<GetUserMFAAuthenticationSettingsResponse> {
7333
8104
  Util.validateModel(request);
7334
8105
  let query = { };
@@ -7357,11 +8128,26 @@ export default class Client extends OpenApi {
7357
8128
  return $tea.cast<GetUserMFAAuthenticationSettingsResponse>(await this.callApi(params, req, runtime), new GetUserMFAAuthenticationSettingsResponse({}));
7358
8129
  }
7359
8130
 
8131
+ /**
8132
+ * 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.
8133
+ *
8134
+ * @param request GetUserMFAAuthenticationSettingsRequest
8135
+ * @return GetUserMFAAuthenticationSettingsResponse
8136
+ */
7360
8137
  async getUserMFAAuthenticationSettings(request: GetUserMFAAuthenticationSettingsRequest): Promise<GetUserMFAAuthenticationSettingsResponse> {
7361
8138
  let runtime = new $Util.RuntimeOptions({ });
7362
8139
  return await this.getUserMFAAuthenticationSettingsWithOptions(request, runtime);
7363
8140
  }
7364
8141
 
8142
+ /**
8143
+ * 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.
8144
+ * ## Limits
8145
+ * You can call this operation up to 20 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.
8146
+ *
8147
+ * @param request ListAccessAssignmentsRequest
8148
+ * @param runtime runtime options for this request RuntimeOptions
8149
+ * @return ListAccessAssignmentsResponse
8150
+ */
7365
8151
  async listAccessAssignmentsWithOptions(request: ListAccessAssignmentsRequest, runtime: $Util.RuntimeOptions): Promise<ListAccessAssignmentsResponse> {
7366
8152
  Util.validateModel(request);
7367
8153
  let query = { };
@@ -7414,11 +8200,27 @@ export default class Client extends OpenApi {
7414
8200
  return $tea.cast<ListAccessAssignmentsResponse>(await this.callApi(params, req, runtime), new ListAccessAssignmentsResponse({}));
7415
8201
  }
7416
8202
 
8203
+ /**
8204
+ * 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.
8205
+ * ## Limits
8206
+ * You can call this operation up to 20 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.
8207
+ *
8208
+ * @param request ListAccessAssignmentsRequest
8209
+ * @return ListAccessAssignmentsResponse
8210
+ */
7417
8211
  async listAccessAssignments(request: ListAccessAssignmentsRequest): Promise<ListAccessAssignmentsResponse> {
7418
8212
  let runtime = new $Util.RuntimeOptions({ });
7419
8213
  return await this.listAccessAssignmentsWithOptions(request, runtime);
7420
8214
  }
7421
8215
 
8216
+ /**
8217
+ * ## Usage notes
8218
+ * 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.
8219
+ *
8220
+ * @param request ListAccessConfigurationProvisioningsRequest
8221
+ * @param runtime runtime options for this request RuntimeOptions
8222
+ * @return ListAccessConfigurationProvisioningsResponse
8223
+ */
7422
8224
  async listAccessConfigurationProvisioningsWithOptions(request: ListAccessConfigurationProvisioningsRequest, runtime: $Util.RuntimeOptions): Promise<ListAccessConfigurationProvisioningsResponse> {
7423
8225
  Util.validateModel(request);
7424
8226
  let query = { };
@@ -7467,11 +8269,26 @@ export default class Client extends OpenApi {
7467
8269
  return $tea.cast<ListAccessConfigurationProvisioningsResponse>(await this.callApi(params, req, runtime), new ListAccessConfigurationProvisioningsResponse({}));
7468
8270
  }
7469
8271
 
8272
+ /**
8273
+ * ## Usage notes
8274
+ * 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.
8275
+ *
8276
+ * @param request ListAccessConfigurationProvisioningsRequest
8277
+ * @return ListAccessConfigurationProvisioningsResponse
8278
+ */
7470
8279
  async listAccessConfigurationProvisionings(request: ListAccessConfigurationProvisioningsRequest): Promise<ListAccessConfigurationProvisioningsResponse> {
7471
8280
  let runtime = new $Util.RuntimeOptions({ });
7472
8281
  return await this.listAccessConfigurationProvisioningsWithOptions(request, runtime);
7473
8282
  }
7474
8283
 
8284
+ /**
8285
+ * ## Usage notes
8286
+ * 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.
8287
+ *
8288
+ * @param request ListAccessConfigurationsRequest
8289
+ * @param runtime runtime options for this request RuntimeOptions
8290
+ * @return ListAccessConfigurationsResponse
8291
+ */
7475
8292
  async listAccessConfigurationsWithOptions(request: ListAccessConfigurationsRequest, runtime: $Util.RuntimeOptions): Promise<ListAccessConfigurationsResponse> {
7476
8293
  Util.validateModel(request);
7477
8294
  let query = { };
@@ -7512,11 +8329,27 @@ export default class Client extends OpenApi {
7512
8329
  return $tea.cast<ListAccessConfigurationsResponse>(await this.callApi(params, req, runtime), new ListAccessConfigurationsResponse({}));
7513
8330
  }
7514
8331
 
8332
+ /**
8333
+ * ## Usage notes
8334
+ * 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.
8335
+ *
8336
+ * @param request ListAccessConfigurationsRequest
8337
+ * @return ListAccessConfigurationsResponse
8338
+ */
7515
8339
  async listAccessConfigurations(request: ListAccessConfigurationsRequest): Promise<ListAccessConfigurationsResponse> {
7516
8340
  let runtime = new $Util.RuntimeOptions({ });
7517
8341
  return await this.listAccessConfigurationsWithOptions(request, runtime);
7518
8342
  }
7519
8343
 
8344
+ /**
8345
+ * 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.
8346
+ * ## Limits
8347
+ * 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.
8348
+ *
8349
+ * @param request ListDirectoriesRequest
8350
+ * @param runtime runtime options for this request RuntimeOptions
8351
+ * @return ListDirectoriesResponse
8352
+ */
7520
8353
  async listDirectoriesWithOptions(runtime: $Util.RuntimeOptions): Promise<ListDirectoriesResponse> {
7521
8354
  let req = new $OpenApi.OpenApiRequest({ });
7522
8355
  let params = new $OpenApi.Params({
@@ -7533,11 +8366,27 @@ export default class Client extends OpenApi {
7533
8366
  return $tea.cast<ListDirectoriesResponse>(await this.callApi(params, req, runtime), new ListDirectoriesResponse({}));
7534
8367
  }
7535
8368
 
8369
+ /**
8370
+ * 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.
8371
+ * ## Limits
8372
+ * 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.
8373
+ *
8374
+ * @return ListDirectoriesResponse
8375
+ */
7536
8376
  async listDirectories(): Promise<ListDirectoriesResponse> {
7537
8377
  let runtime = new $Util.RuntimeOptions({ });
7538
8378
  return await this.listDirectoriesWithOptions(runtime);
7539
8379
  }
7540
8380
 
8381
+ /**
8382
+ * 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.
8383
+ * ## Limits
8384
+ * 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.
8385
+ *
8386
+ * @param request ListExternalSAMLIdPCertificatesRequest
8387
+ * @param runtime runtime options for this request RuntimeOptions
8388
+ * @return ListExternalSAMLIdPCertificatesResponse
8389
+ */
7541
8390
  async listExternalSAMLIdPCertificatesWithOptions(request: ListExternalSAMLIdPCertificatesRequest, runtime: $Util.RuntimeOptions): Promise<ListExternalSAMLIdPCertificatesResponse> {
7542
8391
  Util.validateModel(request);
7543
8392
  let query = { };
@@ -7562,11 +8411,28 @@ export default class Client extends OpenApi {
7562
8411
  return $tea.cast<ListExternalSAMLIdPCertificatesResponse>(await this.callApi(params, req, runtime), new ListExternalSAMLIdPCertificatesResponse({}));
7563
8412
  }
7564
8413
 
8414
+ /**
8415
+ * 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.
8416
+ * ## Limits
8417
+ * 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.
8418
+ *
8419
+ * @param request ListExternalSAMLIdPCertificatesRequest
8420
+ * @return ListExternalSAMLIdPCertificatesResponse
8421
+ */
7565
8422
  async listExternalSAMLIdPCertificates(request: ListExternalSAMLIdPCertificatesRequest): Promise<ListExternalSAMLIdPCertificatesResponse> {
7566
8423
  let runtime = new $Util.RuntimeOptions({ });
7567
8424
  return await this.listExternalSAMLIdPCertificatesWithOptions(request, runtime);
7568
8425
  }
7569
8426
 
8427
+ /**
8428
+ * 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`.
8429
+ * ## Limits
8430
+ * 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.
8431
+ *
8432
+ * @param request ListGroupMembersRequest
8433
+ * @param runtime runtime options for this request RuntimeOptions
8434
+ * @return ListGroupMembersResponse
8435
+ */
7570
8436
  async listGroupMembersWithOptions(request: ListGroupMembersRequest, runtime: $Util.RuntimeOptions): Promise<ListGroupMembersResponse> {
7571
8437
  Util.validateModel(request);
7572
8438
  let query = { };
@@ -7603,11 +8469,28 @@ export default class Client extends OpenApi {
7603
8469
  return $tea.cast<ListGroupMembersResponse>(await this.callApi(params, req, runtime), new ListGroupMembersResponse({}));
7604
8470
  }
7605
8471
 
8472
+ /**
8473
+ * 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`.
8474
+ * ## Limits
8475
+ * 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.
8476
+ *
8477
+ * @param request ListGroupMembersRequest
8478
+ * @return ListGroupMembersResponse
8479
+ */
7606
8480
  async listGroupMembers(request: ListGroupMembersRequest): Promise<ListGroupMembersResponse> {
7607
8481
  let runtime = new $Util.RuntimeOptions({ });
7608
8482
  return await this.listGroupMembersWithOptions(request, runtime);
7609
8483
  }
7610
8484
 
8485
+ /**
8486
+ * 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.
8487
+ * ## Limits
8488
+ * 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.
8489
+ *
8490
+ * @param request ListGroupsRequest
8491
+ * @param runtime runtime options for this request RuntimeOptions
8492
+ * @return ListGroupsResponse
8493
+ */
7611
8494
  async listGroupsWithOptions(request: ListGroupsRequest, runtime: $Util.RuntimeOptions): Promise<ListGroupsResponse> {
7612
8495
  Util.validateModel(request);
7613
8496
  let query = { };
@@ -7648,11 +8531,28 @@ export default class Client extends OpenApi {
7648
8531
  return $tea.cast<ListGroupsResponse>(await this.callApi(params, req, runtime), new ListGroupsResponse({}));
7649
8532
  }
7650
8533
 
8534
+ /**
8535
+ * 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.
8536
+ * ## Limits
8537
+ * 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.
8538
+ *
8539
+ * @param request ListGroupsRequest
8540
+ * @return ListGroupsResponse
8541
+ */
7651
8542
  async listGroups(request: ListGroupsRequest): Promise<ListGroupsResponse> {
7652
8543
  let runtime = new $Util.RuntimeOptions({ });
7653
8544
  return await this.listGroupsWithOptions(request, runtime);
7654
8545
  }
7655
8546
 
8547
+ /**
8548
+ * 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.
8549
+ * ## Limits
8550
+ * 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.
8551
+ *
8552
+ * @param request ListJoinedGroupsForUserRequest
8553
+ * @param runtime runtime options for this request RuntimeOptions
8554
+ * @return ListJoinedGroupsForUserResponse
8555
+ */
7656
8556
  async listJoinedGroupsForUserWithOptions(request: ListJoinedGroupsForUserRequest, runtime: $Util.RuntimeOptions): Promise<ListJoinedGroupsForUserResponse> {
7657
8557
  Util.validateModel(request);
7658
8558
  let query = { };
@@ -7689,11 +8589,28 @@ export default class Client extends OpenApi {
7689
8589
  return $tea.cast<ListJoinedGroupsForUserResponse>(await this.callApi(params, req, runtime), new ListJoinedGroupsForUserResponse({}));
7690
8590
  }
7691
8591
 
8592
+ /**
8593
+ * 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.
8594
+ * ## Limits
8595
+ * 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.
8596
+ *
8597
+ * @param request ListJoinedGroupsForUserRequest
8598
+ * @return ListJoinedGroupsForUserResponse
8599
+ */
7692
8600
  async listJoinedGroupsForUser(request: ListJoinedGroupsForUserRequest): Promise<ListJoinedGroupsForUserResponse> {
7693
8601
  let runtime = new $Util.RuntimeOptions({ });
7694
8602
  return await this.listJoinedGroupsForUserWithOptions(request, runtime);
7695
8603
  }
7696
8604
 
8605
+ /**
8606
+ * 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.
8607
+ * ## Limits
8608
+ * 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.
8609
+ *
8610
+ * @param request ListMFADevicesForUserRequest
8611
+ * @param runtime runtime options for this request RuntimeOptions
8612
+ * @return ListMFADevicesForUserResponse
8613
+ */
7697
8614
  async listMFADevicesForUserWithOptions(request: ListMFADevicesForUserRequest, runtime: $Util.RuntimeOptions): Promise<ListMFADevicesForUserResponse> {
7698
8615
  Util.validateModel(request);
7699
8616
  let query = { };
@@ -7722,11 +8639,28 @@ export default class Client extends OpenApi {
7722
8639
  return $tea.cast<ListMFADevicesForUserResponse>(await this.callApi(params, req, runtime), new ListMFADevicesForUserResponse({}));
7723
8640
  }
7724
8641
 
8642
+ /**
8643
+ * 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.
8644
+ * ## Limits
8645
+ * 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.
8646
+ *
8647
+ * @param request ListMFADevicesForUserRequest
8648
+ * @return ListMFADevicesForUserResponse
8649
+ */
7725
8650
  async listMFADevicesForUser(request: ListMFADevicesForUserRequest): Promise<ListMFADevicesForUserResponse> {
7726
8651
  let runtime = new $Util.RuntimeOptions({ });
7727
8652
  return await this.listMFADevicesForUserWithOptions(request, runtime);
7728
8653
  }
7729
8654
 
8655
+ /**
8656
+ * 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.
8657
+ * ## Limits
8658
+ * 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.
8659
+ *
8660
+ * @param request ListPermissionPoliciesInAccessConfigurationRequest
8661
+ * @param runtime runtime options for this request RuntimeOptions
8662
+ * @return ListPermissionPoliciesInAccessConfigurationResponse
8663
+ */
7730
8664
  async listPermissionPoliciesInAccessConfigurationWithOptions(request: ListPermissionPoliciesInAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ListPermissionPoliciesInAccessConfigurationResponse> {
7731
8665
  Util.validateModel(request);
7732
8666
  let query = { };
@@ -7759,11 +8693,28 @@ export default class Client extends OpenApi {
7759
8693
  return $tea.cast<ListPermissionPoliciesInAccessConfigurationResponse>(await this.callApi(params, req, runtime), new ListPermissionPoliciesInAccessConfigurationResponse({}));
7760
8694
  }
7761
8695
 
8696
+ /**
8697
+ * 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.
8698
+ * ## Limits
8699
+ * 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.
8700
+ *
8701
+ * @param request ListPermissionPoliciesInAccessConfigurationRequest
8702
+ * @return ListPermissionPoliciesInAccessConfigurationResponse
8703
+ */
7762
8704
  async listPermissionPoliciesInAccessConfiguration(request: ListPermissionPoliciesInAccessConfigurationRequest): Promise<ListPermissionPoliciesInAccessConfigurationResponse> {
7763
8705
  let runtime = new $Util.RuntimeOptions({ });
7764
8706
  return await this.listPermissionPoliciesInAccessConfigurationWithOptions(request, runtime);
7765
8707
  }
7766
8708
 
8709
+ /**
8710
+ * This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
8711
+ * ## Limits
8712
+ * 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.
8713
+ *
8714
+ * @param request ListSCIMServerCredentialsRequest
8715
+ * @param runtime runtime options for this request RuntimeOptions
8716
+ * @return ListSCIMServerCredentialsResponse
8717
+ */
7767
8718
  async listSCIMServerCredentialsWithOptions(request: ListSCIMServerCredentialsRequest, runtime: $Util.RuntimeOptions): Promise<ListSCIMServerCredentialsResponse> {
7768
8719
  Util.validateModel(request);
7769
8720
  let query = { };
@@ -7788,11 +8739,29 @@ export default class Client extends OpenApi {
7788
8739
  return $tea.cast<ListSCIMServerCredentialsResponse>(await this.callApi(params, req, runtime), new ListSCIMServerCredentialsResponse({}));
7789
8740
  }
7790
8741
 
8742
+ /**
8743
+ * This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
8744
+ * ## Limits
8745
+ * 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.
8746
+ *
8747
+ * @param request ListSCIMServerCredentialsRequest
8748
+ * @return ListSCIMServerCredentialsResponse
8749
+ */
7791
8750
  async listSCIMServerCredentials(request: ListSCIMServerCredentialsRequest): Promise<ListSCIMServerCredentialsResponse> {
7792
8751
  let runtime = new $Util.RuntimeOptions({ });
7793
8752
  return await this.listSCIMServerCredentialsWithOptions(request, runtime);
7794
8753
  }
7795
8754
 
8755
+ /**
8756
+ * 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`.
8757
+ * This topic provides an example on how to query the tasks within the previous 24 hours.
8758
+ * ## Limits
8759
+ * You can call this operation up to 20 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.
8760
+ *
8761
+ * @param request ListTasksRequest
8762
+ * @param runtime runtime options for this request RuntimeOptions
8763
+ * @return ListTasksResponse
8764
+ */
7796
8765
  async listTasksWithOptions(request: ListTasksRequest, runtime: $Util.RuntimeOptions): Promise<ListTasksResponse> {
7797
8766
  Util.validateModel(request);
7798
8767
  let query = { };
@@ -7857,11 +8826,29 @@ export default class Client extends OpenApi {
7857
8826
  return $tea.cast<ListTasksResponse>(await this.callApi(params, req, runtime), new ListTasksResponse({}));
7858
8827
  }
7859
8828
 
8829
+ /**
8830
+ * 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`.
8831
+ * This topic provides an example on how to query the tasks within the previous 24 hours.
8832
+ * ## Limits
8833
+ * You can call this operation up to 20 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.
8834
+ *
8835
+ * @param request ListTasksRequest
8836
+ * @return ListTasksResponse
8837
+ */
7860
8838
  async listTasks(request: ListTasksRequest): Promise<ListTasksResponse> {
7861
8839
  let runtime = new $Util.RuntimeOptions({ });
7862
8840
  return await this.listTasksWithOptions(request, runtime);
7863
8841
  }
7864
8842
 
8843
+ /**
8844
+ * 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.
8845
+ * ## Limits
8846
+ * 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.
8847
+ *
8848
+ * @param request ListUsersRequest
8849
+ * @param runtime runtime options for this request RuntimeOptions
8850
+ * @return ListUsersResponse
8851
+ */
7865
8852
  async listUsersWithOptions(request: ListUsersRequest, runtime: $Util.RuntimeOptions): Promise<ListUsersResponse> {
7866
8853
  Util.validateModel(request);
7867
8854
  let query = { };
@@ -7906,11 +8893,29 @@ export default class Client extends OpenApi {
7906
8893
  return $tea.cast<ListUsersResponse>(await this.callApi(params, req, runtime), new ListUsersResponse({}));
7907
8894
  }
7908
8895
 
8896
+ /**
8897
+ * 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.
8898
+ * ## Limits
8899
+ * 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.
8900
+ *
8901
+ * @param request ListUsersRequest
8902
+ * @return ListUsersResponse
8903
+ */
7909
8904
  async listUsers(request: ListUsersRequest): Promise<ListUsersResponse> {
7910
8905
  let runtime = new $Util.RuntimeOptions({ });
7911
8906
  return await this.listUsersWithOptions(request, runtime);
7912
8907
  }
7913
8908
 
8909
+ /**
8910
+ * 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.
8911
+ * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
8912
+ * ## Limits
8913
+ * You can call this operation up to 20 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.
8914
+ *
8915
+ * @param request ProvisionAccessConfigurationRequest
8916
+ * @param runtime runtime options for this request RuntimeOptions
8917
+ * @return ProvisionAccessConfigurationResponse
8918
+ */
7914
8919
  async provisionAccessConfigurationWithOptions(request: ProvisionAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ProvisionAccessConfigurationResponse> {
7915
8920
  Util.validateModel(request);
7916
8921
  let query = { };
@@ -7947,11 +8952,29 @@ export default class Client extends OpenApi {
7947
8952
  return $tea.cast<ProvisionAccessConfigurationResponse>(await this.callApi(params, req, runtime), new ProvisionAccessConfigurationResponse({}));
7948
8953
  }
7949
8954
 
8955
+ /**
8956
+ * 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.
8957
+ * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
8958
+ * ## Limits
8959
+ * You can call this operation up to 20 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.
8960
+ *
8961
+ * @param request ProvisionAccessConfigurationRequest
8962
+ * @return ProvisionAccessConfigurationResponse
8963
+ */
7950
8964
  async provisionAccessConfiguration(request: ProvisionAccessConfigurationRequest): Promise<ProvisionAccessConfigurationResponse> {
7951
8965
  let runtime = new $Util.RuntimeOptions({ });
7952
8966
  return await this.provisionAccessConfigurationWithOptions(request, runtime);
7953
8967
  }
7954
8968
 
8969
+ /**
8970
+ * This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
8971
+ * ## Limits
8972
+ * 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.
8973
+ *
8974
+ * @param request RemoveExternalSAMLIdPCertificateRequest
8975
+ * @param runtime runtime options for this request RuntimeOptions
8976
+ * @return RemoveExternalSAMLIdPCertificateResponse
8977
+ */
7955
8978
  async removeExternalSAMLIdPCertificateWithOptions(request: RemoveExternalSAMLIdPCertificateRequest, runtime: $Util.RuntimeOptions): Promise<RemoveExternalSAMLIdPCertificateResponse> {
7956
8979
  Util.validateModel(request);
7957
8980
  let query = { };
@@ -7980,11 +9003,29 @@ export default class Client extends OpenApi {
7980
9003
  return $tea.cast<RemoveExternalSAMLIdPCertificateResponse>(await this.callApi(params, req, runtime), new RemoveExternalSAMLIdPCertificateResponse({}));
7981
9004
  }
7982
9005
 
9006
+ /**
9007
+ * This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
9008
+ * ## Limits
9009
+ * 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.
9010
+ *
9011
+ * @param request RemoveExternalSAMLIdPCertificateRequest
9012
+ * @return RemoveExternalSAMLIdPCertificateResponse
9013
+ */
7983
9014
  async removeExternalSAMLIdPCertificate(request: RemoveExternalSAMLIdPCertificateRequest): Promise<RemoveExternalSAMLIdPCertificateResponse> {
7984
9015
  let runtime = new $Util.RuntimeOptions({ });
7985
9016
  return await this.removeExternalSAMLIdPCertificateWithOptions(request, runtime);
7986
9017
  }
7987
9018
 
9019
+ /**
9020
+ * After you remove an inline policy from an access configuration, the policy cannot be restored.
9021
+ * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
9022
+ * ## Limits
9023
+ * 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.
9024
+ *
9025
+ * @param request RemovePermissionPolicyFromAccessConfigurationRequest
9026
+ * @param runtime runtime options for this request RuntimeOptions
9027
+ * @return RemovePermissionPolicyFromAccessConfigurationResponse
9028
+ */
7988
9029
  async removePermissionPolicyFromAccessConfigurationWithOptions(request: RemovePermissionPolicyFromAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<RemovePermissionPolicyFromAccessConfigurationResponse> {
7989
9030
  Util.validateModel(request);
7990
9031
  let query = { };
@@ -8021,11 +9062,30 @@ export default class Client extends OpenApi {
8021
9062
  return $tea.cast<RemovePermissionPolicyFromAccessConfigurationResponse>(await this.callApi(params, req, runtime), new RemovePermissionPolicyFromAccessConfigurationResponse({}));
8022
9063
  }
8023
9064
 
9065
+ /**
9066
+ * After you remove an inline policy from an access configuration, the policy cannot be restored.
9067
+ * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
9068
+ * ## Limits
9069
+ * 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.
9070
+ *
9071
+ * @param request RemovePermissionPolicyFromAccessConfigurationRequest
9072
+ * @return RemovePermissionPolicyFromAccessConfigurationResponse
9073
+ */
8024
9074
  async removePermissionPolicyFromAccessConfiguration(request: RemovePermissionPolicyFromAccessConfigurationRequest): Promise<RemovePermissionPolicyFromAccessConfigurationResponse> {
8025
9075
  let runtime = new $Util.RuntimeOptions({ });
8026
9076
  return await this.removePermissionPolicyFromAccessConfigurationWithOptions(request, runtime);
8027
9077
  }
8028
9078
 
9079
+ /**
9080
+ * 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.
9081
+ * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
9082
+ * ## Limits
9083
+ * 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.
9084
+ *
9085
+ * @param request RemoveUserFromGroupRequest
9086
+ * @param runtime runtime options for this request RuntimeOptions
9087
+ * @return RemoveUserFromGroupResponse
9088
+ */
8029
9089
  async removeUserFromGroupWithOptions(request: RemoveUserFromGroupRequest, runtime: $Util.RuntimeOptions): Promise<RemoveUserFromGroupResponse> {
8030
9090
  Util.validateModel(request);
8031
9091
  let query = { };
@@ -8058,11 +9118,31 @@ export default class Client extends OpenApi {
8058
9118
  return $tea.cast<RemoveUserFromGroupResponse>(await this.callApi(params, req, runtime), new RemoveUserFromGroupResponse({}));
8059
9119
  }
8060
9120
 
9121
+ /**
9122
+ * 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.
9123
+ * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
9124
+ * ## Limits
9125
+ * 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.
9126
+ *
9127
+ * @param request RemoveUserFromGroupRequest
9128
+ * @return RemoveUserFromGroupResponse
9129
+ */
8061
9130
  async removeUserFromGroup(request: RemoveUserFromGroupRequest): Promise<RemoveUserFromGroupResponse> {
8062
9131
  let runtime = new $Util.RuntimeOptions({ });
8063
9132
  return await this.removeUserFromGroupWithOptions(request, runtime);
8064
9133
  }
8065
9134
 
9135
+ /**
9136
+ * If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
9137
+ * > After you enable SSO logon, your password cannot be reset.
9138
+ * 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.
9139
+ * ## Limits
9140
+ * 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.
9141
+ *
9142
+ * @param request ResetUserPasswordRequest
9143
+ * @param runtime runtime options for this request RuntimeOptions
9144
+ * @return ResetUserPasswordResponse
9145
+ */
8066
9146
  async resetUserPasswordWithOptions(request: ResetUserPasswordRequest, runtime: $Util.RuntimeOptions): Promise<ResetUserPasswordResponse> {
8067
9147
  Util.validateModel(request);
8068
9148
  let query = { };
@@ -8103,11 +9183,37 @@ export default class Client extends OpenApi {
8103
9183
  return $tea.cast<ResetUserPasswordResponse>(await this.callApi(params, req, runtime), new ResetUserPasswordResponse({}));
8104
9184
  }
8105
9185
 
9186
+ /**
9187
+ * If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
9188
+ * > After you enable SSO logon, your password cannot be reset.
9189
+ * 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.
9190
+ * ## Limits
9191
+ * 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.
9192
+ *
9193
+ * @param request ResetUserPasswordRequest
9194
+ * @return ResetUserPasswordResponse
9195
+ */
8106
9196
  async resetUserPassword(request: ResetUserPasswordRequest): Promise<ResetUserPasswordResponse> {
8107
9197
  let runtime = new $Util.RuntimeOptions({ });
8108
9198
  return await this.resetUserPasswordWithOptions(request, runtime);
8109
9199
  }
8110
9200
 
9201
+ /**
9202
+ * ## Usage notes
9203
+ * 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.
9204
+ * 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.
9205
+ * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
9206
+ * * Manually configure the IdP. You can manually specifythe following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
9207
+ * If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
9208
+ * * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
9209
+ * * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
9210
+ * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
9211
+ * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
9212
+ *
9213
+ * @param request SetExternalSAMLIdentityProviderRequest
9214
+ * @param runtime runtime options for this request RuntimeOptions
9215
+ * @return SetExternalSAMLIdentityProviderResponse
9216
+ */
8111
9217
  async setExternalSAMLIdentityProviderWithOptions(request: SetExternalSAMLIdentityProviderRequest, runtime: $Util.RuntimeOptions): Promise<SetExternalSAMLIdentityProviderResponse> {
8112
9218
  Util.validateModel(request);
8113
9219
  let query = { };
@@ -8156,11 +9262,36 @@ export default class Client extends OpenApi {
8156
9262
  return $tea.cast<SetExternalSAMLIdentityProviderResponse>(await this.callApi(params, req, runtime), new SetExternalSAMLIdentityProviderResponse({}));
8157
9263
  }
8158
9264
 
9265
+ /**
9266
+ * ## Usage notes
9267
+ * 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.
9268
+ * 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.
9269
+ * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
9270
+ * * Manually configure the IdP. You can manually specifythe following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
9271
+ * If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
9272
+ * * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
9273
+ * * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
9274
+ * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
9275
+ * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
9276
+ *
9277
+ * @param request SetExternalSAMLIdentityProviderRequest
9278
+ * @return SetExternalSAMLIdentityProviderResponse
9279
+ */
8159
9280
  async setExternalSAMLIdentityProvider(request: SetExternalSAMLIdentityProviderRequest): Promise<SetExternalSAMLIdentityProviderResponse> {
8160
9281
  let runtime = new $Util.RuntimeOptions({ });
8161
9282
  return await this.setExternalSAMLIdentityProviderWithOptions(request, runtime);
8162
9283
  }
8163
9284
 
9285
+ /**
9286
+ * 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.
9287
+ * This topic provides an example on how to enable MFA for users.
9288
+ * ## Limits
9289
+ * 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.
9290
+ *
9291
+ * @param request SetMFAAuthenticationStatusRequest
9292
+ * @param runtime runtime options for this request RuntimeOptions
9293
+ * @return SetMFAAuthenticationStatusResponse
9294
+ */
8164
9295
  async setMFAAuthenticationStatusWithOptions(request: SetMFAAuthenticationStatusRequest, runtime: $Util.RuntimeOptions): Promise<SetMFAAuthenticationStatusResponse> {
8165
9296
  Util.validateModel(request);
8166
9297
  let query = { };
@@ -8189,11 +9320,32 @@ export default class Client extends OpenApi {
8189
9320
  return $tea.cast<SetMFAAuthenticationStatusResponse>(await this.callApi(params, req, runtime), new SetMFAAuthenticationStatusResponse({}));
8190
9321
  }
8191
9322
 
9323
+ /**
9324
+ * 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.
9325
+ * This topic provides an example on how to enable MFA for users.
9326
+ * ## Limits
9327
+ * 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.
9328
+ *
9329
+ * @param request SetMFAAuthenticationStatusRequest
9330
+ * @return SetMFAAuthenticationStatusResponse
9331
+ */
8192
9332
  async setMFAAuthenticationStatus(request: SetMFAAuthenticationStatusRequest): Promise<SetMFAAuthenticationStatusResponse> {
8193
9333
  let runtime = new $Util.RuntimeOptions({ });
8194
9334
  return await this.setMFAAuthenticationStatusWithOptions(request, runtime);
8195
9335
  }
8196
9336
 
9337
+ /**
9338
+ * 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:
9339
+ * * 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.
9340
+ * * 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.
9341
+ * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
9342
+ * ## Limits
9343
+ * 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.
9344
+ *
9345
+ * @param request SetSCIMSynchronizationStatusRequest
9346
+ * @param runtime runtime options for this request RuntimeOptions
9347
+ * @return SetSCIMSynchronizationStatusResponse
9348
+ */
8197
9349
  async setSCIMSynchronizationStatusWithOptions(request: SetSCIMSynchronizationStatusRequest, runtime: $Util.RuntimeOptions): Promise<SetSCIMSynchronizationStatusResponse> {
8198
9350
  Util.validateModel(request);
8199
9351
  let query = { };
@@ -8222,11 +9374,32 @@ export default class Client extends OpenApi {
8222
9374
  return $tea.cast<SetSCIMSynchronizationStatusResponse>(await this.callApi(params, req, runtime), new SetSCIMSynchronizationStatusResponse({}));
8223
9375
  }
8224
9376
 
9377
+ /**
9378
+ * 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:
9379
+ * * 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.
9380
+ * * 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.
9381
+ * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
9382
+ * ## Limits
9383
+ * 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.
9384
+ *
9385
+ * @param request SetSCIMSynchronizationStatusRequest
9386
+ * @return SetSCIMSynchronizationStatusResponse
9387
+ */
8225
9388
  async setSCIMSynchronizationStatus(request: SetSCIMSynchronizationStatusRequest): Promise<SetSCIMSynchronizationStatusResponse> {
8226
9389
  let runtime = new $Util.RuntimeOptions({ });
8227
9390
  return await this.setSCIMSynchronizationStatusWithOptions(request, runtime);
8228
9391
  }
8229
9392
 
9393
+ /**
9394
+ * You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
9395
+ * 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`.
9396
+ * ## Limits
9397
+ * 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.
9398
+ *
9399
+ * @param request UpdateAccessConfigurationRequest
9400
+ * @param runtime runtime options for this request RuntimeOptions
9401
+ * @return UpdateAccessConfigurationResponse
9402
+ */
8230
9403
  async updateAccessConfigurationWithOptions(request: UpdateAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<UpdateAccessConfigurationResponse> {
8231
9404
  Util.validateModel(request);
8232
9405
  let query = { };
@@ -8267,11 +9440,30 @@ export default class Client extends OpenApi {
8267
9440
  return $tea.cast<UpdateAccessConfigurationResponse>(await this.callApi(params, req, runtime), new UpdateAccessConfigurationResponse({}));
8268
9441
  }
8269
9442
 
9443
+ /**
9444
+ * You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
9445
+ * 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`.
9446
+ * ## Limits
9447
+ * 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.
9448
+ *
9449
+ * @param request UpdateAccessConfigurationRequest
9450
+ * @return UpdateAccessConfigurationResponse
9451
+ */
8270
9452
  async updateAccessConfiguration(request: UpdateAccessConfigurationRequest): Promise<UpdateAccessConfigurationResponse> {
8271
9453
  let runtime = new $Util.RuntimeOptions({ });
8272
9454
  return await this.updateAccessConfigurationWithOptions(request, runtime);
8273
9455
  }
8274
9456
 
9457
+ /**
9458
+ * 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.
9459
+ * This topic provides an example on how to change the name of a directory to `new-example`.
9460
+ * ## Limits
9461
+ * 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.
9462
+ *
9463
+ * @param request UpdateDirectoryRequest
9464
+ * @param runtime runtime options for this request RuntimeOptions
9465
+ * @return UpdateDirectoryResponse
9466
+ */
8275
9467
  async updateDirectoryWithOptions(request: UpdateDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<UpdateDirectoryResponse> {
8276
9468
  Util.validateModel(request);
8277
9469
  let query = { };
@@ -8300,11 +9492,31 @@ export default class Client extends OpenApi {
8300
9492
  return $tea.cast<UpdateDirectoryResponse>(await this.callApi(params, req, runtime), new UpdateDirectoryResponse({}));
8301
9493
  }
8302
9494
 
9495
+ /**
9496
+ * 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.
9497
+ * This topic provides an example on how to change the name of a directory to `new-example`.
9498
+ * ## Limits
9499
+ * 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.
9500
+ *
9501
+ * @param request UpdateDirectoryRequest
9502
+ * @return UpdateDirectoryResponse
9503
+ */
8303
9504
  async updateDirectory(request: UpdateDirectoryRequest): Promise<UpdateDirectoryResponse> {
8304
9505
  let runtime = new $Util.RuntimeOptions({ });
8305
9506
  return await this.updateDirectoryWithOptions(request, runtime);
8306
9507
  }
8307
9508
 
9509
+ /**
9510
+ * You can modify `GroupName` and `Description` for a group.
9511
+ * > 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.
9512
+ * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
9513
+ * ## Limits
9514
+ * 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.
9515
+ *
9516
+ * @param request UpdateGroupRequest
9517
+ * @param runtime runtime options for this request RuntimeOptions
9518
+ * @return UpdateGroupResponse
9519
+ */
8308
9520
  async updateGroupWithOptions(request: UpdateGroupRequest, runtime: $Util.RuntimeOptions): Promise<UpdateGroupResponse> {
8309
9521
  Util.validateModel(request);
8310
9522
  let query = { };
@@ -8341,11 +9553,30 @@ export default class Client extends OpenApi {
8341
9553
  return $tea.cast<UpdateGroupResponse>(await this.callApi(params, req, runtime), new UpdateGroupResponse({}));
8342
9554
  }
8343
9555
 
9556
+ /**
9557
+ * You can modify `GroupName` and `Description` for a group.
9558
+ * > 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.
9559
+ * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
9560
+ * ## Limits
9561
+ * 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.
9562
+ *
9563
+ * @param request UpdateGroupRequest
9564
+ * @return UpdateGroupResponse
9565
+ */
8344
9566
  async updateGroup(request: UpdateGroupRequest): Promise<UpdateGroupResponse> {
8345
9567
  let runtime = new $Util.RuntimeOptions({ });
8346
9568
  return await this.updateGroupWithOptions(request, runtime);
8347
9569
  }
8348
9570
 
9571
+ /**
9572
+ * This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
9573
+ * ## Limits
9574
+ * 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.
9575
+ *
9576
+ * @param request UpdateInlinePolicyForAccessConfigurationRequest
9577
+ * @param runtime runtime options for this request RuntimeOptions
9578
+ * @return UpdateInlinePolicyForAccessConfigurationResponse
9579
+ */
8349
9580
  async updateInlinePolicyForAccessConfigurationWithOptions(request: UpdateInlinePolicyForAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<UpdateInlinePolicyForAccessConfigurationResponse> {
8350
9581
  Util.validateModel(request);
8351
9582
  let query = { };
@@ -8382,11 +9613,27 @@ export default class Client extends OpenApi {
8382
9613
  return $tea.cast<UpdateInlinePolicyForAccessConfigurationResponse>(await this.callApi(params, req, runtime), new UpdateInlinePolicyForAccessConfigurationResponse({}));
8383
9614
  }
8384
9615
 
9616
+ /**
9617
+ * This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
9618
+ * ## Limits
9619
+ * 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.
9620
+ *
9621
+ * @param request UpdateInlinePolicyForAccessConfigurationRequest
9622
+ * @return UpdateInlinePolicyForAccessConfigurationResponse
9623
+ */
8385
9624
  async updateInlinePolicyForAccessConfiguration(request: UpdateInlinePolicyForAccessConfigurationRequest): Promise<UpdateInlinePolicyForAccessConfigurationResponse> {
8386
9625
  let runtime = new $Util.RuntimeOptions({ });
8387
9626
  return await this.updateInlinePolicyForAccessConfigurationWithOptions(request, runtime);
8388
9627
  }
8389
9628
 
9629
+ /**
9630
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
9631
+ * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
9632
+ *
9633
+ * @param request UpdateMFAAuthenticationSettingsRequest
9634
+ * @param runtime runtime options for this request RuntimeOptions
9635
+ * @return UpdateMFAAuthenticationSettingsResponse
9636
+ */
8390
9637
  async updateMFAAuthenticationSettingsWithOptions(request: UpdateMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<UpdateMFAAuthenticationSettingsResponse> {
8391
9638
  Util.validateModel(request);
8392
9639
  let query = { };
@@ -8398,6 +9645,10 @@ export default class Client extends OpenApi {
8398
9645
  query["MFAAuthenticationSettings"] = request.MFAAuthenticationSettings;
8399
9646
  }
8400
9647
 
9648
+ if (!Util.isUnset(request.operationForRiskLogin)) {
9649
+ query["OperationForRiskLogin"] = request.operationForRiskLogin;
9650
+ }
9651
+
8401
9652
  let req = new $OpenApi.OpenApiRequest({
8402
9653
  query: OpenApiUtil.query(query),
8403
9654
  });
@@ -8415,11 +9666,27 @@ export default class Client extends OpenApi {
8415
9666
  return $tea.cast<UpdateMFAAuthenticationSettingsResponse>(await this.callApi(params, req, runtime), new UpdateMFAAuthenticationSettingsResponse({}));
8416
9667
  }
8417
9668
 
9669
+ /**
9670
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
9671
+ * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
9672
+ *
9673
+ * @param request UpdateMFAAuthenticationSettingsRequest
9674
+ * @return UpdateMFAAuthenticationSettingsResponse
9675
+ */
8418
9676
  async updateMFAAuthenticationSettings(request: UpdateMFAAuthenticationSettingsRequest): Promise<UpdateMFAAuthenticationSettingsResponse> {
8419
9677
  let runtime = new $Util.RuntimeOptions({ });
8420
9678
  return await this.updateMFAAuthenticationSettingsWithOptions(request, runtime);
8421
9679
  }
8422
9680
 
9681
+ /**
9682
+ * 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.
9683
+ * ## Limits
9684
+ * 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.
9685
+ *
9686
+ * @param request UpdateSCIMServerCredentialStatusRequest
9687
+ * @param runtime runtime options for this request RuntimeOptions
9688
+ * @return UpdateSCIMServerCredentialStatusResponse
9689
+ */
8423
9690
  async updateSCIMServerCredentialStatusWithOptions(request: UpdateSCIMServerCredentialStatusRequest, runtime: $Util.RuntimeOptions): Promise<UpdateSCIMServerCredentialStatusResponse> {
8424
9691
  Util.validateModel(request);
8425
9692
  let query = { };
@@ -8452,11 +9719,30 @@ export default class Client extends OpenApi {
8452
9719
  return $tea.cast<UpdateSCIMServerCredentialStatusResponse>(await this.callApi(params, req, runtime), new UpdateSCIMServerCredentialStatusResponse({}));
8453
9720
  }
8454
9721
 
9722
+ /**
9723
+ * 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.
9724
+ * ## Limits
9725
+ * 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.
9726
+ *
9727
+ * @param request UpdateSCIMServerCredentialStatusRequest
9728
+ * @return UpdateSCIMServerCredentialStatusResponse
9729
+ */
8455
9730
  async updateSCIMServerCredentialStatus(request: UpdateSCIMServerCredentialStatusRequest): Promise<UpdateSCIMServerCredentialStatusResponse> {
8456
9731
  let runtime = new $Util.RuntimeOptions({ });
8457
9732
  return await this.updateSCIMServerCredentialStatusWithOptions(request, runtime);
8458
9733
  }
8459
9734
 
9735
+ /**
9736
+ * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
9737
+ * > 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.
9738
+ * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
9739
+ * ## Limits
9740
+ * 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.
9741
+ *
9742
+ * @param request UpdateUserRequest
9743
+ * @param runtime runtime options for this request RuntimeOptions
9744
+ * @return UpdateUserResponse
9745
+ */
8460
9746
  async updateUserWithOptions(request: UpdateUserRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserResponse> {
8461
9747
  Util.validateModel(request);
8462
9748
  let query = { };
@@ -8505,11 +9791,30 @@ export default class Client extends OpenApi {
8505
9791
  return $tea.cast<UpdateUserResponse>(await this.callApi(params, req, runtime), new UpdateUserResponse({}));
8506
9792
  }
8507
9793
 
9794
+ /**
9795
+ * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
9796
+ * > 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.
9797
+ * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
9798
+ * ## Limits
9799
+ * 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.
9800
+ *
9801
+ * @param request UpdateUserRequest
9802
+ * @return UpdateUserResponse
9803
+ */
8508
9804
  async updateUser(request: UpdateUserRequest): Promise<UpdateUserResponse> {
8509
9805
  let runtime = new $Util.RuntimeOptions({ });
8510
9806
  return await this.updateUserWithOptions(request, runtime);
8511
9807
  }
8512
9808
 
9809
+ /**
9810
+ * 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.
9811
+ * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
9812
+ * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
9813
+ *
9814
+ * @param request UpdateUserMFAAuthenticationSettingsRequest
9815
+ * @param runtime runtime options for this request RuntimeOptions
9816
+ * @return UpdateUserMFAAuthenticationSettingsResponse
9817
+ */
8513
9818
  async updateUserMFAAuthenticationSettingsWithOptions(request: UpdateUserMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserMFAAuthenticationSettingsResponse> {
8514
9819
  Util.validateModel(request);
8515
9820
  let query = { };
@@ -8542,11 +9847,28 @@ export default class Client extends OpenApi {
8542
9847
  return $tea.cast<UpdateUserMFAAuthenticationSettingsResponse>(await this.callApi(params, req, runtime), new UpdateUserMFAAuthenticationSettingsResponse({}));
8543
9848
  }
8544
9849
 
9850
+ /**
9851
+ * 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.
9852
+ * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
9853
+ * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
9854
+ *
9855
+ * @param request UpdateUserMFAAuthenticationSettingsRequest
9856
+ * @return UpdateUserMFAAuthenticationSettingsResponse
9857
+ */
8545
9858
  async updateUserMFAAuthenticationSettings(request: UpdateUserMFAAuthenticationSettingsRequest): Promise<UpdateUserMFAAuthenticationSettingsResponse> {
8546
9859
  let runtime = new $Util.RuntimeOptions({ });
8547
9860
  return await this.updateUserMFAAuthenticationSettingsWithOptions(request, runtime);
8548
9861
  }
8549
9862
 
9863
+ /**
9864
+ * 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.
9865
+ * ## Limits
9866
+ * 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.
9867
+ *
9868
+ * @param request UpdateUserStatusRequest
9869
+ * @param runtime runtime options for this request RuntimeOptions
9870
+ * @return UpdateUserStatusResponse
9871
+ */
8550
9872
  async updateUserStatusWithOptions(request: UpdateUserStatusRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserStatusResponse> {
8551
9873
  Util.validateModel(request);
8552
9874
  let query = { };
@@ -8579,6 +9901,14 @@ export default class Client extends OpenApi {
8579
9901
  return $tea.cast<UpdateUserStatusResponse>(await this.callApi(params, req, runtime), new UpdateUserStatusResponse({}));
8580
9902
  }
8581
9903
 
9904
+ /**
9905
+ * 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.
9906
+ * ## Limits
9907
+ * 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.
9908
+ *
9909
+ * @param request UpdateUserStatusRequest
9910
+ * @return UpdateUserStatusResponse
9911
+ */
8582
9912
  async updateUserStatus(request: UpdateUserStatusRequest): Promise<UpdateUserStatusResponse> {
8583
9913
  let runtime = new $Util.RuntimeOptions({ });
8584
9914
  return await this.updateUserStatusWithOptions(request, runtime);