API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Create a portal profile

post
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/portals/

A portal profile contains customizations to be applied to Central NAC
portals (e.g. MPSK provisioning, or captive portals)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

Unique identifier for the portal profile (must be a UUID).

Query Params
string

LOCAL - To create local objects. SHARED - To create shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be created. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be created. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

portalbody object

string
length between 0 and 255

A description, or note, for the portal profile.

string
length ≤ 9999

A custom image shown on the login page.

The UUID for this image must be a valid Central NAC image file identifier.

See the Central NAC image upload API for further details.

string
length ≤ 9999

The URL that clicking the login image should take the user to

string
required
length between 1 and 255

Unique name for the portal profile.

string
length ≤ 9999

Customization override set for this page

string
required
length ≤ 9999

Unique identifier for the portal profile (must be a UUID).

string
length ≤ 9999

An optional custom email message to send on registration.

The message type of the referenced custom message must be EMAIL.

The message purpose of the referenced custom message must be REGISTRATION.

If not set, the default custom message of type EMAIL and purpose REGISTRATION
will be used. If no default custom message is defined, the system default
registration email message will be used.

string
length ≤ 9999

An optional custom SMS message to send on registration.

The message type of the referenced custom message must be SMS.

The message purpose of the referenced custom message must be REGISTRATION.

If not set, the default custom message of type SMS and purpose REGISTRATION
will be used. If no default custom message is defined, the system default
registration SMS message will be used.

boolean
Defaults to false

Require the user to accept the terms and conditions of login page

string
length ≤ 9999

The skin for this portal

string
length ≤ 9999

An optional custom email message to send when requesting sponsor approval.

The message type of the referenced custom message must be EMAIL.

The message purpose of the referenced custom message must be SPONSOR_APPROVAL.

If not set, the default custom message of type EMAIL and purpose
SPONSOR_APPROVAL will be used. If no default custom message is defined, the
system default sponsor approval email message will be used.

string
enum
Defaults to INTERNAL

Where the terms and conditions should be displayed

Show Details
EXTERNALDisplay terms and conditions on a separate page, accessible via a link
INTERNALDisplay terms and conditions inline on the sign-in page
Allowed:
string
length ≤ 9999

An optional custom SMS message to send for verification.

The message type of the referenced custom message must be SMS.

The message purpose of the referenced custom message must be VERIFICATION_CODE.

If not set, the default custom message of type SMS and purpose VERIFICATION_CODE
will be used. If no default custom message is defined, the system default
verification code SMS message will be used.

string
length ≤ 9999

An optional custom email message to send for verification.

The message type of the referenced custom message must be EMAIL.

The message purpose of the referenced custom message must be VERIFICATION_LINK.

If not set, the default custom message of type EMAIL and purpose
VERIFICATION_LINK will be used. If no default custom message is defined, the
system default verification link email message will be used.

Responses

Updated 11 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago