Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API to manage guest user accounts within the "Identities" domain. Specifically, the "Update By Username" operation allows updating details of a guest user identified by their username. This is useful in scenarios where administrators need to modify guest account information such as email, device MAC address, session limits, or reset passwords without creating new accounts.

Practical examples include:

  • Updating a guest user's contact information or notes.
  • Changing the number of simultaneous sessions allowed for a guest.
  • Resetting or changing the guest's password securely.
  • Modifying sponsor or visitor details associated with the guest account.

Properties

Name Meaning
Domain API domain to access. Options: Identities, Policy Elements, Enforcement Profile. For this operation, must be "Identities".
Username The username of the guest account to update.
Additional Fields Optional fields to update on the guest user account:
- Email: Guest's email address.
- MAC Address: MAC address of the guest's device.
- Notes: Comments or notes about the account.
- Simultaneous Use: Number of concurrent sessions allowed.
- Do Expire: Action when expiration time is reached (e.g., disable, delete).
- 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: Additional custom JSON fields.
Update Password Boolean flag indicating whether to update the guest user's password.
New Password The new password to set for the guest account. Required if "Update Password" is true.
Update Role Boolean flag indicating whether to update the role ID assigned to the guest user.
Role ID The new role ID to assign to the guest account. 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 after the update.

Output

The node outputs an array of items representing the updated guest user data returned from the Aruba ClearPass API. Each item contains a json field with the updated guest user properties reflecting the changes made.

If the operation fails and "Continue on Fail" is enabled, the output will contain an error object with the error message under json.error.

The node does not output binary data.

Dependencies

  • Requires an active connection to the Aruba ClearPass API via an API key credential configured in n8n.
  • The node depends on internal helper functions to execute the API operation.
  • Proper permissions on the ClearPass server are necessary to update guest user accounts.

Troubleshooting

  • Common Issues:

    • Invalid or missing username: Ensure the username exists in ClearPass before attempting update.
    • Insufficient permissions: The API key used must have rights to update guest users.
    • Incorrect domain or resource selection: Must select "Identities" domain and "GuestUser" resource.
    • Password update errors: When updating password, ensure the new password meets ClearPass policy requirements.

  • Error Messages:

    • API errors returned from ClearPass will be logged and can be output if "Continue on Fail" is enabled.
    • Network or authentication failures may cause the node to throw errors; verify API credentials and network connectivity.

Links and References

Discussion