Aruba ClearPass icon

Aruba ClearPass

Interact with Aruba ClearPass API

Actions34

Guest Users → Create

AI-generated

Overview

This node interacts with the Aruba ClearPass API to create a guest user account within the Identities domain. It is useful for automating the provisioning of guest accounts in network access management scenarios, such as granting temporary network access to visitors or contractors.

Use Case Examples

  1. Automatically create guest user accounts with specified username, password, role, and sponsor details.
  2. Set account activation and expiration times to control guest access duration.
  3. Include additional optional information like email, MAC address, and custom fields for enhanced guest user management.

Properties

Name Meaning
Domain API domain to access, fixed to 'Identities' for guest user operations.
Username Username of the guest account to be created.
Password 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 responsible for the guest account.
Sponsor Profile Profile of the sponsor of the guest account.
Account State Boolean flag indicating whether the guest account is enabled.
Start Time ISO 8601 formatted time when the guest account becomes active.
Expire Time ISO 8601 formatted time when the guest account expires.
Additional Fields Optional additional information such as email, MAC address, notes, simultaneous use sessions, sponsor email, visitor details, and custom JSON fields.
Change of Authorization Flag to update network state using Disconnect-Request or CoA-Request when account changes occur.

Output

JSON

  • id - Unique identifier of the created guest user account.
  • username - Username of the created guest user.
  • roleId - Role ID assigned to the guest user.
  • sponsorName - Name of the sponsor for the guest user.
  • enabled - Account enabled state.
  • startTime - Account activation time.
  • expireTime - Account expiration time.
  • email - Email address associated with the guest user.
  • mac - MAC address of the guest's device.
  • notes - Additional notes or comments for the guest user.
  • simultaneous_use - Number of simultaneous sessions allowed.
  • do_expire - Action to take upon expiration.
  • sponsor_email - Sponsor's email address.
  • visitor_name - Full name of the guest visitor.
  • visitor_company - Company name of the guest visitor.
  • visitor_phone - Contact phone number of the guest visitor.
  • customFields - Custom JSON fields associated with the guest user.

Dependencies

  • Aruba ClearPass API credentials required for authentication.

Troubleshooting

  • Common issues include authentication failures due to invalid API credentials or insufficient permissions.
  • Errors may occur if required fields like username, password, or role ID are missing or invalid.
  • Date-time fields must be in ISO 8601 format; incorrect formatting can cause API errors.
  • Network connectivity issues to the Aruba ClearPass API endpoint can cause execution failures.

Links

Discussion