Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Guest Users → Update

AI-generated

Overview

This node interacts with the Aruba ClearPass API to update guest user accounts within the Identities domain. It allows users to modify various attributes of a guest user, such as email, MAC address, notes, simultaneous session limits, expiration actions, sponsor details, visitor information, custom fields, password, and role ID. This node is useful in scenarios where administrators need to manage guest user accounts dynamically, for example, updating user details or changing access permissions.

Use Case Examples

  1. Updating a guest user's email and MAC address to reflect new device information.
  2. Changing the password and role of a guest user to enhance security or modify access rights.
  3. Adding notes or custom fields to a guest user account for better tracking and management.

Properties

Name Meaning
Domain API domain to access, set to 'Identities' for guest user operations.
Guest User ID Numeric ID 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, company, 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 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 - The unique identifier of the updated guest user.
  • email - The updated email address of the guest user.
  • mac - The updated MAC address of the guest user's device.
  • notes - Updated comments or notes associated with the guest user.
  • simultaneous_use - Updated number of simultaneous sessions allowed.
  • do_expire - Updated action to take when expiration time is reached.
  • sponsor_email - Updated sponsor email address.
  • visitor_name - Updated full name of the guest user.
  • visitor_company - Updated company name of the guest user.
  • visitor_phone - Updated contact phone number of the guest user.
  • customFields - Updated additional custom fields in JSON format.
  • password - Updated password if changed.
  • roleId - Updated role ID if changed.
  • changeOfAuthorization - Indicates if network state was updated using Disconnect-Request or CoA-Request.

Dependencies

  • An API key credential for Aruba ClearPass API authentication

Troubleshooting

  • Ensure the Guest User ID is correct and exists in the system to avoid 'not found' errors.
  • If updating the password, ensure the new password meets the ClearPass password policy requirements.
  • Verify that the role ID provided exists and is valid to prevent role assignment errors.
  • Check network connectivity and API credentials if the node fails to connect to the ClearPass API.
  • If 'Change of Authorization' is enabled, ensure the network devices support CoA or Disconnect-Request to avoid authorization update failures.

Links

Discussion