Skip to content
/
Delete RADIUS Attribute G...

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

Get RADIUS Attribute Groups

Request

Gets the complete list of RADIUS attribute group in a paged format.

No request payload

Responses

Radius attribute groups paged.

Bodyapplication/json
Response
application/json
null

Create RADIUS Attribute Group

Request

Creates a RADIUS attribute group with the requested values.

Bodyapplication/jsonrequired
idstring(uuid)

The unique identifier for this attribute group.

namestringrequired

The the name for this attribute group.

descriptionstring

The the description for this attribute group.

attributeAssignmentsArray of objects(Attribute Assignment)required

The RADIUS attributes that are assigned to this group.

attributeAssignments[].​attributeNamestringrequired

The RADIUS attribute name to use. This should be from the list of supported radius attributes.

attributeAssignments[].​operatorstringrequired

The operator to use, which must be one of the allowed types.

Enum"ADD""ADD_REPLACE""DOES_NOT_EXIST"
attributeAssignments[].​attributeValuestringrequired

The assignment value to be returned for this RADIUS attribute.

attributeAssignments[].​dataTypestringrequired

The data type for this attribute. The value provided must be of the specified data types.

Enum"ABINARY""BYTE""COMBO_IP""DATE""ETHER""IFID""INTEGER""IPADDR""IPV6ADDR""IPV6PREFIX"
attributeCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalAssignmentsCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalServiceAssignmentsArray of objects(External Assignment Service Group)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

_linksobject(Links)
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "attributeAssignments": [
    { … }
  ],
  "attributeCount": 0,
  "externalAssignmentsCount": 0,
  "externalServiceAssignments": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

RADIUS attribute group created

Bodyapplication/json
idstring(uuid)

The unique identifier for this attribute group.

namestringrequired

The the name for this attribute group.

descriptionstring

The the description for this attribute group.

attributeAssignmentsArray of objects(Attribute Assignment)required

The RADIUS attributes that are assigned to this group.

attributeAssignments[].​attributeNamestringrequired

The RADIUS attribute name to use. This should be from the list of supported radius attributes.

attributeAssignments[].​operatorstringrequired

The operator to use, which must be one of the allowed types.

Enum"ADD""ADD_REPLACE""DOES_NOT_EXIST"
attributeAssignments[].​attributeValuestringrequired

The assignment value to be returned for this RADIUS attribute.

attributeAssignments[].​dataTypestringrequired

The data type for this attribute. The value provided must be of the specified data types.

Enum"ABINARY""BYTE""COMBO_IP""DATE""ETHER""IFID""INTEGER""IPADDR""IPV6ADDR""IPV6PREFIX"
attributeCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalAssignmentsCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalServiceAssignmentsArray of objects(External Assignment Service Group)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

_linksobject(Links)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "attributeAssignments": [
    { … }
  ],
  "attributeCount": 0,
  "externalAssignmentsCount": 0,
  "externalServiceAssignments": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Get RADIUS Attribute Groups

Request

Gets the list of RADIUS attribute groups using the specified query.

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

RADIUS attribute groups

Bodyapplication/json
idstring(uuid)

The unique identifier for this attribute group.

namestringrequired

The the name for this attribute group.

descriptionstring

The the description for this attribute group.

attributeAssignmentsArray of objects(Attribute Assignment)required

The RADIUS attributes that are assigned to this group.

attributeAssignments[].​attributeNamestringrequired

The RADIUS attribute name to use. This should be from the list of supported radius attributes.

attributeAssignments[].​operatorstringrequired

The operator to use, which must be one of the allowed types.

Enum"ADD""ADD_REPLACE""DOES_NOT_EXIST"
attributeAssignments[].​attributeValuestringrequired

The assignment value to be returned for this RADIUS attribute.

attributeAssignments[].​dataTypestringrequired

The data type for this attribute. The value provided must be of the specified data types.

Enum"ABINARY""BYTE""COMBO_IP""DATE""ETHER""IFID""INTEGER""IPADDR""IPV6ADDR""IPV6PREFIX"
attributeCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalAssignmentsCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalServiceAssignmentsArray of objects(External Assignment Service Group)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

_linksobject(Links)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "attributeAssignments": [
    { … }
  ],
  "attributeCount": 0,
  "externalAssignmentsCount": 0,
  "externalServiceAssignments": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Get RADIUS Attribute Group

Request

Gets the requested RADIUS attribute group by the id.

Path
groupIdstring(uuid)required

RADIUS attribute group id

No request payload

Responses

RADIUS attribute group

Bodyapplication/json
idstring(uuid)

The unique identifier for this attribute group.

namestringrequired

The the name for this attribute group.

descriptionstring

The the description for this attribute group.

attributeAssignmentsArray of objects(Attribute Assignment)required

The RADIUS attributes that are assigned to this group.

attributeAssignments[].​attributeNamestringrequired

The RADIUS attribute name to use. This should be from the list of supported radius attributes.

attributeAssignments[].​operatorstringrequired

The operator to use, which must be one of the allowed types.

Enum"ADD""ADD_REPLACE""DOES_NOT_EXIST"
attributeAssignments[].​attributeValuestringrequired

The assignment value to be returned for this RADIUS attribute.

attributeAssignments[].​dataTypestringrequired

The data type for this attribute. The value provided must be of the specified data types.

Enum"ABINARY""BYTE""COMBO_IP""DATE""ETHER""IFID""INTEGER""IPADDR""IPV6ADDR""IPV6PREFIX"
attributeCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalAssignmentsCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalServiceAssignmentsArray of objects(External Assignment Service Group)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

_linksobject(Links)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "attributeAssignments": [
    { … }
  ],
  "attributeCount": 0,
  "externalAssignmentsCount": 0,
  "externalServiceAssignments": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete RADIUS Attribute Group

Request

Deletes the requested RADIUS attribute group.

Path
groupIdstring(uuid)required

Radius Attribute Group id

No request payload

Responses

RADIUS attribute group deleted.

Bodyapplication/json
object
Response
application/json
{}

Update RADIUS Attribute Group

Request

Updates the properties on the requested RADIUS attribute group.

Path
groupIdstring(uuid)required

RADIUS attribute group id

Bodyapplication/jsonrequired
property name*objectadditional property
application/json
{
  "property1": {},
  "property2": {}
}

Responses

RADIUS attribute group

Bodyapplication/json
idstring(uuid)

The unique identifier for this attribute group.

namestringrequired

The the name for this attribute group.

descriptionstring

The the description for this attribute group.

attributeAssignmentsArray of objects(Attribute Assignment)required

The RADIUS attributes that are assigned to this group.

attributeAssignments[].​attributeNamestringrequired

The RADIUS attribute name to use. This should be from the list of supported radius attributes.

attributeAssignments[].​operatorstringrequired

The operator to use, which must be one of the allowed types.

Enum"ADD""ADD_REPLACE""DOES_NOT_EXIST"
attributeAssignments[].​attributeValuestringrequired

The assignment value to be returned for this RADIUS attribute.

attributeAssignments[].​dataTypestringrequired

The data type for this attribute. The value provided must be of the specified data types.

Enum"ABINARY""BYTE""COMBO_IP""DATE""ETHER""IFID""INTEGER""IPADDR""IPV6ADDR""IPV6PREFIX"
attributeCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalAssignmentsCountinteger(int32)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

externalServiceAssignmentsArray of objects(External Assignment Service Group)

The number of attributes assigned to this attribute group. Allows sorting and filtering.

_linksobject(Links)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "attributeAssignments": [
    { … }
  ],
  "attributeCount": 0,
  "externalAssignmentsCount": 0,
  "externalServiceAssignments": [
    { … }
  ],
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

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