Registration Lists

You can use REST API v2 calls to obtain information about existing registration lists

The following table lists the properties that can be used in the body of a registration lists-related request and/or are provided in the response body. (In the "Optional" column, if a default value is applicable, it is listed in angle brackets (< >)).

Resource: RegistrationList

Property Name Type Editable Filter/Sort Optional in Request/Response Body? Description
guid String No Neither Optional on create only, but not on any subsequent uses The unique identifier for this list.
name String No Neither No The unique reference name for the list.
description String No Neither Yes A description for this list.
sequence
new for 5.8
 Integer No filter and orderBy (like only) No The sequence of the list, which determines the order in which a MAC registration gets evaluated by RADIUS. A MAC Registration list with a lower number is checked before one with a higher number.
ssidRegex String No Neither Yes A regex to determine which SSIDs can access this registration list.
expirationDateRule <Object> No Neither Yes The object containing the attributes that describe the registration validity date. See the "Resource: expirationDateRule" table below.
behavior String <Enum> No Neither Yes An enum describing the behavior of the plugin. Possible options are:
  • PROMPT_WHEN_NO_MAC
  • ALWAYS_PROMPT
  • REDIRECT_WHEN_NO_MAC
  • ALWAYS_REDIRECT
  • DO_NOTHING_WHEN_NO_MAC
redirectInfo Object No Neither default <null> If the "behavior" property is either REDIRECT_WHEN_NO_MAC or ALWAYS_REDIRECT, then this object provides the additional details for the redirect. See the "Resource: redirectInfo" table below.
promptInfo Object No Neither default <null> If the "behavior" property is either PROMPT_WHEN_NO_MAC or ALWAYS_PROMPT, then this object provides the additional details for the prompt. See the "Resource: promptInfo" table below.
autoCleanup boolean No Neither default <false> A boolean value that determines if MAC registrations that are 24 hours past the expirationDateRule will be automatically removed from the list.
link Link No No Yes This includes the following two href links:
  • self: a self-referencing link
  • A linked list of child macRegistrations
.

Resource: redirectInfo

Property Name Type Editable Filter/Sort Optional in Request/Response Body? Description
redirectUrl String No Neither Yes The URL where the user is redirected.
usePost Boolean No Neither Yes (default is false) If the value is set to true, a POST will be used for the redirect; if the value is set to false, a GET will be used.
postParameters List <string> No Neither Yes If the value of the "usePost" poperty is true, this contains a list of string POST parameters that are supplied with the redirect request. The parameters are provided in the format: key=value
allowContinuation Boolean No Neither Yes (default is true) If true, the submit-redirect call is processed; if false, the submit-redirect call is ignored.
killSession Boolean No Neither Yes (default is false) If true, the user's session ends and they are redirected. If they return, they are forced to start over.

Resource: promptInfo

Property Name Type Editable Filter/Sort Optional in Request/Response Body? Description
title String No Neither Yes The title of the prompt content.
promptText String No Neither Yes The message that appears in the prompt.
macAddressLabel String No Neither Yes The label next to the MAC address text box.
helpLinkCaption String No Neither Yes The text used as the help link.
helpLinkUrl String No Neither Yes The URL for the help link.
continueButtonLabel String No Neither Yes The label displayed on the Continue button.
invalidMacErrorMessage String No Neither Yes The error message displayed to the user if the MAC address is not properly formatted.

Resource: expirationDateRule

Property Name Type Editable Filter/Sort Optional in Request/Response Body? Description
type String <Enum> No Neither Yes The type of expiration date rule. The full expiration date rule is determined by paring the type with either an offset or date. Possible options are:
  • SPECIFIED_DATE
  • MINUTES_AFTER_TIME
  • HOURS_AFTER_TIME
  • DAYS_AFTER_TIME
  • WEEKS_AFTER_TIME
  • MONTHS_AFTER_TIME
  • QUARTERS_AFTER_TIME
  • YEARS_AFTER_TIME
  • END_OF_HOUR
  • END_OF_DAY
  • END_OF_WEEK
  • END_OF_MONTH
  • END_OF_QUARTER
  • END_OF_HALF
  • END_OF_YEAR
