Help Center/ Workspace/ API Reference/ Workspace APIs/ User/ Queries MFA devices.

Updated on 2024-01-10 GMT+08:00

View PDF

Queries MFA devices.

Function

Queries MFA devices of a user.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
user_id	Yes	String	User ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	MIME type of the request body, for example, application/json.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
otp_devices	Array of OtpDevice objects	OTP device.

**Table 4** OtpDevice
Parameter	Type	Description
id	String	User OTP information ID.
user_id	String	User ID.
user_name	String	Username.
status	String	User OTP device status. UNREGISTER: unbound REGISTERED: bound
create_time	String	Time when a user's OTP device is bound.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 405

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 503

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

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

Example Responses

Status code: 200

Normal.

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

Status Codes

Status Code	Description
200	Normal.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	You do not have required permissions.
404	No resource found.
405	The request method is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.
503	The service is unavailable.