Actions34
- Devices Actions
- Endpoints Actions
- Guest Users Actions
- Local Users Actions
Local Users → List
AI-generatedOverview
This node interacts with the Aruba ClearPass API to list local users within the Identities domain. It is useful for scenarios where you need to retrieve user information from the ClearPass system, such as for auditing, monitoring, or integrating user data into other workflows. For example, you can list all local users or apply filters to find specific users based on criteria like user ID or username.
Use Case Examples
- Retrieve all local users from the Identities domain.
- List local users with a filter to find users whose user_id contains 'admin'.
- Limit the number of returned local users to 100 for performance optimization.
Properties
| Name | Meaning |
|---|---|
| Domain | API domain to access, fixed to 'Identities' for local users. |
| Return All | Whether to return all results or only up to a given limit. |
| Limit | Maximum number of results to return when 'Return All' is false. |
| Filters | Collection of optional filters to refine the list of local users, including JSON filter expressions, sort order, and whether to calculate the total count. |
Output
JSON
id- Unique identifier of the local user.username- Username of the local user.email- Email address of the local user.roles- Roles assigned to the local user.status- Status of the local user account.
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.
- Errors may occur if the filter JSON expression is malformed; validate JSON syntax before use.
- If the node returns fewer results than expected, check the 'Return All' and 'Limit' settings to ensure they meet your requirements.