A keyring groups multiple keys together, similar to a physical keyring. Keyrings can use either manual storage or device storage, and they can be handed over like any other key.
Requirements for Adding a Key to a Keyring
A key can be added to a keyring only if:
It is not already part of another keyring
Its status is available
It is currently in manual storage
It has no active or future contracts
Restrictions for Adding Keys to Existing Keyrings
The keyring cannot have active contracts
If the keyring selected storage is a device, the keyring needs to be taken out of the key cabinet locker first.
The keyring cannot have ongoing contracts
How to Add Keys to a Keyring
Keys can be added in two ways:
From the keys list – select one or more keys and choose the Add to keyring option from the context menu or three-dots menu.
From individual key details – use the three-dots menu.
Selecting the option opens a modal that lets you either create a new keyring or attach the selected key(s) to an existing keyring.
Creating new keyring:
In the keyring creation form, you can specify the keyring name and choose the storage type: manual storage or device.
Once created, the keyring appears in the keys list. Clicking the keyring opens its details view, where you can see the keyring information and its attached members, which now exist as part of this keyring.
Adding to an existing keyring
In the same modal, you can select Add to Existing Keyring and then search for the keyring to which you want to attach the key.
Updating keyring
You can update a keyring from its details view by clicking the Update button.
This opens the Update Keyring modal, where you can modify keyring details such as its name, add or remove members, and update storage information.
You can detach a key from a keyring by selecting the trash icon, entering the manual storage description, and then clicking Update keyring.
Restrictions
A keyring cannot be updated if it has an active contract.
If the keyring is stored in a device, it must be taken out before making any updates.
Search and Handover
You can search the keyring by either searching by keyring info or attached key info.
From the Keys list:
From the Handover key view:
Detaching a key from an active contract
Normally, keyrings with an active contract cannot be modified. However, situations may arise where a key must be detached during an active contract - for example, if an end user has removed a key from the physical keyring, a key is lost, or another issue occurs.
In these cases, it is possible to detach a key from a keyring even when a contract is active. This can be done from the Receive Contract Keys view by clicking the Detach button next to the key that needs to be removed.
This opens a dialog where you can specify the manual storage location for the key and provide a reason for detachment. An Available toggle lets you indicate whether the key is currently in your possession; in most cases, this should remain off.
Detachment is irreversible, so it should be used only when necessary. This operation will also impact any active or future contracts that include this keyring.
