Skip to content
Client Management/
/
Associate Client to Ident...

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

APIs for managing client aliases.

Operations

Identity Client

APIs for querying identity client information.

Operations

Associate Client to Identity

Request

Associate one or more clients to a target identity. This operation moves the specified clients from their current identity to the target identity.

Path
identityIdstringrequired
Body
required
identityIdstringrequired

The ID of the destination identity where the specified clients will be moved.

clientIdsArray of strings[ 1 .. 100 ] items[ 1 .. 100 ]required

List of client IDs to be moved to the target identity.

{
  "identityId": "string",
  "clientIds": [
    "string"
  ]
}

Responses

Request accepted. The client association operation has been queued for processing.

Body
requestIdstring

The unique identifier of the request.

idstring

Only present for the create operation.

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

Query Identity Clients

Request

Query and retrieve a paginated list of clients associated with identities based on filter criteria such as identity IDs.

Query
pageableobject(Pageable)required

Parameters for paging

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

A list of identity identifiers used to filter and retrieve specific clients associated with those identities.

{
  "identityIds": [
    "string"
  ]
}

Responses

Clients found

Body
totalPagesinteger(int32)

The total number of pages in the result set.

totalElementsinteger(int64)

The total number of elements in the result set.

sizeinteger(int32)
contentArray of objects(Client)

The list of client 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).

numberOfElementsinteger(int32)

The number of elements on the current page.

pageableobject(PageableObject)

The pagination information associated with this page.

firstboolean

Indicates whether the current page is the first page.

lastboolean

Indicates whether the current page is the last page.

emptyboolean

Indicates whether the result set is empty.

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