Skip to content

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

RADIUS Attribute Group Assignments

Manages the external service assignments to a specified Attribute Group

Operations

Get External Assignments

Request

Gets the external assignments for the specified Radius attribute group.

Path
groupIdstring(uuid)required

RADIUS Attribute Group id

No request payload

Responses

RADIUS Attribute Group Assignments

Bodyapplication/json
Response
application/json
null

Create External Assignment

Request

Create an external service assignment to the requested RADIUS attribute group.

Path
groupIdstring(uuid)required

RADIUS Attribute Group id

Bodyapplication/jsonrequired
idstring(uuid)

The unique identifier for this external assignment of an attribute group.

externalAssignmentIdentifierstringrequired

The identifier for this external assignment and must be unique when combined with the service name.

serviceNamestringrequired

The name of the service that is using the attribute group.

_linksobject(Links)
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "externalAssignmentIdentifier": "string", "serviceName": "string", "_links": { "property1": { … }, "property2": { … } } }

Responses

Assignment created

Bodyapplication/json
idstring(uuid)

The unique identifier for this external assignment of an attribute group.

externalAssignmentIdentifierstringrequired

The identifier for this external assignment and must be unique when combined with the service name.

serviceNamestringrequired

The name of the service that is using the attribute group.

_linksobject(Links)
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "externalAssignmentIdentifier": "string", "serviceName": "string", "_links": { "property1": { … }, "property2": { … } } }

Get External Assignment

Request

Gets the external assignment for the specified RADIUS attribute group.

Path
groupIdstring(uuid)required

RADIUS Attribute Group id

assignmentIdstring(uuid)required

RADIUS Attribute Group Assignment id

No request payload

Responses

RADIUS Attribute Group Assignment

Bodyapplication/json
idstring(uuid)

The unique identifier for this external assignment of an attribute group.

externalAssignmentIdentifierstringrequired

The identifier for this external assignment and must be unique when combined with the service name.

serviceNamestringrequired

The name of the service that is using the attribute group.

_linksobject(Links)
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "externalAssignmentIdentifier": "string", "serviceName": "string", "_links": { "property1": { … }, "property2": { … } } }

Delete External Assignment

Request

Delete the requested external assignment for this RADIUS attribute group.

Path
groupIdstring(uuid)required

RADIUS Attribute Group id

assignmentIdstring(uuid)required

RADIUS Attribute Group Assignment id

No request payload

Responses

External Assignment to be deleted.

Bodyapplication/json
object
Response
application/json
{}