Skip to content

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
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

Upload File

Request

Allows user to upload file.

Body
fileDetailsobject(FileUploadDto)required

Request payload for uploading enrollment action files.

fileDetails.​namestring[ 1 .. 100 ] charactersrequired

File name.

fileDetails.​typestringrequired

File type.

Enum"AUP_FILE""USER_SPLIT_OPTION_FILE"
fileToUploadstring(binary)required

File to be uploaded

{
  "fileDetails": {
    "name": "string",
    "type": "AUP_FILE"
  },
  "fileToUpload": "string"
}

Responses

Uploaded

Body*/*
namestring[ 1 .. 100 ] charactersrequired

File name.

urlstring[ 1 .. 1000 ] charactersrequired

URL for accessing the uploaded file.

typestringrequired

File type.

Enum"AUP_FILE""USER_SPLIT_OPTION_FILE"

Get Signed URL for Download

Request

Get signed URL for download.

Path
fileIdstringrequired
No request payload

Responses

Ok

Body*/*
urlstringnon-emptyrequired

Signed URL for downloading the enrollment action file.

Delete File

Request

Deletes the specified enrollment action file.

Path
fileIdstringrequired
No request payload

Responses

OK

Response
No content

Enrollment Action Type API

Manages enrollment actions for specific action types.

Operations