Actions34
- Devices Actions
- Endpoints Actions
- Guest Users Actions
- Local Users Actions
Overview
This node integrates with the Aruba ClearPass API, specifically allowing interaction with various domains such as Identities, Policy Elements, and Enforcement Profile. The "Local Users" resource under the "Identities" domain supports operations including updating local user accounts.
The Update operation for Local Users enables modifying existing user details like username, password, role, and account status flags. This is useful in scenarios where administrators need to programmatically manage user accounts, e.g., enabling/disabling accounts, forcing password changes on next login, or updating user attributes in bulk.
Practical examples:
- Automatically disable a user account after suspicious activity.
- Update user roles based on changes in organizational structure.
- Enforce password resets by setting the "change password next login" flag.
Properties
| Name | Meaning |
|---|---|
| Domain | API domain to access. Options: Identities, Policy Elements, Enforcement Profile. |
| Local User ID | Numeric ID of the local user to update (required when domain is Identities and resource is LocalUser). |
| Update Fields | Collection of fields to update for the local user: |
| - User ID: Unique user identifier string. | |
| - Password: New password for the user. | |
| - Username: New username. | |
| - Role Name: Role assigned to the user. | |
| Additional Fields | Additional optional fields: |
| - Enabled: Boolean flag to enable/disable the account. | |
| - Change Password Next Login: Boolean flag to require password change at next login. | |
| - Attributes: JSON object containing additional key/value pairs stored with the user account. |
Output
The node outputs an array of JSON objects representing the results returned from the Aruba ClearPass API after performing the update operation. Each item corresponds to an updated local user record or relevant response data from the API.
If the operation fails and "Continue on Fail" is enabled, the output will contain an error message in JSON format under the error field.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the Aruba ClearPass API.
- The node depends on an internal helper module (
executeOperation) that handles the actual API request execution. - Proper configuration of the API domain and resource selection is necessary.
- Network connectivity to the Aruba ClearPass server is required.
Troubleshooting
Common issues:
- Invalid or missing Local User ID when updating a user.
- Insufficient permissions or invalid API credentials causing authentication failures.
- Incorrect domain or resource selection leading to unsupported operations.
- Malformed JSON in the "Attributes" field causing API errors.
Error messages:
- Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as part of the output JSON.
- Typical errors include authentication failures, validation errors from the API, or network timeouts.
Resolutions:
- Verify the Local User ID is correct and exists.
- Ensure API credentials are valid and have sufficient permissions.
- Double-check the domain/resource/operation combination matches the intended action.
- Validate JSON syntax in attribute fields before submission.