What's New

GET /certificates/{certId}/chains

Download Certificate Chain

GET /radiusProfiles/{radiusProfileId}/certificates

Get Certificates Associated with RADIUS

GET /radiusProfiles/{radiusProfileId}/certificateAuthorities

Get Certificate Authorities Associated with RADIUS

GET /entitlements/settings

Query Entitlement Settings

PATCH /entitlements/settings

Update Entitlement Settings

GET /entitlements/licenseUsageReports

Get Entitlement Usage Report

PUT /macRegistrationPools/{id}/policySets/{policySetId}

Update Policy Set for a Registration Pool

DELETE /macRegistrationPools/{id}/policySets/{policySetId}

Delete Policy Set from a Registration Pool

POST /identityGroups/{identityGroupId}/macRegistrationPools

Create a Registration Pool with Identity Group

GET /wifiNetworks/{networkId}/macRegistrationPools

Get MAC Registration Pools by Network

PUT /identityGroups/{id}/policySets/{policySetId}

Update the Policy Set Association for Identity Group

DELETE /identityGroups/{id}/policySets/{policySetId}

Remove the Policy Set Association for Identity Group

GET /tenants/betaFeatures

PUT /tenants/betaFeatures

GET /tenants/privacySettings

Get Configured Privacy Settings

POST /tenants/privacySettings

Clear And Save Privacy Settings

PATCH /tenants/privacySettings

Add Or Update Privacy Settings

GET /venues/{venueId}/switches/{switchId}

Get ICX Switch

PUT /venues/{venueId}/switches/{switchId}

Update ICX Switch

POST /venues/{venueId}/switches/{switchId}

Add ICX Switch

DELETE /venues/{venueId}/switches/{switchId}

Delete ICX Switch

GET /venues/{venueId}/switches/{switchId}/vlans/{vlanId}

Get Switch VLAN

PUT /venues/{venueId}/switches/{switchId}/vlans/{vlanId}

Update Switch VLAN

DELETE /venues/{venueId}/switches/{switchId}/vlans/{vlanId}

Delete Switch VLAN

GET /venues/{venueId}/switches/{switchId}/vePorts/{vePortId}

Get Virtual Ethernet Setting

PUT /venues/{venueId}/switches/{switchId}/vePorts/{vePortId}

Update Virtual Ethernet Setting

DELETE /venues/{venueId}/switches/{switchId}/vePorts/{vePortId}

Delete Virtual Ethernet Setting

GET /venues/{venueId}/switches/{switchId}/staticRoutes/{staticRouteId}

Get Static Route

PUT /venues/{venueId}/switches/{switchId}/staticRoutes/{staticRouteId}

Update Static Route

DELETE /venues/{venueId}/switches/{switchId}/staticRoutes/{staticRouteId}

Delete Static Route

PUT /venues/{venueId}/switches/{switchId}/positions

Update Switch Position

GET /venues/{venueId}/switches/{switchId}/portSettings

Get Ports

PUT /venues/{venueId}/switches/{switchId}/portSettings

Update Port

POST /venues/{venueId}/switches/{switchId}/portSettings

Get Ports

GET /venues/{venueId}/switches/{switchId}/lags/{lagId}

Get LAG

PUT /venues/{venueId}/switches/{switchId}/lags/{lagId}

Update LAG

DELETE /venues/{venueId}/switches/{switchId}/lags/{lagId}

Delete LAG

GET /venues/{venueId}/switches/{switchId}/dhcpServers/{dhcpServerId}

Get DHCP Server-Setting

PUT /venues/{venueId}/switches/{switchId}/dhcpServers/{dhcpServerId}

Update DHCP Server-Setting

DELETE /venues/{venueId}/switches/{switchId}/dhcpServers/{dhcpServerId}

Delete DHCP Server-Setting

PUT /venues/{venueId}/switches/portSettings

Update Ports

POST /venues/{venueId}/switches/portSettings

Get Ports

PUT /venues/{venueId}/switchProfiles/{switchProfileId}

Associate Switch Profile to Venue

DELETE /venues/{venueId}/switchProfiles/{switchProfileId}

Disassociate Switch Profile to Venue

PUT /venues/{venueId}/cliTemplates/{cliTemplateId}

Associate Command-Line Interface Templates to Switches

DELETE /venues/{venueId}/cliTemplates/{cliTemplateId}

Disassociate Command-Line Interface Templates to Switches

GET /templates/venues/{venueId}/switchSettings

Get Venue Template Switch Setting

PUT /templates/venues/{venueId}/switchSettings

Update Venue Template Switch Setting

PUT /templates/venues/{venueId}/switchProfiles/{switchProfileId}

Associate Switch Profile Template to Venue

DELETE /templates/venues/{venueId}/switchProfiles/{switchProfileId}

Disassociate Switch Profile Template to Venue

GET /templates/venues/{venueId}/aaaSettings

Retrieve Venue Template AAA Setting

PUT /templates/venues/{venueId}/aaaSettings

Update Venue Template AAA Setting

PUT /templates/venues/{venueId}/aaaSettings/{aaaSettingId}

Update Venue Template AAA Setting

GET /templates/venues/{venueId}/aaaServers/{aaaServerId}

Get Venue Template AAA Server

PUT /templates/venues/{venueId}/aaaServers/{aaaServerId}

Update Venue Template AAA Server

DELETE /templates/venues/{venueId}/aaaServers/{aaaServerId}

Delete Venue Template AAA Server

GET /templates/switchProfiles/{switchProfileId}

Get Switch Profile Template

PUT /templates/switchProfiles/{switchProfileId}

Update Switch Profile Template

DELETE /templates/switchProfiles/{switchProfileId}

Delete Switch Profile Template

POST /venues/{venueId}/vlans/query

Retrieve Switch VLANs

POST /venues/{venueId}/switches/{switchId}/vlans/query

Query Switch VLANs

GET /venues/{venueId}/switches/{switchId}/vePorts

Retrieve Virtual Ethernet Settings

POST /venues/{venueId}/switches/{switchId}/vePorts

Add Virtual Ethernet Settings

DELETE /venues/{venueId}/switches/{switchId}/vePorts

Delete Virtual Ethernet Settings

POST /venues/{venueId}/switches/{switchId}/vePorts/query

Retrieve Virtual Ethernet Settings

GET /venues/{venueId}/switches/{switchId}/staticRoutes

Get Static Routes

POST /venues/{venueId}/switches/{switchId}/staticRoutes

Add Static Route

DELETE /venues/{venueId}/switches/{switchId}/staticRoutes

Delete Static Routes

GET /venues/{venueId}/switches/{switchId}/lags

Get LAGs

POST /venues/{venueId}/switches/{switchId}/lags

Add LAGs

DELETE /venues/{venueId}/switches/{switchId}/lags

Delete LAGs

POST /venues/{venueId}/switches/{switchId}/dhcpServers

Add DHCP Server

DELETE /venues/{venueId}/switches/{switchId}/dhcpServers

Delete DHCP Servers

POST /venues/{venueId}/switches/{switchId}/dhcpServers/query

Query DHCP Servers

POST /venues/{venueId}/switches/{switchId}/deviceRequests

Sync/Reboot ICX Device

POST /venues/{venueId}/switches/{switchId}/configHistDetails/query

Get Configuration History

GET /venues/{venueId}/switches/{switchId}/configBackups

Get Switch Configuration Backups

POST /venues/{venueId}/switches/{switchId}/configBackups

Add Switch Configuration Backup

DELETE /venues/{venueId}/switches/{switchId}/configBackups

Delete Switch Configuration Backups

POST /venues/{venueId}/switches/{switchId}/configBackups/query

Retrieve Switch Configuration Backups

POST /venues/{venueId}/switches/{switchId}/configBackups/comparisons

Compare Switch Configuration Backups

POST /venues/{venueId}/switches/{switchId}/acls/query

Query Switch ACLs

POST /venues/{venueId}/switches/powerCycleRequests

Power Cycle Port

POST /venues/{venueId}/switches/importRequests

Add Switches

POST /venues/{venueId}/switchFirmwares/schedules

Create Upgrade Schedule

DELETE /venues/{venueId}/switchFirmwares/schedules

Delete Upgrade Schedule

POST /venues/{venueId}/deviceRequests

Create Multiple Device Requests

POST /venues/{venueId}/aaaServers/query

Query AAA Servers

POST /venues/switchFirmwares/upgradeStatusDetails/query

Get Venue Upgrade Statuses

POST /venues/switchFirmwares/switches/schedules/query

Get Switches

POST /templates/venues/{venueId}/aaaServers

Add Venue Template AAA Server

DELETE /templates/venues/{venueId}/aaaServers

Delete Venue Template AAA Servers

POST /templates/venues/{venueId}/aaaServers/query

Query Venue Template AAA Servers

POST /templates/venues/aaaServers/query

Query Venue Template AAA Servers

GET /templates/switchProfiles

Get Switch Profile Templates

POST /templates/switchProfiles

Add Switch Profile Template

DELETE /templates/switchProfiles

Delete Switch Profile Templates

