启用MFA设备 - EnableMfaDeviceV5

功能介绍

该接口可以用于启用指定的MFA设备并将其与指定的IAM用户关联。

调试

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

授权信息

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

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
iam:mfa:enableV5	Write	mfa *	-	-	-

URI

POST /v5/mfa-devices/enable

请求参数

表1 请求Body参数
参数	是否必选	参数类型	描述
user_id	是	String	参数解释： IAM用户ID，是IAM用户的全局唯一标识。约束限制：字符串类型，平台生成的标准IAM用户ID格式。取值范围：不涉及。默认取值：不涉及。
serial_number	是	String	参数解释： MFA设备序列号，创建MFA设备时自动生成。约束限制：长度范围为[0,150]。取值范围：不涉及。默认取值：不涉及。
authentication_code_first	是	String	参数解释：设备发出的验证码。约束限制：长度范围为[0,12]。取值范围：不涉及。默认取值：不涉及。
authentication_code_second	是	String	参数解释：设备发出的后续验证码。约束限制：长度范围为[0,12]。取值范围：不涉及。默认取值：不涉及。

响应参数

状态码：200

请求成功。

状态码：400

表2 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码，请参见错误码。取值范围：格式为PAP5.XXXX，例如 PAP5.0012。
error_msg	String	参数解释：错误信息，请参见错误信息。取值范围：不涉及。
request_id	String	参数解释： API 请求的唯一标识，用于排查接口调用异常。取值范围：不涉及。

状态码：403

表3 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码，请参见错误码。取值范围：格式为PAP5.XXXX，例如PAP5.0012。
error_msg	String	参数解释：错误信息，请参见错误消息。取值范围：不涉及。
request_id	String	参数解释： API请求的唯一标识，用于排查接口调用异常。取值范围：不涉及。
encoded_authorization_message	String	参数解释：认证失败时返回的加密详细信息，用于定位认证问题。可以通过STS5解密接口进行解密，请参见接口链接。取值范围：不涉及。

状态码：404

表4 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码，请参见错误码。取值范围：格式为PAP5.XXXX，例如 PAP5.0012。
error_msg	String	参数解释：错误信息，请参见错误信息。取值范围：不涉及。
request_id	String	参数解释： API 请求的唯一标识，用于排查接口调用异常。取值范围：不涉及。

请求示例

启用序列号为iam::accountid:mfa:name的MFA设备并将其与IAM用户xxx关联。

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

{
  "user_id" : "xxx",
  "serial_number" : "iam::accountid:mfa:name",
  "authentication_code_first" : "123456",
  "authentication_code_second" : "123456"
}