Docs home

Remove User Device

Logs a user out of one device and frees that device slot, so they can log in on a new device when your institute limits devices per user. Put the `device_id` (from "User Device List") in the URL.

POST/user/device/{deviceId}/remove
Remove User Device
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/user/device/{deviceId}/remove' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"user_id":90949827}'
{
  "code": 200,
  "message": "Success"
}

Access: Institute admins, plus custom roles that can manage learners. The user must belong to one of your organizations.

Request body: form-data with one field, JSONString, containing this JSON:

Path parameters
device_idintegerrequired
The device to remove.
BodyJSONString
user_idintegerrequired
The user who owns the device.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success

Notes: All the user's sessions on that device are ended immediately. Fails with "One or more user id is invalid" if the user isn't in your organizations, or "This Device not available." if the device isn't linked to the user. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI