API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Read existing 802.1X authentication configuration

IEEE 802.1X is an IEEE Standard for port-based Network Access Control (PNAC).
This standard provides an authentication mechanism to devices wishing to attach
to a LAN or WLAN.
IEEE 802.1X defines the encapsulation of the Extensible Authentication Protocol
(EAP) over IEEE 802, which is known as EAP over LAN (EAPOL).

802.1X authentication involves three entities, a supplicant, an authenticator,
and an authentication server.

Supplicant: An entity that wants to get authenticated.
Authenticator: A network device, such as an Ethernet switch that authenticates
the Supplicant.
Authentication Server: Typically a host running software supporting the RADIUS
and EAP protocols that provides an authentication service to an authenticator.

Until the Supplicant is authenticated, 802.1X Authenticator allows only EAPOL
traffic through the port to which the Supplicant is connected.
Only after the authentication is successful, the authenticator allows normal
traffic from the Supplicant.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

LIBRARY - Returns shared objects in library. For LIBRARY, all other parameters listed below, except 'detailed' , will be ignored. LOCAL - Returns configurations for a scope and one or more device function based on parameters below.

string

Retrieves LOCAL or SHARED or both(default) configuration objects.

string

Configuration at a given scope. Mandatory for view-type = LOCAL.

string

Filters configuration specific to given device-function type. If not provided and view_type = LOCAL, then defaults to all device-function's.

boolean

True - Returns effective configuration (i.e hierarchically merged configuration). False - Returns committed configuration at a given scope.

boolean

True - Includes annotations in the returned json to indicate the type of object, scope, and device function. False - Returns only config objects without annotations.

integer

Limit for pagination.

integer

Offset for pagination.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json