Skip to content
Radius Attribute Group/
/
Get RADIUS Attributes

Radius Attribute Group (1.0.9)

Overview

The RADIUS Attribute Group Management API provides comprehensive management of RADIUS attribute groups for network authentication and authorization. RADIUS is a networking protocol that provides centralized authentication, authorization, and accounting management. This API enables organizations to create, modify, and delete RADIUS attribute groups that contain standardized network parameters used in wireless and wired network access control.

What This API Does

  • Create and manage RADIUS attribute groups: Organize RADIUS attributes into logical groups for easier management
  • Assign attributes to groups: Associate specific RADIUS attributes with groups. The complete list of available RADIUS attributes can be retrieved through the API endpoint /radiusAttributes.
  • Query available RADIUS attributes: Browse and search through available RADIUS attributes by vendor, data type, and name
  • Manage external service assignments: Link attribute groups to external services and systems for distributed authentication

Technical Details

  • Content Types: Supports application/json and application/vnd.ruckus.v1+json
  • API Version: v1.0.9
  • Data Formats: JSON with HATEOAS links for resource navigation
  • Pagination: Standard pagination with configurable page sizes

Common Use Cases

  • Wireless Network Access: Configure RADIUS attributes for Wi-Fi authentication
  • VPN Access Control: Manage user access policies through RADIUS attribute groups
  • Guest Network Management: Create attribute groups for different user types

Authentication

All API calls require valid authentication via Bearer token in Authorization header. Include the JWT token in the Authorization: Bearer <token> header.

Error Handling

The API uses standard HTTP status codes with detailed error messages in the response body. All error responses include a requestId for tracking and debugging purposes.

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

Comprehensive management of RADIUS attribute groups including creation, modification, deletion, and querying. Provides full CRUD operations for organizing RADIUS attributes into logical groups for network authentication and authorization.

Operations

RADIUS Attribute Group Assignments

Manages the external service assignments to a specified Attribute Group. Enables linking RADIUS attribute groups to external services and systems for distributed authentication and authorization across multiple platforms.

Operations

RADIUS Attribute

Browse and query the comprehensive catalog of supported RADIUS attributes. Provides read only access to standardized RADIUS parameters including vendor specific attributes, data types, and metadata for network authentication and authorization.

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
Body
required
sortFieldstring

The field name to use for sorting the results. Valid field names depend on the resource being queried. For RADIUS attributes, valid values include: id, name, vendorName, dataType, showOnDefault. For RADIUS attribute groups, valid values include: id, name, description, attributeCount, externalAssignmentsCount. For attribute group assignments, valid values include: id, externalAssignmentIdentifier, serviceName. The field name must match exactly one of the supported sortable fields for the resource type.

Example: "name"
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

A map of filter criteria to apply to the query results. Each key represents a field name to filter on, and the value is the filter condition. Supported filter formats depend on the resource type. Examples: {"name": "John Doe"} for exact match on attribute names, {"vendorName": "Cisco"} for vendor filtering, {"attributeCount": {"gte": 5}} for range queries. Filter keys must match valid field names for the resource being queried.

Example: {"name":"Sally Smith","vendorName":"Cisco"}
{
  "sortField": "name",
  "sortOrder": "ASC",
  "page": 0,
  "pageSize": 1,
  "filters": {
    "name": "Sally Smith",
    "vendorName": "Cisco"
  }
}

Responses

List RADIUS attributes in a paged format.

Body
totalCountinteger(int64)

Total number of items matching the query across all pages.

pageinteger(int32)>= 0

Current page number (0-based).

pageSizeinteger(int32)>= 1

Number of items per page.

dataArray of objects
Response
{
  "totalCount": 0,
  "page": 0,
  "pageSize": 1,
  "data": [
    null
  ]
}

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 separated from the sort order (asc or desc).

No request payload

Responses

RADIUS Attributes in a paged format.

Body
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 data type of the RADIUS attribute, which determines how the attribute value is validated and formatted (e.g., IPADDR for IPv4 addresses, STRING for text, INTEGER for numeric values).

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

Indicates if this attribute should be shown by default.

_linksobject(Links)

Hypermedia links for HATEOAS navigation, including self reference and related resources.

Response
{
  "id": 0,
  "name": "string",
  "vendorName": "string",
  "dataType": "ABINARY",
  "showOnDefault": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Get RADIUS Attribute

Request

Gets the specific RADIUS attribute requested.

Path
idinteger(int64)required

Attribute unique identifier.

No request payload

Responses

RADIUS Attribute

Body
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 data type of the RADIUS attribute, which determines how the attribute value is validated and formatted (e.g., IPADDR for IPv4 addresses, STRING for text, INTEGER for numeric values).

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

Indicates if this attribute should be shown by default.

_linksobject(Links)

Hypermedia links for HATEOAS navigation, including self reference and related resources.

Response
{
  "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"
  ]
}