文档首页/ 统一身份认证服务 IAM/ API参考/ API/ 安全设置/ 修改IAM用户的登录保护状态信息
更新时间:2024-10-18 GMT+08:00
分享

修改IAM用户的登录保护状态信息

功能介绍

该接口可以用于管理员修改IAM用户的登录保护状态信息。

该接口可以使用全局区域的Endpoint和其他区域的Endpoint调用。IAM的Endpoint请参见:地区和终端节点

调试

您可以在API Explorer中调试该接口。

URI

PUT /v3.0/OS-USER/users/{user_id}/login-protect

表1 路径参数

参数

是否必选

参数类型

描述

user_id

String

待修改登录保护状态信息的IAM用户ID(不支持修改自己的登录保护状态信息),获取方式请参见:获取账号、IAM用户、项目、用户组、区域、委托的名称和ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-token

String

拥有Security Administrator权限的token。

表3 请求Body参数

参数

是否必选

参数类型

描述

login_protect

object

登录保护状态信息。

表4 Login_project

参数

是否必选

参数类型

描述

enabled

Boolean

IAM用户是否开启登录保护,开启为"true",未开启为"false"。

verification_method

String

IAM用户登录验证方式。手机验证为“sms”,邮箱验证为“email”,MFA验证为“vmfa”。

响应参数

状态码为 200 时:

表5 响应Body参数

参数

参数类型

描述

login_protect

object

登录保护状态信息。

表6 login_protect

参数

参数类型

描述

user_id

String

待修改登录保护状态信息的IAM用户ID。

enabled

Boolean

IAM用户是否开启登录保护,开启为"true",不开启为"false"。

verification_method

String

IAM用户登录验证方式。手机验证为“sms”,邮箱验证为“email”,MFA验证为“vmfa”。

请求示例

修改IAM用户的登录保护状态信息:开启登录保护,且登录验证方式为MFA验证。

PUT https://iam.myhuaweicloud.com/v3.0/OS-USER/users/{user_id}/login-protect
 
{ 
  "login_protect" : { 
    "enabled" : true, 
    "verification_method" : "vmfa" 
  } 
}

响应示例

状态码:200

请求成功。

{ 
  "login_protect" : { 
    "user_id": "16b26081f43d4c628c4bb88cf32e9...", 
    "enabled" : true, 
    "verification_method" : "vmfa" 
  } 
}

状态码

状态码

描述

200

请求成功。

400

请求校验异常。

401

认证失败。

403

请求未授权。

404

未找到相应的资源。

500

系统错误。

错误码

请参见错误码

相关文档