Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Guest Users → Update By Username

AI-generated

Overview

This node interacts with the Aruba ClearPass API to update guest user accounts by their username within the Identities domain. It allows updating various guest user details such as email, MAC address, notes, simultaneous use sessions, expiration actions, sponsor email, visitor information, custom fields, password, role ID, and network state authorization. This node is useful in scenarios where administrators need to programmatically manage guest user accounts, for example, updating user details or changing access permissions based on username.

Use Case Examples

  1. Updating a guest user's email and MAC address by their username.
  2. Changing the password and role of a guest user identified by username.
  3. Modifying visitor information and custom fields for a guest user account.

Properties

Name Meaning
Domain API domain to access, fixed to 'Identities' for this operation.
Username Username of the guest account to update.
Additional Fields Optional fields to update on the guest user account, including email, MAC address, notes, simultaneous use sessions, expiration action, sponsor email, visitor name, visitor company, visitor phone, and custom JSON fields.
Update Password Boolean flag indicating whether to update the guest user's password.
New Password New password for the guest account, required if updating password.
Update Role Boolean flag indicating whether to update the guest user's role ID.
Role ID New role ID to assign to the guest user account, required if updating role.
Change of Authorization Boolean flag indicating whether to update the network state using Disconnect-Request or CoA-Request.

Output

JSON

  • id - Unique identifier of the updated guest user.
  • username - Username of the updated guest user.
  • email - Email address of the guest user.
  • mac - MAC address of the guest user's device.
  • notes - Notes or comments associated with the guest user.
  • simultaneous_use - Number of simultaneous sessions allowed for the guest user.
  • do_expire - Expiration action configured for the guest user.
  • sponsor_email - Sponsor's email address for the guest user.
  • visitor_name - Full name of the guest user.
  • visitor_company - Company name of the guest user.
  • visitor_phone - Contact phone number of the guest user.
  • customFields - Additional custom fields stored in JSON format.

Dependencies

  • An API key credential for Aruba ClearPass API authentication

Troubleshooting

  • Ensure the username provided exists in the Aruba ClearPass system; otherwise, the update will fail.
  • If updating the password or role, ensure the respective flags (Update Password, Update Role) are set to true and the new values are provided.
  • Check API credentials and network connectivity if the node fails to connect to the Aruba ClearPass API.
  • Error messages related to invalid JSON in custom fields should be resolved by providing properly formatted JSON.

Discussion