diff --git a/docs/docs/fido-pre-reg/actions/IdentityProviders/okta/okta_activate.md b/docs/docs/fido-pre-reg/actions/IdentityProviders/okta/okta_activate.md index 8cdc850..a40940a 100644 --- a/docs/docs/fido-pre-reg/actions/IdentityProviders/okta/okta_activate.md +++ b/docs/docs/fido-pre-reg/actions/IdentityProviders/okta/okta_activate.md @@ -98,12 +98,13 @@ Next we are going to add a script to **Script** field. Copy the script provided ```js (function execute(inputs, outputs) { + const parsed_signing_keys = JSON.parse(inputs.signing_keys) outputs.request_body = JSON.stringify({ fulfillmentProvider: inputs.fulfillment_provider, userId: inputs.user_id, serial: inputs.serial_number, version: inputs.version, - yubicoSigningJwks: inputs.signing_keys, + yubicoSigningJwks: parsed_signing_keys.keys, pinResponseJwe: inputs.pin_response, credResponses: [ { diff --git a/docs/docs/fido-pre-reg/actions/YubiEnterprise/createshipment.md b/docs/docs/fido-pre-reg/actions/YubiEnterprise/createshipment.md index 6097985..40cfaad 100644 --- a/docs/docs/fido-pre-reg/actions/YubiEnterprise/createshipment.md +++ b/docs/docs/fido-pre-reg/actions/YubiEnterprise/createshipment.md @@ -305,7 +305,7 @@ For each row in the table below, perform the following steps: | Label | Type | Mandatory | | ----------------- | ------- | --------- | | shipment_id | String | on | -| shipment_state_id | Integer | on | +| shipment_state_id | String | on | Your script outputs menu should look like the example below. diff --git a/docs/docs/fido-pre-reg/connections.md b/docs/docs/fido-pre-reg/connections.md index 6a46333..c323c67 100644 --- a/docs/docs/fido-pre-reg/connections.md +++ b/docs/docs/fido-pre-reg/connections.md @@ -28,5 +28,13 @@ Below are instructions for generating an API token for FIDO Pre-reg supported Id See [this section](/yed-spoke-example/docs/connections) from earlier in this guide to establish an API credential in ServiceNow. You will need to perform this step for both of the API tokens generated above. ::::warning + The link to the previous section above references configurations for specifically the YubiEnterprise API. When configuring your IdP ensure that you set the **API Token/Secret** and **Base URL** to match what's expected for your IdP. + :::: + +:::warning + +When creating the credential for Okta and adding the API Key, do not add `Bearer` before the token, instead add `SSWS`. See [Okta API tokens](https://developer.okta.com/docs/guides/create-an-api-token/main/#okta-api-tokens) for more information. + +::: \ No newline at end of file diff --git a/docs/docs/fido-pre-reg/flows/okta.md b/docs/docs/fido-pre-reg/flows/okta.md index 3e99852..26a3958 100644 --- a/docs/docs/fido-pre-reg/flows/okta.md +++ b/docs/docs/fido-pre-reg/flows/okta.md @@ -67,11 +67,11 @@ Use the right facing arrow to move the following fields to the column on the rig - street_address - apt_or_unit - city -- region +- region_state - postal_code -- country +- country_code - is_the_user_receiving_their_first_yubikey_or_a_replacement -- select_a_yubikey_model +- yubikey_model Your form variables menu should look like the example below. @@ -164,10 +164,10 @@ Use the table below to correlate the correct data pill, to the inputs of the act | Street Line 1 | Get Catalog Variable > street_address | | Street Line 2 | Get Catalog Variable > apt_or_unit | | City | Get Catalog Variable > city | -| Region | Get Catalog Variable > region | +| Region | Get Catalog Variable > region_state | | Postal Code | Get Catalog Variable > postal_code | -| Country Code | Get Catalog Variable > country | -| Product ID | Get Catalog Variable > select_a_yubikey_model | +| Country Code | Get Catalog Variable > country_code | +| Product ID | Get Catalog Variable > yubikey_model | | Inventory Product ID | Get Catalog Variable > is_the_user_receiving_their_first_yubikey_or_a_replacement | | Customization ID | Enter your YubiEnterprise customization ID - This can be found in the YubiEnterprise console, or you can work with your Yubico contact | | Quantity | 1 | @@ -188,8 +188,9 @@ We will need to create a flow variable to keep track of the current shipment sta 1. Click the 3 dots on the top right of the screen 2. Click **Flow Variables** 3. Click the small **+** button on the right of the pop-up menu -4. Set the **Label** to **Current shipment state ID**. -5. Set the **Type** to **Integer** +4. Set the **Label** to **Current shipment state ID** +5. Set the **Name** to **current_shipment_state_id** +6. Set the **Type** to **Integer** Your final settings should resemble the image below. @@ -305,9 +306,9 @@ For the field **Shipment ID**, drag the **Shipment Request ID** data pill from t Next, we are going to update the flow variable for the **Current Shipment State ID**. This will help us understand if the PIN and credential response is available for processing. -First we'll start by setting the **Flow Variable Current Shipment State ID** to the updated state provided by the **Get FIDO Pre-reg shipment** action. +First we'll start by setting the **Flow Variable Current Shipment State ID** to the updated state provided by the **YubiEnterprise get shipment (Pre-reg)** action. -These steps should resemble the ones taken earlier on this page. Under the **Get FIDO Pre-reg shipment** action click the **+ Add an Action, Flow Logic, or Subflow** button. +These steps should resemble the ones taken earlier on this page. Under the **YubiEnterprise get shipment (Pre-reg)** action click the **+ Add an Action, Flow Logic, or Subflow** button. Next, select **Flow Logic**. @@ -317,7 +318,7 @@ A new menu will appear. Begin by clicking the **+** button in the new menu. In the **Name** field, select the flow variable **Current shipment state ID**. -Drag the **Shipment State ID** value from the **Data** window on the right, in the **Get FIDO Pre-reg shipment** section. +Drag the **Shipment State ID** value from the **Data** window on the right, in the **YubiEnterprise get shipment (Pre-reg)** section. Your resulting menu should resemble the image below. diff --git a/docs/docs/fido-pre-reg/overview.md b/docs/docs/fido-pre-reg/overview.md index 786a353..a2764c2 100644 --- a/docs/docs/fido-pre-reg/overview.md +++ b/docs/docs/fido-pre-reg/overview.md @@ -4,17 +4,23 @@ sidebar_position: 1 # FIDO Pre-reg overview -With FIDO Pre-reg, an IT administrator can use the YubiEnterprise Delivery API together with an identity provider's (IdP) FIDO2 API to order pre-registered YubiKeys for end-users. The keys are pre-registered and shipped directly to the specific end user together with a login credential for immediate use. +With Yubico FIDO Pre-reg, an IT administrator can use the YubiEnterprise Delivery API together with an identity provider's (IdP) FIDO2 API to order pre-registered YubiKeys for end-users. The keys are pre-registered and shipped directly to the specific end user with a login credential for immediate use. + +:::info + +This guide is designed to be a starting point to demonstrate a basic integration exercising the critical path for ServiceNow and the YubicoEnterprise Delivery API. The resulting product is not production ready. + +::: ## Learn more The resources below dive into more details about Yubico's FIDO Pre-reg solution -- [FIDO Pre-reg](https://www.yubico.com/products/fido-pre-reg/) -- [Yubico Blog - FIDO Pre-reg is here](https://www.yubico.com/blog/fido-pre-reg-is-here-what-secure-fast-passwordless-onboarding-and-account-recovery-at-scale-means-for-your-business-and-end-users/) +- [Yubico FIDO Pre-reg](https://www.yubico.com/products/fido-pre-reg/) +- [Yubico Blog - Yubico FIDO Pre-reg is here](https://www.yubico.com/blog/fido-pre-reg-is-here-what-secure-fast-passwordless-onboarding-and-account-recovery-at-scale-means-for-your-business-and-end-users/) ## This guide -At the end of this tutorial you will have a custom ServiceNow flow that is capable of ordering a YubiKey with a pre-registered FIDO2 credential against a supported IdP. This guide will build off of the concepts introduced in the earlier sections of this guide, though does not require the implementation of a non-FIDO Pre-reg YubiEnterprise shipment flow. +At the end of this tutorial you will have a custom ServiceNow flow that is capable of ordering a YubiKey with a pre-registered FIDO2 credential against a supported IdP. This guide will build off of the concepts introduced in the earlier sections of this guide, and does not require the implementation of a non-FIDO Pre-reg YubiEnterprise shipment flow. Click the **Next** button below if you are ready to begin! diff --git a/docs/static/img/pre-reg/pr-52.png b/docs/static/img/pre-reg/pr-52.png index 208510a..cd39798 100644 Binary files a/docs/static/img/pre-reg/pr-52.png and b/docs/static/img/pre-reg/pr-52.png differ