文档首页/ 统一身份认证服务 IAM_统一身份认证服务（新版）/ API参考/ API/ IAM/ MFA设备管理/ 创建MFA设备 - CreateVirtualMfaDeviceV5
更新时间：2026-05-14 GMT+08:00
查看PDF
分享

创建MFA设备 - CreateVirtualMfaDeviceV5

功能介绍

该接口可以用于创建MFA设备。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

iam:mfa:createVirtualMFADeviceV5

Write

mfa *

-

-

-

URI

POST /v5/virtual-mfa-devices

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

virtual_mfa_device_name

是

String

参数解释：

MFA设备名称。

约束限制：

长度为1到64个字符，只包含字母、数字、"_"和"-"的字符串。

取值范围：

不涉及。

默认取值：

不涉及。

user_id

是

String

参数解释：

IAM用户ID，是IAM用户的全局唯一标识。

约束限制：

字符串类型，平台生成的标准IAM用户ID格式。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：201

表2 响应Body参数

参数

参数类型

描述

virtual_mfa_device

virtual_mfa_device object

参数解释：

MFA设备。

取值范围：

不涉及。
表3 virtual_mfa_device

参数

参数类型

描述

serial_number

String

参数解释：

MFA设备序列号, 创建MFA设备时自动生成。

取值范围：

不涉及。

base32_string_seed

String

参数解释：

密钥信息，用于第三方生成图片验证码。

取值范围：

不涉及。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码，请参见错误码。

取值范围：

格式为PAP5.XXXX，例如 PAP5.0012。

error_msg

String

参数解释：

错误信息，请参见错误信息。

取值范围：

不涉及。

request_id

String

参数解释：

API 请求的唯一标识，用于排查接口调用异常。

取值范围：

不涉及。

状态码：403

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码，请参见错误码。

取值范围：

格式为PAP5.XXXX，例如PAP5.0012。

error_msg

String

参数解释：

错误信息，请参见错误消息。

取值范围：

不涉及。

request_id

String

参数解释：

API请求的唯一标识，用于排查接口调用异常。

取值范围：

不涉及。

encoded_authorization_message

String

参数解释：

认证失败时返回的加密详细信息，用于定位认证问题。 可以通过STS5解密接口进行解密，请参见接口链接。

取值范围：

不涉及。

状态码：404

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码，请参见错误码。

取值范围：

格式为PAP5.XXXX，例如 PAP5.0012。

error_msg

String

参数解释：

错误信息，请参见错误信息。

取值范围：

不涉及。

request_id

String

参数解释：

API 请求的唯一标识，用于排查接口调用异常。

取值范围：

不涉及。

状态码：409

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码，请参见错误码。

取值范围：

格式为PAP5.XXXX，例如 PAP5.0012。

error_msg

String

参数解释：

错误信息，请参见错误信息。

取值范围：

不涉及。

request_id

String

参数解释：

API 请求的唯一标识，用于排查接口调用异常。

取值范围：

不涉及。

请求示例

为IAM用户xxx创建名为name的MFA设备。

POST https://{endpoint}/v5/virtual-mfa-devices

{
  "virtual_mfa_device_name" : "name",
  "user_id" : "xxx"
}

响应示例

状态码：201

请求成功。

{
  "virtual_mfa_device" : {
    "serial_number" : "iam::accountid:mfa:name",
    "base32_string_seed" : "seed"
  }
}

状态码

状态码

描述

201

请求成功。

400

请求体异常。

403

没有操作权限。

404

未找到相应的资源。

409

请求冲突。

错误码

请参见错误码。

父主题： MFA设备管理

相关文档