Get Interface Authentication Status for Element (v2.0)

GET 
/sdwan/v2.0/api/elements/:element_id/interface_authentication/status

List all the interface authentication status for an element.

Request

Path Parameters

element_id stringrequired

The element ID.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

items InterfaceAuthenticationState[]
Array [
authorized boolean
The interface authentication state authorization.
client_details ClientDetails[]
The client details.
Array [
aging_timeout integer
The aging timeout value.
auth_type string
The authentication type. Only closed mode and single host authentication is supported.
element_id string
The element ID.
interface_id string
The interface ID.
mac_address string
The MAC address.
reauth_timeout integer
The re-auth timeout.
reauthentication_timeout integer
The ION device authenticates or reinitializes the client after a session timeout based on the value of the Termination-Action. Values 1 and 0.
stats_start_time_ms int64
The stats start time in milliseconds.
uptime int64
Indicates the time for which the neighbor has been up.
username string
The client user name.
vlan_id integer
The virtual LAN ID.
]
eapol_recvd_version integer
The eapol recieved version.
eapol_src_mac_address string
The eapol src mac address.
element_id string
The element ID.
id string
The ID.
interface_id string
The interface ID.
operational_state string
The operational state.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "items": [
    {
      "authorized": true,
      "client_details": [
        {
          "aging_timeout": 0,
          "auth_type": "string",
          "element_id": "string",
          "interface_id": "string",
          "mac_address": "string",
          "reauth_timeout": 0,
          "reauthentication_timeout": 0,
          "stats_start_time_ms": 0,
          "uptime": 0,
          "username": "string",
          "vlan_id": 0
        }
      ],
      "eapol_recvd_version": 0,
      "eapol_src_mac_address": "string",
      "element_id": "string",
      "id": "string",
      "interface_id": "string",
      "operational_state": "string"
    }
  ]
}

404

Not Found

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INTERFACE_AUTHENTICATION_STATE_NOT_FOUND"
      }
    ]
  }
}

Loading...