@alicloud/cloudsso20210515 1.0.2 → 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/dist/client.js CHANGED
@@ -1455,6 +1455,60 @@ class GetGroupResponse extends $tea.Model {
1455
1455
  }
1456
1456
  }
1457
1457
  exports.GetGroupResponse = GetGroupResponse;
1458
+ class GetMFAAuthenticationSettingInfoRequest extends $tea.Model {
1459
+ constructor(map) {
1460
+ super(map);
1461
+ }
1462
+ static names() {
1463
+ return {
1464
+ directoryId: 'DirectoryId',
1465
+ };
1466
+ }
1467
+ static types() {
1468
+ return {
1469
+ directoryId: 'string',
1470
+ };
1471
+ }
1472
+ }
1473
+ exports.GetMFAAuthenticationSettingInfoRequest = GetMFAAuthenticationSettingInfoRequest;
1474
+ class GetMFAAuthenticationSettingInfoResponseBody extends $tea.Model {
1475
+ constructor(map) {
1476
+ super(map);
1477
+ }
1478
+ static names() {
1479
+ return {
1480
+ MFAAuthenticationSettingInfo: 'MFAAuthenticationSettingInfo',
1481
+ requestId: 'RequestId',
1482
+ };
1483
+ }
1484
+ static types() {
1485
+ return {
1486
+ MFAAuthenticationSettingInfo: GetMFAAuthenticationSettingInfoResponseBodyMFAAuthenticationSettingInfo,
1487
+ requestId: 'string',
1488
+ };
1489
+ }
1490
+ }
1491
+ exports.GetMFAAuthenticationSettingInfoResponseBody = GetMFAAuthenticationSettingInfoResponseBody;
1492
+ class GetMFAAuthenticationSettingInfoResponse extends $tea.Model {
1493
+ constructor(map) {
1494
+ super(map);
1495
+ }
1496
+ static names() {
1497
+ return {
1498
+ headers: 'headers',
1499
+ statusCode: 'statusCode',
1500
+ body: 'body',
1501
+ };
1502
+ }
1503
+ static types() {
1504
+ return {
1505
+ headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
1506
+ statusCode: 'number',
1507
+ body: GetMFAAuthenticationSettingInfoResponseBody,
1508
+ };
1509
+ }
1510
+ }
1511
+ exports.GetMFAAuthenticationSettingInfoResponse = GetMFAAuthenticationSettingInfoResponse;
1458
1512
  class GetMFAAuthenticationSettingsRequest extends $tea.Model {
1459
1513
  constructor(map) {
1460
1514
  super(map);
@@ -4073,6 +4127,7 @@ class GetDirectoryStatisticsResponseBodyDirectoryStatistics extends $tea.Model {
4073
4127
  SCIMServerCredentialCount: 'SCIMServerCredentialCount',
4074
4128
  SCIMSyncEnabled: 'SCIMSyncEnabled',
4075
4129
  SSOEnabled: 'SSOEnabled',
4130
+ systemPolicyPerAccessConfigurationQuota: 'SystemPolicyPerAccessConfigurationQuota',
4076
4131
  userCount: 'UserCount',
4077
4132
  userQuota: 'UserQuota',
4078
4133
  };
@@ -4091,6 +4146,7 @@ class GetDirectoryStatisticsResponseBodyDirectoryStatistics extends $tea.Model {
4091
4146
  SCIMServerCredentialCount: 'number',
4092
4147
  SCIMSyncEnabled: 'boolean',
4093
4148
  SSOEnabled: 'boolean',
4149
+ systemPolicyPerAccessConfigurationQuota: 'number',
4094
4150
  userCount: 'number',
4095
4151
  userQuota: 'number',
4096
4152
  };
@@ -4155,6 +4211,24 @@ class GetGroupResponseBodyGroup extends $tea.Model {
4155
4211
  }
4156
4212
  }
4157
4213
  exports.GetGroupResponseBodyGroup = GetGroupResponseBodyGroup;
4214
+ class GetMFAAuthenticationSettingInfoResponseBodyMFAAuthenticationSettingInfo extends $tea.Model {
4215
+ constructor(map) {
4216
+ super(map);
4217
+ }
4218
+ static names() {
4219
+ return {
4220
+ mfaAuthenticationAdvanceSettings: 'MfaAuthenticationAdvanceSettings',
4221
+ operationForRiskLogin: 'OperationForRiskLogin',
4222
+ };
4223
+ }
4224
+ static types() {
4225
+ return {
4226
+ mfaAuthenticationAdvanceSettings: 'string',
4227
+ operationForRiskLogin: 'string',
4228
+ };
4229
+ }
4230
+ }
4231
+ exports.GetMFAAuthenticationSettingInfoResponseBodyMFAAuthenticationSettingInfo = GetMFAAuthenticationSettingInfoResponseBodyMFAAuthenticationSettingInfo;
4158
4232
  class GetServiceStatusResponseBodyServiceStatus extends $tea.Model {
4159
4233
  constructor(map) {
4160
4234
  super(map);
@@ -4911,6 +4985,16 @@ class Client extends openapi_client_1.default {
4911
4985
  }
4912
4986
  return endpoint_util_1.default.getEndpointRules(productId, regionId, endpointRule, network, suffix);
4913
4987
  }
4988
+ /**
4989
+ * You can add up to two SAML signing certificates.
4990
+ * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
4991
+ * ## Limits
4992
+ * 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.
4993
+ *
4994
+ * @param request AddExternalSAMLIdPCertificateRequest
4995
+ * @param runtime runtime options for this request RuntimeOptions
4996
+ * @return AddExternalSAMLIdPCertificateResponse
4997
+ */
4914
4998
  async addExternalSAMLIdPCertificateWithOptions(request, runtime) {
4915
4999
  tea_util_1.default.validateModel(request);
4916
5000
  let query = {};
@@ -4936,10 +5020,28 @@ class Client extends openapi_client_1.default {
4936
5020
  });
4937
5021
  return $tea.cast(await this.callApi(params, req, runtime), new AddExternalSAMLIdPCertificateResponse({}));
4938
5022
  }
5023
+ /**
5024
+ * You can add up to two SAML signing certificates.
5025
+ * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
5026
+ * ## Limits
5027
+ * 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.
5028
+ *
5029
+ * @param request AddExternalSAMLIdPCertificateRequest
5030
+ * @return AddExternalSAMLIdPCertificateResponse
5031
+ */
4939
5032
  async addExternalSAMLIdPCertificate(request) {
4940
5033
  let runtime = new $Util.RuntimeOptions({});
4941
5034
  return await this.addExternalSAMLIdPCertificateWithOptions(request, runtime);
4942
5035
  }
5036
+ /**
5037
+ * This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
5038
+ * ## Limits
5039
+ * 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.
5040
+ *
5041
+ * @param request AddPermissionPolicyToAccessConfigurationRequest
5042
+ * @param runtime runtime options for this request RuntimeOptions
5043
+ * @return AddPermissionPolicyToAccessConfigurationResponse
5044
+ */
4943
5045
  async addPermissionPolicyToAccessConfigurationWithOptions(request, runtime) {
4944
5046
  tea_util_1.default.validateModel(request);
4945
5047
  let query = {};
@@ -4974,10 +5076,28 @@ class Client extends openapi_client_1.default {
4974
5076
  });
4975
5077
  return $tea.cast(await this.callApi(params, req, runtime), new AddPermissionPolicyToAccessConfigurationResponse({}));
4976
5078
  }
5079
+ /**
5080
+ * This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
5081
+ * ## Limits
5082
+ * 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.
5083
+ *
5084
+ * @param request AddPermissionPolicyToAccessConfigurationRequest
5085
+ * @return AddPermissionPolicyToAccessConfigurationResponse
5086
+ */
4977
5087
  async addPermissionPolicyToAccessConfiguration(request) {
4978
5088
  let runtime = new $Util.RuntimeOptions({});
4979
5089
  return await this.addPermissionPolicyToAccessConfigurationWithOptions(request, runtime);
4980
5090
  }
5091
+ /**
5092
+ * 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.
5093
+ * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
5094
+ * ## Limits
5095
+ * 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.
5096
+ *
5097
+ * @param request AddUserToGroupRequest
5098
+ * @param runtime runtime options for this request RuntimeOptions
5099
+ * @return AddUserToGroupResponse
5100
+ */
4981
5101
  async addUserToGroupWithOptions(request, runtime) {
4982
5102
  tea_util_1.default.validateModel(request);
4983
5103
  let query = {};
@@ -5006,10 +5126,29 @@ class Client extends openapi_client_1.default {
5006
5126
  });
5007
5127
  return $tea.cast(await this.callApi(params, req, runtime), new AddUserToGroupResponse({}));
5008
5128
  }
5129
+ /**
5130
+ * 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.
5131
+ * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
5132
+ * ## Limits
5133
+ * 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.
5134
+ *
5135
+ * @param request AddUserToGroupRequest
5136
+ * @return AddUserToGroupResponse
5137
+ */
5009
5138
  async addUserToGroup(request) {
5010
5139
  let runtime = new $Util.RuntimeOptions({});
5011
5140
  return await this.addUserToGroupWithOptions(request, runtime);
5012
5141
  }
5142
+ /**
5143
+ * 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.
5144
+ * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
5145
+ * ## Limits
5146
+ * 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.
5147
+ *
5148
+ * @param request ClearExternalSAMLIdentityProviderRequest
5149
+ * @param runtime runtime options for this request RuntimeOptions
5150
+ * @return ClearExternalSAMLIdentityProviderResponse
5151
+ */
5013
5152
  async clearExternalSAMLIdentityProviderWithOptions(request, runtime) {
5014
5153
  tea_util_1.default.validateModel(request);
5015
5154
  let query = {};
@@ -5032,10 +5171,30 @@ class Client extends openapi_client_1.default {
5032
5171
  });
5033
5172
  return $tea.cast(await this.callApi(params, req, runtime), new ClearExternalSAMLIdentityProviderResponse({}));
5034
5173
  }
5174
+ /**
5175
+ * 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.
5176
+ * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
5177
+ * ## Limits
5178
+ * 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.
5179
+ *
5180
+ * @param request ClearExternalSAMLIdentityProviderRequest
5181
+ * @return ClearExternalSAMLIdentityProviderResponse
5182
+ */
5035
5183
  async clearExternalSAMLIdentityProvider(request) {
5036
5184
  let runtime = new $Util.RuntimeOptions({});
5037
5185
  return await this.clearExternalSAMLIdentityProviderWithOptions(request, runtime);
5038
5186
  }
5187
+ /**
5188
+ * 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.
5189
+ * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](~~266726~~).
5190
+ * 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.
5191
+ * ## Limits
5192
+ * 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.
5193
+ *
5194
+ * @param request CreateAccessAssignmentRequest
5195
+ * @param runtime runtime options for this request RuntimeOptions
5196
+ * @return CreateAccessAssignmentResponse
5197
+ */
5039
5198
  async createAccessAssignmentWithOptions(request, runtime) {
5040
5199
  tea_util_1.default.validateModel(request);
5041
5200
  let query = {};
@@ -5073,10 +5232,30 @@ class Client extends openapi_client_1.default {
5073
5232
  });
