Skip to content
Device Enrollment REST AP...
/Workflow Login API/
Logs in to Workflow

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

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

Authentication token required for accessing the enrollment workflow.

enrollmentIdstring(uuid)

Unique identifier for an existing enrollment, or leave empty to create a new enrollment.

cpArgsobject(CaptivePortalArgs)

Captive portal arguments for device authentication.

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

Responses

Ok

Body
workflowIdstring(uuid)

Unique identifier for the workflow configuration.

publishedWorkflowIdstring(uuid)

Unique identifier for the active workflow version being used for enrollment.

tokenstring

Authentication token for accessing enrollment resources.

enrollmentobject(Enrollment)

Enrollment information associated with the token.

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

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