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
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
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
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.
This example uses the following URI:
https://Jeff245.cloudpath.net/admin/publicApi/registrationLists
where https://Jeff245.cloudpath.net/admin/publicApi is the root URI of the Cloudpath system being used (must include https, as shown).
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 |
No request body is needed.
Use the GET action to send the request.Once the request is sent, you will receive a "Status: 200 OK" if the GET is successful.
{
"page": {
"page": 1,
"pageSize": 1,
"totalCount": 1
},
"contents": [
{
"guid": "WorkflowRegistration-22510ec0-8f5e-435a-8765-7ce3d643e3fe",
"name": "MAC Registration-8",
"description": "",
"sequence": 1,
"ssidRegex": "",
"expirationDateRule": {
"type": "DAYS_AFTER_TIME",
"offset": 1
},
"behavior": "ALWAYS_PROMPT",
"promptInfo": {
"title": "",
"promptText": "",
"macAddressLabel": "",
"helpLinkCaption": "",
"helpLinkUrl": "",
"continueButtonLabel": "",
"invalidMacErrorMessage": ""
},
"autoCleanup": false,
"supportsPolicies": true,
"defaultAccess": "ACCEPT",
"links": [
{
"rel": "self",
"href": "https://jeff245.cloudpath.net/admin/publicApi/registrationLists/WorkflowRegistration-22510ec0-8f5e-435a-8765-7ce3d643e3fe",
"hreflang": null,
"media": null,
"title": null,
"type": null,
"deprecation": null
},
{
"rel": "macRegistrations",
"href": "https://jeff245.cloudpath.net/admin/publicApi/registrationLists/WorkflowRegistration-22510ec0-8f5e-435a-8765-7ce3d643e3fe/macRegistrations?page=1&pageSize=10{&filter,orderBy}",
"hreflang": null,
"media": null,
"title": null,
"type": null,
"deprecation": null
},
{
"rel": "policies",
"href": "https://jeff245.cloudpath.net/admin/publicApi/registrationLists/WorkflowRegistration-22510ec0-8f5e-435a-8765-7ce3d643e3fe/policies?page=1&pageSize=100{&filter,orderBy}",
"hreflang": null,
"media": null,
"title": null,
"type": null,
"deprecation": null
}
]
}
]
}
Example of Using GET to Obtain RADIUS Attribute Group assigned to MAC Registration list on a RADIUS Reject
This example uses the following URI:
https://Jeff245.cloudpath.net/admin/publicApi/registrationLists/WorkflowRegistration-22510ec0-8f5e-435a-8765-7ce3d643e3fe/rejectAttributeGroup
- https://Jeff245.cloudpath.net/admin/publicApi is the root URI of the Cloudpath system being used (must include https, as shown).
- WorkflowRegistration-22510ec0-8f5e-435a-8765-7ce3d643e3fe is the ID of the MAC registration list
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 |
No request body is needed.
Use the GET action to send the request.Once the request is sent, you will receive a "Status: 200 OK" if the GET is successful.
{
"guid": "4",
"name": "Assign_upon_failure",
"description": "",
"vlanid": "",
"filterid": "",
"classid": "",
"sessionTimeout": "",
"policyCount": 0,
"additionalAttributes": [
{
"name": "Reply-Message",
"action": "ADD",
"value": "${ASSISTANCE_ID}"
},
{
"name": "Acct-Session-Id",
"action": "ADD_MULTIPLE",
"value": ""
},
{
"name": "Acct-Session-Id",
"action": "ADD_MULTIPLE",
"value": ""
}
],
"links": [
{
"rel": "self",
"href": "https://jeff245.cloudpath.net/admin/publicApi/radiusAttributeGroups/4",
"hreflang": null,
"media": null,
"title": null,
"type": null,
"deprecation": null
}
]
}