GetMFAAuthenticationSettingInfo - CloudSSO - Alibaba Cloud Documentation Center

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

Operation description

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
cloudsso:GetMFAAuthenticationSettingInfo	get	*Directory `acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}`	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	95D3B107-DA80-5B34-A3D0-9E82F8F0DA0E
MFAAuthenticationSettingInfo	object	The MFA setting of all users.
MfaAuthenticationAdvanceSettings	string	The MFA policy of all users. Valid values: Enabled: MFA is enabled for all users. Byuser: User-specific settings are applied. For more information about how to configure MFA for a single user, see UpdateUserMFAAuthenticationSettings . Disabled: MFA is disabled for all users. OnlyRiskyLogin: MFA is required only for unusual logons.	OnlyRiskyLogin
OperationForRiskLogin	string	The MFA policy for unusual logons. Valid values: 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. Note This parameter is displayed only when Byuser or OnlyRiskyLogin is returned for the MfaAuthenticationAdvanceSettings parameter.	EnforceVerify

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history