light-mode-image
Learn
MATTR VII PlatformSigners

Update a VICAL signer

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 PEM certificate can be activated.
  • The certificatePem field becomes immutable after it's updated for the first time.

ℹ️ Note: Only available in implementations using unmanaged (external) DTS root CA certificates.

Analytics Events

ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_STARTECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_SUCCESSECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_FAIL

Roles

admindts-provider
PUT/v1/ecosystems/certificates/vical-signers/{vicalSignerId}
AuthorizationBearer <token>

In: header

Path Parameters

vicalSignerIdstring

Unique identifier of the VICAL signer.

Formatuuid
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

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"
    }
  ]
}

How would you rate this page?