Skip to content

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

Identity Client

Operations

Query Identity Clients

Request

Query
pageableobject(Pageable)required

Parameters for paging

pageable.​pageinteger(int32)>= 0
pageable.​sizeinteger(int32)>= 1
pageable.​sortArray of strings
Body
required
identityIdsArray of strings
{
  "identityIds": [
    "string"
  ]
}

Responses

Clients found

Body
totalPagesinteger(int32)
totalElementsinteger(int64)
sizeinteger(int32)
contentArray of objects(Client)
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
}