POST /templates/switchProfiles/query

Query Switch Profile Templates

POST /switchFirmwares/schedules/switches/query

Get Switches

POST /switchFirmwares/schedules/query

Get Venues

PATCH /venues/{venueId}/switches/{switchId}/dhcpServerStates

Change Switch DHCP Server State

GET /venues/{venueId}/switches/{switchId}/configBackups/{configBackupId}

Get Switch Configuration Backup

DELETE /venues/{venueId}/switches/{switchId}/configBackups/{configBackupId}

Delete Switch Configuration Backup

PATCH /venues/{venueId}/switches/{switchId}/configBackups/{configBackupId}

Restore Switch Configuration Backup

GET /venues/{venueId}/switches/{switchId}/vlanUnions

Retrieve VLANs

GET /venues/{venueId}/switches/{switchId}/transactions/{transactionId}/configHistDetails

Get Configuration History

GET /venues/{venueId}/switches/{switchId}/acls

Get Switch ACLs

GET /venues/{venueId}/switches/{switchId}/aclUnions

Get ACL Unions

GET /templates/venues/{venueId}/switchProfiles

Get Switch Profile Templates

GET /templates/venues/aaaServers/{aaaServerId}

Get Venue Template AAA Server

DELETE /templates/venues/aaaServers/{aaaServerId}

Delete Venue Template AAA Server

GET /switchFirmwares/versions/{versionType}

Get Versions

GET /switchFirmwares/currentVersions

Get Current Versions

DELETE /venues/{venueId}/stacks/{stackSwitchSerialNumber}

Delete Stack Member

DELETE /templates/venues/aaaServers

Delete Venue Template AAA Servers

POST /venues/{venueId}/signurls/uploadurls

Access Image Upload URL

POST /venues/{venueId}/floorplans/query

Query Floor Plans

GET /venues/{venueId}/signurls/{fileId}/urls

Access Image Download URL

POST /venues/switches/members/query

Query Members of Switches

POST /ethernetPortProfiles

Create Ethernet Port Profile

GET /ethernetPortProfiles/{ethernetPortProfileId}

Get Ethernet Port Profile

PUT /ethernetPortProfiles/{ethernetPortProfileId}

Update Ethernet Port Profile

DELETE /ethernetPortProfiles/{ethernetPortProfileId}

Delete Ethernet Port Profile

PUT /ethernetPortProfiles/{ethernetPortProfileId}/radiusServerProfiles/{radiusServerProfileId}

Activate RADIUS Server Profile On Ethernet Port Profile

DELETE /ethernetPortProfiles/{ethernetPortProfileId}/radiusServerProfiles/{radiusServerProfileId}

Deactivate RADIUS Server Profile On Ethernet Port Profile

POST /venues/apCompatibilities/query

Venue Compatibility Query

POST /venues/aps/apCompatibilities/query

AP Compatibility Query

GET /venues/{venueId}/apModels/{apModel}/lanPortSpecificSettings

Get Venue AP Model LAN Port Specific Settings

PUT /venues/{venueId}/apModels/{apModel}/lanPortSpecificSettings

Update Venue AP Model LAN Port Specific Settings

PUT /venues/{venueId}/apModels/{apModel}/lanPorts/{portId}/ethernetPortProfiles/{ethernetPortProfileId}

Activate Ethernet Port Profile On Venue AP Model LAN Port

DELETE /venues/{venueId}/apModels/{apModel}/lanPorts/{portId}/ethernetPortProfiles/{ethernetPortProfileId}

Deactivate Ethernet Port Profile On Venue AP Model LAN Port

GET /venues/{venueId}/apModels/{apModel}/lanPorts/{portId}/settings

Get Venue AP Model LAN Port Settings

PUT /venues/{venueId}/apModels/{apModel}/lanPorts/{portId}/settings

Update Venue AP Model LAN Port Settings

GET /venues/{venueId}/apRebootTimeoutSettings

Get Venue Reboot Timeout Settings

PUT /venues/{venueId}/apRebootTimeoutSettings

Update Venue Reboot Timeout Settings

GET /venues/{venueId}/aps/{serialNumber}/lanPortSpecificSettings

Get AP LAN Port Specific Settings

PUT /venues/{venueId}/aps/{serialNumber}/lanPortSpecificSettings

Update AP LAN Port Specific Settings

PUT /venues/{venueId}/aps/{serialNumber}/lanPorts/{portId}/ethernetPortProfiles/{ethernetPortProfileId}

Activate Ethernet Port Profile On AP LAN Port

DELETE /venues/{venueId}/aps/{serialNumber}/lanPorts/{portId}/ethernetPortProfiles/{ethernetPortProfileId}

Deactivate Ethernet Port Profile On AP LAN Port

GET /venues/{venueId}/aps/{serialNumber}/lanPorts/{portId}/settings

Get AP LAN Port Settings

PUT /venues/{venueId}/aps/{serialNumber}/lanPorts/{portId}/settings

Update AP LAN Port Settings

POST /wifiFeatureSets/query

Wi-Fi Feature Sets Query

POST /wifiNetworks/apCompatibilities/query

Wi-Fi Network Compatibility Query

POST /assignments

Create multiple assignments

DELETE /assignments

Revoke multiple assignments

PATCH /assignments

Replace multiple assignments

DELETE /venues/{venueId}/aaaServers

Delete AAA Servers

POST /venues/{venueId}/vlans

Add Switch VLANs

POST /venues/{venueId}/switches/{switchId}/vlans

Add Switch VLAN

DELETE /venues/{venueId}/switches/{switchId}/vlans

Delete Switch VLANs

POST /venues/{venueId}/switches

Add ICX Switches

DELETE /venues/{venueId}/switches

Delete ICX Switches

PUT /venues/{venueId}/aaaSettings

Update AAA Setting

POST /switches/vlans

Add Switch VLANs

GET /venues/{venueId}/aaaServers/{aaaServerId}

Get AAA Server-Setting

DELETE /venues/{venueId}/aaaServers/{aaaServerId}

Delete AAA Server

What's Deleted

GET /switches/{switchId}/dhcpServers/leaseTables

Get DHCP Servers Lease Table

POST /switches/{switchId}/debugRequests

Troubleshoot/Debug

GET /switches/{switchId}/debugRequests/{troubleshootingType}

Troubleshoot/Debug

What's Deprecated

GET /mspEntitlements/summaries

Refresh MSP Entitlements

GET /licenseUsageReports

Get Entitlement Usage Report

GET /mspEntitlements

MSP Entitlements

GET /mspBanners

Retrieve MSP Banner Data

GET /assignments

Retrieve Assignments

GET /assignments/summaries

Retrieve Device Type Summary

POST /identities/csvFile

Export the Identities Into a CSV File

POST /identityGroups/{groupId}/identities

Create an Identity Into a Specific Group

DELETE /identityGroups/{groupId}/identities

Delete the Specific Identities in a Group

POST /identityGroups/{groupId}/identities/{id}/devices

Create Devices Into the Identity

POST /identityGroups/{groupId}/identities/csvFile

Import Identities Into the Specified Identity Group

DELETE /identityGroups/{groupId}/identities/{id}

Delete the Identity

PATCH /identityGroups/{groupId}/identities/{id}

Update the Identity

DELETE /identityGroups/{groupId}/identities/{id}/ethernetPorts/{macAddress}/{portIndex}

Delete the Ethernet Port from the Identity

DELETE /identityGroups/{groupId}/identities/{id}/devices/{macAddress}

Delete the Device from the Identity

GET /switches/{switchId}/portSettings

Get Ports

PUT /switches/{switchId}/portSettings

Update Port

POST /switches/{switchId}/portSettings

Get Ports

DELETE /venues/aaaServers

Delete AAA Servers

GET /switches/staticRoutes/{staticRouteId}

Get Static Route

PUT /switches/staticRoutes/{staticRouteId}

Update Static Route

DELETE /switches/staticRoutes/{staticRouteId}

Delete Static Route

GET /switches/vePorts/{vePortId}

Get Virtual Ethernet Setting

PUT /switches/vePorts/{vePortId}

Update Virtual Ethernet Setting

DELETE /switches/vePorts/{vePortId}

Delete Virtual Ethernet Setting

GET /switches/{switchId}/vePorts

Retrieve Virtual Ethernet Settings

POST /switches/{switchId}/vePorts

Add Virtual Ethernet Settings

POST /switches/{switchId}/vlans/query

Query Switch VLANs

GET /switchProfiles/{switchProfileId}/acls

Get ACLs

POST /switchProfiles/{switchProfileId}/acls

Add ACL

DELETE /switchProfiles/{switchProfileId}/acls

Delete ACLs

GET /switches/{switchId}/aclUnions

Get ACL Union

POST /venues/switchFirmwares/schedules

Create Upgrade Schedule

DELETE /venues/switchFirmwares/schedules

Delete Upgrade Schedule

POST /venues/{venueId}/untaggedVlans/query

Retrieve Untagged-VLANs

GET /venues/{venueId}/vlans

Get VLANs