5074
5233
  return $tea.cast(await this.callApi(params, req, runtime), new CreateAccessAssignmentResponse({}));
5075
5234
  }
5235
+ /**
5236
+ * 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.
5237
+ * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](~~266726~~).
5238
+ * 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.
5239
+ * ## Limits
5240
+ * 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.
5241
+ *
5242
+ * @param request CreateAccessAssignmentRequest
5243
+ * @return CreateAccessAssignmentResponse
5244
+ */
5076
5245
  async createAccessAssignment(request) {
5077
5246
  let runtime = new $Util.RuntimeOptions({});
5078
5247
  return await this.createAccessAssignmentWithOptions(request, runtime);
5079
5248
  }
5249
+ /**
5250
+ * For more information about access configurations, see [Overview of access configurations](~~266737~~).
5251
+ * This topic provides an example on how to create an access configuration named `ECS-Admin`.
5252
+ * ## Limits
5253
+ * 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.
5254
+ *
5255
+ * @param request CreateAccessConfigurationRequest
5256
+ * @param runtime runtime options for this request RuntimeOptions
5257
+ * @return CreateAccessConfigurationResponse
5258
+ */
5080
5259
  async createAccessConfigurationWithOptions(request, runtime) {
5081
5260
  tea_util_1.default.validateModel(request);
5082
5261
  let query = {};
@@ -5111,10 +5290,33 @@ class Client extends openapi_client_1.default {
5111
5290
  });
5112
5291
  return $tea.cast(await this.callApi(params, req, runtime), new CreateAccessConfigurationResponse({}));
5113
5292
  }
5293
+ /**
5294
+ * For more information about access configurations, see [Overview of access configurations](~~266737~~).
5295
+ * This topic provides an example on how to create an access configuration named `ECS-Admin`.
5296
+ * ## Limits
5297
+ * 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.
5298
+ *
5299
+ * @param request CreateAccessConfigurationRequest
5300
+ * @return CreateAccessConfigurationResponse
5301
+ */
5114
5302
  async createAccessConfiguration(request) {
5115
5303
  let runtime = new $Util.RuntimeOptions({});
5116
5304
  return await this.createAccessConfigurationWithOptions(request, runtime);
5117
5305
  }
5306
+ /**
5307
+ * 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.
5308
+ * 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.
5309
+ * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
5310
+ * ## Limits
5311
+ * - You can create only one directory for a management account.
5312
+ * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
5313
+ * ## Limits
5314
+ * 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.
5315
+ *
5316
+ * @param request CreateDirectoryRequest
5317
+ * @param runtime runtime options for this request RuntimeOptions
5318
+ * @return CreateDirectoryResponse
5319
+ */
5118
5320
  async createDirectoryWithOptions(request, runtime) {
5119
5321
  tea_util_1.default.validateModel(request);
5120
5322
  let query = {};
@@ -5137,10 +5339,32 @@ class Client extends openapi_client_1.default {
5137
5339
  });
5138
5340
  return $tea.cast(await this.callApi(params, req, runtime), new CreateDirectoryResponse({}));
5139
5341
  }
5342
+ /**
5343
+ * 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.
5344
+ * 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.
5345
+ * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
5346
+ * ## Limits
5347
+ * - You can create only one directory for a management account.
5348
+ * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
5349
+ * ## Limits
5350
+ * 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.
5351
+ *
5352
+ * @param request CreateDirectoryRequest
5353
+ * @return CreateDirectoryResponse
5354
+ */
5140
5355
  async createDirectory(request) {
5141
5356
  let runtime = new $Util.RuntimeOptions({});
5142
5357
  return await this.createDirectoryWithOptions(request, runtime);
5143
5358
  }
5359
+ /**
5360
+ * This topic provides an example on how to create a group named `TestGroup`.
5361
+ * ## Limits
5362
+ * 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.
5363
+ *
5364
+ * @param request CreateGroupRequest
5365
+ * @param runtime runtime options for this request RuntimeOptions
5366
+ * @return CreateGroupResponse
5367
+ */
5144
5368
  async createGroupWithOptions(request, runtime) {
5145
5369
  tea_util_1.default.validateModel(request);
5146
5370
  let query = {};
@@ -5169,10 +5393,28 @@ class Client extends openapi_client_1.default {
5169
5393
  });
5170
5394
  return $tea.cast(await this.callApi(params, req, runtime), new CreateGroupResponse({}));
5171
5395
  }
5396
+ /**
5397
+ * This topic provides an example on how to create a group named `TestGroup`.
5398
+ * ## Limits
5399
+ * 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.
5400
+ *
5401
+ * @param request CreateGroupRequest
5402
+ * @return CreateGroupResponse
5403
+ */
5172
5404
  async createGroup(request) {
5173
5405
  let runtime = new $Util.RuntimeOptions({});
5174
5406
  return await this.createGroupWithOptions(request, runtime);
5175
5407
  }
5408
+ /**
5409
+ * SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
5410
+ * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
5411
+ * ## Limits
5412
+ * 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.
5413
+ *
5414
+ * @param request CreateSCIMServerCredentialRequest
5415
+ * @param runtime runtime options for this request RuntimeOptions
5416
+ * @return CreateSCIMServerCredentialResponse
5417
+ */
5176
5418
  async createSCIMServerCredentialWithOptions(request, runtime) {
5177
5419
  tea_util_1.default.validateModel(request);
5178
5420
  let query = {};
@@ -5195,10 +5437,28 @@ class Client extends openapi_client_1.default {
5195
5437
  });
5196
5438
  return $tea.cast(await this.callApi(params, req, runtime), new CreateSCIMServerCredentialResponse({}));
5197
5439
  }
5440
+ /**
5441
+ * SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
5442
+ * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
5443
+ * ## Limits
5444
+ * 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.
5445
+ *
5446
+ * @param request CreateSCIMServerCredentialRequest
5447
+ * @return CreateSCIMServerCredentialResponse
5448
+ */
5198
5449
  async createSCIMServerCredential(request) {
5199
5450
  let runtime = new $Util.RuntimeOptions({});
5200
5451
  return await this.createSCIMServerCredentialWithOptions(request, runtime);
5201
5452
  }
5453
+ /**
5454
+ * This topic provides an example on how to create a user named `Alice`.
5455
+ * ## Limits
5456
+ * 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.
5457
+ *
5458
+ * @param request CreateUserRequest
5459
+ * @param runtime runtime options for this request RuntimeOptions
5460
+ * @return CreateUserResponse
5461
+ */
5202
5462
  async createUserWithOptions(request, runtime) {
5203
5463
  tea_util_1.default.validateModel(request);
5204
5464
  let query = {};
@@ -5242,10 +5502,28 @@ class Client extends openapi_client_1.default {
5242
5502
  });
5243
5503
  return $tea.cast(await this.callApi(params, req, runtime), new CreateUserResponse({}));
5244
5504
  }
5505
+ /**
5506
+ * This topic provides an example on how to create a user named `Alice`.
5507
+ * ## Limits
5508
+ * 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.
5509
+ *
5510
+ * @param request CreateUserRequest
5511
+ * @return CreateUserResponse
5512
+ */
5245
5513
  async createUser(request) {
5246
5514
  let runtime = new $Util.RuntimeOptions({});
5247
5515
  return await this.createUserWithOptions(request, runtime);
5248
5516
  }
5517
+ /**
5518
+ * 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.
5519
+ * 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****`.
5520
+ * ## Limits
5521
+ * 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.
5522
+ *
5523
+ * @param request DeleteAccessAssignmentRequest
5524
+ * @param runtime runtime options for this request RuntimeOptions
5525
+ * @return DeleteAccessAssignmentResponse
5526
+ */
5249
5527
  async deleteAccessAssignmentWithOptions(request, runtime) {
5250
5528
  tea_util_1.default.validateModel(request);
5251
5529
  let query = {};
@@ -5286,10 +5564,30 @@ class Client extends openapi_client_1.default {
5286
5564
  });
5287
5565
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteAccessAssignmentResponse({}));
5288
5566
  }
5567
+ /**
5568
+ * 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.
5569
+ * 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****`.
5570
+ * ## Limits
5571
+ * 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.
5572
+ *
5573
+ * @param request DeleteAccessAssignmentRequest
5574
+ * @return DeleteAccessAssignmentResponse
5575
+ */
5289
5576
  async deleteAccessAssignment(request) {
5290
5577
  let runtime = new $Util.RuntimeOptions({});
5291
5578
  return await this.deleteAccessAssignmentWithOptions(request, runtime);
5292
5579
  }
5580
+ /**
5581
+ * This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
5582
+ * ## Prerequisites
5583
+ * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](~~338352~~).
5584
+ * ## Limits
5585
+ * 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.
5586
+ *
5587
+ * @param request DeleteAccessConfigurationRequest
5588
+ * @param runtime runtime options for this request RuntimeOptions
5589
+ * @return DeleteAccessConfigurationResponse
5590
+ */
5293
5591
  async deleteAccessConfigurationWithOptions(request, runtime) {
5294
5592
  tea_util_1.default.validateModel(request);
5295
5593
  let query = {};
@@ -5318,10 +5616,37 @@ class Client extends openapi_client_1.default {
5318
5616
  });
5319
5617
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteAccessConfigurationResponse({}));
5320
5618
  }
5619
+ /**
5620
+ * This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
5621
+ * ## Prerequisites
5622
+ * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](~~338352~~).
5623
+ * ## Limits
5624
+ * 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.
5625
+ *
5626
+ * @param request DeleteAccessConfigurationRequest
5627
+ * @return DeleteAccessConfigurationResponse
5628
+ */
5321
5629
  async deleteAccessConfiguration(request) {
5322
5630
  let runtime = new $Util.RuntimeOptions({});
5323
5631
  return await this.deleteAccessConfigurationWithOptions(request, runtime);
5324
5632
  }
5633
+ /**
5634
+ * This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
5635
+ * ## Prerequisites
5636
+ * No resources are contained in the directory that you want to delete.
5637
+ * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](~~338350~~).
5638
+ * * Users are deleted. For more information, see [DeleteUser](~~341671~~).
5639
+ * * Groups are deleted. For more information, see [DeleteGroup](~~341821~~).
5640
+ * * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](~~336907~~).
5641
+ * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](~~341842~~).
5642
+ * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](~~341573~~).
5643
+ * ## Limits
5644
+ * 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.
5645
+ *
5646
+ * @param request DeleteDirectoryRequest
5647
+ * @param runtime runtime options for this request RuntimeOptions
5648
+ * @return DeleteDirectoryResponse
5649
+ */
5325
5650
  async deleteDirectoryWithOptions(request, runtime) {
5326
5651
  tea_util_1.default.validateModel(request);
5327
5652
  let query = {};
@@ -5344,10 +5669,39 @@ class Client extends openapi_client_1.default {
5344
5669
  });
5345
5670
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteDirectoryResponse({}));
5346
5671
  }
