筛选方式: order info endpoint x 清除
enhancement

CertCentral Services API: Improved Order info API response

Update: To give API consumers more time to evaluate the impact of the Order info API response changes on their integrations, we are postponing this update until May 31, 2022. We originally planned to release the changes described below on April 25, 2022.

On May 31, 2022, DigiCert will make the following improvements to the Order info API. These changes remove unused values and update the data structure of the order details object to be more consistent for orders in different states across product types.

For more information and response examples for public TLS, code signing, document signing, and Class 1 S/MIME certificates, see the reference documentation for the Order info endpoint.

If you have questions or need help with these changes, contact your account representative or DigiCert Support.

Need to test your API integration?

To help CertCentral Services API consumers evaluate the impact of these changes, DigiCert is providing a beta server for API consumers to test their integrations prior to the May 31, 2022 release. To learn more, see our knowledge base article: DigiCert CertCentral Services API beta server.


General enhancements

The following changes apply to orders for various certificate types irrespective of order status.

Removed parameters:

  • public_id (string)
    For all orders, the API will stop returning the public_id parameter. DigiCert no longer supports the Express Install workflow that required a public_id value.
  • certificate.ca_cert_id (string)
    For DV certificate orders, the API will stop returning the ca_cert_id parameter. The value of this parameter is an internal ID for the issuing ICA certificate and cannot be used externally. The API already excludes the ca_cert_id parameter from the order details for other product types.

    To get the name and public ID of the issuing ICA certificate associated with the order, use the ca_cert object instead.
  • verified_contacts (array of objects)
    For document signing certificate orders, the API will stop returning the verified_contacts array. The API already excludes the verified_contacts array from the order details for other product types.
  • certificate.dns_names (array of strings)
    If there are no DNS names associated with the order (for example, if the order is for a code signing, document signing, or Class 1 S/MIME certificate), the API will stop returning the dns_names array.

    Before, the API returned a dns_names array with an empty string: [" "]
  • certificate.organization_units (array of strings)
    If there are no organization units associated with the order, the API will stop returning an organization_units array.

    Before, for some product types, the API returned an organization_units array with an empty string: [" "]
  • certificate.cert_validity
    In the cert_validity object, the API will only return a key/value pair for the unit used to set the certificate validity period when the order was created. For example, if the validity period of the certificate is for 1 year, the cert_validity object will return a years parameter with a value of 1.

    Before, the cert_validity object sometimes returned values for both days and years.

Added parameters:

  • order_validity (object)
    For code signing, document signing, and client certificate orders, the API will start returning an order_validity object.

    The order_validity object returns the days, years, or custom_expiration_date for the order validity period. The API already includes an order_validity object in the order details for public SSL/TLS products.
  • payment_profile (object)
    For DV certificate orders, if the order is associated with a saved credit card, the API will start returning a payment_profile object. The API already includes a payment_profile object in the order details for other product types.
  • server_licenses
    For DV certificate orders, the API will start returning the server_licenses parameter. The API already includes the server_licenses parameter in the order details for other product types.

Unapproved order requests

The following changes apply only to certificate order requests that are pending approval or that have been rejected. These changes bring the data structure of the response closer to what the API returns after the request is approved and the order is submitted to DigiCert for validation and issuance.

To manage unapproved and rejected requests, we recommend using the Request endpoints (/request) instead of retrieving the order details. We designed the /request endpoints to manage pending and rejected certificate order requests, and these endpoints remain unchanged.

Note: For quicker certificate issuance, we recommend using a workflow that skips or omits the request approval step for new certificate orders. If your API workflow already skips or omits the approval step, you can safely ignore the changes below. Learn more about removing the approval step:

Added parameters:

  • disable_ct (boolean)
  • allow_duplicates (boolean)
  • cs_provisioning_method (string)

Removed parameters:

  • server_licenses (integer)
    For unapproved order requests, the API will stop returning the server_licenses parameter. The API will continue including the server_licenses parameter in order details for approved order requests.

