Extreme Networks Configuration - Authentication API
AD/LDAP/RADIUS/RADSEC/CWP/...
Extreme Networks Configuration - Authentication API is one of 52 APIs that Extreme Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Configuration - Authentication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 34 operations across 16 paths, and defines 62 schemas. It is described by OpenAPI 3.0.3, at version 25.9.0-36.
Requests are made against a single base URL, https://api.extremecloudiq.com.
34 operations
16 paths
62 schemas
6 DELETE16 GET6 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Extreme Networks Configuration - Authentication API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuth).
BearerAuth— JSON Web Token (JWT) based authentication
Paths & Operations 34
Across 16 paths, the API surfaces 34 operations — 6 DELETE, 16 GET, 6 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
Configuration - Authentication 34
AD/LDAP/RADIUS/RADSEC/CWP/...
GET
/ad-servers
List active directory servers
GET
/cwps
List captive web portals
GET
/ldap-servers
List LDAP servers
POST
/ldap-servers
Create LDAP server
GET
/ldap-servers/{id}
Get LDAP server by ID
PUT
/ldap-servers/{id}
Update LDAP server configuration
DELETE
/ldap-servers/{id}
Delete a LDAP server
GET
/radius-client-objects
List RADIUS client objects
POST
/radius-client-objects
Create RADIUS client object configuration
GET
/radius-client-objects/{id}
Get RADIUS client object by ID
PUT
/radius-client-objects/{id}
Update RADIUS client object configuration
DELETE
/radius-client-objects/{id}
Delete a RADIUS client object configuration
GET
/radius-proxies
List RADIUS proxies
POST
/radius-proxies
Create RADIUS proxy configuration
GET
/radius-proxies/{id}
Get the RADIUS proxy configuration
PUT
/radius-proxies/{id}
Update RADIUS proxy configuration
DELETE
/radius-proxies/{id}
Delete the RADIUS proxy configuration
GET
/radius-proxies/devices
List Radius proxy devices
GET
/radius-servers/internal
List all internal RADIUS servers
POST
/radius-servers/internal
Create internal RADIUS server configuration
GET
/radius-servers/internal/{id}
Get internal RADIUS server by ID
PUT
/radius-servers/internal/{id}
Update internal RADIUS server configuration
DELETE
/radius-servers/internal/{id}
Delete internal RADIUS server configuration
GET
/radius-servers/internal/devices
List all internal RADIUS devices
GET
/radius-servers/external
List external RADIUS servers
POST
/radius-servers/external
Create external RADIUS server configuration
GET
/radius-servers/external/{id}
Get external RADIUS server by ID
PUT
/radius-servers/external/{id}
Update external RADIUS server configuration
DELETE
/radius-servers/external/{id}
Delete external RADIUS server configuration
GET
/radsec-proxies
List RADSEC proxies
POST
/radsec-proxies
Create RADSEC proxy configuration
GET
/radsec-proxies/{id}
Get the RADSEC proxy configuration
PUT
/radsec-proxies/{id}
Update RADSEC proxy configuration
DELETE
/radsec-proxies/{id}
Delete the RADSEC proxy configuration
Schemas 62
The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are XiqCreateInternalRadiusServerRequest (21 properties), XiqUpdateInternalRadiusServerRequest (19 properties), XiqCreateLdapServerRequest (15 properties), XiqUpdateLdapServerRequest (14 properties). Each schema is shown below with its type and property counts.
XiqInternalRadiusServer
XiqCertBundleType
string
The type of Certificate Bundle.
XiqRadiusClientObjectType
string
The entry server type: INTERNALRADIUSSERVER, EXTERNALRADIUSSERVER, INTERNALRADIUSPROXY
PagedXiqLdapServer
XiqActiveDirectoryServerBaseDnFetchMode
string
The base DN fetch mode of active directory server
XiqUpdateInternalRadiusServerRequest
object
19 properties
11 required
XiqUpdateRadiusProxyRequest
object
The payload to update RADIUS proxy
9 properties
PagedXiqExternalRadiusServer
XiqInternalRadiusServerAuthenticationMethod
string
The default authentication method
XiqUpdateRadiusClient
object
The associate RADIUS client for RADIUS proxy
4 properties
XiqCreateRadsecProxyRequest
object
The payload to create a new RADSEC proxy.
7 properties
2 required
XiqUpdateRadiusProxyRealm
object
The associate RADIUS proxy realm for RADIUS proxy
4 properties
XiqUpdateExternalRadiusServerRequest
object
8 properties
4 required
XiqRadiusClient
object
The associate RADIUS client for RADIUS proxy
4 properties
XiqLdapServerVerificationMode
string
The LDAP server verification mode
PagedXiqActiveDirectoryServer
XiqRadsecProxyRealm
object
The RADSEC proxy realm definition
3 properties
XiqCreateRadiusProxyRealm
object
The associate RADIUS proxy realm for RADIUS proxy
3 properties
XiqCreateRadiusClientObjectRequest
object
8 properties
7 required
XiqRadiusClientObjectEntry
object
The entry of RADIUS client object
3 properties
3 required
XiqInternalRadiusServerAuthenticationMethodGroup
string
The authentication group
XiqRadiusProxyRealm
object
The associate RADIUS proxy realm for RADIUS proxy
4 properties
XiqErrorParams
object
Error parameters
2 properties
XiqUpdateLdapServerRequest
object
14 properties
XiqCertificate
XiqCwp
XiqExternalUserDirectory
object
The setting for external user directory, AD or LDAP
8 properties
8 required
XiqCertificateBundle
XiqServerRole
string
The server role, PRIMARY or BACKUP
XiqExternalUserDirectoryEntry
object
The payload of common object - External User Directory Entry
2 properties
2 required
XiqCreateInternalRadiusServerRequest
object
21 properties
13 required
XiqBaseEntity
object
3 properties
3 required
XiqRadiusServerType
string
The port type of the RADIUS server, can only be either ACCOUNTING, AUTHENTICATION, or BOTH
PagedXiqRadiusProxy
XiqCreateLdapServerRequest
object
15 properties
10 required
PagedXiqInternalRadiusServer
XiqRadiusAccessType
string
The access type of the External RADIUS server, an External RADIUS server with type 'SECURE' is a RADSEC server. This field cannot be changed after it is set.
XiqError
object
6 properties
3 required
XiqRadiusProxyFormatType
string
The format type of RADIUS proxy
XiqRadiusClientObject
XiqActiveDirectoryServer
XiqLdapProtocolType
string
LDAP server protocol type
XiqCreateRadiusProxyRequest
object
The payload to create a new RADIUS proxy
10 properties
7 required
XiqExternalUserDirectoryType
string
The external user directory type
XiqRadsecOperatorNameType
string
The operator name type of a RADSEC proxy.
XiqUpdateRadsecProxyRequest
object
The payload to update RADSEC proxy
6 properties
XiqPage
object
4 properties
4 required
XiqRadiusProxy
XiqInternalRadiusDevice
XiqCertificateType
string
PagedXiqInternalRadiusDevice
XiqViqEntity
PagedXiqRadiusClientObject
XiqRadsecProxy
PagedXiqRadsecProxy
XiqRadsecNameFormatType
string
The name format type of a RADSEC proxy.
PagedXiqCwp
XiqCreateExternalRadiusServerRequest
object
10 properties
5 required
XiqLdapServer
XiqUpdateRadiusClientObjectRequest
object
7 properties
6 required
XiqCreateRadiusClient
object
The associate RADIUS client for RADIUS proxy
3 properties
XiqExternalRadiusServer
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Extreme Networks 12
Other APIs Extreme Networks publishes across the network.
ExtremeCloud IQ Controller REST API Gateway
ExtremeCloud IQ Controller Application Manager API
Ansible Network Collection for Extreme EXOS
Ansible Network Collection for Extreme VOSS
Ansible Network Collection for Extreme SLX-OS
Ansible Network Collection for Extreme NOS
Ansible Network Collection for Extreme Fabric Engine
Extreme Networks Account API
Extreme Networks Administration API
Extreme Networks AFC API
Extreme Networks Alert API
Extreme Networks Application API
#Configuration - Authentication