5672
+ /**
5673
+ * This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
5674
+ * ## Prerequisites
5675
+ * No resources are contained in the directory that you want to delete.
5676
+ * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](~~338350~~).
5677
+ * * Users are deleted. For more information, see [DeleteUser](~~341671~~).
5678
+ * * Groups are deleted. For more information, see [DeleteGroup](~~341821~~).
5679
+ * * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](~~336907~~).
5680
+ * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](~~341842~~).
5681
+ * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](~~341573~~).
5682
+ * ## Limits
5683
+ * 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.
5684
+ *
5685
+ * @param request DeleteDirectoryRequest
5686
+ * @return DeleteDirectoryResponse
5687
+ */
5347
5688
  async deleteDirectory(request) {
5348
5689
  let runtime = new $Util.RuntimeOptions({});
5349
5690
  return await this.deleteDirectoryWithOptions(request, runtime);
5350
5691
  }
5692
+ /**
5693
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
5694
+ * ## Prerequisites
5695
+ * 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.
5696
+ * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](~~335116~~).
5697
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](~~338350~~).
5698
+ * ## Limits
5699
+ * 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.
5700
+ *
5701
+ * @param request DeleteGroupRequest
5702
+ * @param runtime runtime options for this request RuntimeOptions
5703
+ * @return DeleteGroupResponse
5704
+ */
5351
5705
  async deleteGroupWithOptions(request, runtime) {
5352
5706
  tea_util_1.default.validateModel(request);
5353
5707
  let query = {};
@@ -5373,10 +5727,31 @@ class Client extends openapi_client_1.default {
5373
5727
  });
5374
5728
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteGroupResponse({}));
5375
5729
  }
5730
+ /**
5731
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
5732
+ * ## Prerequisites
5733
+ * 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.
5734
+ * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](~~335116~~).
5735
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](~~338350~~).
5736
+ * ## Limits
5737
+ * 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.
5738
+ *
5739
+ * @param request DeleteGroupRequest
5740
+ * @return DeleteGroupResponse
5741
+ */
5376
5742
  async deleteGroup(request) {
5377
5743
  let runtime = new $Util.RuntimeOptions({});
5378
5744
  return await this.deleteGroupWithOptions(request, runtime);
5379
5745
  }
5746
+ /**
5747
+ * This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
5748
+ * ## Limits
5749
+ * 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.
5750
+ *
5751
+ * @param request DeleteMFADeviceForUserRequest
5752
+ * @param runtime runtime options for this request RuntimeOptions
5753
+ * @return DeleteMFADeviceForUserResponse
5754
+ */
5380
5755
  async deleteMFADeviceForUserWithOptions(request, runtime) {
5381
5756
  tea_util_1.default.validateModel(request);
5382
5757
  let query = {};
@@ -5405,10 +5780,28 @@ class Client extends openapi_client_1.default {
5405
5780
  });
5406
5781
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteMFADeviceForUserResponse({}));
5407
5782
  }
5783
+ /**
5784
+ * This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
5785
+ * ## Limits
5786
+ * 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.
5787
+ *
5788
+ * @param request DeleteMFADeviceForUserRequest
5789
+ * @return DeleteMFADeviceForUserResponse
5790
+ */
5408
5791
  async deleteMFADeviceForUser(request) {
5409
5792
  let runtime = new $Util.RuntimeOptions({});
5410
5793
  return await this.deleteMFADeviceForUserWithOptions(request, runtime);
5411
5794
  }
5795
+ /**
5796
+ * After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
5797
+ * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
5798
+ * ## Limits
5799
+ * 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.
5800
+ *
5801
+ * @param request DeleteSCIMServerCredentialRequest
5802
+ * @param runtime runtime options for this request RuntimeOptions
5803
+ * @return DeleteSCIMServerCredentialResponse
5804
+ */
5412
5805
  async deleteSCIMServerCredentialWithOptions(request, runtime) {
5413
5806
  tea_util_1.default.validateModel(request);
5414
5807
  let query = {};
@@ -5434,10 +5827,33 @@ class Client extends openapi_client_1.default {
5434
5827
  });
5435
5828
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteSCIMServerCredentialResponse({}));
5436
5829
  }
5830
+ /**
5831
+ * After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
5832
+ * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
5833
+ * ## Limits
5834
+ * 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.
5835
+ *
5836
+ * @param request DeleteSCIMServerCredentialRequest
5837
+ * @return DeleteSCIMServerCredentialResponse
5838
+ */
5437
5839
  async deleteSCIMServerCredential(request) {
5438
5840
  let runtime = new $Util.RuntimeOptions({});
5439
5841
  return await this.deleteSCIMServerCredentialWithOptions(request, runtime);
5440
5842
  }
5843
+ /**
5844
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
5845
+ * ## Prerequisites
5846
+ * 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.
5847
+ * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](~~341675~~).
5848
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](~~338350~~).
5849
+ * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](~~335116~~).
5850
+ * ## Limits
5851
+ * 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.
5852
+ *
5853
+ * @param request DeleteUserRequest
5854
+ * @param runtime runtime options for this request RuntimeOptions
5855
+ * @return DeleteUserResponse
5856
+ */
5441
5857
  async deleteUserWithOptions(request, runtime) {
5442
5858
  tea_util_1.default.validateModel(request);
5443
5859
  let query = {};
@@ -5463,10 +5879,33 @@ class Client extends openapi_client_1.default {
5463
5879
  });
5464
5880
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteUserResponse({}));
5465
5881
  }
5882
+ /**
5883
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
5884
+ * ## Prerequisites
5885
+ * 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.
5886
+ * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](~~341675~~).
5887
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](~~338350~~).
5888
+ * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](~~335116~~).
5889
+ * ## Limits
5890
+ * 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.
5891
+ *
5892
+ * @param request DeleteUserRequest
5893
+ * @return DeleteUserResponse
5894
+ */
5466
5895
  async deleteUser(request) {
5467
5896
  let runtime = new $Util.RuntimeOptions({});
5468
5897
  return await this.deleteUserWithOptions(request, runtime);
5469
5898
  }
5899
+ /**
5900
+ * 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.
5901
+ * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
5902
+ * ## Limits
5903
+ * 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.
5904
+ *
5905
+ * @param request DeprovisionAccessConfigurationRequest
5906
+ * @param runtime runtime options for this request RuntimeOptions
5907
+ * @return DeprovisionAccessConfigurationResponse
5908
+ */
5470
5909
  async deprovisionAccessConfigurationWithOptions(request, runtime) {
5471
5910
  tea_util_1.default.validateModel(request);
5472
5911
  let query = {};
@@ -5498,10 +5937,28 @@ class Client extends openapi_client_1.default {
5498
5937
  });
5499
5938
  return $tea.cast(await this.callApi(params, req, runtime), new DeprovisionAccessConfigurationResponse({}));
5500
5939
  }
5940
+ /**
5941
+ * 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.
5942
+ * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
5943
+ * ## Limits
5944
+ * 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.
5945
+ *
5946
+ * @param request DeprovisionAccessConfigurationRequest
5947
+ * @return DeprovisionAccessConfigurationResponse
5948
+ */
5501
5949
  async deprovisionAccessConfiguration(request) {
5502
5950
  let runtime = new $Util.RuntimeOptions({});
5503
5951
  return await this.deprovisionAccessConfigurationWithOptions(request, runtime);
5504
5952
  }
5953
+ /**
5954
+ * 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.
5955
+ * ## Limits
5956
+ * 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.
5957
+ *
5958
+ * @param request DisableServiceRequest
5959
+ * @param runtime runtime options for this request RuntimeOptions
5960
+ * @return DisableServiceResponse
5961
+ */
5505
5962
  async disableServiceWithOptions(runtime) {
5506
5963
  let req = new $OpenApi.OpenApiRequest({});
5507
5964
  let params = new $OpenApi.Params({
@@ -5517,10 +5974,27 @@ class Client extends openapi_client_1.default {
5517
5974
  });
5518
5975
  return $tea.cast(await this.callApi(params, req, runtime), new DisableServiceResponse({}));
5519
5976
  }
5977
+ /**
5978
+ * 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.
5979
+ * ## Limits
5980
+ * 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.
5981
+ *
5982
+ * @return DisableServiceResponse
5983
+ */
5520
5984
  async disableService() {
5521
5985
  let runtime = new $Util.RuntimeOptions({});
5522
5986
  return await this.disableServiceWithOptions(runtime);
5523
5987
  }
5988
+ /**
5989
+ * 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~~).
5990
+ * 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).
5991
+ * ## Limits
5992
+ * 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.
5993
+ *
5994
+ * @param request EnableServiceRequest
5995
+ * @param runtime runtime options for this request RuntimeOptions
5996
+ * @return EnableServiceResponse
5997
+ */
5524
5998
  async enableServiceWithOptions(runtime) {
5525
5999
  let req = new $OpenApi.OpenApiRequest({});
5526
6000
  let params = new $OpenApi.Params({
@@ -5536,10 +6010,26 @@ class Client extends openapi_client_1.default {
5536
6010
  });
5537
6011
  return $tea.cast(await this.callApi(params, req, runtime), new EnableServiceResponse({}));
5538
6012
  }
6013
+ /**
6014
+ * 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~~).
6015
+ * 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).
6016
+ * ## Limits
6017
+ * 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.
6018
+ *
6019
+ * @return EnableServiceResponse
6020
+ */
5539
6021
  async enableService() {
5540
6022
  let runtime = new $Util.RuntimeOptions({});
5541
6023
  return await this.enableServiceWithOptions(runtime);
5542
6024
  }
6025
+ /**
6026
+ * ## Usage notes
6027
+ * This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
6028
+ *
6029
+ * @param request GetAccessConfigurationRequest
6030
+ * @param runtime runtime options for this request RuntimeOptions
6031
+ * @return GetAccessConfigurationResponse
6032
+ */
5543
6033
  async getAccessConfigurationWithOptions(request, runtime) {
5544
6034
  tea_util_1.default.validateModel(request);
5545
6035
  let query = {};
@@ -5565,10 +6055,26 @@ class Client extends openapi_client_1.default {
5565
6055
  });
5566
6056
  return $tea.cast(await this.callApi(params, req, runtime), new GetAccessConfigurationResponse({}));
5567
6057
  }
6058
+ /**
6059
+ * ## Usage notes
6060
+ * This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
6061
+ *
6062
+ * @param request GetAccessConfigurationRequest
6063
+ * @return GetAccessConfigurationResponse
6064
+ */
5568
6065
  async getAccessConfiguration(request) {
5569
6066
  let runtime = new $Util.RuntimeOptions({});
5570
6067
  return await this.getAccessConfigurationWithOptions(request, runtime);
5571
6068
  }
6069
+ /**
6070
+ * This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
6071
+ * ## Limits
6072
+ * 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.
6073
+ *
6074
+ * @param request GetDirectoryRequest
6075
+ * @param runtime runtime options for this request RuntimeOptions
6076
+ * @return GetDirectoryResponse
6077
+ */
5572
6078
  async getDirectoryWithOptions(request, runtime) {
5573
6079
  tea_util_1.default.validateModel(request);
5574
6080
  let query = {};
@@ -5591,10 +6097,28 @@ class Client extends openapi_client_1.default {
5591
6097
  });
5592
6098
  return $tea.cast(await this.callApi(params, req, runtime), new GetDirectoryResponse({}));
5593
6099
  }
