Account management

Use the Account Management endpoints to create subaccounts, manage emergency contact email addresses, and retrieve ACME contract reporting for subaccounts.

For an overview of the Partner Subscriptions API, see Partner Subscriptions API.

Why use it?

  • Create a partner subscriptions subaccount with an API key.
  • Retrieve emergency contact email addresses for the authenticated account.
  • Add emergency contact email addresses to the authenticated account.
  • Remove emergency contact email addresses from the authenticated account.
  • Retrieve ACME contract reporting grouped by subaccount.
  • Retrieve and update account settings, including the default auto-renewal behavior for new ACME contracts.

Resource URL

Use the Partner Subscriptions API account management resource URL to construct Account Management requests.

https://www.digicert.com/partner-subscription/api/v1/account/

Authentication

Account Management endpoints require authentication with a Partner Subscriptions API key.

Include this header in each request:

X-PARTNER-APIKEY: {{partner_api_key}}

Account hierarchy and API key scope

Account Management endpoints use the account scope of the Partner Subscriptions API key sent in the X-PARTNER-APIKEY header.

TypeCapabilities / usage
Parent accountCan create subaccounts, manage emergency contact emails for the authenticated parent account, and retrieve ACME contract reporting across subaccounts.
SubaccountCan manage emergency contact emails for the authenticated subaccount. Subaccounts cannot create subaccounts or access account reporting.
Parent account API keyRequired to create subaccounts and retrieve account reporting. Can also be used to manage emergency contact emails for the authenticated parent account.
Subaccount API keyUsed to manage emergency contact emails for the authenticated subaccount.
Using the wrong Partner Subscriptions API key type can result in a 403 Forbidden response. To create a subaccount or retrieve account reporting, use a parent account API key.

Account settings

Use account settings to configure default behavior for the authenticated account.

The auto_renew_subscription setting controls the default auto-renewal behavior for new ACME contracts. When set to 1, new ACME contracts default to auto-renew enabled unless the create request explicitly sets auto_renew to false. When set to 0, new ACME contracts default to auto-renew disabled unless the create request explicitly sets auto_renew to true.

Emergency contact emails

Emergency contact emails are used for critical security issues or service disruptions.

At least one emergency contact email must remain configured. You cannot remove all emergency contact email addresses from an account.

Endpoints in this section

MethodEndpointDescription
POST/account/subaccountCreate a subaccount with an API key.
GET/account/emergency-emailsGet emergency contact email addresses for the authenticated account.
PUT/account/emergency-emailsAdd emergency contact email addresses to the authenticated account.
DELETE/account/emergency-emailsRemove emergency contact email addresses from the authenticated account.
GET/account/reportingGet ACME contract reporting grouped by subaccount.
This endpoint is available only to parent accounts. Subaccounts receive a 403 Forbidden response.
Only subaccounts with at least one ACME contract are included in the response. Subaccounts with no ACME contracts are omitted.
GET/account/settingsList account settings for the authenticated account.
PATCH/account/settingsUpdate an account setting.
The POST /account/subaccount and GET /account/reporting endpoints require a parent account API key. Emergency contact email endpoints use the Partner Subscriptions API key for the authenticated account.

Requests

All Account Management requests use RESTful URLs and header-based authentication. Where a request body is required, the endpoint accepts JSON data.

Methods

Account Management uses these standard HTTP methods:

  • GET
  • POST
  • PUT
  • DELETE

Responses

Account Management responses return JSON data unless the endpoint returns 204 No Content.

Save the API key securely that appears in the response. The full API key value is displayed only once during creation.

Common response codes

Status codeDescription
200 OKRequest succeeded and returned account management data.
201 CreatedSubaccount and API key created successfully.
204 No ContentEmergency contact email update completed successfully.
400 Bad RequestThe request is invalid, an email address is invalid, no emergency emails are configured, or the request attempts to remove all emergency contact emails.
403 ForbiddenAccess denied. This can happen when the request uses the wrong Partner Subscriptions API key type.