Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API, specifically allowing users to list Guest Users within the "Identities" domain. It is designed to retrieve guest user data from an Aruba ClearPass system, which is commonly used for network access control and policy management.

Typical use cases include:

  • Fetching a list of active or specific guest users for auditing or reporting.
  • Integrating guest user information into workflows for automated provisioning or deprovisioning.
  • Filtering guest users based on custom criteria such as username patterns or account states.

For example, a network administrator might use this node to pull all currently active guest users whose usernames contain "test" to verify temporary access accounts.

Properties

Name Meaning
Domain The API domain to access. Options: Identities, Policy Elements, Enforcement Profile. For listing guest users, must be Identities.
Return All Whether to return all results or limit the number of returned items.
Limit Maximum number of results to return when Return All is false (minimum 1, maximum 1000).
Filters Collection of optional filters to refine the list query:
   Filter JSON filter expression specifying conditions to match guest users, e.g., {"current_state": "active"} or partial matches like {"username": {"$contains": "test"}}.
   Sort Sort order for returned items, e.g., -id (default), +username, or -expire_time.
   Calculate Count Boolean flag indicating whether to calculate the total count of matching items.

Output

The node outputs an array of JSON objects representing guest users retrieved from the Aruba ClearPass API. Each object corresponds to a guest user record with fields as defined by the ClearPass API schema for guest users.

If the node encounters an error and "Continue on Fail" is enabled, it outputs a single item containing an error field with the error message.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential configured in n8n to authenticate with the Aruba ClearPass API.
  • The node depends on internal helper functions (from ./helpers/executeOperation) to perform the actual API call.
  • Proper network connectivity to the Aruba ClearPass server is necessary.

Troubleshooting

  • Common Issues:

    • Authentication failures due to invalid or missing API credentials.
    • Network timeouts or unreachable ClearPass server.
    • Invalid JSON filter expressions causing API errors.
    • Exceeding API rate limits or result size limits.

  • Error Messages:

    • Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as part of the output.
    • Typical error messages may relate to authentication, malformed filters, or server errors.

  • Resolutions:

    • Verify API credentials and permissions.
    • Ensure the ClearPass server URL and network access are correct.
    • Validate JSON filter syntax before using.
    • Adjust Limit or enable Return All carefully to avoid large payloads.

Links and References

Discussion