For the complete documentation index, see llms.txt. This page is also available as Markdown.

認証付きアクセス

公開コンテンツにカスタム認証を設定します

認証付きアクセスを使うと、コンテンツを公開しながら、閲覧したい訪問者には認証を要求できます。有効にすると、GitBook は認証プロバイダーにコンテンツへのアクセス権限の管理を任せます。

A screenshot showing a login screen for docs behind authenticated access
公開済みのドキュメントにサインインを追加します。

ユースケース

認証付きアクセスの一般的なユースケースには、次のようなものがあります:

  • 有料顧客、見込み顧客、またはパートナーのみがアクセスできるべき機密性の高い製品ドキュメントを公開すること。

  • 自社の従業員のみがアクセスできるべき社内ナレッジベースのコンテンツを公開すること。

仕組み

認証付きアクセスを設定する際に選べる方法は 2 つあります:

  1. 当社の認証連携のいずれかをインストールすること — 現在、Okta、Azure、Auth0 をサポートしています。私たちは 強く推奨します この方法は、当社がサポートしている認証プロバイダーを使用している場合におすすめです。

  2. 認証を処理するための独自のサーバーを作成し、ホストします。さまざまな技術を使用できますが、選んだソリューションの実装と保守はあなた次第です。

組み込みのログインおよびログアウトURL

GitBook では、公開サイトでのサインインとサインアウト用の組み込みURLを利用できます:

  • <publishedSiteURL>/~gitbook/auth/login

  • <publishedSiteURL>/~gitbook/auth/logout

ログインURLは、サイトのヘッダーリンクなど、サインインリンクを表示したい場所ならどこでも使えます。

訪問者がログインURLを開くと、GitBook はそのサイトに設定された認証バックエンドへリダイレクトします。これは、連携バックエンドでもカスタムバックエンドでも動作します。

GitBook はさらに次のものも追加します location 訪問者が最初に開いたページに一致するクエリパラメータ。バックエンドはその値を使って、サインイン後に同じページへ戻すことができます。

ログアウトURLを使って、訪問者を GitBook セッションからサインアウトさせます。

に移動します 認証済みアクセスを有効にする サイトの保護されたアクセスの設定を始めるには。

最終更新

役に立ちましたか?