How to use Okta Integration for Visitor Authentication

This page describes how to use the Okta integration to publish your space behind Visitor Authentication

Setting up Okta

First, sign in to Okta platform (the admin version) and create a new app integration (or use an existing one) by clicking the Applications button in the left sidebar.

Click Create App Integration and select OIDC - OpenID Connect as the Sign-In method. And then select Web Application as the application type.

Name it appropriately and don't edit any other setting on that page. For assignments, choose the appropriate checkbox. Click Save.

On the next screen, copy Client ID and Client Secret. Copy the Okta Domain right below your email address by clicking the dropdown in the top right.

We will need these values to configure the Okta Integration.

Installing the Okta Visitor Authentication Integration

Navigate to the Integrations tab in the space you want to publish and locate the VA-Okta integration or navigate directly to this https://app.gitbook.com/integrations/VA-Okta.

Install the integration on your organization (if necessary) and then install it on your desired space.

Upon installation on space, you will see a screen asking you enter the Client ID, Okta Domain, and Client Secret.

For Client ID, Okta Domain (remove https://prefix, if any) and Client Secret, paste in the value you copied from Okta Dashboard.

Click Save.

Copy the URL displayed in the modal and enter it as a Sign-In redirect URI in Okta (as shown in the below screenshot). Hit Save.

Now, in GitBook, close the integrations modal and Open the Share modal (top right of the screen) and click "Share to an audience", and enable the "Publish with Visitor Authentication" toggle. Choose the VA-Okta integration as your backend for Visitor Authentication, hit Save, and you're done! The space is now published behind Visitor Authentication controlled by your Okta application. To try it out, copy the link where the space is published (you can get this from the Share modal, under "Share to an audience") and open the link in a new tab. You will be asked to sign in with Okta, which confirms that your space is published behind Visitor Authentication using Okta.

Last updated