Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Guest Users → Replace

AI-generated

Overview

This node interacts with the Aruba ClearPass API to replace (update fully) a guest user account within the Identities domain. It is useful for scenarios where you need to update all details of a guest user, such as password, role, sponsor information, account state, and timing details. For example, it can be used to update a guest user's password and expiration time in a network access management system.

Use Case Examples

  1. Updating a guest user's password and role when their access requirements change.
  2. Replacing a guest user's sponsor information and account state after a policy update.

Properties

Name Meaning
Domain API domain to access, fixed to 'Identities' for this operation.
Guest User ID Numeric ID of the guest account to replace.
Password Password for the guest account.
Role ID Role ID to assign to the account, typically the Guest role.
Sponsor Name Name of the sponsor of the account.
Sponsor Profile Profile of the sponsor of the account.
Account State Whether the account is enabled or disabled.
Start Time Time at which the account will be enabled (ISO 8601 format).
Expire Time Time at which the account will expire (ISO 8601 format).
Additional Fields Optional additional fields such as email, MAC address, notes, simultaneous use, 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

  • id - ID of the replaced guest user account.
  • password - Password of the guest user account.
  • roleId - Role ID assigned to the guest user.
  • sponsorName - Name of the sponsor of the guest user.
  • sponsorProfile - Profile of the sponsor of the guest user.
  • enabled - Account enabled state.
  • startTime - Account start time in ISO 8601 format.
  • expireTime - Account expiration time in ISO 8601 format.
  • 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.
    • simultaneous_use - Number of simultaneous sessions allowed.
    • do_expire - Action to take when the account expires.
    • sponsor_email - Email address of the sponsor.
    • 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.

Dependencies

  • Aruba ClearPass API with appropriate API key credentials

Troubleshooting

  • Common issues include invalid guest user ID, missing required fields like password or role ID, and incorrect date-time formats for startTime and expireTime.
  • Error messages may indicate authentication failures if API credentials are incorrect or missing.
  • Network errors or API endpoint issues may cause operation failures; verify API domain and resource settings.
  • If 'Change of Authorization' is enabled but network state update fails, check network connectivity and ClearPass server logs.

Links

Discussion