Signers
Create a VICAL signer
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
Analytics Events
bearerAuthAuthorizationBearer <token>application/json- body
caId*stringUnique 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.
uuidintermediateCaId?stringUnique identifier of the DTS intermediate CA certificate that will be used for signing the VICAL signer.
uuidVICAL signer created
application/json- response
VICAL signer before a VICAL Signer Certificate (VSC) has been uploaded. Includes the Certificate Signing Request (CSR).
id*stringEach VICAL signer will have a unique identifier which must be provided when using this VICAL signer to sign a VICAL.
uuidcsrPem*stringThe X.509 Certificate Signing Request (CSR) in PEM format, base64 encoded. Use this CSR to generate a valid certificate, then update the VICAL signer with the resulting certificate.
caId*stringUnique identifier of the DTS root CA certificate used as a trust anchor for the VICAL signer.
uuidintermediateCaId?stringUnique identifier of the DTS intermediate CA certificate used to sign the VICAL signer.
uuidactive*falseIndicates 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.
- VICAL signers are created as inactive by default, and can only be set to active once a VICAL Signer Certificate (VSC) has been associated with them.
falsecurl -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
Retrieves all VICAL signers.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>limit?numberRange size of returned list.
1 <= value <= 1000100cursor?stringStarting point for the list of entries.
VICAL signers retrieved
application/json- response
data?array<|>nextCursor?nextCursorStarting point for next cursor to use in a paginated list.
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
Retrieves a VICAL signer.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>vicalSignerId*stringUnique identifier of the VICAL signer.
uuidVICAL signer retrieved
application/json- response
VICAL signer after a VICAL Signer Certificate (VSC) has been uploaded. Includes the uploaded certificate in PEM format, as well as the certificate's fingerprint and data.
id*stringEach VICAL signer will have a unique identifier which must be provided when using this VICAL signer to sign a VICAL.
uuidactive*booleanIndicates 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*stringVICAL Signer Certificate (VSC) in PEM format.
certificateFingerprint*stringSHA-256 hash of all VSC certificate data and signature.
certificateData*caId?stringUnique identifier of the DTS root CA certificate used as a trust anchor for the VICAL signer.
uuidintermediateCaId?stringUnique identifier of the DTS intermediate CA certificate used to sign the VICAL signer.
uuidcurl -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
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
certificatePemcan be activated. - The
certificatePemfield becomes immutable after it's updated for the first time.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>vicalSignerId*stringUnique identifier of the VICAL signer.
uuidapplication/json- body
active?booleanIndicates 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?stringVICAL Signer Certificate (VSC) in PEM format.
VICAL signer updated
application/json- response
VICAL signer after a VICAL Signer Certificate (VSC) has been uploaded. Includes the uploaded certificate in PEM format, as well as the certificate's fingerprint and data.
id*stringEach VICAL signer will have a unique identifier which must be provided when using this VICAL signer to sign a VICAL.
uuidactive*booleanIndicates 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*stringVICAL Signer Certificate (VSC) in PEM format.
certificateFingerprint*stringSHA-256 hash of all VSC certificate data and signature.
certificateData*caId?stringUnique identifier of the DTS root CA certificate used as a trust anchor for the VICAL signer.
uuidintermediateCaId?stringUnique identifier of the DTS intermediate CA certificate used to sign the VICAL signer.
uuidcurl -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
Deletes a VICAL signer.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>vicalSignerId*stringUnique identifier of the VICAL signer.
uuidVICAL signer deleted
curl -X DELETE "https://example.com/v1/ecosystems/certificates/vical-signers/123e4567-e89b-12d3-a456-426614174000"How would you rate this page?
Last updated on