6100
+ /**
6101
+ * This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
6102
+ * ## Limits
6103
+ * 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.
6104
+ *
6105
+ * @param request GetDirectoryRequest
6106
+ * @return GetDirectoryResponse
6107
+ */
5594
6108
  async getDirectory(request) {
5595
6109
  let runtime = new $Util.RuntimeOptions({});
5596
6110
  return await this.getDirectoryWithOptions(request, runtime);
5597
6111
  }
6112
+ /**
6113
+ * 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).
6114
+ * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
6115
+ * ## Limits
6116
+ * 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.
6117
+ *
6118
+ * @param request GetDirectorySAMLServiceProviderInfoRequest
6119
+ * @param runtime runtime options for this request RuntimeOptions
6120
+ * @return GetDirectorySAMLServiceProviderInfoResponse
6121
+ */
5598
6122
  async getDirectorySAMLServiceProviderInfoWithOptions(request, runtime) {
5599
6123
  tea_util_1.default.validateModel(request);
5600
6124
  let query = {};
@@ -5617,10 +6141,28 @@ class Client extends openapi_client_1.default {
5617
6141
  });
5618
6142
  return $tea.cast(await this.callApi(params, req, runtime), new GetDirectorySAMLServiceProviderInfoResponse({}));
5619
6143
  }
6144
+ /**
6145
+ * 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).
6146
+ * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
6147
+ * ## Limits
6148
+ * 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.
6149
+ *
6150
+ * @param request GetDirectorySAMLServiceProviderInfoRequest
6151
+ * @return GetDirectorySAMLServiceProviderInfoResponse
6152
+ */
5620
6153
  async getDirectorySAMLServiceProviderInfo(request) {
5621
6154
  let runtime = new $Util.RuntimeOptions({});
5622
6155
  return await this.getDirectorySAMLServiceProviderInfoWithOptions(request, runtime);
5623
6156
  }
6157
+ /**
6158
+ * 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.
6159
+ * ## Limits
6160
+ * 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.
6161
+ *
6162
+ * @param request GetDirectoryStatisticsRequest
6163
+ * @param runtime runtime options for this request RuntimeOptions
6164
+ * @return GetDirectoryStatisticsResponse
6165
+ */
5624
6166
  async getDirectoryStatisticsWithOptions(request, runtime) {
5625
6167
  tea_util_1.default.validateModel(request);
5626
6168
  let query = {};
@@ -5643,10 +6185,27 @@ class Client extends openapi_client_1.default {
5643
6185
  });
5644
6186
  return $tea.cast(await this.callApi(params, req, runtime), new GetDirectoryStatisticsResponse({}));
5645
6187
  }
6188
+ /**
6189
+ * 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.
6190
+ * ## Limits
6191
+ * 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.
6192
+ *
6193
+ * @param request GetDirectoryStatisticsRequest
6194
+ * @return GetDirectoryStatisticsResponse
6195
+ */
5646
6196
  async getDirectoryStatistics(request) {
5647
6197
  let runtime = new $Util.RuntimeOptions({});
5648
6198
  return await this.getDirectoryStatisticsWithOptions(request, runtime);
5649
6199
  }
6200
+ /**
6201
+ * This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
6202
+ * ## Limits
6203
+ * 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.
6204
+ *
6205
+ * @param request GetExternalSAMLIdentityProviderRequest
6206
+ * @param runtime runtime options for this request RuntimeOptions
6207
+ * @return GetExternalSAMLIdentityProviderResponse
6208
+ */
5650
6209
  async getExternalSAMLIdentityProviderWithOptions(request, runtime) {
5651
6210
  tea_util_1.default.validateModel(request);
5652
6211
  let query = {};
@@ -5669,10 +6228,27 @@ class Client extends openapi_client_1.default {
5669
6228
  });
5670
6229
  return $tea.cast(await this.callApi(params, req, runtime), new GetExternalSAMLIdentityProviderResponse({}));
5671
6230
  }
6231
+ /**
6232
+ * This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
6233
+ * ## Limits
6234
+ * 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.
6235
+ *
6236
+ * @param request GetExternalSAMLIdentityProviderRequest
6237
+ * @return GetExternalSAMLIdentityProviderResponse
6238
+ */
5672
6239
  async getExternalSAMLIdentityProvider(request) {
5673
6240
  let runtime = new $Util.RuntimeOptions({});
5674
6241
  return await this.getExternalSAMLIdentityProviderWithOptions(request, runtime);
5675
6242
  }
6243
+ /**
6244
+ * This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
6245
+ * ## Limits
6246
+ * 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.
6247
+ *
6248
+ * @param request GetGroupRequest
6249
+ * @param runtime runtime options for this request RuntimeOptions
6250
+ * @return GetGroupResponse
6251
+ */
5676
6252
  async getGroupWithOptions(request, runtime) {
5677
6253
  tea_util_1.default.validateModel(request);
5678
6254
  let query = {};
@@ -5698,10 +6274,67 @@ class Client extends openapi_client_1.default {
5698
6274
  });
5699
6275
  return $tea.cast(await this.callApi(params, req, runtime), new GetGroupResponse({}));
5700
6276
  }
6277
+ /**
6278
+ * This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
6279
+ * ## Limits
6280
+ * 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.
6281
+ *
6282
+ * @param request GetGroupRequest
6283
+ * @return GetGroupResponse
6284
+ */
5701
6285
  async getGroup(request) {
5702
6286
  let runtime = new $Util.RuntimeOptions({});
5703
6287
  return await this.getGroupWithOptions(request, runtime);
5704
6288
  }
6289
+ /**
6290
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
6291
+ * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
6292
+ *
6293
+ * @param request GetMFAAuthenticationSettingInfoRequest
6294
+ * @param runtime runtime options for this request RuntimeOptions
6295
+ * @return GetMFAAuthenticationSettingInfoResponse
6296
+ */
6297
+ async getMFAAuthenticationSettingInfoWithOptions(request, runtime) {
6298
+ tea_util_1.default.validateModel(request);
6299
+ let query = {};
6300
+ if (!tea_util_1.default.isUnset(request.directoryId)) {
6301
+ query["DirectoryId"] = request.directoryId;
6302
+ }
6303
+ let req = new $OpenApi.OpenApiRequest({
6304
+ query: openapi_util_1.default.query(query),
6305
+ });
6306
+ let params = new $OpenApi.Params({
6307
+ action: "GetMFAAuthenticationSettingInfo",
6308
+ version: "2021-05-15",
6309
+ protocol: "HTTPS",
6310
+ pathname: "/",
6311
+ method: "POST",
6312
+ authType: "AK",
6313
+ style: "RPC",
6314
+ reqBodyType: "formData",
6315
+ bodyType: "json",
6316
+ });
6317
+ return $tea.cast(await this.callApi(params, req, runtime), new GetMFAAuthenticationSettingInfoResponse({}));
6318
+ }
6319
+ /**
6320
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
6321
+ * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
6322
+ *
6323
+ * @param request GetMFAAuthenticationSettingInfoRequest
6324
+ * @return GetMFAAuthenticationSettingInfoResponse
6325
+ */
6326
+ async getMFAAuthenticationSettingInfo(request) {
6327
+ let runtime = new $Util.RuntimeOptions({});
6328
+ return await this.getMFAAuthenticationSettingInfoWithOptions(request, runtime);
6329
+ }
6330
+ /**
6331
+ * > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](~~611286~~) operation to query more detailed information.
6332
+ * 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.
6333
+ *
6334
+ * @param request GetMFAAuthenticationSettingsRequest
6335
+ * @param runtime runtime options for this request RuntimeOptions
6336
+ * @return GetMFAAuthenticationSettingsResponse
6337
+ */
5705
6338
  async getMFAAuthenticationSettingsWithOptions(request, runtime) {
5706
6339
  tea_util_1.default.validateModel(request);
5707
6340
  let query = {};
@@ -5724,10 +6357,26 @@ class Client extends openapi_client_1.default {
5724
6357
  });
5725
6358
  return $tea.cast(await this.callApi(params, req, runtime), new GetMFAAuthenticationSettingsResponse({}));
5726
6359
  }
6360
+ /**
6361
+ * > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](~~611286~~) operation to query more detailed information.
6362
+ * 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.
6363
+ *
6364
+ * @param request GetMFAAuthenticationSettingsRequest
6365
+ * @return GetMFAAuthenticationSettingsResponse
6366
+ */
5727
6367
  async getMFAAuthenticationSettings(request) {
5728
6368
  let runtime = new $Util.RuntimeOptions({});
5729
6369
  return await this.getMFAAuthenticationSettingsWithOptions(request, runtime);
5730
6370
  }
6371
+ /**
6372
+ * 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.
6373
+ * ## Limits
6374
+ * 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.
6375
+ *
6376
+ * @param request GetMFAAuthenticationStatusRequest
6377
+ * @param runtime runtime options for this request RuntimeOptions
6378
+ * @return GetMFAAuthenticationStatusResponse
6379
+ */
5731
6380
  async getMFAAuthenticationStatusWithOptions(request, runtime) {
5732
6381
  tea_util_1.default.validateModel(request);
5733
6382
  let query = {};
@@ -5750,10 +6399,27 @@ class Client extends openapi_client_1.default {
5750
6399
  });
5751
6400
  return $tea.cast(await this.callApi(params, req, runtime), new GetMFAAuthenticationStatusResponse({}));
5752
6401
  }
6402
+ /**
6403
+ * 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.
6404
+ * ## Limits
6405
+ * 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.
6406
+ *
6407
+ * @param request GetMFAAuthenticationStatusRequest
6408
+ * @return GetMFAAuthenticationStatusResponse
6409
+ */
5753
6410
  async getMFAAuthenticationStatus(request) {
5754
6411
  let runtime = new $Util.RuntimeOptions({});
5755
6412
  return await this.getMFAAuthenticationStatusWithOptions(request, runtime);
5756
6413
  }
6414
+ /**
6415
+ * 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.
6416
+ * ## Limits
6417
+ * 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.
6418
+ *
6419
+ * @param request GetSCIMSynchronizationStatusRequest
6420
+ * @param runtime runtime options for this request RuntimeOptions
6421
+ * @return GetSCIMSynchronizationStatusResponse
6422
+ */
5757
6423
  async getSCIMSynchronizationStatusWithOptions(request, runtime) {
5758
6424
  tea_util_1.default.validateModel(request);
5759
6425
  let query = {};
@@ -5776,10 +6442,26 @@ class Client extends openapi_client_1.default {
5776
6442
  });
5777
6443
  return $tea.cast(await this.callApi(params, req, runtime), new GetSCIMSynchronizationStatusResponse({}));
5778
6444
  }
