文档

GetUserMFAInfo - 查询RAM用户多因素认证设备信息

更新时间:

查询指定RAM用户的多因素认证设备信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ram:GetUserMFAInfoget
  • User
    acs:ram::{#accountId}:user/{#UserName}

请求参数

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

RAM 用户的登录名称。存在以下两种情况:

  • 当 RAM 用户调用时,该参数可以为空,为空时默认查询当前 RAM 用户的多因素认证设备信息。
  • 当阿里云账号(主账号)调用时,该参数不能为空,必须指定需要查询的 RAM 用户的登录名称。
test@example.onaliyun.com

返回参数

名称类型描述示例值
object
MFADeviceobject

多因素认证设备信息。

SerialNumberstring

设备序列号。

acs:ram::177242285274****:mfa/device001
Typestring

多因素认证设备类型。取值:

  • VMFA:虚拟 MFA 设备。
  • U2F:U2F 安全密钥。
VMFA
RequestIdstring

请求 ID。

FCF7322A-20A9-4F68-8B7F-F86958839BC0
IsMFAEnableboolean

是否已启用多因素认证设备。取值:

  • true:已启用。
  • false:未启用。
true

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-14OpenAPI 描述信息更新查看变更详情