Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsClientsNAC

countOrgNacClients

GET
/api/v1/orgs/{org_id}/nac_clients/count

Count NAC clients across the organization, optionally grouped by distinct and filtered by authentication, identity, endpoint, network, site, and time attributes.

Authorization

Authorization<token>

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

org_id*string
Formatuuid

Query Parameters

distinct?string

Field used to group this count response. enum: ap, auth_type, device_mac, edr_managed, edr_providers, 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, site_id, ssid, status, type, usermac_label, username, vlan

Default"type"

Value in

  • "ap"
  • "auth_type"
  • "device_mac"
  • "edr_managed"
  • "edr_providers"
  • "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"
  • "site_id"
  • "ssid"
  • "status"
  • "type"
  • "usermac_label"
  • "username"
  • "vlan"
last_nacrule_id?string

NAC Policy Rule ID, if matched

nacrule_matched?boolean

NAC Policy Rule Matched

auth_type?string

Authentication type, e.g. "eap-tls", "eap-peap", "eap-ttls", "eap-teap", "mab", "psk", "device-auth"

last_vlan_id?string

Filter results by last VLAN ID

last_nas_vendor?string

Vendor of NAS device

idp_id?string

SSO ID, if present and used

last_ssid?string

Filter results by last SSID

last_username?string

Username presented by the client

site_id?string

Filter results by site identifier

last_ap?string

AP MAC connected to by client

mac?string

Filter results by MAC address

last_status?string

Connection status of client i.e "permitted", "denied, "session_ended"

type?string

Client type i.e. "wireless", "wired" etc. Accepts multiple comma-separated values.

mdm_compliance_status?string

MDM compliance of client i.e "compliant", "not compliant"

mdm_provider?string

MDM provider of client’s organization eg "intune", "jamf"

start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

duration?string

Time range duration for the query, using relative units such as 10m, 7d, or 2w

Default"1d"
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/nac_clients/count"
{  "distinct": "string",  "end": 0,  "limit": 0,  "results": [    {      "count": 0,      "property": "string"    }  ],  "start": 0,  "total": 0}

countOrgNacClientEvents GET

Count NAC client events across the organization, optionally grouped by `distinct` and filtered by event type and time range.

searchOrgNacClientEvents GET

Search NAC client authentication event records across the organization with filters for authentication, NAC rule, identity provider, RADIUS, network, endpoint, site, and time attributes.