Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

The "Replace By Username" operation for the "Guest Users" resource in this Aruba ClearPass node allows you to completely replace an existing guest user account identified by its username. This means updating all relevant details of the guest user, such as password, role, sponsor information, account state, and timing parameters, effectively overwriting the current record with new data.

This operation is useful when you need to update a guest user's entire profile in one atomic action, for example:

  • Resetting a guest's password and updating their access duration.
  • Changing the sponsor or role assigned to a guest user.
  • Reactivating or disabling a guest account by modifying its enabled state and expiration times.

Practical scenarios include managing temporary network access for visitors in corporate environments, where guest accounts must be frequently updated or replaced based on changing requirements.

Properties

Name Meaning
Domain API domain to access. Options: Identities, Policy Elements, Enforcement Profile. For this operation, "Identities" is used.
Username The username of the guest account to replace. Identifies which guest user record will be overwritten.
Password New password for the guest account.
Role ID Numeric ID representing the role to assign to the guest account (default typically corresponds to the Guest role).
Sponsor Name Name of the sponsor responsible for the guest account.
Sponsor Profile Profile description of the sponsor.
Account State Boolean indicating whether the guest account is enabled (true) or disabled (false).
Start Time ISO 8601 formatted date-time string specifying when the guest account becomes active/enabled.
Expire Time ISO 8601 formatted date-time string specifying when the guest account expires.
Additional Fields A collection of optional fields that can be added to the guest user profile, including:
- Email address
- MAC address of guest device
- Notes/comments
- Number of simultaneous sessions allowed
- Expiration action (disable, delete, etc.)
- Sponsor email
- Visitor name, company, phone
- Custom JSON fields for extra data
Change of Authorization Boolean flag indicating whether to send a network state update using Disconnect-Request or Change of Authorization (CoA) request when modifying the guest user.

Output

The node outputs an array of items where each item contains a json object representing the response from the Aruba ClearPass API after performing the replace operation. This typically includes the updated guest user details as confirmed by the API.

If an error occurs 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 involved in this operation.

Dependencies

  • Requires an API key credential configured in n8n to authenticate with the Aruba ClearPass API.
  • The node interacts with the Aruba ClearPass server endpoints corresponding to the selected domain and resource.
  • Proper network connectivity and permissions are necessary to perform guest user management operations via the ClearPass API.

Troubleshooting

  • Common Issues:

    • Invalid or missing username: The operation requires a valid existing username to replace; ensure the username exists.
    • Incorrect API credentials or insufficient permissions may cause authentication failures.
    • Date-time fields must be in correct ISO 8601 format; invalid formats can cause errors.
    • Role ID must correspond to a valid role in ClearPass; otherwise, the API may reject the request.

  • Error Messages:

    • Authentication errors indicate issues with the provided API key or token.
    • Validation errors often specify which input property is incorrect or missing.
    • Network errors suggest connectivity problems between n8n and the ClearPass server.

  • Resolutions:

    • Verify API credentials and permissions.
    • Double-check all required fields, especially username, password, and dates.
    • Use proper ISO 8601 formatting for date-time inputs.
    • Confirm role IDs and other references exist in ClearPass before running the operation.

Links and References

Discussion