Customizations

YubiKeys can be customized, for example pre-configured to meet specific needs for an organization, or pre-programmed with end-user specific credentials using the FIDO Pre-reg service. Customizations also include laser etching and custom packaging of YubiKeys. For information about customization services, contact Yubico Support.

When you order a YubiKey with custom configuration, a Customization ID is used to represent the applicable customization included in the final product that you will receive. The Customization ID is unique for a configuration but is not specific for a key model (form factor). You can associate a Customization ID with a more user-friendly Customization label of your own choice.

A Customization ID can be associated with multiple organizations. An organization can for example have sub-entities in different countries to which they want to ship keys with a specific configuration.

The Customization ID is needed for example when configuring the shipment request workflow for ordering shipment of pre-registered YubiKeys.

Viewing Customizations

To view available customizations for your organization, in the Customer Portal left menu, click Inventory > Customizations to open the Customizations page.

The Customizations page displays the following information:

• Status - The state of the customization record. Can be one of the following:
  • Approved - Custom configuration is ready to be added to sales orders.
  • Active - Custom configuration is in use for order fulfillment.
  • Decommissioned - Custom configuration is discontinued and is no longer fulfillable.
• ID - The unique ID for a specific customization. Click the link to view customization details.
• Label - A custom user-friendly name associated with the Customization ID, for example “IT admins Enterprise keys” as in the image example above. See Adding Customization Labels.
• Configurations - Shows if the customization includes FIDO Pre-reg (pre-registered keys).
• Actions - Option for editing a customization label. Click the Edit icon to open the Edit label dialog. Note that customization label changes will apply to all organizations using the customization.

Use Search and Filters to filter the list by one or more fields to locate a specific customization ID to view its details.

Modifying the Table View

You can modify the appearance of the table and the data displayed using the controls at the top of the page.

• Columns - Determine which columns will be shown in the table. Click Columns and select or deselect the desired columns. Click Reset to return to a previous selection. You can also drag and drop the columns to place them in a desired order on the page.
• Filters - Filter data to be displayed. Click Filters, select an Operator and a Value, and click Apply. Available filter fields depend on the data in the table of the Console page you are working with. Click Clear all to remove the selected filters.
• Density - Determine the space between rows in the table, for example “Compact”.

Viewing Customization Details

The Customization details page provides an overview of the details for a specific customization. To open the Customization details page, click the ID link of the desired customization in the ID column on the Customizations page.

The Customization details page displays the following information:

• ID, label, and status for the customization. You can change the customization label from here by clicking the Edit icon in the LABEL section of this page. Note that customization label changes will apply to all organizations using the customization.
• Configurations - Whether the customization includes FIDO Pre-reg or not.
• Customization label edit history - Overview of updates to the customization label.

Adding Customization Labels

The Customization ID consists of a string of numbers and letters. To make it easier for users to identify a specific customization, Console Owners can add user-friendly Customization labels to Customization IDs associated with their organization.

Customization labels can be shared between organizations, for example if your company has sub-entities in different countries to which you want to ship custom YubiKeys. Customization labels can be viewed by all organization members, but only organization Console Owners can add and update labels. Yubico can view but not update Customization labels.

To add or edit a Customization label for a Customization ID, do the following:

1. In the Customer Portal left menu, click Inventory > Customizations to open the Customizations page.
2. Click the Edit icon in the Actions column for the desired Customization ID.
3. In the dialog that opens, enter the desired customization label, for example “YubiKey 5 NFC administrators”.
4. Click Edit label to save your changes.

Note

If a Console Owner for an organization updates a customization label, the change will be reflected in all organizations associated with that specific Customization ID.

Customization labels will also be displayed on purchase orders , shipment details, and refunded shipments. If no Customization label has been added, the Customization label column is empty.

Viewing Change History

To view the change history for a customization label, for example for auditing purposes, in the Customizations page, click the ID link for the desired customization. In the Customization details page, you can view the Customization label edit history at the bottom of the page.

The history information includes the date when a change was made, the updated customization label, and the email of the user that made the change.

Viewing Customization Information

The following section describes where you can find customization information like serial number and firmware version for deliveries of customized YubiKeys.

Customizations in Shipments

For FIDO Pre-reg (pre-registered keys) type of shipments, you can view customization details associated with each key in a specific shipment. The information includes serial number and firmware version, and is displayed after the shipment has been processed by Yubico Fulfillment Center and the shipment is moved to state “Shipped: in Transit”.

To view customization details for custom keys in a shipment, do the following:

1. In the Customer Portal left menu, click Delivery > Shipments to open the Shipments page.

2. Click the ID for a shipment of type “AUTO FIDO PRE-REG” for which you want to see customization details. Ensure that the selected shipment is in state “Shipped: in Transit” or later.

3. In the Shipment details page, scroll down to the Items section and click the expand icon to the left to expand the section.

   

The following information is displayed:

• Serial number - A unique number identifying a customized YubiKey.
• Firmware version - Version number for the firmware on the customized YubiKey.

Each customized item in the list of shipped items displays the Customization ID identifying the type of customization applied to the keys, and you can expand each item to view the details. Totals is the total number of products in the shipment.

Finding Shipment with Custom Keys

If you know the serial number and/or the firmware version for a customized YubiKey, you can filter on this information to locate a specific shipment to view its status. On the Deliver > Shipments page, click Filters and enter values in the Serial number and/or Firmware version fields. For more information, see also Viewing Shipments.

Customizations in Refunds

Just as for other types of shipments, you can view refunds for shipments with custom keys. If the refunded shipment includes custom keys, the Customization IDs are listed in the Refunds section of the Shipment details page.