All Products
Search
Document Center

CloudSSO:UpdateMFAAuthenticationSettings

Last Updated:Jun 14, 2024

Modifies the multi-factor authentication (MFA) setting of all users.

Operation description

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****.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cloudsso:UpdateMFAAuthenticationSettingsWrite
  • Directory
    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DirectoryIdstringYes

The ID of the directory.

d-00fc2p61****
MFAAuthenticationSettingsstringYes

Specifies whether to enable MFA for all users. Valid value:

  • Enabled: enables MFA for all users.
  • Byuser: uses user-specific settings. For more information about how to configure MFA for a single user, see UpdateUserMFAAuthenticationSettings .
  • Disabled: disables MFA for all users.
  • OnlyRiskyLogin: MFA is required only for unusual logons.
Enabled
OperationForRiskLoginstringNo

Specifies whether MFA is required for users who initiated unusual logons. Valid value:

  • Autonomous: MFA is prompted for users who initiated unusual logons. However, the users are allowed to skip MFA. If an MFA device is bound to a user who initiated an unusual logon, the user must pass MFA.

  • EnforceVerify: MFA is required. If no MFA devices are bound to a user who initiated an unusual logon, the user must bind an MFA device. If an MFA device is already bound to a user who initiated an unusual logon, the user must pass MFA.

Autonomous

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

A1C748E3-8944-5593-81BC-7D96AE24F77B

Examples

Sample success responses

JSONformat

{
  "RequestId": "A1C748E3-8944-5593-81BC-7D96AE24F77B"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-11-18The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: OperationForRiskLogin