更新时间:2024-01-11 GMT+08:00

查询OTP设备

功能介绍

该接口用于查询相应用户下面的OTP设备。

调试

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

URI

GET /v2/{project_id}/users/{user_id}/otp-devices

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

user_id

String

用户ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

发送的实体的MIME类型,如:application/json。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

otp_devices

Array of OtpDevice objects

otp设备。

表4 OtpDevice

参数

参数类型

描述

id

String

用户otp 信息id。

user_id

String

用户id。

user_name

String

用户名。

status

String

用户otp设备状态 UNREGISTER: 未绑定 REGISTERED:已绑定

create_time

String

用户otp设备绑定时间。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 405

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 503

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET /v2/0bec5db98280d2d02fd6c00c2de791ce/users/8a2c3f9579d240820179d51e6caf0001/otp-devices

响应示例

状态码: 200

正常。

{
  "otp_devices" : [ {
    "id" : "5311a768c22f4d30914fe50ffdfd1ba5",
    "user_id" : "8a2c3f9579d240820179d51e6caf0001",
    "user_name" : "zhangsan",
    "status" : "UNREGISTER",
    "create_time" : "2020-04-10 06:45:14"
  } ]
}

状态码

状态码

描述

200

正常。

400

由于包含语法错误,当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误,具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码