Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Guest Users → Replace By Username

AI-generated

Overview

This node interacts with the Aruba ClearPass API to replace a guest user account identified by its username. It is useful for updating all details of an existing guest user account in the Identities domain, such as changing the password, role, sponsor information, account state, and timing details. This operation is beneficial in scenarios where a guest user's account needs to be fully replaced or refreshed with new information, for example, when updating access credentials or sponsor details for a guest user in a network environment.

Use Case Examples

  1. Replacing a guest user's account details by username to update their password and role.
  2. Updating the sponsor information and account expiration time for a guest user identified by username.

Properties

Name Meaning
Domain API domain to access, fixed to 'Identities' for this operation.
Username Username of the guest account to be replaced.
Password New password for the guest account.
Role ID Role ID to assign to the guest account, typically the Guest role.
Sponsor Name Name of the sponsor of the guest account.
Sponsor Profile Profile of the sponsor of the guest account.
Account State Whether the guest account is enabled or disabled.
Start Time Time at which the guest account will be enabled (ISO 8601 format).
Expire Time Time at which the guest account will expire (ISO 8601 format).
Additional Fields Optional additional fields for the guest account such as email, MAC address, notes, simultaneous use sessions, expiration action, sponsor email, visitor details, and custom JSON fields.
Change of Authorization Whether to update the network state using Disconnect-Request or CoA-Request.

Output

JSON

  • username - The username of the replaced guest user account.
  • password - The password set for the guest user account.
  • roleId - The role ID assigned to the guest user account.
  • sponsorName - The sponsor's name associated with the guest user account.
  • sponsorProfile - The sponsor's profile associated with the guest user account.
  • enabled - The enabled state of the guest user account.
  • startTime - The start time when the guest user account becomes active.
  • expireTime - The expiration time of the guest user account.
  • additionalFields
    • email - Email address of the guest user.
    • mac - MAC address of the guest user's device.
    • notes - Notes or comments about the guest user account.
    • simultaneous_use - Number of simultaneous sessions allowed.
    • do_expire - Action to take when the account expires.
    • sponsor_email - Sponsor's email address.
    • 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 in JSON format.
  • changeOfAuthorization - Indicates if a network state update request was sent.

Dependencies

  • An API key credential for Aruba ClearPass API authentication

Troubleshooting

  • Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
  • Invalid or missing required fields such as username or password can cause errors. Verify all mandatory fields are provided.
  • Date-time fields must be in ISO 8601 format; incorrect formatting can lead to API errors.
  • If the Change of Authorization option is enabled but network devices do not respond, verify network connectivity and ClearPass configuration for CoA or Disconnect-Request handling.

Links

Discussion