Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API, specifically allowing interaction with various domains and resources within ClearPass. For the Local Users resource under the Identities domain, the node supports listing local user accounts managed by ClearPass.

Typical use cases include:

  • Retrieving a list of local users for auditing or synchronization purposes.
  • Filtering local users based on specific criteria such as username patterns.
  • Sorting and limiting results to manage large datasets efficiently.

For example, an IT administrator could use this node to fetch all local users whose usernames contain "admin" to review privileged accounts.

Properties

Name Meaning
Domain The API domain to access. Options: Identities, Policy Elements, Enforcement Profile.
Return All Whether to return all results or only up to a given limit (boolean).
Limit Maximum number of results to return when not returning all (number between 1 and 1000).
Filters Collection of optional filters to refine the list:
  Filter JSON filter expression specifying which items to return, e.g., {"user_id": {"$contains": "admin"}}.
  Sort Sort ordering for returned items, e.g., +username or -id.
  Calculate Count Whether to calculate the total item count (boolean).

Output

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

If errors occur and "Continue on Fail" is enabled, the output will be a JSON object containing an error field with the error message.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Aruba ClearPass API.
  • The node depends on internal helper functions (executeOperation) to perform the API calls.
  • Proper configuration of the ClearPass API endpoint and credentials in n8n is necessary.

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or missing API credentials.
    • Incorrect filter JSON syntax causing API request errors.
    • Exceeding API rate limits or result size limits without enabling "Return All".

  • 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 network issues, authentication, or invalid parameters.

  • Resolutions:

    • Verify API credentials and permissions.
    • Ensure filter expressions are valid JSON and conform to ClearPass API filtering syntax.
    • Use "Return All" cautiously to avoid performance issues.

Links and References

Discussion