Enrollments

You can use REST API calls to obtain information about existing enrollments or to edit enrollments.

The following table lists the properties that can be used in the body of an enrollment-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: Enrollment

Property Name	Type	Editable	Sort/Filter	Optional in Request/Response Body?	Description
guid	String	No	orderBy, like	No	The unique identifier for this enrollment..
status	enum <String>	Yes	orderBy, in eq	No	Shows the status of this enrollment. The only enrollment that can be BLOCKED is an ACTIVE enrollment. If you unblock an enrollment, it can only return to ACTIVE status. Changing an active enrollment to BLOCKED revokes the enrollment. All other status changes are ignored. The status will be one of the following: INITIATED - Enrollment has been started, SUBMITTED - Enrollment is proceeding through the wizard. APPROVED - The user or device has met the requirements. REJECTED - The user or device failed to meet the workflow requirements. ACTIVE - The enrollment has completed and was issued a certificate, PEAP, or DPSK. BLOCKED - The enrollment has been BLOCKED. ABANDONED - Certificate was never picked up. EXPIRED - The user/device has expired. COMPLETED_BEFORE_AUTHORIZATION - Did not finish authorization but reached a dead end.
createdDate	DateTime	No	orderBy	Yes	(ISO 8601) The date that this enrollment was initially created. Will be provided if the enrollment was blocked.
blockedReason	String	Yes	neither	Yes/No	Will be returned while the status is blocked.
blockedDate	DateTime	No	neither	Yes	(ISO 8601) The date that this enrollment was blocked. Will be provided if the enrollment was blocked.
ipAddress	String	No	orderBy, like	Yes	The IP address for the enrollment agent.
macAddress	String	No	orderBy, like	Yes	The MAC address associated with the enrollment.
name	String	No	orderBy, like	Yes	The name of the user.
email	String	No	orderBy, like	Yes	The email address of the user, as specified by the authentication server.
location	String	No	orderBy, like	Yes	The deployment location that was accessed.
operatingSystem	String	No	neither	Yes	The name of the operating system on the device.
browser	String	No	neither	Yes	The browser used during enrollment.
formFactor	String	No	neither	Yes	The type of device used in the enrolment.
expirationDate	DateTime	No	orderBy	Yes	(ISO 8601) The date that this enrollment expires.
voucherApprovalDate	DateTime	No	orderBy	Yes	(ISO 8601) The date that this enrollment was approved through a voucher. If this enrollment does not use a voucher, no date is provided.
outputType	Enum <String>	No	orderBy, like	No	The type of output from this enrollment: WIZARD_AND_CERTIFICATE, WIZARD_ONLY, CERTIFICATE_ONLY, or NONE
links		NO			Self-referencing link, and links for: user, device, certificate, dpsks, macRegistration, certificates, and variables.

Enrollment 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.

Enrollment URIs and Actions

URI	Action	Description	Return Codes
/enrollments	GET	Returns the list of enrollments in the system.	401 - Unauthorized 200 - Ok
/enrollments/{guid}	GET	Returns details about the specified enrollment.	404 - Not found 401 - Unauthorized 200 - Ok
/enrollments/{guid}	PUT	Only allows the following for this enrollment: Changing an ACTIVE status to BLOCKED. Returning a BLOCKED status to ACTIVE.	404 - Not found 401 - Unauthorized 200 - Ok
/enrollments/{guid}/dpsks	GET	Returns the list of DPSKS assigned during this enrollment process. Note: The self-referencing link points back to: /enrollments/{guid}/	404 - Not found 401 - Unauthorized 200 - Ok

Example of Using GET for Enrollments

This example demonstrates how to obtain information about all enrollments.

URI:

This example uses the following URI:

 https://Jeff245.cloudpath.net/admin/publicApi/enrollments

where https://Jeff245.cloudpath.net/admin/publicApi is the root URI of the Cloudpath system being used (must include https, as shown).

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 all existing enrollments, including any abandoned ones (included in the example below).

