External Queries

Certain external queries (checkCapability and authorizeDevice) require the location URL name, which is specified in the URL Name field on the Configuration > Workflows Properties tab.

Location URL Name

The examples in this section use Production for the locationUrlName.

In this section:

  1. Device Capabilities Query
    Queries the capabilities of a device based on the user agent and device configuration. An HS2R1 or HS2R2 response value is returned only if the HS2R1/HS2R2 SSID Type has been set for the device configuration.
  2. Device Authorization
    Authorizes a device using the customer account number and optional parameters
  3. Change MAC Address
    Changes the MAC address for an enrollment record.
  4. Get Device Information by Certificate Serial Number
    Queries the customer account number and MAC address associated with a certificate serial number. The associated information is returned regardless of revocation status.
  5. Get Devices Associated with a Customer Account Number
    Returns all devices associated with a customer account number.
  6. Get Device Information by MAC Address and Customer Account Number
    Returns the data associated with a customer account number and specified MAC address.
  7. Revoke Certificate by MAC Address and Customer Account Number
    Revokes one or more certificates associated with a customer account number and specified MAC address.
  8. Clear Device Capability Cache (For Testing Only)
    This method allows the cache to be flushed without restarting the server.
  9. Destroy Enrollment Records by Customer Account Number (For Testing Only)
    Allows a call to destroy all elements for a specified customer account number.
  10. Destroy Enrollment Records by GUID
    This method allows a caller to destroy all data related to an enrollment based on the enrollment’s GUID. This causes the enrollment record and all associated data (including certificates) to be permanently deleted.
Parent topic: API Examples