Lastline RADIUS API

The Lastline RADIUS API is accessible at:

https://user.lastline.com/papi/radius/<function>

The Lastline RADIUS API is used to authenticate to a RADIUS server. It can also be used to configure an appliance to perform RADIUS authentication requests.

Additional information about this API and configuration can be found in the RADIUS integration guide.

Requirements

RADIUS api is only available on Lastline Enterprise/Analyst On-Premise version 7.3 or above.

Methods

Method Index

Method Documentation

radius.config_radius_server(response_format)

Configure an appliance to perform authentication through a RADIUS server.

On Premise Availability
This method is available on Lastline Enterprise/Analyst On-Premise version 7.3 or above.
URL

/papi/radius/configure[. response_format]

response_format can be xml or json (defaults to json)

HTTP METHOD
POST
POST Parameters
  • appliance_uuid:

    The UUID of the appliance that will be configured to use the RADIUS server. (Required)

  • enabled:

    Boolean that indicates whether or not to enable/disable the RADIUS sign on. Disabled the RADIUS sign on will store previous configuration settings. When enabling the RADIUS configuration for the first time, all other parameters are required. (Required)

  • server_type:

    The type of RADIUS server. Currently this can only be one of the following values:

    • ‘freeradius’
    • ‘other’
  • server:

    The hostname or IP of the RADIUS server. Note: it MUST be reachable from the configured appliance.

  • auth_port:

    The authorization port of the RADIUS server.

  • secret:

    The shared secret of the RADIUS server for the configured appliance to use for authentication.

  • nas_identifier:

    The identifier of the NAS to be used to inform the RADIUS server where the request is coming from. In this case, the NAS is the configured appliance.

Error Codes

Contents of successful response

  • authenticated_username:

    The authenticated username that the RADIUS server validated.

radius.user_auth(response_format)

Authenticate the user through a configured RADIUS server.

On Premise Availability
This method is available on Lastline Enterprise/Analyst On-Premise version 7.3 or above.
URL

/papi/radius/user/auth[. response_format]

response_format can be xml or json (defaults to json)

HTTP METHOD
POST
POST Parameters
  • username:

    The username to be authenticated by the RADIUS server.

  • password:

    The password that will be used to authenticate the username by the RADIUS server.

Error Codes

Contents of successful response

  • authenticated_username:

    The authenticated username that the RADIUS server validated.

Error Codes

The Lastline API uses error-codes for reporting errors. Errors related to authentication or general mis-use of the API are documented below. Additionally, each API module provides error-codes for module-specific errors.

radius.LLAPI_ERROR__AUTHENTICATION_ERROR

Error code 3004: Returned when requesting results with invalid credentials.

radius.LLAPI_ERROR__UNSUPPORTED_FEATURE

Error code 3010: Returned when the appliance does not support the RADIUS authentication module.

radius.LLAPI_ERROR__INVALID_PARAMETER

Error code 3005: Returned when sending a request with an invalid parameter.

radius.LLAPI_RADIUS_ERROR__SERVER_TIMEOUT

Error code 16001: Returned when the connection to the RADIUS server could not be successfully made or the connection timed out.

radius.LLAPI_RADIUS_ERROR__DICTIONARY_ENCODING_ERROR

Error code 16002: Returned when values could not be encoded properly using the RADIUS dictionary configured.

radius.LLAPI_APPLIANCE_MGMT_ERROR__NO_SUCH_APPLIANCE

Error code 9001: Returned when an operation is requested on an appliance that does not exist.