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 Configuration - User Management API

User Group/End User/PCG/PPSK Classification

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

This API exposes 23 operations across 14 paths, and defines 54 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.

23 operations 14 paths 54 schemas 4 DELETE7 GET9 POST3 PUT

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 Configuration - User Management API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 23

Across 14 paths, the API surfaces 23 operations — 4 DELETE, 7 GET, 9 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Configuration - User Management 23

User Group/End User/PCG/PPSK Classification

GET
/email-templates
List Email templates
listEmailTemplates 1 param → 200default
GET
/sms-templates
List SMS templates
listSmsTemplates 1 param → 200default
GET
/endusers
List end users
listEndUsers 4 params → 200default
POST
/endusers
Create an end user
createEndUser body → 200default
PUT
/endusers/{id}
Update an end user
updateEndUser 1 param body → 200default
DELETE
/endusers/{id}
Delete end user by ID
deleteSsidUser 1 param → 200default
POST
/endusers/{id}/:regenerate-password
Regenerate a new password for the end user
regenerateEndUserPassword 1 param → 200default
GET
/usergroups
List user groups
listUserGroups 4 params → 200default
POST
/usergroups
Create user group
createUserGroup body → 200default
PUT
/usergroups/{id}
Update user group
updateUserGroup 1 param body → 200default
DELETE
/usergroups/{id}
Delete user group by ID
deleteUserGroup 1 param → 200default
GET
/pcgs/key-based
List Key-based Private Client Groups
listKeyBasedPrivateClientGroups → 200default
POST
/pcgs/key-based
[LRO] Create a Key-based Private Client Group
setupKeyBasedPrivateClientGroupNetworkPolicy 1 param body → 200default
POST
/pcgs/key-based/network-policy-{policyId}/:onboard
[LRO] Create Key-based PCG in network policy
onboardKeyBasedPrivateClientGroup 2 params body → 200default
DELETE
/pcgs/key-based/network-policy-{policyId}
Delete Private Client Group from a network policy
deletePcg 2 params → 202default
GET
/pcgs/key-based/network-policy-{policyId}/users
Get users for a PCG-enabled network policy
getKeyBasedPcgUsers 1 param → 200default
POST
/pcgs/key-based/network-policy-{policyId}/users
[LRO] Add users to a PCG-enabled network policy
addKeyBasedPcgUsers 2 params body → 200default
PUT
/pcgs/key-based/network-policy-{policyId}/users
Replace all users in a PCG-enabled network policy
updateKeyBasedPcgUsers 1 param body → 202default
DELETE
/pcgs/key-based/network-policy-{policyId}/users
Delete users from a PCG-enabled network policy
deleteKeyBasedPcgUsers 1 param body → 202default
GET
/pcgs/key-based/network-policy-{policyId}/port-assignments
Get device port assignments in network policy
getPortAssignments 1 param → 200default
POST
/pcgs/key-based/network-policy-{policyId}/port-assignments
Assign ports to devices in network policy
assignPorts 1 param body → 200default
POST
/pcgs/key-based/network-policy-{policyId}/keys/:generate
Generate shared keys for users in network policy
generateKeys 2 params → 202default
POST
/pcgs/key-based/network-policy-{policyId}/keys/:email
Send keys to users in network policy via Email
emailKeys 2 params → 202default

Schemas 54

The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are XiqUpdateUserGroupRequest (13 properties), XiqCreateUserGroupRequest (13 properties), XiqCreateEndUserRequest (12 properties), XiqUpdateEndUserRequest (10 properties). Each schema is shown below with its type and property counts.

XiqDeliverySettings
object
The password delivery settings
2 properties
XiqPskGenerationMethod
string
The psk generation method
XiqPcgAssignPortsResponse
object
The response of assign ports for AP150W
3 properties 3 required
XiqValidDailySettings
object
The settings for Valid Daily option or null for other settings.
4 properties 4 required
XiqPcgPortAssignmentEntryDetail
XiqExpirationActionType
string
The Expiration Action to take, null if the account is never expired.
XiqPcgPortAssignmentEntryEthUserMeta
XiqPasswordSettings
object
The password settings ID
7 properties 3 required
XiqUpdateUserGroupRequest
object
13 properties 6 required
XiqCreateUserGroupRequest
object
13 properties 6 required
XiqValidTimePeriodAfterIdCreation
object
The settings for the valid time period after ID Creation option or null for the other option
2 properties 2 required
XiqDeleteKeyBasedPcgUsersRequest
object
The payload of delete Key Based Private Client Group users request
1 property 1 required
XiqPasswordType
string
The access key type
XiqPcgPortAssignmentEntryDeviceMeta
XiqCreateEndUserRequest
object
12 properties 2 required
XiqRegenerateEndUserPasswordResponse
object
The newly generated password for the end user
1 property 1 required
XiqKeyBasedPcgUserBaseInfo
object
The user's base info
3 properties 3 required
XiqPostExpirationAction
object
The type of action to take after the account expiration.
4 properties
XiqEndUser
XiqCreateKeyBasedPcgNetworkPolicyRequest
object
The request to initiate Key-based Private Client Group
3 properties 3 required
XiqErrorParams
object
Error parameters
2 properties
XiqPcgPortAssignment
object
The PCG port assignment entry
4 properties 1 required
XiqBaseEntity
object
3 properties 3 required
XiqValidDuringDateSettings
object
The settings for Valid During Dates option or null for other settings.
3 properties 3 required
XiqExpirationType
string
The for one of the account expiration types.
XiqKeyBasedPcgUser
XiqDateTimeUnitType
string
The after expiration scheduled time unit.
XiqError
object
6 properties 3 required
XiqUpdateEndUserRequest
object
10 properties
XiqKeyBasedPcg
XiqGetPortAssignmentDetailsResponse
object
The response of port assignment details for AP150W
3 properties 2 required
PagedXiqEndUser
XiqPage
object
4 properties 4 required
XiqValidForTimePeriodSettings
object
The settings for Valid For Time Period option or null for other settings.
3 properties 1 required
XiqAddKeyBasedPcgUsersToNetworkPolicyResponse
object
Add users to a PCG-enabled network policy
3 properties
XiqPcgType
string
The private client group type for pcgUseOnly
XiqCreateKeyBasedPcgUsersRequest
object
The payload of add Key-based Private Client Group users request
1 property 1 required
XiqUpdateKeyBasedPcgUsersRequest
object
The payload of replace Key-based Private Client Group users request
1 property 1 required
PagedXiqUserGroup
XiqUserGroup
XiqSmsTemplate
XiqViqEntity
XiqOnboardKeyBasedPcgResponse
object
Add users to a PCG-enabled network policy
3 properties
XiqExpirationSettings
object
The password expiration settings
6 properties
XiqCreateKeyBasedPcgNetworkPolicyResponse
XiqOnboardKeyBasedPcgRequest
object
The payload to create Key Based PCG data(from exist network policy and SSID)
3 properties 3 required
XiqValidTimePeriodAfterFirstLogin
object
The settings for the valid time period after First Login option or null for the other option
4 properties 4 required
XiqPcgPortAssignmentEntry
XiqPcgAssignPortsRequest
object
The payload to assign ports for AP150W
1 property 1 required
XiqEmailTemplate
XiqPasswordDbLocation
string
The access key storage location
XiqDateTimeType
object
The end date and time
5 properties 5 required
XiqValidTimePeriodAfterType
string
The valid time period after Id creation or first login.
XiqPasswordCharacterType
string
Password generation using letters, numbers, and/or special characters

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-configuration-user-management-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