Query the MFA setting for all users with GetMFAAuthenticationSettingInfo - CloudSSO - Alibaba Cloud - CloudSSO

Operation description

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

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:GetMFAAuthenticationSettingInfo

get

*Directory

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

None

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The directory ID.	u-00q8wbq42wiltcrk****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	95D3B107-DA80-5B34-A3D0-9E82F8F0DA0E
MFAAuthenticationSettingInfo	object	The global MFA verification configuration.
MfaAuthenticationAdvanceSettings	string	The global MFA verification policy. Valid values: Enabled: MFA verification is enabled for all users. Byuser: MFA verification depends on the independent MFA configuration of each user. For more information about user-specific MFA configuration, see UpdateUserMFAAuthenticationSettings. Disabled: MFA verification is disabled for all users. OnlyRiskyLogin: MFA verification is required only for unusual logon attempts.	OnlyRiskyLogin
OperationForRiskLogin	string	The MFA verification policy for unusual logon attempts. Valid values: Autonomous: Users can skip MFA binding during unusual logon, but users who have already bound MFA must complete verification. EnforceVerify: Users are required to bind or verify MFA during unusual logon. Note This parameter is displayed only when MfaAuthenticationAdvanceSettings is set to Byuser or OnlyRiskyLogin.	EnforceVerify
AllowedVerificationTypes	array
	string

Examples

Success response

JSON format

{
  "RequestId": "95D3B107-DA80-5B34-A3D0-9E82F8F0DA0E",
  "MFAAuthenticationSettingInfo": {
    "MfaAuthenticationAdvanceSettings": "OnlyRiskyLogin",
    "OperationForRiskLogin": "EnforceVerify",
    "AllowedVerificationTypes": [
      ""
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.