DELETE /venues/{venueId}/switchSettings

Delete Venue Switch Settings

PUT /venues/{venueId}/aaaSettings/{aaaSettingId}

Update AAA Setting

GET /switches/{switchId}/staticRoutes

Get Static Routes

POST /switches/{switchId}/staticRoutes

Add Static Route

GET /switches/{switchId}/acls

Get ACLs

DELETE /switches/{switchId}/dhcpServers/{dhcpServerId}

Delete DHCP Server-Setting

GET /switches/{switchId}/configBackups

Get Switch Configuration Backups

POST /switches/{switchId}/configBackups

Add Switch Configuration Backup

GET /venues/switchFirmwares/versions/{versionType}

Get Versions

POST /switches/vlans/query

Retrieve Switch VLANs

POST /switches/{switchId}/configBackups/query

Retrieve Switch Configuration Backups

GET /cliTemplates

Get Command-Line Interface Templates

POST /venues/switches

Add Switches

PUT /switches/{switchId}/dhcpServers

Update DHCP Server-Setting

POST /switches/{switchId}/dhcpServers

Add DHCP Server

DELETE /switches/{switchId}/dhcpServers

Delete DHCP Servers

GET /switches/lags/{lagId}

Get LAG

PUT /switches/lags/{lagId}

Update LAG

DELETE /switches/lags/{lagId}

Delete LAG

POST /switches/{switchId}/configHistDetails/query

Get Configuration History

GET /venues/aaaServers/{aaaServerId}

Get AAA Server-Setting

DELETE /venues/aaaServers/{aaaServerId}

Delete AAA Server

POST /switches/{switchId}/acls/query

Retrieve ACLs

GET /switches/dhcpServers/{dhcpServerId}

Get DHCP Server-Setting

GET /switchProfiles/{switchProfileId}/acls/{aclId}

Get ACL

PUT /switchProfiles/{switchProfileId}/acls/{aclId}

Update ACL

DELETE /switchProfiles/{switchProfileId}/acls/{aclId}

Delete ACL

POST /switches/{switchId}/vePorts/query

Retrieve Virtual Ethernet Settings

DELETE /switches/vlans

Delete Switch VLANs

GET /switches/configBackups/{configBackupId}

Get Switch Configuration Backup

PUT /switches/configBackups/{configBackupId}

Restore Switch Configuration Backup

DELETE /switches/configBackups/{configBackupId}

Delete Switch Configuration Backup

GET /switches/{switchId}/lags

Get LAGs

POST /switches/{switchId}/lags

Add LAGs

DELETE /stacks/{stackSwitchSerialNumber}

Delete Stack Member

POST /switches/{switchId}/dhcpServerStateSettings

Update DHCP Server

POST /venues/{venueId}/taggedVlans/query

Retrieve Tagged-VLANs

DELETE /switches/configBackups

Delete Switch Configuration Backups

GET /switches/{switchId}/vlanUnions

Retrieve VLANs

POST /switches/{switchId}/dhcpServers/query

Query DHCP Servers

GET /switches/acls/{aclId}

Get ACL

POST /switches/dhcpServers/query

Query DHCP Servers

GET /venues/{venueId}/trustedPorts

Get Trusted Ports

DELETE /switches/vePorts

Delete Virtual Ethernet Settings

POST /switches/{switchId}/deviceRequests

Sync/Reboot ICX Device

GET /venues/switchFirmwares/currentVersions

Get Current Versions

DELETE /switches/staticRoutes

Delete Static Routes

POST /switches/deviceRequests

Create Multiple Device Requests

GET /switches/{switchId}/transactions/{transactionId}/configHistDetails

Get Configuration History

GET /venues/{venueId}/switchProfiles/acls

Get ACLs

POST /venues/aaaServers/query

Query AAA Servers

DELETE /switches/lags

Delete LAGs

DELETE /identityGroups/{id}

Delete the Identity Group

PATCH /identityGroups/{id}

Update the Identity Group

GET /switches/{switchId}/vlans

Get Switch VLANs

POST /switches/{switchId}/vlans

Add Switch VLAN

GET /switches/vlans/{vlanId}

Get Switch VLAN

DELETE /switches/vlans/{vlanId}

Delete Switch VLAN

PUT /switches/vlans/{vlanId}

Update Switch VLAN

POST /switches/portSettings

Get Ports

PUT /switches/portSettings

Update Ports

GET /switchProfiles/{switchProfileId}/vlans

Get Multiple VLANs

DELETE /switchProfiles/{switchProfileId}/vlans

Delete Multiple VLANs

POST /switches/configBackups/comparisons

Compare Switch Configuration Backups

DELETE /switchProfiles/{switchProfileId}/vlans/{vlanId}

Delete Profile VLAN

GET /switchProfiles/{switchProfileId}/vlans/{vlanId}

Get Profile VLAN

PUT /switchProfiles/{switchProfileId}/vlans/{vlanId}

Update VLAN

DELETE /venues

Revoke Venues by IDs

GET /venues

Access Venues

POST /identityGroups

Create an Identity Group

DELETE /switchProfiles/{switchProfileId}/trustedPorts

Delete Trusted Ports

POST /switchProfiles/{switchProfileId}/trustedPorts

Add Trusted Port

GET /switchProfiles/{switchProfileId}/trustedPorts/{trustedPortId}

Get Trusted Port

DELETE /switchProfiles/{switchProfileId}/trustedPorts/{trustedPortId}

Delete Trusted Port

PUT /switchProfiles/{switchProfileId}/trustedPorts/{trustedPortId}

Update Trusted Port

POST /venues/switchFirmwares/schedules/query

Get Venues

GET /switchProfiles

Get Switch Profiles

DELETE /switchProfiles

Delete Switch Profiles

GET /switches/{switchId}

Get ICX Switch

DELETE /switches/{switchId}

Delete ICX Switch

PUT /switches/{switchId}

Update ICX Switch

GET /switches

Get ICX Switches

DELETE /switches

Delete ICX Switches

POST /switches

Add ICX Switches

What's Changed

POST /certificates

Request:

Changed content type : multipart/form-data

New required properties:

• certificateFile
• name

New optional properties:

• p12File

• Added property certificateFile (string)

  The certificate in P12, DER or PEM format be uploaded.

• Added property privateKeyFile (string)

  The private key in PEM format be uploaded.

• Added property name (string)

  The name for the certificate.

• Deleted property p12File (string)

  The certificate in p12 format must be uploaded.

• Changed property password (string)

  If private key or key store is password-protected, specify the password. If not, leave the password blank.

GET /mspEntitlements/summaries

GET /licenseUsageReports

Parameters:

Added: licenseType in query

Specific license type if the tenant is an ALM tenant, valid value: MSP_APSW (default), MSP_URLF, MSP_EDGE_SECS, MSP_EDGE_SECL

Added: page in query

Page number for the daily reports. If missing or value 0 means no pagination, all daily reports will be returned.

Added: pageSize in query

Page size for the daily reports, default is 5, valid only if page is given

GET /certificateTemplates/{templateId}/certificates/{certId}

Return Type:

Changed response : 200 OK

Certificate

• Changed content type : application/json

  • Added property keyUsages (array)

    The key usage of this certificate.

    Items (string):

    The key usage of this certificate.

    Enum values:

    • DIGITAL_SIGNATURE
    • KEY_ENCIPHERMENT

  • Deleted property keyUsage (array)

    The allowed usages of the certificate.

• Changed content type : application/vnd.ruckus.v1+json

  • Added property keyUsages (array)

    The key usage of this certificate.

  • Deleted property keyUsage (array)

    The allowed usages of the certificate.

PATCH /certificateTemplates/{templateId}/certificates/{certId}

Parameters:

Added: templateId in path

Certificate Template id

Request:

Changed content type : application/json

• Changed property revocationReason (string)

  The reason for revocation of certificate. If not revoked, this field should be null.

Changed content type : application/vnd.ruckus.v1+json

• Changed property revocationReason (string)

  The reason for revocation of certificate. If not revoked, this field should be null.

GET /certificateTemplates/{templateId}/scepKeys/{scepKeyId}

Return Type:

Changed response : 200 OK

SCEP Key

• Changed content type : application/json

  New optional properties:

  • scepKey

  • Changed property challengePassword (string)

    If checked, the client will need to provide this password during the exchange.

  • Changed property overrideDays (integer)

    If greater than 0, this overrides the expiration date in the certificate template for certificates generated using this key.

• Changed content type : application/vnd.ruckus.v1+json

  New optional properties:

  • scepKey

  • Changed property challengePassword (string)

    If checked, the client will need to provide this password during the exchange.

  • Changed property overrideDays (integer)

    If greater than 0, this overrides the expiration date in the certificate template for certificates generated using this key.

PATCH /certificateTemplates/{templateId}/scepKeys/{scepKeyId}

Request:

Changed content type : application/json

New optional properties:

• scepKey

• Changed property challengePassword (string)

  If checked, the client will need to provide this password during the exchange.

• Changed property overrideDays (integer)

  If greater than 0, this overrides the expiration date in the certificate template for certificates generated using this key.

