How does this app work?
You can depend on the simplicity of Envoy with the Aruba Central app. With the option to customize your work flow, Envoy will create credentials in Aruba Central for your location when visitors sign in.
PREREQUISTES:
You must be an admin in order to set up this integration.
In order to send Aruba credentials to your visitors, you must use a sign-in flow that captures an email or a phone number
Splash pages must be configured according to the criteria listed in this article. If the splash page is not configured correctly, you will not be able to select splash pages during setup.
Enabling the Aruba Central app in Envoy
Splash Page Requirements:
Create a splash page in Aruba Central under “Guests" → "Splash Pages”
Splash pages must meet the following criteria:
The type must be set to “Authenticated”
“Username/Password” must be toggled on
Self-registration must be toggled off
Choose “Session Timeout” (defaults to 8 hours)
Step 2 and 3 can be set to your preferences!
Aruba Central + Envoy Configuration
This app is configured per location. If using multiple locations, then the app must be installed at each location.
Navigate to Apps on the Envoy Dashboard and install Aruba Central
Step 1: About
Authorize the app and proceed to step 2 when ready.
Step 2: API Access
Base URL: Envoy needs to know where to send information when we're creating credentials in Aruba Central.
The Base URL can be found in Aruba Central from the Account Home → Organization → API Gateway → APIs. This section will show API urls listed in "All Published APIs". If there is more than one, you can copy and paste either of the URLs into the Base URL field.
Aruba Username:
Enter your admin username
Aruba Password:
Enter your admin password
Aruba Customer ID:
Enter your Customer ID. The Customer ID is found by clicking the person (profile) icon in the top right corner Aruba central web portal.
API Client ID and API Client Secret
This can be found in Account Home → Organization → API Gateway → My Apps & Tokens. You may need to add a new token.
Step 3: Splash Pages
Select your desired splash page from the drop-down of splash pages.
If you see your splash page but cannot select it then this indicates the splash page does not conform to our requirements. You can revisit our "Requirements" section in this article for more information.
Step 4: Visitors
Access Duration:
Select a default access duration from the drop-down for Wifi credentials issued for this integration
Default Access Map:
Select the default Aruba access type (Splash Page) to issue to Visitors. Use next section for custom mapping to flow.
Aruba Guest Account to Envoy Flow
This step is optional and will allow you to exempt individual flows from the default Aruba access type or completely exempt from access to Aruba central.
Select the Visitor Types which should receive WiFi credentials upon sign-in / or invite
Select one or multiple visitor flows to receive credentials.
Anonymize Aruba Central username for Envoy visitors
Check this box to anonymize and hide the Aruba Central username for Envoy Visitors
Restrict WiFi access to only visitors which were invited
Wifi access will only be granted if there is an invite created for the Visitor if this box is checked.
Expire WiFi credentials upon sign-out from Envoy.
Wifi credentials will not work after the visitor is signed out if this box is checked.
Credentials generated by Envoy will follow this format, based on the visitor information and configuration set up in Envoy:
Credentials viewed in Aruba Central:
Credentials viewed in Envoy:
