Actions34
- Devices Actions
- Endpoints Actions
- Guest Users Actions
- Local Users Actions
Overview
This node integrates with the Aruba ClearPass API, enabling automation and management of network access control elements. Specifically, for the "Guest Users" resource and the "Delete By Username" operation, it allows users to delete a guest user account identified by their username within the ClearPass system.
Common scenarios include:
- Automatically removing guest accounts when they expire or are no longer needed.
- Cleaning up test or temporary guest accounts as part of a workflow.
- Enforcing security policies by revoking guest access promptly.
Practical example:
- A workflow that triggers when a guest's visit period ends, automatically deleting their account by username to prevent unauthorized network access.
Properties
| Name | Meaning |
|---|---|
| Domain | The API domain to access. Options: "Identities", "Policy Elements", "Enforcement Profile". |
| Username | The username of the guest account to delete. Required when Domain is "Identities" and Resource is "GuestUser". |
| Change of Authorization | Whether to update the network state using a Disconnect-Request or Change of Authorization (CoA) Request. Boolean value (true or false). |
Output
The node outputs an array of JSON objects representing the result of the delete operation. Typically, this will confirm successful deletion or provide error details if the operation failed.
If the operation fails and "Continue on Fail" is enabled, the output will contain an object with an error field describing the failure message.
No binary data output is indicated in the source code.
Dependencies
- Requires an API key credential for authenticating with the Aruba ClearPass API.
- The node depends on the external Aruba ClearPass API service being accessible.
- No additional environment variables or configurations are explicitly required beyond the API credential.
Troubleshooting
Common issues:
- Invalid or missing username: The node requires a valid username to identify the guest user to delete.
- Authentication failures: Ensure the API key credential is correctly configured and has sufficient permissions.
- Network connectivity problems: The node must reach the Aruba ClearPass API endpoint.
- Using the wrong domain or resource combination may cause the operation to fail.
Error messages:
- Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as output with an
errorproperty. - Typical errors might include "User not found," "Unauthorized," or "Invalid request."
- Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as output with an
Resolution tips:
- Verify the username exists in the ClearPass system.
- Check API credentials and permissions.
- Confirm the domain and resource selections match the intended operation.
- Enable "Continue on Fail" to handle errors gracefully in workflows.