MATTR Learn

Create a VICAL signer

POST/v1/ecosystems/certificates/vical-signers

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

caId*string

Internal identifier of the DTS root CA certificate that will be used for signing the VICAL signer.

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

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.vii.au01.mattr.global/v1/ecosystems/certificates/vical-signers" \
  -H "Content-Type: application/json" \
  -d '{
    "caId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2"
  }'

curl -X POST "https://example.vii.au01.mattr.global/v1/ecosystems/certificates/vical-signers" \  -H "Content-Type: application/json" \  -d '{    "caId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2"  }'

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

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve all VICAL signers

GET/v1/ecosystems/certificates/vical-signers

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Default100

Range1 <= value <= 1000

cursor?string

Starting point for the list of entries.

Response Body

`application/json`

curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/certificates/vical-signers"

curl -X GET "https://example.vii.au01.mattr.global/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"
      }
    }
  ],
  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve a VICAL signer

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

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.vii.au01.mattr.global/v1/ecosystems/certificates/vical-signers/123e4567-e89b-12d3-a456-426614174000"

curl -X GET "https://example.vii.au01.mattr.global/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"
  }
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Update a VICAL signer

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

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

vicalSignerId*string

Unique identifier of the VICAL signer.

Formatuuid

Request Body

application/json

active?boolean

Indicates if the VICAL signer is active. Only active VICAL signers can be used to sign VICALs.

certificatePem?string

VICAL Signer Certificate (VSC) in PEM format.

Response Body

`application/json`

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

curl -X PUT "https://example.vii.au01.mattr.global/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"
  }
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Delete a VICAL signer

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

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.vii.au01.mattr.global/v1/ecosystems/certificates/vical-signers/123e4567-e89b-12d3-a456-426614174000"

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

Empty

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Signers

Create a VICAL signer

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Retrieve all VICAL signers

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

Retrieve a VICAL signer

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Update a VICAL signer

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

Delete a VICAL signer

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

On this page

Signers

201application/json

400application/json

404application/json

409application/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`