Reseller Activate Device API
Allow resellers to activate and register devices for users they manage
Reseller Activate Device API
Enable resellers to register and activate new devices for their managed users. Essential for reseller self-service and customer onboarding.
Device Registration
Register new devices for managed users.
Reseller Scoped
Only for users under reseller management.
Instant Setup
Devices ready to connect immediately.
Endpoint Overview
/graphqlActivate a device for a user managed by the authenticated reseller. The device will be linked to the user's account and ready for VPN access.
Request Parameters
userIdInt!RequiredThe unique identifier of the user (must be under reseller's management).
deviceIdInputDeviceIdInput!RequiredObject containing the device identification details.
uuidString!RequiredThe universally unique identifier of the device.
serialString!RequiredThe device's serial number.
nameString!RequiredA friendly name for the device.
GraphQL Mutation
mutation resellerActivateDevice($userId: Int!, $deviceIdInput: DeviceIdInput!) {
resellerActivateDevice(userId: $userId, deviceIdInput: $deviceIdInput)
}Variables:
{
"userId": 12345,
"deviceIdInput": {
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"serial": "ABC123XYZ789",
"name": "Customer's Android Phone"
}
}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_RESELLER_TOKEN" \
-d '{
"query": "mutation resellerActivateDevice($userId: Int!, $deviceIdInput: DeviceIdInput!) { resellerActivateDevice(userId: $userId, deviceIdInput: $deviceIdInput) }",
"variables": {
"userId": 12345,
"deviceIdInput": {
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"serial": "ABC123XYZ789",
"name": "Customers Android Phone"
}
}
}'Response
{
"data": {
"resellerActivateDevice": true
}
}{
"errors": [
{
"message": "Maximum device limit reached for this user",
"path": ["resellerActivateDevice"],
"extensions": {
"code": "DEVICE_LIMIT_EXCEEDED",
"currentDevices": 5,
"maxDevices": 5
}
}
],
"data": null
}{
"errors": [
{
"message": "User is not under your management",
"path": ["resellerActivateDevice"],
"extensions": {
"code": "FORBIDDEN"
}
}
],
"data": null
}Use Cases
Customer Onboarding
Set up devices for new customers during registration.
Device Replacement
Activate new device when customer upgrades hardware.
Multi-Device Setup
Register additional devices for existing users.
Remote Support
Activate devices remotely for customer convenience.
Best Practices
Verify User Status
Ensure user has active subscription before activating devices.
Check Device Limits
Confirm user hasn't exceeded allowed device count.
Use Clear Names
Name devices descriptively for easy identification.
Document Activations
Keep records of device activations for support.
Related Endpoints
Device Limits
Each user's subscription plan defines their maximum device count. If a user needs more devices, consider upgrading their plan or using the Extra Logins feature.
Need More Device Slots?
If customers need additional devices beyond their plan limits, use the Extra Logins API to increase their allowance.