Signers

Create a VICAL signer

POST/v1/ecosystems/certificates/vical-signers

Creates a VICAL signer.

Only available in implementations using unmanaged (external) DTS root CA certificates.
A maximum of five VICAL signers can be created per tenant.

Roles

admindts-provider

Analytics Events

ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_CREATE_STARTECOSYSTEM_VICAL_SIGNER_CERTIFICATE_CREATE_SUCCESSECOSYSTEM_VICAL_SIGNER_CERTIFICATE_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

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

{  "id": "782f1885-c7c2-4459-8426-b6d7c111b0b1",  "csrPem": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE REQUEST-----",  "caId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2",  "intermediateCaId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2",  "active": false}

Retrieve all VICAL signers

GET/v1/ecosystems/certificates/vical-signers

Retrieves all VICAL signers.

Roles

admindts-provider

Analytics Events

ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_STARTECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_SUCCESSECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_FAIL

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/vical-signers"

{  "data": [    {      "id": "782f1885-c7c2-4459-8426-b6d7c111b0b1",      "active": true,      "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----",      "certificateFingerprint": "f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172",      "certificateData": {        "commonName": "example.com",        "country": "US",        "notAfter": "2024-10-22T00:00:00Z",        "notBefore": "2023-10-22T00:00:00Z"      },      "caId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2",      "intermediateCaId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2"    }  ],  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"}

Retrieve a VICAL signer

GET/v1/ecosystems/certificates/vical-signers/{vicalSignerId}

Retrieves a VICAL signer.

Roles

admindts-provider

Analytics Events

ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_STARTECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_SUCCESSECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

vicalSignerId*string

Unique identifier of the VICAL signer.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/ecosystems/certificates/vical-signers/123e4567-e89b-12d3-a456-426614174000"

{  "id": "782f1885-c7c2-4459-8426-b6d7c111b0b1",  "active": true,  "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----",  "certificateFingerprint": "f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172",  "certificateData": {    "commonName": "example.com",    "country": "US",    "notAfter": "2024-10-22T00:00:00Z",    "notBefore": "2023-10-22T00:00:00Z"  },  "caId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2",  "intermediateCaId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2"}

Update a VICAL signer

PUT/v1/ecosystems/certificates/vical-signers/{vicalSignerId}

Updates a VICAL signer by:

Providing a VICAL Signer Certificate (VSC) in PEM format that matches its Certificate Signing Request (CSR).
Activating or deactivating the VICAL signer. Only VICAL signers with a valid certificatePem can be activated.
The certificatePem field becomes immutable after it's updated for the first time.

Roles

admindts-provider

Analytics Events

ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_STARTECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_SUCCESSECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

vicalSignerId*string

Unique identifier of the VICAL signer.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/v1/ecosystems/certificates/vical-signers/123e4567-e89b-12d3-a456-426614174000" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "782f1885-c7c2-4459-8426-b6d7c111b0b1",  "active": true,  "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----",  "certificateFingerprint": "f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172",  "certificateData": {    "commonName": "example.com",    "country": "US",    "notAfter": "2024-10-22T00:00:00Z",    "notBefore": "2023-10-22T00:00:00Z"  },  "caId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2",  "intermediateCaId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2"}

Delete a VICAL signer

DELETE/v1/ecosystems/certificates/vical-signers/{vicalSignerId}

Deletes a VICAL signer.

Roles

admindts-provider

Analytics Events

ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_DELETE_STARTECOSYSTEM_VICAL_SIGNER_CERTIFICATE_DELETE_SUCCESSECOSYSTEM_VICAL_SIGNER_CERTIFICATE_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

vicalSignerId*string

Unique identifier of the VICAL signer.

Formatuuid

Create a VICAL signer

POST/v1/ecosystems/certificates/vical-signers

Creates a VICAL signer.

Only available in implementations using unmanaged (external) DTS root CA certificates.
A maximum of five VICAL signers can be created per tenant.

Roles

admindts-provider

Analytics Events

ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_CREATE_STARTECOSYSTEM_VICAL_SIGNER_CERTIFICATE_CREATE_SUCCESSECOSYSTEM_VICAL_SIGNER_CERTIFICATE_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

caId*string

Unique identifier of the DTS root CA certificate used as a trust anchor for the VICAL signer.

Must be an unmanaged (external) DTS root CA certificate.

Formatuuid

intermediateCaId?string

Unique identifier of the DTS intermediate CA certificate that will be used for signing the VICAL signer.

Formatuuid

Response Body

`application/json`

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

{  "id": "782f1885-c7c2-4459-8426-b6d7c111b0b1",  "csrPem": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE REQUEST-----",  "caId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2",  "intermediateCaId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2",  "active": false}

Retrieve all VICAL signers

GET/v1/ecosystems/certificates/vical-signers

Retrieves all VICAL signers.

Roles

admindts-provider

Analytics Events

ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_STARTECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_SUCCESSECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_FAIL

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/vical-signers"

{  "data": [    {      "id": "782f1885-c7c2-4459-8426-b6d7c111b0b1",      "active": true,      "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----",      "certificateFingerprint": "f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172",      "certificateData": {        "commonName": "example.com",        "country": "US",        "notAfter": "2024-10-22T00:00:00Z",        "notBefore": "2023-10-22T00:00:00Z"      },      "caId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2",      "intermediateCaId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2"    }  ],  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"}

Retrieve a VICAL signer

GET/v1/ecosystems/certificates/vical-signers/{vicalSignerId}

Retrieves a VICAL signer.

Roles

admindts-provider

Analytics Events

ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_STARTECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_SUCCESSECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

vicalSignerId*string

Unique identifier of the VICAL signer.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/ecosystems/certificates/vical-signers/123e4567-e89b-12d3-a456-426614174000"

{  "id": "782f1885-c7c2-4459-8426-b6d7c111b0b1",  "active": true,  "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----",  "certificateFingerprint": "f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172",  "certificateData": {    "commonName": "example.com",    "country": "US",    "notAfter": "2024-10-22T00:00:00Z",    "notBefore": "2023-10-22T00:00:00Z"  },  "caId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2",  "intermediateCaId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2"}

Update a VICAL signer

PUT/v1/ecosystems/certificates/vical-signers/{vicalSignerId}

Updates a VICAL signer by:

Providing a VICAL Signer Certificate (VSC) in PEM format that matches its Certificate Signing Request (CSR).
Activating or deactivating the VICAL signer. Only VICAL signers with a valid certificatePem can be activated.
The certificatePem field becomes immutable after it's updated for the first time.

Roles

admindts-provider

Analytics Events

ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_STARTECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_SUCCESSECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

vicalSignerId*string

Unique identifier of the VICAL signer.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

active?boolean

Indicates whether the VICAL signer is active. Active VICAL signers are included in the selection process MATTR VII uses when choosing the signer to sign a VICAL, where MATTR VII prefers the most recently created active VICAL signer. A VICAL signer can only be set to active once a VICAL Signer Certificate (VSC) has been associated with it.

certificatePem?string

VICAL Signer Certificate (VSC) in PEM format.

Response Body

`application/json`

curl -X PUT "https://example.com/v1/ecosystems/certificates/vical-signers/123e4567-e89b-12d3-a456-426614174000" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "782f1885-c7c2-4459-8426-b6d7c111b0b1",  "active": true,  "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----",  "certificateFingerprint": "f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172",  "certificateData": {    "commonName": "example.com",    "country": "US",    "notAfter": "2024-10-22T00:00:00Z",    "notBefore": "2023-10-22T00:00:00Z"  },  "caId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2",  "intermediateCaId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2"}

Delete a VICAL signer

DELETE/v1/ecosystems/certificates/vical-signers/{vicalSignerId}

Deletes a VICAL signer.

Roles

admindts-provider

Analytics Events

ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_DELETE_STARTECOSYSTEM_VICAL_SIGNER_CERTIFICATE_DELETE_SUCCESSECOSYSTEM_VICAL_SIGNER_CERTIFICATE_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

vicalSignerId*string

Unique identifier of the VICAL signer.

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/ecosystems/certificates/vical-signers/123e4567-e89b-12d3-a456-426614174000"

Empty

Roles

Analytics Events

201application/json

400application/json

404application/json

409application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

200application/json

404application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

204

400application/json

404application/json

On this page

Signers

Roles

Analytics Events

201application/json

400application/json

404application/json

409application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

200application/json

404application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

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`