searchOrgNacClients
Search NAC client records across the organization with filters for authentication, endpoint posture, identity, network, NAC rule, site, and time attributes.
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
MAC address of the AP the client is/was connected to
Authentication type, e.g. "eap-tls", "eap-peap", "eap-ttls", "eap-teap", "mab", "psk", "device-auth". Accepts multiple comma-separated values.
Filter by certificate expiry within a specific duration from now (e.g., "7d" for 7 days, "1m" for 1 month). Accepts multiple comma-separated values.
Filters NAC clients that are integrated with EDR providers
EDR provider of the client's organization. enum: crowdstrike, sentinelone
Value in
- "crowdstrike"
- "sentinelone"
EDR status used to filter NAC clients. enum: sentinelone_healthy, sentinelone_infected, crowdstrike_low, crowdstrike_medium, crowdstrike_high, crowdstrike_critical, crowdstrike_informational
Value in
- "sentinelone_healthy"
- "sentinelone_infected"
- "crowdstrike_low"
- "crowdstrike_medium"
- "crowdstrike_high"
- "crowdstrike_critical"
- "crowdstrike_informational"
Partial / full Client family (e.g. "Phone/Tablet/Wearable", "Access Point"). Use prefix* for prefix search or *substring* for contains search (e.g. Surveillance* and *urveillance* match Surveillance Camera). Suffix-only wildcards (e.g. *Camera) are not supported. Accepts multiple comma-separated values.
Partial / full Client hostname. Use prefix* for prefix search or *substring* for contains search (e.g. everest* and *rest* match my-everest-client). Suffix-only wildcards (e.g. *everest) are not supported. Accepts multiple comma-separated values.
SSO ID, if present and used
Partial / full Client MAC address. Use a single value; comma-separated values are not supported. Use prefix* for prefix search or *substring* for contains search (e.g. aabbcc* and *bbcc* match aabbccddeeff). Suffix-only wildcards (e.g. *bccddeeff) are not supported
MDM compliance of client i.e "compliant", "not compliant"
MDM provider of client’s organization eg "intune", "jamf"
Filters NAC clients that are managed by MDM providers
Partial / full Client manufacturer (e.g. "apple", "cisco", "juniper"). Use prefix* for prefix search or *substring* for contains search (e.g. Raspberry Pi* and *Pi* match Raspberry Pi Trading Ltd). Suffix-only wildcards (e.g. *Ltd) are not supported. Accepts multiple comma-separated values.
Client model, e.g. "iPhone 12", "MX100"
NAC Policy Rule Name matched
NAC Policy Rule ID, if matched
NAC Policy Rule Matched
Vendor of NAS device
IP address of NAS device. Accepts multiple comma-separated values.
Vendor specific VLAN ID in RADIUS requests
Client OS, e.g. "iOS 18.1", "Android", "Windows", "Linux"
Filter results by SSID
Client connection status used to filter results. enum: permitted, session_started, session_stopped, denied
Value in
- "permitted"
- "session_started"
- "session_stopped"
- "denied"
partial / full MAC address, last_username, device_mac, nas_ip or last_ap
Client type i.e. "wireless", "wired" etc. Accepts multiple comma-separated values.
Labels derived from usermac entry
Filter results by username
Filter results by VLAN ID
Filter results by one site identifier. Use a single value; comma-separated values are not supported
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"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/nac_clients/search"{ "end": 1513362753, "limit": 3, "results": [ { "ap": [ "5c5b35bf16bb", "d4dc090041b4" ], "auth_type": "eap-tls", "cert_cn": [ "john@mycorp.net" ], "cert_issuer": [ "/C=US/ST=CA/CN=MyCorp" ], "client_ip": [ "10.7.51.74" ], "edr_managed": true, "edr_providers": [ "sentinelone" ], "edr_status": [ "sentinelone_healthy" ], "idp_id": "string", "idp_role": [ "string" ], "last_ap": "string", "last_cert_cn": "john@mycorp.net", "last_cert_expiry": 1746711240, "last_cert_issuer": "/C=US/ST=CA/CN=MyCorp", "last_cert_serial": "2c63510123456789", "last_cert_subject": "/C=US/O=MyCorp/CN=john@mycorp.net/emailAddress=john@mycorp.net", "last_client_ip": "10.7.51.74", "last_nacrule_id": "603b62db-d839-4152-9f7f-f2578443de8d", "last_nacrule_name": "Wireless Cert Auth", "last_nas_vendor": "juniper-mist", "last_ssid": "string", "last_status": "permitted", "mac": "string", "nacrule_id": [ "603b62db-d839-4152-9f7f-f2578443de8d" ], "nacrule_matched": true, "nacrule_name": [ "Wireless Cert Auth" ], "nas_vendor": [ "juniper-mist" ], "org_id": "31f27122-68a9-47a4-b526-8fb8a62a8acb", "random_mac": "true", "site_id": "832b1d74-9531-409b-ae37-4d7f3edbde92", "ssid": [ "string" ], "timestamp": 1694689718.612, "type": "wireless", "usermac_label": [ "non-compliant", "building26", "floor52" ] } ], "start": 1513276353, "total": 2}