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 リダイレクト URI として入力します（下のスクリーンショットのとおり）。Save を押します。

次に、GitBook でインテグレーションのモーダルを閉じ、Manage site ボタンをクリックします。次へ移動し オーディエンス、選択し 認証済みアクセス、バックエンドとして 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 に渡されるようになったら、 コンテンツを適応させる の手順に従って、どのコンテンツを誰に表示するかを定義します。