Update operations
The horizon client can perform update operations on certificates using the update-cert
command. This will modify the information associated with the certificate on Horizon.
This command can either be used to update a certificate present on your machine or to update certificates on Horizon using an account with sufficient permission.
To update a local certificate, the 'Update (pop)' common configuration permission must be enabled on the profile the certificate is linked to. |
General Parameters
|
The command asks for confirmation after the changes are computed. Use this flag to disable this behavior and proceed directly. (Optional) |
|
Use this flag to be prompted for edition of all the certificate fields. In this mode, using enter on an existing value means the value is not changed. (Optional) |
Update Parameters
An update concerns only metadata fields, that is fields added by Horizon.
|
Set the owner of the certificate. An empty string means deletion of this information. (Optional) |
|
Set the team of the certificate. An empty string means deletion of this information. (Optional) |
|
Set the contact email of the certificate. An empty string means deletion of this information. (Optional) |
|
Set the labels of the certificate. An empty string means deletion of this information. (Optional) |
|
Set the technical metadata of the certificate. To use with caution. An empty string means deletion of this information. (Optional) |
Certificate selection parameters
Local certificate
The update is only possible on local certificates for which you possess the key:
|
Path to the certificate to update (PEM file, PKCS#12 file, JKS file) or cert thumbprint for Windows certificate store entries. (Optional) |
|
Path to the private key of the certificate to update if it is not included in the certificate file. (Optional) |
|
Password for the PKCS#12 file to update. (Optional) |
|
Password for the JKS file to update. (Optional) |
|
Alias for the JKS file to update. (Optional) |
|
Alias password for the JKS file to update. (Optional) |
Examples
You will find below a few examples detailing how to use the client to update certificates in various contexts
Updating the owner of a certificate
horizon-cli update-cert --cert=/path/to/cert --key=/path/to/key --owner=newowner
Removing the team from a certificate stored in JKS file
horizon-cli update-cert --cert=/path/to/cert.jks --jks-pwd=<jks_password> --team=""
Updating labels and metadata of a certificate stored in windows certificate store
horizon-cli update-cert --cert=<certificate_thumbprint> --labels="label1:value1,label2:value2" --metadata="metadata1:value1,metadata2:value2"
Updating contact email of a certificate referenced on Horizon
horizon-cli update-cert --id=<certificate_id> --contact-email="[email protected]"