AvantGuard - ClerkChat icon

AvantGuard - ClerkChat

AvantGuard - ClerkChat

Overview

This node operation, Remove Team Whitelisted Domain, is designed to remove a specific domain from the whitelist of a team within a reseller context. It is useful in scenarios where an organization wants to restrict or update the domains that are allowed for a particular team, such as revoking access for certain email domains or cleaning up outdated entries.

Practical examples include:

  • Removing a domain that was mistakenly whitelisted.
  • Updating team security policies by removing domains no longer associated with the team.
  • Managing domain access dynamically based on organizational changes.

Properties

Name Meaning
Team Id The unique identifier of the team from which the domain will be removed.
Domain Id The unique identifier of the domain to be removed from the team's whitelist.

Output

The node outputs JSON data representing the result of the removal operation. Typically, this would include confirmation of success or failure and may contain metadata about the updated team whitelist state. If the operation supports binary data output, it would relate to any files or attachments returned by the API, but none are indicated here.

Dependencies

  • Requires an API key credential for authentication to the external service managing reseller teams and domains.
  • Depends on the external API endpoint configured via the node’s credentials (e.g., a base URL and authentication token).
  • Uses the @avantguardllc/n8n-openapi-node package for OpenAPI integration, indicating reliance on a RESTful API described by an OpenAPI specification.

Troubleshooting

  • Missing or invalid Team Id or Domain Id: Ensure both IDs are provided and correctly formatted; otherwise, the API call will fail.
  • Authentication errors: Verify that the API key or authentication token is valid and has sufficient permissions to modify team whitelists.
  • Domain not found: If the domain ID does not exist in the team’s whitelist, the operation may return an error or no-op response.
  • Network or API errors: Check connectivity and API availability if requests time out or fail unexpectedly.

Links and References

Discussion