Certificates
The following table lists the properties that can be used in the body of a certificate-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: Certificate
Resource: RadiusUsage
| Property Name | Type | Editable | Sort/Filter | Optional in Request/Response Body? | Description |
|---|---|---|---|---|---|
| issued | DateTime<String> | No | orderBy | No | (ISO 8601) Date/time when the certificate was issued. |
| lastSessionStartTime | DateTime<String> | No | orderBy | yes | (ISO 8601) The time that the current (or latest) session started. |
| lastSessionStopTime | DateTime<String> | No | orderBy | yes | (ISO 8601) The time that the latest session ended. |
| lastIpaddress | String | No | orderBy, like | yes | The last IP address of the client, as reported via RADIUS accounting. |
| lastSsid | String | No | orderBy, like | yes | The SSID for the latest RADIUS authentication or accounting request from the certificate. |
| lastMacAddress | String | No | orderBy, like | Yes | The lastMacAddress string. |
| lastNasId | String | No | orderBy, like | yes | The NAS identifier for the latest RADIUS authentication or accounting request from the certificate. |
| lastNasPort | number | No | orderBy, like | yes | The NAS port ID for the latest RADIUS authentication or accounting request from the certificate. |
| lastOcp | DateTime<String> | No | none | yes | ISO8601- The last time that this certificate was validated via OCSP. This timestamp is updated a maximum of once every 10 minutes. |
| lastPolicyAssigned | String | No | orderBy, like | yes | The last policy assigned, if the template uses policies. |
| lastSuccess | DateTime<String> | No | orderBy | yes | (ISO 8601) The last timestamp that this certificate was successfully authenticated by RADIUS. |
| lastFailure | DateTime<String> | No | orderBy | yes | ISO8601- The last timestamp that this certificate had an unsuccessful attempt at being authenticated by RADIUS. |
Certificate 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.
Certificate URIs and Actions
Example of Using GET for Certificates Within a Specific Certificate Template
This example demonstrates how to obtain information about all certificates within a specific certificate template.
This example uses the following URI:
https://Jeff245.cloudpath.net/admin/publicApi/certificateTemplates/1/certificates
- https://Jeff245.cloudpath.net/admin/publicApi is the root URI of the Cloudpath system being used (must include https, as shown)
- 1 is the GUID for the certificate template from which to obtain a list of all its certificates.
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 |
None required.
Use the GET action to send the request.Once the request is sent, you will receive a "Status: 200 OK" if the GET is successful. The response body provides information about the certificates from the specified certificate template. In this example, only one certificate was issued from the specified certificate template, as shown in the response body below.
{
"page": {
"page": 1,
"pageSize": 1,
"totalCount": 1
},
"contents": [
{
"guid": "1",
"commonName": "jeff245.cloudpath.net",
"status": "ISSUED_AND_CONFIRMED_USE",
"notValidBefore": "2021-01-09T19:38:34Z",
"notValidAfter": "2024-02-09T19:38:34Z",
"serialNumber": "698fae00f75f419d3cfc56a19b49f66c1bc604ff",
"keyLength": 2048,
"shaFingerprint": "80325204AB8104CCC1740408DCADFB33AC1CE19A",
"organization": "Sample Company, Inc.",
"organizationUnit": "IT",
"locality": "Westminster",
"state": "Colorado",
"country": "US",
"radiusUsage": {
"issued": "2021-02-09T19:38:34Z",
"lastIpaddress": "",
"lastSsid": "",
"lastNasId": "",
"lastNasPort": "",
"lastOcp": "2021-02-12T20:05:14Z"
},
"links": [
{
"rel": "parent",
"href": "https://jeff245.cloudpath.net/admin/publicApi/certificateTemplates/1",
"hreflang": null,
"media": null,
"title": null,
"type": null,
"deprecation": null
},
{
"rel": "self",
"href": "https://jeff245.cloudpath.net/admin/publicApi/certificateTemplates/1/certificates/1",
"hreflang": null,
"media": null,
"title": null,
"type": null,
"deprecation": null
}
]
}
]
}