RADIUS Clients

You can use REST API v2 calls to obtain information about existing RADIUS clients.

The following table lists the properties that can be used in the body of a RADIUS client-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: RADIUS Clients

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 RADIUS client.
referenceName String Yes Neither No The display name for this RADIUS client, must be unique
ipAddress String Yes Neither No IP address of the RADIUS client.
enabled Boolean Yes Neither No (true by default) If enabled, the client is available for use. If disabled, the client is not available for use.
sharedSecret String Yes Neither NO The shared secret for this RADIUS client.
changeOfAuthority <Object> Embedded Yes Neither Yes Change of Authority embedded object. If not present, COA has not been enabled; if present COA is enabled.
links Link No No No A self reference href link is created. This link can be used in other API calls, such as within the "rule" section of a POST call to create a policy.

Resource:ChangeOfAuthority

Property Name Type Editable Filter/Sort Optional in Request/Response Body? Description
port Long No Neither Optional on create only, but not on any subsequent uses COA usually uses port 3799 in typical configurations and 2083 in RADSEC configurations. Some Cisco equipment uses port 1700.
macAddressFormat Enum Yes Filter No COA MAC Address Format - MAC Addresses within attributes such as value of 'Calling-Station-Id' will be sent in this format. Enumeration values accepted are:
  • COLON_6_GROUPS (XX:XX:XX:XX:XX:XX)
  • HYPHEN_2_GROUPS (XXXXXX-XXXXXX)
  • HYPHEN_6_GROUPS (XX-XX-XX-XX-XX-XX)
  • DOT (XXXX.XXXX.XXXX)
  • NONE(XXXXXXXXXXXX)
disconnectAttributes List Yes Neither Yes A list of additional attributes to apply to radius configurations during the disconnect from the RADIUS client. Refer to Resource: Attribute.
portForwardList List Yes Neither Yes This list should only be provided if port forwarding is required to reach the switches or controllers. By default, the system sends COA requests to the switch or controller on the default port (3799).You can enable this option by providing at least one value in the portForward list. Refer to the "Resource: portForward" table that follows.

Resource:portForward

Property Name Type Editable Filter/Sort Optional in Request/Response Body? Description
nasIpAddress String Yes Neither No The NAS Ip address for forwarding.
port Long Yes Neither No The port number for forwarding
sharedSecret String Yes Neither No The shared secret to use for this NAS IP.

RADIUS Clients 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 Clients

URI Action Description Return Codes
/radius/clients GET Returns the list of RADIUS clients that are defined.

401 - Unauthorized

/radius/clients/{id} GET Returns the specific RADIUS client.

404 - Not Found

401 - Unauthorized

Example of Using GET to Retrieve RADIUS Client Information

This example demonstrates how to obtain information about all RADIUS clients in your Cloudpath system by using the REST API GET call.

URI:

This example uses the following URI: 

 https://Jeff243.cloudpath.net/admin/apiv2/5XcTc6SjkHDL/radius/clients/

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:

No request body is needed for this request. All the necessary information is in the URI.

Action:

Use the GET action to send the request.

Response Body:

Once the request is sent, you will receive a "Status: 200 OK" if the GET is successful. The example response body below lists information for the specified RADIUS client.

{
    "page": {
        "page": 1,
        "pageSize": 1,
        "totalCount": 1
    },
    "contents": [
        {
            "guid": "1",
            "referenceName": "Rad Client 12",
            "ipAddress": "10.0.0.1",
            "enabled": true,
            "sharedSecret": "testtest",
            "changeOfAuthority": {
                "port": 3799,
                "macAddressFormat": "COLON_6_GROUPS",
                "disconnectAttributes": [],
                "portForwardList": []
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff243.cloudpath.net/admin/api3v2/5XcTc6SjkHDL/radius/clients/1",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        }
    ]
}

Parent topic: Core Cloudpath APIs