Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Guest Users → List

AI-generated

Overview

This node interacts with the Aruba ClearPass API to list guest users within the Identities domain. It is useful for scenarios where you need to retrieve and manage guest user information from Aruba ClearPass, such as fetching active guest users, filtering by specific criteria, or sorting the results. For example, an administrator can use this node to get a list of all active guest users or to retrieve guest users matching certain username patterns.

Use Case Examples

  1. Retrieve all guest users with active status.
  2. Fetch guest users filtered by username containing 'test'.
  3. Sort guest users by their expiration time.

Properties

Name Meaning
Domain API domain to access, fixed to 'Identities' for this operation.
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of guest user results to return when 'Return All' is false.
Filters Collection of optional filters to refine the guest user list results.

Output

JSON

  • id - Unique identifier of the guest user.
  • username - Username of the guest user.
  • current_state - Current state/status of the guest user (e.g., active, inactive).
  • expire_time - Expiration time of the guest user account.
  • additionalProperties - Other guest user properties returned by the API.

Dependencies

  • Aruba ClearPass API
  • An API key credential for authentication

Troubleshooting

  • Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
  • Incorrect filter JSON syntax can cause errors; validate the filter expression before use.
  • If the node returns fewer results than expected, check the 'Return All' and 'Limit' settings to ensure they match your needs.

Links

Discussion