Client
List active clients
List active clients with filters and pagination.
get/clients/active
Query parameters
locationIdsinteger[]
The location IDs
deviceIdsinteger[]
The device IDs
vlansinteger[]
The associate vlan IDs
userProfileNamesstring[]
The user profile names
ssidsstring[]
The SSIDs
clientOsNamesstring[]
The client os names
clientConnectionTypesinteger[]
The client connection types: 1 - WIRELESS, 2 - WIRED, -1 - UNDETERMINED
clientHealthStatusinteger
The client health status: 1 - HEALTHY, 2 - POOR
excludeLocallyManagedboolean
Return Cloud managed Devices' clients
userNamesstring[]
The user names
searchStringstring
The search string
pageinteger
Page number, min = 1
limitinteger
Page Size, min = 1, max = 100
sortField'AUTH_METHOD' | 'CHANNEL' | 'CONNECTED_VIA' | 'CONNECTION_TYPE' | 'DEVICE_NAME' | 'HOST_NAME' | 'IPV4' | 'IPV6' | 'MAC' | 'NAC_DETAILS' | 'NAC_PROFILE' | 'OS_TYPE' | 'REPORTED_BY' | 'START_TIME' | 'USER_NAME' | 'USER_PROFILE' | 'VLAN' | 'TH_RLOC16' | 'CLIENT_MAC' | 'RSSI' | 'DEVICE_MAC'
Sort field
sortOrder'ASC' | 'DESC'
Sort Order
Sort order (ascending by default)
viewsXiqClientView[]
The views to return client fields (Check fields for each view at XiqClientView schema)
fieldsXiqClientField[]
The client fields to return
Response
OK