The identity and technical contract details declared by the specification.
XiqL3AddressType
string
Address type
XiqUpdateRpNeighborhoodAnalysisRequest
object
5 properties
XiqExpirationActionType
string
The Expiration Action to take, null if the account is never expired.
XiqIotpMaBleScanApplication
object
The BLE Scan application
XiqRecurrenceType
string
The schedule recurrence type.
XiqHsNaiRealm
object
The Network Access Identification (NAI) realm.
4 properties
1 required
XiqHttpServer
object
3 properties
1 required
XiqIpFirewallAction
string
XiqSsidDot1xEncryptionMethod
string
The encryption method: for WPA8021X, WPA28021X, please use CCMP or TKIP, for AUTO8021X, please use AUTOTKIPCCMP, for WPA38021X, please use AES192
XiqHsRoamingConsortium
object
The Roaming Consortium network provider.
2 properties
1 required
XiqIotpMaBleScan
object
2 properties
XiqHsIpv6Type
string
The IPv6 address availability enum.
XiqClientMonitorSetting
object
The client monitor setting
3 properties
XiqCreateUserProfileAssignmentRequest
object
4 properties
XiqHsWanLinkStatus
string
The WAN metric status.
XiqIotpMaBleBeaconApplication
object
The BLE Beacon application
XiqSetSsidModePpskRequest
object
The request for setting the SSID to be PPSK mode.
8 properties
5 required
XiqIotpMaBleScanIBeacon
object
3 properties
1 required
XiqExpirationType
string
The for one of the account expiration types.
XiqHsConnectionCapabilityStatus
string
Connection capability status.
XiqIotApplicationSupported
string
IoT profile supported type.
XiqUpdateRpSensorScanSettingsRequest
object
3 properties
XiqHsVenue
object
Venue information helps client devices understand the type and nature of the location where the Wi-Fi network is deployed.
3 properties
XiqMacObjectType
string
Mac Object type
XiqUpdateRpRadioUsageOptimizationRequest
object
35 properties
XiqWildcardAddressProfile
XiqSsidDot1xKeyManagement
string
The key management: WPA8021X, WPA28021X, WPA38021X or AUTO8021X
XiqLoggingType
string
Firewall Rule Logging type
XiqApplicationDetectionRule
object
The Application Detection Rule
3 properties
XiqWirelessIfName
string
The one or multiple ssid on wifi interfaces (example:wifi0 or wifi1) to be disabled/enabled, cannot be empty or no SSID will be disabled or enabled.
PagedXiqClassificationRule
XiqSsidPskEncryptionMethod
string
The encryption method: for WPA3PSK please use CCMP, for WPA2PSK or WPAPSK, please use CCMP or TKIP, for AUTOPSK, please use AUTOTKIPCCMP
XiqDateTimeType
object
The end date and time
5 properties
5 required
XiqRpMiscellaneousSettings
XiqValidTimePeriodAfterType
string
The valid time period after Id creation or first login.
XiqIotpTgWhiteListEntry
object
2 properties
2 required
PagedXiqUserProfileAssignment
XiqCreateUserProfileRequest
object
2 properties
2 required
XiqSsidWepEncryptionMethod
string
The encryption method type, WEP104 or WEP40
XiqHostNameAddressProfile
XiqSetSsidModeWepRequest
object
The request for setting the SSID to be WEP mode.
10 properties
2 required
XiqClassificationType
string
Classification type
XiqAttachUPAssignmentRequest
object
6 properties
XiqPasswordSettings
object
The password settings ID
7 properties
3 required
PagedXiqHotspotServiceProviderProfile
XiqRpNeighborhoodAnalysis
XiqUpdateL3AddressProfileRequest
object
7 properties
XiqErrorParams
object
Error parameters
2 properties
XiqIotpMaBleBeaconAppType
string
The BLE Beacon application type.
XiqUpdateRpChannelSelectionRequest
object
21 properties
XiqHsWanMetrics
object
Hotspot WAN (Wide Area Network) metrics.
3 properties
3 required
XiqError
object
6 properties
3 required
XiqHsNaiEncodingType
string
The NAI realm encoding type.
XiqSetSsidModePskRequest
object
The request for setting the SSID to be PSK mode.
7 properties
4 required
XiqAttachMacFirewallRuleToMacFirewallPolicy
object
4 properties
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
XiqUserProfileAssignmentRule
XiqHsQosMap
object
2 properties
XiqUpdateClassificationRuleRequest
object
3 properties
2 required
XiqHotspotServiceProviderProfileRequest
object
The Hotspot Service Provider profile.
10 properties
1 required
XiqDeviceRadioBand
string
Radio Interface Bands
XiqIotpMaBleScanGeneric
object
3 properties
1 required
XiqUserProfileAssignmentRadiusAttribute
XiqIotProfileRequest
object
The IoT Profile
XiqHotspotProfileRequest
object
The Hotspot profile.
19 properties
2 required
XiqIotpMaBleScanEddystoneUrl
object
2 properties
1 required
XiqUpdateRpMacOuiProfileRequest
object
5 properties
XiqMacFirewallPolicyRequest
object
3 properties
3 required
XiqIotpMaBleScanAppType
string
The BLE Scan application type.
XiqHsLanguageCode
string
Language code (3B abbreviation) found at: http://www.loc.gov/standards/iso639-2/ISO-639-2utf-8.txt.
XiqIpFirewallRuleRequest
object
5 properties
XiqClientMonitorProfileRequest
XiqIotApplicationId
string
IoT application identifiers.
XiqHsConnectionCapability
object
The connection capability informs client devices about available network services. Used to identify the IP protocols that are permitted or denied on the networ…
3 properties
3 required
XiqDetachMacFirewallRequest
object
2 properties
1 required
XiqDeliverySettings
object
The password delivery settings
2 properties
XiqHsIpv4Type
string
The IPv4 address availability enum: NOTAVAILABLE - No IPv4 address is available. PUBLIC - A publicly routable IPv4 address is available. PORTRESTRICTED - An IP…
XiqValidDailySettings
object
The settings for Valid Daily option or null for other settings.
4 properties
4 required
XiqRadioMode
string
The supported radio modes.
XiqHsAccessNetworkType
string
The Hotspot profile Access Network: PRIVATE - An enterprise network with user accounts. PRIVATEWITHGUEST - An enterprise network providing guest access. CHARGE…
XiqRpRadioUsageOptimization
XiqUpdateRpMiscellaneousSettingsRequest
object
2 properties
XiqHsVenueType
string
The venue type ID further specifies the particular kind of location within the general venue group. Each venue type ID must match the venue group ID to accurat…
XiqHsOsuNetworkAuthType
string
The Network Authentication type for Hotspot profiles: ACCEPTANCETERMS - Indicate that the network requires the user to accept terms and conditions. ONLINESIGNU…
XiqNetworkServiceRequest
object
Network
6 properties
XiqPostExpirationAction
object
The type of action to take after the account expiration.
4 properties
XiqUpdateMacObjectRequest
object
4 properties
XiqAttachIpFirewallRuleToIpFirewallPolicy
object
5 properties
XiqHsVenueGroup
string
The venue group ID categorizes the general type of location.
XiqSsidWepAuthenticationMethod
string
The authentication method type, OPEN or SHARED
XiqHsspOsuMethod
string
OSU protocols supported by the Service Provider: OMADM - Set OSU provider support of the OMA DM (Open Mobile Alliance Device Management) protocol. SOAPXMLSPP -…
XiqHsLocalizedName
object
A language specific name.
2 properties
1 required
XiqIotpMaBleBeacon
object
1 property
XiqCreateRadioProfileRequest
object
11 properties
1 required
XiqSsidEncryptionMethod
string
XiqValidDuringDateSettings
object
The settings for Valid During Dates option or null for other settings.
3 properties
3 required
XiqCreateMacObjectRequest
object
5 properties
3 required
XiqUpdateCloudConfigGroupRequest
object
3 properties
XiqWildcardHostNameAddressProfile
XiqCreateClassificationRequest
object
The details of rule assignments
3 properties
3 required
XiqUpdateRadioProfileRequest
object
11 properties
XiqUpdateSsidAdvancedSettingsRequest
object
1 property
XiqDeviceRadioOperatingMode
string
Modern AP hardware types include dual or triple band radios. A limited subset of band combinations are supported. Operating mode defines the supported band com…
XiqPcgType
string
The private client group type for pcgUseOnly
XiqIpFirewallRuleId
object
1 property
1 required
XiqSsidPpskKeyManagement
string
The key management: WPA2PSK, WPAPSK, AUTOPSK
XiqAttachMacFirewallRequest
object
2 properties
2 required
XiqCreateCloudConfigGroupRequest
object
3 properties
1 required
XiqSsidWepKeyManagement
string
The key management type, WEP or WEP8021X
XiqValidTimePeriodAfterFirstLogin
object
The settings for the valid time period after First Login option or null for the other option
4 properties
4 required
XiqHsOnlineSignup
object
The Hotspot profile Online Signup settings.
3 properties
1 required
XiqPasswordCharacterType
string
Password generation using letters, numbers, and/or special characters
XiqCreateRpMacOuiProfileRequest
object
5 properties
2 required
XiqIpFirewallPolicyRequest
object
3 properties
3 required
XiqMacFirewallAction
string
XiqPskGenerationMethod
string
The psk generation method
XiqHsspIconFile
object
The OSU registration server icon according to language mode.
3 properties
2 required
XiqDetachIpFirewallRequest
object
2 properties
1 required
XiqNetworkIpProtocol
string
XiqHsConnectionCapabilityProtocol
string
Hotspot Connection Capability protocol.
XiqAttachIpFirewallRequest
object
2 properties
2 required
XiqSsidSaeGroup
string
The SAE group: ALL, ECC, or FFC, must be selected when the key management is WPA3
XiqValidTimePeriodAfterIdCreation
object
The settings for the valid time period after ID Creation option or null for the other option
2 properties
2 required
XiqIotProfileMultiApplication
object
4 properties
2 required
XiqPasswordType
string
The access key type
XiqUserProfileAssignmentEntry
object
2 properties
XiqIotpMaBleScanVendor
object
3 properties
1 required
XiqClientMonitorParameters
object
The client monitor setting parameters
2 properties
XiqHsEapMethod
string
The Extensible Authentication Protocol (EAP) method.
XiqApplicationDetectionProtocol
string
XiqApplicationDetectionType
string
PagedXiqClientMonitorProfile
XiqScheduleType
string
The schedule type.
XiqDetachUPAssignmentRequest
object
1 property
XiqBaseEntity
object
3 properties
3 required
XiqSsidKeyManagement
string
XiqMacFirewallRuleRequest
object
4 properties
XiqHotspotServiceProviderProfile
XiqDateTimeUnitType
string
The after expiration scheduled time unit.
XiqUpdateRpWmmQosSettingsRequest
object
5 properties
XiqIotProfileThreadGateway
object
4 properties
2 required
XiqSsidPskKeyManagement
string
The key management: WPA3PSK, WPA2PSK, WPAPSK,AUTOPSK
XiqMacFirewallRuleId
object
1 property
1 required
XiqDeviceInterfaceRadioMode
object
Device Radio Interface Band.
3 properties
3 required
XiqSsidWepDefaultKey
string
The default key, FIRST, SECOND,THIRD, OR FOURTH
XiqIotpMaBleBeaconEddystoneUrl
object
5 properties
2 required
XiqCreateClassificationRuleRequest
object
3 properties
2 required
XiqHsQosAhClassToDscpRange
object
ahclass to DSCP range. The DSCP range for each user priority is non-overlapping. The end value for the DSCP range must be greater than or equal to the start va…
3 properties
3 required
XiqIotpMaBleScanVendorType
string
The BLE Scan Vendor types for BLE Scan applications.
XiqDeviceRadioModesSettings
array
Device Radio Operating Mode settings based on AP Model.
XiqUpdateUserProfileRequest
object
2 properties
XiqHsCellularNetwork
object
The 3GPP cellular network.
3 properties
2 required
XiqTraffic
string
The Firewall traffic direction.
XiqIotpMaBleBeaconIBeacon
object
7 properties
4 required
XiqIotpMaBleScanDestination
object
The BLE Scan destination.
1 property
XiqHsQosDscpException
object
A DSCP priority to map to an Extreme QoS class that is different than the class mapped to the DSCP range in which the DSCP priority already exists.
2 properties
2 required
XiqSsidKeyType
string
The key type, ASCII or HEX
XiqExpirationSettings
object
The password expiration settings
6 properties
XiqUpdateClassificationRequest
object
The details of rule Rules
3 properties
3 required
XiqVlanObjectClassifiedEntry
XiqRadiusClientProfileEntry
XiqCreateL3AddressProfileRequest
object
9 properties
2 required
XiqAddressProfileClassifiedEntry
object
Address profile classified entry
6 properties
XiqPasswordDbLocation
string
The access key storage location
XiqSetSsidModeDot1xRequest
object
The request for setting the SSID to be 802.1x mode and Authentication settings. Authentication with ExtremeCloud IQ Authentication Service and Authentication w…
7 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Extreme Networks publishes across the network.