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 updates an existing enterprise connection in the DNSFilter system. It is useful for managing and modifying enterprise connection settings such as organization IDs, display names, roles, identity providers, and authorized domains. For example, an administrator can update the display name or role mappings of an enterprise connection to reflect organizational changes or security policies.

Use Case Examples

  1. Update the display name and authorized domains of an enterprise connection to reflect a rebranding.
  2. Modify the default role and role map of an enterprise connection to adjust user permissions.

Properties

Name Meaning
Id The unique identifier of the enterprise connection to update.
Options JSON object containing strategy-dependent options for the enterprise connection.
Additional Fields Optional fields to update such as organization ID, default organization ID, display name, default role, role map, identity provider type, and authorized domains.

Output

JSON

  • id - The ID of the updated enterprise connection.
  • organization_id - The organization ID associated with the updated enterprise connection.
  • default_organization_id - The default organization ID of the updated enterprise connection.
  • display_name - The display name of the updated enterprise connection.
  • role_default - The default role of the updated enterprise connection.
  • role_map - The role map of the updated enterprise connection.
  • idp - The identity provider type of the updated enterprise connection.
  • authorized_domains - The list of domains authorized to connect through the updated enterprise connection.

Dependencies

  • An API key credential for DNSFilter API authentication.

Troubleshooting

  • Ensure the provided enterprise connection ID exists and is correct.
  • Verify that the options JSON is correctly formatted and contains valid strategy-dependent attributes.
  • Check that the API key credential is valid and has sufficient permissions to update enterprise connections.
  • If the API returns rate limit errors (HTTP 429), implement retry logic with delays as recommended by the API documentation.

Links

Discussion