Skip to content
/
Get RADIUS Attributes

RADIUS Attribute Group Management REST API (1.0.8)

Overview

The RADIUS Attribute Group Management REST API's and Model, allow the creation, delete and modification of RADIUS attribute groups. A RADIUS attribute group is a set of RADIUS attributes that can then be applied to a RADIUS authentication. When a RADIUS response is made and a RADIUS attribute group is associated with that response, then the attributes in the group are applied to the response. Currently, policies defined in the dynamic policy service, of type "RADIUS" or of type "DPSK", must provide a radius attribute group when created.

Rate Limit

For the Radius Attribute Group REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 60 calls can be made per second.
  • Each second 30 calls will be returned to be used.
Download OpenAPI description
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Languages
Servers
Generated server url

http://localhost:8080/

RADIUS Attribute Group

Manage the RADIUS attribute groups.

Operations

RADIUS Attribute

View the list of supported RADIUS attributes.

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
Bodyapplication/jsonrequired
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.

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

Responses

List RADIUS attributes in a paged format.

Bodyapplication/json
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 attribute name, as viewed in RADIUS.

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

Indicates if this attribute should be shown by default.

_linksobject(Links)
Response
application/json
{
  "id": 0,
  "name": "string",
  "vendorName": "string",
  "dataType": "ABINARY",
  "showOnDefault": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Get RADIUS Attributes

Request

Gets the list of RADIUS attributes in a paged format.

No request payload

Responses

RADIUS Attributes in a paged format.

Bodyapplication/json
Response
application/json
null

Get RADIUS Attribute

Request

Gets the specific RADIUS attribute requested.

Path
idinteger(int64)required

Attribute unique identifier.

No request payload

Responses

RADIUS Attribute

Bodyapplication/json
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 attribute name, as viewed in RADIUS.

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

Indicates if this attribute should be shown by default.

_linksobject(Links)
Response
application/json
{
  "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.

Bodyapplication/json
supportedVendorsArray of strings

The list of vendors found in the RADIUS attributes.

Response
application/json
{
  "supportedVendors": [
    "string"
  ]
}

RADIUS Attribute Group Assignments

Manages the external service assignments to a specified Attribute Group

Operations