6445
+ /**
6446
+ * 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.
6447
+ * ## Limits
6448
+ * 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.
6449
+ *
6450
+ * @param request GetSCIMSynchronizationStatusRequest
6451
+ * @return GetSCIMSynchronizationStatusResponse
6452
+ */
5779
6453
  async getSCIMSynchronizationStatus(request) {
5780
6454
  let runtime = new $Util.RuntimeOptions({});
5781
6455
  return await this.getSCIMSynchronizationStatusWithOptions(request, runtime);
5782
6456
  }
6457
+ /**
6458
+ * ## Limits
6459
+ * 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.
6460
+ *
6461
+ * @param request GetServiceStatusRequest
6462
+ * @param runtime runtime options for this request RuntimeOptions
6463
+ * @return GetServiceStatusResponse
6464
+ */
5783
6465
  async getServiceStatusWithOptions(runtime) {
5784
6466
  let req = new $OpenApi.OpenApiRequest({});
5785
6467
  let params = new $OpenApi.Params({
@@ -5795,10 +6477,25 @@ class Client extends openapi_client_1.default {
5795
6477
  });
5796
6478
  return $tea.cast(await this.callApi(params, req, runtime), new GetServiceStatusResponse({}));
5797
6479
  }
6480
+ /**
6481
+ * ## Limits
6482
+ * 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.
6483
+ *
6484
+ * @return GetServiceStatusResponse
6485
+ */
5798
6486
  async getServiceStatus() {
5799
6487
  let runtime = new $Util.RuntimeOptions({});
5800
6488
  return await this.getServiceStatusWithOptions(runtime);
5801
6489
  }
6490
+ /**
6491
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
6492
+ * ## Limits
6493
+ * 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.
6494
+ *
6495
+ * @param request GetTaskRequest
6496
+ * @param runtime runtime options for this request RuntimeOptions
6497
+ * @return GetTaskResponse
6498
+ */
5802
6499
  async getTaskWithOptions(request, runtime) {
5803
6500
  tea_util_1.default.validateModel(request);
5804
6501
  let query = {};
@@ -5824,10 +6521,28 @@ class Client extends openapi_client_1.default {
5824
6521
  });
5825
6522
  return $tea.cast(await this.callApi(params, req, runtime), new GetTaskResponse({}));
5826
6523
  }
6524
+ /**
6525
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
6526
+ * ## Limits
6527
+ * 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.
6528
+ *
6529
+ * @param request GetTaskRequest
6530
+ * @return GetTaskResponse
6531
+ */
5827
6532
  async getTask(request) {
5828
6533
  let runtime = new $Util.RuntimeOptions({});
5829
6534
  return await this.getTaskWithOptions(request, runtime);
5830
6535
  }
6536
+ /**
6537
+ * 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.
6538
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
6539
+ * ## Limits
6540
+ * 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.
6541
+ *
6542
+ * @param request GetTaskStatusRequest
6543
+ * @param runtime runtime options for this request RuntimeOptions
6544
+ * @return GetTaskStatusResponse
6545
+ */
5831
6546
  async getTaskStatusWithOptions(request, runtime) {
5832
6547
  tea_util_1.default.validateModel(request);
5833
6548
  let query = {};
@@ -5853,10 +6568,28 @@ class Client extends openapi_client_1.default {
5853
6568
  });
5854
6569
  return $tea.cast(await this.callApi(params, req, runtime), new GetTaskStatusResponse({}));
5855
6570
  }
6571
+ /**
6572
+ * 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.
6573
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
6574
+ * ## Limits
6575
+ * 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.
6576
+ *
6577
+ * @param request GetTaskStatusRequest
6578
+ * @return GetTaskStatusResponse
6579
+ */
5856
6580
  async getTaskStatus(request) {
5857
6581
  let runtime = new $Util.RuntimeOptions({});
5858
6582
  return await this.getTaskStatusWithOptions(request, runtime);
5859
6583
  }
6584
+ /**
6585
+ * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
6586
+ * ## Limits
6587
+ * 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.
6588
+ *
6589
+ * @param request GetUserRequest
6590
+ * @param runtime runtime options for this request RuntimeOptions
6591
+ * @return GetUserResponse
6592
+ */
5860
6593
  async getUserWithOptions(request, runtime) {
5861
6594
  tea_util_1.default.validateModel(request);
5862
6595
  let query = {};
@@ -5882,10 +6615,25 @@ class Client extends openapi_client_1.default {
5882
6615
  });
5883
6616
  return $tea.cast(await this.callApi(params, req, runtime), new GetUserResponse({}));
5884
6617
  }
6618
+ /**
6619
+ * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
6620
+ * ## Limits
6621
+ * 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.
6622
+ *
6623
+ * @param request GetUserRequest
6624
+ * @return GetUserResponse
6625
+ */
5885
6626
  async getUser(request) {
5886
6627
  let runtime = new $Util.RuntimeOptions({});
5887
6628
  return await this.getUserWithOptions(request, runtime);
5888
6629
  }
6630
+ /**
6631
+ * 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.
6632
+ *
6633
+ * @param request GetUserMFAAuthenticationSettingsRequest
6634
+ * @param runtime runtime options for this request RuntimeOptions
6635
+ * @return GetUserMFAAuthenticationSettingsResponse
6636
+ */
5889
6637
  async getUserMFAAuthenticationSettingsWithOptions(request, runtime) {
5890
6638
  tea_util_1.default.validateModel(request);
5891
6639
  let query = {};
@@ -5911,10 +6659,25 @@ class Client extends openapi_client_1.default {
5911
6659
  });
5912
6660
  return $tea.cast(await this.callApi(params, req, runtime), new GetUserMFAAuthenticationSettingsResponse({}));
5913
6661
  }
6662
+ /**
6663
+ * 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.
6664
+ *
6665
+ * @param request GetUserMFAAuthenticationSettingsRequest
6666
+ * @return GetUserMFAAuthenticationSettingsResponse
6667
+ */
5914
6668
  async getUserMFAAuthenticationSettings(request) {
5915
6669
  let runtime = new $Util.RuntimeOptions({});
5916
6670
  return await this.getUserMFAAuthenticationSettingsWithOptions(request, runtime);
5917
6671
  }
6672
+ /**
6673
+ * 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.
6674
+ * ## Limits
6675
+ * 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.
6676
+ *
6677
+ * @param request ListAccessAssignmentsRequest
6678
+ * @param runtime runtime options for this request RuntimeOptions
6679
+ * @return ListAccessAssignmentsResponse
6680
+ */
5918
6681
  async listAccessAssignmentsWithOptions(request, runtime) {
5919
6682
  tea_util_1.default.validateModel(request);
5920
6683
  let query = {};
@@ -5958,10 +6721,26 @@ class Client extends openapi_client_1.default {
5958
6721
  });
5959
6722
  return $tea.cast(await this.callApi(params, req, runtime), new ListAccessAssignmentsResponse({}));
5960
6723
  }
6724
+ /**
6725
+ * 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.
6726
+ * ## Limits
6727
+ * 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.
6728
+ *
6729
+ * @param request ListAccessAssignmentsRequest
6730
+ * @return ListAccessAssignmentsResponse
6731
+ */
5961
6732
  async listAccessAssignments(request) {
5962
6733
  let runtime = new $Util.RuntimeOptions({});
5963
6734
  return await this.listAccessAssignmentsWithOptions(request, runtime);
5964
6735
  }
6736
+ /**
6737
+ * ## Usage notes
6738
+ * 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.
6739
+ *
6740
+ * @param request ListAccessConfigurationProvisioningsRequest
6741
+ * @param runtime runtime options for this request RuntimeOptions
6742
+ * @return ListAccessConfigurationProvisioningsResponse
6743
+ */
5965
6744
  async listAccessConfigurationProvisioningsWithOptions(request, runtime) {
5966
6745
  tea_util_1.default.validateModel(request);
5967
6746
  let query = {};
@@ -6002,10 +6781,25 @@ class Client extends openapi_client_1.default {
6002
6781
  });
6003
6782
  return $tea.cast(await this.callApi(params, req, runtime), new ListAccessConfigurationProvisioningsResponse({}));
6004
6783
  }
6784
+ /**
6785
+ * ## Usage notes
6786
+ * 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.
6787
+ *
6788
+ * @param request ListAccessConfigurationProvisioningsRequest
6789
+ * @return ListAccessConfigurationProvisioningsResponse
6790
+ */
6005
6791
  async listAccessConfigurationProvisionings(request) {
6006
6792
  let runtime = new $Util.RuntimeOptions({});
6007
6793
  return await this.listAccessConfigurationProvisioningsWithOptions(request, runtime);
6008
6794
  }
6795
+ /**
6796
+ * ## Usage notes
6797
+ * 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.
6798
+ *
6799
+ * @param request ListAccessConfigurationsRequest
6800
+ * @param runtime runtime options for this request RuntimeOptions
6801
+ * @return ListAccessConfigurationsResponse
6802
+ */
6009
6803
  async listAccessConfigurationsWithOptions(request, runtime) {
6010
6804
  tea_util_1.default.validateModel(request);
6011
6805
  let query = {};
@@ -6040,10 +6834,26 @@ class Client extends openapi_client_1.default {
6040
6834
  });
6041
6835
  return $tea.cast(await this.callApi(params, req, runtime), new ListAccessConfigurationsResponse({}));
6042
6836
  }
6837
+ /**
6838
+ * ## Usage notes
6839
+ * 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.
6840
+ *
6841
+ * @param request ListAccessConfigurationsRequest
6842
+ * @return ListAccessConfigurationsResponse
6843
+ */
6043
6844
  async listAccessConfigurations(request) {
6044
6845
  let runtime = new $Util.RuntimeOptions({});
6045
6846
  return await this.listAccessConfigurationsWithOptions(request, runtime);
6046
6847
  }
6848
+ /**
6849
+ * 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.
6850
+ * ## Limits
6851
+ * 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.
6852
+ *
6853
+ * @param request ListDirectoriesRequest
6854
+ * @param runtime runtime options for this request RuntimeOptions
6855
+ * @return ListDirectoriesResponse
6856
+ */
6047
6857
  async listDirectoriesWithOptions(runtime) {
6048
6858
  let req = new $OpenApi.OpenApiRequest({});
6049
6859
  let params = new $OpenApi.Params({
@@ -6059,10 +6869,26 @@ class Client extends openapi_client_1.default {
6059
6869
  });
6060
6870
  return $tea.cast(await this.callApi(params, req, runtime), new ListDirectoriesResponse({}));
6061
6871
  }
6872
+ /**
6873
+ * 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.
6874
+ * ## Limits
6875
+ * 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.
6876
+ *
6877
+ * @return ListDirectoriesResponse
6878
+ */
6062
6879
  async listDirectories() {
6063
6880
  let runtime = new $Util.RuntimeOptions({});
6064
6881
  return await this.listDirectoriesWithOptions(runtime);
6065
6882
  }
6883
+ /**
6884
+ * 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.
6885
+ * ## Limits
6886
+ * 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.
6887
+ *
6888
+ * @param request ListExternalSAMLIdPCertificatesRequest
6889
+ * @param runtime runtime options for this request RuntimeOptions
6890
+ * @return ListExternalSAMLIdPCertificatesResponse
6891
+ */
6066
6892
  async listExternalSAMLIdPCertificatesWithOptions(request, runtime) {
6067
6893
  tea_util_1.default.validateModel(request);
6068
6894
  let query = {};
@@ -6085,10 +6911,27 @@ class Client extends openapi_client_1.default {
6085
6911
  });
6086
6912
  return $tea.cast(await this.callApi(params, req, runtime), new ListExternalSAMLIdPCertificatesResponse({}));
6087
6913
  }
