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（remove https://prefix, if any）および Client Secret には、Okta Dashboard からコピーした値を貼り付けます。

Save をクリックします。

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

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

アダプティブコンテンツ用に Okta を設定する（任意）

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

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

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

• 標準クレーム これらは一般的なクレーム（ メール, name、または グループなど）で、既定で含まれる場合がありますが、一貫して利用できるようにするには、トークン設定に明示的に追加する必要があることがよくあります。

• カスタム クレーム Okta では、 カスタムユーザー属性 または式ベースのロジックを使用してカスタムクレームを定義できます。これにより、プランの階層、アカウント ID、内部チームフラグなど、非常に具体的な値を渡せます。

• クレームとしてのグループ Okta のグループをクレームとして渡すこともできます。これは、「エンタープライズユーザー」や「ベータテスター」のような対象セグメントを定義する場合に特に便利です。これらは認可サーバーのクレーム設定でフィルタリングおよびマッピングできます。

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

1. Okta Admin Console を開きます。

2. 次へ移動します Security > API > Authorization Servers.

3. GitBook サイトで使用している認可サーバーを編集します。

4. の下で Claims タブで、必要なクレームをトークンに含めるルールを追加します。

5. GitBook サイトがそれらのクレームを正しく読み取り、マッピングしていることを確認してください。

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