Skip to content

Radius Attribute Group (1.0.9)

Overview

The RADIUS Attribute Group Management API allows creation, modification, and deletion ofRADIUS attribute groups.

What This API Does

  • Create and manage RADIUS attribute groups
  • Assign attributes to groups
  • Query available RADIUS attributes
  • Manage external service assignments

Authentication

All API calls require valid authentication via Bearer token in Authorization header.

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/

RADIUS Attribute Group

Manage the RADIUS attribute groups.

Operations

RADIUS Attribute

View the list of supported RADIUS attributes.

Operations

Get RADIUS Attributes

Request

Gets the list of RADIUS attributes using the specified query. Paging is indexed starting at one.

Query
excludeContentboolean
Default false
Bodyapplication/jsonrequired
sortFieldstring

The field to use to sort on.

sortOrderstring

The sort order of the applied query.

Enum"ASC""DESC"
pageinteger(int32)>= 0

The page number to return, indexed starting with 0.

pageSizeinteger(int32)[ 1 .. 2000 ]

The number of items requested on the page.

filtersobject

The list of filters to apply.

application/json
{
  "sortField": "string",
  "sortOrder": "ASC",
  "page": 0,
  "pageSize": 1,
  "filters": {
    "property1": {},
    "property2": {}
  }
}

Responses

List RADIUS attributes in a paged format.

Body
totalCountinteger(int64)
pageinteger(int32)
pageSizeinteger(int32)
dataArray of objects(RADIUS Attribute)
Response
{
  "totalCount": 0,
  "page": 0,
  "pageSize": 0,
  "data": [
    { … }
  ]
}

Get RADIUS Attributes

Request

Gets the list of RADIUS attributes in a paged format.

Query
sizeany

Page size

pageany

The page to retrieve (starts at zero).

sortany

The field name to sort, comma seperated from the sort order (asc or desc).

No request payload

Responses

RADIUS Attributes in a paged format.

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

Get RADIUS Attribute

Request

Gets the specific RADIUS attribute requested.

Path
idinteger(int64)required

Attribute unique identifier.

No request payload

Responses

RADIUS Attribute

Bodyapplication/json
idinteger(int64)required

The identifier for this RADIUS attribute.

namestringrequired

The attribute name, as viewed in RADIUS.

vendorNamestring

The vendor for this RADIUS attribute.

dataTypestring

The attribute name, as viewed in RADIUS.

Enum"ABINARY""BYTE""COMBO_IP""DATE""ETHER""IFID""INTEGER""IPADDR""IPV6ADDR""IPV6PREFIX"
showOnDefaultboolean

Indicates if this attribute should be shown by default.

_linksobject(Links)
Response
application/json
{
  "id": 0,
  "name": "string",
  "vendorName": "string",
  "dataType": "ABINARY",
  "showOnDefault": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Get RADIUS Attribute Vendors

Request

Gets the list of vendors that are supported in the RADIUS attributes.

No request payload

Responses

RADIUS Attribute Vendors.

Body
supportedVendorsArray of strings

The list of vendors found in the RADIUS attributes.

Response
{
  "supportedVendors": [
    "string"
  ]
}

RADIUS Attribute Group Assignments

Manages the external service assignments to a specified Attribute Group

Operations