Skip to content
Workflow Actions/
Enrollment Action Type AP...
/
Get Enrollment Actions by...

Workflow Actions (0.0.2)

Overview

Workflow Actions APIs enable management of reusable action configurations that define steps within enrollment and onboarding workflows. These actions determine the behavior and prompts presented to users during network enrollment processes, such as authentication screens, terms acceptance, data collection forms, and certificate provisioning. Use these APIs to create, update, retrieve, and delete workflow action configurations for your organization.

Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
Languages
Servers
RUCKUS One API host for North American region.
https://api.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud

Enrollment Action API

Manages enrollment actions for workflow configuration.

Operations

Enrollment Action Files API

Manages enrollment action files.

Operations

Enrollment Action Type API

Manages enrollment actions for specific action types.

Operations

Get Enrollment Actions by Type

Request

Gets all enrollment action configurations for a specific action type.

Path
actionTypestringrequired

Action Type

Enum"AUP""DATA_PROMPT""DPSK""USER_SELECTION_SPLIT""USER_SELECTION_SPLIT_OPTION""FUNCTIONAL_SPLIT""FUNCTIONAL_SPLIT_OPTION""DISPLAY_MESSAGE""MAC_REG""CERT_TEMPLATE"
Query
sizeinteger(int32)

Number of records in a page. Will be defaulted to 20 if not specified or found invalid.

Example: size=20
pageinteger(int32)

The page to retrieve (starts at zero). Will be defaulted to 0 if not specified or found invalid

sortstring

The field names to sort with. Comma separated from the sort order (asc or desc).

Example: sort=name,description,asc
No request payload

Responses

Ok

Body
totalPagesinteger(int32)

Total number of pages available.

totalElementsinteger(int64)

Total number of items across all pages.

firstboolean

Indicates if this is the first page.

lastboolean

Indicates if this is the last page.

sizeinteger(int32)
contentArray of any

List of items for the current page.

numberinteger(int32)

Current page number starting from zero.

sortobject(SortObject)

Sorting information for ordering the results.

pageableobject(PageableObject)

Page request information including page number and size.

numberOfElementsinteger(int32)

Number of items in the current page.

emptyboolean

Indicates if the page contains no items.

Response
{
  "totalPages": 0,
  "totalElements": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    null
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "unsorted": true,
    "sorted": true
  },
  "pageable": {
    "offset": 0,
    "sort": { … },
    "unpaged": true,
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0
  },
  "numberOfElements": 0,
  "empty": true
}