GitHubContribute in GitHub: Edit online

Viewing a list of key templates

You can view a list of your key templates in UKO with the UKO web interface, or programmatically with the UKO API.

Viewing a list of key templates with the UKO web interface

To view a list of your key templates by using the web interface, complete the following steps:

  1. Log in to UKO.

  2. Click Key templates from the navigation to view all the available key templates.

  3. Browse the general characteristics of your key templates in the table.

    To customize how the table is to be presented, click the Settings icon Settings icon and check the columns to be displayed. You can also view archived key templates by clicking the Show archived templates icon Show archived templates icon on the table. To view unarchived templates again, click the Hide archived templates icon Hide archived templates icon on the table. For more information, see Archiving and unarchiving key templates.

    Table 1. Key templates table
    Property Description
    Name The unique, human-readable name that is assigned to your key template.
    ID A string that uniquely identifies the key template. The key template ID is truncated and displayed with a copy icon.
    Vault The vault that controls access to the key template.
    Last modified The date and time when the key template was last updated. This field gets updated when the key template is created, edited, or any part of the key template metadata is modified.
    Key algorithm The encryption algorithm to encrypt data for the key to be created with the template.
    Key length The number of bits that represents the encryption strength of the keys that are created or to be created with the template.
    Key naming scheme The key naming conventions that are created based on the key template.
    Keys The number of keys that created based on the key template.
    Keystore type The type of keystore that the key template properties are compatible with.
    Creation date Set a date range of when the key template was created.

    You can search for a specific key template by using the search bar, or filter key templates based on your needs by clicking the Filter icon Filter icon in the Key templates table.

Viewing a list of key templates with the API

To view a list of key templates through the API, follow these steps:

  1. Retrieve your service and authentication credentials to work with key templates in the service.

  2. Create a key template by making a GET call to the following endpoint.

    https://<hostname>:<port>/api/v4/templates
    

    By default all unarchived templates will be returned. To view unarchived and archived templates you can filter by "state". For detailed instructions and code examples about using the API method, check out the Cloud API reference doc.

What's next