6914
+ /**
6915
+ * 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.
6916
+ * ## Limits
6917
+ * 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.
6918
+ *
6919
+ * @param request ListExternalSAMLIdPCertificatesRequest
6920
+ * @return ListExternalSAMLIdPCertificatesResponse
6921
+ */
6088
6922
  async listExternalSAMLIdPCertificates(request) {
6089
6923
  let runtime = new $Util.RuntimeOptions({});
6090
6924
  return await this.listExternalSAMLIdPCertificatesWithOptions(request, runtime);
6091
6925
  }
6926
+ /**
6927
+ * 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`.
6928
+ * ## Limits
6929
+ * 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.
6930
+ *
6931
+ * @param request ListGroupMembersRequest
6932
+ * @param runtime runtime options for this request RuntimeOptions
6933
+ * @return ListGroupMembersResponse
6934
+ */
6092
6935
  async listGroupMembersWithOptions(request, runtime) {
6093
6936
  tea_util_1.default.validateModel(request);
6094
6937
  let query = {};
@@ -6120,10 +6963,27 @@ class Client extends openapi_client_1.default {
6120
6963
  });
6121
6964
  return $tea.cast(await this.callApi(params, req, runtime), new ListGroupMembersResponse({}));
6122
6965
  }
6966
+ /**
6967
+ * 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`.
6968
+ * ## Limits
6969
+ * 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.
6970
+ *
6971
+ * @param request ListGroupMembersRequest
6972
+ * @return ListGroupMembersResponse
6973
+ */
6123
6974
  async listGroupMembers(request) {
6124
6975
  let runtime = new $Util.RuntimeOptions({});
6125
6976
  return await this.listGroupMembersWithOptions(request, runtime);
6126
6977
  }
6978
+ /**
6979
+ * 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.
6980
+ * ## Limits
6981
+ * 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.
6982
+ *
6983
+ * @param request ListGroupsRequest
6984
+ * @param runtime runtime options for this request RuntimeOptions
6985
+ * @return ListGroupsResponse
6986
+ */
6127
6987
  async listGroupsWithOptions(request, runtime) {
6128
6988
  tea_util_1.default.validateModel(request);
6129
6989
  let query = {};
@@ -6158,10 +7018,27 @@ class Client extends openapi_client_1.default {
6158
7018
  });
6159
7019
  return $tea.cast(await this.callApi(params, req, runtime), new ListGroupsResponse({}));
6160
7020
  }
7021
+ /**
7022
+ * 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.
7023
+ * ## Limits
7024
+ * 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.
7025
+ *
7026
+ * @param request ListGroupsRequest
7027
+ * @return ListGroupsResponse
7028
+ */
6161
7029
  async listGroups(request) {
6162
7030
  let runtime = new $Util.RuntimeOptions({});
6163
7031
  return await this.listGroupsWithOptions(request, runtime);
6164
7032
  }
7033
+ /**
7034
+ * 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.
7035
+ * ## Limits
7036
+ * 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.
7037
+ *
7038
+ * @param request ListJoinedGroupsForUserRequest
7039
+ * @param runtime runtime options for this request RuntimeOptions
7040
+ * @return ListJoinedGroupsForUserResponse
7041
+ */
6165
7042
  async listJoinedGroupsForUserWithOptions(request, runtime) {
6166
7043
  tea_util_1.default.validateModel(request);
6167
7044
  let query = {};
@@ -6193,10 +7070,27 @@ class Client extends openapi_client_1.default {
6193
7070
  });
6194
7071
  return $tea.cast(await this.callApi(params, req, runtime), new ListJoinedGroupsForUserResponse({}));
6195
7072
  }
7073
+ /**
7074
+ * 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.
7075
+ * ## Limits
7076
+ * 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.
7077
+ *
7078
+ * @param request ListJoinedGroupsForUserRequest
7079
+ * @return ListJoinedGroupsForUserResponse
7080
+ */
6196
7081
  async listJoinedGroupsForUser(request) {
6197
7082
  let runtime = new $Util.RuntimeOptions({});
6198
7083
  return await this.listJoinedGroupsForUserWithOptions(request, runtime);
6199
7084
  }
7085
+ /**
7086
+ * 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.
7087
+ * ## Limits
7088
+ * 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.
7089
+ *
7090
+ * @param request ListMFADevicesForUserRequest
7091
+ * @param runtime runtime options for this request RuntimeOptions
7092
+ * @return ListMFADevicesForUserResponse
7093
+ */
6200
7094
  async listMFADevicesForUserWithOptions(request, runtime) {
6201
7095
  tea_util_1.default.validateModel(request);
6202
7096
  let query = {};
@@ -6222,10 +7116,27 @@ class Client extends openapi_client_1.default {
6222
7116
  });
6223
7117
  return $tea.cast(await this.callApi(params, req, runtime), new ListMFADevicesForUserResponse({}));
6224
7118
  }
7119
+ /**
7120
+ * 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.
7121
+ * ## Limits
7122
+ * 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.
7123
+ *
7124
+ * @param request ListMFADevicesForUserRequest
7125
+ * @return ListMFADevicesForUserResponse
7126
+ */
6225
7127
  async listMFADevicesForUser(request) {
6226
7128
  let runtime = new $Util.RuntimeOptions({});
6227
7129
  return await this.listMFADevicesForUserWithOptions(request, runtime);
6228
7130
  }
7131
+ /**
7132
+ * 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.
7133
+ * ## Limits
7134
+ * 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.
7135
+ *
7136
+ * @param request ListPermissionPoliciesInAccessConfigurationRequest
7137
+ * @param runtime runtime options for this request RuntimeOptions
7138
+ * @return ListPermissionPoliciesInAccessConfigurationResponse
7139
+ */
6229
7140
  async listPermissionPoliciesInAccessConfigurationWithOptions(request, runtime) {
6230
7141
  tea_util_1.default.validateModel(request);
6231
7142
  let query = {};
@@ -6254,10 +7165,27 @@ class Client extends openapi_client_1.default {
6254
7165
  });
6255
7166
  return $tea.cast(await this.callApi(params, req, runtime), new ListPermissionPoliciesInAccessConfigurationResponse({}));
6256
7167
  }
7168
+ /**
7169
+ * 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.
7170
+ * ## Limits
7171
+ * 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.
7172
+ *
7173
+ * @param request ListPermissionPoliciesInAccessConfigurationRequest
7174
+ * @return ListPermissionPoliciesInAccessConfigurationResponse
7175
+ */
6257
7176
  async listPermissionPoliciesInAccessConfiguration(request) {
6258
7177
  let runtime = new $Util.RuntimeOptions({});
6259
7178
  return await this.listPermissionPoliciesInAccessConfigurationWithOptions(request, runtime);
6260
7179
  }
7180
+ /**
7181
+ * This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
7182
+ * ## Limits
7183
+ * 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.
7184
+ *
7185
+ * @param request ListSCIMServerCredentialsRequest
7186
+ * @param runtime runtime options for this request RuntimeOptions
7187
+ * @return ListSCIMServerCredentialsResponse
7188
+ */
6261
7189
  async listSCIMServerCredentialsWithOptions(request, runtime) {
6262
7190
  tea_util_1.default.validateModel(request);
6263
7191
  let query = {};
@@ -6280,10 +7208,28 @@ class Client extends openapi_client_1.default {
6280
7208
  });
6281
7209
  return $tea.cast(await this.callApi(params, req, runtime), new ListSCIMServerCredentialsResponse({}));
6282
7210
  }
7211
+ /**
7212
+ * This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
7213
+ * ## Limits
7214
+ * 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.
7215
+ *
7216
+ * @param request ListSCIMServerCredentialsRequest
7217
+ * @return ListSCIMServerCredentialsResponse
7218
+ */
6283
7219
  async listSCIMServerCredentials(request) {
6284
7220
  let runtime = new $Util.RuntimeOptions({});
6285
7221
  return await this.listSCIMServerCredentialsWithOptions(request, runtime);
6286
7222
  }
7223
+ /**
7224
+ * 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`.
7225
+ * This topic provides an example on how to query the tasks within the previous 24 hours.
7226
+ * ## Limits
7227
+ * 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.
7228
+ *
7229
+ * @param request ListTasksRequest
7230
+ * @param runtime runtime options for this request RuntimeOptions
7231
+ * @return ListTasksResponse
7232
+ */
6287
7233
  async listTasksWithOptions(request, runtime) {
6288
7234
  tea_util_1.default.validateModel(request);
6289
7235
  let query = {};
@@ -6336,10 +7282,28 @@ class Client extends openapi_client_1.default {
6336
7282
  });
6337
7283
  return $tea.cast(await this.callApi(params, req, runtime), new ListTasksResponse({}));
6338
7284
  }
7285
+ /**
7286
+ * 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`.
7287
+ * This topic provides an example on how to query the tasks within the previous 24 hours.
7288
+ * ## Limits
7289
+ * 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.
7290
+ *
7291
+ * @param request ListTasksRequest
7292
+ * @return ListTasksResponse
7293
+ */
6339
7294
  async listTasks(request) {
6340
7295
  let runtime = new $Util.RuntimeOptions({});
6341
7296
  return await this.listTasksWithOptions(request, runtime);
6342
7297
  }
7298
+ /**
7299
+ * 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.
7300
+ * ## Limits
7301
+ * 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.
7302
+ *
7303
+ * @param request ListUsersRequest
7304
+ * @param runtime runtime options for this request RuntimeOptions
7305
+ * @return ListUsersResponse
7306
+ */
6343
7307
  async listUsersWithOptions(request, runtime) {
6344
7308
  tea_util_1.default.validateModel(request);
6345
7309
  let query = {};
@@ -6377,10 +7341,28 @@ class Client extends openapi_client_1.default {
6377
7341
  });
6378
7342
  return $tea.cast(await this.callApi(params, req, runtime), new ListUsersResponse({}));
6379
7343
  }
7344
+ /**
7345
+ * 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.
7346
+ * ## Limits
7347
+ * 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.
7348
+ *
7349
+ * @param request ListUsersRequest
7350
+ * @return ListUsersResponse
7351
+ */
6380
7352
  async listUsers(request) {
6381
7353
  let runtime = new $Util.RuntimeOptions({});
6382
7354
  return await this.listUsersWithOptions(request, runtime);
6383
7355
  }
