Logout Device by Device ID API

End a device session using only the device identifier without requiring full device details

Quick Logout

Logout Device by Device ID API

Simplified device logout using just the device ID. Ideal for administrative actions when you have the device ID from your management system.

ID-Based

Logout using just the device ID.

Simplified

No need for UUID or serial number.

Admin Friendly

Perfect for management dashboards.


Endpoint Overview

MUTATION/graphql

Log out a device using only its unique device ID. Simpler than the full logout endpoint when device details aren't available.

Authentication:Bearer Token
Required scopes:admin

Request Parameters

deviceIdInt!Required

The unique identifier of the device to log out.


GraphQL Mutation

mutation logoutDeviceByDeviceId($deviceId: Int!) {
  logoutDeviceByDeviceId(deviceId: $deviceId)
}

Variables:

{
  "deviceId": 67890
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ADMIN_TOKEN" \
  -d '{
    "query": "mutation logoutDeviceByDeviceId($deviceId: Int!) { logoutDeviceByDeviceId(deviceId: $deviceId) }",
    "variables": {
      "deviceId": 67890
    }
  }'

Response

200Device Logged Out Successfully
{
  "data": {
    "logoutDeviceByDeviceId": true
  }
}
400Device Not Found
{
  "errors": [
    {
      "message": "Device not found",
      "path": ["logoutDeviceByDeviceId"],
      "extensions": {
        "code": "DEVICE_NOT_FOUND"
      }
    }
  ],
  "data": null
}
400No Active Session
{
  "errors": [
    {
      "message": "No active session for this device",
      "path": ["logoutDeviceByDeviceId"],
      "extensions": {
        "code": "SESSION_NOT_FOUND"
      }
    }
  ],
  "data": null
}

When to Use

Admin Dashboards

When managing devices from an admin panel with device IDs.

Bulk Operations

Easier to script when you only have device IDs.

Support Actions

Quick logout from support tickets with device IDs.

API Integration

Simpler integration when device details aren't stored.



Finding Device IDs

Use the Get Devices query to retrieve device IDs for a user. Device IDs are also returned when activating or listing devices.

Need Device Details?

Use the Devices query to find device IDs and other details for any user in your system.

Get Devices API