概要

ドキュメントの閲覧者を制御し、体験をカスタマイズする

Proプランにはパスワード認証が含まれます。

Enterpriseプランにはすべての認証方法が含まれます。

ユーザー情報とセキュリティ要件に基づいてアクセスを管理し、ドキュメントをカスタマイズするため、次の3つのアプローチから選べます:

• フル認証: すべてのコンテンツを完全に保護し、コンテンツを全面的にカスタマイズ可能。
• 部分的認証: ページごとのアクセス制御に対応し、コンテンツを全面的にカスタマイズ可能。
• パーソナライゼーション: セキュリティ保証なしでコンテンツをカスタマイズ。すべてのコンテンツは公開のままです。

ユースケースの例

次の場合はフル認証を選択してください：

• 機密情報を含む社内向けドキュメントを作成する場合
• ユーザーの本人確認が必要な独自APIを文書化する場合
• 顧客ごとの実装ガイドを用意する場合

次の場合は部分的認証を選択してください：

• 公開の「はじめに」ガイドを提供しつつ、高度な機能は非公開にする場合
• プレミアムユーザーに追加ドキュメントを提供するフリーミアム製品を運用する場合
• オープンソースのドキュメントは公開しつつ、エンタープライズ向けセクションは非公開にする場合

次の場合はパーソナライゼーションを選択してください：

• ユーザーごとの例を表示する公開APIドキュメントを作成する場合
• ユーザープロファイルに基づいてコンテンツをカスタマイズするマーケティングサイトを構築する場合
• ユーザーの嗜好やスキルレベルに合わせて内容が変化する公開チュートリアルを提供する場合

ハンドシェイク方法

既存のインフラやセキュリティ要件に最適な方法を選びましょう。

方法	対応範囲	セットアップの難易度	最適な用途
JWT	すべての方式	中	カスタムログインフロー、セキュリティ制御の最大化
OAuth 2.0	すべての方式	高	サードパーティ認証プロバイダー、エンタープライズ向けセキュリティ
Mintlify Dashboard	認証のみ	低	すでに Mintlify ダッシュボードを使用しているチーム
Password	認証のみ	低	パーソナライゼーションなしのシンプルな共有アクセス
Shared Session	パーソナライゼーションのみ	低	既存のセッションベース認証を使うアプリ

それぞれの方法を使うべきタイミング

JWT: 既存の認証システムがあり、ログインフローを完全に制御したい場合に使用します。カスタムのユーザー管理を行いたい場合や、ドキュメントへのアクセスをメインアプリケーションから切り離す必要がある場合に最適です。

OAuth 2.0: サードパーティの認証プロバイダー（Google、GitHub など）を活用したい場合、またはエンタープライズ向けのセキュリティ標準が必要な場合に使用します。すでに OAuth 基盤を利用している組織に最適です。

Mintlify Dashboard: ドキュメントの編集者がそのまま閲覧者でもある場合に使用します。すでに Mintlify のダッシュボードでコンテンツを管理している社内チームに最適です。

Password: 個々のユーザーを追跡したり、コンテンツをパーソナライズしたりする必要がない、シンプルなアクセス制御に使用します。外部委託者、ベータユーザー、一時的なアクセスに適しています。

Shared Session: アプリケーションとドキュメント間でシームレスにログインを共有したい場合に使用します。ユーザーがすでにメインアプリケーションで認証済みで、その体験に合わせてドキュメントをパーソナライズしたい場合に最適です。

コンテンツのカスタマイズ

3つのアプローチすべてで、動的なMDXコンテンツ、APIキーの自動入力、ページの表示制御などのパーソナライゼーション機能に対応しています。実装の詳細は、パーソナライゼーションのセットアップを参照してください。