GET Certificates/{guid}
Retrieves details and validation information about a certificate.
This API call confirms:
- The target host information matches the Host, Fully Qualified Domain Name (FQDN), or common name with Policy tree information.
- The communications protocol and connectivity with the target host.
- The certificate is valid for the target host.
Venafi Trust Protection Platform has updated certificate association data retrieval processes that use the UI and websdk APIs. The update optimizes the retrieval process by fetching data from new tables, where certificate strings such as common name, organization, organization unit, locality, state, country, and subject alternative names are normalized in a case-insensitive name table. However, the casing of the first added string pattern will determine the value returned for any related query. For instance, if a certificate is imported with 'CN=MyCommonName' and another certificate with 'CN=mycommonname', the returned value for any query will be 'CN=MyCommonName'.
The update also reduces database size by removing most certificate secret store associations from the store_associations table. As a result, the secret store association REST APIs for certificates have been officially deprecated and will no longer work for many certificate-specific associations. Instead, use the certificates REST APIs, which are documented in the Certificates API documentation. These changes impact users performing an upgrade, and it is essential to ensure that all certificates are managed correctly after the upgrade.
Requirements
- Permissions: The caller must have View permission and Read permission.
- Token scope: Certificate
Headers
-
Content type: Content-Type:application/json.
- Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.
Parameters
|
Name |
Description |
|---|---|
|
{guid} |
The Config GUID for the Certificate object. To get the GUID, call POST Config/DnToGuid. For example, {2b6b673f-2c55-46fc-935a-5836eae9b9db}. |
Returns
The Certificates/{guid} API call returns the status of certificate validation. For example, to confirm the certificate status, you can review the Certificate Details,ProcessingDetails, RenewalDetails, or ValidationDetails.
For invalid requests, Certificates/{guid} returns:
- HTTP 404 Not Found.
- HTTP 400 Bad Request and .
For valid requests, this API returns a HTTP 200 message and the following data in the message body.
|
Name |
Description |
|---|---|
|
HTTP 200 |
For valid requests, this call returns a HTTP 200 message and the following data in the message body:
|
| HTTP 400 |
For invalid requests, this call returns a HTTP 400 BadRequest and the following data in the message body: ErrorDetails: Returns a Bad Request for errors and the reason appears in the Error field of the message body. |
| HTTP 404 | Not Found |
A collection of certificate Information
Example: View the status of a certificate
To learn about a certificate status, you can review ProcessingDetails, RenewalDetails, or ValidationDetails.
Request
GET https://test.venafi.example/vedsdk/certificates/
{2b6b673f-2c55-46fc-935a-5836eae9b9db}
Authorization:Bearer 4MyGeneratedBearerTknz==
Response
HTTP/1.1 200 OK
{
"Approver":[
"local:{cd2e9fd1-8c0a-4a00-b6b3-e1de501e5b6e}"
],
"CertificateDetails":{
"AIACAIssuerURL":[
"0:http:\/\/qavenafica.venqa.venafi.com\/CertEnroll\/qavenafica.venqa.venafi .com_QA%20Venafi%20CA.crt",
"1:ldap:\/\/\/CN=QA%20Venafi%20CA,CN=AIA,CN=Public%20Key%20Services,CN=Services,CN=Configuration,
DC=venqa,DC=venafi,DC=com?cACertificate?base?objectClas s=certificationAuthority"
],
"AIAKeyIdentifier":"3CAC9CA6...",
"CN":"MyCertificate",
"EnhancedKeyUsage":"Server Authentication (1.3.6.1.5.5.7.3.1)
Smart Card Logon (1.3.6.1.4.1.311.20.2.2)",
"Issuer":"CN=hoho",
"KeyAlgorithm":"RSA",
"KeySize":2048,
"PublicKeyHash":"4D93BA33FA4DBC2E6FCB0F1BCC57DFA795659EB4",
"Serial":"01",
"SignatureAlgorithm":"sha1RSA",
"SignatureAlgorithmOID":"1.2.840.113549.1.1.5",
"StoreAdded":"2017-12-13T17:51:54.4437541Z",
"Subject":"CN=hoho",
"Thumbprint":"95CD28BB7DB2067A8DCB0938DEFE0792F9E9BD32",
"ValidFrom":"2017-11-23T14:25:00.0000000Z",
"ValidTo":"2018-11-23T14:25:00.0000000Z"
},
"Contact":[
"local:{cd2e9fd1-8c0a-4a00-b6b3-e1de501e5b6e}"
],
"CreatedOn":"2017-12-13T17:49:28.8028346Z",
"DN":"\\VED\\Policy\\Reputation\\digicert_test",
"Guid":"{941e5574-e467-46c4-a735-e5daaa65832b}",
"Name":"digicert_test",
"ParentDn":"\\VED\\Policy\\Reputation",
"ProcessingDetails":{
"InError":true,
"Stage":500,
"Status":"Access denied due to access_denied_invalid_key."
},
"RenewalDetails":{
"Subject":"hoho"
},
"SchemaClass":"X509 Server Certificate",
"ValidationDetails":{
"LastValidationStateUpdate":"2017-12-15T23:05:37.0000000Z",
"ValidationState":"Failure"
}
}