Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Local Users → Replace

AI-generated

Overview

This node interacts with the Aruba ClearPass API to replace (update fully) a local user account within the Identities domain. It is useful for scenarios where you need to update all details of a local user, such as username, password, role, and additional attributes, ensuring the user account information is current and accurate.

Use Case Examples

  1. Replacing a local user's password and role after a security policy update.
  2. Updating a local user's username and enabling the account after reactivation.

Properties

Name Meaning
Domain API domain to access, fixed to 'Identities' for local user operations.
Local User ID Numeric ID of the local user to replace (used for identifying the user in the API).
User ID Unique user_id of the local user (alternative identifier for the user).
Password Password of the local user to set during replacement.
Username Username of the local user to set during replacement.
Role Name Role name assigned to the local user.
Additional Fields Optional additional fields such as account enabled flag, password change requirement on next login, and extra attributes stored as key/value pairs.

Output

JSON

  • id - The unique identifier of the replaced local user.
  • username - The username of the replaced local user.
  • userId - The unique user ID of the replaced local user.
  • roleName - The role name assigned to the replaced local user.
  • enabled - Boolean flag indicating if the user account is enabled.
  • attributes - Additional attributes associated with the local user.

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 local user ID or user ID provided does not exist or is invalid. Verify the IDs before executing the replace operation.
  • If required fields like username, password, or role name are missing, the API may reject the request. Ensure all mandatory fields are provided.
  • Network connectivity issues to the Aruba ClearPass API endpoint can cause execution failures. Check network access and API endpoint availability.

Links

Discussion