文档首页/IAM 身份中心/API参考/API/用户管理/列出用户MFA设备 - BatchListMfaDevicesForUser
更新时间：2025-12-12 GMT+08:00
查看PDF
分享

列出用户MFA设备 - BatchListMfaDevicesForUser

功能介绍

查询指定用户的MFA设备列表。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

IdentityCenter:user:listMfaDevice

Read

-

-

-

organizations:delegatedAdministrators:list

URI

POST /v1/identity-stores/{identity_store_id}/users/retrieve-mfa-devices

表1 路径参数

参数

是否必选

参数类型

描述

identity_store_id

是

String

身份源的全局唯一标识符（ID）

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。

表3 请求Body参数

参数

是否必选

参数类型

描述

user_list

是

Array of RetrieveMfaDevicesForUserDto objects

用户列表

表4 RetrieveMfaDevicesForUserDto

参数

是否必选

参数类型

描述

identity_store_id

是

String

身份源的全局唯一标识符（ID）

user_id

是

String

用户唯一标识符（ID）

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

user_mfa_devices_entry_list

Array of RetrieveMfaDevicesForUserEntryDto objects

用户MFA设备信息列表

表6 RetrieveMfaDevicesForUserEntryDto

参数

参数类型

描述

mfa_devices

Array of MfaDeviceDto objects

MFA设备列表

user

RetrieveMfaDevicesForUserDto object

用户信息

表7 MfaDeviceDto

参数

参数类型

描述

device_id

String

MFA设备唯一标识符（ID）

device_name

String

MFA设备名称

display_name

String

MFA设备显示名称

mfa_type

String

MFA类型

registered_date

Long

注册时间

表8 RetrieveMfaDevicesForUserDto

参数

参数类型

描述

identity_store_id

String

身份源的全局唯一标识符（ID）

user_id

String

用户唯一标识符（ID）

状态码：400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

request_id

String

请求唯一标识

状态码：403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

request_id

String

请求唯一标识

encoded_authorization_message

String

加密的错误信息

请求示例

查询指定用户的MFA设备列表

POST https://{hostname}/v1/identity-stores/{identity_store_id}/users/retrieve-mfa-devices

{
  "user_list" : [ {
    "identity_store_id" : "d-a23axxxx",
    "user_id" : "201dca3f-965b-4311-8830-dc7953axxxx"
  } ]
}

响应示例

状态码：200

Successful

{
  "user_mfa_devices_entry_list" : [ {
    "mfa_devices" : [ {
      "device_id" : "m-fd4e4981d8",
      "device_name" : "MFA1",
      "display_name" : "MFA1",
      "mfa_type" : "TOTP",
      "registered_date" : 1753862382307
    } ],
    "user" : {
      "identity_store_id" : "d-a23adaabca",
      "user_id" : "201dca3f-965b-4311-8830-dc7953aecdcc"
    }
  } ]
}

状态码

状态码

描述

200

Successful

400

Bad request

403

Forbidden

错误码

请参见错误码。

父主题：用户管理