文档

DescribeMfaDevices - 查询便捷用户绑定的虚拟MFA设备

更新时间:

查询便捷用户绑定的虚拟MFA设备。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
MaxResultslong

返回结果的最大数量。取值范围:1~500。
默认值:100。

100
NextTokenstring

查询凭证。取值为上一次 API 调用时返回的 NextToken 参数值。

caeba0bbb2be03f84eb48b699f0a4883
EndUserIdsarray

便捷用户的用户名。

string

便捷用户的用户名。

test
SerialNumbersarray

虚拟 MFA 设备序列号,唯一标识。

string

虚拟 MFA 设备序列号,唯一标识。

c2d9ae94-a64b-4a0d-8024-9519ca50****
AdDomainstring

AD 工作区地址。

cn.misumi.pri

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

33DBB8EC-6E68-4726-91C4-E09C59D9A7D8
NextTokenstring

下一个查询开始的 Token。

AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp
MfaDevicesobject []

虚拟 MFA 设备信息集合。

Idlong
说明 该参数暂未开放使用。
36
EndUserIdstring

使用该虚拟 MFA 设备的便捷用户名。

test
Emailstring
说明 该参数暂未开放使用。
username@example.com
GmtEnabledstring

虚拟 MFA 设备启用时间。按照 ISO8601 标准表示,并使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2021-06-22T06:20:49Z
GmtUnlockstring

虚拟 MFA 设备被锁定后的自动解锁时间。按照 ISO8601 标准表示,并使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2021-06-23T06:20:49Z
ConsecutiveFailsinteger

连续绑定或者认证虚拟 MFA 设备失败的次数。

0
SerialNumberstring

虚拟 MFA 设备序列号,唯一标识。

dc856334-446b-4035-bfbc-18af261e****
Statusstring

虚拟 MFA 设备状态。

枚举值:
  • LOCKED已锁定
  • UNBOUND未绑定
  • NORMAL正常
NORMAL
DeviceTypestring

虚拟 MFA 设备类型。目前仅支持 TOTP_VIRTUAL,即遵循 TOTP 算法的虚拟 MFA 设备。

TOTP_VIRTUAL

示例

正常返回示例

JSON格式

{
  "RequestId": "33DBB8EC-6E68-4726-91C4-E09C59D9A7D8",
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6na6YlN9asMM31MsMcdQNpp",
  "MfaDevices": [
    {
      "Id": 36,
      "EndUserId": "test",
      "Email": "username@example.com",
      "GmtEnabled": "2021-06-22T06:20:49Z",
      "GmtUnlock": "2021-06-23T06:20:49Z",
      "ConsecutiveFails": 0,
      "SerialNumber": "dc856334-446b-4035-bfbc-18af261e****",
      "Status": "NORMAL",
      "DeviceType": "TOTP_VIRTUAL"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-21OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:AdDomain
  • 本页导读 (0)
文档反馈