Get user certificates
Gets the list of certificates that are associated with a specified user. Retired certificates are filtered from the list.
Note
The URLs in this article are relative to the hostname that's chosen during API deployment, such as https://api.contoso.com.
Request
| Method | Request URL |
|---|---|
| GET | /CertificateManagement/api/v1.0/certificates |
URL parameters
None.
Request headers
For common request headers, see HTTP request and response headers in CM REST API service details.
Request body
None.
Response
This section describes the response.
Response codes
| Code | Description |
|---|---|
| 200 | OK |
| 204 | No content |
| 403 | Forbidden |
| 500 | Internal Error |
Response headers
For common response headers, see HTTP request and response headers in CM REST API service details.
Response body
On success, returns a list of JSON-serialized Microsoft.Clm.Shared.Certificates.X509ClmCertificate objects with the following properties:
| Name | Description |
|---|---|
| ArchivedOnCa | A Boolean value that indicates if the certificate is archived on the certification authority (CA). |
| CertificateType | The type of the certificate. |
| IsKeyHistory | A Boolean value that indicates if the certificate is a key history certificate. |
| Issuer | The issuer. |
| NotAfter | The date and time after which the certificate is no longer valid. |
| NotBefore | The date and time at which the certificate becomes valid. |
| RequesterName | The account that requested the certificate. |
| SerialNumber | The certificate's serial number. |
| Status | The status of the certificate. |
| TemplateCommonName | The certificate template common name for the certificate. |
| Thumbprint | The certificate's thumbprint. |
Example
This section provides an example to get the certificates that are associated with a user.
Example: Request
GET /certificatemanagement/api/v1.0/certificates HTTP/1.1
Example: Response
HTTP/1.1 200 OK
[
{
"IsKeyHistory":false,
"ArchivedOnCa":false,
"CertificateType":1,
"TemplateCommonName":"KSPusercertificate",
"SerialNumber":"270000013C3A98764EC3233BE400000000013C",
"Thumbprint":"09B41AC106F0C40168940DF4AB74D6DB39DE55EE",
"NotAfter":"2016-07-13T09:10:31",
"NotBefore":"2015-07-14T09:10:31",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
},
{
"IsKeyHistory":false,
"ArchivedOnCa":false,
"CertificateType":1,
"TemplateCommonName":"KSPusercertificate",
"SerialNumber":"270000013B957A5513AF6CE2B200000000013B",
"Thumbprint":"7F0248836E7B93FE2B0357F19269C7134B449376",
"NotAfter":"2016-07-13T08:59:51",
"NotBefore":"2015-07-14T08:59:51",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
},
{
"IsKeyHistory":false,
"ArchivedOnCa":false,
"CertificateType":1,
"TemplateCommonName":"KSPusercertificate",
"SerialNumber":"270000013A68D58660B37FA7BB00000000013A",
"Thumbprint":"67DDEE9CF2C417832305714FF4F64175CC2F8963",
"NotAfter":"2016-07-13T08:56:31",
"NotBefore":"2015-07-14T08:56:31",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
},
{
"IsKeyHistory":false,
"ArchivedOnCa":true,
"CertificateType":1,
"TemplateCommonName":"ArchivedCertificateTemplate",
"SerialNumber":"27000001392838861E9DA725C9000000000139",
"Thumbprint":"352650D413262E53389908E73BDF5DBAAEEA0D81",
"NotAfter":"2016-07-13T08:08:50",
"NotBefore":"2015-07-14T08:08:50",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
},
{
"IsKeyHistory":false,
"ArchivedOnCa":false,
"CertificateType":1,
"TemplateCommonName":"KSPusercertificate",
"SerialNumber":"2700000137D1C6649BE84FAC2B000000000137",
"Thumbprint":"9170C7E38126C6B87C5B4F8A50FC3CE261B59BBF",
"NotAfter":"2016-07-13T07:14:43",
"NotBefore":"2015-07-14T07:14:43",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
},
{
"IsKeyHistory":false,
"ArchivedOnCa":true,
"CertificateType":1,
"TemplateCommonName":"ArchivedCertificateTemplate",
"SerialNumber":"270000012D12ED47DEF778AE5200000000012D",
"Thumbprint":"E5CDBFA02072E0A19EFACAA5C009E2DBD4DA8CEC",
"NotAfter":"2016-07-12T11:48:02",
"NotBefore":"2015-07-13T11:48:02",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
},
{
"IsKeyHistory":false,
"ArchivedOnCa":false,
"CertificateType":1,
"TemplateCommonName":"CopyofUser",
"SerialNumber":"270000012B1EFE271640C75D5800000000012B",
"Thumbprint":"88C815E8A5FB40EE71907327061491B7F402EBA3",
"NotAfter":"2016-07-12T11:47:09",
"NotBefore":"2015-07-13T11:47:09",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
},
{
"IsKeyHistory":false,
"ArchivedOnCa":false,
"CertificateType":1,
"TemplateCommonName":"KSPusercertificate",
"SerialNumber":"270000011D0E1C76C5EA0FA94500000000011D",
"Thumbprint":"CCFC28DB6E5A48149ACD0E2D787F5E239E686809",
"NotAfter":"2016-05-03T08:04:31",
"NotBefore":"2015-05-04T08:04:31",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
},
{
"IsKeyHistory":false,
"ArchivedOnCa":false,
"CertificateType":1,
"TemplateCommonName":"KSPusercertificate",
"SerialNumber":"270000011A5CC01932CACC661F00000000011A",
"Thumbprint":"1190AFFBDA94333C5659BAAD63B566C10EC24620",
"NotAfter":"2016-05-03T06:31:04",
"NotBefore":"2015-05-04T06:31:04",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
},
{
"IsKeyHistory":false,
"ArchivedOnCa":false,
"CertificateType":1,
"TemplateCommonName":"KSPusercertificate",
"SerialNumber":"2700000118E402E672C46BBD5C000000000118",
"Thumbprint":"3D04D0F4FF932A7888A331A762BA46E51DAAE415",
"NotAfter":"2016-04-27T16:35:03",
"NotBefore":"2015-04-28T16:35:03",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
},
{
"IsKeyHistory":false,
"ArchivedOnCa":false,
"CertificateType":1,
"TemplateCommonName":"KSPusercertificate",
"SerialNumber":"270000011685A0CE1F819B1917000000000116",
"Thumbprint":"FF5FE72A35E9C17AB060805CC9BF84C0799BFBCA",
"NotAfter":"2016-04-27T11:53:53",
"NotBefore":"2015-04-28T11:53:53",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
},
{
"IsKeyHistory":false,
"ArchivedOnCa":false,
"CertificateType":1,
"TemplateCommonName":"KSPusercertificate",
"SerialNumber":"2700000112A2339B46DC1E8B0C000000000112",
"Thumbprint":"A3A4E733FE7CB19FC213C15378115101A752855F",
"NotAfter":"2016-04-27T07:35:47",
"NotBefore":"2015-04-28T07:35:47",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
},
{
"IsKeyHistory":false,
"ArchivedOnCa":false,
"CertificateType":1,
"TemplateCommonName":"KSPusercertificate",
"SerialNumber":"270000011149EFD78B17F120CF000000000111",
"Thumbprint":"4EFB6E9AB584186054005F0514B6D692F263629C",
"NotAfter":"2016-04-27T07:34:26",
"NotBefore":"2015-04-28T07:34:26",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
},
{
"IsKeyHistory":false,
"ArchivedOnCa":false,
"CertificateType":1,
"TemplateCommonName":"KSPusercertificate",
"SerialNumber":"270000011070FD397CBEC70535000000000110",
"Thumbprint":"5A584340294C88157F901366FF7E887FD7B05F1E",
"NotAfter":"2016-04-27T07:32:48",
"NotBefore":"2015-04-28T07:32:48",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
},
{
"IsKeyHistory":false,
"ArchivedOnCa":false,
"CertificateType":1,
"TemplateCommonName":"KSPusercertificate",
"SerialNumber":"270000010F87F9FEE060CC024A00000000010F",
"Thumbprint":"7E7E74AACF0581DD9C374E85C7A74BEFCF6608EF",
"NotAfter":"2016-04-26T14:50:15",
"NotBefore":"2015-04-27T14:50:15",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
},
{
"IsKeyHistory":false,
"ArchivedOnCa":false,
"CertificateType":1,
"TemplateCommonName":"KSPusercertificate",
"SerialNumber":"27000000D9AABE8619E368DC760000000000D9",
"Thumbprint":"4809C9291679527E1A943387144E1E7CC2863AA3",
"NotAfter":"2016-01-20T09:21:13",
"NotBefore":"2015-01-20T09:21:13",
"Issuer":"WIN-TRUR24L4CFS.corp.cmteam.com\\corp-WIN-TRUR24L4CFS-CA",
"RequesterName":"CORP\\Administrator",
"Status":0
}
]
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for