Changed content type : application/vnd.ruckus.v1+json

New optional properties:

• scepKey

• Changed property challengePassword (string)

  If checked, the client will need to provide this password during the exchange.

• Changed property overrideDays (integer)

  If greater than 0, this overrides the expiration date in the certificate template for certificates generated using this key.

POST /macRegistrationPools/{poolId}/registrations/csvFile

Return Type:

New response : 202 Accepted

The registration import request is in progress

Changed response : 400 Bad Request

Invalid content supplied

• New content type : application/vnd.ruckus.v1.1+json

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property status (string)

    Enum values:

    • 100 CONTINUE
    • 101 SWITCHING_PROTOCOLS
    • 102 PROCESSING
    • 103 EARLY_HINTS
    • 103 CHECKPOINT
    • 200 OK
    • 201 CREATED
    • 202 ACCEPTED
    • 203 NON_AUTHORITATIVE_INFORMATION
    • 204 NO_CONTENT
    • 205 RESET_CONTENT
    • 206 PARTIAL_CONTENT
    • 207 MULTI_STATUS
    • 208 ALREADY_REPORTED
    • 226 IM_USED
    • 300 MULTIPLE_CHOICES
    • 301 MOVED_PERMANENTLY
    • 302 FOUND
    • 302 MOVED_TEMPORARILY
    • 303 SEE_OTHER
    • 304 NOT_MODIFIED
    • 305 USE_PROXY
    • 307 TEMPORARY_REDIRECT
    • 308 PERMANENT_REDIRECT
    • 400 BAD_REQUEST
    • 401 UNAUTHORIZED
    • 402 PAYMENT_REQUIRED
    • 403 FORBIDDEN
    • 404 NOT_FOUND
    • 405 METHOD_NOT_ALLOWED
    • 406 NOT_ACCEPTABLE
    • 407 PROXY_AUTHENTICATION_REQUIRED
    • 408 REQUEST_TIMEOUT
    • 409 CONFLICT
    • 410 GONE
    • 411 LENGTH_REQUIRED
    • 412 PRECONDITION_FAILED
    • 413 PAYLOAD_TOO_LARGE
    • 413 REQUEST_ENTITY_TOO_LARGE
    • 414 URI_TOO_LONG
    • 414 REQUEST_URI_TOO_LONG
    • 415 UNSUPPORTED_MEDIA_TYPE
    • 416 REQUESTED_RANGE_NOT_SATISFIABLE
    • 417 EXPECTATION_FAILED
    • 418 I_AM_A_TEAPOT
    • 419 INSUFFICIENT_SPACE_ON_RESOURCE
    • 420 METHOD_FAILURE
    • 421 DESTINATION_LOCKED
    • 422 UNPROCESSABLE_ENTITY
    • 423 LOCKED
    • 424 FAILED_DEPENDENCY
    • 425 TOO_EARLY
    • 426 UPGRADE_REQUIRED
    • 428 PRECONDITION_REQUIRED
    • 429 TOO_MANY_REQUESTS
    • 431 REQUEST_HEADER_FIELDS_TOO_LARGE
    • 451 UNAVAILABLE_FOR_LEGAL_REASONS
    • 500 INTERNAL_SERVER_ERROR
    • 501 NOT_IMPLEMENTED
    • 502 BAD_GATEWAY
    • 503 SERVICE_UNAVAILABLE
    • 504 GATEWAY_TIMEOUT
    • 505 HTTP_VERSION_NOT_SUPPORTED
    • 506 VARIANT_ALSO_NEGOTIATES
    • 507 INSUFFICIENT_STORAGE
    • 508 LOOP_DETECTED
    • 509 BANDWIDTH_LIMIT_EXCEEDED
    • 510 NOT_EXTENDED
    • 511 NETWORK_AUTHENTICATION_REQUIRED

  • Added property timestamp (string)

  • Added property message (string)

  • Added property debugMessage (string)

  • Added property subErrors (array)

    Items (object):

Changed response : 413 Request Too Long

Payload too large

• New content type : application/vnd.ruckus.v1.1+json

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property status (string)

  • Added property timestamp (string)

  • Added property message (string)

  • Added property debugMessage (string)

  • Added property subErrors (array)

Changed response : 419 Insufficient Space On Resource

Exceed max registrations of the pool

• New content type : application/vnd.ruckus.v1.1+json

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property status (string)

  • Added property timestamp (string)

  • Added property message (string)

  • Added property debugMessage (string)

  • Added property subErrors (array)

Changed response : 201 Created

Registration pools created

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  Changed items (object):

  A MAC registration

  • Added property isReferenced (boolean)

    This registration is referenced by an identity and cannot be deleted.

  • Added property _links (object)

  • Deleted property identityId (string)

    Identifier of linked service.

  • Deleted property links (array)

  • Changed property username (string)

    A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

  • Changed property email (string)

    The email to associate with this device.

  • Changed property location (string)

    The location of this device.

  • Changed property deviceName (string)

    Device name

DELETE /macRegistrationPools/{poolId}/registrations/{id}

Parameters:

Added: id in path

MAC registration id

Deleted: registrationId in path

MAC registration id

Return Type:

New response : 202 Accepted

The registration delete request is in progress

New response : 409 Conflict

The Registration associated with other resources is not allowed to be deleted

Changed response : 200 OK

Registration deleted

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  New required properties:

  • macAddress
  • revoked

  • Added property id (string)

    The unique identifier for this MAC registration.

  • Added property expirationDate (string)

    Indicates when this registration expires. Will derive from the pool setting if not specified.

  • Added property revoked (boolean)

    If this MAC registration is revoked or not.

  • Added property macAddress (string)

    The mac address for this registration. Must be provided on post, and may not be changed.

  • Added property username (string)

    A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

  • Added property email (string)

    The email to associate with this device.

  • Added property location (string)

    The location of this device.

  • Added property deviceName (string)

    Device name

  • Added property createdDate (string)

    The created date of this device.

  • Added property isReferenced (boolean)

    This registration is referenced by an identity and cannot be deleted.

  • Added property _links (object)

Changed response : 400 Bad Request

Invalid id supplied

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property status (string)

  • Added property timestamp (string)

  • Added property message (string)

  • Added property debugMessage (string)

  • Added property subErrors (array)

Changed response : 404 Not Found

MAC registration not found

• New content type : application/vnd.ruckus.v1.1+json

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property status (string)

  • Added property timestamp (string)

  • Added property message (string)

  • Added property debugMessage (string)

  • Added property subErrors (array)

GET /macRegistrationPools/{poolId}/registrations/{id}

Parameters:

Added: id in path

MAC registration id

Deleted: registrationId in path

MAC registration id

Return Type:

Changed response : 200 OK

MAC registration

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property isReferenced (boolean)

    This registration is referenced by an identity and cannot be deleted.

  • Added property _links (object)

  • Deleted property identityId (string)

    Identifier of linked service.

  • Deleted property links (array)

  • Changed property username (string)

    A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

  • Changed property email (string)

    The email to associate with this device.

  • Changed property location (string)

    The location of this device.

  • Changed property deviceName (string)

    Device name

Changed response : 400 Bad Request

Invalid id supplied

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  New optional properties:

  • macAddress
  • revoked

  • Added property status (string)

  • Added property timestamp (string)

  • Added property message (string)

  • Added property debugMessage (string)

  • Added property subErrors (array)

  • Deleted property id (string)

    The unique identifier for this MAC registration.

  • Deleted property expirationDate (string)

    Indicates when this registration expires. Will derive from the pool setting if not specified.

  • Deleted property revoked (boolean)

    If this MAC registration is revoked or not.

  • Deleted property macAddress (string)

    The mac address for this registration. Must be provided on post, and may not be changed.

  • Deleted property username (string)

    A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

  • Deleted property email (string)

    The email to associate with this device.

  • Deleted property location (string)

    The location of this device.

  • Deleted property deviceName (string)

    Device name

  • Deleted property createdDate (string)

    The created date of this device.

  • Deleted property identityId (string)

    Identifier of linked service.

  • Deleted property links (array)

Changed response : 404 Not Found

MAC registration not found

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  New optional properties:

  • macAddress
  • revoked

  • Added property status (string)

  • Added property timestamp (string)

  • Added property message (string)

  • Added property debugMessage (string)

  • Added property subErrors (array)

  • Deleted property id (string)

    The unique identifier for this MAC registration.

  • Deleted property expirationDate (string)

    Indicates when this registration expires. Will derive from the pool setting if not specified.

  • Deleted property revoked (boolean)

    If this MAC registration is revoked or not.

  • Deleted property macAddress (string)

    The mac address for this registration. Must be provided on post, and may not be changed.

  • Deleted property username (string)

    A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

  • Deleted property email (string)

    The email to associate with this device.

  • Deleted property location (string)

    The location of this device.

  • Deleted property deviceName (string)

    Device name

  • Deleted property createdDate (string)

    The created date of this device.

  • Deleted property identityId (string)

    Identifier of linked service.

  • Deleted property links (array)

