Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extreme Networks User API

Local and external user management in ExtremeCloud IQ account

Extreme Networks User 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 User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 16 operations across 10 paths, and defines 17 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.

16 operations 10 paths 17 schemas 2 DELETE5 GET2 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
25.9.0-36
Base URL
https://api.extremecloudiq.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Extreme Networks User API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 16

Across 10 paths, the API surfaces 16 operations — 2 DELETE, 5 GET, 2 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

User 16

Local and external user management in ExtremeCloud IQ account

GET
/users
List all users
listUsers 2 params → 200default
POST
/users
Create new user
createUser body → 201default
GET
/users/me
Get current user info
getCurrentUser → 200default
GET
/users/{id}
Get user info by ID
getUser 1 param → 200default
PATCH
/users/{id}
Update user info
updateUser 1 param body → 200default
DELETE
/users/{id}
Delete user by ID
deleteUser 1 param → 200default
GET
/users/external
List external access users
listExternalUsers 2 params → 200default
POST
/users/external
Grant external access
grantExternalUser body → 200default
GET
/users/external/{id}
Get external access info
getExternalUser 1 param → 200default
PATCH
/users/external/{id}
Update external access info
updateExternalUser 1 param body → 200default
DELETE
/users/external/{id}
Revoke external access
revokeExternalUser 1 param → 200default
POST
/users/grid
List users
list_users 7 params body → 200default
POST
/users/filter_metadata
List user grid filter metadata
listUserGridFilterMetadata body → 200default
POST
/users/type_distribution
Get user type distribution
getUserTypeDistribution body → 200default
POST
/users/data_usage
Get user data usage
getUserDataUsage body → 200default
POST
/users/grid_export
Export user grid
exportUserGridToCsv 5 params body → 202default

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are RmUsers (13 properties), XiqError (6 properties), number_filter (5 properties), XiqPage (4 properties). Each schema is shown below with its type and property counts.

XiqSortOrder
string
RmUsers
object
13 properties
XiqGrantExternalUserRequest
object
4 properties 2 required
RmPagedUsers
PagedXiqExternalUser
XiqUser
XiqErrorParams
object
Error parameters
2 properties
XiqUpdateUserRequest
object
4 properties
number_filter
object
If the filter type is between, only then min and max are to be used, else value is to be used.
5 properties
XiqExternalUser
PagedXiqUser
XiqBaseEntity
object
3 properties 3 required
XiqError
object
6 properties 3 required
XiqPage
object
4 properties 4 required
XiqUpdateExternalUserRequest
object
3 properties
XiqCreateUserRequest
object
4 properties 3 required
XiqUserRole
string
The user administrative role.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-user-api-openapi.yml Raw ↑

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