Get an MFA device by ID

Returns details of a specific MFA device by its ID.

GET /sdk/{environmentId}/users/mfa/{mfaDeviceId}

Get an MFA device by ID

cURL

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/sdk/{environmentId}/users/mfa/{mfaDeviceId} \
  --header 'Authorization: Bearer <token>'

200

{
  "verified": true,
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "createdAt": "2023-11-07T05:31:56Z",
  "verifiedAt": "2023-11-07T05:31:56Z",
  "default": true,
  "alias": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

mfaDeviceId · string · required

ID of the MFA Device

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Response

200

application/json

successful operation

type · enum<string>

Available options: totp, passkey, email

verified · boolean

Whether or not the user has a verified this MFA Device

id · string

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

createdAt · string<date-time>

The date and time the MFA device was created

verifiedAt · string<date-time> | null

The date and time the MFA device was verified

default · boolean

Whether or not this is the default MFA device for the user

alias · string

The optional alias for the MFA device