Use this API to get details for specified requests.
Parameter |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|
uuid |
Mandatory | string |
UUID of the certificate |
approverUserNames (array) |
Mandatory | array |
Array of valid user names. User roles must be manager, PKI admin or approvers. |
requesterUserName |
Optional | string |
Requester user name. |
intermediateCA |
Mandatory | object |
Intermediate Certificate Authority information. Make sure: - At least one of the params certhash, commonName or serialNumber is required. - CA is DigiCert's public intermediate CA - CA is configured with CA API key |
certhash |
Optional | string |
Provide hash of the certificate. |
commonName |
Optional | string |
Fully qualified domain name of the Web server that will receive the certificate |
serialNumber |
Optional | string |
A short, unique identifier for each certificate generated by the certificate issuer |
certificate |
Mandatory | object |
Provide Certificate details like commonName,organizationUnits as a json Object |
commonName (string) |
Mandatory | string |
Provide a wildcard character if the product name is of wildcard type. |
csr (object) |
Mandatory | object |
Certificate Signing Request Information |
autoGenerateCSR |
Optional | boolean |
If this flag is set to True then Qualys will generate csr value and return private key info in the response of the API. If this field is set to True then encoded_csr field can not be set By default the value is set to False. |
encodedCSR |
Optional | string |
A valid Encoded Certificate Signing Request |
organizationUnits |
Optional | array |
provide value for the OU field for the certificate. |
signatureHash |
Mandatory | string |
Certificate's signing algorithm hash. Accepted values: SHA-256, SHA-384, SHA-512 |
renewal |
Optional | object |
Required for certificate renewal request. |
digicertPreviousOrderId |
Mandatory | integer |
If the request is a renewal of a previous request then add the previous request id. |
renewalOfCertificate |
Mandatory | string |
Provide certhash of the old certificate for which this renewal request is required. Make sure:
|
validity |
Mandatory | object |
Provide any one of the following values: customExpirationDate, validityYears and validityDays params Make sure only one value is provided in a request. |
customExpirationDate |
Optional | date |
Expiry date of the certificate |
validityYears |
Optional | integer |
Number of years that the certificate is valid |
validityDays |
Optional | integer |
Number of days that the certificate is valid |
digicertOrganizationId |
Mandatory | integer |
Get organization id using List DigiCert Organizations API |
digicertProductNameId |
Mandatory | integer |
Get product name id using List DigiCert Products API |
digicertEVApproverUserIds |
Optional | array |
Required when product name is of EV type. Get EV Approvers user id using List Digicert EV Approvers API |
status |
Optional | string |
Provide any of the following values: CANCELLED, APPROVED, SUBMITTED, ISSUED |
caStatus |
Optional | string |
Status from the Certificate Authority |
created |
Optional | date |
Date the request was created |
updated |
Optional | date |
Date the request was updated |
API Request
curl -X GET
"<qualys_base_url>/certview/v1/certificates/digicert/orders/cb95d100-ec30-11ea-920d-eb66140967e3"
-H "Accept: application/json"
-H "Content-Type: application/json" -
H "Authorization: Bearer <jwt token>"
Response
{
"uuid": "cb95d100-ec30-11ea-920d-eb66140967e3",
"intermediateCA": {
"name": "DigiCert Test SHA2 Intermediate CA-1",
"certhash": "a52d05988b61a33d6ac3edb449eb47150fa5b7a26c7dfc4e61f905ca36e165ee"
},
"approverUserNames": [
"doe_john"
],
"requesterUserName": "doe_john",
"certificate": {
"commonName": "example.com",
"organizationUnits": [
"QA"
],
"signatureHash": "SHA-256",
"encodedCSR": "string",
"privateKey": null,
"dnsNames": null
},
"renewal": null,
"validity": {
"validityYears": 1,
"validityDays": null,
"customExpirationDate": null
},
"digicertOrganization": {
"id": 525858
},
"digicertProductNameId": "private_ssl_plus",
"digicertEVApproverUserIds": null,
"status": "SUBMITTED",
"caStatus": "",
"created": "2020-09-01T08:54:50.473+0000",
"updated": "2020-09-01T08:58:58.138+0000"
}