Skip to content
/
Get client alias

Client Management (0.0.1)

Overview

The Client Management REST APIs provide comprehensive functionality for managing identity clients, including client identification and alias management.

What This API Does

  • Client Query: Query and retrieve detailed information about connected clients
  • Client Aliases: Create, update, delete, and query custom aliases for client devices

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 token
  • 403 Forbidden: Insufficient permissions for the requested operation
  • 404 Not Found: Requested client or resource doesn't exist
  • 409 Conflict: Resource conflict (e.g., duplicate alias)
  • 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

Client Alias

Client Alias management APIs.

Operations

Get client alias

Request

Retrieve the alias information for the specified client MAC address.

Path
macAddressstringrequired

MAC address of the client

No request payload

Responses

Alias found

Body
idstring

The identifier of the client alias.

aliasstring[ 1 .. 255 ] characters^[a-zA-Z0-9][a-zA-Z0-9_-]{0,254}$required

The alias name of the client.

deviceTypestring

The type of the device.

Enum"WIFI""SWITCH""EDGE"
macAddressstring

The MAC address of the client.

Response
{
  "id": "string",
  "alias": "string",
  "deviceType": "WIFI",
  "macAddress": "string"
}

Update or create client alias

Request

Update or create the alias for the specified client identified by MAC address.

Path
macAddressstringrequired

MAC address of the client

Body
required
idstring

The identifier of the client alias.

aliasstring[ 1 .. 255 ] characters^[a-zA-Z0-9][a-zA-Z0-9_-]{0,254}$required

The alias name of the client.

deviceTypestring

The type of the device.

Enum"WIFI""SWITCH""EDGE"
macAddressstring

The MAC address of the client.

{
  "id": "string",
  "alias": "string",
  "deviceType": "WIFI",
  "macAddress": "string"
}

Responses

Request accepted

Body
requestIdstring
idstring

Only present for the create operation.

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

Delete client alias

Request

Remove the alias associated with the specified client MAC address.

Path
macAddressstringrequired

MAC address of the client

No request payload

Responses

Request accepted

Body
requestIdstring
idstring

Only present for the create operation.

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

Query client aliases

Request

Query client aliases based on filter criteria such as alias name or MAC address, with support for pagination.

Query
pageableobject(Pageable)required

Parameters for paging

pageable.​pageinteger(int32)>= 0
pageable.​sizeinteger(int32)>= 1
pageable.​sortArray of strings
Body
macAddressesArray of strings

A list of MAC addresses to filter the query. If omitted or empty, the query will not filter by MAC address.

aliasstring

A partial match filter for the alias.

{
  "macAddresses": [
    "string"
  ],
  "alias": "string"
}

Responses

Aliases found

Body
totalPagesinteger(int32)
totalElementsinteger(int64)
sizeinteger(int32)
contentArray of objects
numberinteger(int32)
sortobject(SortObject)
numberOfElementsinteger(int32)
pageableobject(PageableObject)
firstboolean
lastboolean
emptyboolean
Response
{
  "totalPages": 0,
  "totalElements": 0,
  "size": 0,
  "content": [
    {}
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "sort": { … },
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "unpaged": true
  },
  "first": true,
  "last": true,
  "empty": true
}

Identity Client

Operations