Call GetUserMFAInfo to query the MFA device of a RAM user - Resource Access Management - Alibaba Cloud - Resource Access Management

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

ram:GetUserMFAInfo

get

*User

acs:ram::{#accountId}:user/{#UserName}

None

Request parameters

Parameter	Type	Required	Description	Example
UserPrincipalName	string	No	The logon name of the RAM user. This parameter is differently set in the following scenarios: If you use a RAM user to call this operation, this parameter can be left empty. If you do not specify this parameter, information about the MFA device that is bound to the RAM user is queried. If you use an Alibaba Cloud account to call this operation, you must set this parameter to the logon name of the RAM user that you want to query.	test@example.onaliyun.com

Response elements

Element	Type	Description	Example
	object
MFADevice	object	The information about the MFA device.
SerialNumber	string	The serial number of the MFA device.	acs:ram::177242285274****:mfa/device001
Type	string	The type of the MFA device. Valid values: VMFA: virtual MFA device. U2F: Universal 2nd Factor (U2F) security key.	VMFA
RequestId	string	The request ID.	FCF7322A-20A9-4F68-8B7F-F86958839BC0
IsMFAEnable	boolean	Indicates whether the MFA device is enabled. Valid values: true false	true

Examples

Success response

JSON format

{
  "MFADevice": {
    "SerialNumber": "acs:ram::177242285274****:mfa/device001",
    "Type": "VMFA"
  },
  "RequestId": "FCF7322A-20A9-4F68-8B7F-F86958839BC0",
  "IsMFAEnable": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.