Skip to content
Assign Registration Pool...
/
Create Pool with Identity...

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

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

Create Pool with Identity Group

Request

Create a registration pool with the identity group.

Path
identityGroupIdstringrequired

The identity group to create

Body
required
idstring(uuid)

The unique identifier for this pool.

namestring[ 0 .. 255 ] charactersrequired

The unique reference name of the pool.

descriptionstring[ 0 .. 255 ] characters

A description of the pool.

autoCleanupboolean

A toggle determining whether MAC registrations that are 24 hours past the expiration time will be automatically removed from the pool.

Default true
expirationTypestring

Defines the rule for expiration date calculation.

Enum"SPECIFIED_DATE""MINUTES_AFTER_TIME""HOURS_AFTER_TIME""DAYS_AFTER_TIME""WEEKS_AFTER_TIME""MONTHS_AFTER_TIME""QUARTERS_AFTER_TIME""YEARS_AFTER_TIME""END_OF_HOUR""END_OF_DAY"
expirationOffsetinteger(int32)

If the expiration type is not specified_date then this field is the offset amount.

expirationDatestring(date-time)

If the expiration type is specified_date then this field is the related date.

ssidRegexstring[ 0 .. 255 ] characters

A regex to determine which SSIDs this registration pool will allows access to.

expirationEnabledboolean

If the expiration setting is enabled for new MAC registration.

Default false
registrationCountinteger(int32)

Number of registrations in the pool.

defaultAccessstring

The type of default access.

Default "ACCEPT"
Enum"ACCEPT""REJECT"
createdDatestring(date-time)

The created date of this pool.

policySetIdstring

The policy set of this pool.

isReferencedboolean

This pool is referenced by an identity group and cannot be deleted.

networkCountinteger(int32)

Number of networks associated with this pool.

identityGroupIdstring

The identity group of this pool.

identityIdstring

The single identity policy of this pool.

_linksobject(Links)
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "autoCleanup": true,
  "expirationType": "SPECIFIED_DATE",
  "expirationOffset": 0,
  "expirationDate": "2019-08-24T14:15:22Z",
  "ssidRegex": "string",
  "expirationEnabled": false,
  "registrationCount": 0,
  "defaultAccess": "ACCEPT",
  "createdDate": "2019-08-24T14:15:22Z",
  "policySetId": "string",
  "isReferenced": true,
  "networkCount": 0,
  "identityGroupId": "string",
  "identityId": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

The registration pool create request is in progress

Body
requestIdstringrequired

The request id.

idstring

Only present for the create operation.

Response
{
  "requestId": "string",
  "id": "string"
}

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