PATCH /macRegistrationPools/{poolId}/registrations/{id}

Parameters:

Added: id in path

MAC registration id

Deleted: registrationId in path

MAC registration id

Request:

New content type : application/vnd.ruckus.v1+json

Changed content type : application/json

New required properties:

• macAddress
• revoked

• Added property id (string)

  The unique identifier for this MAC registration.

• Added property expirationDate (string)

  Indicates when this registration expires. Will derive from the pool setting if not specified.

• Added property revoked (boolean)

  If this MAC registration is revoked or not.

• Added property macAddress (string)

  The mac address for this registration. Must be provided on post, and may not be changed.

• Added property username (string)

  A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

• Added property email (string)

  The email to associate with this device.

• Added property location (string)

  The location of this device.

• Added property deviceName (string)

  Device name

• Added property createdDate (string)

  The created date of this device.

• Added property isReferenced (boolean)

  This registration is referenced by an identity and cannot be deleted.

• Added property _links (object)

Return Type:

New response : 202 Accepted

The registration update request is in progress

Changed response : 400 Bad Request

Invalid id or content supplied

• New content type : application/vnd.ruckus.v1.1+json

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  New required properties:

  • macAddress
  • revoked

  • Added property id (string)

    The unique identifier for this MAC registration.

  • Added property expirationDate (string)

    Indicates when this registration expires. Will derive from the pool setting if not specified.

  • Added property revoked (boolean)

    If this MAC registration is revoked or not.

  • Added property macAddress (string)

    The mac address for this registration. Must be provided on post, and may not be changed.

  • Added property username (string)

    A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

  • Added property email (string)

    The email to associate with this device.

  • Added property location (string)

    The location of this device.

  • Added property deviceName (string)

    Device name

  • Added property createdDate (string)

    The created date of this device.

  • Added property isReferenced (boolean)

    This registration is referenced by an identity and cannot be deleted.

  • Added property _links (object)

Changed response : 404 Not Found

MAC registration not found

• New content type : application/vnd.ruckus.v1.1+json

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  New required properties:

  • macAddress
  • revoked

  • Added property id (string)

    The unique identifier for this MAC registration.

  • Added property expirationDate (string)

    Indicates when this registration expires. Will derive from the pool setting if not specified.

  • Added property revoked (boolean)

    If this MAC registration is revoked or not.

  • Added property macAddress (string)

    The mac address for this registration. Must be provided on post, and may not be changed.

  • Added property username (string)

    A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

  • Added property email (string)

    The email to associate with this device.

  • Added property location (string)

    The location of this device.

  • Added property deviceName (string)

    Device name

  • Added property createdDate (string)

    The created date of this device.

  • Added property isReferenced (boolean)

    This registration is referenced by an identity and cannot be deleted.

  • Added property _links (object)

Changed response : 200 OK

MAC registration updated

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property isReferenced (boolean)

    This registration is referenced by an identity and cannot be deleted.

  • Added property _links (object)

  • Deleted property identityId (string)

    Identifier of linked service.

  • Deleted property links (array)

  • Changed property username (string)

    A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

  • Changed property email (string)

    The email to associate with this device.

  • Changed property location (string)

    The location of this device.

  • Changed property deviceName (string)

    Device name

DELETE /macRegistrationPools/{id}

Return Type:

New response : 202 Accepted

The registration pool delete request is in progress

New response : 404 Not Found

Registration pool not found

New response : 409 Conflict

The Registration pool associated with other resources is not allowed to be deleted

Changed response : 200 OK

Registration pool deleted

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

Changed response : 400 Bad Request

Invalid id supplied

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property status (string)

  • Added property timestamp (string)

  • Added property message (string)

  • Added property debugMessage (string)

  • Added property subErrors (array)

GET /macRegistrationPools/{id}

Return Type:

Changed response : 400 Bad Request

Invalid id supplied

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property status (string)

  • Added property timestamp (string)

  • Added property message (string)

  • Added property debugMessage (string)

  • Added property subErrors (array)

Changed response : 404 Not Found

Registration pool not found

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property status (string)

  • Added property timestamp (string)

  • Added property message (string)

  • Added property debugMessage (string)

  • Added property subErrors (array)

Changed response : 200 OK

Registration pool

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  New optional properties:

  • priority

  • Added property isReferenced (boolean)

    This pool is referenced by an identity group and cannot be deleted.

  • Added property networkCount (integer)

    Number of networks associated with this pool.

  • Added property identityGroupId (string)

    The identity group of this pool.

  • Added property identityId (string)

    The single identity policy of this pool.

  • Added property _links (object)

  • Deleted property policyId (string)

  • Deleted property priority (integer)

    The sequence of the pool, which determines the order it has when a MAC registration is being evaluated by radius. A MAC registration pool with a lower number is checked before one with a higher number.

  • Deleted property enabled (boolean)

    The registration pool is enabled for authentication or not.

  • Deleted property associationIds (array)

    The association list of this pool.

  • Deleted property networkIds (array)

    The network list of this pool.

  • Deleted property links (array)

  • Changed property name (string)

    The unique reference name of the pool.

  • Changed property description (string)

    A description of the pool.

  • Changed property expirationType (string)

    Defines the rule for expiration date calculation.

  • Changed property ssidRegex (string)

    A regex to determine which SSIDs this registration pool will allows access to.

  • Changed property defaultAccess (string)

    The type of default access.

PATCH /macRegistrationPools/{id}

Request:

New content type : application/vnd.ruckus.v1+json

Changed content type : application/json

New required properties:

• name

• Added property id (string)

  The unique identifier for this pool.

• Added property name (string)

  The unique reference name of the pool.

• Added property description (string)

  A description of the pool.

• Added property autoCleanup (boolean)

  A toggle determining whether MAC registrations that are 24 hours past the expiration time will be automatically removed from the pool.

• Added property expirationType (string)

  Defines the rule for expiration date calculation.

  Enum values:

  • SPECIFIED_DATE
  • MINUTES_AFTER_TIME
  • HOURS_AFTER_TIME
  • DAYS_AFTER_TIME
  • WEEKS_AFTER_TIME
  • MONTHS_AFTER_TIME
  • QUARTERS_AFTER_TIME
  • YEARS_AFTER_TIME
  • END_OF_HOUR
  • END_OF_DAY
  • END_OF_WEEK
  • END_OF_MONTH
  • END_OF_QUARTER
  • END_OF_HALF
  • END_OF_YEAR

• Added property expirationOffset (integer)

  If the expiration type is not specified_date then this field is the offset amount.

• Added property expirationDate (string)

  If the expiration type is specified_date then this field is the related date.

• Added property ssidRegex (string)

  A regex to determine which SSIDs this registration pool will allows access to.

• Added property expirationEnabled (boolean)

  If the expiration setting is enabled for new MAC registration.

• Added property registrationCount (integer)

  Number of registrations in the pool.

• Added property defaultAccess (string)

  The type of default access.

  Enum values:

  • ACCEPT
  • REJECT

• Added property createdDate (string)

  The created date of this pool.

• Added property policySetId (string)

  The policy set of this pool.

• Added property isReferenced (boolean)

  This pool is referenced by an identity group and cannot be deleted.

• Added property networkCount (integer)

  Number of networks associated with this pool.

• Added property identityGroupId (string)

  The identity group of this pool.

• Added property identityId (string)

  The single identity policy of this pool.

• Added property _links (object)

Return Type:

New response : 202 Accepted

The registration pool update request is in progress

Changed response : 400 Bad Request

Invalid id supplied

• New content type : application/vnd.ruckus.v1.1+json

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property status (string)

  • Added property timestamp (string)

  • Added property message (string)

  • Added property debugMessage (string)

  • Added property subErrors (array)

Changed response : 404 Not Found

Registration pool not found

• New content type : application/vnd.ruckus.v1.1+json

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property status (string)

  • Added property timestamp (string)

  • Added property message (string)

  • Added property debugMessage (string)

  • Added property subErrors (array)

Changed response : 200 OK

Registration pool updated

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  New optional properties:

  • priority

  • Added property isReferenced (boolean)

    This pool is referenced by an identity group and cannot be deleted.

  • Added property networkCount (integer)

    Number of networks associated with this pool.

  • Added property identityGroupId (string)

    The identity group of this pool.

  • Added property identityId (string)

    The single identity policy of this pool.

  • Added property _links (object)

  • Deleted property policyId (string)

  • Deleted property priority (integer)

    The sequence of the pool, which determines the order it has when a MAC registration is being evaluated by radius. A MAC registration pool with a lower number is checked before one with a higher number.

  • Deleted property enabled (boolean)

    The registration pool is enabled for authentication or not.

  • Deleted property associationIds (array)

    The association list of this pool.

  • Deleted property networkIds (array)

    The network list of this pool.

  • Deleted property links (array)

  • Changed property name (string)

    The unique reference name of the pool.

  • Changed property description (string)

    A description of the pool.

  • Changed property expirationType (string)

    Defines the rule for expiration date calculation.

  • Changed property ssidRegex (string)

    A regex to determine which SSIDs this registration pool will allows access to.

  • Changed property defaultAccess (string)

    The type of default access.

