Admin Enrollment REST API (0.0.1)

Overview

The Admin Enrollment REST API provides administrative capabilities for managing and monitoring user enrollments and device registrations within RUCKUS One platform. These APIs enable administrators to query enrollment records, view registration details, and track enrollment activities across the organization. Use these endpoints to retrieve enrollment information, search registrations by various criteria, and monitor the overall enrollment workflow status.

Download OpenAPI description

Download PDF

Overview

License

RUCKUS Cloud Privacy Policy

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

Admin Enrollment Registration API

Manages enrollment registration admin views.

Operations

Query Enrollment Registrations

Request

Gets the list of enrollment registrations using the specified query.

Body

Search criteria and pagination details

sortDirectionstring

Sort direction for ordering query results in ascending or descending order.

Enum"ASC""DESC"

pageinteger(int32)

Page number. If not specified the first page will be returned.

pageSizeinteger(int32)

Number of records in a page.If not specified default page size of 20 will be applied.

workflowIdstring(uuid)

Identifier of the workflow.

enrollmentIdstring(uuid)

Identifier of the enrollment.

descriptionstring[ 0 .. 1000 ] characters

Description of the enrollment.

macAddressstring^([0-9A-Fa-f]{2}-){5}([0-9A-Fa-f]{2})$|^([0-9...

Mac address of the enrolled device.

ipAddressstring(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25...

Network address of the enrolled device.

statusstring

Enrollment status.

Enum"CREATED""STARTED""FINISHED""ABANDONED""ACTIVE""INACTIVE""REVOKED"

sortFieldsArray of strings

List of field names used to sort the enrollment query results.

{
  "sortDirection": "ASC",
  "page": 0,
  "pageSize": 0,
  "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
  "enrollmentId": "883e2903-3e2f-407c-ae2a-1274a4137945",
  "description": "string",
  "macAddress": "string",
  "ipAddress": "string",
  "status": "CREATED",
  "sortFields": "workflowId"
}

Responses

Body

totalElementsinteger(int64)

Total number of enrollment registration elements across all pages.

totalPagesinteger(int32)

Total number of pages available in the paginated result set.

pageableobject(PageableObject)

Pagination information including page number, size, and sort details.

firstboolean

Indicates whether this is the first page in the paginated result set.

lastboolean

Indicates whether this is the last page in the paginated result set.

sizeinteger(int32)

contentArray of objects(EntityModelEnrollmentRegistrationDto)

List of enrollment registration items on the current page.

numberinteger(int32)

Current page number (zero indexed).

sortobject(SortObject)

Sorting information object containing sort order and field details.

numberOfElementsinteger(int32)

Number of elements on the current page.

emptyboolean

Indicates whether the current page contains any elements.

Response

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "paged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": { … },
    "unpaged": true
  },
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    { … }
  ],
  "number": 0,
  "sort": {
    "sorted": true,
    "empty": true,
    "unsorted": true
  },
  "numberOfElements": 0,
  "empty": true
}

Get Registration Details

Request

Gets enrollment registration details for the requested enrollment registration identifier.

Path

enrollmentRegistrationIdstringnon-emptyrequired

Enrollment Registration Id

No request payload

Responses

Body

registrationIdstring(uuid)

Identifier of the new enrollment registration.

enrollmentIdstring(uuid)

Identifier of the new enrollment.

statusstring

Enrollment Status.

Enum"CREATED""STARTED""FINISHED""ABANDONED""ACTIVE""INACTIVE""REVOKED"

macAddressstring

MAC address of the device associated with this enrollment registration.

workflowIdstring(uuid)

Identifier of the workflow.

authenticationobject(AuthenticationDto)

Authentication information including service type, identity, group, and network details.

revocationobject(RevocationDto)

Revocation information including date, reason, and user who revoked the enrollment.

_linksobject(Links)

Response

{
  "registrationId": "cb67e1cd-0e53-4115-9a51-243e5b471e8b",
  "enrollmentId": "883e2903-3e2f-407c-ae2a-1274a4137945",
  "status": "CREATED",
  "macAddress": "string",
  "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
  "authentication": {
    "authType": "string",
    "identity": "string",
    "groupId": "string",
    "networkId": "string"
  },
  "revocation": {
    "revokedDate": "2019-08-24T14:15:22Z",
    "revokedReason": "string",
    "revokedBy": "string"
  },
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Admin Enrollment API

Manages enrollment admin views.

Operations