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

RADIUS Attribute Group Assignments

Manages the external service assignments to a specified Attribute Group

Operations

Get External Assignments

Request

Gets the external assignments for the specified Radius attribute group.

Path
groupIdstring(uuid)required

RADIUS Attribute Group id

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 Group Assignments

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

Request

Create an external service assignment to the requested RADIUS attribute group.

Path
groupIdstring(uuid)required

RADIUS Attribute Group id

Body
required
idstring(uuid)

The unique identifier for this external assignment of an attribute group.

externalAssignmentIdentifierstringrequired

The identifier for this external assignment and must be unique when combined with the service name.

serviceNamestringrequired

The name of the service that is using the attribute group.

_linksobject(Links)
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalAssignmentIdentifier": "string",
  "serviceName": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Assignment created

Body
idstring(uuid)

The unique identifier for this external assignment of an attribute group.

externalAssignmentIdentifierstringrequired

The identifier for this external assignment and must be unique when combined with the service name.

serviceNamestringrequired

The name of the service that is using the attribute group.

_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalAssignmentIdentifier": "string",
  "serviceName": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Get External Assignment

Request

Gets the external assignment for the specified RADIUS attribute group.

Path
groupIdstring(uuid)required

RADIUS Attribute Group id

assignmentIdstring(uuid)required

RADIUS Attribute Group Assignment id

No request payload

Responses

RADIUS Attribute Group Assignment

Body
idstring(uuid)

The unique identifier for this external assignment of an attribute group.

externalAssignmentIdentifierstringrequired

The identifier for this external assignment and must be unique when combined with the service name.

serviceNamestringrequired

The name of the service that is using the attribute group.

_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalAssignmentIdentifier": "string",
  "serviceName": "string",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete External Assignment

Request

Delete the requested external assignment for this RADIUS attribute group.

Path
groupIdstring(uuid)required

RADIUS Attribute Group id

assignmentIdstring(uuid)required

RADIUS Attribute Group Assignment id

No request payload

Responses

External Assignment to be deleted.

Body
object
Response
{}