Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Overview

This node integrates with the Aruba ClearPass API, specifically allowing users to manage local user accounts within the "Identities" domain. The "Create" operation for the "Local Users" resource enables creating new local user accounts in ClearPass.

Typical use cases include automating user provisioning workflows, such as onboarding new employees or guests by programmatically creating their local user accounts with specified credentials and roles. For example, an IT administrator could use this node to bulk-create local users with predefined roles and passwords, streamlining access management.

Properties

Name Meaning
Domain API domain to access. Options: Identities, Policy Elements, Enforcement Profile.
User ID Unique identifier (user_id) of the local user to create.
Password Password for the local user account.
Username Username of the local user.
Role Name Role assigned to the local user.
Additional Fields Optional additional settings for the user:
  Enabled Boolean flag indicating if the account is enabled (default: true).
  Change Password Next Login Boolean flag indicating if the user must change password on next login (default: false).
  Attributes JSON object containing additional key/value attributes to store with the user account.

Output

The node outputs an array of JSON objects representing the results of the executed operation. Each item corresponds to a created local user record returned from the ClearPass API. The exact structure depends on the API response but typically includes details about the newly created user.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to Aruba ClearPass API.
  • Needs an API authentication credential configured in n8n (an API key or token).
  • The node uses internal helper functions to execute operations against the ClearPass API.

Troubleshooting

  • Common Issues:

    • Authentication failures due to invalid or missing API credentials.
    • Validation errors if required fields like User ID, Username, Password, or Role Name are missing or malformed.
    • API domain or resource mismatches causing unsupported operation errors.

  • Error Messages:

    • Errors thrown by the ClearPass API will be logged and can be returned as output if "Continue on Fail" is enabled.
    • Typical error messages may include permission denied, user already exists, or invalid input data.

  • Resolution Tips:

    • Verify that all required properties are correctly set.
    • Ensure the API credential has sufficient permissions.
    • Check the domain and resource selections match the intended operation.
    • Enable "Continue on Fail" to capture errors as output for debugging.

Links and References

Discussion