@alicloud/cloudsso20210515 1.5.0 → 1.5.1

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
@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
15
15
  }) : function(o, v) {
16
16
  o["default"] = v;
17
17
  });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
25
35
  var __importDefault = (this && this.__importDefault) || function (mod) {
26
36
  return (mod && mod.__esModule) ? mod : { "default": mod };
27
37
  };
@@ -35,7 +45,6 @@ exports.UpdateAccessConfigurationResponseBodyAccessConfiguration = exports.SetEx
35
45
  exports.UpdateUserProvisioningConfigurationResponseBodyUserProvisioningConfiguration = exports.UpdateUserProvisioningResponseBodyUserProvisioning = exports.UpdateUserResponseBodyUser = exports.UpdateSCIMServerCredentialStatusResponseBodySCIMServerCredential = exports.UpdateGroupResponseBodyGroup = exports.UpdateDirectoryResponseBodyDirectory = void 0;
36
46
  // This file is auto-generated, don't edit it
37
47
  /**
38
- *
39
48
  */
40
49
  const tea_util_1 = __importStar(require("@alicloud/tea-util")), $Util = tea_util_1;
41
50
  const openapi_client_1 = __importStar(require("@alicloud/openapi-client")), $OpenApi = openapi_client_1;
@@ -4041,6 +4050,7 @@ exports.RetryUserProvisioningEventResponse = RetryUserProvisioningEventResponse;
4041
4050
  class SetExternalSAMLIdentityProviderRequest extends $tea.Model {
4042
4051
  static names() {
4043
4052
  return {
4053
+ bindingType: 'BindingType',
4044
4054
  directoryId: 'DirectoryId',
4045
4055
  encodedMetadataDocument: 'EncodedMetadataDocument',
4046
4056
  entityId: 'EntityId',
@@ -4052,6 +4062,7 @@ class SetExternalSAMLIdentityProviderRequest extends $tea.Model {
4052
4062
  }
4053
4063
  static types() {
4054
4064
  return {
4065
+ bindingType: 'string',
4055
4066
  directoryId: 'string',
4056
4067
  encodedMetadataDocument: 'string',
4057
4068
  entityId: 'string',
@@ -4107,12 +4118,14 @@ exports.SetExternalSAMLIdentityProviderResponse = SetExternalSAMLIdentityProvide
4107
4118
  class SetLoginPreferenceRequest extends $tea.Model {
4108
4119
  static names() {
4109
4120
  return {
4121
+ allowUserToGetCredentials: 'AllowUserToGetCredentials',
4110
4122
  directoryId: 'DirectoryId',
4111
4123
  loginNetworkMasks: 'LoginNetworkMasks',
4112
4124
  };
4113
4125
  }
4114
4126
  static types() {
4115
4127
  return {
4128
+ allowUserToGetCredentials: 'boolean',
4116
4129
  directoryId: 'string',
4117
4130
  loginNetworkMasks: 'string',
4118
4131
  };
@@ -5413,6 +5426,7 @@ exports.GetDirectoryStatisticsResponseBodyDirectoryStatistics = GetDirectoryStat
5413
5426
  class GetExternalSAMLIdentityProviderResponseBodySAMLIdentityProviderConfiguration extends $tea.Model {
5414
5427
  static names() {
5415
5428
  return {
5429
+ bindingType: 'BindingType',
5416
5430
  certificateIds: 'CertificateIds',
5417
5431
  createTime: 'CreateTime',
5418
5432
  directoryId: 'DirectoryId',
@@ -5426,6 +5440,7 @@ class GetExternalSAMLIdentityProviderResponseBodySAMLIdentityProviderConfigurati
5426
5440
  }
5427
5441
  static types() {
5428
5442
  return {
5443
+ bindingType: 'string',
5429
5444
  certificateIds: { 'type': 'array', 'itemType': 'string' },
5430
5445
  createTime: 'string',
5431
5446
  directoryId: 'string',
@@ -5471,11 +5486,13 @@ exports.GetGroupResponseBodyGroup = GetGroupResponseBodyGroup;
5471
5486
  class GetLoginPreferenceResponseBodyLoginPreference extends $tea.Model {
5472
5487
  static names() {
5473
5488
  return {
5489
+ allowUserToGetCredentials: 'AllowUserToGetCredentials',
5474
5490
  loginNetworkMasks: 'LoginNetworkMasks',
5475
5491
  };
5476
5492
  }
5477
5493
  static types() {
5478
5494
  return {
5495
+ allowUserToGetCredentials: 'boolean',
5479
5496
  loginNetworkMasks: 'string',
5480
5497
  };
5481
5498
  }
@@ -6435,6 +6452,7 @@ exports.ProvisionAccessConfigurationResponseBodyTasks = ProvisionAccessConfigura
6435
6452
  class SetExternalSAMLIdentityProviderResponseBodySAMLIdentityProviderConfiguration extends $tea.Model {
6436
6453
  static names() {
6437
6454
  return {
6455
+ bindingType: 'BindingType',
6438
6456
  certificateIds: 'CertificateIds',
6439
6457
  createTime: 'CreateTime',
6440
6458
  directoryId: 'DirectoryId',
@@ -6448,6 +6466,7 @@ class SetExternalSAMLIdentityProviderResponseBodySAMLIdentityProviderConfigurati
6448
6466
  }
6449
6467
  static types() {
6450
6468
  return {
6469
+ bindingType: 'string',
6451
6470
  certificateIds: { 'type': 'array', 'itemType': 'string' },
6452
6471
  createTime: 'string',
6453
6472
  directoryId: 'string',
@@ -6693,14 +6712,15 @@ class Client extends openapi_client_1.default {
6693
6712
  return endpoint_util_1.default.getEndpointRules(productId, regionId, endpointRule, network, suffix);
6694
6713
  }
6695
6714
  /**
6696
- * @summary Adds a Security Assertion Markup Language (SAML) signing certificate.
6715
+ * Adds a Security Assertion Markup Language (SAML) signing certificate.
6697
6716
  *
6698
- * @description You can add up to two SAML signing certificates.
6717
+ * @remarks
6718
+ * You can add up to two SAML signing certificates.
6699
6719
  * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
6700
6720
  *
6701
- * @param request AddExternalSAMLIdPCertificateRequest
6702
- * @param runtime runtime options for this request RuntimeOptions
6703
- * @return AddExternalSAMLIdPCertificateResponse
6721
+ * @param request - AddExternalSAMLIdPCertificateRequest
6722
+ * @param runtime - runtime options for this request RuntimeOptions
6723
+ * @returns AddExternalSAMLIdPCertificateResponse
6704
6724
  */
6705
6725
  async addExternalSAMLIdPCertificateWithOptions(request, runtime) {
6706
6726
  tea_util_1.default.validateModel(request);
@@ -6728,26 +6748,28 @@ class Client extends openapi_client_1.default {
6728
6748
  return $tea.cast(await this.callApi(params, req, runtime), new AddExternalSAMLIdPCertificateResponse({}));
6729
6749
  }
6730
6750
  /**
6731
- * @summary Adds a Security Assertion Markup Language (SAML) signing certificate.
6751
+ * Adds a Security Assertion Markup Language (SAML) signing certificate.
6732
6752
  *
6733
- * @description You can add up to two SAML signing certificates.
6753
+ * @remarks
6754
+ * You can add up to two SAML signing certificates.
6734
6755
  * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
6735
6756
  *
6736
- * @param request AddExternalSAMLIdPCertificateRequest
6737
- * @return AddExternalSAMLIdPCertificateResponse
6757
+ * @param request - AddExternalSAMLIdPCertificateRequest
6758
+ * @returns AddExternalSAMLIdPCertificateResponse
6738
6759
  */
6739
6760
  async addExternalSAMLIdPCertificate(request) {
6740
6761
  let runtime = new $Util.RuntimeOptions({});
6741
6762
  return await this.addExternalSAMLIdPCertificateWithOptions(request, runtime);
6742
6763
  }
6743
6764
  /**
6744
- * @summary Adds a policy to an access configuration.
6765
+ * Adds a policy to an access configuration.
6745
6766
  *
6746
- * @description This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
6767
+ * @remarks
6768
+ * This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
6747
6769
  *
6748
- * @param request AddPermissionPolicyToAccessConfigurationRequest
6749
- * @param runtime runtime options for this request RuntimeOptions
6750
- * @return AddPermissionPolicyToAccessConfigurationResponse
6770
+ * @param request - AddPermissionPolicyToAccessConfigurationRequest
6771
+ * @param runtime - runtime options for this request RuntimeOptions
6772
+ * @returns AddPermissionPolicyToAccessConfigurationResponse
6751
6773
  */
6752
6774
  async addPermissionPolicyToAccessConfigurationWithOptions(request, runtime) {
6753
6775
  tea_util_1.default.validateModel(request);
@@ -6784,26 +6806,28 @@ class Client extends openapi_client_1.default {
6784
6806
  return $tea.cast(await this.callApi(params, req, runtime), new AddPermissionPolicyToAccessConfigurationResponse({}));
6785
6807
  }
6786
6808
  /**
6787
- * @summary Adds a policy to an access configuration.
6809
+ * Adds a policy to an access configuration.
6788
6810
  *
6789
- * @description This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
6811
+ * @remarks
6812
+ * This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
6790
6813
  *
6791
- * @param request AddPermissionPolicyToAccessConfigurationRequest
6792
- * @return AddPermissionPolicyToAccessConfigurationResponse
6814
+ * @param request - AddPermissionPolicyToAccessConfigurationRequest
6815
+ * @returns AddPermissionPolicyToAccessConfigurationResponse
6793
6816
  */
6794
6817
  async addPermissionPolicyToAccessConfiguration(request) {
6795
6818
  let runtime = new $Util.RuntimeOptions({});
6796
6819
  return await this.addPermissionPolicyToAccessConfigurationWithOptions(request, runtime);
6797
6820
  }
6798
6821
  /**
6799
- * @summary Adds a user to a group.
6822
+ * Adds a user to a group.
6800
6823
  *
6801
- * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot add a user to a group that is synchronized by using SCIM.
6824
+ * @remarks
6825
+ * 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.
6802
6826
  * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
6803
6827
  *
6804
- * @param request AddUserToGroupRequest
6805
- * @param runtime runtime options for this request RuntimeOptions
6806
- * @return AddUserToGroupResponse
6828
+ * @param request - AddUserToGroupRequest
6829
+ * @param runtime - runtime options for this request RuntimeOptions
6830
+ * @returns AddUserToGroupResponse
6807
6831
  */
6808
6832
  async addUserToGroupWithOptions(request, runtime) {
6809
6833
  tea_util_1.default.validateModel(request);
@@ -6834,27 +6858,29 @@ class Client extends openapi_client_1.default {
6834
6858
  return $tea.cast(await this.callApi(params, req, runtime), new AddUserToGroupResponse({}));
6835
6859
  }
6836
6860
  /**
6837
- * @summary Adds a user to a group.
6861
+ * Adds a user to a group.
6838
6862
  *
6839
- * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot add a user to a group that is synchronized by using SCIM.
6863
+ * @remarks
6864
+ * 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.
6840
6865
  * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
6841
6866
  *
6842
- * @param request AddUserToGroupRequest
6843
- * @return AddUserToGroupResponse
6867
+ * @param request - AddUserToGroupRequest
6868
+ * @returns AddUserToGroupResponse
6844
6869
  */
6845
6870
  async addUserToGroup(request) {
6846
6871
  let runtime = new $Util.RuntimeOptions({});
6847
6872
  return await this.addUserToGroupWithOptions(request, runtime);
6848
6873
  }
6849
6874
  /**
6850
- * @summary Clears the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
6875
+ * Clears the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
6851
6876
  *
6852
- * @description If single sign-on (SSO) logon is disabled, you can clear the configurations of a SAML IdP. If SSO logon is enabled, you cannot clear the configurations.
6877
+ * @remarks
6878
+ * 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.
6853
6879
  * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
6854
6880
  *
6855
- * @param request ClearExternalSAMLIdentityProviderRequest
6856
- * @param runtime runtime options for this request RuntimeOptions
6857
- * @return ClearExternalSAMLIdentityProviderResponse
6881
+ * @param request - ClearExternalSAMLIdentityProviderRequest
6882
+ * @param runtime - runtime options for this request RuntimeOptions
6883
+ * @returns ClearExternalSAMLIdentityProviderResponse
6858
6884
  */
6859
6885
  async clearExternalSAMLIdentityProviderWithOptions(request, runtime) {
6860
6886
  tea_util_1.default.validateModel(request);
@@ -6879,28 +6905,30 @@ class Client extends openapi_client_1.default {
6879
6905
  return $tea.cast(await this.callApi(params, req, runtime), new ClearExternalSAMLIdentityProviderResponse({}));
6880
6906
  }
6881
6907
  /**
6882
- * @summary Clears the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
6908
+ * Clears the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
6883
6909
  *
6884
- * @description If single sign-on (SSO) logon is disabled, you can clear the configurations of a SAML IdP. If SSO logon is enabled, you cannot clear the configurations.
6910
+ * @remarks
6911
+ * 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.
6885
6912
  * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
6886
6913
  *
6887
- * @param request ClearExternalSAMLIdentityProviderRequest
6888
- * @return ClearExternalSAMLIdentityProviderResponse
6914
+ * @param request - ClearExternalSAMLIdentityProviderRequest
6915
+ * @returns ClearExternalSAMLIdentityProviderResponse
6889
6916
  */
6890
6917
  async clearExternalSAMLIdentityProvider(request) {
6891
6918
  let runtime = new $Util.RuntimeOptions({});
6892
6919
  return await this.clearExternalSAMLIdentityProviderWithOptions(request, runtime);
6893
6920
  }
6894
6921
  /**
6895
- * @summary Assigns access permissions on an account in your resource directory to a user or a group by using an access configuration.
6922
+ * Assigns access permissions on an account in your resource directory to a user or a group by using an access configuration.
6896
6923
  *
6897
- * @description When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
6924
+ * @remarks
6925
+ * When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
6898
6926
  * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](https://help.aliyun.com/document_detail/266726.html).
6899
6927
  * 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.
6900
6928
  *
6901
- * @param request CreateAccessAssignmentRequest
6902
- * @param runtime runtime options for this request RuntimeOptions
6903
- * @return CreateAccessAssignmentResponse
6929
+ * @param request - CreateAccessAssignmentRequest
6930
+ * @param runtime - runtime options for this request RuntimeOptions
6931
+ * @returns CreateAccessAssignmentResponse
6904
6932
  */
6905
6933
  async createAccessAssignmentWithOptions(request, runtime) {
6906
6934
  tea_util_1.default.validateModel(request);
@@ -6940,28 +6968,30 @@ class Client extends openapi_client_1.default {
6940
6968
  return $tea.cast(await this.callApi(params, req, runtime), new CreateAccessAssignmentResponse({}));
6941
6969
  }
6942
6970
  /**
6943
- * @summary Assigns access permissions on an account in your resource directory to a user or a group by using an access configuration.
6971
+ * Assigns access permissions on an account in your resource directory to a user or a group by using an access configuration.
6944
6972
  *
6945
- * @description When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
6973
+ * @remarks
6974
+ * When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
6946
6975
  * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](https://help.aliyun.com/document_detail/266726.html).
6947
6976
  * 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.
6948
6977
  *
6949
- * @param request CreateAccessAssignmentRequest
6950
- * @return CreateAccessAssignmentResponse
6978
+ * @param request - CreateAccessAssignmentRequest
6979
+ * @returns CreateAccessAssignmentResponse
6951
6980
  */
6952
6981
  async createAccessAssignment(request) {
6953
6982
  let runtime = new $Util.RuntimeOptions({});
6954
6983
  return await this.createAccessAssignmentWithOptions(request, runtime);
6955
6984
  }
6956
6985
  /**
6957
- * @summary Creates an access configuration.
6986
+ * Creates an access configuration.
6958
6987
  *
6959
- * @description For more information about access configurations, see [Overview of access configurations](https://help.aliyun.com/document_detail/266737.html).
6988
+ * @remarks
6989
+ * For more information about access configurations, see [Overview of access configurations](https://help.aliyun.com/document_detail/266737.html).
6960
6990
  * This topic provides an example on how to create an access configuration named `ECS-Admin`.
6961
6991
  *
6962
- * @param request CreateAccessConfigurationRequest
6963
- * @param runtime runtime options for this request RuntimeOptions
6964
- * @return CreateAccessConfigurationResponse
6992
+ * @param request - CreateAccessConfigurationRequest
6993
+ * @param runtime - runtime options for this request RuntimeOptions
6994
+ * @returns CreateAccessConfigurationResponse
6965
6995
  */
6966
6996
  async createAccessConfigurationWithOptions(request, runtime) {
6967
6997
  tea_util_1.default.validateModel(request);
@@ -6998,31 +7028,33 @@ class Client extends openapi_client_1.default {
6998
7028
  return $tea.cast(await this.callApi(params, req, runtime), new CreateAccessConfigurationResponse({}));
6999
7029
  }
7000
7030
  /**
7001
- * @summary Creates an access configuration.
7031
+ * Creates an access configuration.
7002
7032
  *
7003
- * @description For more information about access configurations, see [Overview of access configurations](https://help.aliyun.com/document_detail/266737.html).
7033
+ * @remarks
7034
+ * For more information about access configurations, see [Overview of access configurations](https://help.aliyun.com/document_detail/266737.html).
7004
7035
  * This topic provides an example on how to create an access configuration named `ECS-Admin`.
7005
7036
  *
7006
- * @param request CreateAccessConfigurationRequest
7007
- * @return CreateAccessConfigurationResponse
7037
+ * @param request - CreateAccessConfigurationRequest
7038
+ * @returns CreateAccessConfigurationResponse
7008
7039
  */
7009
7040
  async createAccessConfiguration(request) {
7010
7041
  let runtime = new $Util.RuntimeOptions({});
7011
7042
  return await this.createAccessConfigurationWithOptions(request, runtime);
7012
7043
  }
7013
7044
  /**
7014
- * @summary Creates a directory.
7045
+ * Creates a directory.
7015
7046
  *
7016
- * @description A directory is a CloudSSO instance. Before you can use CloudSSO, you must create a directory. The directory is used to manage all CloudSSO resources.
7047
+ * @remarks
7048
+ * 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.
7017
7049
  * 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.
7018
7050
  * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
7019
7051
  * ## Limits
7020
7052
  * - You can create only one directory for a management account.
7021
7053
  * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
7022
7054
  *
7023
- * @param request CreateDirectoryRequest
7024
- * @param runtime runtime options for this request RuntimeOptions
7025
- * @return CreateDirectoryResponse
7055
+ * @param request - CreateDirectoryRequest
7056
+ * @param runtime - runtime options for this request RuntimeOptions
7057
+ * @returns CreateDirectoryResponse
7026
7058
  */
7027
7059
  async createDirectoryWithOptions(request, runtime) {
7028
7060
  tea_util_1.default.validateModel(request);
@@ -7047,30 +7079,32 @@ class Client extends openapi_client_1.default {
7047
7079
  return $tea.cast(await this.callApi(params, req, runtime), new CreateDirectoryResponse({}));
7048
7080
  }
7049
7081
  /**
7050
- * @summary Creates a directory.
7082
+ * Creates a directory.
7051
7083
  *
7052
- * @description A directory is a CloudSSO instance. Before you can use CloudSSO, you must create a directory. The directory is used to manage all CloudSSO resources.
7084
+ * @remarks
7085
+ * 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.
7053
7086
  * 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.
7054
7087
  * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
7055
7088
  * ## Limits
7056
7089
  * - You can create only one directory for a management account.
7057
7090
  * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
7058
7091
  *
7059
- * @param request CreateDirectoryRequest
7060
- * @return CreateDirectoryResponse
7092
+ * @param request - CreateDirectoryRequest
7093
+ * @returns CreateDirectoryResponse
7061
7094
  */
7062
7095
  async createDirectory(request) {
7063
7096
  let runtime = new $Util.RuntimeOptions({});
7064
7097
  return await this.createDirectoryWithOptions(request, runtime);
7065
7098
  }
7066
7099
  /**
7067
- * @summary Creates a group.
7100
+ * Creates a group.
7068
7101
  *
7069
- * @description This topic provides an example on how to create a group named `TestGroup`.
7102
+ * @remarks
7103
+ * This topic provides an example on how to create a group named `TestGroup`.
7070
7104
  *
7071
- * @param request CreateGroupRequest
7072
- * @param runtime runtime options for this request RuntimeOptions
7073
- * @return CreateGroupResponse
7105
+ * @param request - CreateGroupRequest
7106
+ * @param runtime - runtime options for this request RuntimeOptions
7107
+ * @returns CreateGroupResponse
7074
7108
  */
7075
7109
  async createGroupWithOptions(request, runtime) {
7076
7110
  tea_util_1.default.validateModel(request);
@@ -7101,26 +7135,28 @@ class Client extends openapi_client_1.default {
7101
7135
  return $tea.cast(await this.callApi(params, req, runtime), new CreateGroupResponse({}));
7102
7136
  }
7103
7137
  /**
7104
- * @summary Creates a group.
7138
+ * Creates a group.
7105
7139
  *
7106
- * @description This topic provides an example on how to create a group named `TestGroup`.
7140
+ * @remarks
7141
+ * This topic provides an example on how to create a group named `TestGroup`.
7107
7142
  *
7108
- * @param request CreateGroupRequest
7109
- * @return CreateGroupResponse
7143
+ * @param request - CreateGroupRequest
7144
+ * @returns CreateGroupResponse
7110
7145
  */
7111
7146
  async createGroup(request) {
7112
7147
  let runtime = new $Util.RuntimeOptions({});
7113
7148
  return await this.createGroupWithOptions(request, runtime);
7114
7149
  }
7115
7150
  /**
7116
- * @summary Creates a Cross-domain Identity Management (SCIM) credential.
7151
+ * Creates a Cross-domain Identity Management (SCIM) credential.
7117
7152
  *
7118
- * @description SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
7153
+ * @remarks
7154
+ * SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
7119
7155
  * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
7120
7156
  *
7121
- * @param request CreateSCIMServerCredentialRequest
7122
- * @param runtime runtime options for this request RuntimeOptions
7123
- * @return CreateSCIMServerCredentialResponse
7157
+ * @param request - CreateSCIMServerCredentialRequest
7158
+ * @param runtime - runtime options for this request RuntimeOptions
7159
+ * @returns CreateSCIMServerCredentialResponse
7124
7160
  */
7125
7161
  async createSCIMServerCredentialWithOptions(request, runtime) {
7126
7162
  tea_util_1.default.validateModel(request);
@@ -7145,26 +7181,28 @@ class Client extends openapi_client_1.default {
7145
7181
  return $tea.cast(await this.callApi(params, req, runtime), new CreateSCIMServerCredentialResponse({}));
7146
7182
  }
7147
7183
  /**
7148
- * @summary Creates a Cross-domain Identity Management (SCIM) credential.
7184
+ * Creates a Cross-domain Identity Management (SCIM) credential.
7149
7185
  *
7150
- * @description SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
7186
+ * @remarks
7187
+ * SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
7151
7188
  * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
7152
7189
  *
7153
- * @param request CreateSCIMServerCredentialRequest
7154
- * @return CreateSCIMServerCredentialResponse
7190
+ * @param request - CreateSCIMServerCredentialRequest
7191
+ * @returns CreateSCIMServerCredentialResponse
7155
7192
  */
7156
7193
  async createSCIMServerCredential(request) {
7157
7194
  let runtime = new $Util.RuntimeOptions({});
7158
7195
  return await this.createSCIMServerCredentialWithOptions(request, runtime);
7159
7196
  }
7160
7197
  /**
7161
- * @summary Creates a user.
7198
+ * Creates a user.
7162
7199
  *
7163
- * @description This topic provides an example on how to create a user named `Alice`.
7200
+ * @remarks
7201
+ * This topic provides an example on how to create a user named `Alice`.
7164
7202
  *
7165
- * @param request CreateUserRequest
7166
- * @param runtime runtime options for this request RuntimeOptions
7167
- * @return CreateUserResponse
7203
+ * @param request - CreateUserRequest
7204
+ * @param runtime - runtime options for this request RuntimeOptions
7205
+ * @returns CreateUserResponse
7168
7206
  */
7169
7207
  async createUserWithOptions(request, runtime) {
7170
7208
  tea_util_1.default.validateModel(request);
@@ -7210,23 +7248,27 @@ class Client extends openapi_client_1.default {
7210
7248
  return $tea.cast(await this.callApi(params, req, runtime), new CreateUserResponse({}));
7211
7249
  }
7212
7250
  /**
7213
- * @summary Creates a user.
7251
+ * Creates a user.
7214
7252
  *
7215
- * @description This topic provides an example on how to create a user named `Alice`.
7253
+ * @remarks
7254
+ * This topic provides an example on how to create a user named `Alice`.
7216
7255
  *
7217
- * @param request CreateUserRequest
7218
- * @return CreateUserResponse
7256
+ * @param request - CreateUserRequest
7257
+ * @returns CreateUserResponse
7219
7258
  */
7220
7259
  async createUser(request) {
7221
7260
  let runtime = new $Util.RuntimeOptions({});
7222
7261
  return await this.createUserWithOptions(request, runtime);
7223
7262
  }
7224
7263
  /**
7225
- * @summary Creates a Resource Access Management (RAM) user provisioning.
7264
+ * Creates a Resource Access Management (RAM) user provisioning.
7265
+ *
7266
+ * @remarks
7267
+ * You can create a RAM user provisioning for a member in your resource directory to create a RAM user that has the same username as a CloudSSO user. This way, the CloudSSO user can access the resources of the member as the RAM user.
7226
7268
  *
7227
- * @param request CreateUserProvisioningRequest
7228
- * @param runtime runtime options for this request RuntimeOptions
7229
- * @return CreateUserProvisioningResponse
7269
+ * @param request - CreateUserProvisioningRequest
7270
+ * @param runtime - runtime options for this request RuntimeOptions
7271
+ * @returns CreateUserProvisioningResponse
7230
7272
  */
7231
7273
  async createUserProvisioningWithOptions(request, runtime) {
7232
7274
  tea_util_1.default.validateModel(request);
@@ -7272,24 +7314,28 @@ class Client extends openapi_client_1.default {
7272
7314
  return $tea.cast(await this.callApi(params, req, runtime), new CreateUserProvisioningResponse({}));
7273
7315
  }
7274
7316
  /**
7275
- * @summary Creates a Resource Access Management (RAM) user provisioning.
7317
+ * Creates a Resource Access Management (RAM) user provisioning.
7276
7318
  *
7277
- * @param request CreateUserProvisioningRequest
7278
- * @return CreateUserProvisioningResponse
7319
+ * @remarks
7320
+ * You can create a RAM user provisioning for a member in your resource directory to create a RAM user that has the same username as a CloudSSO user. This way, the CloudSSO user can access the resources of the member as the RAM user.
7321
+ *
7322
+ * @param request - CreateUserProvisioningRequest
7323
+ * @returns CreateUserProvisioningResponse
7279
7324
  */
7280
7325
  async createUserProvisioning(request) {
7281
7326
  let runtime = new $Util.RuntimeOptions({});
7282
7327
  return await this.createUserProvisioningWithOptions(request, runtime);
7283
7328
  }
7284
7329
  /**
7285
- * @summary Removes the access permissions on an account in a resource directory.
7330
+ * Removes the access permissions on an account in a resource directory.
7286
7331
  *
7287
- * @description When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
7332
+ * @remarks
7333
+ * When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
7288
7334
  * 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****`.
7289
7335
  *
7290
- * @param request DeleteAccessAssignmentRequest
7291
- * @param runtime runtime options for this request RuntimeOptions
7292
- * @return DeleteAccessAssignmentResponse
7336
+ * @param request - DeleteAccessAssignmentRequest
7337
+ * @param runtime - runtime options for this request RuntimeOptions
7338
+ * @returns DeleteAccessAssignmentResponse
7293
7339
  */
7294
7340
  async deleteAccessAssignmentWithOptions(request, runtime) {
7295
7341
  tea_util_1.default.validateModel(request);
@@ -7332,28 +7378,30 @@ class Client extends openapi_client_1.default {
7332
7378
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteAccessAssignmentResponse({}));
7333
7379
  }
7334
7380
  /**
7335
- * @summary Removes the access permissions on an account in a resource directory.
7381
+ * Removes the access permissions on an account in a resource directory.
7336
7382
  *
7337
- * @description When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
7383
+ * @remarks
7384
+ * When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
7338
7385
  * 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****`.
7339
7386
  *
7340
- * @param request DeleteAccessAssignmentRequest
7341
- * @return DeleteAccessAssignmentResponse
7387
+ * @param request - DeleteAccessAssignmentRequest
7388
+ * @returns DeleteAccessAssignmentResponse
7342
7389
  */
7343
7390
  async deleteAccessAssignment(request) {
7344
7391
  let runtime = new $Util.RuntimeOptions({});
7345
7392
  return await this.deleteAccessAssignmentWithOptions(request, runtime);
7346
7393
  }
7347
7394
  /**
7348
- * @summary Deletes an access configuration.
7395
+ * Deletes an access configuration.
7349
7396
  *
7350
- * @description This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
7397
+ * @remarks
7398
+ * This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
7351
7399
  * ## Prerequisites
7352
7400
  * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](https://help.aliyun.com/document_detail/338352.html).
7353
7401
  *
7354
- * @param request DeleteAccessConfigurationRequest
7355
- * @param runtime runtime options for this request RuntimeOptions
7356
- * @return DeleteAccessConfigurationResponse
7402
+ * @param request - DeleteAccessConfigurationRequest
7403
+ * @param runtime - runtime options for this request RuntimeOptions
7404
+ * @returns DeleteAccessConfigurationResponse
7357
7405
  */
7358
7406
  async deleteAccessConfigurationWithOptions(request, runtime) {
7359
7407
  tea_util_1.default.validateModel(request);
@@ -7384,23 +7432,25 @@ class Client extends openapi_client_1.default {
7384
7432
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteAccessConfigurationResponse({}));
7385
7433
  }
7386
7434
  /**
7387
- * @summary Deletes an access configuration.
7435
+ * Deletes an access configuration.
7388
7436
  *
7389
- * @description This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
7437
+ * @remarks
7438
+ * This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
7390
7439
  * ## Prerequisites
7391
7440
  * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](https://help.aliyun.com/document_detail/338352.html).
7392
7441
  *
7393
- * @param request DeleteAccessConfigurationRequest
7394
- * @return DeleteAccessConfigurationResponse
7442
+ * @param request - DeleteAccessConfigurationRequest
7443
+ * @returns DeleteAccessConfigurationResponse
7395
7444
  */
7396
7445
  async deleteAccessConfiguration(request) {
7397
7446
  let runtime = new $Util.RuntimeOptions({});
7398
7447
  return await this.deleteAccessConfigurationWithOptions(request, runtime);
7399
7448
  }
7400
7449
  /**
7401
- * @summary Deletes a directory.
7450
+ * Deletes a directory.
7402
7451
  *
7403
- * @description This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
7452
+ * @remarks
7453
+ * This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
7404
7454
  * ## Prerequisites
7405
7455
  * No resources are contained in the directory that you want to delete.
7406
7456
  * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
@@ -7410,9 +7460,9 @@ class Client extends openapi_client_1.default {
7410
7460
  * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](https://help.aliyun.com/document_detail/341842.html).
7411
7461
  * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](https://help.aliyun.com/document_detail/341573.html).
7412
7462
  *
7413
- * @param request DeleteDirectoryRequest
7414
- * @param runtime runtime options for this request RuntimeOptions
7415
- * @return DeleteDirectoryResponse
7463
+ * @param request - DeleteDirectoryRequest
7464
+ * @param runtime - runtime options for this request RuntimeOptions
7465
+ * @returns DeleteDirectoryResponse
7416
7466
  */
7417
7467
  async deleteDirectoryWithOptions(request, runtime) {
7418
7468
  tea_util_1.default.validateModel(request);
@@ -7437,9 +7487,10 @@ class Client extends openapi_client_1.default {
7437
7487
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteDirectoryResponse({}));
7438
7488
  }
7439
7489
  /**
7440
- * @summary Deletes a directory.
7490
+ * Deletes a directory.
7441
7491
  *
7442
- * @description This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
7492
+ * @remarks
7493
+ * This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
7443
7494
  * ## Prerequisites
7444
7495
  * No resources are contained in the directory that you want to delete.
7445
7496
  * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
@@ -7449,25 +7500,26 @@ class Client extends openapi_client_1.default {
7449
7500
  * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](https://help.aliyun.com/document_detail/341842.html).
7450
7501
  * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](https://help.aliyun.com/document_detail/341573.html).
7451
7502
  *
7452
- * @param request DeleteDirectoryRequest
7453
- * @return DeleteDirectoryResponse
7503
+ * @param request - DeleteDirectoryRequest
7504
+ * @returns DeleteDirectoryResponse
7454
7505
  */
7455
7506
  async deleteDirectory(request) {
7456
7507
  let runtime = new $Util.RuntimeOptions({});
7457
7508
  return await this.deleteDirectoryWithOptions(request, runtime);
7458
7509
  }
7459
7510
  /**
7460
- * @summary Deletes a group.
7511
+ * Deletes a group.
7461
7512
  *
7462
- * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
7513
+ * @remarks
7514
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
7463
7515
  * ## Prerequisites
7464
7516
  * 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.
7465
7517
  * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
7466
7518
  * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
7467
7519
  *
7468
- * @param request DeleteGroupRequest
7469
- * @param runtime runtime options for this request RuntimeOptions
7470
- * @return DeleteGroupResponse
7520
+ * @param request - DeleteGroupRequest
7521
+ * @param runtime - runtime options for this request RuntimeOptions
7522
+ * @returns DeleteGroupResponse
7471
7523
  */
7472
7524
  async deleteGroupWithOptions(request, runtime) {
7473
7525
  tea_util_1.default.validateModel(request);
@@ -7495,29 +7547,31 @@ class Client extends openapi_client_1.default {
7495
7547
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteGroupResponse({}));
7496
7548
  }
7497
7549
  /**
7498
- * @summary Deletes a group.
7550
+ * Deletes a group.
7499
7551
  *
7500
- * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
7552
+ * @remarks
7553
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
7501
7554
  * ## Prerequisites
7502
7555
  * 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.
7503
7556
  * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
7504
7557
  * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
7505
7558
  *
7506
- * @param request DeleteGroupRequest
7507
- * @return DeleteGroupResponse
7559
+ * @param request - DeleteGroupRequest
7560
+ * @returns DeleteGroupResponse
7508
7561
  */
7509
7562
  async deleteGroup(request) {
7510
7563
  let runtime = new $Util.RuntimeOptions({});
7511
7564
  return await this.deleteGroupWithOptions(request, runtime);
7512
7565
  }
7513
7566
  /**
7514
- * @summary Unbinds a multi-factor authentication (MFA) device from a user.
7567
+ * Unbinds a multi-factor authentication (MFA) device from a user.
7515
7568
  *
7516
- * @description This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
7569
+ * @remarks
7570
+ * This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
7517
7571
  *
7518
- * @param request DeleteMFADeviceForUserRequest
7519
- * @param runtime runtime options for this request RuntimeOptions
7520
- * @return DeleteMFADeviceForUserResponse
7572
+ * @param request - DeleteMFADeviceForUserRequest
7573
+ * @param runtime - runtime options for this request RuntimeOptions
7574
+ * @returns DeleteMFADeviceForUserResponse
7521
7575
  */
7522
7576
  async deleteMFADeviceForUserWithOptions(request, runtime) {
7523
7577
  tea_util_1.default.validateModel(request);
@@ -7548,26 +7602,28 @@ class Client extends openapi_client_1.default {
7548
7602
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteMFADeviceForUserResponse({}));
7549
7603
  }
7550
7604
  /**
7551
- * @summary Unbinds a multi-factor authentication (MFA) device from a user.
7605
+ * Unbinds a multi-factor authentication (MFA) device from a user.
7552
7606
  *
7553
- * @description This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
7607
+ * @remarks
7608
+ * This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
7554
7609
  *
7555
- * @param request DeleteMFADeviceForUserRequest
7556
- * @return DeleteMFADeviceForUserResponse
7610
+ * @param request - DeleteMFADeviceForUserRequest
7611
+ * @returns DeleteMFADeviceForUserResponse
7557
7612
  */
7558
7613
  async deleteMFADeviceForUser(request) {
7559
7614
  let runtime = new $Util.RuntimeOptions({});
7560
7615
  return await this.deleteMFADeviceForUserWithOptions(request, runtime);
7561
7616
  }
7562
7617
  /**
7563
- * @summary Deletes a Cross-domain Identity Management (SCIM) credential.
7618
+ * Deletes a Cross-domain Identity Management (SCIM) credential.
7564
7619
  *
7565
- * @description After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
7620
+ * @remarks
7621
+ * After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
7566
7622
  * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
7567
7623
  *
7568
- * @param request DeleteSCIMServerCredentialRequest
7569
- * @param runtime runtime options for this request RuntimeOptions
7570
- * @return DeleteSCIMServerCredentialResponse
7624
+ * @param request - DeleteSCIMServerCredentialRequest
7625
+ * @param runtime - runtime options for this request RuntimeOptions
7626
+ * @returns DeleteSCIMServerCredentialResponse
7571
7627
  */
7572
7628
  async deleteSCIMServerCredentialWithOptions(request, runtime) {
7573
7629
  tea_util_1.default.validateModel(request);
@@ -7595,31 +7651,33 @@ class Client extends openapi_client_1.default {
7595
7651
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteSCIMServerCredentialResponse({}));
7596
7652
  }
7597
7653
  /**
7598
- * @summary Deletes a Cross-domain Identity Management (SCIM) credential.
7654
+ * Deletes a Cross-domain Identity Management (SCIM) credential.
7599
7655
  *
7600
- * @description After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
7656
+ * @remarks
7657
+ * After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
7601
7658
  * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
7602
7659
  *
7603
- * @param request DeleteSCIMServerCredentialRequest
7604
- * @return DeleteSCIMServerCredentialResponse
7660
+ * @param request - DeleteSCIMServerCredentialRequest
7661
+ * @returns DeleteSCIMServerCredentialResponse
7605
7662
  */
7606
7663
  async deleteSCIMServerCredential(request) {
7607
7664
  let runtime = new $Util.RuntimeOptions({});
7608
7665
  return await this.deleteSCIMServerCredentialWithOptions(request, runtime);
7609
7666
  }
7610
7667
  /**
7611
- * @summary Deletes a user.
7668
+ * Deletes a user.
7612
7669
  *
7613
- * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
7670
+ * @remarks
7671
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
7614
7672
  * ## Prerequisites
7615
7673
  * 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.
7616
7674
  * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](https://help.aliyun.com/document_detail/341675.html).
7617
7675
  * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
7618
7676
  * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
7619
7677
  *
7620
- * @param request DeleteUserRequest
7621
- * @param runtime runtime options for this request RuntimeOptions
7622
- * @return DeleteUserResponse
7678
+ * @param request - DeleteUserRequest
7679
+ * @param runtime - runtime options for this request RuntimeOptions
7680
+ * @returns DeleteUserResponse
7623
7681
  */
7624
7682
  async deleteUserWithOptions(request, runtime) {
7625
7683
  tea_util_1.default.validateModel(request);
@@ -7647,28 +7705,29 @@ class Client extends openapi_client_1.default {
7647
7705
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteUserResponse({}));
7648
7706
  }
7649
7707
  /**
7650
- * @summary Deletes a user.
7708
+ * Deletes a user.
7651
7709
  *
7652
- * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
7710
+ * @remarks
7711
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
7653
7712
  * ## Prerequisites
7654
7713
  * 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.
7655
7714
  * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](https://help.aliyun.com/document_detail/341675.html).
7656
7715
  * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
7657
7716
  * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
7658
7717
  *
7659
- * @param request DeleteUserRequest
7660
- * @return DeleteUserResponse
7718
+ * @param request - DeleteUserRequest
7719
+ * @returns DeleteUserResponse
7661
7720
  */
7662
7721
  async deleteUser(request) {
7663
7722
  let runtime = new $Util.RuntimeOptions({});
7664
7723
  return await this.deleteUserWithOptions(request, runtime);
7665
7724
  }
7666
7725
  /**
7667
- * @summary Deletes a Resource Access Management (RAM) user provisioning.
7726
+ * Deletes a Resource Access Management (RAM) user provisioning.
7668
7727
  *
7669
- * @param request DeleteUserProvisioningRequest
7670
- * @param runtime runtime options for this request RuntimeOptions
7671
- * @return DeleteUserProvisioningResponse
7728
+ * @param request - DeleteUserProvisioningRequest
7729
+ * @param runtime - runtime options for this request RuntimeOptions
7730
+ * @returns DeleteUserProvisioningResponse
7672
7731
  */
7673
7732
  async deleteUserProvisioningWithOptions(request, runtime) {
7674
7733
  tea_util_1.default.validateModel(request);
@@ -7699,21 +7758,21 @@ class Client extends openapi_client_1.default {
7699
7758
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteUserProvisioningResponse({}));
7700
7759
  }
7701
7760
  /**
7702
- * @summary Deletes a Resource Access Management (RAM) user provisioning.
7761
+ * Deletes a Resource Access Management (RAM) user provisioning.
7703
7762
  *
7704
- * @param request DeleteUserProvisioningRequest
7705
- * @return DeleteUserProvisioningResponse
7763
+ * @param request - DeleteUserProvisioningRequest
7764
+ * @returns DeleteUserProvisioningResponse
7706
7765
  */
7707
7766
  async deleteUserProvisioning(request) {
7708
7767
  let runtime = new $Util.RuntimeOptions({});
7709
7768
  return await this.deleteUserProvisioningWithOptions(request, runtime);
7710
7769
  }
7711
7770
  /**
7712
- * @summary Deletes a Resource Access Management (RAM) user provisioning event.
7771
+ * Deletes a Resource Access Management (RAM) user provisioning event.
7713
7772
  *
7714
- * @param request DeleteUserProvisioningEventRequest
7715
- * @param runtime runtime options for this request RuntimeOptions
7716
- * @return DeleteUserProvisioningEventResponse
7773
+ * @param request - DeleteUserProvisioningEventRequest
7774
+ * @param runtime - runtime options for this request RuntimeOptions
7775
+ * @returns DeleteUserProvisioningEventResponse
7717
7776
  */
7718
7777
  async deleteUserProvisioningEventWithOptions(request, runtime) {
7719
7778
  tea_util_1.default.validateModel(request);
@@ -7744,24 +7803,25 @@ class Client extends openapi_client_1.default {
7744
7803
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteUserProvisioningEventResponse({}));
7745
7804
  }
7746
7805
  /**
7747
- * @summary Deletes a Resource Access Management (RAM) user provisioning event.
7806
+ * Deletes a Resource Access Management (RAM) user provisioning event.
7748
7807
  *
7749
- * @param request DeleteUserProvisioningEventRequest
7750
- * @return DeleteUserProvisioningEventResponse
7808
+ * @param request - DeleteUserProvisioningEventRequest
7809
+ * @returns DeleteUserProvisioningEventResponse
7751
7810
  */
7752
7811
  async deleteUserProvisioningEvent(request) {
7753
7812
  let runtime = new $Util.RuntimeOptions({});
7754
7813
  return await this.deleteUserProvisioningEventWithOptions(request, runtime);
7755
7814
  }
7756
7815
  /**
7757
- * @summary De-provisions an access configuration from an account in your resource directory.
7816
+ * De-provisions an access configuration from an account in your resource directory.
7758
7817
  *
7759
- * @description When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
7818
+ * @remarks
7819
+ * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
7760
7820
  * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
7761
7821
  *
7762
- * @param request DeprovisionAccessConfigurationRequest
7763
- * @param runtime runtime options for this request RuntimeOptions
7764
- * @return DeprovisionAccessConfigurationResponse
7822
+ * @param request - DeprovisionAccessConfigurationRequest
7823
+ * @param runtime - runtime options for this request RuntimeOptions
7824
+ * @returns DeprovisionAccessConfigurationResponse
7765
7825
  */
7766
7826
  async deprovisionAccessConfigurationWithOptions(request, runtime) {
7767
7827
  tea_util_1.default.validateModel(request);
@@ -7795,24 +7855,25 @@ class Client extends openapi_client_1.default {
7795
7855
  return $tea.cast(await this.callApi(params, req, runtime), new DeprovisionAccessConfigurationResponse({}));
7796
7856
  }
7797
7857
  /**
7798
- * @summary De-provisions an access configuration from an account in your resource directory.
7858
+ * De-provisions an access configuration from an account in your resource directory.
7799
7859
  *
7800
- * @description When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
7860
+ * @remarks
7861
+ * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
7801
7862
  * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
7802
7863
  *
7803
- * @param request DeprovisionAccessConfigurationRequest
7804
- * @return DeprovisionAccessConfigurationResponse
7864
+ * @param request - DeprovisionAccessConfigurationRequest
7865
+ * @returns DeprovisionAccessConfigurationResponse
7805
7866
  */
7806
7867
  async deprovisionAccessConfiguration(request) {
7807
7868
  let runtime = new $Util.RuntimeOptions({});
7808
7869
  return await this.deprovisionAccessConfigurationWithOptions(request, runtime);
7809
7870
  }
7810
7871
  /**
7811
- * @summary DisableDelegateAccount
7872
+ * Disables the delegated administrator account of CloudSSO.
7812
7873
  *
7813
- * @param request DisableDelegateAccountRequest
7814
- * @param runtime runtime options for this request RuntimeOptions
7815
- * @return DisableDelegateAccountResponse
7874
+ * @param request - DisableDelegateAccountRequest
7875
+ * @param runtime - runtime options for this request RuntimeOptions
7876
+ * @returns DisableDelegateAccountResponse
7816
7877
  */
7817
7878
  async disableDelegateAccountWithOptions(request, runtime) {
7818
7879
  tea_util_1.default.validateModel(request);
@@ -7837,23 +7898,24 @@ class Client extends openapi_client_1.default {
7837
7898
  return $tea.cast(await this.callApi(params, req, runtime), new DisableDelegateAccountResponse({}));
7838
7899
  }
7839
7900
  /**
7840
- * @summary DisableDelegateAccount
7901
+ * Disables the delegated administrator account of CloudSSO.
7841
7902
  *
7842
- * @param request DisableDelegateAccountRequest
7843
- * @return DisableDelegateAccountResponse
7903
+ * @param request - DisableDelegateAccountRequest
7904
+ * @returns DisableDelegateAccountResponse
7844
7905
  */
7845
7906
  async disableDelegateAccount(request) {
7846
7907
  let runtime = new $Util.RuntimeOptions({});
7847
7908
  return await this.disableDelegateAccountWithOptions(request, runtime);
7848
7909
  }
7849
7910
  /**
7850
- * @summary Disables CloudSSO.
7911
+ * Disables CloudSSO.
7851
7912
  *
7852
- * @description If your CloudSSO has no directory, you can disable CloudSSO based on your business requirements. After you disable CloudSSO, you can enable it at any time.
7913
+ * @remarks
7914
+ * 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.
7853
7915
  *
7854
- * @param request DisableServiceRequest
7855
- * @param runtime runtime options for this request RuntimeOptions
7856
- * @return DisableServiceResponse
7916
+ * @param request - DisableServiceRequest
7917
+ * @param runtime - runtime options for this request RuntimeOptions
7918
+ * @returns DisableServiceResponse
7857
7919
  */
7858
7920
  async disableServiceWithOptions(runtime) {
7859
7921
  let req = new $OpenApi.OpenApiRequest({});
@@ -7871,22 +7933,26 @@ class Client extends openapi_client_1.default {
7871
7933
  return $tea.cast(await this.callApi(params, req, runtime), new DisableServiceResponse({}));
7872
7934
  }
7873
7935
  /**
7874
- * @summary Disables CloudSSO.
7875
- *
7876
- * @description If your CloudSSO has no directory, you can disable CloudSSO based on your business requirements. After you disable CloudSSO, you can enable it at any time.
7936
+ * Disables CloudSSO.
7877
7937
  *
7878
- * @return DisableServiceResponse
7938
+ * @remarks
7939
+ * 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.
7940
+ * @returns DisableServiceResponse
7879
7941
  */
7880
7942
  async disableService() {
7881
7943
  let runtime = new $Util.RuntimeOptions({});
7882
7944
  return await this.disableServiceWithOptions(runtime);
7883
7945
  }
7884
7946
  /**
7885
- * @summary EnableDelegateAccount
7947
+ * Enables the delegated administrator account of CloudSSO.
7886
7948
  *
7887
- * @param request EnableDelegateAccountRequest
7888
- * @param runtime runtime options for this request RuntimeOptions
7889
- * @return EnableDelegateAccountResponse
7949
+ * @remarks
7950
+ * You can use the management account of a resource directory to specify a member of the resource directory as the delegated administrator account of CloudSSO. For more information, see [Add a delegated administrator account](https://help.aliyun.com/document_detail/208117.html).
7951
+ * After the delegated administrator account of CloudSSO is specified, you can call this operation to enable the delegated administrator account of CloudSSO to manage CloudSSO resources.
7952
+ *
7953
+ * @param request - EnableDelegateAccountRequest
7954
+ * @param runtime - runtime options for this request RuntimeOptions
7955
+ * @returns EnableDelegateAccountResponse
7890
7956
  */
7891
7957
  async enableDelegateAccountWithOptions(request, runtime) {
7892
7958
  tea_util_1.default.validateModel(request);
@@ -7911,24 +7977,29 @@ class Client extends openapi_client_1.default {
7911
7977
  return $tea.cast(await this.callApi(params, req, runtime), new EnableDelegateAccountResponse({}));
7912
7978
  }
7913
7979
  /**
7914
- * @summary EnableDelegateAccount
7980
+ * Enables the delegated administrator account of CloudSSO.
7981
+ *
7982
+ * @remarks
7983
+ * You can use the management account of a resource directory to specify a member of the resource directory as the delegated administrator account of CloudSSO. For more information, see [Add a delegated administrator account](https://help.aliyun.com/document_detail/208117.html).
7984
+ * After the delegated administrator account of CloudSSO is specified, you can call this operation to enable the delegated administrator account of CloudSSO to manage CloudSSO resources.
7915
7985
  *
7916
- * @param request EnableDelegateAccountRequest
7917
- * @return EnableDelegateAccountResponse
7986
+ * @param request - EnableDelegateAccountRequest
7987
+ * @returns EnableDelegateAccountResponse
7918
7988
  */
7919
7989
  async enableDelegateAccount(request) {
7920
7990
  let runtime = new $Util.RuntimeOptions({});
7921
7991
  return await this.enableDelegateAccountWithOptions(request, runtime);
7922
7992
  }
7923
7993
  /**
7924
- * @summary Enables CloudSSO.
7994
+ * Enables CloudSSO.
7925
7995
  *
7926
- * @description You can call this operation only if your account belongs to the management account that is used to enable a resource directory and has permissions to enable CloudSSO. For more information, see [Enable CloudSSO](https://help.aliyun.com/document_detail/262819.html).
7996
+ * @remarks
7997
+ * You can call this operation only if your account belongs to the management account that is used to enable a resource directory and has permissions to enable CloudSSO. For more information, see [Enable CloudSSO](https://help.aliyun.com/document_detail/262819.html).
7927
7998
  * 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).
7928
7999
  *
7929
- * @param request EnableServiceRequest
7930
- * @param runtime runtime options for this request RuntimeOptions
7931
- * @return EnableServiceResponse
8000
+ * @param request - EnableServiceRequest
8001
+ * @param runtime - runtime options for this request RuntimeOptions
8002
+ * @returns EnableServiceResponse
7932
8003
  */
7933
8004
  async enableServiceWithOptions(runtime) {
7934
8005
  let req = new $OpenApi.OpenApiRequest({});
@@ -7946,25 +8017,26 @@ class Client extends openapi_client_1.default {
7946
8017
  return $tea.cast(await this.callApi(params, req, runtime), new EnableServiceResponse({}));
7947
8018
  }
7948
8019
  /**
7949
- * @summary Enables CloudSSO.
8020
+ * Enables CloudSSO.
7950
8021
  *
7951
- * @description You can call this operation only if your account belongs to the management account that is used to enable a resource directory and has permissions to enable CloudSSO. For more information, see [Enable CloudSSO](https://help.aliyun.com/document_detail/262819.html).
8022
+ * @remarks
8023
+ * You can call this operation only if your account belongs to the management account that is used to enable a resource directory and has permissions to enable CloudSSO. For more information, see [Enable CloudSSO](https://help.aliyun.com/document_detail/262819.html).
7952
8024
  * 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).
7953
- *
7954
- * @return EnableServiceResponse
8025
+ * @returns EnableServiceResponse
7955
8026
  */
7956
8027
  async enableService() {
7957
8028
  let runtime = new $Util.RuntimeOptions({});
7958
8029
  return await this.enableServiceWithOptions(runtime);
7959
8030
  }
7960
8031
  /**
7961
- * @summary Queries information about an access configuration.
8032
+ * Queries information about an access configuration.
7962
8033
  *
7963
- * @description This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
8034
+ * @remarks
8035
+ * This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
7964
8036
  *
7965
- * @param request GetAccessConfigurationRequest
7966
- * @param runtime runtime options for this request RuntimeOptions
7967
- * @return GetAccessConfigurationResponse
8037
+ * @param request - GetAccessConfigurationRequest
8038
+ * @param runtime - runtime options for this request RuntimeOptions
8039
+ * @returns GetAccessConfigurationResponse
7968
8040
  */
7969
8041
  async getAccessConfigurationWithOptions(request, runtime) {
7970
8042
  tea_util_1.default.validateModel(request);
@@ -7992,25 +8064,27 @@ class Client extends openapi_client_1.default {
7992
8064
  return $tea.cast(await this.callApi(params, req, runtime), new GetAccessConfigurationResponse({}));
7993
8065
  }
7994
8066
  /**
7995
- * @summary Queries information about an access configuration.
8067
+ * Queries information about an access configuration.
7996
8068
  *
7997
- * @description This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
8069
+ * @remarks
8070
+ * This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
7998
8071
  *
7999
- * @param request GetAccessConfigurationRequest
8000
- * @return GetAccessConfigurationResponse
8072
+ * @param request - GetAccessConfigurationRequest
8073
+ * @returns GetAccessConfigurationResponse
8001
8074
  */
8002
8075
  async getAccessConfiguration(request) {
8003
8076
  let runtime = new $Util.RuntimeOptions({});
8004
8077
  return await this.getAccessConfigurationWithOptions(request, runtime);
8005
8078
  }
8006
8079
  /**
8007
- * @summary Queries information about a directory.
8080
+ * Queries information about a directory.
8008
8081
  *
8009
- * @description This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
8082
+ * @remarks
8083
+ * This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
8010
8084
  *
8011
- * @param request GetDirectoryRequest
8012
- * @param runtime runtime options for this request RuntimeOptions
8013
- * @return GetDirectoryResponse
8085
+ * @param request - GetDirectoryRequest
8086
+ * @param runtime - runtime options for this request RuntimeOptions
8087
+ * @returns GetDirectoryResponse
8014
8088
  */
8015
8089
  async getDirectoryWithOptions(request, runtime) {
8016
8090
  tea_util_1.default.validateModel(request);
@@ -8035,26 +8109,28 @@ class Client extends openapi_client_1.default {
8035
8109
  return $tea.cast(await this.callApi(params, req, runtime), new GetDirectoryResponse({}));
8036
8110
  }
8037
8111
  /**
8038
- * @summary Queries information about a directory.
8112
+ * Queries information about a directory.
8039
8113
  *
8040
- * @description This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
8114
+ * @remarks
8115
+ * This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
8041
8116
  *
8042
- * @param request GetDirectoryRequest
8043
- * @return GetDirectoryResponse
8117
+ * @param request - GetDirectoryRequest
8118
+ * @returns GetDirectoryResponse
8044
8119
  */
8045
8120
  async getDirectory(request) {
8046
8121
  let runtime = new $Util.RuntimeOptions({});
8047
8122
  return await this.getDirectoryWithOptions(request, runtime);
8048
8123
  }
8049
8124
  /**
8050
- * @summary Queries information about a Security Assertion Markup Language (SAML) service provider (SP).
8125
+ * Queries information about a Security Assertion Markup Language (SAML) service provider (SP).
8051
8126
  *
8052
- * @description During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an identity provider (IdP).
8127
+ * @remarks
8128
+ * 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).
8053
8129
  * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
8054
8130
  *
8055
- * @param request GetDirectorySAMLServiceProviderInfoRequest
8056
- * @param runtime runtime options for this request RuntimeOptions
8057
- * @return GetDirectorySAMLServiceProviderInfoResponse
8131
+ * @param request - GetDirectorySAMLServiceProviderInfoRequest
8132
+ * @param runtime - runtime options for this request RuntimeOptions
8133
+ * @returns GetDirectorySAMLServiceProviderInfoResponse
8058
8134
  */
8059
8135
  async getDirectorySAMLServiceProviderInfoWithOptions(request, runtime) {
8060
8136
  tea_util_1.default.validateModel(request);
@@ -8079,29 +8155,28 @@ class Client extends openapi_client_1.default {
8079
8155
  return $tea.cast(await this.callApi(params, req, runtime), new GetDirectorySAMLServiceProviderInfoResponse({}));
8080
8156
  }
8081
8157
  /**
8082
- * @summary Queries information about a Security Assertion Markup Language (SAML) service provider (SP).
8158
+ * Queries information about a Security Assertion Markup Language (SAML) service provider (SP).
8083
8159
  *
8084
- * @description During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an identity provider (IdP).
8160
+ * @remarks
8161
+ * 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).
8085
8162
  * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
8086
8163
  *
8087
- * @param request GetDirectorySAMLServiceProviderInfoRequest
8088
- * @return GetDirectorySAMLServiceProviderInfoResponse
8164
+ * @param request - GetDirectorySAMLServiceProviderInfoRequest
8165
+ * @returns GetDirectorySAMLServiceProviderInfoResponse
8089
8166
  */
8090
8167
  async getDirectorySAMLServiceProviderInfo(request) {
8091
8168
  let runtime = new $Util.RuntimeOptions({});
8092
8169
  return await this.getDirectorySAMLServiceProviderInfoWithOptions(request, runtime);
8093
8170
  }
8094
8171
  /**
8095
- * @summary Queries the statistics of a directory.
8172
+ * Queries the statistics of a directory.
8096
8173
  *
8097
- * @description ### [](#)
8098
- * This topic provides an example on how to query the statistics of a directory whose ID is `d-00fc2p61****`. The statistics include the number of users, quota for users, number of groups, quota for groups, number of access configurations, quota for access configurations, quota for system policies that can be configured for an access configuration, number of access permissions that are assigned, number of System for Cross-domain Identity Management (SCIM) credentials, number of asynchronous tasks, status of single sign-on (SSO), and status of SCIM synchronization.
8099
- * ### [](#qps)Limit
8100
- * 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.
8174
+ * @remarks
8175
+ * 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 policies that can be configured for an access configuration, 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.
8101
8176
  *
8102
- * @param request GetDirectoryStatisticsRequest
8103
- * @param runtime runtime options for this request RuntimeOptions
8104
- * @return GetDirectoryStatisticsResponse
8177
+ * @param request - GetDirectoryStatisticsRequest
8178
+ * @param runtime - runtime options for this request RuntimeOptions
8179
+ * @returns GetDirectoryStatisticsResponse
8105
8180
  */
8106
8181
  async getDirectoryStatisticsWithOptions(request, runtime) {
8107
8182
  tea_util_1.default.validateModel(request);
@@ -8126,28 +8201,27 @@ class Client extends openapi_client_1.default {
8126
8201
  return $tea.cast(await this.callApi(params, req, runtime), new GetDirectoryStatisticsResponse({}));
8127
8202
  }
8128
8203
  /**
8129
- * @summary Queries the statistics of a directory.
8204
+ * Queries the statistics of a directory.
8130
8205
  *
8131
- * @description ### [](#)
8132
- * This topic provides an example on how to query the statistics of a directory whose ID is `d-00fc2p61****`. The statistics include the number of users, quota for users, number of groups, quota for groups, number of access configurations, quota for access configurations, quota for system policies that can be configured for an access configuration, number of access permissions that are assigned, number of System for Cross-domain Identity Management (SCIM) credentials, number of asynchronous tasks, status of single sign-on (SSO), and status of SCIM synchronization.
8133
- * ### [](#qps)Limit
8134
- * 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.
8206
+ * @remarks
8207
+ * 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 policies that can be configured for an access configuration, 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.
8135
8208
  *
8136
- * @param request GetDirectoryStatisticsRequest
8137
- * @return GetDirectoryStatisticsResponse
8209
+ * @param request - GetDirectoryStatisticsRequest
8210
+ * @returns GetDirectoryStatisticsResponse
8138
8211
  */
8139
8212
  async getDirectoryStatistics(request) {
8140
8213
  let runtime = new $Util.RuntimeOptions({});
8141
8214
  return await this.getDirectoryStatisticsWithOptions(request, runtime);
8142
8215
  }
8143
8216
  /**
8144
- * @summary Queries the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
8217
+ * Queries the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
8145
8218
  *
8146
- * @description This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
8219
+ * @remarks
8220
+ * This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
8147
8221
  *
8148
- * @param request GetExternalSAMLIdentityProviderRequest
8149
- * @param runtime runtime options for this request RuntimeOptions
8150
- * @return GetExternalSAMLIdentityProviderResponse
8222
+ * @param request - GetExternalSAMLIdentityProviderRequest
8223
+ * @param runtime - runtime options for this request RuntimeOptions
8224
+ * @returns GetExternalSAMLIdentityProviderResponse
8151
8225
  */
8152
8226
  async getExternalSAMLIdentityProviderWithOptions(request, runtime) {
8153
8227
  tea_util_1.default.validateModel(request);
@@ -8172,25 +8246,27 @@ class Client extends openapi_client_1.default {
8172
8246
  return $tea.cast(await this.callApi(params, req, runtime), new GetExternalSAMLIdentityProviderResponse({}));
8173
8247
  }
8174
8248
  /**
8175
- * @summary Queries the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
8249
+ * Queries the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
8176
8250
  *
8177
- * @description This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
8251
+ * @remarks
8252
+ * This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
8178
8253
  *
8179
- * @param request GetExternalSAMLIdentityProviderRequest
8180
- * @return GetExternalSAMLIdentityProviderResponse
8254
+ * @param request - GetExternalSAMLIdentityProviderRequest
8255
+ * @returns GetExternalSAMLIdentityProviderResponse
8181
8256
  */
8182
8257
  async getExternalSAMLIdentityProvider(request) {
8183
8258
  let runtime = new $Util.RuntimeOptions({});
8184
8259
  return await this.getExternalSAMLIdentityProviderWithOptions(request, runtime);
8185
8260
  }
8186
8261
  /**
8187
- * @summary Queries information about a group.
8262
+ * Queries information about a group.
8188
8263
  *
8189
- * @description This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
8264
+ * @remarks
8265
+ * This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
8190
8266
  *
8191
- * @param request GetGroupRequest
8192
- * @param runtime runtime options for this request RuntimeOptions
8193
- * @return GetGroupResponse
8267
+ * @param request - GetGroupRequest
8268
+ * @param runtime - runtime options for this request RuntimeOptions
8269
+ * @returns GetGroupResponse
8194
8270
  */
8195
8271
  async getGroupWithOptions(request, runtime) {
8196
8272
  tea_util_1.default.validateModel(request);
@@ -8218,23 +8294,24 @@ class Client extends openapi_client_1.default {
8218
8294
  return $tea.cast(await this.callApi(params, req, runtime), new GetGroupResponse({}));
8219
8295
  }
8220
8296
  /**
8221
- * @summary Queries information about a group.
8297
+ * Queries information about a group.
8222
8298
  *
8223
- * @description This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
8299
+ * @remarks
8300
+ * This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
8224
8301
  *
8225
- * @param request GetGroupRequest
8226
- * @return GetGroupResponse
8302
+ * @param request - GetGroupRequest
8303
+ * @returns GetGroupResponse
8227
8304
  */
8228
8305
  async getGroup(request) {
8229
8306
  let runtime = new $Util.RuntimeOptions({});
8230
8307
  return await this.getGroupWithOptions(request, runtime);
8231
8308
  }
8232
8309
  /**
8233
- * @summary Queries the logon preference of CloudSSO users.
8310
+ * Queries the logon preference of CloudSSO users.
8234
8311
  *
8235
- * @param request GetLoginPreferenceRequest
8236
- * @param runtime runtime options for this request RuntimeOptions
8237
- * @return GetLoginPreferenceResponse
8312
+ * @param request - GetLoginPreferenceRequest
8313
+ * @param runtime - runtime options for this request RuntimeOptions
8314
+ * @returns GetLoginPreferenceResponse
8238
8315
  */
8239
8316
  async getLoginPreferenceWithOptions(request, runtime) {
8240
8317
  tea_util_1.default.validateModel(request);
@@ -8259,24 +8336,25 @@ class Client extends openapi_client_1.default {
8259
8336
  return $tea.cast(await this.callApi(params, req, runtime), new GetLoginPreferenceResponse({}));
8260
8337
  }
8261
8338
  /**
8262
- * @summary Queries the logon preference of CloudSSO users.
8339
+ * Queries the logon preference of CloudSSO users.
8263
8340
  *
8264
- * @param request GetLoginPreferenceRequest
8265
- * @return GetLoginPreferenceResponse
8341
+ * @param request - GetLoginPreferenceRequest
8342
+ * @returns GetLoginPreferenceResponse
8266
8343
  */
8267
8344
  async getLoginPreference(request) {
8268
8345
  let runtime = new $Util.RuntimeOptions({});
8269
8346
  return await this.getLoginPreferenceWithOptions(request, runtime);
8270
8347
  }
8271
8348
  /**
8272
- * @summary Queries the multi-factor authentication (MFA) setting of all users.
8349
+ * Queries the multi-factor authentication (MFA) setting of all users.
8273
8350
  *
8274
- * @description If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
8351
+ * @remarks
8352
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
8275
8353
  * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
8276
8354
  *
8277
- * @param request GetMFAAuthenticationSettingInfoRequest
8278
- * @param runtime runtime options for this request RuntimeOptions
8279
- * @return GetMFAAuthenticationSettingInfoResponse
8355
+ * @param request - GetMFAAuthenticationSettingInfoRequest
8356
+ * @param runtime - runtime options for this request RuntimeOptions
8357
+ * @returns GetMFAAuthenticationSettingInfoResponse
8280
8358
  */
8281
8359
  async getMFAAuthenticationSettingInfoWithOptions(request, runtime) {
8282
8360
  tea_util_1.default.validateModel(request);
@@ -8301,27 +8379,29 @@ class Client extends openapi_client_1.default {
8301
8379
  return $tea.cast(await this.callApi(params, req, runtime), new GetMFAAuthenticationSettingInfoResponse({}));
8302
8380
  }
8303
8381
  /**
8304
- * @summary Queries the multi-factor authentication (MFA) setting of all users.
8382
+ * Queries the multi-factor authentication (MFA) setting of all users.
8305
8383
  *
8306
- * @description If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
8384
+ * @remarks
8385
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
8307
8386
  * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
8308
8387
  *
8309
- * @param request GetMFAAuthenticationSettingInfoRequest
8310
- * @return GetMFAAuthenticationSettingInfoResponse
8388
+ * @param request - GetMFAAuthenticationSettingInfoRequest
8389
+ * @returns GetMFAAuthenticationSettingInfoResponse
8311
8390
  */
8312
8391
  async getMFAAuthenticationSettingInfo(request) {
8313
8392
  let runtime = new $Util.RuntimeOptions({});
8314
8393
  return await this.getMFAAuthenticationSettingInfoWithOptions(request, runtime);
8315
8394
  }
8316
8395
  /**
8317
- * @summary Queries the multi-factor authentication (MFA) setting of all users.
8396
+ * Queries the multi-factor authentication (MFA) setting of all users.
8318
8397
  *
8319
- * @description > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](https://help.aliyun.com/document_detail/611286.html) operation to query more detailed information.
8398
+ * @remarks
8399
+ * > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](https://help.aliyun.com/document_detail/611286.html) operation to query more detailed information.
8320
8400
  * 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.
8321
8401
  *
8322
- * @param request GetMFAAuthenticationSettingsRequest
8323
- * @param runtime runtime options for this request RuntimeOptions
8324
- * @return GetMFAAuthenticationSettingsResponse
8402
+ * @param request - GetMFAAuthenticationSettingsRequest
8403
+ * @param runtime - runtime options for this request RuntimeOptions
8404
+ * @returns GetMFAAuthenticationSettingsResponse
8325
8405
  */
8326
8406
  async getMFAAuthenticationSettingsWithOptions(request, runtime) {
8327
8407
  tea_util_1.default.validateModel(request);
@@ -8346,26 +8426,28 @@ class Client extends openapi_client_1.default {
8346
8426
  return $tea.cast(await this.callApi(params, req, runtime), new GetMFAAuthenticationSettingsResponse({}));
8347
8427
  }
8348
8428
  /**
8349
- * @summary Queries the multi-factor authentication (MFA) setting of all users.
8429
+ * Queries the multi-factor authentication (MFA) setting of all users.
8350
8430
  *
8351
- * @description > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](https://help.aliyun.com/document_detail/611286.html) operation to query more detailed information.
8431
+ * @remarks
8432
+ * > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](https://help.aliyun.com/document_detail/611286.html) operation to query more detailed information.
8352
8433
  * 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.
8353
8434
  *
8354
- * @param request GetMFAAuthenticationSettingsRequest
8355
- * @return GetMFAAuthenticationSettingsResponse
8435
+ * @param request - GetMFAAuthenticationSettingsRequest
8436
+ * @returns GetMFAAuthenticationSettingsResponse
8356
8437
  */
8357
8438
  async getMFAAuthenticationSettings(request) {
8358
8439
  let runtime = new $Util.RuntimeOptions({});
8359
8440
  return await this.getMFAAuthenticationSettingsWithOptions(request, runtime);
8360
8441
  }
8361
8442
  /**
8362
- * @summary Checks whether multi-factor authentication (MFA) is enabled for users.
8443
+ * Checks whether multi-factor authentication (MFA) is enabled for users.
8363
8444
  *
8364
- * @description This topic provides an example on how to check whether MFA is enabled for users in the directory whose ID is `00fc2p61****`. The returned result shows that MFA is in the Enabled state.
8445
+ * @remarks
8446
+ * 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.
8365
8447
  *
8366
- * @param request GetMFAAuthenticationStatusRequest
8367
- * @param runtime runtime options for this request RuntimeOptions
8368
- * @return GetMFAAuthenticationStatusResponse
8448
+ * @param request - GetMFAAuthenticationStatusRequest
8449
+ * @param runtime - runtime options for this request RuntimeOptions
8450
+ * @returns GetMFAAuthenticationStatusResponse
8369
8451
  */
8370
8452
  async getMFAAuthenticationStatusWithOptions(request, runtime) {
8371
8453
  tea_util_1.default.validateModel(request);
@@ -8390,23 +8472,24 @@ class Client extends openapi_client_1.default {
8390
8472
  return $tea.cast(await this.callApi(params, req, runtime), new GetMFAAuthenticationStatusResponse({}));
8391
8473
  }
8392
8474
  /**
8393
- * @summary Checks whether multi-factor authentication (MFA) is enabled for users.
8475
+ * Checks whether multi-factor authentication (MFA) is enabled for users.
8394
8476
  *
8395
- * @description This topic provides an example on how to check whether MFA is enabled for users in the directory whose ID is `00fc2p61****`. The returned result shows that MFA is in the Enabled state.
8477
+ * @remarks
8478
+ * 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.
8396
8479
  *
8397
- * @param request GetMFAAuthenticationStatusRequest
8398
- * @return GetMFAAuthenticationStatusResponse
8480
+ * @param request - GetMFAAuthenticationStatusRequest
8481
+ * @returns GetMFAAuthenticationStatusResponse
8399
8482
  */
8400
8483
  async getMFAAuthenticationStatus(request) {
8401
8484
  let runtime = new $Util.RuntimeOptions({});
8402
8485
  return await this.getMFAAuthenticationStatusWithOptions(request, runtime);
8403
8486
  }
8404
8487
  /**
8405
- * @summary Queries the password policy of CloudSSO users.
8488
+ * Queries the password policy of CloudSSO users.
8406
8489
  *
8407
- * @param request GetPasswordPolicyRequest
8408
- * @param runtime runtime options for this request RuntimeOptions
8409
- * @return GetPasswordPolicyResponse
8490
+ * @param request - GetPasswordPolicyRequest
8491
+ * @param runtime - runtime options for this request RuntimeOptions
8492
+ * @returns GetPasswordPolicyResponse
8410
8493
  */
8411
8494
  async getPasswordPolicyWithOptions(request, runtime) {
8412
8495
  tea_util_1.default.validateModel(request);
@@ -8431,23 +8514,24 @@ class Client extends openapi_client_1.default {
8431
8514
  return $tea.cast(await this.callApi(params, req, runtime), new GetPasswordPolicyResponse({}));
8432
8515
  }
8433
8516
  /**
8434
- * @summary Queries the password policy of CloudSSO users.
8517
+ * Queries the password policy of CloudSSO users.
8435
8518
  *
8436
- * @param request GetPasswordPolicyRequest
8437
- * @return GetPasswordPolicyResponse
8519
+ * @param request - GetPasswordPolicyRequest
8520
+ * @returns GetPasswordPolicyResponse
8438
8521
  */
8439
8522
  async getPasswordPolicy(request) {
8440
8523
  let runtime = new $Util.RuntimeOptions({});
8441
8524
  return await this.getPasswordPolicyWithOptions(request, runtime);
8442
8525
  }
8443
8526
  /**
8444
- * @summary Queries the status of System for Cross-domain Identity Management (SCIM) synchronization.
8527
+ * Queries the status of System for Cross-domain Identity Management (SCIM) synchronization.
8445
8528
  *
8446
- * @description This topic provides an example on how to query the status of SCIM synchronization within the directory `d-00fc2p61****`. The returned result shows that SCIM synchronization is in the Enabled state.
8529
+ * @remarks
8530
+ * 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.
8447
8531
  *
8448
- * @param request GetSCIMSynchronizationStatusRequest
8449
- * @param runtime runtime options for this request RuntimeOptions
8450
- * @return GetSCIMSynchronizationStatusResponse
8532
+ * @param request - GetSCIMSynchronizationStatusRequest
8533
+ * @param runtime - runtime options for this request RuntimeOptions
8534
+ * @returns GetSCIMSynchronizationStatusResponse
8451
8535
  */
8452
8536
  async getSCIMSynchronizationStatusWithOptions(request, runtime) {
8453
8537
  tea_util_1.default.validateModel(request);
@@ -8472,23 +8556,24 @@ class Client extends openapi_client_1.default {
8472
8556
  return $tea.cast(await this.callApi(params, req, runtime), new GetSCIMSynchronizationStatusResponse({}));
8473
8557
  }
8474
8558
  /**
8475
- * @summary Queries the status of System for Cross-domain Identity Management (SCIM) synchronization.
8559
+ * Queries the status of System for Cross-domain Identity Management (SCIM) synchronization.
8476
8560
  *
8477
- * @description This topic provides an example on how to query the status of SCIM synchronization within the directory `d-00fc2p61****`. The returned result shows that SCIM synchronization is in the Enabled state.
8561
+ * @remarks
8562
+ * 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.
8478
8563
  *
8479
- * @param request GetSCIMSynchronizationStatusRequest
8480
- * @return GetSCIMSynchronizationStatusResponse
8564
+ * @param request - GetSCIMSynchronizationStatusRequest
8565
+ * @returns GetSCIMSynchronizationStatusResponse
8481
8566
  */
8482
8567
  async getSCIMSynchronizationStatus(request) {
8483
8568
  let runtime = new $Util.RuntimeOptions({});
8484
8569
  return await this.getSCIMSynchronizationStatusWithOptions(request, runtime);
8485
8570
  }
8486
8571
  /**
8487
- * @summary Queries the status of CloudSSO.
8572
+ * Queries the status of CloudSSO.
8488
8573
  *
8489
- * @param request GetServiceStatusRequest
8490
- * @param runtime runtime options for this request RuntimeOptions
8491
- * @return GetServiceStatusResponse
8574
+ * @param request - GetServiceStatusRequest
8575
+ * @param runtime - runtime options for this request RuntimeOptions
8576
+ * @returns GetServiceStatusResponse
8492
8577
  */
8493
8578
  async getServiceStatusWithOptions(runtime) {
8494
8579
  let req = new $OpenApi.OpenApiRequest({});
@@ -8506,22 +8591,22 @@ class Client extends openapi_client_1.default {
8506
8591
  return $tea.cast(await this.callApi(params, req, runtime), new GetServiceStatusResponse({}));
8507
8592
  }
8508
8593
  /**
8509
- * @summary Queries the status of CloudSSO.
8510
- *
8511
- * @return GetServiceStatusResponse
8594
+ * Queries the status of CloudSSO.
8595
+ * @returns GetServiceStatusResponse
8512
8596
  */
8513
8597
  async getServiceStatus() {
8514
8598
  let runtime = new $Util.RuntimeOptions({});
8515
8599
  return await this.getServiceStatusWithOptions(runtime);
8516
8600
  }
8517
8601
  /**
8518
- * @summary Queries information about an asynchronous task.
8602
+ * Queries information about an asynchronous task.
8519
8603
  *
8520
- * @description This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
8604
+ * @remarks
8605
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
8521
8606
  *
8522
- * @param request GetTaskRequest
8523
- * @param runtime runtime options for this request RuntimeOptions
8524
- * @return GetTaskResponse
8607
+ * @param request - GetTaskRequest
8608
+ * @param runtime - runtime options for this request RuntimeOptions
8609
+ * @returns GetTaskResponse
8525
8610
  */
8526
8611
  async getTaskWithOptions(request, runtime) {
8527
8612
  tea_util_1.default.validateModel(request);
@@ -8549,26 +8634,28 @@ class Client extends openapi_client_1.default {
8549
8634
  return $tea.cast(await this.callApi(params, req, runtime), new GetTaskResponse({}));
8550
8635
  }
8551
8636
  /**
8552
- * @summary Queries information about an asynchronous task.
8637
+ * Queries information about an asynchronous task.
8553
8638
  *
8554
- * @description This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
8639
+ * @remarks
8640
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
8555
8641
  *
8556
- * @param request GetTaskRequest
8557
- * @return GetTaskResponse
8642
+ * @param request - GetTaskRequest
8643
+ * @returns GetTaskResponse
8558
8644
  */
8559
8645
  async getTask(request) {
8560
8646
  let runtime = new $Util.RuntimeOptions({});
8561
8647
  return await this.getTaskWithOptions(request, runtime);
8562
8648
  }
8563
8649
  /**
8564
- * @summary Queries the status of an asynchronous task.
8650
+ * Queries the status of an asynchronous task.
8565
8651
  *
8566
- * @description You can call the GetTaskStatus operation to query the status of an asynchronous task. If you want to query more information about an asynchronous task, call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation.
8652
+ * @remarks
8653
+ * You can call the GetTaskStatus operation to query the status of an asynchronous task. If you want to query more information about an asynchronous task, call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation.
8567
8654
  * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
8568
8655
  *
8569
- * @param request GetTaskStatusRequest
8570
- * @param runtime runtime options for this request RuntimeOptions
8571
- * @return GetTaskStatusResponse
8656
+ * @param request - GetTaskStatusRequest
8657
+ * @param runtime - runtime options for this request RuntimeOptions
8658
+ * @returns GetTaskStatusResponse
8572
8659
  */
8573
8660
  async getTaskStatusWithOptions(request, runtime) {
8574
8661
  tea_util_1.default.validateModel(request);
@@ -8596,26 +8683,28 @@ class Client extends openapi_client_1.default {
8596
8683
  return $tea.cast(await this.callApi(params, req, runtime), new GetTaskStatusResponse({}));
8597
8684
  }
8598
8685
  /**
8599
- * @summary Queries the status of an asynchronous task.
8686
+ * Queries the status of an asynchronous task.
8600
8687
  *
8601
- * @description You can call the GetTaskStatus operation to query the status of an asynchronous task. If you want to query more information about an asynchronous task, call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation.
8688
+ * @remarks
8689
+ * You can call the GetTaskStatus operation to query the status of an asynchronous task. If you want to query more information about an asynchronous task, call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation.
8602
8690
  * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
8603
8691
  *
8604
- * @param request GetTaskStatusRequest
8605
- * @return GetTaskStatusResponse
8692
+ * @param request - GetTaskStatusRequest
8693
+ * @returns GetTaskStatusResponse
8606
8694
  */
8607
8695
  async getTaskStatus(request) {
8608
8696
  let runtime = new $Util.RuntimeOptions({});
8609
8697
  return await this.getTaskStatusWithOptions(request, runtime);
8610
8698
  }
8611
8699
  /**
8612
- * @summary Queries information about a user.
8700
+ * Queries information about a user.
8613
8701
  *
8614
- * @description This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
8702
+ * @remarks
8703
+ * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
8615
8704
  *
8616
- * @param request GetUserRequest
8617
- * @param runtime runtime options for this request RuntimeOptions
8618
- * @return GetUserResponse
8705
+ * @param request - GetUserRequest
8706
+ * @param runtime - runtime options for this request RuntimeOptions
8707
+ * @returns GetUserResponse
8619
8708
  */
8620
8709
  async getUserWithOptions(request, runtime) {
8621
8710
  tea_util_1.default.validateModel(request);
@@ -8643,23 +8732,24 @@ class Client extends openapi_client_1.default {
8643
8732
  return $tea.cast(await this.callApi(params, req, runtime), new GetUserResponse({}));
8644
8733
  }
8645
8734
  /**
8646
- * @summary Queries information about a user.
8735
+ * Queries information about a user.
8647
8736
  *
8648
- * @description This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
8737
+ * @remarks
8738
+ * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
8649
8739
  *
8650
- * @param request GetUserRequest
8651
- * @return GetUserResponse
8740
+ * @param request - GetUserRequest
8741
+ * @returns GetUserResponse
8652
8742
  */
8653
8743
  async getUser(request) {
8654
8744
  let runtime = new $Util.RuntimeOptions({});
8655
8745
  return await this.getUserWithOptions(request, runtime);
8656
8746
  }
8657
8747
  /**
8658
- * @summary Queries the ID of a user in a resource directory by using the ExternalId parameter.
8748
+ * Queries the ID of a user in a resource directory by using the ExternalId parameter.
8659
8749
  *
8660
- * @param tmpReq GetUserIdRequest
8661
- * @param runtime runtime options for this request RuntimeOptions
8662
- * @return GetUserIdResponse
8750
+ * @param tmpReq - GetUserIdRequest
8751
+ * @param runtime - runtime options for this request RuntimeOptions
8752
+ * @returns GetUserIdResponse
8663
8753
  */
8664
8754
  async getUserIdWithOptions(tmpReq, runtime) {
8665
8755
  tea_util_1.default.validateModel(tmpReq);
@@ -8692,23 +8782,24 @@ class Client extends openapi_client_1.default {
8692
8782
  return $tea.cast(await this.callApi(params, req, runtime), new GetUserIdResponse({}));
8693
8783
  }
8694
8784
  /**
8695
- * @summary Queries the ID of a user in a resource directory by using the ExternalId parameter.
8785
+ * Queries the ID of a user in a resource directory by using the ExternalId parameter.
8696
8786
  *
8697
- * @param request GetUserIdRequest
8698
- * @return GetUserIdResponse
8787
+ * @param request - GetUserIdRequest
8788
+ * @returns GetUserIdResponse
8699
8789
  */
8700
8790
  async getUserId(request) {
8701
8791
  let runtime = new $Util.RuntimeOptions({});
8702
8792
  return await this.getUserIdWithOptions(request, runtime);
8703
8793
  }
8704
8794
  /**
8705
- * @summary Queries the multi-factor authentication (MFA) setting of a single user.
8795
+ * Queries the multi-factor authentication (MFA) setting of a single user.
8706
8796
  *
8707
- * @description This topic provides an example on how to query the MFA setting of the user named `u-00q8wbq42wiltcrk****`. The returned result shows that MFA is enabled for the user.
8797
+ * @remarks
8798
+ * 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.
8708
8799
  *
8709
- * @param request GetUserMFAAuthenticationSettingsRequest
8710
- * @param runtime runtime options for this request RuntimeOptions
8711
- * @return GetUserMFAAuthenticationSettingsResponse
8800
+ * @param request - GetUserMFAAuthenticationSettingsRequest
8801
+ * @param runtime - runtime options for this request RuntimeOptions
8802
+ * @returns GetUserMFAAuthenticationSettingsResponse
8712
8803
  */
8713
8804
  async getUserMFAAuthenticationSettingsWithOptions(request, runtime) {
8714
8805
  tea_util_1.default.validateModel(request);
@@ -8736,23 +8827,24 @@ class Client extends openapi_client_1.default {
8736
8827
  return $tea.cast(await this.callApi(params, req, runtime), new GetUserMFAAuthenticationSettingsResponse({}));
8737
8828
  }
8738
8829
  /**
8739
- * @summary Queries the multi-factor authentication (MFA) setting of a single user.
8830
+ * Queries the multi-factor authentication (MFA) setting of a single user.
8740
8831
  *
8741
- * @description This topic provides an example on how to query the MFA setting of the user named `u-00q8wbq42wiltcrk****`. The returned result shows that MFA is enabled for the user.
8832
+ * @remarks
8833
+ * 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.
8742
8834
  *
8743
- * @param request GetUserMFAAuthenticationSettingsRequest
8744
- * @return GetUserMFAAuthenticationSettingsResponse
8835
+ * @param request - GetUserMFAAuthenticationSettingsRequest
8836
+ * @returns GetUserMFAAuthenticationSettingsResponse
8745
8837
  */
8746
8838
  async getUserMFAAuthenticationSettings(request) {
8747
8839
  let runtime = new $Util.RuntimeOptions({});
8748
8840
  return await this.getUserMFAAuthenticationSettingsWithOptions(request, runtime);
8749
8841
  }
8750
8842
  /**
8751
- * @summary Queries a Resource Access Management (RAM) user provisioning.
8843
+ * Queries a Resource Access Management (RAM) user provisioning.
8752
8844
  *
8753
- * @param request GetUserProvisioningRequest
8754
- * @param runtime runtime options for this request RuntimeOptions
8755
- * @return GetUserProvisioningResponse
8845
+ * @param request - GetUserProvisioningRequest
8846
+ * @param runtime - runtime options for this request RuntimeOptions
8847
+ * @returns GetUserProvisioningResponse
8756
8848
  */
8757
8849
  async getUserProvisioningWithOptions(request, runtime) {
8758
8850
  tea_util_1.default.validateModel(request);
@@ -8780,21 +8872,21 @@ class Client extends openapi_client_1.default {
8780
8872
  return $tea.cast(await this.callApi(params, req, runtime), new GetUserProvisioningResponse({}));
8781
8873
  }
8782
8874
  /**
8783
- * @summary Queries a Resource Access Management (RAM) user provisioning.
8875
+ * Queries a Resource Access Management (RAM) user provisioning.
8784
8876
  *
8785
- * @param request GetUserProvisioningRequest
8786
- * @return GetUserProvisioningResponse
8877
+ * @param request - GetUserProvisioningRequest
8878
+ * @returns GetUserProvisioningResponse
8787
8879
  */
8788
8880
  async getUserProvisioning(request) {
8789
8881
  let runtime = new $Util.RuntimeOptions({});
8790
8882
  return await this.getUserProvisioningWithOptions(request, runtime);
8791
8883
  }
8792
8884
  /**
8793
- * @summary Queries the global configurations of a Resource Access Management (RAM) user provisioning.
8885
+ * Queries the global configurations of a Resource Access Management (RAM) user provisioning.
8794
8886
  *
8795
- * @param request GetUserProvisioningConfigurationRequest
8796
- * @param runtime runtime options for this request RuntimeOptions
8797
- * @return GetUserProvisioningConfigurationResponse
8887
+ * @param request - GetUserProvisioningConfigurationRequest
8888
+ * @param runtime - runtime options for this request RuntimeOptions
8889
+ * @returns GetUserProvisioningConfigurationResponse
8798
8890
  */
8799
8891
  async getUserProvisioningConfigurationWithOptions(request, runtime) {
8800
8892
  tea_util_1.default.validateModel(request);
@@ -8819,21 +8911,21 @@ class Client extends openapi_client_1.default {
8819
8911
  return $tea.cast(await this.callApi(params, req, runtime), new GetUserProvisioningConfigurationResponse({}));
8820
8912
  }
8821
8913
  /**
8822
- * @summary Queries the global configurations of a Resource Access Management (RAM) user provisioning.
8914
+ * Queries the global configurations of a Resource Access Management (RAM) user provisioning.
8823
8915
  *
8824
- * @param request GetUserProvisioningConfigurationRequest
8825
- * @return GetUserProvisioningConfigurationResponse
8916
+ * @param request - GetUserProvisioningConfigurationRequest
8917
+ * @returns GetUserProvisioningConfigurationResponse
8826
8918
  */
8827
8919
  async getUserProvisioningConfiguration(request) {
8828
8920
  let runtime = new $Util.RuntimeOptions({});
8829
8921
  return await this.getUserProvisioningConfigurationWithOptions(request, runtime);
8830
8922
  }
8831
8923
  /**
8832
- * @summary Queries a Resource Access Management (RAM) user provisioning event.
8924
+ * Queries the information about a Resource Access Management (RAM) user provisioning.
8833
8925
  *
8834
- * @param request GetUserProvisioningEventRequest
8835
- * @param runtime runtime options for this request RuntimeOptions
8836
- * @return GetUserProvisioningEventResponse
8926
+ * @param request - GetUserProvisioningEventRequest
8927
+ * @param runtime - runtime options for this request RuntimeOptions
8928
+ * @returns GetUserProvisioningEventResponse
8837
8929
  */
8838
8930
  async getUserProvisioningEventWithOptions(request, runtime) {
8839
8931
  tea_util_1.default.validateModel(request);
@@ -8861,21 +8953,21 @@ class Client extends openapi_client_1.default {
8861
8953
  return $tea.cast(await this.callApi(params, req, runtime), new GetUserProvisioningEventResponse({}));
8862
8954
  }
8863
8955
  /**
8864
- * @summary Queries a Resource Access Management (RAM) user provisioning event.
8956
+ * Queries the information about a Resource Access Management (RAM) user provisioning.
8865
8957
  *
8866
- * @param request GetUserProvisioningEventRequest
8867
- * @return GetUserProvisioningEventResponse
8958
+ * @param request - GetUserProvisioningEventRequest
8959
+ * @returns GetUserProvisioningEventResponse
8868
8960
  */
8869
8961
  async getUserProvisioningEvent(request) {
8870
8962
  let runtime = new $Util.RuntimeOptions({});
8871
8963
  return await this.getUserProvisioningEventWithOptions(request, runtime);
8872
8964
  }
8873
8965
  /**
8874
- * @summary Queries statistics of Resource Access Management (RAM) user provisioning events that are created for the member in a resource directory.
8966
+ * Queries statistics of Resource Access Management (RAM) user provisioning events that are created for the member in a resource directory.
8875
8967
  *
8876
- * @param request GetUserProvisioningRdAccountStatisticsRequest
8877
- * @param runtime runtime options for this request RuntimeOptions
8878
- * @return GetUserProvisioningRdAccountStatisticsResponse
8968
+ * @param request - GetUserProvisioningRdAccountStatisticsRequest
8969
+ * @param runtime - runtime options for this request RuntimeOptions
8970
+ * @returns GetUserProvisioningRdAccountStatisticsResponse
8879
8971
  */
8880
8972
  async getUserProvisioningRdAccountStatisticsWithOptions(request, runtime) {
8881
8973
  tea_util_1.default.validateModel(request);
@@ -8903,21 +8995,21 @@ class Client extends openapi_client_1.default {
8903
8995
  return $tea.cast(await this.callApi(params, req, runtime), new GetUserProvisioningRdAccountStatisticsResponse({}));
8904
8996
  }
8905
8997
  /**
8906
- * @summary Queries statistics of Resource Access Management (RAM) user provisioning events that are created for the member in a resource directory.
8998
+ * Queries statistics of Resource Access Management (RAM) user provisioning events that are created for the member in a resource directory.
8907
8999
  *
8908
- * @param request GetUserProvisioningRdAccountStatisticsRequest
8909
- * @return GetUserProvisioningRdAccountStatisticsResponse
9000
+ * @param request - GetUserProvisioningRdAccountStatisticsRequest
9001
+ * @returns GetUserProvisioningRdAccountStatisticsResponse
8910
9002
  */
8911
9003
  async getUserProvisioningRdAccountStatistics(request) {
8912
9004
  let runtime = new $Util.RuntimeOptions({});
8913
9005
  return await this.getUserProvisioningRdAccountStatisticsWithOptions(request, runtime);
8914
9006
  }
8915
9007
  /**
8916
- * @summary Queries the statistics of a Resource Access Management (RAM) user provisioning.
9008
+ * Queries the statistics of a Resource Access Management (RAM) user provisioning.
8917
9009
  *
8918
- * @param request GetUserProvisioningStatisticsRequest
8919
- * @param runtime runtime options for this request RuntimeOptions
8920
- * @return GetUserProvisioningStatisticsResponse
9010
+ * @param request - GetUserProvisioningStatisticsRequest
9011
+ * @param runtime - runtime options for this request RuntimeOptions
9012
+ * @returns GetUserProvisioningStatisticsResponse
8921
9013
  */
8922
9014
  async getUserProvisioningStatisticsWithOptions(request, runtime) {
8923
9015
  tea_util_1.default.validateModel(request);
@@ -8945,23 +9037,24 @@ class Client extends openapi_client_1.default {
8945
9037
  return $tea.cast(await this.callApi(params, req, runtime), new GetUserProvisioningStatisticsResponse({}));
8946
9038
  }
8947
9039
  /**
8948
- * @summary Queries the statistics of a Resource Access Management (RAM) user provisioning.
9040
+ * Queries the statistics of a Resource Access Management (RAM) user provisioning.
8949
9041
  *
8950
- * @param request GetUserProvisioningStatisticsRequest
8951
- * @return GetUserProvisioningStatisticsResponse
9042
+ * @param request - GetUserProvisioningStatisticsRequest
9043
+ * @returns GetUserProvisioningStatisticsResponse
8952
9044
  */
8953
9045
  async getUserProvisioningStatistics(request) {
8954
9046
  let runtime = new $Util.RuntimeOptions({});
8955
9047
  return await this.getUserProvisioningStatisticsWithOptions(request, runtime);
8956
9048
  }
8957
9049
  /**
8958
- * @summary Queries the access permissions that are assigned.
9050
+ * Queries the access permissions that are assigned.
8959
9051
  *
8960
- * @description This topic provides an example on how to query the assigned access permissions on the account `114240524784****` in your resource directory. The returned result shows that access permissions on the account in your resource directory is assigned to one user.
9052
+ * @remarks
9053
+ * 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.
8961
9054
  *
8962
- * @param request ListAccessAssignmentsRequest
8963
- * @param runtime runtime options for this request RuntimeOptions
8964
- * @return ListAccessAssignmentsResponse
9055
+ * @param request - ListAccessAssignmentsRequest
9056
+ * @param runtime - runtime options for this request RuntimeOptions
9057
+ * @returns ListAccessAssignmentsResponse
8965
9058
  */
8966
9059
  async listAccessAssignmentsWithOptions(request, runtime) {
8967
9060
  tea_util_1.default.validateModel(request);
@@ -9007,25 +9100,27 @@ class Client extends openapi_client_1.default {
9007
9100
  return $tea.cast(await this.callApi(params, req, runtime), new ListAccessAssignmentsResponse({}));
9008
9101
  }
9009
9102
  /**
9010
- * @summary Queries the access permissions that are assigned.
9103
+ * Queries the access permissions that are assigned.
9011
9104
  *
9012
- * @description This topic provides an example on how to query the assigned access permissions on the account `114240524784****` in your resource directory. The returned result shows that access permissions on the account in your resource directory is assigned to one user.
9105
+ * @remarks
9106
+ * 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.
9013
9107
  *
9014
- * @param request ListAccessAssignmentsRequest
9015
- * @return ListAccessAssignmentsResponse
9108
+ * @param request - ListAccessAssignmentsRequest
9109
+ * @returns ListAccessAssignmentsResponse
9016
9110
  */
9017
9111
  async listAccessAssignments(request) {
9018
9112
  let runtime = new $Util.RuntimeOptions({});
9019
9113
  return await this.listAccessAssignmentsWithOptions(request, runtime);
9020
9114
  }
9021
9115
  /**
9022
- * @summary Queries the access configurations that are provisioned.
9116
+ * Queries the access configurations that are provisioned.
9023
9117
  *
9024
- * @description This topic provides an example on how to query the accounts for which the access permission `ac-00ccule7tadaijxc****` is provisioned. The returned result shows that the access configuration is provisioned for two accounts in your resource directory.
9118
+ * @remarks
9119
+ * 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.
9025
9120
  *
9026
- * @param request ListAccessConfigurationProvisioningsRequest
9027
- * @param runtime runtime options for this request RuntimeOptions
9028
- * @return ListAccessConfigurationProvisioningsResponse
9121
+ * @param request - ListAccessConfigurationProvisioningsRequest
9122
+ * @param runtime - runtime options for this request RuntimeOptions
9123
+ * @returns ListAccessConfigurationProvisioningsResponse
9029
9124
  */
9030
9125
  async listAccessConfigurationProvisioningsWithOptions(request, runtime) {
9031
9126
  tea_util_1.default.validateModel(request);
@@ -9068,25 +9163,27 @@ class Client extends openapi_client_1.default {
9068
9163
  return $tea.cast(await this.callApi(params, req, runtime), new ListAccessConfigurationProvisioningsResponse({}));
9069
9164
  }
9070
9165
  /**
9071
- * @summary Queries the access configurations that are provisioned.
9166
+ * Queries the access configurations that are provisioned.
9072
9167
  *
9073
- * @description This topic provides an example on how to query the accounts for which the access permission `ac-00ccule7tadaijxc****` is provisioned. The returned result shows that the access configuration is provisioned for two accounts in your resource directory.
9168
+ * @remarks
9169
+ * 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.
9074
9170
  *
9075
- * @param request ListAccessConfigurationProvisioningsRequest
9076
- * @return ListAccessConfigurationProvisioningsResponse
9171
+ * @param request - ListAccessConfigurationProvisioningsRequest
9172
+ * @returns ListAccessConfigurationProvisioningsResponse
9077
9173
  */
9078
9174
  async listAccessConfigurationProvisionings(request) {
9079
9175
  let runtime = new $Util.RuntimeOptions({});
9080
9176
  return await this.listAccessConfigurationProvisioningsWithOptions(request, runtime);
9081
9177
  }
9082
9178
  /**
9083
- * @summary Queries access configurations.
9179
+ * Queries access configurations.
9084
9180
  *
9085
- * @description This topic provides an example on how to query the access configurations within the directory `d-00fc2p61****`. The returned result shows that the directory contains the `VPC-Admin` and `ECS-Admin` access configurations.
9181
+ * @remarks
9182
+ * 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.
9086
9183
  *
9087
- * @param request ListAccessConfigurationsRequest
9088
- * @param runtime runtime options for this request RuntimeOptions
9089
- * @return ListAccessConfigurationsResponse
9184
+ * @param request - ListAccessConfigurationsRequest
9185
+ * @param runtime - runtime options for this request RuntimeOptions
9186
+ * @returns ListAccessConfigurationsResponse
9090
9187
  */
9091
9188
  async listAccessConfigurationsWithOptions(request, runtime) {
9092
9189
  tea_util_1.default.validateModel(request);
@@ -9123,25 +9220,27 @@ class Client extends openapi_client_1.default {
9123
9220
  return $tea.cast(await this.callApi(params, req, runtime), new ListAccessConfigurationsResponse({}));
9124
9221
  }
9125
9222
  /**
9126
- * @summary Queries access configurations.
9223
+ * Queries access configurations.
9127
9224
  *
9128
- * @description This topic provides an example on how to query the access configurations within the directory `d-00fc2p61****`. The returned result shows that the directory contains the `VPC-Admin` and `ECS-Admin` access configurations.
9225
+ * @remarks
9226
+ * 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.
9129
9227
  *
9130
- * @param request ListAccessConfigurationsRequest
9131
- * @return ListAccessConfigurationsResponse
9228
+ * @param request - ListAccessConfigurationsRequest
9229
+ * @returns ListAccessConfigurationsResponse
9132
9230
  */
9133
9231
  async listAccessConfigurations(request) {
9134
9232
  let runtime = new $Util.RuntimeOptions({});
9135
9233
  return await this.listAccessConfigurationsWithOptions(request, runtime);
9136
9234
  }
9137
9235
  /**
9138
- * @summary Queries directories.
9236
+ * Queries directories.
9139
9237
  *
9140
- * @description This topic provides an example on how to query the directories within your Alibaba Cloud account. The returned result shows that only one directory with the ID `d-00fc2p61****` is created within your Alibaba Cloud account.
9238
+ * @remarks
9239
+ * 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.
9141
9240
  *
9142
- * @param request ListDirectoriesRequest
9143
- * @param runtime runtime options for this request RuntimeOptions
9144
- * @return ListDirectoriesResponse
9241
+ * @param request - ListDirectoriesRequest
9242
+ * @param runtime - runtime options for this request RuntimeOptions
9243
+ * @returns ListDirectoriesResponse
9145
9244
  */
9146
9245
  async listDirectoriesWithOptions(runtime) {
9147
9246
  let req = new $OpenApi.OpenApiRequest({});
@@ -9159,24 +9258,25 @@ class Client extends openapi_client_1.default {
9159
9258
  return $tea.cast(await this.callApi(params, req, runtime), new ListDirectoriesResponse({}));
9160
9259
  }
9161
9260
  /**
9162
- * @summary Queries directories.
9261
+ * Queries directories.
9163
9262
  *
9164
- * @description This topic provides an example on how to query the directories within your Alibaba Cloud account. The returned result shows that only one directory with the ID `d-00fc2p61****` is created within your Alibaba Cloud account.
9165
- *
9166
- * @return ListDirectoriesResponse
9263
+ * @remarks
9264
+ * 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.
9265
+ * @returns ListDirectoriesResponse
9167
9266
  */
9168
9267
  async listDirectories() {
9169
9268
  let runtime = new $Util.RuntimeOptions({});
9170
9269
  return await this.listDirectoriesWithOptions(runtime);
9171
9270
  }
9172
9271
  /**
9173
- * @summary Queries Security Assertion Markup Language (SAML) signing certificates.
9272
+ * Queries Security Assertion Markup Language (SAML) signing certificates.
9174
9273
  *
9175
- * @description This topic provides an example on how to query the SAML signing certificates within the directory `d-00fc2p61****`. The returned result shows that the directory contains one SAML signing certificate.
9274
+ * @remarks
9275
+ * 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.
9176
9276
  *
9177
- * @param request ListExternalSAMLIdPCertificatesRequest
9178
- * @param runtime runtime options for this request RuntimeOptions
9179
- * @return ListExternalSAMLIdPCertificatesResponse
9277
+ * @param request - ListExternalSAMLIdPCertificatesRequest
9278
+ * @param runtime - runtime options for this request RuntimeOptions
9279
+ * @returns ListExternalSAMLIdPCertificatesResponse
9180
9280
  */
9181
9281
  async listExternalSAMLIdPCertificatesWithOptions(request, runtime) {
9182
9282
  tea_util_1.default.validateModel(request);
@@ -9201,25 +9301,27 @@ class Client extends openapi_client_1.default {
9201
9301
  return $tea.cast(await this.callApi(params, req, runtime), new ListExternalSAMLIdPCertificatesResponse({}));
9202
9302
  }
9203
9303
  /**
9204
- * @summary Queries Security Assertion Markup Language (SAML) signing certificates.
9304
+ * Queries Security Assertion Markup Language (SAML) signing certificates.
9205
9305
  *
9206
- * @description This topic provides an example on how to query the SAML signing certificates within the directory `d-00fc2p61****`. The returned result shows that the directory contains one SAML signing certificate.
9306
+ * @remarks
9307
+ * 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.
9207
9308
  *
9208
- * @param request ListExternalSAMLIdPCertificatesRequest
9209
- * @return ListExternalSAMLIdPCertificatesResponse
9309
+ * @param request - ListExternalSAMLIdPCertificatesRequest
9310
+ * @returns ListExternalSAMLIdPCertificatesResponse
9210
9311
  */
9211
9312
  async listExternalSAMLIdPCertificates(request) {
9212
9313
  let runtime = new $Util.RuntimeOptions({});
9213
9314
  return await this.listExternalSAMLIdPCertificatesWithOptions(request, runtime);
9214
9315
  }
9215
9316
  /**
9216
- * @summary Queries the users in a group.
9317
+ * Queries the users in a group.
9217
9318
  *
9218
- * @description This topic provides an example on how to query the users in the group `g-00jqzghi2n3o5hkh****`. The returned result shows that the group contains the user `Alice` and the user `user1`.
9319
+ * @remarks
9320
+ * 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`.
9219
9321
  *
9220
- * @param request ListGroupMembersRequest
9221
- * @param runtime runtime options for this request RuntimeOptions
9222
- * @return ListGroupMembersResponse
9322
+ * @param request - ListGroupMembersRequest
9323
+ * @param runtime - runtime options for this request RuntimeOptions
9324
+ * @returns ListGroupMembersResponse
9223
9325
  */
9224
9326
  async listGroupMembersWithOptions(request, runtime) {
9225
9327
  tea_util_1.default.validateModel(request);
@@ -9253,25 +9355,27 @@ class Client extends openapi_client_1.default {
9253
9355
  return $tea.cast(await this.callApi(params, req, runtime), new ListGroupMembersResponse({}));
9254
9356
  }
9255
9357
  /**
9256
- * @summary Queries the users in a group.
9358
+ * Queries the users in a group.
9257
9359
  *
9258
- * @description This topic provides an example on how to query the users in the group `g-00jqzghi2n3o5hkh****`. The returned result shows that the group contains the user `Alice` and the user `user1`.
9360
+ * @remarks
9361
+ * 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`.
9259
9362
  *
9260
- * @param request ListGroupMembersRequest
9261
- * @return ListGroupMembersResponse
9363
+ * @param request - ListGroupMembersRequest
9364
+ * @returns ListGroupMembersResponse
9262
9365
  */
9263
9366
  async listGroupMembers(request) {
9264
9367
  let runtime = new $Util.RuntimeOptions({});
9265
9368
  return await this.listGroupMembersWithOptions(request, runtime);
9266
9369
  }
9267
9370
  /**
9268
- * @summary Queries groups.
9371
+ * Queries groups.
9269
9372
  *
9270
- * @description This topic provides an example on how to query the groups in the directory `d-00fc2p61****`. The returned result shows that the directory contains three groups. The groups `group1` and `group2` are synchronized from an external identity provider (IdP). The group `TestGroup` is manually created in CloudSSO.
9373
+ * @remarks
9374
+ * 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.
9271
9375
  *
9272
- * @param request ListGroupsRequest
9273
- * @param runtime runtime options for this request RuntimeOptions
9274
- * @return ListGroupsResponse
9376
+ * @param request - ListGroupsRequest
9377
+ * @param runtime - runtime options for this request RuntimeOptions
9378
+ * @returns ListGroupsResponse
9275
9379
  */
9276
9380
  async listGroupsWithOptions(request, runtime) {
9277
9381
  tea_util_1.default.validateModel(request);
@@ -9308,25 +9412,27 @@ class Client extends openapi_client_1.default {
9308
9412
  return $tea.cast(await this.callApi(params, req, runtime), new ListGroupsResponse({}));
9309
9413
  }
9310
9414
  /**
9311
- * @summary Queries groups.
9415
+ * Queries groups.
9312
9416
  *
9313
- * @description This topic provides an example on how to query the groups in the directory `d-00fc2p61****`. The returned result shows that the directory contains three groups. The groups `group1` and `group2` are synchronized from an external identity provider (IdP). The group `TestGroup` is manually created in CloudSSO.
9417
+ * @remarks
9418
+ * 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.
9314
9419
  *
9315
- * @param request ListGroupsRequest
9316
- * @return ListGroupsResponse
9420
+ * @param request - ListGroupsRequest
9421
+ * @returns ListGroupsResponse
9317
9422
  */
9318
9423
  async listGroups(request) {
9319
9424
  let runtime = new $Util.RuntimeOptions({});
9320
9425
  return await this.listGroupsWithOptions(request, runtime);
9321
9426
  }
9322
9427
  /**
9323
- * @summary Queries the groups to which a user is added.
9428
+ * Queries the groups to which a user is added.
9324
9429
  *
9325
- * @description This topic provides an example on how to query the groups to which the user `u-00q8wbq42wiltcrk****` is added. The returned result shows that the user is added to both the `TestGroup` and the `group1` groups.
9430
+ * @remarks
9431
+ * 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.
9326
9432
  *
9327
- * @param request ListJoinedGroupsForUserRequest
9328
- * @param runtime runtime options for this request RuntimeOptions
9329
- * @return ListJoinedGroupsForUserResponse
9433
+ * @param request - ListJoinedGroupsForUserRequest
9434
+ * @param runtime - runtime options for this request RuntimeOptions
9435
+ * @returns ListJoinedGroupsForUserResponse
9330
9436
  */
9331
9437
  async listJoinedGroupsForUserWithOptions(request, runtime) {
9332
9438
  tea_util_1.default.validateModel(request);
@@ -9360,25 +9466,27 @@ class Client extends openapi_client_1.default {
9360
9466
  return $tea.cast(await this.callApi(params, req, runtime), new ListJoinedGroupsForUserResponse({}));
9361
9467
  }
9362
9468
  /**
9363
- * @summary Queries the groups to which a user is added.
9469
+ * Queries the groups to which a user is added.
9364
9470
  *
9365
- * @description This topic provides an example on how to query the groups to which the user `u-00q8wbq42wiltcrk****` is added. The returned result shows that the user is added to both the `TestGroup` and the `group1` groups.
9471
+ * @remarks
9472
+ * 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.
9366
9473
  *
9367
- * @param request ListJoinedGroupsForUserRequest
9368
- * @return ListJoinedGroupsForUserResponse
9474
+ * @param request - ListJoinedGroupsForUserRequest
9475
+ * @returns ListJoinedGroupsForUserResponse
9369
9476
  */
9370
9477
  async listJoinedGroupsForUser(request) {
9371
9478
  let runtime = new $Util.RuntimeOptions({});
9372
9479
  return await this.listJoinedGroupsForUserWithOptions(request, runtime);
9373
9480
  }
9374
9481
  /**
9375
- * @summary Queries the multi-factor authentication (MFA) devices that are bound to a user. Up to two MFA devices can be bound to a user.
9482
+ * Queries the multi-factor authentication (MFA) devices that are bound to a user. Up to two MFA devices can be bound to a user.
9376
9483
  *
9377
- * @description This topic provides an example on how to query the MFA devices that are bound to the user `u-00q8wbq42wiltcrk****`. The returned result shows that the MFA device named `Alice-MFA1` is bound to the user.
9484
+ * @remarks
9485
+ * 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.
9378
9486
  *
9379
- * @param request ListMFADevicesForUserRequest
9380
- * @param runtime runtime options for this request RuntimeOptions
9381
- * @return ListMFADevicesForUserResponse
9487
+ * @param request - ListMFADevicesForUserRequest
9488
+ * @param runtime - runtime options for this request RuntimeOptions
9489
+ * @returns ListMFADevicesForUserResponse
9382
9490
  */
9383
9491
  async listMFADevicesForUserWithOptions(request, runtime) {
9384
9492
  tea_util_1.default.validateModel(request);
@@ -9406,25 +9514,27 @@ class Client extends openapi_client_1.default {
9406
9514
  return $tea.cast(await this.callApi(params, req, runtime), new ListMFADevicesForUserResponse({}));
9407
9515
  }
9408
9516
  /**
9409
- * @summary Queries the multi-factor authentication (MFA) devices that are bound to a user. Up to two MFA devices can be bound to a user.
9517
+ * Queries the multi-factor authentication (MFA) devices that are bound to a user. Up to two MFA devices can be bound to a user.
9410
9518
  *
9411
- * @description This topic provides an example on how to query the MFA devices that are bound to the user `u-00q8wbq42wiltcrk****`. The returned result shows that the MFA device named `Alice-MFA1` is bound to the user.
9519
+ * @remarks
9520
+ * 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.
9412
9521
  *
9413
- * @param request ListMFADevicesForUserRequest
9414
- * @return ListMFADevicesForUserResponse
9522
+ * @param request - ListMFADevicesForUserRequest
9523
+ * @returns ListMFADevicesForUserResponse
9415
9524
  */
9416
9525
  async listMFADevicesForUser(request) {
9417
9526
  let runtime = new $Util.RuntimeOptions({});
9418
9527
  return await this.listMFADevicesForUserWithOptions(request, runtime);
9419
9528
  }
9420
9529
  /**
9421
- * @summary Queries the policies that are created for an access configuration.
9530
+ * Queries the policies that are created for an access configuration.
9422
9531
  *
9423
- * @description This topic provides an example on how to query the policies that are created for the access configuration `ac-00jhtfl8thteu6uj****`. The returned result shows that the access configuration contains one system policy and one inline policy.
9532
+ * @remarks
9533
+ * 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.
9424
9534
  *
9425
- * @param request ListPermissionPoliciesInAccessConfigurationRequest
9426
- * @param runtime runtime options for this request RuntimeOptions
9427
- * @return ListPermissionPoliciesInAccessConfigurationResponse
9535
+ * @param request - ListPermissionPoliciesInAccessConfigurationRequest
9536
+ * @param runtime - runtime options for this request RuntimeOptions
9537
+ * @returns ListPermissionPoliciesInAccessConfigurationResponse
9428
9538
  */
9429
9539
  async listPermissionPoliciesInAccessConfigurationWithOptions(request, runtime) {
9430
9540
  tea_util_1.default.validateModel(request);
@@ -9455,25 +9565,27 @@ class Client extends openapi_client_1.default {
9455
9565
  return $tea.cast(await this.callApi(params, req, runtime), new ListPermissionPoliciesInAccessConfigurationResponse({}));
9456
9566
  }
9457
9567
  /**
9458
- * @summary Queries the policies that are created for an access configuration.
9568
+ * Queries the policies that are created for an access configuration.
9459
9569
  *
9460
- * @description This topic provides an example on how to query the policies that are created for the access configuration `ac-00jhtfl8thteu6uj****`. The returned result shows that the access configuration contains one system policy and one inline policy.
9570
+ * @remarks
9571
+ * 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.
9461
9572
  *
9462
- * @param request ListPermissionPoliciesInAccessConfigurationRequest
9463
- * @return ListPermissionPoliciesInAccessConfigurationResponse
9573
+ * @param request - ListPermissionPoliciesInAccessConfigurationRequest
9574
+ * @returns ListPermissionPoliciesInAccessConfigurationResponse
9464
9575
  */
9465
9576
  async listPermissionPoliciesInAccessConfiguration(request) {
9466
9577
  let runtime = new $Util.RuntimeOptions({});
9467
9578
  return await this.listPermissionPoliciesInAccessConfigurationWithOptions(request, runtime);
9468
9579
  }
9469
9580
  /**
9470
- * @summary Queries Cross-domain Identity Management (SCIM) credentials.
9581
+ * Queries Cross-domain Identity Management (SCIM) credentials.
9471
9582
  *
9472
- * @description This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
9583
+ * @remarks
9584
+ * This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
9473
9585
  *
9474
- * @param request ListSCIMServerCredentialsRequest
9475
- * @param runtime runtime options for this request RuntimeOptions
9476
- * @return ListSCIMServerCredentialsResponse
9586
+ * @param request - ListSCIMServerCredentialsRequest
9587
+ * @param runtime - runtime options for this request RuntimeOptions
9588
+ * @returns ListSCIMServerCredentialsResponse
9477
9589
  */
9478
9590
  async listSCIMServerCredentialsWithOptions(request, runtime) {
9479
9591
  tea_util_1.default.validateModel(request);
@@ -9498,26 +9610,28 @@ class Client extends openapi_client_1.default {
9498
9610
  return $tea.cast(await this.callApi(params, req, runtime), new ListSCIMServerCredentialsResponse({}));
9499
9611
  }
9500
9612
  /**
9501
- * @summary Queries Cross-domain Identity Management (SCIM) credentials.
9613
+ * Queries Cross-domain Identity Management (SCIM) credentials.
9502
9614
  *
9503
- * @description This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
9615
+ * @remarks
9616
+ * This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
9504
9617
  *
9505
- * @param request ListSCIMServerCredentialsRequest
9506
- * @return ListSCIMServerCredentialsResponse
9618
+ * @param request - ListSCIMServerCredentialsRequest
9619
+ * @returns ListSCIMServerCredentialsResponse
9507
9620
  */
9508
9621
  async listSCIMServerCredentials(request) {
9509
9622
  let runtime = new $Util.RuntimeOptions({});
9510
9623
  return await this.listSCIMServerCredentialsWithOptions(request, runtime);
9511
9624
  }
9512
9625
  /**
9513
- * @summary Queries asynchronous tasks.
9626
+ * Queries asynchronous tasks.
9514
9627
  *
9515
- * @description By default, this operation queries the tasks within the previous 24 hours. This operation allows you to query the tasks within a maximum of 7 days. You can specify the start time of the query by using `Filter`.
9628
+ * @remarks
9629
+ * 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`.
9516
9630
  * This topic provides an example on how to query the tasks within the previous 24 hours.
9517
9631
  *
9518
- * @param request ListTasksRequest
9519
- * @param runtime runtime options for this request RuntimeOptions
9520
- * @return ListTasksResponse
9632
+ * @param request - ListTasksRequest
9633
+ * @param runtime - runtime options for this request RuntimeOptions
9634
+ * @returns ListTasksResponse
9521
9635
  */
9522
9636
  async listTasksWithOptions(request, runtime) {
9523
9637
  tea_util_1.default.validateModel(request);
@@ -9572,24 +9686,25 @@ class Client extends openapi_client_1.default {
9572
9686
  return $tea.cast(await this.callApi(params, req, runtime), new ListTasksResponse({}));
9573
9687
  }
9574
9688
  /**
9575
- * @summary Queries asynchronous tasks.
9689
+ * Queries asynchronous tasks.
9576
9690
  *
9577
- * @description By default, this operation queries the tasks within the previous 24 hours. This operation allows you to query the tasks within a maximum of 7 days. You can specify the start time of the query by using `Filter`.
9691
+ * @remarks
9692
+ * 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`.
9578
9693
  * This topic provides an example on how to query the tasks within the previous 24 hours.
9579
9694
  *
9580
- * @param request ListTasksRequest
9581
- * @return ListTasksResponse
9695
+ * @param request - ListTasksRequest
9696
+ * @returns ListTasksResponse
9582
9697
  */
9583
9698
  async listTasks(request) {
9584
9699
  let runtime = new $Util.RuntimeOptions({});
9585
9700
  return await this.listTasksWithOptions(request, runtime);
9586
9701
  }
9587
9702
  /**
9588
- * @summary Queries Resource Access Management (RAM) user provisioning events.
9703
+ * Queries Resource Access Management (RAM) user provisioning events.
9589
9704
  *
9590
- * @param request ListUserProvisioningEventsRequest
9591
- * @param runtime runtime options for this request RuntimeOptions
9592
- * @return ListUserProvisioningEventsResponse
9705
+ * @param request - ListUserProvisioningEventsRequest
9706
+ * @param runtime - runtime options for this request RuntimeOptions
9707
+ * @returns ListUserProvisioningEventsResponse
9593
9708
  */
9594
9709
  async listUserProvisioningEventsWithOptions(request, runtime) {
9595
9710
  tea_util_1.default.validateModel(request);
@@ -9623,21 +9738,21 @@ class Client extends openapi_client_1.default {
9623
9738
  return $tea.cast(await this.callApi(params, req, runtime), new ListUserProvisioningEventsResponse({}));
9624
9739
  }
9625
9740
  /**
9626
- * @summary Queries Resource Access Management (RAM) user provisioning events.
9741
+ * Queries Resource Access Management (RAM) user provisioning events.
9627
9742
  *
9628
- * @param request ListUserProvisioningEventsRequest
9629
- * @return ListUserProvisioningEventsResponse
9743
+ * @param request - ListUserProvisioningEventsRequest
9744
+ * @returns ListUserProvisioningEventsResponse
9630
9745
  */
9631
9746
  async listUserProvisioningEvents(request) {
9632
9747
  let runtime = new $Util.RuntimeOptions({});
9633
9748
  return await this.listUserProvisioningEventsWithOptions(request, runtime);
9634
9749
  }
9635
9750
  /**
9636
- * @summary Queries Resource Access Management (RAM) user provisionings.
9751
+ * Queries Resource Access Management (RAM) user provisionings.
9637
9752
  *
9638
- * @param request ListUserProvisioningsRequest
9639
- * @param runtime runtime options for this request RuntimeOptions
9640
- * @return ListUserProvisioningsResponse
9753
+ * @param request - ListUserProvisioningsRequest
9754
+ * @param runtime - runtime options for this request RuntimeOptions
9755
+ * @returns ListUserProvisioningsResponse
9641
9756
  */
9642
9757
  async listUserProvisioningsWithOptions(request, runtime) {
9643
9758
  tea_util_1.default.validateModel(request);
@@ -9680,23 +9795,24 @@ class Client extends openapi_client_1.default {
9680
9795
  return $tea.cast(await this.callApi(params, req, runtime), new ListUserProvisioningsResponse({}));
9681
9796
  }
9682
9797
  /**
9683
- * @summary Queries Resource Access Management (RAM) user provisionings.
9798
+ * Queries Resource Access Management (RAM) user provisionings.
9684
9799
  *
9685
- * @param request ListUserProvisioningsRequest
9686
- * @return ListUserProvisioningsResponse
9800
+ * @param request - ListUserProvisioningsRequest
9801
+ * @returns ListUserProvisioningsResponse
9687
9802
  */
9688
9803
  async listUserProvisionings(request) {
9689
9804
  let runtime = new $Util.RuntimeOptions({});
9690
9805
  return await this.listUserProvisioningsWithOptions(request, runtime);
9691
9806
  }
9692
9807
  /**
9693
- * @summary Queries users.
9808
+ * Queries users.
9694
9809
  *
9695
- * @description This topic provides an example on how to query users in the `d-00fc2p61****` directory. The returned result shows that the directory contains two users. The user `AliceLee` is synchronized from an external identity provider (IdP). The user `user1` is manually created within CloudSSO.
9810
+ * @remarks
9811
+ * 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.
9696
9812
  *
9697
- * @param request ListUsersRequest
9698
- * @param runtime runtime options for this request RuntimeOptions
9699
- * @return ListUsersResponse
9813
+ * @param request - ListUsersRequest
9814
+ * @param runtime - runtime options for this request RuntimeOptions
9815
+ * @returns ListUsersResponse
9700
9816
  */
9701
9817
  async listUsersWithOptions(request, runtime) {
9702
9818
  tea_util_1.default.validateModel(request);
@@ -9736,26 +9852,28 @@ class Client extends openapi_client_1.default {
9736
9852
  return $tea.cast(await this.callApi(params, req, runtime), new ListUsersResponse({}));
9737
9853
  }
9738
9854
  /**
9739
- * @summary Queries users.
9855
+ * Queries users.
9740
9856
  *
9741
- * @description This topic provides an example on how to query users in the `d-00fc2p61****` directory. The returned result shows that the directory contains two users. The user `AliceLee` is synchronized from an external identity provider (IdP). The user `user1` is manually created within CloudSSO.
9857
+ * @remarks
9858
+ * 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.
9742
9859
  *
9743
- * @param request ListUsersRequest
9744
- * @return ListUsersResponse
9860
+ * @param request - ListUsersRequest
9861
+ * @returns ListUsersResponse
9745
9862
  */
9746
9863
  async listUsers(request) {
9747
9864
  let runtime = new $Util.RuntimeOptions({});
9748
9865
  return await this.listUsersWithOptions(request, runtime);
9749
9866
  }
9750
9867
  /**
9751
- * @summary Provisions an access configuration for an account in your resource directory.
9868
+ * Provisions an access configuration for an account in your resource directory.
9752
9869
  *
9753
- * @description When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
9870
+ * @remarks
9871
+ * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
9754
9872
  * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
9755
9873
  *
9756
- * @param request ProvisionAccessConfigurationRequest
9757
- * @param runtime runtime options for this request RuntimeOptions
9758
- * @return ProvisionAccessConfigurationResponse
9874
+ * @param request - ProvisionAccessConfigurationRequest
9875
+ * @param runtime - runtime options for this request RuntimeOptions
9876
+ * @returns ProvisionAccessConfigurationResponse
9759
9877
  */
9760
9878
  async provisionAccessConfigurationWithOptions(request, runtime) {
9761
9879
  tea_util_1.default.validateModel(request);
@@ -9789,26 +9907,28 @@ class Client extends openapi_client_1.default {
9789
9907
  return $tea.cast(await this.callApi(params, req, runtime), new ProvisionAccessConfigurationResponse({}));
9790
9908
  }
9791
9909
  /**
9792
- * @summary Provisions an access configuration for an account in your resource directory.
9910
+ * Provisions an access configuration for an account in your resource directory.
9793
9911
  *
9794
- * @description When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
9912
+ * @remarks
9913
+ * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
9795
9914
  * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
9796
9915
  *
9797
- * @param request ProvisionAccessConfigurationRequest
9798
- * @return ProvisionAccessConfigurationResponse
9916
+ * @param request - ProvisionAccessConfigurationRequest
9917
+ * @returns ProvisionAccessConfigurationResponse
9799
9918
  */
9800
9919
  async provisionAccessConfiguration(request) {
9801
9920
  let runtime = new $Util.RuntimeOptions({});
9802
9921
  return await this.provisionAccessConfigurationWithOptions(request, runtime);
9803
9922
  }
9804
9923
  /**
9805
- * @summary Removes a Security Assertion Markup Language (SAML) signing certificate.
9924
+ * Removes a Security Assertion Markup Language (SAML) signing certificate.
9806
9925
  *
9807
- * @description This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
9926
+ * @remarks
9927
+ * This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
9808
9928
  *
9809
- * @param request RemoveExternalSAMLIdPCertificateRequest
9810
- * @param runtime runtime options for this request RuntimeOptions
9811
- * @return RemoveExternalSAMLIdPCertificateResponse
9929
+ * @param request - RemoveExternalSAMLIdPCertificateRequest
9930
+ * @param runtime - runtime options for this request RuntimeOptions
9931
+ * @returns RemoveExternalSAMLIdPCertificateResponse
9812
9932
  */
9813
9933
  async removeExternalSAMLIdPCertificateWithOptions(request, runtime) {
9814
9934
  tea_util_1.default.validateModel(request);
@@ -9836,26 +9956,28 @@ class Client extends openapi_client_1.default {
9836
9956
  return $tea.cast(await this.callApi(params, req, runtime), new RemoveExternalSAMLIdPCertificateResponse({}));
9837
9957
  }
9838
9958
  /**
9839
- * @summary Removes a Security Assertion Markup Language (SAML) signing certificate.
9959
+ * Removes a Security Assertion Markup Language (SAML) signing certificate.
9840
9960
  *
9841
- * @description This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
9961
+ * @remarks
9962
+ * This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
9842
9963
  *
9843
- * @param request RemoveExternalSAMLIdPCertificateRequest
9844
- * @return RemoveExternalSAMLIdPCertificateResponse
9964
+ * @param request - RemoveExternalSAMLIdPCertificateRequest
9965
+ * @returns RemoveExternalSAMLIdPCertificateResponse
9845
9966
  */
9846
9967
  async removeExternalSAMLIdPCertificate(request) {
9847
9968
  let runtime = new $Util.RuntimeOptions({});
9848
9969
  return await this.removeExternalSAMLIdPCertificateWithOptions(request, runtime);
9849
9970
  }
9850
9971
  /**
9851
- * @summary Removes a policy from an access configuration.
9972
+ * Removes a policy from an access configuration.
9852
9973
  *
9853
- * @description After you remove an inline policy from an access configuration, the policy cannot be restored.
9974
+ * @remarks
9975
+ * After you remove an inline policy from an access configuration, the policy cannot be restored.
9854
9976
  * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
9855
9977
  *
9856
- * @param request RemovePermissionPolicyFromAccessConfigurationRequest
9857
- * @param runtime runtime options for this request RuntimeOptions
9858
- * @return RemovePermissionPolicyFromAccessConfigurationResponse
9978
+ * @param request - RemovePermissionPolicyFromAccessConfigurationRequest
9979
+ * @param runtime - runtime options for this request RuntimeOptions
9980
+ * @returns RemovePermissionPolicyFromAccessConfigurationResponse
9859
9981
  */
9860
9982
  async removePermissionPolicyFromAccessConfigurationWithOptions(request, runtime) {
9861
9983
  tea_util_1.default.validateModel(request);
@@ -9889,27 +10011,29 @@ class Client extends openapi_client_1.default {
9889
10011
  return $tea.cast(await this.callApi(params, req, runtime), new RemovePermissionPolicyFromAccessConfigurationResponse({}));
9890
10012
  }
9891
10013
  /**
9892
- * @summary Removes a policy from an access configuration.
10014
+ * Removes a policy from an access configuration.
9893
10015
  *
9894
- * @description After you remove an inline policy from an access configuration, the policy cannot be restored.
10016
+ * @remarks
10017
+ * After you remove an inline policy from an access configuration, the policy cannot be restored.
9895
10018
  * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
9896
10019
  *
9897
- * @param request RemovePermissionPolicyFromAccessConfigurationRequest
9898
- * @return RemovePermissionPolicyFromAccessConfigurationResponse
10020
+ * @param request - RemovePermissionPolicyFromAccessConfigurationRequest
10021
+ * @returns RemovePermissionPolicyFromAccessConfigurationResponse
9899
10022
  */
9900
10023
  async removePermissionPolicyFromAccessConfiguration(request) {
9901
10024
  let runtime = new $Util.RuntimeOptions({});
9902
10025
  return await this.removePermissionPolicyFromAccessConfigurationWithOptions(request, runtime);
9903
10026
  }
9904
10027
  /**
9905
- * @summary Removes a user from a group.
10028
+ * Removes a user from a group.
9906
10029
  *
9907
- * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot remove a user from a group that is synchronized by using SCIM.
10030
+ * @remarks
10031
+ * 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.
9908
10032
  * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
9909
10033
  *
9910
- * @param request RemoveUserFromGroupRequest
9911
- * @param runtime runtime options for this request RuntimeOptions
9912
- * @return RemoveUserFromGroupResponse
10034
+ * @param request - RemoveUserFromGroupRequest
10035
+ * @param runtime - runtime options for this request RuntimeOptions
10036
+ * @returns RemoveUserFromGroupResponse
9913
10037
  */
9914
10038
  async removeUserFromGroupWithOptions(request, runtime) {
9915
10039
  tea_util_1.default.validateModel(request);
@@ -9940,28 +10064,30 @@ class Client extends openapi_client_1.default {
9940
10064
  return $tea.cast(await this.callApi(params, req, runtime), new RemoveUserFromGroupResponse({}));
9941
10065
  }
9942
10066
  /**
9943
- * @summary Removes a user from a group.
10067
+ * Removes a user from a group.
9944
10068
  *
9945
- * @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot remove a user from a group that is synchronized by using SCIM.
10069
+ * @remarks
10070
+ * 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.
9946
10071
  * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
9947
10072
  *
9948
- * @param request RemoveUserFromGroupRequest
9949
- * @return RemoveUserFromGroupResponse
10073
+ * @param request - RemoveUserFromGroupRequest
10074
+ * @returns RemoveUserFromGroupResponse
9950
10075
  */
9951
10076
  async removeUserFromGroup(request) {
9952
10077
  let runtime = new $Util.RuntimeOptions({});
9953
10078
  return await this.removeUserFromGroupWithOptions(request, runtime);
9954
10079
  }
9955
10080
  /**
9956
- * @summary Resets the password of a user.
10081
+ * Resets the password of a user.
9957
10082
  *
9958
- * @description If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
10083
+ * @remarks
10084
+ * If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
9959
10085
  * > After you enable SSO logon, your password cannot be reset.
9960
10086
  * 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.
9961
10087
  *
9962
- * @param request ResetUserPasswordRequest
9963
- * @param runtime runtime options for this request RuntimeOptions
9964
- * @return ResetUserPasswordResponse
10088
+ * @param request - ResetUserPasswordRequest
10089
+ * @param runtime - runtime options for this request RuntimeOptions
10090
+ * @returns ResetUserPasswordResponse
9965
10091
  */
9966
10092
  async resetUserPasswordWithOptions(request, runtime) {
9967
10093
  tea_util_1.default.validateModel(request);
@@ -9998,25 +10124,26 @@ class Client extends openapi_client_1.default {
9998
10124
  return $tea.cast(await this.callApi(params, req, runtime), new ResetUserPasswordResponse({}));
9999
10125
  }
10000
10126
  /**
10001
- * @summary Resets the password of a user.
10127
+ * Resets the password of a user.
10002
10128
  *
10003
- * @description If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
10129
+ * @remarks
10130
+ * If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
10004
10131
  * > After you enable SSO logon, your password cannot be reset.
10005
10132
  * 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.
10006
10133
  *
10007
- * @param request ResetUserPasswordRequest
10008
- * @return ResetUserPasswordResponse
10134
+ * @param request - ResetUserPasswordRequest
10135
+ * @returns ResetUserPasswordResponse
10009
10136
  */
10010
10137
  async resetUserPassword(request) {
10011
10138
  let runtime = new $Util.RuntimeOptions({});
10012
10139
  return await this.resetUserPasswordWithOptions(request, runtime);
10013
10140
  }
10014
10141
  /**
10015
- * @summary Retries a Resource Access Management (RAM) user provisioning event.
10142
+ * Retries a Resource Access Management (RAM) user provisioning event.
10016
10143
  *
10017
- * @param request RetryUserProvisioningEventRequest
10018
- * @param runtime runtime options for this request RuntimeOptions
10019
- * @return RetryUserProvisioningEventResponse
10144
+ * @param request - RetryUserProvisioningEventRequest
10145
+ * @param runtime - runtime options for this request RuntimeOptions
10146
+ * @returns RetryUserProvisioningEventResponse
10020
10147
  */
10021
10148
  async retryUserProvisioningEventWithOptions(request, runtime) {
10022
10149
  tea_util_1.default.validateModel(request);
@@ -10047,19 +10174,20 @@ class Client extends openapi_client_1.default {
10047
10174
  return $tea.cast(await this.callApi(params, req, runtime), new RetryUserProvisioningEventResponse({}));
10048
10175
  }
10049
10176
  /**
10050
- * @summary Retries a Resource Access Management (RAM) user provisioning event.
10177
+ * Retries a Resource Access Management (RAM) user provisioning event.
10051
10178
  *
10052
- * @param request RetryUserProvisioningEventRequest
10053
- * @return RetryUserProvisioningEventResponse
10179
+ * @param request - RetryUserProvisioningEventRequest
10180
+ * @returns RetryUserProvisioningEventResponse
10054
10181
  */
10055
10182
  async retryUserProvisioningEvent(request) {
10056
10183
  let runtime = new $Util.RuntimeOptions({});
10057
10184
  return await this.retryUserProvisioningEventWithOptions(request, runtime);
10058
10185
  }
10059
10186
  /**
10060
- * @summary Configures a Security Assertion Markup Language (SAML) identity provider (IdP).
10187
+ * Configures a Security Assertion Markup Language (SAML) identity provider (IdP).
10061
10188
  *
10062
- * @description During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an IdP.
10189
+ * @remarks
10190
+ * 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.
10063
10191
  * 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.
10064
10192
  * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
10065
10193
  * * Manually configure the IdP. You can manually specify the following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
@@ -10069,13 +10197,16 @@ class Client extends openapi_client_1.default {
10069
10197
  * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
10070
10198
  * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
10071
10199
  *
10072
- * @param request SetExternalSAMLIdentityProviderRequest
10073
- * @param runtime runtime options for this request RuntimeOptions
10074
- * @return SetExternalSAMLIdentityProviderResponse
10200
+ * @param request - SetExternalSAMLIdentityProviderRequest
10201
+ * @param runtime - runtime options for this request RuntimeOptions
10202
+ * @returns SetExternalSAMLIdentityProviderResponse
10075
10203
  */
10076
10204
  async setExternalSAMLIdentityProviderWithOptions(request, runtime) {
10077
10205
  tea_util_1.default.validateModel(request);
10078
10206
  let query = {};
10207
+ if (!tea_util_1.default.isUnset(request.bindingType)) {
10208
+ query["BindingType"] = request.bindingType;
10209
+ }
10079
10210
  if (!tea_util_1.default.isUnset(request.directoryId)) {
10080
10211
  query["DirectoryId"] = request.directoryId;
10081
10212
  }
@@ -10114,9 +10245,10 @@ class Client extends openapi_client_1.default {
10114
10245
  return $tea.cast(await this.callApi(params, req, runtime), new SetExternalSAMLIdentityProviderResponse({}));
10115
10246
  }
10116
10247
  /**
10117
- * @summary Configures a Security Assertion Markup Language (SAML) identity provider (IdP).
10248
+ * Configures a Security Assertion Markup Language (SAML) identity provider (IdP).
10118
10249
  *
10119
- * @description During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an IdP.
10250
+ * @remarks
10251
+ * 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.
10120
10252
  * 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.
10121
10253
  * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
10122
10254
  * * Manually configure the IdP. You can manually specify the following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
@@ -10126,23 +10258,26 @@ class Client extends openapi_client_1.default {
10126
10258
  * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
10127
10259
  * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
10128
10260
  *
10129
- * @param request SetExternalSAMLIdentityProviderRequest
10130
- * @return SetExternalSAMLIdentityProviderResponse
10261
+ * @param request - SetExternalSAMLIdentityProviderRequest
10262
+ * @returns SetExternalSAMLIdentityProviderResponse
10131
10263
  */
10132
10264
  async setExternalSAMLIdentityProvider(request) {
10133
10265
  let runtime = new $Util.RuntimeOptions({});
10134
10266
  return await this.setExternalSAMLIdentityProviderWithOptions(request, runtime);
10135
10267
  }
10136
10268
  /**
10137
- * @summary Configures the logon preference of CloudSSO users.
10269
+ * Configures the logon preference of CloudSSO users.
10138
10270
  *
10139
- * @param request SetLoginPreferenceRequest
10140
- * @param runtime runtime options for this request RuntimeOptions
10141
- * @return SetLoginPreferenceResponse
10271
+ * @param request - SetLoginPreferenceRequest
10272
+ * @param runtime - runtime options for this request RuntimeOptions
10273
+ * @returns SetLoginPreferenceResponse
10142
10274
  */
10143
10275
  async setLoginPreferenceWithOptions(request, runtime) {
10144
10276
  tea_util_1.default.validateModel(request);
10145
10277
  let query = {};
10278
+ if (!tea_util_1.default.isUnset(request.allowUserToGetCredentials)) {
10279
+ query["AllowUserToGetCredentials"] = request.allowUserToGetCredentials;
10280
+ }
10146
10281
  if (!tea_util_1.default.isUnset(request.directoryId)) {
10147
10282
  query["DirectoryId"] = request.directoryId;
10148
10283
  }
@@ -10166,24 +10301,25 @@ class Client extends openapi_client_1.default {
10166
10301
  return $tea.cast(await this.callApi(params, req, runtime), new SetLoginPreferenceResponse({}));
10167
10302
  }
10168
10303
  /**
10169
- * @summary Configures the logon preference of CloudSSO users.
10304
+ * Configures the logon preference of CloudSSO users.
10170
10305
  *
10171
- * @param request SetLoginPreferenceRequest
10172
- * @return SetLoginPreferenceResponse
10306
+ * @param request - SetLoginPreferenceRequest
10307
+ * @returns SetLoginPreferenceResponse
10173
10308
  */
10174
10309
  async setLoginPreference(request) {
10175
10310
  let runtime = new $Util.RuntimeOptions({});
10176
10311
  return await this.setLoginPreferenceWithOptions(request, runtime);
10177
10312
  }
10178
10313
  /**
10179
- * @summary Enables or disables multi-factor authentication (MFA) for users in a directory.
10314
+ * Enables or disables multi-factor authentication (MFA) for users in a directory.
10180
10315
  *
10181
- * @description If a CloudSSO administrator enables username-password logon for users, CloudSSO automatically enables MFA to improve security. The administrator can call this operation to enable or disable MFA based on the business requirements.
10316
+ * @remarks
10317
+ * 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.
10182
10318
  * This topic provides an example on how to enable MFA for users.
10183
10319
  *
10184
- * @param request SetMFAAuthenticationStatusRequest
10185
- * @param runtime runtime options for this request RuntimeOptions
10186
- * @return SetMFAAuthenticationStatusResponse
10320
+ * @param request - SetMFAAuthenticationStatusRequest
10321
+ * @param runtime - runtime options for this request RuntimeOptions
10322
+ * @returns SetMFAAuthenticationStatusResponse
10187
10323
  */
10188
10324
  async setMFAAuthenticationStatusWithOptions(request, runtime) {
10189
10325
  tea_util_1.default.validateModel(request);
@@ -10211,24 +10347,25 @@ class Client extends openapi_client_1.default {
10211
10347
  return $tea.cast(await this.callApi(params, req, runtime), new SetMFAAuthenticationStatusResponse({}));
10212
10348
  }
10213
10349
  /**
10214
- * @summary Enables or disables multi-factor authentication (MFA) for users in a directory.
10350
+ * Enables or disables multi-factor authentication (MFA) for users in a directory.
10215
10351
  *
10216
- * @description If a CloudSSO administrator enables username-password logon for users, CloudSSO automatically enables MFA to improve security. The administrator can call this operation to enable or disable MFA based on the business requirements.
10352
+ * @remarks
10353
+ * 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.
10217
10354
  * This topic provides an example on how to enable MFA for users.
10218
10355
  *
10219
- * @param request SetMFAAuthenticationStatusRequest
10220
- * @return SetMFAAuthenticationStatusResponse
10356
+ * @param request - SetMFAAuthenticationStatusRequest
10357
+ * @returns SetMFAAuthenticationStatusResponse
10221
10358
  */
10222
10359
  async setMFAAuthenticationStatus(request) {
10223
10360
  let runtime = new $Util.RuntimeOptions({});
10224
10361
  return await this.setMFAAuthenticationStatusWithOptions(request, runtime);
10225
10362
  }
10226
10363
  /**
10227
- * @summary Configures a password policy for CloudSSO users.
10364
+ * Configures a password policy for CloudSSO users.
10228
10365
  *
10229
- * @param request SetPasswordPolicyRequest
10230
- * @param runtime runtime options for this request RuntimeOptions
10231
- * @return SetPasswordPolicyResponse
10366
+ * @param request - SetPasswordPolicyRequest
10367
+ * @param runtime - runtime options for this request RuntimeOptions
10368
+ * @returns SetPasswordPolicyResponse
10232
10369
  */
10233
10370
  async setPasswordPolicyWithOptions(request, runtime) {
10234
10371
  tea_util_1.default.validateModel(request);
@@ -10271,26 +10408,27 @@ class Client extends openapi_client_1.default {
10271
10408
  return $tea.cast(await this.callApi(params, req, runtime), new SetPasswordPolicyResponse({}));
10272
10409
  }
10273
10410
  /**
10274
- * @summary Configures a password policy for CloudSSO users.
10411
+ * Configures a password policy for CloudSSO users.
10275
10412
  *
10276
- * @param request SetPasswordPolicyRequest
10277
- * @return SetPasswordPolicyResponse
10413
+ * @param request - SetPasswordPolicyRequest
10414
+ * @returns SetPasswordPolicyResponse
10278
10415
  */
10279
10416
  async setPasswordPolicy(request) {
10280
10417
  let runtime = new $Util.RuntimeOptions({});
10281
10418
  return await this.setPasswordPolicyWithOptions(request, runtime);
10282
10419
  }
10283
10420
  /**
10284
- * @summary Enables or disables Cross-domain Identity Management (SCIM) synchronization.
10421
+ * Enables or disables Cross-domain Identity Management (SCIM) synchronization.
10285
10422
  *
10286
- * @description You can synchronize users or groups from an external identity provider (IdP) that supports SCIM 2.0 to CloudSSO only after SCIM synchronization is enabled. If you disable SCIM synchronization, you can no longer synchronize users or groups to CloudSSO. The following list describes the impacts after SCIM synchronization is enabled or disabled:
10423
+ * @remarks
10424
+ * 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:
10287
10425
  * * 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.
10288
10426
  * * 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.
10289
10427
  * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
10290
10428
  *
10291
- * @param request SetSCIMSynchronizationStatusRequest
10292
- * @param runtime runtime options for this request RuntimeOptions
10293
- * @return SetSCIMSynchronizationStatusResponse
10429
+ * @param request - SetSCIMSynchronizationStatusRequest
10430
+ * @param runtime - runtime options for this request RuntimeOptions
10431
+ * @returns SetSCIMSynchronizationStatusResponse
10294
10432
  */
10295
10433
  async setSCIMSynchronizationStatusWithOptions(request, runtime) {
10296
10434
  tea_util_1.default.validateModel(request);
@@ -10318,29 +10456,31 @@ class Client extends openapi_client_1.default {
10318
10456
  return $tea.cast(await this.callApi(params, req, runtime), new SetSCIMSynchronizationStatusResponse({}));
10319
10457
  }
10320
10458
  /**
10321
- * @summary Enables or disables Cross-domain Identity Management (SCIM) synchronization.
10459
+ * Enables or disables Cross-domain Identity Management (SCIM) synchronization.
10322
10460
  *
10323
- * @description You can synchronize users or groups from an external identity provider (IdP) that supports SCIM 2.0 to CloudSSO only after SCIM synchronization is enabled. If you disable SCIM synchronization, you can no longer synchronize users or groups to CloudSSO. The following list describes the impacts after SCIM synchronization is enabled or disabled:
10461
+ * @remarks
10462
+ * 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:
10324
10463
  * * 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.
10325
10464
  * * 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.
10326
10465
  * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
10327
10466
  *
10328
- * @param request SetSCIMSynchronizationStatusRequest
10329
- * @return SetSCIMSynchronizationStatusResponse
10467
+ * @param request - SetSCIMSynchronizationStatusRequest
10468
+ * @returns SetSCIMSynchronizationStatusResponse
10330
10469
  */
10331
10470
  async setSCIMSynchronizationStatus(request) {
10332
10471
  let runtime = new $Util.RuntimeOptions({});
10333
10472
  return await this.setSCIMSynchronizationStatusWithOptions(request, runtime);
10334
10473
  }
10335
10474
  /**
10336
- * @summary Modifies information about an access configuration.
10475
+ * Modifies information about an access configuration.
10337
10476
  *
10338
- * @description You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
10477
+ * @remarks
10478
+ * You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
10339
10479
  * 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`.
10340
10480
  *
10341
- * @param request UpdateAccessConfigurationRequest
10342
- * @param runtime runtime options for this request RuntimeOptions
10343
- * @return UpdateAccessConfigurationResponse
10481
+ * @param request - UpdateAccessConfigurationRequest
10482
+ * @param runtime - runtime options for this request RuntimeOptions
10483
+ * @returns UpdateAccessConfigurationResponse
10344
10484
  */
10345
10485
  async updateAccessConfigurationWithOptions(request, runtime) {
10346
10486
  tea_util_1.default.validateModel(request);
@@ -10377,27 +10517,29 @@ class Client extends openapi_client_1.default {
10377
10517
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateAccessConfigurationResponse({}));
10378
10518
  }
10379
10519
  /**
10380
- * @summary Modifies information about an access configuration.
10520
+ * Modifies information about an access configuration.
10381
10521
  *
10382
- * @description You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
10522
+ * @remarks
10523
+ * You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
10383
10524
  * 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`.
10384
10525
  *
10385
- * @param request UpdateAccessConfigurationRequest
10386
- * @return UpdateAccessConfigurationResponse
10526
+ * @param request - UpdateAccessConfigurationRequest
10527
+ * @returns UpdateAccessConfigurationResponse
10387
10528
  */
10388
10529
  async updateAccessConfiguration(request) {
10389
10530
  let runtime = new $Util.RuntimeOptions({});
10390
10531
  return await this.updateAccessConfigurationWithOptions(request, runtime);
10391
10532
  }
10392
10533
  /**
10393
- * @summary Changes the name of a directory.
10534
+ * Changes the name of a directory.
10394
10535
  *
10395
- * @description After you change the name of a directory, the URL that is used to log on to the Cloud SSO user portal is changed. You must notify the Cloud SSO users of the correct URL.
10536
+ * @remarks
10537
+ * 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.
10396
10538
  * This topic provides an example on how to change the name of a directory to `new-example`.
10397
10539
  *
10398
- * @param request UpdateDirectoryRequest
10399
- * @param runtime runtime options for this request RuntimeOptions
10400
- * @return UpdateDirectoryResponse
10540
+ * @param request - UpdateDirectoryRequest
10541
+ * @param runtime - runtime options for this request RuntimeOptions
10542
+ * @returns UpdateDirectoryResponse
10401
10543
  */
10402
10544
  async updateDirectoryWithOptions(request, runtime) {
10403
10545
  tea_util_1.default.validateModel(request);
@@ -10425,28 +10567,30 @@ class Client extends openapi_client_1.default {
10425
10567
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateDirectoryResponse({}));
10426
10568
  }
10427
10569
  /**
10428
- * @summary Changes the name of a directory.
10570
+ * Changes the name of a directory.
10429
10571
  *
10430
- * @description After you change the name of a directory, the URL that is used to log on to the Cloud SSO user portal is changed. You must notify the Cloud SSO users of the correct URL.
10572
+ * @remarks
10573
+ * 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.
10431
10574
  * This topic provides an example on how to change the name of a directory to `new-example`.
10432
10575
  *
10433
- * @param request UpdateDirectoryRequest
10434
- * @return UpdateDirectoryResponse
10576
+ * @param request - UpdateDirectoryRequest
10577
+ * @returns UpdateDirectoryResponse
10435
10578
  */
10436
10579
  async updateDirectory(request) {
10437
10580
  let runtime = new $Util.RuntimeOptions({});
10438
10581
  return await this.updateDirectoryWithOptions(request, runtime);
10439
10582
  }
10440
10583
  /**
10441
- * @summary Modifies information about a group.
10584
+ * Modifies information about a group.
10442
10585
  *
10443
- * @description You can modify `GroupName` and `Description` for a group.
10586
+ * @remarks
10587
+ * You can modify `GroupName` and `Description` for a group.
10444
10588
  * > 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.
10445
10589
  * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
10446
10590
  *
10447
- * @param request UpdateGroupRequest
10448
- * @param runtime runtime options for this request RuntimeOptions
10449
- * @return UpdateGroupResponse
10591
+ * @param request - UpdateGroupRequest
10592
+ * @param runtime - runtime options for this request RuntimeOptions
10593
+ * @returns UpdateGroupResponse
10450
10594
  */
10451
10595
  async updateGroupWithOptions(request, runtime) {
10452
10596
  tea_util_1.default.validateModel(request);
@@ -10480,27 +10624,29 @@ class Client extends openapi_client_1.default {
10480
10624
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateGroupResponse({}));
10481
10625
  }
10482
10626
  /**
10483
- * @summary Modifies information about a group.
10627
+ * Modifies information about a group.
10484
10628
  *
10485
- * @description You can modify `GroupName` and `Description` for a group.
10629
+ * @remarks
10630
+ * You can modify `GroupName` and `Description` for a group.
10486
10631
  * > 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.
10487
10632
  * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
10488
10633
  *
10489
- * @param request UpdateGroupRequest
10490
- * @return UpdateGroupResponse
10634
+ * @param request - UpdateGroupRequest
10635
+ * @returns UpdateGroupResponse
10491
10636
  */
10492
10637
  async updateGroup(request) {
10493
10638
  let runtime = new $Util.RuntimeOptions({});
10494
10639
  return await this.updateGroupWithOptions(request, runtime);
10495
10640
  }
10496
10641
  /**
10497
- * @summary Modifies an inline policy that is created for an access configuration.
10642
+ * Modifies an inline policy that is created for an access configuration.
10498
10643
  *
10499
- * @description This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
10644
+ * @remarks
10645
+ * This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
10500
10646
  *
10501
- * @param request UpdateInlinePolicyForAccessConfigurationRequest
10502
- * @param runtime runtime options for this request RuntimeOptions
10503
- * @return UpdateInlinePolicyForAccessConfigurationResponse
10647
+ * @param request - UpdateInlinePolicyForAccessConfigurationRequest
10648
+ * @param runtime - runtime options for this request RuntimeOptions
10649
+ * @returns UpdateInlinePolicyForAccessConfigurationResponse
10504
10650
  */
10505
10651
  async updateInlinePolicyForAccessConfigurationWithOptions(request, runtime) {
10506
10652
  tea_util_1.default.validateModel(request);
@@ -10534,26 +10680,28 @@ class Client extends openapi_client_1.default {
10534
10680
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateInlinePolicyForAccessConfigurationResponse({}));
10535
10681
  }
10536
10682
  /**
10537
- * @summary Modifies an inline policy that is created for an access configuration.
10683
+ * Modifies an inline policy that is created for an access configuration.
10538
10684
  *
10539
- * @description This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
10685
+ * @remarks
10686
+ * This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
10540
10687
  *
10541
- * @param request UpdateInlinePolicyForAccessConfigurationRequest
10542
- * @return UpdateInlinePolicyForAccessConfigurationResponse
10688
+ * @param request - UpdateInlinePolicyForAccessConfigurationRequest
10689
+ * @returns UpdateInlinePolicyForAccessConfigurationResponse
10543
10690
  */
10544
10691
  async updateInlinePolicyForAccessConfiguration(request) {
10545
10692
  let runtime = new $Util.RuntimeOptions({});
10546
10693
  return await this.updateInlinePolicyForAccessConfigurationWithOptions(request, runtime);
10547
10694
  }
10548
10695
  /**
10549
- * @summary Modifies the multi-factor authentication (MFA) setting of all users.
10696
+ * Modifies the multi-factor authentication (MFA) setting of all users.
10550
10697
  *
10551
- * @description If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
10698
+ * @remarks
10699
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
10552
10700
  * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
10553
10701
  *
10554
- * @param request UpdateMFAAuthenticationSettingsRequest
10555
- * @param runtime runtime options for this request RuntimeOptions
10556
- * @return UpdateMFAAuthenticationSettingsResponse
10702
+ * @param request - UpdateMFAAuthenticationSettingsRequest
10703
+ * @param runtime - runtime options for this request RuntimeOptions
10704
+ * @returns UpdateMFAAuthenticationSettingsResponse
10557
10705
  */
10558
10706
  async updateMFAAuthenticationSettingsWithOptions(request, runtime) {
10559
10707
  tea_util_1.default.validateModel(request);
@@ -10584,26 +10732,28 @@ class Client extends openapi_client_1.default {
10584
10732
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateMFAAuthenticationSettingsResponse({}));
10585
10733
  }
10586
10734
  /**
10587
- * @summary Modifies the multi-factor authentication (MFA) setting of all users.
10735
+ * Modifies the multi-factor authentication (MFA) setting of all users.
10588
10736
  *
10589
- * @description If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
10737
+ * @remarks
10738
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
10590
10739
  * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
10591
10740
  *
10592
- * @param request UpdateMFAAuthenticationSettingsRequest
10593
- * @return UpdateMFAAuthenticationSettingsResponse
10741
+ * @param request - UpdateMFAAuthenticationSettingsRequest
10742
+ * @returns UpdateMFAAuthenticationSettingsResponse
10594
10743
  */
10595
10744
  async updateMFAAuthenticationSettings(request) {
10596
10745
  let runtime = new $Util.RuntimeOptions({});
10597
10746
  return await this.updateMFAAuthenticationSettingsWithOptions(request, runtime);
10598
10747
  }
10599
10748
  /**
10600
- * @summary Enables or disables a Cross-domain Identity Management (SCIM) credential.
10749
+ * Enables or disables a Cross-domain Identity Management (SCIM) credential.
10601
10750
  *
10602
- * @description This topic provides an example on how to disable the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`. After the SCIM credential is disabled, the synchronization task that uses the SCIM credential fails. You can call this operation again to enable the SCIM credential.
10751
+ * @remarks
10752
+ * 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.
10603
10753
  *
10604
- * @param request UpdateSCIMServerCredentialStatusRequest
10605
- * @param runtime runtime options for this request RuntimeOptions
10606
- * @return UpdateSCIMServerCredentialStatusResponse
10754
+ * @param request - UpdateSCIMServerCredentialStatusRequest
10755
+ * @param runtime - runtime options for this request RuntimeOptions
10756
+ * @returns UpdateSCIMServerCredentialStatusResponse
10607
10757
  */
10608
10758
  async updateSCIMServerCredentialStatusWithOptions(request, runtime) {
10609
10759
  tea_util_1.default.validateModel(request);
@@ -10634,27 +10784,29 @@ class Client extends openapi_client_1.default {
10634
10784
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateSCIMServerCredentialStatusResponse({}));
10635
10785
  }
10636
10786
  /**
10637
- * @summary Enables or disables a Cross-domain Identity Management (SCIM) credential.
10787
+ * Enables or disables a Cross-domain Identity Management (SCIM) credential.
10638
10788
  *
10639
- * @description This topic provides an example on how to disable the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`. After the SCIM credential is disabled, the synchronization task that uses the SCIM credential fails. You can call this operation again to enable the SCIM credential.
10789
+ * @remarks
10790
+ * 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.
10640
10791
  *
10641
- * @param request UpdateSCIMServerCredentialStatusRequest
10642
- * @return UpdateSCIMServerCredentialStatusResponse
10792
+ * @param request - UpdateSCIMServerCredentialStatusRequest
10793
+ * @returns UpdateSCIMServerCredentialStatusResponse
10643
10794
  */
10644
10795
  async updateSCIMServerCredentialStatus(request) {
10645
10796
  let runtime = new $Util.RuntimeOptions({});
10646
10797
  return await this.updateSCIMServerCredentialStatusWithOptions(request, runtime);
10647
10798
  }
10648
10799
  /**
10649
- * @summary Modifies information about a user.
10800
+ * Modifies information about a user.
10650
10801
  *
10651
- * @description You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
10802
+ * @remarks
10803
+ * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
10652
10804
  * > 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.
10653
10805
  * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
10654
10806
  *
10655
- * @param request UpdateUserRequest
10656
- * @param runtime runtime options for this request RuntimeOptions
10657
- * @return UpdateUserResponse
10807
+ * @param request - UpdateUserRequest
10808
+ * @param runtime - runtime options for this request RuntimeOptions
10809
+ * @returns UpdateUserResponse
10658
10810
  */
10659
10811
  async updateUserWithOptions(request, runtime) {
10660
10812
  tea_util_1.default.validateModel(request);
@@ -10697,29 +10849,31 @@ class Client extends openapi_client_1.default {
10697
10849
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateUserResponse({}));
10698
10850
  }
10699
10851
  /**
10700
- * @summary Modifies information about a user.
10852
+ * Modifies information about a user.
10701
10853
  *
10702
- * @description You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
10854
+ * @remarks
10855
+ * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
10703
10856
  * > 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.
10704
10857
  * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
10705
10858
  *
10706
- * @param request UpdateUserRequest
10707
- * @return UpdateUserResponse
10859
+ * @param request - UpdateUserRequest
10860
+ * @returns UpdateUserResponse
10708
10861
  */
10709
10862
  async updateUser(request) {
10710
10863
  let runtime = new $Util.RuntimeOptions({});
10711
10864
  return await this.updateUserWithOptions(request, runtime);
10712
10865
  }
10713
10866
  /**
10714
- * @summary Modifies the multi-factor authentication (MFA) setting of a single user.
10867
+ * Modifies the multi-factor authentication (MFA) setting of a single user.
10715
10868
  *
10716
- * @description If you call the [UpdateMFAAuthenticationSettings](https://help.aliyun.com/document_detail/450134.html) operation to set the MFAAuthenticationSettings parameter to `Byuser`, user-specific settings are applied. Then, you must call the UpdateUserMFAAuthenticationSettings operation to configure MFA for each user.
10869
+ * @remarks
10870
+ * If you call the [UpdateMFAAuthenticationSettings](https://help.aliyun.com/document_detail/450134.html) operation to set the MFAAuthenticationSettings parameter to `Byuser`, user-specific settings are applied. Then, you must call the UpdateUserMFAAuthenticationSettings operation to configure MFA for each user.
10717
10871
  * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
10718
10872
  * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
10719
10873
  *
10720
- * @param request UpdateUserMFAAuthenticationSettingsRequest
10721
- * @param runtime runtime options for this request RuntimeOptions
10722
- * @return UpdateUserMFAAuthenticationSettingsResponse
10874
+ * @param request - UpdateUserMFAAuthenticationSettingsRequest
10875
+ * @param runtime - runtime options for this request RuntimeOptions
10876
+ * @returns UpdateUserMFAAuthenticationSettingsResponse
10723
10877
  */
10724
10878
  async updateUserMFAAuthenticationSettingsWithOptions(request, runtime) {
10725
10879
  tea_util_1.default.validateModel(request);
@@ -10750,25 +10904,26 @@ class Client extends openapi_client_1.default {
10750
10904
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateUserMFAAuthenticationSettingsResponse({}));
10751
10905
  }
10752
10906
  /**
10753
- * @summary Modifies the multi-factor authentication (MFA) setting of a single user.
10907
+ * Modifies the multi-factor authentication (MFA) setting of a single user.
10754
10908
  *
10755
- * @description If you call the [UpdateMFAAuthenticationSettings](https://help.aliyun.com/document_detail/450134.html) operation to set the MFAAuthenticationSettings parameter to `Byuser`, user-specific settings are applied. Then, you must call the UpdateUserMFAAuthenticationSettings operation to configure MFA for each user.
10909
+ * @remarks
10910
+ * If you call the [UpdateMFAAuthenticationSettings](https://help.aliyun.com/document_detail/450134.html) operation to set the MFAAuthenticationSettings parameter to `Byuser`, user-specific settings are applied. Then, you must call the UpdateUserMFAAuthenticationSettings operation to configure MFA for each user.
10756
10911
  * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
10757
10912
  * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
10758
10913
  *
10759
- * @param request UpdateUserMFAAuthenticationSettingsRequest
10760
- * @return UpdateUserMFAAuthenticationSettingsResponse
10914
+ * @param request - UpdateUserMFAAuthenticationSettingsRequest
10915
+ * @returns UpdateUserMFAAuthenticationSettingsResponse
10761
10916
  */
10762
10917
  async updateUserMFAAuthenticationSettings(request) {
10763
10918
  let runtime = new $Util.RuntimeOptions({});
10764
10919
  return await this.updateUserMFAAuthenticationSettingsWithOptions(request, runtime);
10765
10920
  }
10766
10921
  /**
10767
- * @summary Modifies a Resource Access Management (RAM) user provisioning.
10922
+ * Modifies a Resource Access Management (RAM) user provisioning.
10768
10923
  *
10769
- * @param request UpdateUserProvisioningRequest
10770
- * @param runtime runtime options for this request RuntimeOptions
10771
- * @return UpdateUserProvisioningResponse
10924
+ * @param request - UpdateUserProvisioningRequest
10925
+ * @param runtime - runtime options for this request RuntimeOptions
10926
+ * @returns UpdateUserProvisioningResponse
10772
10927
  */
10773
10928
  async updateUserProvisioningWithOptions(request, runtime) {
10774
10929
  tea_util_1.default.validateModel(request);
@@ -10805,21 +10960,21 @@ class Client extends openapi_client_1.default {
10805
10960
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateUserProvisioningResponse({}));
10806
10961
  }
10807
10962
  /**
10808
- * @summary Modifies a Resource Access Management (RAM) user provisioning.
10963
+ * Modifies a Resource Access Management (RAM) user provisioning.
10809
10964
  *
10810
- * @param request UpdateUserProvisioningRequest
10811
- * @return UpdateUserProvisioningResponse
10965
+ * @param request - UpdateUserProvisioningRequest
10966
+ * @returns UpdateUserProvisioningResponse
10812
10967
  */
10813
10968
  async updateUserProvisioning(request) {
10814
10969
  let runtime = new $Util.RuntimeOptions({});
10815
10970
  return await this.updateUserProvisioningWithOptions(request, runtime);
10816
10971
  }
10817
10972
  /**
10818
- * @summary Modifies the global configurations of a Resource Access Management (RAM) user provisioning.
10973
+ * Modifies the global configurations of a Resource Access Management (RAM) user provisioning.
10819
10974
  *
10820
- * @param request UpdateUserProvisioningConfigurationRequest
10821
- * @param runtime runtime options for this request RuntimeOptions
10822
- * @return UpdateUserProvisioningConfigurationResponse
10975
+ * @param request - UpdateUserProvisioningConfigurationRequest
10976
+ * @param runtime - runtime options for this request RuntimeOptions
10977
+ * @returns UpdateUserProvisioningConfigurationResponse
10823
10978
  */
10824
10979
  async updateUserProvisioningConfigurationWithOptions(request, runtime) {
10825
10980
  tea_util_1.default.validateModel(request);
@@ -10850,23 +11005,24 @@ class Client extends openapi_client_1.default {
10850
11005
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateUserProvisioningConfigurationResponse({}));
10851
11006
  }
10852
11007
  /**
10853
- * @summary Modifies the global configurations of a Resource Access Management (RAM) user provisioning.
11008
+ * Modifies the global configurations of a Resource Access Management (RAM) user provisioning.
10854
11009
  *
10855
- * @param request UpdateUserProvisioningConfigurationRequest
10856
- * @return UpdateUserProvisioningConfigurationResponse
11010
+ * @param request - UpdateUserProvisioningConfigurationRequest
11011
+ * @returns UpdateUserProvisioningConfigurationResponse
10857
11012
  */
10858
11013
  async updateUserProvisioningConfiguration(request) {
10859
11014
  let runtime = new $Util.RuntimeOptions({});
10860
11015
  return await this.updateUserProvisioningConfigurationWithOptions(request, runtime);
10861
11016
  }
10862
11017
  /**
10863
- * @summary Changes the status of a user.
11018
+ * Changes the status of a user.
10864
11019
  *
10865
- * @description This topic provides an example on how to change the status of the user whose ID is `u-00q8wbq42wiltcrk****` to Disabled. Users in the Disabled state cannot log on to the CloudSSO user portal.
11020
+ * @remarks
11021
+ * 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.
10866
11022
  *
10867
- * @param request UpdateUserStatusRequest
10868
- * @param runtime runtime options for this request RuntimeOptions
10869
- * @return UpdateUserStatusResponse
11023
+ * @param request - UpdateUserStatusRequest
11024
+ * @param runtime - runtime options for this request RuntimeOptions
11025
+ * @returns UpdateUserStatusResponse
10870
11026
  */
10871
11027
  async updateUserStatusWithOptions(request, runtime) {
10872
11028
  tea_util_1.default.validateModel(request);
@@ -10897,12 +11053,13 @@ class Client extends openapi_client_1.default {
10897
11053
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateUserStatusResponse({}));
10898
11054
  }
10899
11055
  /**
10900
- * @summary Changes the status of a user.
11056
+ * Changes the status of a user.
10901
11057
  *
10902
- * @description This topic provides an example on how to change the status of the user whose ID is `u-00q8wbq42wiltcrk****` to Disabled. Users in the Disabled state cannot log on to the CloudSSO user portal.
11058
+ * @remarks
11059
+ * 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.
10903
11060
  *
10904
- * @param request UpdateUserStatusRequest
10905
- * @return UpdateUserStatusResponse
11061
+ * @param request - UpdateUserStatusRequest
11062
+ * @returns UpdateUserStatusResponse
10906
11063
  */
10907
11064
  async updateUserStatus(request) {
10908
11065
  let runtime = new $Util.RuntimeOptions({});