Skip to content
Device Enrollment REST AP...
/
/
Updates a Workflow Step

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

Gets the Workflow Step

Request

Allows the user to fetch workflow step for the enrollment.

Path
workflowIdstring(uuid)required
stepIdstring(uuid)required
Query
navstring

Navigation parameter value

Enum"""next""prev"
No request payload

Responses

OK

Body
stepobject(EnrollmentStep)

Current enrollment step data including status and collected input.

configobject(StepConfig)

Configuration details for the workflow step including available actions.

Response
{
  "step": {
    "actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0",
    "status": "IN_PROGRESS",
    "failureReason": "string",
    "variables": { … },
    "execution": null,
    "input": { … }
  },
  "config": {
    "stepId": "50e29fb7-490e-4a88-b2f4-2fde4d70423d",
    "stepType": "string",
    "actionType": "string",
    "actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0",
    "actionConfiguration": "string",
    "options": { … },
    "optionName": "string",
    "providedEnrollmentVariables": [ … ],
    "requiredEnrollmentVariables": [ … ]
  }
}

Updates a Workflow Step

Request

Allows the user to update a workflow step for the enrollment.

Path
workflowIdstring(uuid)required
stepIdstring(uuid)required
Body
One of:

Input object for acceptable use policy action step.

actionTypestring

Type identifier for the action being performed.

acceptAupboolean

Indicates whether the user has agreed to the terms and conditions of the acceptable use policy.

{
  "actionType": "string",
  "acceptAup": true
}

Responses

Accepted

Body
requestIdstring

Request identifier for tracking and debugging purposes.

idstring
Response
{
  "requestId": "string",
  "id": "string"
}

Gets the Current Workflow Step

Request

Allows the user to fetch the current step for the enrollment.

Path
workflowIdstring(uuid)required
No request payload

Responses

OK

Body
stepobject(EnrollmentStep)

Current enrollment step data including status and collected input.

configobject(StepConfig)

Configuration details for the workflow step including available actions.

Response
{
  "step": {
    "actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0",
    "status": "IN_PROGRESS",
    "failureReason": "string",
    "variables": { … },
    "execution": null,
    "input": { … }
  },
  "config": {
    "stepId": "50e29fb7-490e-4a88-b2f4-2fde4d70423d",
    "stepType": "string",
    "actionType": "string",
    "actionId": "4a2794ff-94cb-4bac-8d36-d5fb36c563a0",
    "actionConfiguration": "string",
    "options": { … },
    "optionName": "string",
    "providedEnrollmentVariables": [ … ],
    "requiredEnrollmentVariables": [ … ]
  }
}

Workflow Configuration API

Manages workflow for an enrollment.

Operations