Deactivate Device API
Remove a device from a user's account and revoke its VPN access permissions
Deactivate Device API
Remove devices from user accounts to revoke VPN access. Deactivated devices can no longer connect to the VPN service until reactivated.
Revoke Access
Immediately remove device's ability to connect.
Security Control
Remove compromised or lost devices quickly.
Slot Recovery
Free up device slots for new device registration.
Endpoint Overview
/graphqlDeactivate a device for a user, removing it from their account and preventing it from connecting to the VPN service.
Request Parameters
userIdInt!RequiredThe unique identifier of the user whose device is being deactivated.
deviceIdInt!RequiredThe unique identifier of the device to deactivate.
GraphQL Mutation
mutation deactivateDevice($userId: Int!, $deviceId: Int!) {
deactivateDevice(userId: $userId, deviceId: $deviceId)
}Variables:
{
"userId": 12345,
"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 deactivateDevice($userId: Int!, $deviceId: Int!) { deactivateDevice(userId: $userId, deviceId: $deviceId) }",
"variables": {
"userId": 12345,
"deviceId": 67890
}
}'Response
{
"data": {
"deactivateDevice": true
}
}{
"errors": [
{
"message": "Device not found or already deactivated",
"path": ["deactivateDevice"],
"extensions": {
"code": "DEVICE_NOT_FOUND"
}
}
],
"data": null
}{
"errors": [
{
"message": "User not found",
"path": ["deactivateDevice"],
"extensions": {
"code": "USER_NOT_FOUND"
}
}
],
"data": null
}When to Deactivate Devices
Lost or Stolen
Immediately revoke access when a device is lost or stolen.
Device Replacement
Remove old device to make room for a new one.
Account Cleanup
Remove unused or obsolete devices from accounts.
Security Incident
Deactivate devices involved in suspicious activity.
Effects of Deactivation
Immediate Disconnect
Any active session from this device is terminated.
Access Revoked
Device cannot establish new VPN connections.
Slot Freed
Device slot becomes available for new activation.
Record Retained
Device history is preserved for audit purposes.
Best Practices
Disconnect First
For immediate effect, disconnect active sessions before deactivating.
Verify Device
Confirm the correct device is selected before deactivation.
Notify User
Inform the user when devices are removed from their account.
Document Reason
Log the reason for deactivation for support reference.
Related Endpoints
Permanent Action
Device deactivation removes the device from the user's account. The device can be reactivated later if needed, but will require re-registration with the Activate Device API.
Need to Reactivate?
If you need to restore access for a deactivated device, use the Activate Device API to re-register it.