DNSFilter icon

DNSFilter

**Note:** If you are a distributor integrating with DNSFilter, please check out our [Distributors Development Guide](/docs/distributors).### Authentication- Authentication is required for most, but not all, endpoints.- Authentication is done by setting the `Authorization` request header. The header value is the API key itself. For example: `Authorization: eyJ...`- An API key can be obtained through the DNSFilter dashboard under Account Settings. For additional information see [this KB article](https://help.dnsfilter.com/hc/en-us/articles/21169189058323-API-Tokens).### Rate Limiting- All endpoints are rate limited.- The limits may vary by endpoint, but are generally consistent.- When the rate limit is exceeded the API will return the standard `429` HTTP status.- The following headers will also be provided in the response: `Retry-After`, `RateLimit-Policy`, `RateLimit`, `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset`. For details on the values of these headers, see the following articles [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After), [here](https://www.ietf.org/archive/id/draft-ietf-httpapi-ratelimit-headers-08.html), and [here](https://www.ietf.org/archive/id/draft-polli-ratelimit-headers-05.html).- For additional information see [this KB article](https://help.dnsfilter.com/hc/en-us/articles/38202811088403-API-Rate-Limits).### Error Handling- The API uses standard HTTP status codes to indicate success or failure.- For _V1_ endpoints the response format is: ```json { "error": "string", "type": "string(optional)" } ```- For _V2_ endpoints the response format is: ```json { "error": { "message": "string", "type": "string(optional)" } } ```### PaginationFor the _V1_ endpoints, the pagination parameters are nested. That is to say,if passed as JSON they look like this: `{"page[number]": 1, "page[size]": 10}`.To pass this information in the URL query string, it would be formatted likethis: `...?page%5Bnumber%5D=1&page%5Bsize%5D=10`.In this guide, the UI will indicate that `page` is an `object` and if youwant to set values when trying the request, you must enter it as if it wasthe JSON above.### A Quick ExampleThe following will return information about the currentlyauthenticated user.```bash% curl -H 'Authorization: ***' https://api.dnsfilter.com/v1/users/self{ "data": { "id": "12345", "type": "users", "attributes": { "name": "John Doe", "email": "john@example.com", ...additional fields...}}}```
Join our community

Actions328

Overview

This node interacts with the DNSFilter API to retrieve information about agent local users associated with an organization. Specifically, the 'Gets extant users' operation fetches a list of existing agent local users with basic information. It supports filtering by collection membership, name, organization IDs, search terms, and sorting options. The node can handle pagination and return all results or a single page based on user input. This is useful for scenarios where you need to manage or analyze local users on agents within an organization, such as auditing user access or integrating user data into workflows.

Use Case Examples

  1. Retrieve all agent local users in an organization to audit user access.
  2. Fetch a filtered list of agent local users by name or collection for reporting purposes.

Properties

Name Meaning
Return All Whether to return all results or only a single page. When disabled, no pagination parameters are sent and only one page of results is returned.
Additional Fields Optional filters and parameters to refine the query, including filtering by collection membership, name, organization IDs, pagination, search, and sorting.

Output

JSON

  • json - The JSON response containing the list of agent local users and their details.

Dependencies

  • An API key credential for DNSFilter API authentication.

Troubleshooting

  • Ensure the API key credential is correctly configured and has the necessary permissions to access agent local user data.
  • Check the network connectivity to the DNSFilter API endpoint.
  • If pagination is enabled, verify that the pagination parameters are correctly set to avoid incomplete data retrieval.
  • Review the debug output (if enabled) to inspect the actual API request and response for troubleshooting.

Links

Discussion