Bind the subscriber to this session's device

POST /api/v1/admin/sessions/{id}/lock-mac prm_users_mac_lock

Writes the session's calling-station MAC into the subscriber's locked-MAC list. From the next authentication onward only that device may connect. The current session is left up, since it already uses the locked MAC.

This endpoint also turns the lock ON, which the subscriber PATCH does not. Writing mac_locked_addrs through PATCH /users/{id} without setting mac_lock_enabled stores a list that enforces nothing.

At a glance

Authentication: Staff token or session
Requires permission: prm_users_mac_lock Lock user MAC
Rate limit: t_mutate

Parameters

Parameter	Description
`id`required path · integer	Session id.

Errors

Code	When it is returned
`ERR_VALIDATION`422	the session has no owning subscriber, so there is no record to lock

Request

curl -X POST "$BASE/api/v1/admin/sessions/{id}/lock-mac" \
  -H "Authorization: Bearer $XR_TOKEN"

Response 200 OK

{
  "data": {
    "user_id": 4711,
    "mac": "AA:BB:CC:DD:EE:FF",
    "locked_macs": ["AA:BB:CC:DD:EE:FF"]
  }
}

BASE is your tenant host: the same address you sign in on.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.

Try it free Talk to us