Skip to content

Check that a device is registered

GET
/mfa/devices/{device}/check
curl --request GET \
--url https://work.optidata.cloud/api/mfa/devices/example/check \
--header 'Authorization: Bearer <token>'

Confirms a device exists and returns its identifiers. Requires permission to view the device.

device
required
string

Public identifier of the device.

Identifiers of the device.

Media typeapplication/json
object
id
integer format: int64
uuid
string format: uuid
duid
string | null
Examples
Exampledevice
{
"id": 31,
"uuid": "9c1f0e2a-4d31-4d8a-8c1a-1f0b6b1f9a10",
"duid": "PC-A1B2C3"
}

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
"error": "JWT passport exception: Missing bearer token in request"
}

The caller lacks the permission level the operation requires.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Exampledenied
{
"message": "This action is unauthorized."
}

The resource does not exist, or does not belong to the given drive.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplemissing
{
"message": "No query results for model [App\\Models\\Node] 99999999"
}

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
"message": "Too Many Attempts."
}