7356
+ /**
7357
+ * 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.
7358
+ * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
7359
+ * ## Limits
7360
+ * 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.
7361
+ *
7362
+ * @param request ProvisionAccessConfigurationRequest
7363
+ * @param runtime runtime options for this request RuntimeOptions
7364
+ * @return ProvisionAccessConfigurationResponse
7365
+ */
6384
7366
  async provisionAccessConfigurationWithOptions(request, runtime) {
6385
7367
  tea_util_1.default.validateModel(request);
6386
7368
  let query = {};
@@ -6412,10 +7394,28 @@ class Client extends openapi_client_1.default {
6412
7394
  });
6413
7395
  return $tea.cast(await this.callApi(params, req, runtime), new ProvisionAccessConfigurationResponse({}));
6414
7396
  }
7397
+ /**
7398
+ * 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.
7399
+ * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
7400
+ * ## Limits
7401
+ * 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.
7402
+ *
7403
+ * @param request ProvisionAccessConfigurationRequest
7404
+ * @return ProvisionAccessConfigurationResponse
7405
+ */
6415
7406
  async provisionAccessConfiguration(request) {
6416
7407
  let runtime = new $Util.RuntimeOptions({});
6417
7408
  return await this.provisionAccessConfigurationWithOptions(request, runtime);
6418
7409
  }
7410
+ /**
7411
+ * This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
7412
+ * ## Limits
7413
+ * 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.
7414
+ *
7415
+ * @param request RemoveExternalSAMLIdPCertificateRequest
7416
+ * @param runtime runtime options for this request RuntimeOptions
7417
+ * @return RemoveExternalSAMLIdPCertificateResponse
7418
+ */
6419
7419
  async removeExternalSAMLIdPCertificateWithOptions(request, runtime) {
6420
7420
  tea_util_1.default.validateModel(request);
6421
7421
  let query = {};
@@ -6441,10 +7441,28 @@ class Client extends openapi_client_1.default {
6441
7441
  });
6442
7442
  return $tea.cast(await this.callApi(params, req, runtime), new RemoveExternalSAMLIdPCertificateResponse({}));
6443
7443
  }
7444
+ /**
7445
+ * This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
7446
+ * ## Limits
7447
+ * 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.
7448
+ *
7449
+ * @param request RemoveExternalSAMLIdPCertificateRequest
7450
+ * @return RemoveExternalSAMLIdPCertificateResponse
7451
+ */
6444
7452
  async removeExternalSAMLIdPCertificate(request) {
6445
7453
  let runtime = new $Util.RuntimeOptions({});
6446
7454
  return await this.removeExternalSAMLIdPCertificateWithOptions(request, runtime);
6447
7455
  }
7456
+ /**
7457
+ * After you remove an inline policy from an access configuration, the policy cannot be restored.
7458
+ * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
7459
+ * ## Limits
7460
+ * 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.
7461
+ *
7462
+ * @param request RemovePermissionPolicyFromAccessConfigurationRequest
7463
+ * @param runtime runtime options for this request RuntimeOptions
7464
+ * @return RemovePermissionPolicyFromAccessConfigurationResponse
7465
+ */
6448
7466
  async removePermissionPolicyFromAccessConfigurationWithOptions(request, runtime) {
6449
7467
  tea_util_1.default.validateModel(request);
6450
7468
  let query = {};
@@ -6476,10 +7494,29 @@ class Client extends openapi_client_1.default {
6476
7494
  });
6477
7495
  return $tea.cast(await this.callApi(params, req, runtime), new RemovePermissionPolicyFromAccessConfigurationResponse({}));
6478
7496
  }
7497
+ /**
7498
+ * After you remove an inline policy from an access configuration, the policy cannot be restored.
7499
+ * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
7500
+ * ## Limits
7501
+ * 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.
7502
+ *
7503
+ * @param request RemovePermissionPolicyFromAccessConfigurationRequest
7504
+ * @return RemovePermissionPolicyFromAccessConfigurationResponse
7505
+ */
6479
7506
  async removePermissionPolicyFromAccessConfiguration(request) {
6480
7507
  let runtime = new $Util.RuntimeOptions({});
6481
7508
  return await this.removePermissionPolicyFromAccessConfigurationWithOptions(request, runtime);
6482
7509
  }
7510
+ /**
7511
+ * 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.
7512
+ * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
7513
+ * ## Limits
7514
+ * 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.
7515
+ *
7516
+ * @param request RemoveUserFromGroupRequest
7517
+ * @param runtime runtime options for this request RuntimeOptions
7518
+ * @return RemoveUserFromGroupResponse
7519
+ */
6483
7520
  async removeUserFromGroupWithOptions(request, runtime) {
6484
7521
  tea_util_1.default.validateModel(request);
6485
7522
  let query = {};
@@ -6508,10 +7545,30 @@ class Client extends openapi_client_1.default {
6508
7545
  });
6509
7546
  return $tea.cast(await this.callApi(params, req, runtime), new RemoveUserFromGroupResponse({}));
6510
7547
  }
7548
+ /**
7549
+ * 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.
7550
+ * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
7551
+ * ## Limits
7552
+ * 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.
7553
+ *
7554
+ * @param request RemoveUserFromGroupRequest
7555
+ * @return RemoveUserFromGroupResponse
7556
+ */
6511
7557
  async removeUserFromGroup(request) {
6512
7558
  let runtime = new $Util.RuntimeOptions({});
6513
7559
  return await this.removeUserFromGroupWithOptions(request, runtime);
6514
7560
  }
7561
+ /**
7562
+ * If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
7563
+ * > After you enable SSO logon, your password cannot be reset.
7564
+ * 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.
7565
+ * ## Limits
7566
+ * 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.
7567
+ *
7568
+ * @param request ResetUserPasswordRequest
7569
+ * @param runtime runtime options for this request RuntimeOptions
7570
+ * @return ResetUserPasswordResponse
7571
+ */
6515
7572
  async resetUserPasswordWithOptions(request, runtime) {
6516
7573
  tea_util_1.default.validateModel(request);
6517
7574
  let query = {};
@@ -6546,10 +7603,36 @@ class Client extends openapi_client_1.default {
6546
7603
  });
6547
7604
  return $tea.cast(await this.callApi(params, req, runtime), new ResetUserPasswordResponse({}));
6548
7605
  }
7606
+ /**
7607
+ * If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
7608
+ * > After you enable SSO logon, your password cannot be reset.
7609
+ * 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.
7610
+ * ## Limits
7611
+ * 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.
7612
+ *
7613
+ * @param request ResetUserPasswordRequest
7614
+ * @return ResetUserPasswordResponse
7615
+ */
6549
7616
  async resetUserPassword(request) {
6550
7617
  let runtime = new $Util.RuntimeOptions({});
6551
7618
  return await this.resetUserPasswordWithOptions(request, runtime);
6552
7619
  }
7620
+ /**
7621
+ * ## Usage notes
7622
+ * 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.
7623
+ * 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.
7624
+ * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
7625
+ * * Manually configure the IdP. You can manually specifythe following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
7626
+ * If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
7627
+ * * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
7628
+ * * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
7629
+ * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
7630
+ * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
7631
+ *
7632
+ * @param request SetExternalSAMLIdentityProviderRequest
7633
+ * @param runtime runtime options for this request RuntimeOptions
7634
+ * @return SetExternalSAMLIdentityProviderResponse
7635
+ */
6553
7636
  async setExternalSAMLIdentityProviderWithOptions(request, runtime) {
6554
7637
  tea_util_1.default.validateModel(request);
6555
7638
  let query = {};
@@ -6590,10 +7673,35 @@ class Client extends openapi_client_1.default {
6590
7673
  });
6591
7674
  return $tea.cast(await this.callApi(params, req, runtime), new SetExternalSAMLIdentityProviderResponse({}));
6592
7675
  }
7676
+ /**
7677
+ * ## Usage notes
7678
+ * 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.
7679
+ * 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.
7680
+ * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
7681
+ * * Manually configure the IdP. You can manually specifythe following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
7682
+ * If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
7683
+ * * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
7684
+ * * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
7685
+ * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
7686
+ * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
7687
+ *
7688
+ * @param request SetExternalSAMLIdentityProviderRequest
7689
+ * @return SetExternalSAMLIdentityProviderResponse
7690
+ */
6593
7691
  async setExternalSAMLIdentityProvider(request) {
6594
7692
  let runtime = new $Util.RuntimeOptions({});
6595
7693
  return await this.setExternalSAMLIdentityProviderWithOptions(request, runtime);
6596
7694
  }
7695
+ /**
7696
+ * 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.
7697
+ * This topic provides an example on how to enable MFA for users.
7698
+ * ## Limits
7699
+ * 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.
7700
+ *
7701
+ * @param request SetMFAAuthenticationStatusRequest
7702
+ * @param runtime runtime options for this request RuntimeOptions
7703
+ * @return SetMFAAuthenticationStatusResponse
7704
+ */
6597
7705
  async setMFAAuthenticationStatusWithOptions(request, runtime) {
6598
7706
  tea_util_1.default.validateModel(request);
6599
7707
  let query = {};
@@ -6619,10 +7727,31 @@ class Client extends openapi_client_1.default {
6619
7727
  });
6620
7728
  return $tea.cast(await this.callApi(params, req, runtime), new SetMFAAuthenticationStatusResponse({}));
6621
7729
  }
7730
+ /**
7731
+ * 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.
7732
+ * This topic provides an example on how to enable MFA for users.
7733
+ * ## Limits
7734
+ * 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.
7735
+ *
7736
+ * @param request SetMFAAuthenticationStatusRequest
7737
+ * @return SetMFAAuthenticationStatusResponse
7738
+ */
6622
7739
  async setMFAAuthenticationStatus(request) {
6623
7740
  let runtime = new $Util.RuntimeOptions({});
6624
7741
  return await this.setMFAAuthenticationStatusWithOptions(request, runtime);
6625
7742
  }
7743
+ /**
7744
+ * 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:
7745
+ * * 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.
7746
+ * * 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.
7747
+ * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
7748
+ * ## Limits
7749
+ * 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.
7750
+ *
7751
+ * @param request SetSCIMSynchronizationStatusRequest
7752
+ * @param runtime runtime options for this request RuntimeOptions
7753
+ * @return SetSCIMSynchronizationStatusResponse
7754
+ */
6626
7755
  async setSCIMSynchronizationStatusWithOptions(request, runtime) {
6627
7756
  tea_util_1.default.validateModel(request);
6628
7757
  let query = {};
@@ -6648,10 +7777,31 @@ class Client extends openapi_client_1.default {
6648
7777
  });
6649
7778
  return $tea.cast(await this.callApi(params, req, runtime), new SetSCIMSynchronizationStatusResponse({}));
6650
7779
  }
7780
+ /**
7781
+ * 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:
7782
+ * * 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.
7783
+ * * 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.
7784
+ * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
7785
+ * ## Limits
7786
+ * 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.
7787
+ *
7788
+ * @param request SetSCIMSynchronizationStatusRequest
7789
+ * @return SetSCIMSynchronizationStatusResponse
7790
+ */
6651
7791
  async setSCIMSynchronizationStatus(request) {
6652
7792
  let runtime = new $Util.RuntimeOptions({});
6653
7793
  return await this.setSCIMSynchronizationStatusWithOptions(request, runtime);
6654
7794
  }
