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

查询指定IAM用户的登录保护状态信息

功能介绍

该接口可以用于管理员查询指定IAM用户的登录保护状态信息，或IAM用户查询自己的登录保护状态信息。

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

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

user_id

是

String

待查询的IAM用户ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

管理员查询IAM用户的登录保护状态信息：请参见授权项。

IAM用户查询自己的登录保护状态信息：URL中user_id所对应IAM用户的token（无需特殊权限）。

响应参数

状态码为 200 时:

表3 响应Body参数

参数

参数类型

描述

login_protect

object

登录状态保护信息。
表4 login_protect

参数

参数类型

描述

enabled

Boolean

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

user_id

String

IAM用户ID。

verification_method

String

IAM用户登录验证方式。

请求示例

查询指定IAM用户的登录保护状态信息。

GET https://iam.myhuaweicloud.com/v3.0/OS-USER/users/{user_id}/login-protect

响应示例

状态码为 200 时:

请求成功。

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

状态码为 403 时:

没有操作权限。

  • 示例 1
{ 
   "error_msg" : "You are not authorized to perform the requested action.", 
   "error_code" : "IAM.0002" 
 }
  • 示例 2
{ 
   "error_msg" : "Policy doesn't allow %(actions)s to be performed.", 
   "error_code" : "IAM.0003" 
 }

状态码为 404 时:

未找到相应的资源。

{ 
  "error_msg" : "Could not find %(target)s: %(target_id)s.", 
  "error_code" : "Iam.0004" 
}

对于从未开启过登录保护的IAM用户，该接口无法获取到其登录保护状态信息，会返回IAM.0004错误码。

状态码为 500 时:

内部服务错误。

{ 
  "error_msg" : "An unexpected error prevented the server from fulfilling your request.", 
  "error_code" : "IAM.0006" 
}

状态码

状态码

描述

200

请求成功。

401

认证失败。

403

没有操作权限。

404

未找到相应的资源。

500

内部服务错误。

错误码

请参见错误码。

父主题： 安全设置

相关文档