date String <date> No Neither Yes If the "type" property is SPECIFIED_DATE, then this field is the related date in the format of: YYYY-MM-DD
offSet integer No Neither Yes If the "type" property is not SPECIFIED_DATE, then this field is the offset amount

Registration Lists URIs and Actions

The following table indicates the URIs that you can append to the root URI, along with the actions you can take, and possible return codes you can receive.

Registration Lists URIs and Actions

URI Action Description Return Codes
/registrationLists/ GET Returns all MAC registration lists.

401 - Unauthorized

200 - OK

/registrationLists/{listGuid} GET Returns a specific MAC registration list.

404 - Not Found

401 - Unauthorized

200 - OK

Example of Using GET to Obtain All Registration Lists

This example demonstrates how to obtain all registration lists in your Cloudpath system by using the REST API GET call.

URI:

This example uses the following URI: 

 https://Jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/registrationLists

where:

  • https://Jeff243.cloudpath.net/admin/apiv2 is the root URI of the Cloudpath system being used (must include https, as shown)
  • 5XcTc6SjkHDL is an example of an API key generated from the Configuration > API Keys section of the Cloudpath UI

Request Headers:

The following table shows the required request headers for this URI example, with an example value of an active token that must be pasted into the Authorization header value:

Request Headers

Key Value
Content-type application/json
Authorization eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqZWZmLnJob2RpZUBjb21tc2NvcGUuY29tIiwicm9sZVBrIjoiMjEwMDAiLCJhY2NvdW50QWRtaW5QayI6IjIiLCJhcGlLZXkiOiJaV2NjTGpQZUdZMGUiLCJpYXQiOjE1NzU1NzUxNTcsImV4cCI6MTU3NTU3NTQ1N30.2q4KTyDUevkAAz7mJyp529Be1-ip3EC8P06Xarmz5ao

Request Body:

No request body is needed.

Action:

Use the GET action to send the request.

Response Body:

Once the request is sent, you will receive a "Status: 200 OK" if the GET is successful.

added "Sequence" to the Response body example below for 5.8

{
    "page": {
        "page": 1,
        "pageSize": 2,
        "totalCount": 2
    },
    "contents": [
        {
            "guid": "WorkflowRegistration-2de79119-f1da-4b7e-84b8-b0482911cae1",
            "name": "Mac reg 12",
            "description": "",
            "sequence": 1,
            "ssidRegex": "ssid12",
            "expirationDateRule": {
                "type": "DAYS_AFTER_TIME",
                "offset": 1
            },
            "behavior": "ALWAYS_REDIRECT",
            "redirectInfo": {
                "redirectUrl": "https://wlan.cloudpath.net",
                "usePost": true,
                "postParameters": [
                    "username=bob"
                ],
                "allowContinuation": true,
                "killSession": false
            },
            "autoCleanup": false,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/registrationLists/WorkflowRegistration-2de79119-f1da-4b7e-84b8-b0482911cae1",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "macRegistrations",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/registrationLists/WorkflowRegistration-2de79119-f1da-4b7e-84b8-b0482911cae1/macRegistrations?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "WorkflowRegistration-3802eb98-7c97-4949-80b4-6ec9901e1a4a",
            "name": "Mac reg 13",
            "description": "",
            "sequence": 2,
            "ssidRegex": "ssid13",
            "expirationDateRule": {
                "type": "DAYS_AFTER_TIME",
                "offset": 1
            },
            "behavior": "ALWAYS_REDIRECT",
            "redirectInfo": {
                "redirectUrl": "https://cloudpath.com.net",
                "usePost": false,
                "allowContinuation": true,
                "killSession": false
            },
            "autoCleanup": false,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/registrationLists/WorkflowRegistration-3802eb98-7c97-4949-80b4-6ec9901e1a4a",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "macRegistrations",
                    "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/registrationLists/WorkflowRegistration-3802eb98-7c97-4949-80b4-6ec9901e1a4a/macRegistrations?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        }
    ]
}

Parent topic: Core Cloudpath APIs