文档首页/ 统一身份认证服务 IAM/ API参考(吉隆坡区域)/ API/ 安全设置/ 查询IAM用户的登录保护状态信息列表
更新时间:2024-07-25 GMT+08:00

查询IAM用户的登录保护状态信息列表

功能介绍

该接口可以用于管理员查询IAM用户的登录保护状态列表。

URI

GET /v3.0/OS-USER/login-protects

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

拥有Security Administrator权限的token。

响应参数

表2 响应Body参数

参数

参数类型

描述

login_protects

Array of objects

登录保护状态信息列表。

说明:

只返回配置过登录保护的用户状态信息。

表3 login_protects

参数

参数类型

描述

enabled

Boolean

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

user_id

String

IAM用户ID。

verification_method

String

IAM用户登录验证方式。

  • email:邮件验证码
  • vmfa:虚拟MFA
  • SMS:手机验证码

请求示例

GET https://sample.domain.com/v3.0/OS-USER/login-protects

响应示例

状态码为 200 时:

请求成功。

{ 
  "login_protects" : [
          { 
            "user_id" : "75226081f43d4c628c4bb88cf32e9...", 
            "enabled" : true, 
            "verification_method" : "email" 
            }, 
          { 
            "user_id" : "16b26081f43d4c628c4bb88cf32e9...", 
            "enabled" : true, 
            "verification_method" : "vmfa" 
            },
          { 
            "user_id" : "56b26081f43d4c628c4bb88cf32e9...", 
            "enabled" : true, 
            "verification_method" : "sms" 
            }
          { 
            "user_id" : "08c16cb6c58010691f81c0028dd94...", 
            "enabled" : false, 
            "verification_method" : "none" 
            }
       ] 
}

对于从未配置过登录保护的IAM用户,该接口无法获取到其登录保护状态信息,只返回开启过登录保护的用户状态信息。

状态码为 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" 
}

状态码为 500 时:

内部服务错误。

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

状态码

状态码

描述

200

请求成功。

401

认证失败。

403

没有操作权限。

404

未找到相应的资源。

500

内部服务错误。