Skip to content
Radius Attribute Group/
/
Get External Assignments

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

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

No request payload

Responses

RADIUS Attribute Group Assignments

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. This identifier is used by the external service to reference the attribute group assignment. Format: alphanumeric string with optional hyphens and underscores, maximum length of 255 characters. Examples: 'assignment001', 'nas_controller_1', 'vpn_gateway_west'.

Example: "assignment001"
serviceNamestringrequired

The name of the service that is using the attribute group. This identifies the target external system or application (e.g., 'wireless controller', 'VPN gateway', 'network access server', 'policy engine', 'authentication server'). Format: alphanumeric string with optional hyphens and underscores, maximum length of 255 characters. Examples: 'wireless controller', 'VPN gateway', 'network access server'.

Example: "wirelesscontroller"
_linksobject(Links)

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

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalAssignmentIdentifier": "assignment001",
  "serviceName": "wirelesscontroller",
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Create External Assignment

Request

Creates a new external service assignment linking the specified RADIUS attribute group to an external service. This enables the external service to reference and use the attribute group for authentication and authorization purposes.

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. This identifier is used by the external service to reference the attribute group assignment. Format: alphanumeric string with optional hyphens and underscores, maximum length of 255 characters. Examples: 'assignment001', 'nas_controller_1', 'vpn_gateway_west'.

Example: "assignment001"
serviceNamestringrequired

The name of the service that is using the attribute group. This identifies the target external system or application (e.g., 'wireless controller', 'VPN gateway', 'network access server', 'policy engine', 'authentication server'). Format: alphanumeric string with optional hyphens and underscores, maximum length of 255 characters. Examples: 'wireless controller', 'VPN gateway', 'network access server'.

Example: "wirelesscontroller"
_linksobject(Links)

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

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalAssignmentIdentifier": "assignment001",
  "serviceName": "wirelesscontroller",
  "_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. This identifier is used by the external service to reference the attribute group assignment. Format: alphanumeric string with optional hyphens and underscores, maximum length of 255 characters. Examples: 'assignment001', 'nas_controller_1', 'vpn_gateway_west'.

Example: "assignment001"
serviceNamestringrequired

The name of the service that is using the attribute group. This identifies the target external system or application (e.g., 'wireless controller', 'VPN gateway', 'network access server', 'policy engine', 'authentication server'). Format: alphanumeric string with optional hyphens and underscores, maximum length of 255 characters. Examples: 'wireless controller', 'VPN gateway', 'network access server'.

Example: "wirelesscontroller"
_linksobject(Links)

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

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalAssignmentIdentifier": "assignment001",
  "serviceName": "wirelesscontroller",
  "_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. This identifier is used by the external service to reference the attribute group assignment. Format: alphanumeric string with optional hyphens and underscores, maximum length of 255 characters. Examples: 'assignment001', 'nas_controller_1', 'vpn_gateway_west'.

Example: "assignment001"
serviceNamestringrequired

The name of the service that is using the attribute group. This identifies the target external system or application (e.g., 'wireless controller', 'VPN gateway', 'network access server', 'policy engine', 'authentication server'). Format: alphanumeric string with optional hyphens and underscores, maximum length of 255 characters. Examples: 'wireless controller', 'VPN gateway', 'network access server'.

Example: "wirelesscontroller"
_linksobject(Links)

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

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalAssignmentIdentifier": "assignment001",
  "serviceName": "wirelesscontroller",
  "_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(EmptyResponse)

Empty response for successful deletion operations.

Response
{}

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