Improved organization object
To provide a consistent data structure in the order details for unapproved and approved order requests, the API will return a modified organization object on unapproved order requests for some product types.

The API will stop returning the following unexpected properties on unapproved order requests for all product types:

  • organization.status (string)
  • organization.is_hidden (boolean)
  • organization.organization_contact (object)
  • organization.technical_contact (object)
  • organization.contacts (array of objects)

The API will start returning the following expected properties, if existing, on unapproved order requests for all product types:

  • organization.name (string)
  • organization.display_name (string)
  • organization.assumed_name (string)
  • organization.city (string)
  • organization.country (string)

To get organization details not included in the Order info response, use the Organization info API endpoint.

fix

CertCentral Services API: Fixed data type for empty user value in Order info API response

We fixed an issue where the Order info API (GET https://www.digicert.com/services/v2/order/certificate/{{order_id}}) returned the wrong data type for the user field when no user is associated with the order. Now, for orders without user data, the Order info endpoint returns an empty user object ("user": {}) instead of returning an empty array ("user": []).

enhancement

我们改进了与 CertCentral 集成的 SAML 单一登录 (SSO) 的用户邀请工作流,您可以在发送帐户用户邀请之前指定被邀请者作为仅 SSO 用户。现在,在邀请新用户弹窗中,使用仅 SAML 单一登录 (SSO) 选项限制被邀请者为仅 SAML SSO。

注意:此选项为这些用户禁用所有其他身份验证方式。而且,仅当您为 CertCentral 帐户启用 SAML 时,此选项才显示。

(在侧栏菜单中,单击帐户 > 用户邀请。在“用户邀请”页面上,单击邀请新用户。请参阅 SAML SSO:邀请用户加入帐户。)

简化的注册表

我们还简化了仅 SSO 用户注册表,删除了密码和安全问题要求。现在,仅 SSO 被邀请者需仅添加他们的个人信息。

new

我们添加了发现的即将到期的证书,您可以更容易地从帐户中的 CertCentral 仪表板中看到 Discovery 证书扫描结果,证书颁发机构,和按等级分析证书小工具。

每个小工具都包含一个交互式图表,您可以通过钻取以轻松找到有关即将到期的证书的更多信息(例如,哪些证书将在 8 至 15 天内到期)、每个证书颁发机构(例如,DigiCert)颁发的证书以及各安全性等级(例如,不安全)的证书。

有关 Discovery 的更多信息

Discovery 使用传感器扫描您的网络。扫描在您的 CertCentral 帐户内集中配置和管理。

new

在 DigiCert 服务 API 中,我们更新了订单信息端点,您可以查看请求证书的方式。对于通过服务 API 或 ACME 目录 URL 请求的证书,我们返回新的响应参数:api_key. 该参数包括密钥名称以及密钥类型:API 或 ACME。

注意:对于通过其他方式(例如,CertCentral 帐户、来宾请求 URL 等)请求的订单,在响应中忽略 api_key 参数。

现在,在查看订单详情时,对于通过 API 或 ACME 目录 URL 请求的订单,您将在响应中看到新的 api_key 参数:

GET https://dev.digicert.com/services-api/order/certificate/{order_id}

响应:

Order info endpoint response parameter

new

我们在“订单”页面新增了一个搜索筛选项 - 请求方式,您可以搜索通过特定 API 密钥或 ACME 目录 URL 请求的证书订单。

现在,在“订单”页面上,使用请求方式筛选项查找通过特定 API 密钥或 ACME 目录 URL 请求的有效、已到期、已吊销、被拒绝、等待补发、待处理和副本证书。

(在侧栏菜单中,单击证书 > 订单。在“订单”页面上,单击显示高级搜索。然后,在请求方式下拉列表中,选择 API 密钥或 ACME 目录 URL 名称或在框中键入其名称。)