searchOrgClientFingerprints
Search Client Fingerprints
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuidQuery Parameters
Device Category of the client device
Filter results by client type. enum: wireless, wired, vty
Value in
- "wireless"
- "wired"
- "vty"
Filter results by device model
Manufacturer name of the client device
Operating System name and version of the client device
Operating system name of the client device
Filter results by MAC address
Maximum number of results to return per page
0 <= value100Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w
Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now
Time range duration for the query, using relative units such as 10m, 7d, or 2w
"1d"Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.
On which field the list should be sorted, -prefix represents DESC order.
"wxid"Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the next URL from the previous response and should not be manually constructed.
Response Body
curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/insights/fingerprints/search?family=EX+Series+Switch&client_type=wired&model=ex4100-f-12p&mfg=Juniper+Networks%2C+Inc.&os=JUNOS+22.3R1.12&os_type=JUNOS&mac=d420b080516d"{ "end": 1735678700, "limit": 10, "results": [ { "family": "Apple", "mac": "d420b080516e", "mfg": "Apple, Inc.", "model": "Unknown", "org_id": "bb2fb165-0931-49c7-a1b8-9b5814326b7d", "os": "iOS 18.1.1", "os_type": "iOS", "random_mac": true, "site_id": "441a1214-6928-442a-8e92-e1d34b8ec6a6", "timestamp": 1735678662.58 }, { "family": "EX Series Switch", "mac": "d420b080516d", "mfg": "Juniper Networks, Inc.", "model": "ex4100-f-12p", "org_id": "b6bc08f3-60a3-402b-8f0d-caf9132a1e9a", "os": "JUNOS 22.3R1.12", "os_type": "JUNOS", "random_mac": false, "site_id": "441a1214-6928-442a-8e92-e1d34b8ec6a6", "timestamp": 1735669092.932 } ], "start": 1735678650, "total": 2}countOrgClientFingerprints GET
Count Client Fingerprints
validateOrgIdpCredential POST
IDP Credential Validation. The output will be available through websocket. As there can be multiple commands issued against the same device at the same time and the output all goes through the same websocket stream, `session` is introduced for demux. #### Subscribe to Device Command outputs `WS /api-ws/v1/stream` ``` json { "subscribe": "orgs/{org_id}/mist_nac/test_idp" } ``` ### Response (no idp can be found) ``` json { "event": "data", "channel": "/orgs/{org_id}/mist_nac/test_idp", "status": "data": { "status": "failure", "error": "No matching IDP found" } } ``` ### Response OK ``` json { "event": "data", "channel": "/orgs/{org_id}/mist_nac/test_idp", "status": "data": { "status": "success", "idp_id": "915793c0-1355-4e98-b1c0-23df2227b357", "idp_type": "ldap", // more attributes will be added later } } ``` ### Response Invalid Credentials ``` json { "event": "data", "channel": "/orgs/{org_id}/mist_nac/test_idp", "status": "data": { "status": "failure", "error": "Invalid Credentials", "idp_id": "915793c0-1355-4e98-b1c0-23df2227b357", "idp_type": "ldap", } } ```