Skip to content
/
Workflow Configuration AP...

Device Enrollment REST API (0.0.1)

Overview

The Device Enrollment REST API enables end users to enroll their devices through a guided workflow process in RUCKUS One platform. These APIs orchestrate the device onboarding experience by executing sequential enrollment steps including authentication, device registration, and network provisioning. Use these endpoints to initiate enrollment workflows, progress through enrollment steps, and retrieve enrollment status and credentials.

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

Workflow Login API

Manages workflow token for enrollment.

Operations

Device Enrollment API

Manages enrollments for a device.

Operations

Certificate Download API

Manages certificate downloads for device enrollment.

Operations

Enrollment File Management API

Manages enrollment action files.

Operations

Workflow Step API

Manages workflow enrollment step.

Operations

Workflow Configuration API

Manages workflow for an enrollment.

Operations

Gets Workflow Configuration

Request

Allows the user to fetch workflow configuration.

Path
workflowIdstring(uuid)required
No request payload

Responses

OK

Body
idstring(uuid)

Identifier of the workflow.

namestring

Name of the workflow.

colorobject(RedisColorSchema)

Color configuration settings for the workflow interface.

stylesobject(StyleSchema)

Style configuration settings for the workflow interface.

startStepIdstring(uuid)

Unique identifier for the initial step where the enrollment workflow begins.

firstActionStepIdstring(uuid)

Unique identifier for the first step that requires user action or input.

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "color": {
    "backgroundColor": "string",
    "lineColor": "string",
    "fontColor": "string",
    "fontHeaderColor": "string",
    "headerBackgroundColor": "string",
    "startOverFontColor": "string",
    "buttonColor": "string",
    "buttonFontColor": "string"
  },
  "styles": {
    "welcomeTitle": "string",
    "welcomeSubTitle": "string",
    "logoImage": "string",
    "backgroundImage": "string",
    "iconImage": "string",
    "fontName": "string",
    "wifi4EuNetworkId": "string",
    "logoSize": "string",
    "disablePoweredBy": true,
    "headerFontSize": 0
  },
  "startStepId": "89855da9-7928-4250-8ea0-cf0707fcc260",
  "firstActionStepId": "de1a3af3-8d3a-471f-b1d9-2b7490d0aed0"
}