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.
Radius Attribute Group (1.0.9)
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.
- 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
- Content Types: Supports
application/jsonandapplication/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
- 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
All API calls require valid authentication via Bearer token in Authorization header. Include the JWT token in the Authorization: Bearer <token> header.
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.
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
Overview
License
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
- RUCKUS One API host for North American region.https://api.ruckus.cloud/radiusAttributeGroups
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/radiusAttributeGroups
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/radiusAttributeGroups
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadRadius attribute groups paged.
- application/vnd.ruckus.v1+json
- application/json
The RADIUS attributes that are assigned to this group.
The RADIUS attribute name to use. This should be from the list of supported RADIUS attributes. The complete list of available RADIUS attributes can be retrieved through the /radiusAttributes API endpoint. For standard RADIUS attributes, refer to Request for Comments 2865. Vendor specific attributes are identified by their vendor name.
The operator to use for attribute assignment. ADD: Adds the attribute value to the response if it does not already exist. ADD_REPLACE: Adds the attribute value to the response, replacing any existing value for the same attribute. DOES_NOT_EXIST: Assigns the attribute value only if the attribute does not already exist in the response.
Enum"ADD""ADD_REPLACE""DOES_NOT_EXIST"
The assignment value to be returned for this RADIUS attribute. The value must conform to the data type specified for the attribute. Maximum length is 4096 characters.
The data type for this attribute value. The value must match one of the specified data types. The data type determines how the attributeValue is validated and formatted. For example, IPADDR expects a valid IPv4 address, IPV6ADDR expects a valid IPv6 address, INTEGER expects a numeric value, and STRING accepts alphanumeric text. Refer to the RADIUS Attribute schema for the specific data type definition of the selected attribute.
Enum"ABINARY""BYTE""COMBO_IP""DATE""ETHER""IFID""INTEGER""IPADDR""IPV6ADDR""IPV6PREFIX"
The number of RADIUS attribute assignments within this attribute group. Allows sorting and filtering.
The total count of external service assignments for this attribute group across all services. Allows sorting and filtering.
The list of external service assignments grouped by service name, showing which services have assigned this attribute group and their associated external assignment identifiers.
Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "attributeAssignments": [ { … } ], "attributeCount": 0, "externalAssignmentsCount": 0, "externalServiceAssignments": [ { … } ], "_links": { "property1": { … }, "property2": { … } } }
Body
- application/json
- application/vnd.ruckus.v1+json
The RADIUS attributes that are assigned to this group.
The RADIUS attribute name to use. This should be from the list of supported RADIUS attributes. The complete list of available RADIUS attributes can be retrieved through the /radiusAttributes API endpoint. For standard RADIUS attributes, refer to Request for Comments 2865. Vendor specific attributes are identified by their vendor name.
The operator to use for attribute assignment. ADD: Adds the attribute value to the response if it does not already exist. ADD_REPLACE: Adds the attribute value to the response, replacing any existing value for the same attribute. DOES_NOT_EXIST: Assigns the attribute value only if the attribute does not already exist in the response.
Enum"ADD""ADD_REPLACE""DOES_NOT_EXIST"
The assignment value to be returned for this RADIUS attribute. The value must conform to the data type specified for the attribute. Maximum length is 4096 characters.
The data type for this attribute value. The value must match one of the specified data types. The data type determines how the attributeValue is validated and formatted. For example, IPADDR expects a valid IPv4 address, IPV6ADDR expects a valid IPv6 address, INTEGER expects a numeric value, and STRING accepts alphanumeric text. Refer to the RADIUS Attribute schema for the specific data type definition of the selected attribute.
Enum"ABINARY""BYTE""COMBO_IP""DATE""ETHER""IFID""INTEGER""IPADDR""IPV6ADDR""IPV6PREFIX"
The number of RADIUS attribute assignments within this attribute group. Allows sorting and filtering.
The total count of external service assignments for this attribute group across all services. Allows sorting and filtering.
The list of external service assignments grouped by service name, showing which services have assigned this attribute group and their associated external assignment identifiers.
- RUCKUS One API host for North American region.https://api.ruckus.cloud/radiusAttributeGroups
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/radiusAttributeGroups
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/radiusAttributeGroups
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "attributeAssignments": [ { … } ], "attributeCount": 0, "externalAssignmentsCount": 0, "externalServiceAssignments": [ { … } ], "_links": { "property1": { … }, "property2": { … } } }
RADIUS attribute group created
- application/vnd.ruckus.v1+json
- application/json
The RADIUS attributes that are assigned to this group.
The RADIUS attribute name to use. This should be from the list of supported RADIUS attributes. The complete list of available RADIUS attributes can be retrieved through the /radiusAttributes API endpoint. For standard RADIUS attributes, refer to Request for Comments 2865. Vendor specific attributes are identified by their vendor name.
The operator to use for attribute assignment. ADD: Adds the attribute value to the response if it does not already exist. ADD_REPLACE: Adds the attribute value to the response, replacing any existing value for the same attribute. DOES_NOT_EXIST: Assigns the attribute value only if the attribute does not already exist in the response.
Enum"ADD""ADD_REPLACE""DOES_NOT_EXIST"
The assignment value to be returned for this RADIUS attribute. The value must conform to the data type specified for the attribute. Maximum length is 4096 characters.
The data type for this attribute value. The value must match one of the specified data types. The data type determines how the attributeValue is validated and formatted. For example, IPADDR expects a valid IPv4 address, IPV6ADDR expects a valid IPv6 address, INTEGER expects a numeric value, and STRING accepts alphanumeric text. Refer to the RADIUS Attribute schema for the specific data type definition of the selected attribute.
Enum"ABINARY""BYTE""COMBO_IP""DATE""ETHER""IFID""INTEGER""IPADDR""IPV6ADDR""IPV6PREFIX"
The number of RADIUS attribute assignments within this attribute group. Allows sorting and filtering.
The total count of external service assignments for this attribute group across all services. Allows sorting and filtering.
The list of external service assignments grouped by service name, showing which services have assigned this attribute group and their associated external assignment identifiers.
Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "attributeAssignments": [ { … } ], "attributeCount": 0, "externalAssignmentsCount": 0, "externalServiceAssignments": [ { … } ], "_links": { "property1": { … }, "property2": { … } } }
Bodyrequired
- application/json
- application/vnd.ruckus.v1+json
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"
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"}
- RUCKUS One API host for North American region.https://api.ruckus.cloud/radiusAttributeGroups/query
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/radiusAttributeGroups/query
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/radiusAttributeGroups/query
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
{ "sortField": "name", "sortOrder": "ASC", "page": 0, "pageSize": 1, "filters": { "name": "Sally Smith", "vendorName": "Cisco" } }
Response
{ "totalCount": 0, "page": 0, "pageSize": 1, "data": [ null ] }
- RUCKUS One API host for North American region.https://api.ruckus.cloud/radiusAttributeGroups/{groupId}
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/radiusAttributeGroups/{groupId}
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/radiusAttributeGroups/{groupId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadRADIUS attribute group
- application/vnd.ruckus.v1+json
- application/json
The RADIUS attributes that are assigned to this group.
The RADIUS attribute name to use. This should be from the list of supported RADIUS attributes. The complete list of available RADIUS attributes can be retrieved through the /radiusAttributes API endpoint. For standard RADIUS attributes, refer to Request for Comments 2865. Vendor specific attributes are identified by their vendor name.
The operator to use for attribute assignment. ADD: Adds the attribute value to the response if it does not already exist. ADD_REPLACE: Adds the attribute value to the response, replacing any existing value for the same attribute. DOES_NOT_EXIST: Assigns the attribute value only if the attribute does not already exist in the response.
Enum"ADD""ADD_REPLACE""DOES_NOT_EXIST"
The assignment value to be returned for this RADIUS attribute. The value must conform to the data type specified for the attribute. Maximum length is 4096 characters.
The data type for this attribute value. The value must match one of the specified data types. The data type determines how the attributeValue is validated and formatted. For example, IPADDR expects a valid IPv4 address, IPV6ADDR expects a valid IPv6 address, INTEGER expects a numeric value, and STRING accepts alphanumeric text. Refer to the RADIUS Attribute schema for the specific data type definition of the selected attribute.
Enum"ABINARY""BYTE""COMBO_IP""DATE""ETHER""IFID""INTEGER""IPADDR""IPV6ADDR""IPV6PREFIX"
The number of RADIUS attribute assignments within this attribute group. Allows sorting and filtering.
The total count of external service assignments for this attribute group across all services. Allows sorting and filtering.
The list of external service assignments grouped by service name, showing which services have assigned this attribute group and their associated external assignment identifiers.
Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "attributeAssignments": [ { … } ], "attributeCount": 0, "externalAssignmentsCount": 0, "externalServiceAssignments": [ { … } ], "_links": { "property1": { … }, "property2": { … } } }
- RUCKUS One API host for North American region.https://api.ruckus.cloud/radiusAttributeGroups/{groupId}
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/radiusAttributeGroups/{groupId}
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/radiusAttributeGroups/{groupId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
{}
Body
- application/json
- application/vnd.ruckus.v1+json
The name for this attribute group. Maximum length is 255 characters.
The description for this attribute group. Maximum length is 1000 characters.
- RUCKUS One API host for North American region.https://api.ruckus.cloud/radiusAttributeGroups/{groupId}
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/radiusAttributeGroups/{groupId}
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/radiusAttributeGroups/{groupId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
{ "name": "string", "description": "string", "attributeAssignments": [ { … } ] }
RADIUS attribute group
- application/vnd.ruckus.v1+json
- application/json
The RADIUS attributes that are assigned to this group.
The RADIUS attribute name to use. This should be from the list of supported RADIUS attributes. The complete list of available RADIUS attributes can be retrieved through the /radiusAttributes API endpoint. For standard RADIUS attributes, refer to Request for Comments 2865. Vendor specific attributes are identified by their vendor name.
The operator to use for attribute assignment. ADD: Adds the attribute value to the response if it does not already exist. ADD_REPLACE: Adds the attribute value to the response, replacing any existing value for the same attribute. DOES_NOT_EXIST: Assigns the attribute value only if the attribute does not already exist in the response.
Enum"ADD""ADD_REPLACE""DOES_NOT_EXIST"
The assignment value to be returned for this RADIUS attribute. The value must conform to the data type specified for the attribute. Maximum length is 4096 characters.
The data type for this attribute value. The value must match one of the specified data types. The data type determines how the attributeValue is validated and formatted. For example, IPADDR expects a valid IPv4 address, IPV6ADDR expects a valid IPv6 address, INTEGER expects a numeric value, and STRING accepts alphanumeric text. Refer to the RADIUS Attribute schema for the specific data type definition of the selected attribute.
Enum"ABINARY""BYTE""COMBO_IP""DATE""ETHER""IFID""INTEGER""IPADDR""IPV6ADDR""IPV6PREFIX"
The number of RADIUS attribute assignments within this attribute group. Allows sorting and filtering.
The total count of external service assignments for this attribute group across all services. Allows sorting and filtering.
The list of external service assignments grouped by service name, showing which services have assigned this attribute group and their associated external assignment identifiers.
Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "attributeAssignments": [ { … } ], "attributeCount": 0, "externalAssignmentsCount": 0, "externalServiceAssignments": [ { … } ], "_links": { "property1": { … }, "property2": { … } } }