Setting up Okta

Set up an Okta login screen for visitors to your docs.

To setup your GitBook site with visitor authentication using Okta, the process looks as follows:

1

Create a new Okta application

Create an Okta application from your Okta dashboard.

2

Install and configure the Okta integration

Install the Okta integration and add the required configuration.

3

Configure Okta for adaptive content (optional)

Configure Okta to work with adaptive content in GitBook.

Create a new Okta application

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.

Install and configure the Okta integration

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

Install the integration on your site.

Upon installation on site, 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 click on the Manage site button. Navigate to Audience, select Visitor Authentication, and choose Okta as the backend. and click Update audience. Go to the site's screen and click Publish. The site is now published behind Visitor Authentication controlled by your Okta application. To try it out, click on Visit. You will be asked to sign in with Okta, which confirms that your site is published behind Visitor Authentication using Okta.

Configure Okta for adaptive content

Last updated

Was this helpful?