Public Keys

Public Keys are cryptographic credentials used to verify the identity of remote components during SSH handshakes in USP. They work in conjunction with Private Keys and are essential for establishing trust between USP components and external clients.

info

For more information on where and how Public Keys are used, refer to How USP Uses Keys.

Public Key Administration via USP Admin UI

Adding a Public Key

To add a Public Key, follow these steps:

1. From the Sidebar, click Authentication > Keys.
2. Click Public Key.
3. Click Add Public Key.
4. Complete the details for the new Public Key using the Field Descriptions table as a guide.
5. Click Save.

Field Descriptions

Name	Description	Specifications	Required
Name	The name of the Public Key.	Must be unique. Must follow the Standard Naming Pattern.	Yes
Description	The description of the Public Key.		No
Key	The Public Key content.	Must be in SSH authorized keys format.	Yes

Editing a Public Key

To edit a Public Key, follow these steps:

1. From the Sidebar, click Authentication > Keys.
2. Click Public Key.
3. Click the row of the Public Key you want to edit.
4. Click the Edit button above the Public Key details.
5. Edit the details of the Public Key using the Field Descriptions table as a guide.
6. Click Save.

warning

If you modify a Public Key that is currently in use by a USP Server instance, the changes will not take effect until you manually apply the updated configuration by pushing it to the server. To apply the changes:

1. Navigate to Monitoring > Status.
2. Click the Name of the associated USP Server instance.
3. Go to the Configuration tab.
4. Review the pending changes in the Updated Configuration column.
5. If the changes are correct, click Push Configuration.

Public Key Metadata

Public Key details include all parameters given in the Field Descriptions table above, plus the following read-only metadata:

Name	Description
ID	Universally Unique Identifier of this Public Key.
Enabled	A Boolean value indicating the status of the Public Key. The only possible value is true.
Created At	Date and time this Public Key was created.
Updated At	Date and time this Public Key was last updated.

Deleting a Public Key

To delete a Public Key, follow these steps:

1. From the Sidebar, click Authentication > Keys.
2. Click Public Key.
3. Click the row of the Public Key you want to delete.
4. Click the Delete button above the Public Key details.
5. You will be asked to confirm the deletion. Click Delete.

warning

USP Manager prevents deletion of a Public Key if it is currently referenced by a Configuration Item.

Additionally, if the Public Key is used by a USP Server instance, the updated configuration must be manually applied. To apply the changes:

1. Navigate to Monitoring > Status.
2. Click the Name of the associated USP Server instance.
3. Go to the Configuration tab.
4. Review the pending changes in the Candidate Configuration - Preview section.
5. If the changes are correct, click Push Configuration.

The changes do not take effect on the server until this step is completed.