# MAC Registration

# 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

Version: UNKNOWN
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
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[MAC Registration](https://docs.ruckus.cloud/_bundle/api/mac-registration-0.0.1.yaml)

## 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.

### Search MAC Registrations by Criteria

 - [POST /macRegistrationPools/{poolId}/registrations/query](https://docs.ruckus.cloud/api/mac-registration-0.0.1/mac-registration/searchregistrations.md): Search the MAC registrations by the criteria.

### List MAC Registrations in Pool

 - [GET /macRegistrationPools/{poolId}/registrations](https://docs.ruckus.cloud/api/mac-registration-0.0.1/mac-registration/listallregistrations.md): List the MAC registrations in the registration pool.

### Returns the Specific MAC Registration

 - [GET /macRegistrationPools/{poolId}/registrations/{id}](https://docs.ruckus.cloud/api/mac-registration-0.0.1/mac-registration/getregistrationbyid.md): Return the specific MAC registration.

## Registration Pool

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

### Change Policy Set for Pool

 - [PUT /macRegistrationPools/{id}/policySets/{policySetId}](https://docs.ruckus.cloud/api/mac-registration-0.0.1/registration-pool/macpoolupdatepolicysetid.md): Update the policy set id for the registration pool.

### Remove Policy Set from Pool

 - [DELETE /macRegistrationPools/{id}/policySets/{policySetId}](https://docs.ruckus.cloud/api/mac-registration-0.0.1/registration-pool/macpoolremovepolicysetid.md): Remove the policy set id from the registration pool.

### Search Registration Pools by Criteria

 - [POST /macRegistrationPools/query](https://docs.ruckus.cloud/api/mac-registration-0.0.1/registration-pool/searchpools.md): Search the registration pools by the criteria.

### List Registration Pools

 - [GET /macRegistrationPools](https://docs.ruckus.cloud/api/mac-registration-0.0.1/registration-pool/listallpools.md): List the registration pools.

### Returns the Specific Registration Pool

 - [GET /macRegistrationPools/{id}](https://docs.ruckus.cloud/api/mac-registration-0.0.1/registration-pool/getpoolbyid.md): Return the specific registration pool.

## 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.

### Create Pool with Identity Group

 - [POST /identityGroups/{identityGroupId}/macRegistrationPools](https://docs.ruckus.cloud/api/mac-registration-0.0.1/assign-registration-pool-identity-group/createpoolwithidentitygroup.md): Create a registration pool with the identity group.

## Wifi Network

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

### Get Pools by Network ID

 - [GET /wifiNetworks/{networkId}/macRegistrationPools](https://docs.ruckus.cloud/api/mac-registration-0.0.1/wifi-network/getpoolsbynetworkid.md): Get the registration pools by the network id.