Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API, allowing users to interact with various domains and resources within ClearPass. Specifically, for the "Guest Users" resource with the "Get" operation, it retrieves detailed information about a specific guest user account by its numeric ID. This is useful in scenarios where administrators need to fetch guest user details for auditing, monitoring, or management purposes.

Practical examples include:

  • Retrieving guest user profile data to verify access permissions.
  • Fetching guest user status before performing updates or deletions.
  • Integrating guest user information into broader workflows for network access control.

Properties

Name Meaning
Domain The API domain to access. Options: "Identities", "Policy Elements", "Enforcement Profile". For this operation, must be "Identities".
Guest User ID Numeric ID of the guest user account to retrieve. Required when Domain is "Identities" and Resource is "GuestUser" with operation "Get".

Output

The node outputs an array of JSON objects representing the retrieved guest user(s). Each object contains detailed properties of the guest user as returned by the Aruba ClearPass API. The exact structure depends on the API response but typically includes fields such as user identifiers, status, creation date, and other metadata related to the guest account.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Aruba ClearPass API.
  • Needs an API authentication credential configured in n8n (an API key or token).
  • The node relies on internal helper functions to execute the API call.

Troubleshooting

  • Common issues:

    • Invalid or missing Guest User ID will cause the API call to fail.
    • Incorrect domain or resource selection may result in no data or errors.
    • Authentication failures if the API credential is not properly set up.

  • Error messages:

    • Errors from the API are caught and logged. If "Continue on Fail" is enabled, the error message is returned as part of the node output.
    • Typical error messages might include "Guest User not found" or "Unauthorized access".

  • Resolutions:

    • Verify that the Guest User ID is correct and exists in ClearPass.
    • Ensure the API credentials are valid and have sufficient permissions.
    • Confirm that the selected domain and resource match the intended operation.

Links and References

Discussion