Learn

VICAL Configuration

Update VICAL configuration

Update the VICAL configuration for the requested ecosystem

SecuritybearerAuth
Request
path Parameters
ecosystemId
required
string <uuid>

The UUID of the ecosystem

Example: 87880d7e-a4d0-462e-8383-3f1e5e16865d
Request Body schema: application/json
required
vicalProvider
required
string

VICAL provider name.

vicalProviderFullName
required
string

Fully qualified name of the VICAL provider. Used as the organization field in the VICAL CA certificate, and as such cannot be updated after configuraiton has been created.

certificateCountry
string

Uppercase ISO 3166-1 alpha-2 code of the issuing country of the VICAL root CA certificate. Cannot be updated after configuraiton has been created.

certificateCommonName
string

Common name of the VICAL CA certificate. Cannot be updated after configuration has been created.

Responses
200

VICAL configuration updated

400

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

put/v1/ecosystems/{ecosystemId}/vicals/configuration
Request samples
application/json
{
  • "vicalProvider": "Mattr",
  • "vicalProviderFullName": "MATTR Limited",
  • "certificateCountry": "NZ",
  • "certificateCommonName": "Example Certificate Common Name"
}
Response samples
application/json
{
  • "vicalProvider": "Mattr",
  • "vicalProviderFullName": "MATTR Limited",
  • "certificateCountry": "NZ",
  • "certificateCommonName": "Example Certificate Common Name"
}

Retrieve VICAL configuration

Retrieve the VICAL configuration from the requested ecosystem

SecuritybearerAuth
Request
path Parameters
ecosystemId
required
string <uuid>

The UUID of the ecosystem

Example: 87880d7e-a4d0-462e-8383-3f1e5e16865d
Responses
200

VICAL confguration retrieved

404

Not Found. The specified resource was not found.

get/v1/ecosystems/{ecosystemId}/vicals/configuration
Request samples 
Response samples 
application/json
{
  • "vicalProvider": "Mattr",
  • "vicalProviderFullName": "MATTR Limited",
  • "certificateCountry": "NZ",
  • "certificateCommonName": "Example Certificate Common Name"
}
Delete VICAL configuration
Delete the VICAL configuration for the requested ecosystem


SecuritybearerAuth 
Request 
path Parameters
ecosystemId
required
string <uuid> 
The UUID of the ecosystem


 
 Example:  87880d7e-a4d0-462e-8383-3f1e5e16865d
Responses 
204
VICAL configuration deleted


404
Not Found. The specified resource was not found.


delete/v1/ecosystems/{ecosystemId}/vicals/configuration
Request samples 
➔ Next to VICAL Certificates