@alicloud/cloudsso20210515 1.5.2 → 1.5.3

package/dist/client.d.ts

@@ -127,7 +127,7 @@ export default class Client extends OpenApi {
      * Creates an access configuration.
      *
      * @remarks
-     * For more information about access configurations, see [Overview of access configurations](https://help.aliyun.com/document_detail/266737.html).
+     * For more information about access configurations, see [Access configuration overview](https://help.aliyun.com/document_detail/266737.html).
      * This topic provides an example on how to create an access configuration named `ECS-Admin`.
      *
      * @param request - CreateAccessConfigurationRequest
@@ -139,7 +139,7 @@ export default class Client extends OpenApi {
      * Creates an access configuration.
      *
      * @remarks
-     * For more information about access configurations, see [Overview of access configurations](https://help.aliyun.com/document_detail/266737.html).
+     * For more information about access configurations, see [Access configuration overview](https://help.aliyun.com/document_detail/266737.html).
      * This topic provides an example on how to create an access configuration named `ECS-Admin`.
      *
      * @param request - CreateAccessConfigurationRequest
@@ -226,9 +226,6 @@ export default class Client extends OpenApi {
     /**
      * Creates a user.
      *
-     * @remarks
-     * This topic provides an example on how to create a user named `Alice`.
-     *
      * @param request - CreateUserRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns CreateUserResponse
@@ -237,9 +234,6 @@ export default class Client extends OpenApi {
     /**
      * Creates a user.
      *
-     * @remarks
-     * This topic provides an example on how to create a user named `Alice`.
-     *
      * @param request - CreateUserRequest
      * @returns CreateUserResponse
      */
@@ -360,8 +354,8 @@ export default class Client extends OpenApi {
      * @remarks
      * ### [](#)Prerequisites
      * 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.
-     * *   Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
-     * *   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).
+     * - Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
+     * - 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).
      * ### [](#)Operation description
      * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
      * This topic provides an example on how to delete the group `g-00jqzghi2n3o5hkh****`.
@@ -377,8 +371,8 @@ export default class Client extends OpenApi {
      * @remarks
      * ### [](#)Prerequisites
      * 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.
-     * *   Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
-     * *   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).
+     * - Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
+     * - 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).
      * ### [](#)Operation description
      * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
      * This topic provides an example on how to delete the group `g-00jqzghi2n3o5hkh****`.
@@ -388,10 +382,10 @@ export default class Client extends OpenApi {
      */
     deleteGroup(request: $_model.DeleteGroupRequest): Promise<$_model.DeleteGroupResponse>;
     /**
-     * Unbinds a multi-factor authentication (MFA) device from a user.
+     * Deletes the MFA device of a user.
      *
      * @remarks
-     * This topic provides an example on how to unbind the MFA device whose ID is `mfa-00ujhet8pycljj7j****` from the user whose ID is `u-00q8wbq42wiltcrk****`.
+     * This topic provides an example on how to delete the MFA device `mfa-00ujhet8pycljj7j****` that is attached to the user `u-00q8wbq42wiltcrk****`.
      *
      * @param request - DeleteMFADeviceForUserRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -399,10 +393,10 @@ export default class Client extends OpenApi {
      */
     deleteMFADeviceForUserWithOptions(request: $_model.DeleteMFADeviceForUserRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteMFADeviceForUserResponse>;
     /**
-     * Unbinds a multi-factor authentication (MFA) device from a user.
+     * Deletes the MFA device of a user.
      *
      * @remarks
-     * This topic provides an example on how to unbind the MFA device whose ID is `mfa-00ujhet8pycljj7j****` from the user whose ID is `u-00q8wbq42wiltcrk****`.
+     * This topic provides an example on how to delete the MFA device `mfa-00ujhet8pycljj7j****` that is attached to the user `u-00q8wbq42wiltcrk****`.
      *
      * @param request - DeleteMFADeviceForUserRequest
      * @returns DeleteMFADeviceForUserResponse
@@ -538,9 +532,8 @@ export default class Client extends OpenApi {
      * Disables CloudSSO.
      *
      * @remarks
-     * 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.
+     * You can disable CloudSSO only when no directories exist in CloudSSO. After you disable CloudSSO, you can re-enable it at any time.
      *
-     * @param request - DisableServiceRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DisableServiceResponse
      */
@@ -549,7 +542,7 @@ export default class Client extends OpenApi {
      * Disables CloudSSO.
      *
      * @remarks
-     * 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.
+     * You can disable CloudSSO only when no directories exist in CloudSSO. After you disable CloudSSO, you can re-enable it at any time.
      * @returns DisableServiceResponse
      */
     disableService(): Promise<$_model.DisableServiceResponse>;
@@ -580,10 +573,9 @@ export default class Client extends OpenApi {
      * Enables CloudSSO.
      *
      * @remarks
-     * You can call this operation only if your account belongs to the management account that is used to enable a resource directory and has the permissions to enable CloudSSO. For more information, see [Enable CloudSSO](https://help.aliyun.com/document_detail/262819.html).
-     * 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).
+     * Only users under the management account of a resource directory who have the permissions to enable CloudSSO can call this operation. For more information, see [Enable CloudSSO](https://help.aliyun.com/document_detail/262819.html).
+     * By calling this operation, you agree to the [Alibaba Cloud International Website Product Terms of Service](https://www.alibabacloud.com/help/doc-detail/42416.htm).
      *
-     * @param request - EnableServiceRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns EnableServiceResponse
      */
@@ -592,16 +584,16 @@ export default class Client extends OpenApi {
      * Enables CloudSSO.
      *
      * @remarks
-     * You can call this operation only if your account belongs to the management account that is used to enable a resource directory and has the permissions to enable CloudSSO. For more information, see [Enable CloudSSO](https://help.aliyun.com/document_detail/262819.html).
-     * 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).
+     * Only users under the management account of a resource directory who have the permissions to enable CloudSSO can call this operation. For more information, see [Enable CloudSSO](https://help.aliyun.com/document_detail/262819.html).
+     * By calling this operation, you agree to the [Alibaba Cloud International Website Product Terms of Service](https://www.alibabacloud.com/help/doc-detail/42416.htm).
      * @returns EnableServiceResponse
      */
     enableService(): Promise<$_model.EnableServiceResponse>;
     /**
-     * Queries information about an access configuration.
+     * Queries the details of an access configuration.
      *
      * @remarks
-     * This topic provides an example on how to query information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
+     * This topic provides an example of how to query the details of an access configuration with the ID `ac-00ccule7tadaijxc****`.
      *
      * @param request - GetAccessConfigurationRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -609,10 +601,10 @@ export default class Client extends OpenApi {
      */
     getAccessConfigurationWithOptions(request: $_model.GetAccessConfigurationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetAccessConfigurationResponse>;
     /**
-     * Queries information about an access configuration.
+     * Queries the details of an access configuration.
      *
      * @remarks
-     * This topic provides an example on how to query information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
+     * This topic provides an example of how to query the details of an access configuration with the ID `ac-00ccule7tadaijxc****`.
      *
      * @param request - GetAccessConfigurationRequest
      * @returns GetAccessConfigurationResponse
@@ -741,11 +733,11 @@ export default class Client extends OpenApi {
      */
     getLoginPreference(request: $_model.GetLoginPreferenceRequest): Promise<$_model.GetLoginPreferenceResponse>;
     /**
-     * Queries the multi-factor authentication (MFA) setting of all users.
+     * Queries the global multi-factor authentication (MFA) configuration.
      *
      * @remarks
-     * If you enable username-password logon for CloudSSO users, you can query the MFA setting for the users.
-     * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `u-00q8wbq42wiltcrk****`.
+     * When username-password logon is enabled, you can retrieve the global MFA verification policy for user logon.
+     * This topic provides an example on how to query the global MFA verification policy for CloudSSO users in the directory `u-00q8wbq42wiltcrk****`.
      *
      * @param request - GetMFAAuthenticationSettingInfoRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -753,11 +745,11 @@ export default class Client extends OpenApi {
      */
     getMFAAuthenticationSettingInfoWithOptions(request: $_model.GetMFAAuthenticationSettingInfoRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetMFAAuthenticationSettingInfoResponse>;
     /**
-     * Queries the multi-factor authentication (MFA) setting of all users.
+     * Queries the global multi-factor authentication (MFA) configuration.
      *
      * @remarks
-     * If you enable username-password logon for CloudSSO users, you can query the MFA setting for the users.
-     * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `u-00q8wbq42wiltcrk****`.
+     * When username-password logon is enabled, you can retrieve the global MFA verification policy for user logon.
+     * This topic provides an example on how to query the global MFA verification policy for CloudSSO users in the directory `u-00q8wbq42wiltcrk****`.
      *
      * @param request - GetMFAAuthenticationSettingInfoRequest
      * @returns GetMFAAuthenticationSettingInfoResponse
@@ -846,7 +838,6 @@ export default class Client extends OpenApi {
     /**
      * Queries the status of CloudSSO.
      *
-     * @param request - GetServiceStatusRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns GetServiceStatusResponse
      */
@@ -901,10 +892,7 @@ export default class Client extends OpenApi {
      */
     getTaskStatus(request: $_model.GetTaskStatusRequest): Promise<$_model.GetTaskStatusResponse>;
     /**
-     * Queries information about a user.
-     *
-     * @remarks
-     * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
+     * Queries the information about a user.
      *
      * @param request - GetUserRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -912,10 +900,7 @@ export default class Client extends OpenApi {
      */
     getUserWithOptions(request: $_model.GetUserRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetUserResponse>;
     /**
-     * Queries information about a user.
-     *
-     * @remarks
-     * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
+     * Queries the information about a user.
      *
      * @param request - GetUserRequest
      * @returns GetUserResponse
@@ -1075,10 +1060,10 @@ export default class Client extends OpenApi {
      */
     listAccessConfigurationProvisionings(request: $_model.ListAccessConfigurationProvisioningsRequest): Promise<$_model.ListAccessConfigurationProvisioningsResponse>;
     /**
-     * Queries access configurations.
+     * Queries a list of access configurations.
      *
      * @remarks
-     * 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.
+     * This topic provides an example of how to query the access configurations in the folder `d-00fc2p61****`. The response shows two access configurations: `VPC-Admin` and `ECS-Admin`.
      *
      * @param request - ListAccessConfigurationsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1086,10 +1071,10 @@ export default class Client extends OpenApi {
      */
     listAccessConfigurationsWithOptions(request: $_model.ListAccessConfigurationsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListAccessConfigurationsResponse>;
     /**
-     * Queries access configurations.
+     * Queries a list of access configurations.
      *
      * @remarks
-     * 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.
+     * This topic provides an example of how to query the access configurations in the folder `d-00fc2p61****`. The response shows two access configurations: `VPC-Admin` and `ECS-Admin`.
      *
      * @param request - ListAccessConfigurationsRequest
      * @returns ListAccessConfigurationsResponse
@@ -1101,7 +1086,6 @@ export default class Client extends OpenApi {
      * @remarks
      * 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.
      *
-     * @param request - ListDirectoriesRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns ListDirectoriesResponse
      */
@@ -1199,10 +1183,10 @@ export default class Client extends OpenApi {
      */
     listJoinedGroupsForUser(request: $_model.ListJoinedGroupsForUserRequest): Promise<$_model.ListJoinedGroupsForUserResponse>;
     /**
-     * Queries the multi-factor authentication (MFA) devices that are bound to a user. Up to two MFA devices can be bound to a user.
+     * Queries the list of MFA devices for a user. Each user can have a maximum of two MFA devices.
      *
      * @remarks
-     * 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.
+     * This topic provides an example on how to query the MFA device list for the user `u-00q8wbq42wiltcrk****`. The response shows that the user has one MFA device named `Alice-MFA1`.
      *
      * @param request - ListMFADevicesForUserRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1210,10 +1194,10 @@ export default class Client extends OpenApi {
      */
     listMFADevicesForUserWithOptions(request: $_model.ListMFADevicesForUserRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListMFADevicesForUserResponse>;
     /**
-     * Queries the multi-factor authentication (MFA) devices that are bound to a user. Up to two MFA devices can be bound to a user.
+     * Queries the list of MFA devices for a user. Each user can have a maximum of two MFA devices.
      *
      * @remarks
-     * 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.
+     * This topic provides an example on how to query the MFA device list for the user `u-00q8wbq42wiltcrk****`. The response shows that the user has one MFA device named `Alice-MFA1`.
      *
      * @param request - ListMFADevicesForUserRequest
      * @returns ListMFADevicesForUserResponse
@@ -1315,10 +1299,7 @@ export default class Client extends OpenApi {
      */
     listUserProvisionings(request: $_model.ListUserProvisioningsRequest): Promise<$_model.ListUserProvisioningsResponse>;
     /**
-     * Queries users.
-     *
-     * @remarks
-     * 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.
+     * Queries a list of users.
      *
      * @param request - ListUsersRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1326,10 +1307,7 @@ export default class Client extends OpenApi {
      */
     listUsersWithOptions(request: $_model.ListUsersRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListUsersResponse>;
     /**
-     * Queries users.
-     *
-     * @remarks
-     * 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.
+     * Queries a list of users.
      *
      * @param request - ListUsersRequest
      * @returns ListUsersResponse
@@ -1430,7 +1408,7 @@ export default class Client extends OpenApi {
      *
      * @remarks
      * If a user forgets the password, the password expires, or the password poses security risks, a CloudSSO administrator can reset the password for the user.
-     * >  After you enable single sign-on (SSO) logon, the password of a user cannot be reset.
+     * > After you enable single sign-on (SSO) logon, the password of a user cannot be reset.
      * 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.
      *
      * @param request - ResetUserPasswordRequest
@@ -1443,7 +1421,7 @@ export default class Client extends OpenApi {
      *
      * @remarks
      * If a user forgets the password, the password expires, or the password poses security risks, a CloudSSO administrator can reset the password for the user.
-     * >  After you enable single sign-on (SSO) logon, the password of a user cannot be reset.
+     * > After you enable single sign-on (SSO) logon, the password of a user cannot be reset.
      * 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.
      *
      * @param request - ResetUserPasswordRequest
@@ -1633,7 +1611,7 @@ export default class Client extends OpenApi {
      *
      * @remarks
      * You can modify `GroupName` and `Description` for a group.
-     * >  If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify information about a group that is synchronized by using SCIM.
+     * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify information about a group that is synchronized by using SCIM.
      * This topic provides an example on how to modify the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
      *
      * @param request - UpdateGroupRequest
@@ -1646,7 +1624,7 @@ export default class Client extends OpenApi {
      *
      * @remarks
      * You can modify `GroupName` and `Description` for a group.
-     * >  If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify information about a group that is synchronized by using SCIM.
+     * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify information about a group that is synchronized by using SCIM.
      * This topic provides an example on how to modify the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
      *
      * @param request - UpdateGroupRequest
@@ -1675,23 +1653,23 @@ export default class Client extends OpenApi {
      */
     updateInlinePolicyForAccessConfiguration(request: $_model.UpdateInlinePolicyForAccessConfigurationRequest): Promise<$_model.UpdateInlinePolicyForAccessConfigurationResponse>;
     /**
-     * Modifies the multi-factor authentication (MFA) setting of all users.
+     * Modifies the global multi-factor authentication (MFA) settings.
      *
      * @remarks
-     * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
-     * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
+     * When username-password logon is enabled, you can configure the global MFA verification policy for user logon.
+     * This topic provides an example on how to enable MFA verification for all CloudSSO users in the directory `d-00fc2p61****`.
      *
-     * @param request - UpdateMFAAuthenticationSettingsRequest
+     * @param tmpReq - UpdateMFAAuthenticationSettingsRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns UpdateMFAAuthenticationSettingsResponse
      */
-    updateMFAAuthenticationSettingsWithOptions(request: $_model.UpdateMFAAuthenticationSettingsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateMFAAuthenticationSettingsResponse>;
+    updateMFAAuthenticationSettingsWithOptions(tmpReq: $_model.UpdateMFAAuthenticationSettingsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateMFAAuthenticationSettingsResponse>;
     /**
-     * Modifies the multi-factor authentication (MFA) setting of all users.
+     * Modifies the global multi-factor authentication (MFA) settings.
      *
      * @remarks
-     * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
-     * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
+     * When username-password logon is enabled, you can configure the global MFA verification policy for user logon.
+     * This topic provides an example on how to enable MFA verification for all CloudSSO users in the directory `d-00fc2p61****`.
      *
      * @param request - UpdateMFAAuthenticationSettingsRequest
      * @returns UpdateMFAAuthenticationSettingsResponse
@@ -1723,7 +1701,7 @@ export default class Client extends OpenApi {
      *
      * @remarks
      * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
-     * >  If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify information about a user that is synchronized by using SCIM.
+     * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify information about a user that is synchronized by using SCIM.
      *
      * @param request - UpdateUserRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1735,7 +1713,7 @@ export default class Client extends OpenApi {
      *
      * @remarks
      * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
-     * >  If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify information about a user that is synchronized by using SCIM.
+     * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify information about a user that is synchronized by using SCIM.
      *
      * @param request - UpdateUserRequest
      * @returns UpdateUserResponse