CaptivePortalProfile

Object representing a Wireless Access Captive Portal Profile which can be associated with SSID entities from which end users may be presented with instructions and condition of use when connecting to an Open wireless access point.

Overview

captivePage string required  
description string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable   locally unique  
portalType enum (CLICK_THROUGH) filterable   orderable  

API Resource

/captiveportalprofiles/id
delete get put

Parents

/enterprises/id/captiveportalprofiles
get post
/ssidconnections/id/captiveportalprofiles
get put

Children

This object has no children.

Members

This object has no members.

Attributes documentation

captivePage string required  
Discussion

Attribute having the contents of captive portal page displayed to end user. User can possibly include very basic HTML tags like

,

    etc. inorder to fomat the text displayed to the user.

    Charateristics

    Format: free
    SDK attribute: captivePage

description string
Discussion

Description for the captive portal profile.

Charateristics

Format: free
Max length: 255
SDK attribute: description

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable   locally unique  
Discussion

Name of the captive portal profile.

Charateristics

Format: free
Min length: 1
Max length: 64
SDK attribute: name

portalType enum filterable   orderable  
Discussion

Type of the portal page.

Charateristics

Allowed values: CLICK_THROUGH
Default value: CLICK_THROUGH
SDK attribute: portalType