Introduction
Note
The Microsoft Entra ID integration with FIDO Pre-reg and the FIDO Connector is currently available in Early Access (EA).
The FIDO Connector and associated APIs provided by Yubico with YubiKey as a Service - Enrollment, are used for FIDO Pre-reg integrations with identity providers (IdPs) to manage system interactions supporting pre-enrollment of credentials and shipment of YubiKeys. The FIDO Connector is deployed in the customer’s environment, and application credentials and secrets are stored, managed, and fully controlled by the customer.
The current version of the FIDO Connector API supports the following features:
- Multiple identity providers: Create multiple credential requests to one or more IdPs, useful if your organization has more than one IdP for system authentication.
- Multiple credentials: Add multiple credentials on the same YubiKey, for example for different account types, as required by your end users.
- Multiple keys: Include, for example, a primary and a backup YubiKey programmed for the same account credentials, in a single request.
- On-site programming: Use a mobile device to program a YubiKey with credentials at your premises before it is handed over to an end user. For more information, see the YubiID program (Limited Early Access).
- Identity provider plugin: Yubico provides an IdP-plugin solution delivered as an SDK that you install in your local development environment, and use as a foundation when creating your own IdP plugin. Contact your Yubico representative for more information.
The image below provides an overview of the architecture with the FIDO Connector, one or more IdPs, the integration APIs used, and the services provided by Yubico.
The following components are included:
- Identity providers (IdPs): The FIDO Connector supports Microsoft Entra ID, PingOne PingID, and PingOne AIC, see FIDO Pre-reg integration guides.
- Customer environment: IT system components, including the Azure environment where the FIDO Connector is deployed, see for example FIDO Pre-reg with Microsoft.
- Business system integrations: Integrations with for example an HR system providing recipient address information, or ServiceNow for triggering shipments of physical keys.
- Delivery Service: The Yubico-provided APIs for managing shipments of physical keys, with access to the Yubico Customer Portal for managing shipment statuses.
- Enrollment Service: Manages credential and shipment request data, provides APIs for managing on-site programming requests.
- Fulfillment Center(s): Yubico-managed programming and shipping of physical YubiKeys globally.
- API Calls: Calls to the FIDO Connector and YubiKey as a Service-FIDO Pre-reg APIs for requesting credentials and/or shipments of enrolled YubiKeys.
API Version and Feature Support
The following FIDO Pre-reg integration options are available:
- Using the FIDO Connector API v2 and v1
- Using the FIDO Pre-reg API (fido2PreRegisteredShipments)
The table below provides an overview of supported features for each integration option.
Feature
|
FIDO
Connector v2
|
FIDO
Connector v1
|
FIDO Pre-reg
|
|---|---|---|---|
Support for IdPs Microsoft Entra ID
PingOne PingID, and PingOne AIC (see note below).
|
Yes
|
Yes
|
Yes (see note
below)
|
Credential requests to multiple IdPs
in a single request.
|
Yes
|
No
|
Yes (see note
below)
|
Multiple credentials on the same key
in a single request.
|
Yes
|
Yes
|
No
|
Multiple keys with multiple credentials
in a single request.
|
Yes
|
No
|
Yes (see note
below)
|
On-site credential programming of keys for
handover to an end user locally.
|
Yes
|
Yes
|
No
|
End-user provided PIN when programming keys
locally on-site.
|
Yes
|
Yes
|
No
|
Shipment requests and credential requests
in the same request.
|
Yes
|
No
|
No
|
Shipment-only request of one or more keys,
programmed and shipped by Yubico.
|
Yes
|
Yes (one key)
only)
|
Yes (see note
below)
|
Note
The Okta integration only supports the FIDO Pre-reg API, not the FIDO Connector API, and only one enrolled key at the time can be shipped. See the FIDO Pre-reg with Okta Integration Guide.
Installation and Deployment
The FIDO Connector is available as a Docker image, together with an ARM template, provided by Yubico. The following components are used in a reference implementation:
- Azure Subscription: An active subscription and appropriate permissions.
- Azure Container Apps: For hosting the FIDO Connector Docker image.
- Azure Key Vault: For storing API tokens and client secrets.
- Azure Logic App: For sending PIN notification emails to the end user.
- Azure Storage Account: For temporary tracking of shipment and credential requests.
When deploying the FIDO Connector, users must have sufficient permissions in both Azure and Microsoft Entra ID to be able to deploy. Resource Group Owner is the recommended baseline.
To allow for the FIDO Connector to connect and authenticate with the Yubico services, an API token is created in the Yubico Customer portal, and stored in Azure Key Vault.
In order for the FIDO Connector to connect and authenticate with Entra ID, an application is registered in the customer’s Entra ID tenant. The appropriate app permissions are provided, and a client secret is created and stored in Azure Key Vault.
See the following for details on how to install and deploy the FIDO Connector with different identity provider integrations:
