RADIUS Attribute Groups

You can use REST API v2 calls to obtain information about existing RADIUS attribute groups, to create or edit RADIUS attribute groups, and to delete RADIUS attribute groups.

The following table lists the properties that can be used in the body of a RADIUS attribute groups-related request and/or are provided in the response body. (In the "Optional" column, if a default value is applicable, it is listed in angle brackets (< >)).

Resource: RadiusAttributeGroup

Property Name Type Editable Filter/Sort Optional in Request/Response Body? Description
guid String No Neither Optional on create only, but not on any subsequent uses The unique identifier for this attribute group.
name String Yes Filter No The display name for this attribute group; must be unique.
description String Yes Neither Yes A description for this attribute group.
vlanid String Yes Neither Yes The VLAN to use. If not specified, the device receives the default VLAN that is configured on the controller.
classid String Yes Neither Yes The device class ID to use. If not specified, the device is not assigned a class ID.
filterid String Yes Neither Yes Filter ID for the device in the attribute group. If not specified, the device is not assigned a filter ID.
sessionTimeout Long Yes   No The reauthentication period, in seconds, that is included in the RADIUS reply for successful authentications. If the device stays connected for longer than this period, the WLAN or switch requires that the device be reauthenticated (unbeknownst to the user). If no value is specified, the sessionTimeout is not applied, which means that the device is not required to reauthenticate as long as it remains associated to the WLAN or switch.
policyCount Integer No Yes Yes The number of policies that are currently using this attribute group. This number cannot be altered, and any attempt to do so is ignored.
additionalAttributes List <Attribute> Yes   Yes A list of additional attributes to apply to RADIUS configurations. In the Configuration > Policies > Radius Attribute Groups portion of the UI, if you add or modify a RADIUS attribute group, you can click + at the bottom of the Attributes section to invoke a drop-down of all the additional attributes that are available. Also, see the "Resource: Attribute" table below for more information.
links Link No No No A self reference href link is created that can be used in other API calls where a reference to a specific RADIUS attribute group is needed, such as in a POST to create a new policy.

Additional Attributes:

The following table lists the additional-attribute properties to apply to RADIUS configurations that can be used in the body of a DPSK-pool-related request and/or are provided in the response body.

Resource: Attribute

Property Name Type Editable Filter or Sort Optional? Description
name String Yes No No The RADIUS attribute to use.
action String <Enum> Yes No No The action to take must be one of the following: ADD, ADD_OR_REPLACE, or ADD_MULTIPLE.
value String Yes No No The value to substitute.

RADIUS Attribute Groups URIs and Actions

The following table indicates the URIs that you can append to the root URI, along with the actions you can take, and possible return codes you can receive.

RADIUS Attribute Groups URIs and Actions

URI Action Description Return Codes
/radiusAttributeGroups GET Returns the list of RADIUS attribute groups defined.

401 - Unauthorized

200 - OK

POST Creates a RADIUS attribute group.

401 - Unauthorized

201 - Created

/radiusAttributeGroups/{id} GET Returns the specific RADIUS attribute group.

404 - Not Found

401 - Unauthorized

200 - OK

DELETE Deletes the RADIUS attribute group specified. If the attribute group is assigned to one or more policies, and a request to delete the group is sent, the response will be a "409" message.

409 - Conflict

401 - Unauthorized

204 - No content

200 - OK

PUT Updates a RADIUS attribute group. See the "Resource: RADIUS Attribute Groups" table for the properties that can be edited.

409 - Conflict

401 - Unauthorized

204 - No content

200 - OK

Example of Using POST to Create a RADIUS Attribute Group

This example demonstrates how to create a new RADIUS attribute group in your Cloudpath system by using the REST API POST call.

URI:

This example uses the following URI: 

 https://Jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/radiusAttributeGroups

where:

  • https://Jeff243.cloudpath.net/admin/apiv2 is the root URI of the Cloudpath system being used (must include https, as shown)
  • 5XcTc6SjkHDL is an example of an API key generated from the Configuration > API Keys section of the Cloudpath UI

Request Headers:

The following table shows the required request headers for this URI example, with an example value of an active token that must be pasted into the Authorization header value:

Request Headers

Key Value
Content-type application/json
Authorization eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqZWZmLnJob2RpZUBjb21tc2NvcGUuY29tIiwicm9sZVBrIjoiMjEwMDAiLCJhY2NvdW50QWRtaW5QayI6IjIiLCJhcGlLZXkiOiJaV2NjTGpQZUdZMGUiLCJpYXQiOjE1NzU1NzUxNTcsImV4cCI6MTU3NTU3NTQ1N30.2q4KTyDUevkAAz7mJyp529Be1-ip3EC8P06Xarmz5ao

Request Body:

The following is an example of a request body for creating a RADIUS attribute group. You can refer to the preceding Resource tables for a list and descriptions of properties you can use to define your RADIUS attribute group. For instance, in this example, a RADIUS attribute group called "RadGroup22" is being created with the values provided in the body. 

{
            "name": "RadGroup22",
            "description": "test group",
            "vlanid": "10",
            "filterid": 15,
            "sessionTimeout": 333
            }

Action:

Use the POST action to send the request.

Response Body:

Once the request is sent, you will receive a "Status: 201 Created" if the POST is successful. You can see that a "guid" (a unique identifier for the newly created RADIUS attribute group) is included in the response body. 

{
    "guid": "1",
    "name": "RadGroup22",
    "description": "test group",
    "vlanid": "10",
    "filterid": "15",
    "classid": null,
    "sessionTimeout": "333",
    "policyCount": 0,
    "additionalAttributes": [],
    "links": [
        {
            "rel": "self",
            "href": "https://jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/radiusAttributeGroups/1",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        }
    ]
}

Parent topic: Core Cloudpath APIs