Device

You can use REST API v2 calls to obtain information about a device that gets registered during a enrollment.
New for 5.8

The following table lists the properties that can be used in the body of a device-related request and/or are provided in the response body. (In the "Optional" column, if a default value is applicable, it is listed in angle brackets (< >).)

Resource: Device

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
name String No sortBy, like No The type of the device; for example Windows 10.
operatingSystem <Object> Embedded No None No The operating system details that were obtained.
browser String No None No The browser used.
browserAgent String No None No The user-agent string detected on the server.
browserManufacturer String No None No The manufacturer of the browser used.
browserVersion String No None Yes The version of the browser used.
formFactor String No None Yes The form factor of the device used.
computerName String No None Yes The name of the computer.
computerManufacturer String No None Yes The manufacturer of the device.
computerModel String No None Yes The model number or model name of the device.
nic <Object> Embedded No None Yes The information on the nic, if obtained.
links String No None No Self-referencing link, and enrollment link.

Resource: OperatingSystem

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
name String No sortBy, like No The name of the operating system that the device is running.
manufacturer String No None Yes The manufacturer of the operating system that the device is running.
family String No None Yes The family of the operating system that the device is running.
version String No None Yes The version of the operating system that the device is running.
servicePack String No None Yes The service pack of the operating system that the device is running.
bits String No None Yes The number of bits (32, 64) of the operating system that the device is running.

Resource: Nic

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
type String No sortBy, like No The type of interface for the NIC used.
displayName String No None Yes The display name of the NIC used.
macAddress String No None Yes The MAC address of the NIC used.
model String No None Yes The model number or model name of the NIC used.
name String No None Yes The name of the NIC.
logicalName String No None Yes The logical or display name of the NIC.

Device URIs and Actions

The following table indicates the URIs that you can append to the root URI, along with the actions you can take, and possible return codes you can receive.

Device URIs and Actions

URI Action Description Return Codes
/enrollments/{guid}/device GET Returns information about the device that was registered with this enrollment.

404 - Not found

401 - Unauthorized

200 - Ok

     

Example of Using GET for Device

This example demonstrates how to obtain information about a device that is registered during an enrollment.

URI:

This example uses the following URI:

 https://Jeff245.cloudpath.net/admin/apiv2/yRCjJObWR6ER/enrollments/Enrollment-4718fcaa-d04f-43c3-a3f0-6ef3af6b9d59/device

where:

  • https://Jeff245.cloudpath.net/admin/apiv2 is the root URI of the Cloudpath system being used (must include https, as shown)
  • yRCjJObWR6ER is an example of an API key generated from the Configuration > API Keys section of the Cloudpath UI
  • Enrollment-4718fcaa-d04f-43c3-a3f0-6ef3af6b9d59 is the GUID of the enrollment

Request Headers:

The following table shows the required request headers for this URI example, with an example value of an active token that must be pasted into the Authorization header value:

Request Headers

Key Value
Content-type application/json
Authorization eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqZWZmLnJob2RpZUBjb21tc2NvcGUuY29tIiwicm9sZVBrIjoiMjEwMDAiLCJhY2NvdW50QWRtaW5QayI6IjIiLCJhcGlLZXkiOiJaV2NjTGpQZUdZMGUiLCJpYXQiOjE1NzU1NzUxNTcsImV4cCI6MTU3NTU3NTQ1N30.2q4KTyDUevkAAz7mJyp529Be1-ip3EC8P06Xarmz5ao

Request Body:

None required.

Action:

Use the GET action to send the request.

Response Body:

Once the request is sent, you will receive a "Status: 200 OK" if the GET is successful. The response body provides information about the device of the enrollment that was specified.

{
    "name": "Windows 10",
    "browser": "Chrome 8",
    "browserAgent": "Browser",
    "browserManufacturer": "Google Inc.",
    "browserVersion": "87.0.4280.141",
    "formFactor": "Computer",
    "links": [
        {
            "rel": "self",
            "href": "https://jeff245.cloudpath.net/admin/apiv2/yRCjJObWR6ER/enrollments/Enrollment-4718fcaa-d04f-43c3-a3f0-6ef3af6b9d59/device",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        },
        {
            "rel": "parent",
            "href": "/apiv2/yRCjJObWR6ER/enrollments/Enrollment-4718fcaa-d04f-43c3-a3f0-6ef3af6b9d59",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        }
    ]
}