GET /mspEntitlements

Return Type:

Changed response : 200 OK

List of MSP entitlement.

• Changed content type : application/json

  Changed items (object):

  • Added property alm (boolean)

  • Added property almActivationId (string)

  • Added property almSoEntQuantity (integer)

  • Added property isR1Sku (string)

  • Added property r1Sku (boolean)

  • Changed property deviceType (string)

    Added enum values:

    • MSP_APSW
    • MSP_SLTN_TOKEN

GET /mspBanners

Return Type:

Changed response : 200 OK

List of MSP entitlement banners.

• Changed content type : application/json

  Changed items (object):

  • Added property alm (boolean)

  • Added property almExtraEntitlementInfoDto (object)

    • Property licenseType (string)

      Enum values:

      • MSP_WIFI
      • MSP_WIFI_TEMP
      • MSP_ICX
      • MSP_ICX71L
      • MSP_ICX71
      • MSP_ICX75
      • MSP_ICX76
      • MSP_ICX78
      • MSP_ICX_ANY
      • MSP_EDGE
      • MSP_EDGE_TEMP
      • MSP_APSW
      • MSP_APSW_TEMP
      • MSP_URLF
      • MSP_EDGE_SECL
      • MSP_EDGE_SELS
      • MSP_SLTN_TOKEN
      • MSP_SLTN_TOKEN_TEMP

    • Property remainingQuantity (integer)

    • Property soEntQuantity (integer)

  • Changed property deviceType (string)

    Added enum values:

    • MSP_APSW
    • MSP_SLTN_TOKEN

GET /assignments

Parameters:

Added: mspEcTenantId in query

Use 'mspEcTenantId' optionally; if provided, assignments for the specified MSP-EC will be returned.

Return Type:

Changed response : 200 OK

List of entitlement assignments.

• Changed content type : application/json

  Changed items (object):

  • Added property extendedTrial (boolean)

  • Added property alm (boolean)

  • Added property ownAssignment (boolean)

  • Changed property deviceType (string)

    Added enum values:

    • MSP_APSW
    • MSP_SLTN_TOKEN

GET /assignments/summaries

Return Type:

Changed response : 200 OK

Assignment Summaries by device type.

• Changed content type : application/json

  Changed items (object):

  • Added property myAssignments (integer)

  • Added property licenseType (string)

  • Changed property deviceType (string)

    Added enum values:

    • MSP_APSW
    • MSP_SLTN_TOKEN

POST /identityGroups/csvFile

Request:

Changed content type : application/json

• Added property policySetId (string)

• Added property networkId (string)

Changed content type : application/vnd.ruckus.v1+json

• Added property policySetId (string)

• Added property networkId (string)

POST /identities/csvFile

Request:

Changed content type : application/json

• Added property ethernetPort (object)

  Ethernet port

  • Property macAddress (string)

    The MAC address for the ethernet port.

  • Property portIndex (integer)

    The index of the port of the ethernet port.

  • Property name (string)

    The name for the ethernet port.

  • Property createdAt (string)

    The timestamp that the ethernet port get created.

  • Property updatedAt (string)

    The timestamp that the ethernet get updated.

  • Property identityId (string)

    The identifier of the identity for the ethernet port.

• Added property filter (object)

Changed content type : application/vnd.ruckus.v1+json

• Added property ethernetPort (object)

  Ethernet port

• Added property filter (object)

GET /tenants/authentications

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/vnd.ruckus.v1+json

  Changed items (object):

  • Added property samlSignatureEnabled (boolean)

  • Added property samlEncryptionCertificateId (string)

  • Added property parentTenantId (string)

• Changed content type : application/json

  Changed items (object):

  • Added property samlSignatureEnabled (boolean)

  • Added property samlEncryptionCertificateId (string)

  • Added property parentTenantId (string)

POST /tenants/authentications

Request:

Changed content type : application/vnd.ruckus.v1+json

• Added property samlSignatureEnabled (boolean)

• Added property samlEncryptionCertificateId (string)

• Added property parentTenantId (string)

Changed content type : application/json

• Added property samlSignatureEnabled (boolean)

• Added property samlEncryptionCertificateId (string)

• Added property parentTenantId (string)

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/vnd.ruckus.v1+json

  • Added property samlSignatureEnabled (boolean)

  • Added property samlEncryptionCertificateId (string)

  • Added property parentTenantId (string)

• Changed content type : application/json

  • Added property samlSignatureEnabled (boolean)

  • Added property samlEncryptionCertificateId (string)

  • Added property parentTenantId (string)

GET /admins/{adminId}

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/vnd.ruckus.v1+json

  • Added property phoneNumber (string)

  • Deleted property manageAllEcs (boolean)

  • Deleted property isManageAllEcs (boolean)

  • Deleted property lastLogin (string)

  • Changed property role (string)

• Changed content type : application/json

  • Added property phoneNumber (string)

  • Deleted property manageAllEcs (boolean)

  • Deleted property isManageAllEcs (boolean)

  • Deleted property lastLogin (string)

  • Changed property role (string)

DELETE /admins/{adminId}

Return Type:

Changed response : 500 Internal Server Error

Internal Server Error

POST /certificates/{certId}

Return Type:

Changed response : 200 OK

Downloaded private key of CA

• New content type : application/x-pkcs12

• Deleted content type : application/pkcs1

PATCH /certificates/{certId}

Request:

Changed content type : application/json

• Added property name (string)

  The name for the certificate.

• Added property description (string)

  The description of this certificate.

• Added property notAfterDate (string)

  The expiration date for the renewed certificate. The start date for the validity period will also be set to today.

Changed content type : application/vnd.ruckus.v1+json

• Added property name (string)

  The name for the certificate.

• Added property description (string)

  The description of this certificate.

• Added property notAfterDate (string)

  The expiration date for the renewed certificate. The start date for the validity period will also be set to today.

GET /certificates/{certId}

Return Type:

Changed response : 200 OK

Certificate

• Changed content type : application/json

  New required properties:

  • name

  New optional properties:

  • commonName

  • Added property certificateAuthorityName (string)

    The name of the certificate authority that issued this certificate.

  • Added property keyUsages (array)

    The key usages of the certificate.

    Items (string):

    The key usages of the certificate.

    Enum values:

    • DIGITAL_SIGNATURE
    • KEY_ENCIPHERMENT

  • Added property status (array)

    The status of the certificate.

    Items (string):

    The status of the certificate.

    Enum values:

    • INVALID
    • VALID
    • REVOKED
    • EXPIRED

  • Added property extendedKeyUsages (array)

    The extended key usage of the certificate.

    Items (string):

    The extended key usage of the certificate.

    Enum values:

    • SERVER_AUTH
    • CLIENT_AUTH

  • Deleted property certificateAuthoritiesName (string)

    The name of the template that this certificate generates from.

  • Deleted property keyUsage (array)

    The allowed usages of the certificate.

  • Changed property name (string)

    The name of the certificate.

• Changed content type : application/vnd.ruckus.v1+json

  New required properties:

  • name

  New optional properties:

  • commonName

  • Added property certificateAuthorityName (string)

    The name of the certificate authority that issued this certificate.

  • Added property keyUsages (array)

    The key usages of the certificate.

  • Added property status (array)

    The status of the certificate.

  • Added property extendedKeyUsages (array)

    The extended key usage of the certificate.

  • Deleted property certificateAuthoritiesName (string)

    The name of the template that this certificate generates from.

  • Deleted property keyUsage (array)

    The allowed usages of the certificate.

  • Changed property name (string)

    The name of the certificate.

POST /certificateTemplates/{templateId}/scepKeys

Request:

Changed content type : application/json

New optional properties:

• scepKey

• Changed property challengePassword (string)

  If checked, the client will need to provide this password during the exchange.

• Changed property overrideDays (integer)

  If greater than 0, this overrides the expiration date in the certificate template for certificates generated using this key.

Changed content type : application/vnd.ruckus.v1+json

New optional properties:

• scepKey

• Changed property challengePassword (string)

  If checked, the client will need to provide this password during the exchange.

• Changed property overrideDays (integer)

  If greater than 0, this overrides the expiration date in the certificate template for certificates generated using this key.

POST /certificateTemplates/{templateId}/identities/{identityId}/certificates/query

Request:

Changed content type : application/json

• Changed property filters (object)

  • Changed property status (string)

    Added enum value:

    • INVALID Changed content type : application/vnd.ruckus.v1+json

• Changed property filters (object)

  • Changed property status (string)

    Added enum value:

    • INVALID

Return Type:

Changed response : 200 OK

Certificates

• Changed content type : application/json

  • Changed property data (array)

    Certificate in page.

    Changed items (object):

    • Added property keyUsages (array)

      The key usage of this certificate.

    • Deleted property keyUsage (array)

      The allowed usages of the certificate.

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property data (array)

    Certificate in page.

    Changed items (object):

    • Added property keyUsages (array)

      The key usage of this certificate.

    • Deleted property keyUsage (array)

      The allowed usages of the certificate.

