Provisioning – FreeRADIUS Specifications and Actions

Article Contents

Summary

This article describes the certified specifications and actions supported for FreeRADIUS. Provisioning currently supports a subset of the FreeRADIUS provisioning capabilities. The article contains a detailed list of actions and parameters. Note: Using FreeRADIUS provisioning in the IDI platform requires task plan development. Contact your account manager for details.

Specifications

Provider: FreeRADIUS

Link: https://www.freeradius.org/

Application Interface: FreeRADIUS JSON API

Application Version: 3.0.x

IDI Platform FreeRADIUS Provider Version: 1.0

IDI Platform Bundle Version: 23.11

Overview

The section below describes how Provisioning interacts with the FreeRADIUS API, and provides some helpful advice and guidelines.

The system has a list of provisioning actions. Some actions can be fulfilled in one API call, while others may require multiple API calls to perform the action.
If an error occurs on an API call, none of the objects in the request are processed. The error must be corrected and the API regenerated accordingly.

Available Actions:

The current actions supported for FreeRADIUS include:

Provider	Action	Available
FreeRADIUS	Add Service	23.11
FreeRADIUS	Disconnect Service	23.11
FreeRADIUS	Refresh Service	23.11
FreeRADIUS	Query Service	23.11
FreeRADIUS	Change Service Number	23.11

Add Service

This action adds a new service to the switch.

Parameters:

Name	Type	Required	Notes
Base URL	String	Required	Base URL for FreeRADIUS switch
MDN	String	Required
MIN	String	Optional
Serial Number	String	Required	Serial number of the device
Device Type	String	Required
ICCID	String	Required
A12Chap	String	Required
Account Type	String	Required

Add Service Example

An example of the parameters included in an Add Service command.

Parameters:

Name	Type	Required	Example Value
Base URL	String	Required	http://example.api.website
MDN	String	Required	123456789
MIN	String	Required	987654321
Serial Number	String	Required	00001850610
Device Type	String	Required	4G
ICCID	String	Required	89015816051600026495
A12Chap	String	Required	A12ChapValue
Account Type	String	Required	0

Disconnect Service

This action disconnects a service from the switch.

Parameters:

Name	Type	Required	Notes
Base URL	String	Required	Base URL for FreeRADIUS switch
MDN	String	Required

Disconnect Service Example

An example of the parameters included in a Disconnect Service command.

Parameters:

Name	Type	Required	Example Value
Base URL	String	Required	http://example.api.website
MDN	String	Required	123456789

Refresh Service

This action first disconnects, then adds a service to the switch.

Parameters:

Name	Type	Required	Notes
Base URL	String	Required	Base URL for FreeRADIUS switch
MDN	String	Required
MIN	String	Optional
Serial Number	String	Required	Serial number of the device
Device Type	String	Required
ICCID	String	Required
A12Chap	String	Required
Account Type	String	Required

Refresh Service Example

An example of the parameters included in a Refresh Service command.

Parameters:

Name	Type	Required	Example Value
Base URL	String	Required	http://example.api.website
MDN	String	Required	123456789
MIN	String	Required	987654321
Serial Number	String	Required	00001850610
Device Type	String	Required	4G
ICCID	String	Required	89015816051600026495
A12Chap	String	Required	A12ChapValue
Account Type	String	Required	0

Query Service

This action queries information from the switch about a specific service.

Parameters:

Name	Type	Required	Notes
Base URL	String	Required	Base URL for FreeRADIUS switch
MDN	String	Required

Query Service Example

An example of the parameters included in a Query Service command.

Parameters:

Name	Type	Required	Example Value
Base URL	String	Required	http://example.api.website
MDN	String	Required	123456789

Change Service Number

This action changes the service number associated with a service on the switch.

Parameters:

Name	Type	Required	Notes
Base URL	String	Required	Base URL for FreeRADIUS switch
Old MDN	String	Required
New MDN	String	Required
MIN	String	Optional
Serial Number	String	Required	Serial number of the device
Device Type	String	Required
ICCID	String	Required
A12Chap	String	Required
Account Type	String	Required

Change Service Number Example

An example of the parameters included in a Change Service Number command.

Parameters:

Name	Type	Required	Example Value
Base URL	String	Required	http://example.api.website
Old MDN	String	Required	123456789
New MDN	String	Required	567891234
MIN	String	Required	987654321
Serial Number	String	Required	00001850610
Device Type	String	Required	4G
ICCID	String	Required	89015816051600026495
A12Chap	String	Required	A12ChapValue
Account Type	String	Required	0

Swap Equipment

This action updates the device associated with a service on the switch.

Parameters:

Name	Type	Required	Notes
Base URL	String	Required	Base URL for FreeRADIUS switch
MDN	String	Required
MIN	String	Optional
Serial Number	String	Required	Serial number of the device
Device Type	String	Required
ICCID	String	Required
A12Chap	String	Required
Account Type	String	Required

Swap Equipment Example

An example of the parameters included in a Swap Equipment command.

Parameters:

Name	Type	Required	Example Value
Base URL	String	Required	http://example.api.website
MDN	String	Required	123456789
MIN	String	Required	987654321
Serial Number	String	Required	00001850610
Device Type	String	Required	4G
ICCID	String	Required	89015816051600026495
A12Chap	String	Required	A12ChapValue
Account Type	String	Required	0

Updated on February 25, 2025

Tagged: Provisioning

Was this article helpful?

Yes No

About The Author

Jim Hart

Jim is a Product Manager who has been with IDI since 2020. Questions or comments on this article can be sent to jhart@idibilling.com.