Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API, allowing users to interact with various ClearPass resources such as Local Users, Devices, Endpoints, and Policy Elements. Specifically, for the "Local Users" resource and the "Get By User ID" operation, it retrieves detailed information about a local user identified by their unique user ID.

Common scenarios include:

  • Fetching user details for authentication or auditing purposes.
  • Integrating ClearPass user data into workflows for access control or reporting.
  • Automating user management tasks by retrieving user profiles dynamically.

Example: A network administrator can use this node to fetch a local user's profile by their user ID to verify their access rights before granting network access.

Properties

Name Meaning
Domain The API domain to access. Options are: "Identities", "Policy Elements", "Enforcement Profile". For this operation, "Identities" is used.
User ID The unique identifier of the local user whose information you want to retrieve.

Output

The node outputs an array of JSON objects representing the retrieved local user(s). Each object contains detailed user information as returned by the ClearPass API for the specified user ID.

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

No binary data output is indicated in the source code.

Dependencies

  • Requires an API key credential for authenticating with the Aruba ClearPass API.
  • The node depends on an internal helper function (executeOperation) that handles the actual API request based on the selected domain, resource, and operation.
  • Proper configuration of the API credentials within n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an incorrect or non-existent User ID will result in no data or an error from the API.
    • Selecting a mismatched domain/resource/operation combination may lead to unexpected errors.

  • Error messages:

    • Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as part of the node's output.
    • Typical error messages might relate to network connectivity, authorization failures, or invalid parameters.

  • Resolution tips:

    • Verify API credentials and permissions.
    • Ensure the User ID exists in the ClearPass system.
    • Confirm that the Domain is set to "Identities" when working with Local Users.
    • Enable "Continue on Fail" cautiously to handle errors gracefully in workflows.

Links and References

Discussion