recently_associated_clients

Recently Associated Clients

When a client gets connected to an AP, we can get the details of all the recently associated clients to a particular AP. If we navigate through Access Points page, we can get a display of the event logs of the AP, a list of clients associated with the AP and its details with the graph showing the network usage. When you select a particular AP, the associated client list is displayed.

JSON Table

Attribute Data Type Description
bssid  String BSSID configured on a managed device.
ssid String It specifies the operating SSID.
active boolean A true or false value indicating whether the BSSID is active or inactive.
numAssocClients int Number of active clients associated with the BSSID.
security int Security standard applied to the BSSID. This is derived from the template applied to the AP. Possible values are:

  • 0 – Unknown
  • 1 – Open
  • 2 – WEP
  • 3 – WEP, Open
  • 4 – WPA
  • 5 – WPA, Open
  • 6 – WPA, WEP
  • 7 – WPA, WEP, Open
  • 8 – 802.11i
  • 9 – 802.11i, Open
  • 10 – 802.11i, WEP
  • 11 – 802.11i, WEP, Open
  • 12 – 802.11i, WPA
  • 13 – 802.11i, WPA, Open
  • 14 – 802.11i, WPA, WEP
  • 15 – 802.11i, WPA, WEP, Open
secAuth int Procedure used by APs to verify the identity of a client. Possible values are:

  • 0 – Unknown
  • 1 – PSK
  • 2 – 802.1x
  • 3 – 802.1x, PSK
  • 129 – PSK, VendorSpecific
  • 130 – 802.1x, VendorSpecific
  • 131 – 802.1x, PSK, VendorSpecific
secGCS int Specifies the encryption used for broadcast or multicast communication
from the AP. Applicable values are:

  • 0 – CIPHER_NONE_VALUE (Cipher None)
  • 1 – CIPHER_WEP40_VALUE
  • 2 – CIPHER_WEP104_VALUE
  • 4 – CIPHER_TKIP_VALUE
  • 8 – CIPHER_CCMP_VALUE
  • 32 -CIPHER_UNKNOWN_VALUE
  • 64 – CIPHER_USE_GROUP_VALUE
  • 128 – CIPHER_VENDOR_SPECIFIC_VALUE
secPWCS int Encryption used for unicast communication between the AP and a Client.
Applicable values are:

  • 0 – CIPHER_NONE_VALUE (Cipher None)
  • 1 – CIPHER_WEP40_VALUE
  • 2 – CIPHER_WEP104_VALUE
  • 4 – CIPHER_TKIP_VALUE
  • 8 – CIPHER_CCMP_VALUE
  • 32 -CIPHER_UNKNOWN_VALUE
  • 64 – CIPHER_USE_GROUP_VALUE
  • 128 – CIPHER_VENDOR_SPECIFIC_VALUE
