Query MFA devices for a user via ListMFADevicesForUser - CloudSSO - Alibaba Cloud - CloudSSO

Operation description

This topic provides an example on how to query the MFA device list of the user u-00q8wbq42wiltcrk****. The response shows that the user has one MFA device named Alice-MFA1.

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

list

*User

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

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	8B9982ED-FD0D-5622-8EA0-7B768685DCE7
TotalCounts	integer	The total number of MFA devices.	1
MFADevices	array<object>	The MFA device list.
	object	The MFA device list.
DeviceType	string	The MFA device type. Valid values: TOTP: a virtual MFA device based on the Time-based One-Time Password algorithm. CrossPlatformPasskey: a cross-platform passkey. PlatformPasskey: a platform built-in passkey.	TOTP
EffectiveTime	string	The effective period. The time is in UTC and follows the RFC 3339 format (YYYY-MM-DDTHH:mm:ssZ).	2021-10-29T09:14:06Z
DeviceId	string	The MFA device ID.	mfa-00ujhet8pycljj7j****
UserId	string	The user ID.	u-00q8wbq42wiltcrk****
DeviceName	string	The MFA device name.	Alice-MFA1
LastUseTime	string	The last time the MFA device was used.	2026-08-12T07:26:12Z

Examples

Success response

JSON format

{
  "RequestId": "8B9982ED-FD0D-5622-8EA0-7B768685DCE7",
  "TotalCounts": 1,
  "MFADevices": [
    {
      "DeviceType": "TOTP",
      "EffectiveTime": "2021-10-29T09:14:06Z",
      "DeviceId": "mfa-00ujhet8pycljj7j****",
      "UserId": "u-00q8wbq42wiltcrk****",
      "DeviceName": "Alice-MFA1",
      "LastUseTime": "2026-08-12T07:26:12Z"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.