Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API, allowing users to manage various resources within the ClearPass system. Specifically, for the "Guest Users" resource and the "Delete" operation, it enables the deletion of a guest user account by its numeric ID. This is useful in scenarios where temporary or expired guest accounts need to be removed from the network access control system to maintain security and compliance.

Practical examples include:

  • Automatically removing guest user accounts after their access period expires.
  • Cleaning up test or temporary guest accounts created during events or troubleshooting.
  • Managing guest user lifecycle as part of automated workflows in network administration.

Properties

Name Meaning
Domain The API domain to access. Options: "Identities", "Policy Elements", "Enforcement Profile".
Guest User ID Numeric ID of the guest user account to delete. Required when Domain is "Identities" and Resource is "GuestUser".
Change of Authorization Boolean flag indicating whether to update the network state using Disconnect-Request or Change of Authorization (CoA) Request when deleting the guest user. Defaults to false.

Output

The node outputs an array of JSON objects representing the result of the delete operation. Typically, this will confirm the success or failure of the deletion request. If the operation fails and "Continue on Fail" is enabled, the output will contain an error message in the json.error field.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Aruba ClearPass API.
  • The node depends on the external Aruba ClearPass service being accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common Issues:

    • Invalid or missing Guest User ID: Ensure the provided ID corresponds to an existing guest user.
    • Authentication failures: Verify that the API key credential is valid and has sufficient permissions.
    • Network connectivity issues: Confirm that the ClearPass API endpoint is reachable from n8n.

  • Error Messages:

    • Errors returned from the ClearPass API will be logged and, if "Continue on Fail" is enabled, passed as output with the error message under json.error.
    • Typical errors might include "User not found" if the Guest User ID does not exist, or "Unauthorized" if credentials are invalid.

Links and References

Discussion