Oktaの設定

ドキュメント訪問者向けのOktaログイン画面を設定します

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

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

1

新しい Okta アプリケーションを作成する

Okta ダッシュボードから Okta アプリケーションを作成します。

2

Okta インテグレーションをインストールして設定する

Okta インテグレーションをインストールし、必要な設定を追加します。

3

適応型コンテンツ用に Okta を設定する（任意）

GitBook の適応型コンテンツで動作するように Okta を設定します。

新しい Okta アプリケーションを作成する

まず、Okta プラットフォーム（管理者版）にサインインし、左側のサイドバーにある Applications ボタンをクリックして、新しいアプリ統合を作成します（または既存のものを使用します）。

Create App Integration をクリックし、サインイン方法として OIDC - OpenID Connect を選択します。その後、アプリケーションタイプとして Web Application を選択します。

適切な名前を付け、そのページ上の他の設定は変更しないでください。割り当てについては、適切なチェックボックスを選択します。Save をクリックします。

次の画面で、Client ID と Client Secret をコピーします。右上のドロップダウンをクリックして、メールアドレスのすぐ下にある Okta Domain をコピーします。

Okta インテグレーションを設定するために、これらの値が必要になります。

Okta インテグレーションをインストールして設定する

公開したいサイトの Integrations タブに移動し、Okta インテグレーションを見つけます。

サイトにインテグレーションをインストールします。

サイトへのインストール後、Client ID、Okta Domain、および Client Secret の入力を求める画面が表示されます。

Client ID、Okta Domain（ https://のプレフィックスがある場合は削除）および Client Secret には、Okta ダッシュボードからコピーした値を貼り付けます。

Save をクリックします。

モーダルに表示されている URL をコピーし、Okta の Sign-In redirect URI として入力します（下のスクリーンショットのとおりです）。Save を押します。

次に、GitBook でインテグレーションのモーダルを閉じ、Manage site ボタンをクリックします。に移動し 対象, を選択し 認証アクセス, バックエンドとして Okta を選択します。その後、 対象を更新。サイトの画面に移動して 公開をクリックします。 サイトは現在、Auth0 アプリケーションによって制御される認証アクセスの背後で公開されています。試すには、Visit をクリックします。Okta でのサインインを求められ、Auth0 を使用した認証アクセスの背後でサイトが公開されていることが確認できます。

適応型コンテンツ用に Okta を設定する（任意）

認証アクセス付きの GitBook サイトで Adaptive Content を有効にするには、認証トークンに関連するユーザーデータをクレームとして含めるように Okta アプリケーションを設定する必要があります。

クレームは、GitBook に送信されるトークンに埋め込まれたキーと値のペアです。これらのクレームは、ユーザーの役割、プラン、所在地、またはその他の識別属性に基づいて、ドキュメントを動的に調整するために使用できます。

Okta は複数種類のクレームをサポートしています:

• 標準クレーム これは、 email, nameのような一般的なクレームや、 groups) を含みます。これらはデフォルトで含まれている場合がありますが、一貫して利用できるようにするには、トークン設定に明示的に追加する必要があることがよくあります。
• カスタム クレーム Okta では、 カスタムユーザー属性 または式ベースのロジックを使用してカスタムクレームを定義できます。これにより、プランの階層、アカウント ID、内部チームフラグのような、非常に特定的な値を渡すことができます。
• クレームとしてのグループ Okta のグループをクレームとして渡すこともできます。これは、「エンタープライズユーザー」や「ベータテスター」のような対象セグメントを定義する際に特に便利です。これらは、認可サーバーのクレーム設定でフィルタリングおよびマッピングできます。

Okta でクレームを追加またはカスタマイズするには:

1. Okta Admin Console を開きます。
2. に移動します Security > API > Authorization Servers.
3. GitBook サイトで使用している認可サーバーを編集します。
4. の下の Claims タブで、必要なクレームをトークンに含めるルールを追加します。
5. GitBook サイトがそれらのクレームを正しく読み取り、マッピングしていることを確認してください。

クレームが GitBook に渡されるようになったら、 コンテンツの適応 の手順に従って、どのコンテンツを誰に表示するかを定義します。