Authenticated access
Protect private documentation with authenticated access, so only approved customers, partners, or team members can view your content
Authenticated documentation. Simplified.
Edit content using GitBook’s block-based WYSIWYG editor with Markdown support.
How authenticated access works
Connect your identity provider, define who gets access, and keep private product knowledge protected behind a secure sign-in
01
Enable authenticated access for your GitBook site and choose what to protect
02
Connect to your authentication provider with an integration or custom back-end
03
Your authentication provider determines who is allowed to access your site
04
Optionally pass user data into GitBook to offer personalized content based on who signs in
FAQs
What is authenticated documentation
Authenticated documentation is published content that requires users to sign in before they can view it. It’s commonly used for customer-only docs, partner portals, internal knowledge, and other private product content.
What authentication providers does GitBook support?
GitBook supports authentication through integrations with providers including Okta, Azure, Auth0, AWS Cognito, and OIDC. You can also use a custom authentication backend.
How do I set up a custom authentication backend?
First, you need to enable authenticated access for your site. You can do that in the Site settings screen — head to our docs to find out more.
Once enabled, you can set up your custom backend that creates and signs a JSON Web Token (JWT) upon successful authentication and redirects users back to GitBook. Find out more about setting up a custom authentication backend in our docs.
Can I show different content to different users?
Yes. GitBook’s adaptive content can use information about an authenticated visitor to tailor the content they see, making it possible to create different experiences for different customers, plans, roles, or use cases.
Who will be able to view my docs after setup?
Only visitors who have authentication credentials will be able to see the content of your site. You can choose who gets access through your authentication provider.
Can GitBook be used for private internal documentation?
Yes. Teams can use authenticated access to keep internal documentation and company knowledge protected behind sign-in, while still giving employees a polished, searchable GitBook experience. GitBook also supports SSO and granular access controls for more controlled internal deployments.
Which plan is required for authenticated access?
Authenticated access is available on the Ultimate plan. Head to our pricing page to find out more
