Learn

Signers

Specifies paths and operations for managing VICAL 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.

Analytic events

  • ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_CREATE_START
  • ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_CREATE_SUCCESS
  • ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_CREATE_FAIL
Roles: ["admin","dts-provider"]
SecuritybearerAuth
Request
Request Body schema: application/json
caId
required
string <uuid>

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.
Responses
201

VICAL signer created

400

Bad Request. The request was malformed or missing required parameters.

404

Not Found. The specified resource was not found.

409

Maximum number of VICAL signer certificates reached. Please delete an existing certificate before creating a new one.

post/v1/ecosystems/certificates/vical-signers
Request samples
application/json
{
  • "caId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2"
}
Response samples
application/json
{
  • "id": "782f1885-c7c2-4459-8426-b6d7c111b0b1",
  • "csrPem": "-----BEGIN CERTIFICATE REQUEST-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE REQUEST-----",
  • "caId": "b0aae560-10e7-4247-8e96-7cdd3578a1e2",
  • "active": false
}

Retrieve all VICAL signers

Retrieves all VICAL signers.

Analytic events

  • ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_START
  • ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_SUCCESS
  • ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_LIST_FAIL
Roles: ["admin","dts-provider"]
SecuritybearerAuth
Request
query Parameters
limit
number [ 1 .. 1000 ]
Default: 100

Range size of returned list.

Example: limit=2
cursor
string

Starting point for the list of entries.

Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses
200

VICAL signers retrieved

400

Bad Request. The request was malformed or missing required parameters.

404

Not Found. The specified resource was not found.

get/v1/ecosystems/certificates/vical-signers
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}
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.
    • 





Only available in implementations using unmanaged (external) DTS root CA certificates.




Analytic events


    

  • ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_START
    • 

  • ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_SUCCESS
    • 

  • ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_UPDATE_FAIL
    • 



Roles:  ["admin","dts-provider"]
SecuritybearerAuth 
Request 
path Parameters
vicalSignerId
required
string <uuid> 
Unique identifier of the VICAL signer.


 
 Example:  123e4567-e89b-12d3-a456-426614174000
Request Body schema: 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.


 
Responses 
200
VICAL signer updated


400
Bad Request. The request was malformed or missing required parameters.


404
Not Found. The specified resource was not found.


put/v1/ecosystems/certificates/vical-signers/{vicalSignerId}
Request samples 
application/json
{
  • "active": true,
  • "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----"
}
Response samples 
application/json
{
  • "id": "782f1885-c7c2-4459-8426-b6d7c111b0b1",
  • "active": true,
  • "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----",
  • "certificateFingerprint": "f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172",
  • "certificateData": {
    }
}
Delete a VICAL signer
Deletes a VICAL signer.




Only available in implementations using unmanaged (external) DTS root CA certificates.




Analytic events


    

  • ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_DELETE_START
    • 

  • ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_DELETE_SUCCESS
    • 

  • ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_DELETE_FAIL
    • 



Roles:  ["admin","dts-provider"]
SecuritybearerAuth 
Request 
path Parameters
vicalSignerId
required
string <uuid> 
Unique identifier of the VICAL signer.


 
 Example:  123e4567-e89b-12d3-a456-426614174000
Responses 
204
VICAL signer deleted


400
Bad Request. The request was malformed or missing required parameters.


404
Not Found. The specified resource was not found.


delete/v1/ecosystems/certificates/vical-signers/{vicalSignerId}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "message": "string",
  • "details": [
    ]
}
Retrieve a VICAL signer
Retrieves a VICAL signer.


Analytic events


    

  • ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_START
    • 

  • ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_SUCCESS
    • 

  • ECOSYSTEM_VICAL_SIGNER_CERTIFICATE_RETRIEVE_FAIL
    • 



Roles:  ["admin","dts-provider"]
SecuritybearerAuth 
Request 
path Parameters
vicalSignerId
required
string <uuid> 
Unique identifier of the VICAL signer.


 
 Example:  123e4567-e89b-12d3-a456-426614174000
Responses 
200
VICAL signer retrieved


404
Not Found. The specified resource was not found.


get/v1/ecosystems/certificates/vical-signers/{vicalSignerId}
Request samples 
Response samples 
application/json
{
  • "id": "782f1885-c7c2-4459-8426-b6d7c111b0b1",
  • "active": true,
  • "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5...\n-----END CERTIFICATE-----",
  • "certificateFingerprint": "f6cad6e579d70b3973efa60624af731a580d1a11a7579e70f2f10f059dc86172",
  • "certificateData": {
    }
}
➔ Next to CWT credentials