Trusted Devices model

The trusted_devices model is an array of objects containing a user’s trusted devices. Only users with MFA enabled can have trusted devices in their user profile.

You can retrieve this information with Identity API: /identity/v1/mfa/trusteddevices endpoint or the Management API: /api/v2/users/:user_id/mfa/trusteddevices endpoint.

Trusted Devices object

{
  "trusted_devices": [
    {
      "id": "k6ShT…​Xu5uV0i",
      "metadata": {
        "ip": "185.209.222.60",
        "operatingSystem": "Windows 11",
        "userAgent": "Mozilla/5.0 (platform; rv:geckoversion) Gecko/geckotrail Firefox/firefoxversion",
        "deviceClass": "deviceClass",
        "deviceName": "deviceName"
      },
      "userId": "teSh2…​Wu5bV5L",
      "createdAt": "2025-03-17T09:01:41.146Z",
      "isTrusted": true (1)
    }
  ]
}
1 isTrusted is a boolean that denotes whether the device is currently marked as a trusted device for the user.

Trusted Devices fields

Field Type Description

id

string

The ID for the device.

metadata

object

An object containing important information about the actual device.

This includes:

  • ip: The IP address associated with the device interaction (IPv4 or IPv6).

  • operatingSystem: The operating system and version running on the device (e.g., Windows 10, macOS, iOS).

  • userAgent: The raw HTTP User-Agent string sent by the client browser or application.

  • deviceClass: The category of the hardware (e.g., Desktop, Mobile, Tablet).

  • deviceName: The human-readable name or model of the device (e.g., "iPhone 13", "Chrome on MacBook").

userId

string

The ID of the user trusting the device.

createdAt

string

The timestamp indicating when the device was trusted.

  • Format: ISO 8601 date-time string in UTC.

  • Example: 2025-03-17T09:01:41.146Z

isTrusted

boolean

Boolean indicating if the device is trusted or not.

options

  • true: Device is trusted.

  • false: Device is not trusted.