interfaceClientAssociation application/json Map of wireless interface(BSSID) to client association .
interfaceClientAssociation/<MAC_address>
interfaceClientAssociation/<MAC_address>/bssid
interfaceClientAssociation/<MAC_address>/protocol String Protocol on which BSSID is configured.
interfaceClientAssociation/<MAC_address> /ssid String Name of SSID using which client is associated.
interfaceClientAssociation/<MAC_address> /radio application/json
interfaceClientAssociation/<MAC_address> /radio/type String Radio information, in this case it will be clientradio.
interfaceClientAssociation/<MAC_address> /radio/macaddress A unique 48-bit address of the radio.
interfaceClientAssociation/<MAC_address> /radio/protocol String Protocol using which client is associated.
interfaceClientAssociation/<MAC_address> /radio/channel int Operating channel number of radio.
interfaceClientAssociation/<MAC_address> /radio/firstDetectedTime int First detected time in milliseconds.
interfaceClientAssociation/<MAC_address> /radio/upSince int Up since time in milliseconds.
interfaceClientAssociation/<MAC_address> /radio/signalStrength int Signal strength in dBm by which AP is seeing this client.
interfaceClientAssociation/<MAC_address> /radio/quarantineStatus Indicates if the client is quarantined.
interfaceClientAssociation/<MAC_address> /radio/captureFlag int Indicates troubleshoot status.
interfaceClientAssociation/<MAC_address> /radio/captureId int Troubleshooting session id
interfaceClientAssociation/<MAC_address> /radio/deviceBoxId int System generated integer to identify radio.
interfaceClientAssociation/<MAC_address> /radio/banned boolean
interfaceClientAssociation/<MAC_address> /radio/deviceName
interfaceClientAssociation/<MAC_address> /radio/deviceGroup
interfaceClientAssociation/<MAC_address>/radio/guest boolean
interfaceClientAssociation/<MAC_address> /radio/honeypot boolean
interfaceClientAssociation/<MAC_address> /radio/misconfigured boolean
interfaceClientAssociation/<MAC_address> /radio/ssid String
interfaceClientAssociation/<MAC_address> /radio/active boolean
associatedRadio application/json
associatedRadio/type String
associatedRadio/macaddress
associatedRadio/protocol String
associatedRadio/channel int
associatedRadio/firstDetectedTime int
associatedRadio/upSince int
associatedRadio/signalStrength int
associatedRadio/quarantineStatus
associatedRadio/captureFlag int
associatedRadio/captureId int
associatedRadio/deviceBoxId
associatedRadio/banned boolean
associatedRadio/deviceName String
associatedRadio/deviceGroup String
associatedRadio/ipAddress
associatedRadio/active boolean
associationType String
lastAssociationTime
signalStrength
locationId

Copy Sample JSON
Sample JSON 
{
   "wirelessInterfaces":[{
      "bssid": "00:11:74:96:57:61",
      "ssid": "AllPluginstest123",
      "active": false,
      "numAssocClients": 0,
      "security": 0,
      "secAuth": 0,
      "secGCS": 0,
      "secPWCS": 0
   }],
   "interfaceClientAssociation":{
		"00:11:74:96:57:61":[{
         "bssid": "00:24:D7:C7:31:60",
		   "protocol": "CLIENT",
		   "ssid": "AllPluginstest123",
		   "radio":{
		      "type": "AssociatedAPRadio",
		      "macaddress": "00:11:74:96:57:61",
		      "protocol": "A",
		      "channel": 0,
		      "firstDetectedTime": 0,
		      "upSince": 0,
		      "signalStrength": 0,
			  "quarantineStatus": null,
			  "captureFlag": 0,
			  "captureId": 0,
			  "deviceBoxId": 0,
			  "banned": false,
			  "deviceName": null,
			  "deviceGroup": null,
			  "guest": false,
			  "honeypot": false,
			  "misconfigured": false,
			  "ssid": "AllPluginstest123",
			  "active": false
         },
         "associatedRadio":{
		      "type": "AssociatedClientRadio",
			  "macaddress": "00:11:74:96:57:61",
		      "protocol": "A",
		      "channel": 0,
		      "firstDetectedTime": 0,
		      "upSince": 0,
		      "signalStrength": 0,
		      "quarantineStatus": null,
		      "captureFlag": 0,
		      "captureId": 0,
		      "deviceBoxId": 839682911,
		      "banned": false,
			  "deviceName": "Lap-324",
		      "deviceGroup": "AUTHORIZED",
		      "ipAddress": "",
		      "active": false
         },
         "associationType": "BSS",
         "lastAssociationTime": 1479983366000,
         "signalStrength": -5000,
         "locationId": null
	     }
	]}
}
API Calls
Get

/V5/devices/aps/{boxid}/recentlyassociatedclients

Get Recently Associated Clients

Description This API is used to retrieve recently associated clients with an AP.
Users with the following roles can call this API: super user, administrator, operator, and viewer.
Syntax
GET  <Base_URL>/devices/aps/{boxid}/recentlyassociatedclients

Here,

  • boxid

    Is used to specify the AP box ID. It takes Integer value. The default value is -1. To retrieve box ID refer APs
Sample code
GET https://training.mojonetworks.com/new/webservice/V5/devices/aps/1986778163
/recentlyassociatedclients
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains the list of recently associated clients with an AP along with all the wifi radios in the system in the application/json format.