Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API to update guest user accounts within the Identities domain. It allows modifying various attributes of a guest user, such as email, MAC address, notes, simultaneous session limits, expiration behavior, sponsor information, visitor details, custom fields, password, and role assignments. This is useful in scenarios where administrators need to manage guest access dynamically, for example, updating guest credentials or permissions after account creation or adjusting session limits based on changing policies.

Practical examples include:

  • Updating a guest user's contact information or notes.
  • Changing the allowed number of simultaneous sessions for a guest.
  • Resetting a guest user's password securely.
  • Assigning a new role to a guest user to change their access level.
  • Triggering network state changes via Change of Authorization requests.

Properties

Name Meaning
Domain API domain to access. Options: Identities, Policy Elements, Enforcement Profile. For this operation, must be Identities.
Guest User ID Numeric ID of the guest account to update.
Additional Fields Optional additional guest user attributes to update:
- Email: Email address of the guest.
- MAC Address: MAC address of the guest's device.
- Notes: Comments or notes.
- Simultaneous Use: Number of concurrent sessions allowed.
- Do Expire: Action on expiry (0=Disable, 1=Delete, etc.).
- Sponsor Email: Email of the sponsor.
- Visitor Name: Full name of the guest.
- Visitor Company: Guest's company.
- Visitor Phone: Contact phone number.
- Custom Fields: JSON object with additional custom data.
Update Password Boolean flag indicating whether to update the guest user's password.
New Password The new password to set for the guest user. Required if Update Password is true.
Update Role Boolean flag indicating whether to update the guest user's role ID.
Role ID The new role ID to assign to the guest user. Required if Update Role is true.
Change of Authorization Boolean flag indicating whether to send a network state update using Disconnect-Request or Change of Authorization (CoA) Request.

Output

The node outputs an array of items representing the updated guest user(s). Each item contains a json field with the response data from the Aruba ClearPass API reflecting the updated guest user record.

If errors occur and "Continue on Fail" is enabled, the output will contain an item with an error field describing the failure message.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to Aruba ClearPass API authenticated via an API key credential configured in n8n.
  • The node depends on internal helper functions to execute the API operation but does not require external libraries beyond those bundled.
  • Proper permissions on the ClearPass server are necessary to update guest user records.

Troubleshooting

  • Common issues:

    • Invalid or missing Guest User ID will cause the update to fail.
    • Attempting to update password or role without enabling the respective flags (Update Password or Update Role) will ignore those fields.
    • Malformed JSON in Custom Fields may cause API rejection.
    • Network or authentication errors if API credentials are incorrect or expired.

  • Error messages:

    • Errors returned from the ClearPass API will be logged and can be output if "Continue on Fail" is enabled.
    • Typical error messages include "Guest User not found", "Invalid role ID", or "Unauthorized".

  • Resolutions:

    • Verify the Guest User ID exists before attempting update.
    • Ensure all required fields are correctly filled.
    • Validate JSON syntax for custom fields.
    • Check API credentials and permissions.

Links and References

Discussion