DTS root and intermediate CA certificates

Create DTS root CA certificate

POST/v1/ecosystems/certificates/ca

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

commonName?string

Indicates the common name of the DTS root CA certificate. When specified, the value must be a valid PrintableString and cannot be an empty string. If not provided and a custom domain is configured and verified, the custom domain is used followed by the words DTS CA. If no custom domain is configured, the tenant subdomain is used instead.

country?string

Indicates the DTS provider's country. If not provided, a country is selected based on the region of the tenant subdomain cloud host. When specified, the value must be a valid Alpha 2 country code as per ISO 3166-1.

organisationName*string

Indicates the organization associated with the DTS root CA certificate.

notAfter?string

Used to set the date and time when the DTS root CA certificate expires.

If not provided, calculated as notBefore + 20 years.
If not provided and notBefore is not provided, calculated as time of creation + 20 years.
Maximum value is 20 years from creation.
Must be after notBefore, if provided.

Formatdate-time

notBefore?string

Used to set the date and time when the DTS root CA certificate becomes valid and can be used to sign other intermediate certificates.

Must not be in the past.
Must be before notAfter.

Formatdate-time

Response Body

`application/json`

curl -X POST "https://example.com/v1/ecosystems/certificates/ca" \  -H "Content-Type: application/json" \  -d '{    "organisationName": "string"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "active": true,  "certificatePem": "string",  "certificateFingerprint": "string",  "certificateData": {    "commonName": "string",    "country": "string",    "organisationName": "string",    "notAfter": "2019-08-24T14:15:22Z",    "notBefore": "2019-08-24T14:15:22Z"  },  "isManaged": true,  "useIntermediateCa": true}

Retrieve all DTS root CA certificates

GET/v1/ecosystems/certificates/ca

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

`application/json`

curl -X GET "https://example.com/v1/ecosystems/certificates/ca"

{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "active": true,      "certificatePem": "string",      "certificateFingerprint": "string",      "certificateData": {        "commonName": "string",        "country": "string",        "organisationName": "string",        "notAfter": "2019-08-24T14:15:22Z",        "notBefore": "2019-08-24T14:15:22Z"      },      "isManaged": true,      "useIntermediateCa": true    }  ],  "nextCursor": "string"}

Retrieve all DTS root CA Certificates (public)

GET/v1/ecosystems/public/certificates/ca

Response Body

`application/json`

curl -X GET "https://example.com/v1/ecosystems/public/certificates/ca"

{  "rootCertificates": [    {      "certificate": "string",      "notBefore": "2019-08-24T14:15:22Z",      "notAfter": "2019-08-24T14:15:22Z",      "fingerprint": "string",      "commonName": "string",      "intermediateCertificates": [        {          "certificate": "string",          "notBefore": "2019-08-24T14:15:22Z",          "notAfter": "2019-08-24T14:15:22Z",          "fingerprint": "string",          "commonName": "string"        }      ]    }  ]}

Retrieve a DTS root CA certificate

GET/v1/ecosystems/certificates/ca/{dtsCaCertificateId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

dtsCaCertificateId*string

Unique identifier of the DTS root CA certificate.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/ecosystems/certificates/ca/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "active": true,  "certificatePem": "string",  "certificateFingerprint": "string",  "certificateData": {    "commonName": "string",    "country": "string",    "organisationName": "string",    "notAfter": "2019-08-24T14:15:22Z",    "notBefore": "2019-08-24T14:15:22Z"  },  "isManaged": true,  "useIntermediateCa": true}

Update a DTS root CA certificate

