Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Local Users → Create

AI-generated

Overview

This node interacts with the Aruba ClearPass API to create a local user within the Identities domain. It is useful for automating user management tasks such as adding new local users with specific credentials and roles in Aruba ClearPass environments. For example, it can be used in workflows that onboard new employees by creating their local user accounts with defined usernames, passwords, roles, and additional attributes.

Use Case Examples

  1. Creating a new local user with a username, password, and role in the Identities domain.
  2. Automating user account creation with additional settings like enabling the account or requiring a password change on next login.

Properties

Name Meaning
Domain API domain to access, fixed to 'Identities' for local user creation.
User ID Unique user_id of the local user to be created.
Password Password of the local user to be created.
Username Username of the local user to be created.
Role Name Role name assigned to the local user.
Additional Fields Optional additional fields for the local user such as enabling the account, requiring password change on next login, and storing additional attributes as key/value pairs.

Output

JSON

  • userId - Unique identifier of the created local user.
  • username - Username of the created local user.
  • roleName - Role assigned to the created local user.
  • enabled - Boolean flag indicating if the user account is enabled.
  • change_pwd_next_login - Boolean flag indicating if the user must change password on next login.
  • attributes - Additional attributes stored with the user account as key/value pairs.

Dependencies

  • Aruba ClearPass API with appropriate credentials

Troubleshooting

  • Common issues include authentication failures due to invalid API credentials, which can be resolved by verifying and updating the API key or token.
  • Validation errors may occur if required fields like userId, username, password, or roleName are missing or invalid; ensure all required fields are correctly provided.
  • Network connectivity issues to the Aruba ClearPass API endpoint can cause execution failures; verify network access and API endpoint availability.

Links

Discussion