Configure MFA for all users with UpdateMFAAuthenticationSettings - CloudSSO - Alibaba Cloud - CloudSSO

Operation description

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cloudsso:UpdateMFAAuthenticationSettings

update

*Directory

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

None

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The directory ID.	d-00fc2p61****
MFAAuthenticationSettings	string	Yes	The global MFA settings. Valid values: Enabled: MFA verification is enabled for all users. Byuser: MFA verification depends on the individual MFA settings of each user. For more information about individual user MFA settings, see UpdateUserMFAAuthenticationSettings. Disabled: MFA verification is disabled for all users. OnlyRiskyLogin: MFA verification is required only for unusual logon attempts.	Enabled
OperationForRiskLogin	string	No	The action to take when the MFA settings option is set to verify only for unusual logon attempts. Valid values: Autonomous: Users can skip MFA binding during unusual logon, but users who have already bound MFA must complete MFA verification. EnforceVerify: Users who have not bound MFA are required to bind it, and users who have already bound MFA must complete verification.	Autonomous
		No

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	A1C748E3-8944-5593-81BC-7D96AE24F77B

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.