PUT/v1/ecosystems/certificates/ca/{dtsCaCertificateId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

dtsCaCertificateId*string

Unique identifier of the DTS root CA certificate.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

active*boolean

Indicates whether the DTS root CA certificate is active. Activating a certificate does not affect your ability to create or sign subordinate (intermediate CA or signer) certificates: you can build a complete certificate chain while the root CA is inactive. Instead, active certificates are included in the selection process MATTR VII uses when choosing the certificate chain to sign a trusted list (VICAL or RICAL), where MATTR VII prefers the most recently created active certificate at each level of the chain. Only one DTS root CA certificate can be active at a time.

useIntermediateCa?boolean

When true, this DTS root CA certificate uses the 3-tier certificate model, requiring and using DTS intermediate CA certificates as part of its chain of trust for signing operations. When false, the 2-tier model is used and the DTS root CA signs signer certificates directly. Changing this value requires deleting all subordinate certificates. This field can only be set for unmanaged (external) DTS root CA certificates. For an explanation of the 2-tier and 3-tier models, refer to the DTS certificates overview.

Response Body

`application/json`

curl -X PUT "https://example.com/v1/ecosystems/certificates/ca/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "active": true  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "active": true,  "certificatePem": "string",  "certificateFingerprint": "string",  "certificateData": {    "commonName": "string",    "country": "string",    "organisationName": "string",    "notAfter": "2019-08-24T14:15:22Z",    "notBefore": "2019-08-24T14:15:22Z"  },  "isManaged": true,  "useIntermediateCa": true}

Delete a DTS root CA certificate

DELETE/v1/ecosystems/certificates/ca/{dtsCaCertificateId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

dtsCaCertificateId*string

Unique identifier of the DTS root CA certificate.

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/ecosystems/certificates/ca/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Retrieve a DTS root CA certificate Certificate Revocation List (CRL) (public)

GET/v1/ecosystems/certificates/ca/{dtsCaCertificateId}/crl

Path Parameters

dtsCaCertificateId*string

Unique identifier of the DTS root CA certificate.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/ecosystems/certificates/ca/497f6eca-6276-4993-bfeb-53cbbbba6f08/crl"

"string"

Create a DTS intermediate CA certificate

POST/v1/ecosystems/certificates/ca/{dtsCaCertificateId}/intermediate

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

dtsCaCertificateId*string

Unique identifier of the DTS root CA certificate.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

certificatePem*string

DTS intermediate CA certificate encoded in PEM format

usages*array<>

The intended usages for this intermediate CA. Must contain at least one value.

Items1 <= items

Response Body

`application/json`

curl -X POST "https://example.com/v1/ecosystems/certificates/ca/497f6eca-6276-4993-bfeb-53cbbbba6f08/intermediate" \  -H "Content-Type: application/json" \  -d '{    "certificatePem": "string",    "usages": [      "VICAL"    ]  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "active": true,  "certificatePem": "string",  "certificateFingerprint": "string",  "certificateData": {    "commonName": "string",    "country": "string",    "organisationName": "string",    "notAfter": "2019-08-24T14:15:22Z",    "notBefore": "2019-08-24T14:15:22Z"  },  "usages": [    "VICAL"  ],  "caCertificateId": "3c667fc8-c92c-4eee-a159-5221f574052e"}

Retrieve all DTS intermediate CA certificates under a root CA

GET/v1/ecosystems/certificates/ca/{dtsCaCertificateId}/intermediate

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

dtsCaCertificateId*string

Unique identifier of the DTS root CA certificate.

Formatuuid

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

`application/json`

curl -X GET "https://example.com/v1/ecosystems/certificates/ca/497f6eca-6276-4993-bfeb-53cbbbba6f08/intermediate"

{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "active": true,      "certificatePem": "string",      "certificateFingerprint": "string",      "certificateData": {        "commonName": "string",        "country": "string",        "organisationName": "string",        "notAfter": "2019-08-24T14:15:22Z",        "notBefore": "2019-08-24T14:15:22Z"      },      "usages": [        "VICAL"      ],      "caCertificateId": "3c667fc8-c92c-4eee-a159-5221f574052e"    }  ],  "nextCursor": "string"}

Retrieve a DTS intermediate CA certificate

GET/v1/ecosystems/certificates/ca/{dtsCaCertificateId}/intermediate/{dtsIntermediateCaCertificateId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

dtsCaCertificateId*string

Unique identifier of the DTS root CA certificate.

Formatuuid

dtsIntermediateCaCertificateId*string

Unique identifier of the DTS intermediate CA certificate.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/ecosystems/certificates/ca/497f6eca-6276-4993-bfeb-53cbbbba6f08/intermediate/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "active": true,  "certificatePem": "string",  "certificateFingerprint": "string",  "certificateData": {    "commonName": "string",    "country": "string",    "organisationName": "string",    "notAfter": "2019-08-24T14:15:22Z",    "notBefore": "2019-08-24T14:15:22Z"  },  "usages": [    "VICAL"  ],  "caCertificateId": "3c667fc8-c92c-4eee-a159-5221f574052e"}

Update a DTS intermediate CA certificate

PUT/v1/ecosystems/certificates/ca/{dtsCaCertificateId}/intermediate/{dtsIntermediateCaCertificateId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

dtsCaCertificateId*string

Unique identifier of the DTS root CA certificate.

Formatuuid

dtsIntermediateCaCertificateId*string

Unique identifier of the DTS intermediate CA certificate.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

active*boolean

Indicates whether the DTS intermediate CA certificate is active. Activating a certificate does not affect your ability to create or sign subordinate signer certificates: you can build a complete certificate chain while the intermediate CA is inactive. Instead, active certificates are included in the selection process MATTR VII uses when choosing the certificate chain to sign a trusted list (VICAL or RICAL), where MATTR VII prefers the most recently created active certificate at each level of the chain.

usages?array<>

Response Body

`application/json`

curl -X PUT "https://example.com/v1/ecosystems/certificates/ca/497f6eca-6276-4993-bfeb-53cbbbba6f08/intermediate/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "active": true  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "active": true,  "certificatePem": "string",  "certificateFingerprint": "string",  "certificateData": {    "commonName": "string",    "country": "string",    "organisationName": "string",    "notAfter": "2019-08-24T14:15:22Z",    "notBefore": "2019-08-24T14:15:22Z"  },  "usages": [    "VICAL"  ],  "caCertificateId": "3c667fc8-c92c-4eee-a159-5221f574052e"}

Delete a DTS intermediate CA certificate

DELETE/v1/ecosystems/certificates/ca/{dtsCaCertificateId}/intermediate/{dtsIntermediateCaCertificateId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

dtsCaCertificateId*string

Unique identifier of the DTS root CA certificate.

Formatuuid

dtsIntermediateCaCertificateId*string

Unique identifier of the DTS intermediate CA certificate.

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/ecosystems/certificates/ca/497f6eca-6276-4993-bfeb-53cbbbba6f08/intermediate/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

DTS root and intermediate CA certificates

201application/json

400application/json

404application/json

409application/json

200application/json

400application/json

404application/json

200application/json

200application/json

404application/json

200application/json

400application/json

404application/json

204

400application/json

404application/json

200application/json

404application/json

201application/json

400application/json

404application/json

200application/json

400application/json

404application/json

200application/json

404application/json

200application/json

400application/json

404application/json

204

400application/json

404application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`