POST /certificateTemplates/{templateId}/certificates/query

Request:

Changed content type : application/json

• Changed property filters (object)

  • Changed property status (string)

    Added enum value:

    • INVALID Changed content type : application/vnd.ruckus.v1+json

• Changed property filters (object)

  • Changed property status (string)

    Added enum value:

    • INVALID

Return Type:

Changed response : 200 OK

Certificates

• Changed content type : application/json

  • Changed property data (array)

    Certificate in page.

    Changed items (object):

    • Added property keyUsages (array)

      The key usage of this certificate.

    • Deleted property keyUsage (array)

      The allowed usages of the certificate.

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property data (array)

    Certificate in page.

    Changed items (object):

    • Added property keyUsages (array)

      The key usage of this certificate.

    • Deleted property keyUsage (array)

      The allowed usages of the certificate.

POST /certificateTemplates/certificates/query

Request:

Changed content type : application/json

• Changed property filters (object)

  • Changed property status (string)

    Added enum value:

    • INVALID Changed content type : application/vnd.ruckus.v1+json

• Changed property filters (object)

  • Changed property status (string)

    Added enum value:

    • INVALID

Return Type:

Changed response : 200 OK

Certificates

• Changed content type : application/json

  • Changed property data (array)

    Certificate in page.

    Changed items (object):

    • Added property keyUsages (array)

      The key usage of this certificate.

    • Deleted property keyUsage (array)

      The allowed usages of the certificate.

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property data (array)

    Certificate in page.

    Changed items (object):

    • Added property keyUsages (array)

      The key usage of this certificate.

    • Deleted property keyUsage (array)

      The allowed usages of the certificate.

POST /certificateAuthorities

Request:

Changed content type : application/json

• Changed property commonName (string)

  The common name of this authority.

Changed content type : application/vnd.ruckus.v1+json

• Changed property commonName (string)

  The common name of this authority.

GET /certificateAuthorities/{caId}

Return Type:

Changed response : 200 OK

Certificate Authority

• Changed content type : application/json

  • Added property status (array)

    The status of the certificate of the CA.

    Items (string):

    The status of the certificate of the CA.

    Enum values:

    • INVALID
    • VALID
    • REVOKED
    • EXPIRED

  • Changed property commonName (string)

    The common name of this authority.

  • Changed property usages (array)

    The extended key usage of this CA.

    Changed items (string):

    The extended key usage of this CA.

    Added enum values:

    • SERVER_AUTH
    • CLIENT_AUTH

  • Changed property keyUsages (array)

    The key usage for the CA.

    Changed items (string):

    The key usage for the CA.

    Added enum values:

    • DIGITAL_SIGNATURE
    • KEY_ENCIPHERMENT

• Changed content type : application/vnd.ruckus.v1+json

  • Added property status (array)

    The status of the certificate of the CA.

  • Changed property commonName (string)

    The common name of this authority.

  • Changed property usages (array)

    The extended key usage of this CA.

    Changed items (string):

    The extended key usage of this CA.

    Added enum values:

    • SERVER_AUTH
    • CLIENT_AUTH

  • Changed property keyUsages (array)

    The key usage for the CA.

    Changed items (string):

    The key usage for the CA.

    Added enum values:

    • DIGITAL_SIGNATURE
    • KEY_ENCIPHERMENT

POST /certificateAuthorities/{caId}/templates

Request:

Changed content type : application/json

New required properties:

• identityGroupId

• Added property identityGroupId (string)

  The identity group id associated with the template.

• Changed property keyLength (integer)

  The key length for certificates generated using this template.

  Added enum values:

  • 2048
  • 3072
  • 4096

• Changed property onboard (object)

  The configuration of the onboard CA.

  • Changed property commonNamePattern (string)

    The pattern used to determine the common name for certificates generated using this template.

Changed content type : application/vnd.ruckus.v1+json

New required properties:

• identityGroupId

• Added property identityGroupId (string)

  The identity group id associated with the template.

• Changed property keyLength (integer)

  The key length for certificates generated using this template.

  Added enum values:

  • 2048
  • 3072
  • 4096

• Changed property onboard (object)

  The configuration of the onboard CA.

  • Changed property commonNamePattern (string)

    The pattern used to determine the common name for certificates generated using this template.

POST /certificateAuthorities/{caId}/subCas

Request:

Changed content type : application/json

• Changed property commonName (string)

  The common name of this authority.

Changed content type : application/vnd.ruckus.v1+json

• Changed property commonName (string)

  The common name of this authority.

POST /certificateAuthorities/{caId}/certificates

Request:

Changed content type : application/json

New required properties:

• name

New optional properties:

• commonName

• Added property keyUsages (array)

  The key usages of the certificate.

• Added property extendedKeyUsages (array)

  The extended key usage of the certificate.

• Changed property name (string)

  The name of the certificate.

Changed content type : application/vnd.ruckus.v1+json

New required properties:

• name

New optional properties:

• commonName

• Added property keyUsages (array)

  The key usages of the certificate.

• Added property extendedKeyUsages (array)

  The extended key usage of the certificate.

• Changed property name (string)

  The name of the certificate.

GET /certificateTemplates/{templateId}

Return Type:

Changed response : 200 OK

Certificate Template

• Changed content type : application/json

  New required properties:

  • identityGroupId

  • Added property identityGroupId (string)

    The identity group id associated with the template.

  • Changed property keyLength (integer)

    The key length for certificates generated using this template.

    Added enum values:

    • 2048
    • 3072
    • 4096

  • Changed property onboard (object)

    The configuration of the onboard CA.

    • Changed property commonNamePattern (string)

      The pattern used to determine the common name for certificates generated using this template.

• Changed content type : application/vnd.ruckus.v1+json

  New required properties:

  • identityGroupId

  • Added property identityGroupId (string)

    The identity group id associated with the template.

  • Changed property keyLength (integer)

    The key length for certificates generated using this template.

    Added enum values:

    • 2048
    • 3072
    • 4096

  • Changed property onboard (object)

    The configuration of the onboard CA.

    • Changed property commonNamePattern (string)

      The pattern used to determine the common name for certificates generated using this template.

PATCH /certificateTemplates/{templateId}

Request:

Changed content type : application/json

• Changed property onboard (object)

  The configuration of the onboard CA.

  • Changed property commonNamePattern (string)

    The pattern used to determine the common name for certificates generated using this template.

Changed content type : application/vnd.ruckus.v1+json

• Changed property onboard (object)

  The configuration of the onboard CA.

  • Changed property commonNamePattern (string)

    The pattern used to determine the common name for certificates generated using this template.

POST /tenants/{tenantId}/entitlements/assignments/query

Return Type:

Changed response : 400 Bad Request

Bad input, missing tenant ID.

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

Changed response : 500 Internal Server Error

Internal server error.

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property errors (array)

    Changed items (object):

    • Changed property error (object)

      • Added property reason (string)

      • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property errors (array)

    Changed items (object):

    • Changed property error (object)

      • Added property reason (string)

      • Added property suggestion (string)

POST /tenants/self/entitlements/assignments

Return Type:

Changed response : 400 Bad Request

Bad input, such as missing required fields.

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

Changed response : 500 Internal Server Error

Internal server error.

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

POST /tenants/self/entitlements/assignments/query

Return Type:

Changed response : 400 Bad Request

Bad input, missing tenant ID.

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

Changed response : 500 Internal Server Error

Internal server error.

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

Changed response : 200 OK

OK

• Changed content type : application/json

  • Changed property errors (array)

    Changed items (object):

    • Changed property error (object)

      • Added property reason (string)

      • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property errors (array)

    Changed items (object):

    • Changed property error (object)

      • Added property reason (string)

      • Added property suggestion (string)

POST /entitlements/utilizations/query

Parameters:

Added: Content-Type in header

Request:

New content type : application/vnd.ruckus.v1.1+json

Return Type:

Changed response : 404 Not Found

Tenant not found.

• New content type : application/vnd.ruckus.v1.1+json

• Changed content type : application/vnd.ruckus.v1+json

  • Added property reason (string)

  • Added property suggestion (string)

• Changed content type : application/json

  • Added property reason (string)

  • Added property suggestion (string)

Changed response : 417 Expectation Failed

Cannot display subscription data: entitlement ID is missing. At least one tenant subscription must be active.

• New content type : application/vnd.ruckus.v1.1+json

• Changed content type : application/vnd.ruckus.v1+json

  • Added property reason (string)

  • Added property suggestion (string)

• Changed content type : application/json

  • Added property reason (string)

  • Added property suggestion (string)

Changed response : 500 Internal Server Error

Internal Server Error

• New content type : application/vnd.ruckus.v1.1+json

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

Changed response : 200 OK

success

• New content type : application/vnd.ruckus.v1+json

• New content type : application/vnd.ruckus.v1.1+json

• Changed content type : application/json

  Updated Manage_Entitlements_API_DataResponseDto :

  • Changed property errors (array)

    Changed items (object):

    • Changed property error (object)

      • Added property reason (string)

      • Added property suggestion (string)

