{ "opencollection": "1.0.0", "info": { "name": "DNSFilter Agent Local User Bulk Deletes Agent Local Users API", "version": "2026-07-13" }, "items": [ { "info": { "name": "Agent Local Users", "type": "folder" }, "items": [ { "info": { "name": "Gets extant users", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/agent_local_users", "params": [ { "name": "block_page", "value": "", "type": "query", "description": "Filter by block page name" }, { "name": "collection_id", "value": "", "type": "query", "description": "Filter by collection" }, { "name": "cybersight_enabled", "value": "", "type": "query", "description": "When true, use OpenSearch for activity in the time window: without user_agent_uuids, return extant ALUs seen on any Cybersight-eligible roaming client in the org(s); with user_agent_uuids, return ALUs seen on those roaming clients. When false, use Postgres only (default: false)" }, { "name": "end_at", "value": "", "type": "query", "description": "ISO8601 end of activity window. Optional; only used with start_at when cybersight_enabled=true." }, { "name": "friendly_name", "value": "", "type": "query", "description": "Filter by friendly name" }, { "name": "ids", "value": "", "type": "query", "description": "Filter to users whose IDs are in the specified list of values" }, { "name": "in_a_collection", "value": "", "type": "query", "description": "filter by agent local users in a collection" }, { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID. When provided, returns agent local users across all organizations belonging to this MSP." }, { "name": "name", "value": "", "type": "query", "description": "filter by name. If friendly_name not found, will search by user_name" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Organization IDs, defaults to user organization ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number and size" }, { "name": "policy_schedule", "value": "", "type": "query", "description": "Filter by policy or scheduled policy name" }, { "name": "search", "value": "", "type": "query", "description": "Filter by name or user_login" }, { "name": "sort", "value": "", "type": "query", "description": "Sort options, valid attributes: name, first_seen, last_seen. Prefix with - for descending (e.g. -first_seen)" }, { "name": "start_at", "value": "", "type": "query", "description": "ISO8601 start of activity window. Optional; only used when cybersight_enabled=true. Omitted => last 91 days unless paired with end_at." }, { "name": "user_agent_uuids", "value": "", "type": "query", "description": "Filter to users associated with these roaming clients. When cybersight_enabled=true uses Cybersight activity (OpenSearch); otherwise uses current user on device (PG)." }, { "name": "user_login", "value": "", "type": "query", "description": "Filter by user login" }, { "name": "user_name", "value": "", "type": "query", "description": "Filter by username" }, { "name": "user_policy_override", "value": "", "type": "query", "description": "When true, return only users with a policy or scheduled policy directly assigned. When false, return only users without a direct policy or scheduled policy assignment." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets the agent local users associated to an organization with basic information." }, { "info": { "name": "Gets ALL users", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/agent_local_users/all", "params": [ { "name": "cybersight_enabled", "value": "", "type": "query", "description": "When true, use OpenSearch for activity in the time window: without user_agent_uuids, return ALUs seen on any Cybersight-eligible roaming client in scope; with user_agent_uuids, return ALUs seen on those roaming clients. When false, use Postgres only (default: false)" }, { "name": "end_at", "value": "", "type": "query", "description": "ISO8601 end of activity window. Optional; only used with start_at when cybersight_enabled=true." }, { "name": "in_a_collection", "value": "", "type": "query", "description": "filter by agent local users in a collection" }, { "name": "name", "value": "", "type": "query", "description": "filter by name. If friendly_name not found, will search by user_name" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Organization IDs, defaults to user organization ID" }, { "name": "page", "value": "", "type": "query", "description": "Page number and size" }, { "name": "sort", "value": "", "type": "query", "description": "Sort options, valid attributes: name" }, { "name": "start_at", "value": "", "type": "query", "description": "ISO8601 start of activity window. Optional; only used when cybersight_enabled=true. Omitted => last 91 days unless paired with end_at." }, { "name": "user_agent_uuids", "value": "", "type": "query", "description": "Filter to users associated with these roaming clients. When cybersight_enabled=true uses Cybersight activity (OpenSearch); otherwise uses current user on device (PG)." }, { "name": "user_policy_override", "value": "", "type": "query", "description": "When true, return only users with a policy or scheduled policy directly assigned. When false, return only users without a direct policy or scheduled policy assignment." } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets ALL agent local users associated to an user organization with basic information." }, { "info": { "name": "Show extant user", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v1/agent_local_users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Agent local user ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets basic information of the specified agent local user." }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.dnsfilter.com/v1/agent_local_users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Agent local user ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates an agent local user with the specified data." }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.dnsfilter.com/v1/agent_local_users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Agent local user ID" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Deletes a agent local user." }, { "info": { "name": "Count users", "type": "http" }, "http": { "method": "GET", "url": "https://api.dnsfilter.com/v2/agent_local_users/counts", "params": [ { "name": "msp_id", "value": "", "type": "query", "description": "MSP ID. When provided, returns counts across all organizations belonging to this MSP." }, { "name": "name", "value": "", "type": "query", "description": "filter by name. If friendly_name not found, will search by user_name" }, { "name": "organization_ids", "value": "", "type": "query", "description": "Organization IDs, defaults to user organization ID" }, { "name": "search", "value": "", "type": "query", "description": "Filter by name or user_login" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Gets counts of agent local users by policy assignment status." } ] } ], "bundled": true }