Skip to content
/
Gets the Workflow Step

Device Enrollment REST API (0.0.1)

Overview

These APIs facilitate enrolling users devices by going thorough different enrollment steps in the workflow.

RateLimit

For the Device enrollment REST APIs the following will be true: Limits are applied to each workflow. A maximum of 60 calls can be made per second. Each second 30 calls will be returned to be used.

Download OpenAPI description
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Languages
Servers
Generated server url

http://localhost:8080/

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)
configobject(StepConfig)
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

Step information to update

One of:
actionTypestring
acceptAupboolean
"string"

Responses

Accepted

Body
requestIdstring
idstring
_linksobject(Links)
Response
{
  "requestId": "string",
  "id": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

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)
configobject(StepConfig)
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": [ … ]
  }
}

Device Enrollment API

Manages enrollments for a device

Operations

Certificate Download API

Manages certificate downloads

Operations

Workflow Login API

Manages workflow token for enrollment

Operations

Enrollment File Management API

Manages enrollment action files

Operations

Workflow Configuration API

Manages workflow for an enrollment

Operations