7795
+ /**
7796
+ * You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
7797
+ * 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`.
7798
+ * ## Limits
7799
+ * 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.
7800
+ *
7801
+ * @param request UpdateAccessConfigurationRequest
7802
+ * @param runtime runtime options for this request RuntimeOptions
7803
+ * @return UpdateAccessConfigurationResponse
7804
+ */
6655
7805
  async updateAccessConfigurationWithOptions(request, runtime) {
6656
7806
  tea_util_1.default.validateModel(request);
6657
7807
  let query = {};
@@ -6686,10 +7836,29 @@ class Client extends openapi_client_1.default {
6686
7836
  });
6687
7837
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateAccessConfigurationResponse({}));
6688
7838
  }
7839
+ /**
7840
+ * You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
7841
+ * 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`.
7842
+ * ## Limits
7843
+ * 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.
7844
+ *
7845
+ * @param request UpdateAccessConfigurationRequest
7846
+ * @return UpdateAccessConfigurationResponse
7847
+ */
6689
7848
  async updateAccessConfiguration(request) {
6690
7849
  let runtime = new $Util.RuntimeOptions({});
6691
7850
  return await this.updateAccessConfigurationWithOptions(request, runtime);
6692
7851
  }
7852
+ /**
7853
+ * 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.
7854
+ * This topic provides an example on how to change the name of a directory to `new-example`.
7855
+ * ## Limits
7856
+ * 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.
7857
+ *
7858
+ * @param request UpdateDirectoryRequest
7859
+ * @param runtime runtime options for this request RuntimeOptions
7860
+ * @return UpdateDirectoryResponse
7861
+ */
6693
7862
  async updateDirectoryWithOptions(request, runtime) {
6694
7863
  tea_util_1.default.validateModel(request);
6695
7864
  let query = {};
@@ -6715,10 +7884,30 @@ class Client extends openapi_client_1.default {
6715
7884
  });
6716
7885
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateDirectoryResponse({}));
6717
7886
  }
7887
+ /**
7888
+ * 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.
7889
+ * This topic provides an example on how to change the name of a directory to `new-example`.
7890
+ * ## Limits
7891
+ * 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.
7892
+ *
7893
+ * @param request UpdateDirectoryRequest
7894
+ * @return UpdateDirectoryResponse
7895
+ */
6718
7896
  async updateDirectory(request) {
6719
7897
  let runtime = new $Util.RuntimeOptions({});
6720
7898
  return await this.updateDirectoryWithOptions(request, runtime);
6721
7899
  }
7900
+ /**
7901
+ * You can modify `GroupName` and `Description` for a group.
7902
+ * > 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.
7903
+ * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
7904
+ * ## Limits
7905
+ * 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.
7906
+ *
7907
+ * @param request UpdateGroupRequest
7908
+ * @param runtime runtime options for this request RuntimeOptions
7909
+ * @return UpdateGroupResponse
7910
+ */
6722
7911
  async updateGroupWithOptions(request, runtime) {
6723
7912
  tea_util_1.default.validateModel(request);
6724
7913
  let query = {};
@@ -6750,10 +7939,29 @@ class Client extends openapi_client_1.default {
6750
7939
  });
6751
7940
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateGroupResponse({}));
6752
7941
  }
7942
+ /**
7943
+ * You can modify `GroupName` and `Description` for a group.
7944
+ * > 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.
7945
+ * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
7946
+ * ## Limits
7947
+ * 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.
7948
+ *
7949
+ * @param request UpdateGroupRequest
7950
+ * @return UpdateGroupResponse
7951
+ */
6753
7952
  async updateGroup(request) {
6754
7953
  let runtime = new $Util.RuntimeOptions({});
6755
7954
  return await this.updateGroupWithOptions(request, runtime);
6756
7955
  }
7956
+ /**
7957
+ * This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
7958
+ * ## Limits
7959
+ * 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.
7960
+ *
7961
+ * @param request UpdateInlinePolicyForAccessConfigurationRequest
7962
+ * @param runtime runtime options for this request RuntimeOptions
7963
+ * @return UpdateInlinePolicyForAccessConfigurationResponse
7964
+ */
6757
7965
  async updateInlinePolicyForAccessConfigurationWithOptions(request, runtime) {
6758
7966
  tea_util_1.default.validateModel(request);
6759
7967
  let query = {};
@@ -6785,10 +7993,26 @@ class Client extends openapi_client_1.default {
6785
7993
  });
6786
7994
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateInlinePolicyForAccessConfigurationResponse({}));
6787
7995
  }
7996
+ /**
7997
+ * This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
7998
+ * ## Limits
7999
+ * 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.
8000
+ *
8001
+ * @param request UpdateInlinePolicyForAccessConfigurationRequest
8002
+ * @return UpdateInlinePolicyForAccessConfigurationResponse
8003
+ */
6788
8004
  async updateInlinePolicyForAccessConfiguration(request) {
6789
8005
  let runtime = new $Util.RuntimeOptions({});
6790
8006
  return await this.updateInlinePolicyForAccessConfigurationWithOptions(request, runtime);
6791
8007
  }
8008
+ /**
8009
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
8010
+ * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
8011
+ *
8012
+ * @param request UpdateMFAAuthenticationSettingsRequest
8013
+ * @param runtime runtime options for this request RuntimeOptions
8014
+ * @return UpdateMFAAuthenticationSettingsResponse
8015
+ */
6792
8016
  async updateMFAAuthenticationSettingsWithOptions(request, runtime) {
6793
8017
  tea_util_1.default.validateModel(request);
6794
8018
  let query = {};
@@ -6817,10 +8041,26 @@ class Client extends openapi_client_1.default {
6817
8041
  });
6818
8042
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateMFAAuthenticationSettingsResponse({}));
6819
8043
  }
8044
+ /**
8045
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
8046
+ * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
8047
+ *
8048
+ * @param request UpdateMFAAuthenticationSettingsRequest
8049
+ * @return UpdateMFAAuthenticationSettingsResponse
8050
+ */
6820
8051
  async updateMFAAuthenticationSettings(request) {
6821
8052
  let runtime = new $Util.RuntimeOptions({});
6822
8053
  return await this.updateMFAAuthenticationSettingsWithOptions(request, runtime);
6823
8054
  }
8055
+ /**
8056
+ * 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.
8057
+ * ## Limits
8058
+ * 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.
8059
+ *
8060
+ * @param request UpdateSCIMServerCredentialStatusRequest
8061
+ * @param runtime runtime options for this request RuntimeOptions
8062
+ * @return UpdateSCIMServerCredentialStatusResponse
8063
+ */
6824
8064
  async updateSCIMServerCredentialStatusWithOptions(request, runtime) {
6825
8065
  tea_util_1.default.validateModel(request);
6826
8066
  let query = {};
@@ -6849,10 +8089,29 @@ class Client extends openapi_client_1.default {
6849
8089
  });
6850
8090
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateSCIMServerCredentialStatusResponse({}));
6851
8091
  }
8092
+ /**
8093
+ * 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.
8094
+ * ## Limits
8095
+ * 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.
8096
+ *
8097
+ * @param request UpdateSCIMServerCredentialStatusRequest
8098
+ * @return UpdateSCIMServerCredentialStatusResponse
8099
+ */
6852
8100
  async updateSCIMServerCredentialStatus(request) {
6853
8101
  let runtime = new $Util.RuntimeOptions({});
6854
8102
  return await this.updateSCIMServerCredentialStatusWithOptions(request, runtime);
6855
8103
  }
8104
+ /**
8105
+ * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
8106
+ * > 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.
8107
+ * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
8108
+ * ## Limits
8109
+ * 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.
8110
+ *
8111
+ * @param request UpdateUserRequest
8112
+ * @param runtime runtime options for this request RuntimeOptions
8113
+ * @return UpdateUserResponse
8114
+ */
6856
8115
  async updateUserWithOptions(request, runtime) {
6857
8116
  tea_util_1.default.validateModel(request);
6858
8117
  let query = {};
@@ -6893,10 +8152,29 @@ class Client extends openapi_client_1.default {
6893
8152
  });
6894
8153
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateUserResponse({}));
6895
8154
  }
8155
+ /**
8156
+ * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
8157
+ * > 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.
8158
+ * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
8159
+ * ## Limits
8160
+ * 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.
8161
+ *
8162
+ * @param request UpdateUserRequest
8163
+ * @return UpdateUserResponse
8164
+ */
6896
8165
  async updateUser(request) {
6897
8166
  let runtime = new $Util.RuntimeOptions({});
6898
8167
  return await this.updateUserWithOptions(request, runtime);
6899
8168
  }
8169
+ /**
8170
+ * 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.
8171
+ * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
8172
+ * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
8173
+ *
8174
+ * @param request UpdateUserMFAAuthenticationSettingsRequest
8175
+ * @param runtime runtime options for this request RuntimeOptions
8176
+ * @return UpdateUserMFAAuthenticationSettingsResponse
8177
+ */
6900
8178
  async updateUserMFAAuthenticationSettingsWithOptions(request, runtime) {
6901
8179
  tea_util_1.default.validateModel(request);
6902
8180
  let query = {};
@@ -6925,10 +8203,27 @@ class Client extends openapi_client_1.default {
6925
8203
  });
6926
8204
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateUserMFAAuthenticationSettingsResponse({}));
6927
8205
  }
8206
+ /**
8207
+ * 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.
8208
+ * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
8209
+ * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
8210
+ *
8211
+ * @param request UpdateUserMFAAuthenticationSettingsRequest
8212
+ * @return UpdateUserMFAAuthenticationSettingsResponse
8213
+ */
6928
8214
  async updateUserMFAAuthenticationSettings(request) {
6929
8215
  let runtime = new $Util.RuntimeOptions({});
6930
8216
  return await this.updateUserMFAAuthenticationSettingsWithOptions(request, runtime);
6931
8217
  }
8218
+ /**
8219
+ * 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.
8220
+ * ## Limits
8221
+ * 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.
8222
+ *
8223
+ * @param request UpdateUserStatusRequest
8224
+ * @param runtime runtime options for this request RuntimeOptions
8225
+ * @return UpdateUserStatusResponse
8226
+ */
6932
8227
  async updateUserStatusWithOptions(request, runtime) {
6933
8228
  tea_util_1.default.validateModel(request);
6934
8229
  let query = {};
@@ -6957,6 +8252,14 @@ class Client extends openapi_client_1.default {
6957
8252
  });
6958
8253
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateUserStatusResponse({}));
6959
8254
  }
8255
+ /**
8256
+ * 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.
8257
+ * ## Limits
8258
+ * 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.
8259
+ *
8260
+ * @param request UpdateUserStatusRequest
8261
+ * @return UpdateUserStatusResponse
8262
+ */
6960
8263
  async updateUserStatus(request) {
6961
8264
  let runtime = new $Util.RuntimeOptions({});
6962
8265
  return await this.updateUserStatusWithOptions(request, runtime);