ListMFADevicesForUser - CloudSSO - Alibaba Cloud Documentation Center

Queries the multi-factor authentication (MFA) devices that are bound to a user. Up to two MFA devices can be bound to a user.

Operation description

This topic provides an example on how to query the MFA devices that are bound to the user u-00q8wbq42wiltcrk****. The returned result shows that the MFA device named Alice-MFA1 is bound to the user.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:ListMFADevicesForUser	List	User acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/user/{#UserId}	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	8B9982ED-FD0D-5622-8EA0-7B768685DCE7
TotalCounts	integer	The total number of MFA devices.	1
MFADevices	object []	The MFA devices.
DeviceType	string	The type of the MFA device. The value is fixed as TOTP, which indicates a virtual MFA device. Virtual MFA devices are based on the Time-based One-time Password (TOTP) algorithm.	TOTP
EffectiveTime	string	The time when the MFA device was enabled.	2021-10-29T09:14:06Z
DeviceId	string	The ID of the MFA device.	mfa-00ujhet8pycljj7j****
UserId	string	The ID of the user.	u-00q8wbq42wiltcrk****
DeviceName	string	The name of the MFA device.	Alice-MFA1

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ]
}

Error codes

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