POST /entitlements/query

Return Type:

Changed response : 404 Not Found

Tenant not found.

• Changed content type : application/vnd.ruckus.v1+json

  • Added property reason (string)

  • Added property suggestion (string)

• Changed content type : application/json

  • Added property reason (string)

  • Added property suggestion (string)

Changed response : 417 Expectation Failed

Cannot display subscription data: entitlement ID is missing. At least one tenant subscription must be active.

• Changed content type : application/vnd.ruckus.v1+json

  • Added property reason (string)

  • Added property suggestion (string)

• Changed content type : application/json

  • Added property reason (string)

  • Added property suggestion (string)

Changed response : 500 Internal Server Error

Internal Server Error

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

Changed response : 200 OK

success.

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property errors (array)

    Changed items (object):

    • Changed property error (object)

      • Added property reason (string)

      • Added property suggestion (string)

• Changed content type : application/json

  • Changed property errors (array)

    Changed items (object):

    • Changed property error (object)

      • Added property reason (string)

      • Added property suggestion (string)

POST /entitlements/banners/query

Return Type:

Changed response : 404 Not Found

This tenant does not exist.

• Changed content type : application/vnd.ruckus.v1+json

  • Added property reason (string)

  • Added property suggestion (string)

• Changed content type : application/json

  • Added property reason (string)

  • Added property suggestion (string)

Changed response : 500 Internal Server Error

Internal Server Error

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

POST /entitlements/availabilityReports/query

Return Type:

Changed response : 403 Forbidden

Access Denied

• Changed content type : application/vnd.ruckus.v1+json

  • Added property reason (string)

  • Added property suggestion (string)

• Changed content type : application/json

  • Added property reason (string)

  • Added property suggestion (string)

Changed response : 500 Internal Server Error

Internal Server Error

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

POST /entitlements/attentionNotes/query

Return Type:

Changed response : 403 Forbidden

Access Denied

• Changed content type : application/vnd.ruckus.v1+json

  • Added property reason (string)

  • Added property suggestion (string)

• Changed content type : application/json

  • Added property reason (string)

  • Added property suggestion (string)

Changed response : 500 Internal Server Error

Internal Server Error

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

Changed response : 200 OK

Success

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property errors (array)

    Changed items (object):

    • Changed property error (object)

      • Added property reason (string)

      • Added property suggestion (string)

• Changed content type : application/json

  • Changed property errors (array)

    Changed items (object):

    • Changed property error (object)

      • Added property reason (string)

      • Added property suggestion (string)

DELETE /tenants/self/entitlements/assignments/{id}

Return Type:

Changed response : 400 Bad Request

Bad input, such as missing required fields.

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

Changed response : 409 Conflict

If the assignment already have been revoked.

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

Changed response : 500 Internal Server Error

Internal server error.

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

PATCH /tenants/self/entitlements/assignments/{id}

Return Type:

Changed response : 400 Bad Request

Bad input, such as missing required fields.

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

Changed response : 402 Payment Required

Insufficient license

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

Changed response : 409 Conflict

If the assignment has already expired.

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

Changed response : 500 Internal Server Error

Internal server error.

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

GET /entitlements

Parameters:

Changed: type in query

Filter by device type (optional). If device agnostic sku feature is enabled, all device types will be treated as APSW except ANALYTICS.

Changed: licenseType in query

Filter by license type (optional)

Return Type:

Changed response : 200 OK

Returns the entitlements.

• Changed content type : application/json

  Changed items (object):

  • Changed property deviceType (string)

    Added enum values:

    • SLTN_PIN_FOR_IDENTITY
    • SLTN_TOKEN
    • SLTN_PMS_INTEGRATION

  • Changed property almLicenseType (string)

    Added enum value:

    • SLTN_TOKEN Changed response : 404 Not Found

This tenant does not exist.

• Changed content type : application/json

  • Added property reason (string)

  • Added property suggestion (string)

Changed response : 417 Expectation Failed

Entitlement ID is missing.

• Changed content type : application/json

  • Added property reason (string)

  • Added property suggestion (string)

PATCH /entitlements

Request:

Changed content type : application/vnd.ruckus.v1+json

• Added property refreshType (string)

  Enum values:

  • FULL
  • DELTA Changed content type : application/json

• Added property refreshType (string)

Return Type:

Changed response : 404 Not Found

Tenant not found.

• Changed content type : application/vnd.ruckus.v1+json

  • Added property reason (string)

  • Added property suggestion (string)

• Changed content type : application/json

  • Added property reason (string)

  • Added property suggestion (string)

Changed response : 417 Expectation Failed

Entitlement ID is missing. At least one tenant subscription must be active.

• Changed content type : application/vnd.ruckus.v1+json

  • Added property reason (string)

  • Added property suggestion (string)

• Changed content type : application/json

  • Added property reason (string)

  • Added property suggestion (string)

Changed response : 500 Internal Server Error

Internal Server Error

• Changed content type : application/json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

• Changed content type : application/vnd.ruckus.v1+json

  • Changed property error (object)

    • Added property reason (string)

    • Added property suggestion (string)

GET /banners

Parameters:

Changed: type in query

Filter by device type (Optional). If device agnostic sku feature is enabled, all device types will be treated as APSW except ANALYTICS.

Changed: licenseType in query

Filter by license type (optional)

Return Type:

Changed response : 200 OK

OK

• Changed content type : application/json

  Changed items (object):

  • Changed property deviceType (string)

    Added enum values:

    • SLTN_PIN_FOR_IDENTITY
    • SLTN_TOKEN
    • SLTN_PMS_INTEGRATION

  • Changed property licenseType (string)

    Added enum value:

    • SLTN_TOKEN

  • Changed property almExtraInfo (object)

    • Changed property licenseType (string)

      Added enum value:

      • SLTN_TOKEN

POST /macRegistrationPools/{poolId}/registrations/query

Request:

New content type : application/vnd.ruckus.v1+json

Return Type:

Changed response : 200 OK

Registrations

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Changed property content (array)

    Changed items (object):

    A MAC registration

    • Added property isReferenced (boolean)

      This registration is referenced by an identity and cannot be deleted.

    • Added property _links (object)

    • Deleted property identityId (string)

      Identifier of linked service.

    • Deleted property links (array)

    • Changed property username (string)

      A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

    • Changed property email (string)

      The email to associate with this device.

    • Changed property location (string)

      The location of this device.

    • Changed property deviceName (string)

      Device name

DELETE /macRegistrationPools/{poolId}/registrations

Request:

New content type : application/vnd.ruckus.v1+json

Return Type:

New response : 202 Accepted

The registration bulk delete request is in progress

Changed response : 200 OK

Registration deleted

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

Changed response : 400 Bad Request

Invalid ids supplied

• New content type : application/vnd.ruckus.v1.1+json

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property status (string)

  • Added property timestamp (string)

  • Added property message (string)

  • Added property debugMessage (string)

  • Added property subErrors (array)

POST /macRegistrationPools/{poolId}/registrations

Request:

New content type : application/vnd.ruckus.v1+json

Changed content type : application/json

• Added property isReferenced (boolean)

  This registration is referenced by an identity and cannot be deleted.

• Added property _links (object)

• Deleted property identityId (string)

  Identifier of linked service.

• Changed property username (string)

  A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

• Changed property email (string)

  The email to associate with this device.

• Changed property location (string)

  The location of this device.

• Changed property deviceName (string)

  Device name

Return Type:

New response : 202 Accepted

The registration create request is in progress

Changed response : 400 Bad Request

Invalid content supplied

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property status (string)

  • Added property timestamp (string)

  • Added property message (string)

  • Added property debugMessage (string)

  • Added property subErrors (array)

Changed response : 419 Insufficient Space On Resource

Exceed max registrations of the pool

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property status (string)

  • Added property timestamp (string)

  • Added property message (string)

  • Added property debugMessage (string)

  • Added property subErrors (array)

Changed response : 201 Created

Registration pool created

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Added property isReferenced (boolean)

    This registration is referenced by an identity and cannot be deleted.

  • Added property _links (object)

  • Deleted property identityId (string)

    Identifier of linked service.

  • Deleted property links (array)

  • Changed property username (string)

    A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

  • Changed property email (string)

    The email to associate with this device.

  • Changed property location (string)

    The location of this device.

  • Changed property deviceName (string)

    Device name

GET /macRegistrationPools/{poolId}/registrations

Return Type:

Changed response : 200 OK

Registrations

• New content type : application/vnd.ruckus.v1+json

• Changed content type : application/json

  • Changed property content (array)

    Changed items (object):

    A MAC registration

    • Added property isReferenced (boolean)

      This registration is referenced by an identity and cannot be deleted.

    • Added property _links (object)

    • Deleted property identityId (string)

      Identifier of linked service.

    • Deleted property links (array)

    • Changed property username (string)

      A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

    • Changed property email (string)

      The email to associate with this device.

    • Changed property location (string)

      The location of this device.

    • Changed property deviceName (string)

      Device name