{
    "page": {
        "page": 1,
        "pageSize": 5,
        "totalCount": 5
    },
    "contents": [
        {
            "guid": "Enrollment-4718fcaa-d04f-43c3-a3f0-6ef3af6b9d59",
            "status": "ACTIVE",
            "ipAddress": "10.45.245.129",
            "macAddress": "",
            "location": "",
            "operatingSystem": "Windows 10",
            "browser": "Chrome 8",
            "formFactor": "",
            "expirationDate": "2021-02-18T04:45:11Z",
            "voucherApprovalDate": "2021-02-18T04:15:11Z",
            "outputType": "NONE",
            "createdDate": "2021-02-18T04:15:05Z",
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-4718fcaa-d04f-43c3-a3f0-6ef3af6b9d59",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "device",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-4718fcaa-d04f-43c3-a3f0-6ef3af6b9d59/device",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "dpsks",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-4718fcaa-d04f-43c3-a3f0-6ef3af6b9d59/dpsks",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "macRegistrations",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-4718fcaa-d04f-43c3-a3f0-6ef3af6b9d59/macRegistrations",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "variables",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-4718fcaa-d04f-43c3-a3f0-6ef3af6b9d59/variables",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "Enrollment-6178b32e-94c2-47ec-a9c4-5942b016cb19",
            "status": "ACTIVE",
            "ipAddress": "10.45.245.129",
            "macAddress": "",
            "location": "",
            "operatingSystem": "Windows 10",
            "browser": "Chrome 8",
            "formFactor": "",
            "expirationDate": "2021-02-18T04:45:02Z",
            "voucherApprovalDate": "2021-02-18T04:15:02Z",
            "outputType": "NONE",
            "createdDate": "2021-02-18T04:14:53Z",
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-6178b32e-94c2-47ec-a9c4-5942b016cb19",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "device",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-6178b32e-94c2-47ec-a9c4-5942b016cb19/device",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "dpsks",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-6178b32e-94c2-47ec-a9c4-5942b016cb19/dpsks",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "macRegistrations",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-6178b32e-94c2-47ec-a9c4-5942b016cb19/macRegistrations",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "variables",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-6178b32e-94c2-47ec-a9c4-5942b016cb19/variables",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "Enrollment-4ef63fa5-4429-40c0-a57e-43bb1eac1f65",
            "status": "ACTIVE",
            "ipAddress": "10.45.245.129",
            "macAddress": "",
            "location": "",
            "operatingSystem": "Windows 10",
            "browser": "Chrome 8",
            "formFactor": "",
            "expirationDate": "2021-02-18T04:44:45Z",
            "voucherApprovalDate": "2021-02-18T04:14:45Z",
            "outputType": "NONE",
            "createdDate": "2021-02-18T04:14:29Z",
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-4ef63fa5-4429-40c0-a57e-43bb1eac1f65",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "device",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-4ef63fa5-4429-40c0-a57e-43bb1eac1f65/device",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "dpsks",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-4ef63fa5-4429-40c0-a57e-43bb1eac1f65/dpsks",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "macRegistrations",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-4ef63fa5-4429-40c0-a57e-43bb1eac1f65/macRegistrations",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "variables",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-4ef63fa5-4429-40c0-a57e-43bb1eac1f65/variables",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "Enrollment-73ca7a79-8f34-4735-b6e8-ac416580e417",
            "status": "ACTIVE",
            "ipAddress": "10.45.245.129",
            "macAddress": "",
            "location": "",
            "operatingSystem": "Windows 10",
            "browser": "Chrome 8",
            "formFactor": "",
            "expirationDate": "2021-02-18T04:41:34Z",
            "voucherApprovalDate": "2021-02-18T04:11:34Z",
            "outputType": "NONE",
            "createdDate": "2021-02-18T04:11:26Z",
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-73ca7a79-8f34-4735-b6e8-ac416580e417",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "device",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-73ca7a79-8f34-4735-b6e8-ac416580e417/device",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "dpsks",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-73ca7a79-8f34-4735-b6e8-ac416580e417/dpsks",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "macRegistrations",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-73ca7a79-8f34-4735-b6e8-ac416580e417/macRegistrations",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "variables",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-73ca7a79-8f34-4735-b6e8-ac416580e417/variables",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "Enrollment-7084b41a-ed46-48bd-97fb-3b5247f637b0",
            "status": "ABANDONED",
            "ipAddress": "10.45.245.129",
            "macAddress": "",
            "location": "",
            "operatingSystem": "Windows 10",
            "browser": "Chrome 8",
            "formFactor": "",
            "outputType": "NONE",
            "createdDate": "2021-02-18T04:06:44Z",
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-7084b41a-ed46-48bd-97fb-3b5247f637b0",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "device",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-7084b41a-ed46-48bd-97fb-3b5247f637b0/device",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "dpsks",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-7084b41a-ed46-48bd-97fb-3b5247f637b0/dpsks",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "macRegistrations",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-7084b41a-ed46-48bd-97fb-3b5247f637b0/macRegistrations",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "variables",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/enrollments/Enrollment-7084b41a-ed46-48bd-97fb-3b5247f637b0/variables",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        }
    ]
}