HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

Disconnect User

post
https://{api-base-url}/device_management/v1/device//action/disconnect_user

This API disconnects the clients from an IAP. Disconnect user command has following option:

  1. all : Disconnects all clients associated with an IAP.
  2. mac : Allows you to disconnect a client by specifying the MAC address of the client.
  3. network : Allows you to disconnect the clients connected to a specific network.

Use one of the above options.

Possible error_codes for the error responses are

  1. 0001 - General Error.
  2. 0003 - Validation Error. Unsupported query combination.
  3. 0004 - Validation Error. Invalid value for a query parameter.
Path Params
string
required

Serial of device

Body Params

Use one of option from all, mac or network.

string

Specify mac address of client to disconnect

boolean

Use this option to disconnects all clients associated with an IAP.

string

specify network name to disconnect

Responses

401

Unauthorized

403

Forbidden

404

Not found

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

Updated about 2 years ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 years ago