Skip to content

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

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

Logs in to Workflow

Request

Allows the user to login for device enrollment.

Path
workflowIdstring(uuid)required
Body
required

Enrollment information to create

accessTokenstringnon-emptyrequired

Access token for login.

enrollmentIdstring(uuid)

Enrollment identifier to get access.

cpArgsobject(CaptivePortalArgs)
{
  "accessToken": "string",
  "enrollmentId": "883e2903-3e2f-407c-ae2a-1274a4137945",
  "cpArgs": {
    "ssid": "string",
    "redirectUrl": "string",
    "clientMac": "string",
    "uip": "string"
  }
}

Responses

Ok

Body
workflowIdstring(uuid)

Workflow identifier.

publishedWorkflowIdstring(uuid)

Published workflow identifier.

tokenstring

JWT token.

enrollmentobject(Enrollment)
_linksobject(Links)
Response
{
  "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
  "publishedWorkflowId": "7feabd8d-7a1a-4e4d-be72-09185241cff7",
  "token": "string",
  "enrollment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "description": "string",
    "status": "CREATED"
  },
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Enrollment File Management API

Manages enrollment action files

Operations

Workflow Configuration API

Manages workflow for an enrollment

Operations