Skip to content
/
Get RADIUS Attribute Grou...

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

Get RADIUS Attribute Groups

Request

Gets the complete list of RADIUS attribute group 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 attribute groups paged.

Body
totalElementsinteger(int64)
totalPagesinteger(int32)
pageableobject(PageableObject)
firstboolean
lastboolean
sizeinteger(int32)
contentArray of objects(RADIUS Attribute Group)
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
}

Create RADIUS Attribute Group

Request

Creates a RADIUS attribute group with the requested values.

Body
required
idstring(uuid)

The unique identifier for this attribute group.

namestringrequired

The the name for this attribute group.

descriptionstring

The the description for this attribute group.

attributeAssignmentsArray of objects(Attribute Assignment)required

The RADIUS attributes that are assigned to this group.

attributeAssignments[].​attributeNamestringrequired

The RADIUS attribute name to use. This should be from the list of supported radius attributes.

attributeAssignments[].​operatorstringrequired

The operator to use, which must be one of the allowed types.

Enum"ADD""ADD_REPLACE""DOES_NOT_EXIST"
attributeAssignments[].​attributeValuestringrequired

The assignment value to be returned for this RADIUS attribute.

attributeAssignments[].​dataTypestringrequired

The data type for this attribute. The value provided must be of the specified data types.

Enum"ABINARY""BYTE""COMBO_IP""DATE""ETHER""IFID""INTEGER""IPADDR""IPV6ADDR""IPV6PREFIX"
attributeCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalAssignmentsCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalServiceAssignmentsArray of objects(External Assignment Service Group)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

_linksobject(Links)
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "attributeAssignments": [
    { … }
  ],
  "attributeCount": 0,
  "externalAssignmentsCount": 0,
  "externalServiceAssignments": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

RADIUS attribute group created

Body
idstring(uuid)

The unique identifier for this attribute group.

namestringrequired

The the name for this attribute group.

descriptionstring

The the description for this attribute group.

attributeAssignmentsArray of objects(Attribute Assignment)required

The RADIUS attributes that are assigned to this group.

attributeAssignments[].​attributeNamestringrequired

The RADIUS attribute name to use. This should be from the list of supported radius attributes.

attributeAssignments[].​operatorstringrequired

The operator to use, which must be one of the allowed types.

Enum"ADD""ADD_REPLACE""DOES_NOT_EXIST"
attributeAssignments[].​attributeValuestringrequired

The assignment value to be returned for this RADIUS attribute.

attributeAssignments[].​dataTypestringrequired

The data type for this attribute. The value provided must be of the specified data types.

Enum"ABINARY""BYTE""COMBO_IP""DATE""ETHER""IFID""INTEGER""IPADDR""IPV6ADDR""IPV6PREFIX"
attributeCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalAssignmentsCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalServiceAssignmentsArray of objects(External Assignment Service Group)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "attributeAssignments": [
    { … }
  ],
  "attributeCount": 0,
  "externalAssignmentsCount": 0,
  "externalServiceAssignments": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Get RADIUS Attribute Groups

Request

Gets the list of RADIUS attribute groups using the specified query.

Query
excludeContentboolean
Default false
Body
required
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.

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

Responses

RADIUS attribute groups

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

Get RADIUS Attribute Group

Request

Gets the requested RADIUS attribute group by the id.

Path
groupIdstring(uuid)required

RADIUS attribute group id

No request payload

Responses

RADIUS attribute group

Body
idstring(uuid)

The unique identifier for this attribute group.

namestringrequired

The the name for this attribute group.

descriptionstring

The the description for this attribute group.

attributeAssignmentsArray of objects(Attribute Assignment)required

The RADIUS attributes that are assigned to this group.

attributeAssignments[].​attributeNamestringrequired

The RADIUS attribute name to use. This should be from the list of supported radius attributes.

attributeAssignments[].​operatorstringrequired

The operator to use, which must be one of the allowed types.

Enum"ADD""ADD_REPLACE""DOES_NOT_EXIST"
attributeAssignments[].​attributeValuestringrequired

The assignment value to be returned for this RADIUS attribute.

attributeAssignments[].​dataTypestringrequired

The data type for this attribute. The value provided must be of the specified data types.

Enum"ABINARY""BYTE""COMBO_IP""DATE""ETHER""IFID""INTEGER""IPADDR""IPV6ADDR""IPV6PREFIX"
attributeCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalAssignmentsCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalServiceAssignmentsArray of objects(External Assignment Service Group)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "attributeAssignments": [
    { … }
  ],
  "attributeCount": 0,
  "externalAssignmentsCount": 0,
  "externalServiceAssignments": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete RADIUS Attribute Group

Request

Deletes the requested RADIUS attribute group.

Path
groupIdstring(uuid)required

Radius Attribute Group id

No request payload

Responses

RADIUS attribute group deleted.

Body
object
Response
{}

Update RADIUS Attribute Group

Request

Updates the properties on the requested RADIUS attribute group.

Path
groupIdstring(uuid)required

RADIUS attribute group id

Body
required
property name*objectadditional property
{
  "property1": {},
  "property2": {}
}

Responses

RADIUS attribute group

Body
idstring(uuid)

The unique identifier for this attribute group.

namestringrequired

The the name for this attribute group.

descriptionstring

The the description for this attribute group.

attributeAssignmentsArray of objects(Attribute Assignment)required

The RADIUS attributes that are assigned to this group.

attributeAssignments[].​attributeNamestringrequired

The RADIUS attribute name to use. This should be from the list of supported radius attributes.

attributeAssignments[].​operatorstringrequired

The operator to use, which must be one of the allowed types.

Enum"ADD""ADD_REPLACE""DOES_NOT_EXIST"
attributeAssignments[].​attributeValuestringrequired

The assignment value to be returned for this RADIUS attribute.

attributeAssignments[].​dataTypestringrequired

The data type for this attribute. The value provided must be of the specified data types.

Enum"ABINARY""BYTE""COMBO_IP""DATE""ETHER""IFID""INTEGER""IPADDR""IPV6ADDR""IPV6PREFIX"
attributeCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalAssignmentsCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalServiceAssignmentsArray of objects(External Assignment Service Group)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "attributeAssignments": [
    { … }
  ],
  "attributeCount": 0,
  "externalAssignmentsCount": 0,
  "externalServiceAssignments": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

RADIUS Attribute

View the list of supported RADIUS attributes.

Operations

RADIUS Attribute Group Assignments

Manages the external service assignments to a specified Attribute Group

Operations