Skip to content

MAC Registration (UNKNOWN)

Overview

The MAC Registration REST APIs and Model, allow the creation, deletion, and modification of MAC registration list, and MAC registrations.

What This API Does

  • Create, modify, and delete MAC registration list and MAC registrations

Error Handling

The API uses standard HTTP status codes with detailed error messages in the response body.

Common Error Responses

All endpoints may return these common error responses:

  • 400 Bad Request: Invalid input data or validation errors
  • 401 Unauthorized: Missing or invalid authentication
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Requested resource doesn't exist
  • 409 Conflict: Resource conflict (e.g., duplicate names)
  • 422 Unprocessable Entity: Business rule violations
  • 500 Internal Server Error: Unexpected server errors
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/

MAC Registration

Operations for managing MAC address registrations within registration pools. MAC registrations allow devices to be authenticated and granted network access based on their MAC address.

Operations

Search MAC Registrations by Criteria

Request

Search the MAC registrations by the criteria.

Path
poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27
Query
pageinteger>= 0

Page index starting from 0 (0..N)

Default 0
sizeinteger>= 1

The size of the page to be returned

Default 20
sortArray of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Body
required
searchCriteriaListArray of objects(SearchCriteria)

The list of search criteria.

dataOptionstring

The data option.

Example: "ALL"
{
  "searchCriteriaList": [
    { … }
  ],
  "dataOption": "ALL"
}

Responses

Registrations

Body
totalElementsinteger(int64)

The total number of elements in the result set.

totalPagesinteger(int32)

The total number of pages in the result set.

sizeinteger(int32)
contentArray of objects(Registration)

The list of registration items.

numberinteger(int32)

The current page number.

sortobject(SortObject)

Sorting information for a page request. Contains details about the field(s) to sort by and the sort direction (ascending or descending).

pageableobject(PageableObject)

The pagination metadata.

firstboolean

Indicates whether the current page is the first page.

lastboolean

Indicates whether the current page is the last page.

numberOfElementsinteger(int32)

The number of elements on the current page.

emptyboolean

Indicates whether the result set is empty.

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

List MAC Registrations in Pool

Request

List the MAC registrations in the registration pool.

Path
poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27
Query
pageinteger>= 0

Page index starting from 0 (0..N)

Default 0
sizeinteger>= 1

The size of the page to be returned

Default 20
sortArray of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

No request payload

Responses

Registrations

Body
totalElementsinteger(int64)

The total number of elements in the result set.

totalPagesinteger(int32)

The total number of pages in the result set.

sizeinteger(int32)
contentArray of objects(Registration)

The list of registration items.

numberinteger(int32)

The current page number.

sortobject(SortObject)

Sorting information for a page request. Contains details about the field(s) to sort by and the sort direction (ascending or descending).

pageableobject(PageableObject)

The pagination metadata.

firstboolean

Indicates whether the current page is the first page.

lastboolean

Indicates whether the current page is the last page.

numberOfElementsinteger(int32)

The number of elements on the current page.

emptyboolean

Indicates whether the result set is empty.

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

Returns the Specific MAC Registration

Request

Return the specific MAC registration.

Path
idstring(uuid)required

MAC registration id

Example: 28529868-9db0-4361-ba20-4d35fb402bc2
poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27
No request payload

Responses

MAC registration

Body
idstring(uuid)

The unique identifier for this MAC registration.

expirationDatestring(date-time)

Indicates when this registration expires. Will derive from the pool setting if not specified.

revokedbooleanrequired

If this MAC registration is revoked or not.

macAddressstringnon-empty^([0-9A-F]{2}:){5}([0-9A-F]{2})$required

The mac address for this registration. Must be provided on post, and may not be changed.

usernamestring[ 0 .. 255 ] characters

A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

emailstring[ 0 .. 255 ] characters^(?:[\w!#$%&’*+/=?`{|}~^-]+(?:\.[\w!#$%&’*+/=...

The email to associate with this device.

Example: "dev@commscope.com"
locationstring[ 0 .. 255 ] characters

The location of this device.

deviceNamestring[ 0 .. 255 ] characters

Device name

createdDatestring(date-time)

The created date of this device.

isReferencedboolean

This registration is referenced by an identity and cannot be deleted.

_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "expirationDate": "2019-08-24T14:15:22Z",
  "revoked": true,
  "macAddress": "string",
  "username": "string",
  "email": "dev@commscope.com",
  "location": "string",
  "deviceName": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "isReferenced": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Registration Pool

Operations for managing registration pools. Registration pools are containers that hold MAC address registrations and define access policies for devices.

Operations

Assign Registration Pool Identity Group

Operations for associating registration pools with identity groups. Registration pools can be associated with identity groups to control which devices can access the pools.

Operations

Wifi Network

Operations for managing WiFi network associations with registration pools. Networks can be associated with pools to control which networks devices can access.

Operations