OIDC の設定

ドキュメントの閲覧者向けにOIDCのログイン画面を設定します

このガイドでは、ドキュメント用の保護されたサインイン画面を設定する手順を説明します。このガイドを読む前に、まず次の手順を完了していることを確認してください。 認証済みアクセスを有効にする.

OIDCを使用して認証付きアクセスでGitBookサイトをセットアップする手順は次のとおりです:

1

アイデンティティプロバイダーで新しいアプリケーションを作成します

アイデンティティプロバイダーのダッシュボードからアプリケーションを作成します。

2

OIDC統合をインストールして設定します

Auth0統合をインストールし、必要な設定を追加します。

OIDCはOpenID Connectの略で、OAuth上に構築されたIDレイヤーです。多くのアイデンティティプロバイダーはOIDCに準拠しており、GitBookの認証付きアクセス向けOIDC統合を使うと、認証付きアクセスの背後にスペースを公開でき、コンテンツへのアクセスはアイデンティティプロバイダーによって制御されます

このガイドはすべてのアイデンティティプロバイダー向けの一般的なガイドであるため、詳細の一部はお使いのアイデンティティプロバイダーによって異なる場合があります。説明のため、このガイドではGoogleをアイデンティティプロバイダーとして使用しています。

アイデンティティプロバイダーで新しいアプリケーションを作成します

統合を動作させるために、アイデンティティプロバイダー側で設定する必要がある項目がいくつかあります。

アイデンティティプロバイダー内で新しいアプリを作成する必要があります。タイプは「Web Application」であるべきです。Googleでは、「APIとサービス」、「認証情報」、そして「OAuth 2.0 Client IDs」の下でこれを作成します。\

「認証情報を作成」をクリックし、「OAuth クライアント ID」を選択して、タイプとして「Web Application」を選び、適切な名前を付け、承認済みのリダイレクト URI の下に、GitBookから取得したコールバックURLを入力します。

「作成」をクリックします。Client IDとClient Secretを控えておいてください。GitBookで統合の設定を完了するためにこれらが必要になります。

OIDC統合をインストールして設定します

GitBookアプリ内の統合に移動し、カテゴリとして認証付きアクセスを選択して、OIDC統合をインストールします。選択したドキュメントサイトにOIDC統合をインストールします。

サイトにインストールしたら、設定に移動し、保存ボタンのすぐ上にあるコールバックURLを控えてください。アイデンティティプロバイダーの設定に必要になる場合があります。

統合をインストールしたスペースのOIDC統合の設定画面を開きます。

次の画像のようになります

Client IDとClient Secretには、アイデンティティプロバイダーで取得した値を貼り付けます。

次に、アイデンティティプロバイダーの認可エンドポイントとアクセストークンエンドポイントを見つける必要があります。Googleの場合、これらは https://accounts.google.com/o/oauth2/v2/auth 、 https://oauth2.googleapis.com/token です。

Googleを使用していない場合、これらのエンドポイントは異なります。これらのエンドポイントを見つけるには、アイデンティティプロバイダーのドキュメントを確認してください

OAuthスコープについては、値もまたアイデンティティプロバイダーによって異なります。Googleの場合は、次を入力できます openid.

アイデンティティプロバイダーのドキュメントにある許可されたスコープの一覧を確認し、最も制限の強いスコープの値を入力してください。Access Tokenは、ユーザーが認証されていることを確認するためにのみ使用し、それ以上の情報を取得するためには使用しません。そのため、最も制限の強いスコープを入力するのが最善のセキュリティ推奨事項です。

Save を押します。

次に、GitBook でインテグレーションのモーダルを閉じ、Manage site ボタンをクリックします。次へ移動し オーディエンス、選択し 認証済みアクセスを選択し、バックエンドとしてOIDCを選択します。次に、 オーディエンスを更新をクリックします。サイトの画面に移動して 公開。 これでサイトはAuth0アプリケーションによって制御される認証付きアクセスの背後で公開されました。試すには、「Visit」をクリックしてください。OIDCでサインインするよう求められ、Auth0を使用した認証付きアクセスの背後でサイトが公開されていることが確認できます。