{ "opencollection": "1.0.0", "info": { "name": "Mist Admins Sites Clients - NAC API", "version": "2606.1.1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Sites Clients - NAC", "type": "folder" }, "items": [ { "info": { "name": "countSiteNacClients", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/nac_clients/count", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "distinct", "value": "", "type": "query", "description": "Field used to group this count response. enum: `ap`, `auth_type`, `device_mac`, `edr_managed`, `edr_provider`, `edr_status`, `family`, `hostname`, `idp_id`, `mfg`, `mdm_compliance`, `mdm_managed`, `mdm_provider`, `model`, `mxedge_id`, `nacrule_matched`, `nacrule_name`, `nacrule_id`, `nas_ip`, `nas_vendor`, `os`, `ssid`, `status`, `type`, `usermac_label`, `username`, `vlan`" }, { "name": "last_nacrule_id", "value": "", "type": "query", "description": "NAC Policy Rule ID, if matched" }, { "name": "nacrule_matched", "value": "", "type": "query", "description": "NAC Policy Rule Matched" }, { "name": "auth_type", "value": "", "type": "query", "description": "Authentication type, e.g. \"eap-tls\", \"eap-peap\", \"eap-ttls\", \"eap-teap\", \"mab\", \"psk\", \"device-auth\"" }, { "name": "last_vlan_id", "value": "", "type": "query", "description": "Filter results by last VLAN ID" }, { "name": "last_nas_vendor", "value": "", "type": "query", "description": "Vendor of NAS device" }, { "name": "idp_id", "value": "", "type": "query", "description": "SSO ID, if present and used" }, { "name": "last_ssid", "value": "", "type": "query", "description": "Filter results by last SSID" }, { "name": "last_username", "value": "", "type": "query", "description": "Username presented by the client" }, { "name": "last_ap", "value": "", "type": "query", "description": "AP MAC connected to by client" }, { "name": "mac", "value": "", "type": "query", "description": "Filter results by MAC address" }, { "name": "last_status", "value": "", "type": "query", "description": "Connection status of client i.e \"permitted\", \"denied, \"session_ended\"" }, { "name": "type", "value": "", "type": "query", "description": "Client type i.e. \"wireless\", \"wired\" etc." }, { "name": "mdm_compliance_status", "value": "", "type": "query", "description": "MDM compliance of client i.e \"compliant\", \"not compliant\"" }, { "name": "mdm_provider", "value": "", "type": "query", "description": "MDM provider of client’s organisation eg \"intune\", \"jamf\"" }, { "name": "start", "value": "", "type": "query", "description": "Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`" }, { "name": "end", "value": "", "type": "query", "description": "Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`" }, { "name": "duration", "value": "", "type": "query", "description": "Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return per page" } ] }, "docs": "Count NAC clients for a site, optionally grouped by the `distinct` field and filtered by authentication, identity, endpoint, network, and time attributes. Use [Count Org NAC Clients](/#operations/countOrgNacClients) to count NAC clients across the organization." }, { "info": { "name": "countSiteNacClientEvents", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/nac_clients/events/count", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "distinct", "value": "", "type": "query", "description": "Field used to group this count response. enum: `ap`, `auth_type`, `dryrun_nacrule_id`, `mac`, `nacrule_id`, `nas_vendor`, `ssid`, `type`, `username`, `vlan`" }, { "name": "type", "value": "", "type": "query", "description": "See [List Device Events Definitions](/#operations/listNacEventsDefinitions)" }, { "name": "start", "value": "", "type": "query", "description": "Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`" }, { "name": "end", "value": "", "type": "query", "description": "Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`" }, { "name": "duration", "value": "", "type": "query", "description": "Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return per page" } ] }, "docs": "Count NAC client events for a site, optionally grouped by the `distinct` field and filtered by event type and time range. Use [Count Org NAC Client Events](/#operations/countOrgNacClientEvents) to count NAC client events across the organization." }, { "info": { "name": "searchSiteNacClientEvents", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/nac_clients/events/search", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "query", "description": "See [List Device Events Definitions](/#operations/listNacEventsDefinitions)" }, { "name": "nacrule_id", "value": "", "type": "query", "description": "NAC Policy Rule ID, if matched" }, { "name": "nacrule_matched", "value": "", "type": "query", "description": "NAC Policy Rule Matched" }, { "name": "dryrun_nacrule_id", "value": "", "type": "query", "description": "NAC Policy Dry Run Rule ID, if present and matched" }, { "name": "dryrun_nacrule_matched", "value": "", "type": "query", "description": "True - if dryrun rule present and matched with priority, False - if not matched or not present" }, { "name": "auth_type", "value": "", "type": "query", "description": "Authentication type, e.g. \"eap-tls\", \"eap-peap\", \"eap-ttls\", \"eap-teap\", \"mab\", \"psk\", \"device-auth\"" }, { "name": "vlan", "value": "", "type": "query", "description": "Filter results by VLAN ID" }, { "name": "nas_vendor", "value": "", "type": "query", "description": "Vendor of NAS device" }, { "name": "bssid", "value": "", "type": "query", "description": "Filter results by BSSID" }, { "name": "idp_id", "value": "", "type": "query", "description": "SSO ID, if present and used" }, { "name": "idp_role", "value": "", "type": "query", "description": "IDP returned roles/groups for the user" }, { "name": "idp_username", "value": "", "type": "query", "description": "Username presented to the Identity Provider" }, { "name": "resp_attrs", "value": "", "type": "query", "description": "RADIUS attributes returned by NAC to NAS Devive" }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID" }, { "name": "username", "value": "", "type": "query", "description": "Filter results by username" }, { "name": "ap", "value": "", "type": "query", "description": "Filter results by AP MAC address" }, { "name": "random_mac", "value": "", "type": "query", "description": "Filter results by whether the client is using a randomized MAC address" }, { "name": "mac", "value": "", "type": "query", "description": "Filter results by MAC address" }, { "name": "usermac_label", "value": "", "type": "query", "description": "Labels derived from usermac entry" }, { "name": "text", "value": "", "type": "query", "description": "Partial / full MAC address, username, device_mac or ap. 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" }, { "name": "nas_ip", "value": "", "type": "query", "description": "IP address of NAS device" }, { "name": "ingress_vlan", "value": "", "type": "query", "description": "Vendor specific VLAN ID in RADIUS requests" }, { "name": "start", "value": "", "type": "query", "description": "Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`" }, { "name": "end", "value": "", "type": "query", "description": "Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`" }, { "name": "duration", "value": "", "type": "query", "description": "Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return per page" }, { "name": "sort", "value": "", "type": "query", "description": "On which field the list should be sorted, -prefix represents DESC order." }, { "name": "search_after", "value": "", "type": "query", "description": "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." } ] }, "docs": "Search NAC client events for a site with filters for authentication, NAC rule, identity provider, RADIUS, network, endpoint, and time attributes. Use [Search Org NAC Client Events](/#operations/searchOrgNacClientEvents) to search NAC client events across the organization." }, { "info": { "name": "searchSiteNacClients", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/sites/:site_id/nac_clients/search", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "ap", "value": "", "type": "query", "description": "MAC address of the AP the client is/was connected to" }, { "name": "auth_type", "value": "", "type": "query", "description": "Authentication type, e.g. \"eap-tls\", \"eap-peap\", \"eap-ttls\", \"eap-teap\", \"mab\", \"psk\", \"device-auth\"" }, { "name": "cert_expiry_duration", "value": "", "type": "query", "description": "Filter by certificate expiry within a specific duration from now (e.g., \"7d\" for 7 days, \"1m\" for 1 month)" }, { "name": "edr_managed", "value": "", "type": "query", "description": "Filters NAC clients that are integrated with EDR providers" }, { "name": "edr_provider", "value": "", "type": "query", "description": "EDR provider used to filter NAC clients. enum: `crowdstrike`, `sentinelone`" }, { "name": "edr_status", "value": "", "type": "query", "description": "EDR status used to filter NAC clients. enum: `sentinelone_healthy`, `sentinelone_infected`, `crowdstrike_low`, `crowdstrike_medium`, `crowdstrike_high`, `crowdstrike_critical`, `crowdstrike_informational`" }, { "name": "family", "value": "", "type": "query", "description": "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" }, { "name": "hostname", "value": "", "type": "query", "description": "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" }, { "name": "idp_id", "value": "", "type": "query", "description": "SSO ID, if present and used" }, { "name": "mac", "value": "", "type": "query", "description": "Partial / full Client MAC address. 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" }, { "name": "mdm_compliance", "value": "", "type": "query", "description": "MDM compliance of client i.e \"compliant\", \"not compliant\"" }, { "name": "mdm_provider", "value": "", "type": "query", "description": "MDM provider of client’s organization eg \"intune\", \"jamf\"" }, { "name": "mdm_managed", "value": "", "type": "query", "description": "Filters NAC clients that are managed by MDM providers" }, { "name": "mfg", "value": "", "type": "query", "description": "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" }, { "name": "model", "value": "", "type": "query", "description": "Client model, e.g. \"iPhone 12\", \"MX100\"" }, { "name": "nacrule_name", "value": "", "type": "query", "description": "NAC Policy Rule Name matched" }, { "name": "nacrule_id", "value": "", "type": "query", "description": "NAC Policy Rule ID, if matched" }, { "name": "nacrule_matched", "value": "", "type": "query", "description": "NAC Policy Rule Matched" }, { "name": "nas_vendor", "value": "", "type": "query", "description": "Vendor of NAS device" }, { "name": "nas_ip", "value": "", "type": "query", "description": "IP address of NAS device" }, { "name": "ingress_vlan", "value": "", "type": "query", "description": "Vendor specific VLAN ID in RADIUS requests" }, { "name": "os", "value": "", "type": "query", "description": "Client OS, e.g. \"iOS 18.1\", \"Android\", \"Windows\", \"Linux\"" }, { "name": "ssid", "value": "", "type": "query", "description": "Filter results by SSID" }, { "name": "status", "value": "", "type": "query", "description": "Client connection status used to filter results. enum: `permitted`, `session_started`, `session_stopped`, `denied`" }, { "name": "text", "value": "", "type": "query", "description": "partial / full MAC address, last_username, device_mac, nas_ip. 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." }, { "name": "type", "value": "", "type": "query", "description": "Client type i.e. \"wireless\", \"wired\" etc." }, { "name": "usermac_label", "value": "", "type": "query", "description": "Labels derived from usermac entry" }, { "name": "username", "value": "", "type": "query", "description": "Filter results by username" }, { "name": "vlan", "value": "", "type": "query", "description": "Filter results by VLAN ID" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return per page" }, { "name": "start", "value": "", "type": "query", "description": "Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d` or `-1w`" }, { "name": "end", "value": "", "type": "query", "description": "Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as `-1d`, `-2h`, or `now`" }, { "name": "duration", "value": "", "type": "query", "description": "Time range duration for the query, using relative units such as `10m`, `7d`, or `2w`" }, { "name": "sort", "value": "", "type": "query", "description": "On which field the list should be sorted, -prefix represents DESC order." }, { "name": "search_after", "value": "", "type": "query", "description": "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." } ] }, "docs": "Search NAC clients for a site with filters for authentication, endpoint posture, identity, network, NAC rule, and time attributes. Use [Search Org NAC Clients](/#operations/searchOrgNacClients) to search NAC clients across the organization." }, { "info": { "name": "sendSiteNacClientCoA", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/sites/:site_id/nac_clients/:client_mac/coa", "params": [ { "name": "site_id", "value": "", "type": "path" }, { "name": "client_mac", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sends CoA (Change of Authorization) command to a NAC client." } ] } ], "bundled": true }