idp-server ドキュメントガイド
あなたの役割に合わせて、最適な読み始めポイントを見つけてください。
読者別スタートガイド
初めての方
idp-serverを初めて触る方は、以下の順序で読み進めてください。
| Step | ドキュメント | 所要時間 | 内容 |
|---|---|---|---|
| 1 | はじめに | 5分 | idp-serverとは何か、特徴と想定利用ケース |
| 2 | 技術概要 | 10分 | システム構成、モジュール一覧 |
| 3 | 機能一覧 | 10分 | 対応プロトコル、機能の全体像 |
| 4 | Getting Started | 30分 | 環境構築、初回起動 |
運用担当者
本番環境へのデプロイ・運用を担当する方向け。
| Step | ドキュメント | 内容 |
|---|---|---|
| 1 | 商用デプロイ概要 | 責任範囲、技術要件 |
| 2 | Dockerビルド | イメージビルド手順 |
| 3 | 環境変数設定 | 全環境変数一覧 |
| 4 | DB設定 | PostgreSQL/RLS設定 |
| 5 | 初期設定 | setup.sh、initial.json |
| 6 | 運用ガイダンス | 監視、トラブルシューティング |
関連: テスト戦略 | パフォーマンステスト
設定・構築担当者（How-to）
idp-serverの設定を段階的に行いたい方向け。
| Phase | 内容 | 所要時間 |
|---|---|---|
| Phase 1: 最小構成 | サーバー起動 → 組織初期化 → テナント → クライアント → ユーザー → 認証ポリシー | 約1.5時間 |
| Phase 2: セキュリティ強化 | MFA設定 → トークン戦略 → 認証ポリシー詳細 | 約1時間 |
| Phase 3: 高度な機能 | 外部IdP連携 → CIBA → FIDO-UAF | 約1.5時間 |
| Phase 4: 拡張機能 | 身元確認（eKYC） → セキュリティイベントフック | 約2時間 |
開発者
idp-serverの機能開発・拡張を行う開発者向け。
スキルレベル別ラーニングパス
| レベル | 期間 | 目標 | ドキュメント |
|---|---|---|---|
| 初級 | 1-2週間 | 既存機能の理解・バグ修正 | 初級パス |
| 中級（Control Plane） | 2-4 週間 | 管理API実装 | Control Planeトラック |
| 中級（Application Plane） | 2-4週間 | 認証フロー実装 | Application Planeトラック |
| 上級 | 1-2ヶ月 | フルスタック | Full Stackトラック |
クイックスタート（開発者向け）
| ドキュメント | 内容 |
|---|---|
| アーキテクチャ概要 | 4層アーキテクチャ、責務分離 |
| 共通実装パターン | Repository/Handler/EntryServiceパターン |
| トラブルシューティング | よくあるエラーと解決策 |
| コードレビューチェックリスト | PR前の必須チェック |
詳細: 開発者ガイドTOC
OAuth/OIDC を学びたい方
OAuth 2.0 / OpenID Connect の基礎から学びたい方向け。
基礎知識（順番に読む）
| # | ドキュメント | 内容 |
|---|---|---|
| 01 | アイデンティティ管理の基礎 | 認証と認可の違い |
| 02 | 身近な実例で学ぶID管理 | ATM等の実例 |
| 03-04 | 最新トレンド / 現代Webの認証認可 | eKYC・FIDO・MFA |
| 05-10 | OAuth 2.0シリーズ | なぜ必要か → 認可 → 役割 → フロー → トークン |
| 11-15 | OpenID Connectシリーズ | OIDC基礎 → 詳細 → JWT → クレーム → Discovery |
| 16-21 | FIDO2/WebAuthnシリーズ | パスワードレス認証の仕組み |
機能別クイックリファレンス
認証・認可
| 機能 | 概念 | How-to | 開発者向け |
|---|---|---|---|
| 認証ポリシー | concept-01 | 基礎 / 詳細 | impl-05 |
| MFA（多要素認証） | concept-02 | MFA設定 | - |
| パスワードポリシー | concept-02 | - | config/password |
| WebAuthn/FIDO2 | basic-16~21 | - | config/fido2 |
トークン・セッション
| 機能 | 概念 | How-to | 開発者向け |
|---|---|---|---|
| トークン管理 | concept-02 | トークン戦略 | - |
| セッション管理 | concept-03 | - | impl-18 |
| IDトークン | concept-01 | - | - |
マルチテナント・組織
| 機能 | 概念 | How-to | 開発者向け |
|---|---|---|---|
| マルチテナント | concept-01 | 組織初期化 | impl-07 |
| テナント設定 | - | テナント設定 | config/tenant |
| クライアント | concept-03 | クライアント登録 | config/client |
身元確認・eKYC
| 機能 | 概念 | How-to | 開発者向け |
|---|---|---|---|
| 身元確認済みID | concept-01 | ガイド / 申込み | impl-07 |
| カスタムクレーム | concept-03 | - | impl-21 |
外部連携・フェデレーション
| 機 能 | 概念 | How-to | 開発者向け |
|---|---|---|---|
| 外部IdP連携 | - | Federation設定 | impl-08 |
| 外部サービス連携 | concept-02 | - | impl-17 |
セキュリティ・監査
| 機能 | 概念 | How-to | 開発者向け |
|---|---|---|---|
| セキュリティイベント | concept-01 | フック設定 | impl-15 |
| 監査ログ | concept-01 | - | impl-25 |
| 認可許諾管理 | concept-05 | - | - |
プロトコル別リファレンス
| プロトコル | 概念・詳細 | 開発者向け |
|---|---|---|
| Authorization Code Flow | protocol-01 | impl |
| CIBA | protocol-02 / protocol-04 | impl |
| Token Introspection | protocol-03 | - |
| FAPI | concept-06 / protocol-05 | impl-22 |
| PKCE | - | impl-23 |
カテゴリ別一覧
content_01_intro - 製品紹介 (3)
| ファイル | タイトル |
|---|---|
| intro-01-tech-overview.md | 技術概要 |
| intro-02-features.md | 機能一覧 |
| intro-03-use-cases.md | ユースケースカタログ |
content_02_quickstart - クイックスタート (2)
| ファイル | タイトル |
|---|---|
| quickstart-01-getting-started.md | Getting Started |
| quickstart-03-common-use-cases.md | ユースケース一覧 |
| quickstart-04-login.md | ログイン |
| quickstart-04-login-social.md | Socialログイン（外部IdP連携） |
| quickstart-11-ciba.md | CIBA |
| quickstart-12-financial-grade.md | 金融グレード（FAPI） |
content_03_concepts - 概念・コンセプト (23)
| # | ファイル | タイトル | カテゴリ |
|---|---|---|---|
| 01 | concept-03-multi-tenant.md | マルチテナント | 基盤概念 |
| 02 | concept-02-control-plane.md | コントロールプレーン | 基盤概念 |
| 03 | concept-04-client.md | クライアント | 基盤概念 |
| 04 | concept-01-id-management.md | ID（ユーザー）管理 | アイデンティティ管理 |
| 05 | concept-02-password-policy.md | パスワードポリシー | アイデンティティ管理 |
| 06 | concept-01-authentication-policy.md | 認証ポリシー | 認証・認可 |
| 07 | concept-02-mfa.md | 多要素認証（MFA） | 認証・認可 |
| 08 | concept-03-session-management.md | セッション管理 | 認証・認可 |
| 09 | concept-04-authorization.md | 認可 | 認証・認可 |
| 10 | concept-05-grant-management.md | 認可許諾管理 | 認証・認可 |
| 11 | concept-06-fapi.md | FAPI | 認証・認可 |
| 12 | concept-01-id-token.md | IDトークン | トークン・クレーム |
| 13 | concept-02-token-management.md | トークン管理 | トークン・クレーム |
| 14 | concept-03-custom-claims.md | カスタムクレーム・スコープ | トークン・クレーム |
| 15 | concept-01-id-verified.md | 身元確認済みID | 高度なID機能 |
| 16 | concept-02-enterprise-id.md | エンタープライズID | 高度なID機能 |
| 17 | concept-01-security-events.md | セキュリティイベント・フック | セキュリティ・拡張 |
| 18 | concept-02-external-service-integration.md | 外部サービス連携 | セキュリティ・拡張 |
| 19 | concept-03-schema-validation.md | スキーマバリデーション | セキュリティ・拡張 |
| 20 | concept-01-audit-compliance.md | 監査ログ | 運用・監視 |
| 21 | concept-02-application-logging.md | アプリケーションログ | 運用・監視 |
| 22 | concept-03-tenant-statistics.md | テナント統計 | 運用・監視 |
| 23 | concept-04-operations.md | 運用・保守 | 運用・監視 |
basic/ (21) - OAuth/OIDC/FIDO2基礎知識シリーズ
content_04_protocols - プロトコル詳細 (5)
| ファイル | タイトル |
|---|---|
| protocol-01-authorization-code-flow.md | 認可コードフロー |
| protocol-02-ciba-flow.md | CIBAフロー |
| protocol-03-introspection.md | イントロスペクション |
| protocol-04-ciba-rar.md | CIBA + RAR |
| protocol-05-fapi-ciba.md | FAPI + CIBA |
content_05_how-to - ハウツーガイド (19)
| Phase | ディレクトリ/ファイル | タイトル |
|---|---|---|
| - | index.md | 学習ロードマップ |
| Phase 1 | phase-1-foundation/ | 基盤構築 |
| 1 | 01-server-setup.md | サーバーセットアップ |
| 1 | 02-organization-initialization.md | 組織初期化 |
| 1 | 03-tenant-setup.md | テナント設定 |
| 1 | 04-client-registration.md | クライアント登録 |
| 1 | 05-user-registration.md | ユーザー登録 |
| 1 | 06-password-management.md | パスワード管理 |
| 1 | 07-authentication-policy.md | 認証ポリシー（基礎） |
| Phase 2 | phase-2-security/ | セキュリティ強化 |
| 2 | 01-mfa-setup.md | MFA設定 |
| 2 | 02-token-strategy.md | トークン戦略 |
| 2 | 03-authentication-policy-advanced.md | 認証ポリシー（詳細） |
| Phase 3 | phase-3-advanced/ | 高度な機能 |
| 3 | 01-federation-setup.md | 外部IdP連携 |
| 3 | fido-uaf/01-ciba-flow.md | CIBA + FIDO-UAF |
| 3 | fido-uaf/02-registration.md | FIDO-UAF登録 |
| 3 | fido-uaf/03-deregistration.md | FIDO-UAF解除 |
| Phase 4 | phase-4-extensions/ | 拡張機能 |
| 4 | identity-verification/01-guide.md | 身元確認ガイド |
| 4 | identity-verification/02-application.md | 身元確認申込み |
| 4 | identity-verification/03-registration.md | 身元確認データ登録 |
| 4 | 04-security-event-hooks.md | セキュリティイベントフック |
| 4 | 05-ciba-binding-message.md | CIBA Binding Message検証 |
content_06_developer-guide - 開発者ガイド
サブディレクトリ構成:
01-getting-started/- 入門（サービス概要、アーキテクチャ）02-control-plane/- 管理API実装（5ファイル）03-application-plane/- 認証フロー実装（12ファイル）04-implementation-guides/- 実装パターン（22ファ イル）05-configuration/- 設定リファレンス06-patterns/- 共通パターン07-troubleshooting/- トラブルシューティング08-reference/- リファレンス（設計原則、チェックリスト等）learning-paths/- ラーニングパス（4トラック）
content_07_reference - APIリファレンス (4)
| ファイル | タイトル |
|---|---|
| api-reference.md | API概要 |
| api-reference/api-authentication-device-ja.md | 認証デバイスAPI |
| api-reference/api-internal-ja.md | 内部API |
| api-reference/api-resource-owner-ja.md | リソースオーナーAPI |
content_08_ops - 運用ガイド (9)
| ファイル | タイトル |
|---|---|
| ops-01-test-strategy.md | テスト戦略 |
| ops-02-performance-test.md | パフォーマンステスト |
| ops-03-authentication-device-search-performance.md | 認証デバイス検索パフォーマンス |
| commercial-deployment/ | |
| 00-overview.md | 商用デプロイ概要 |
| 01-docker-build.md | Dockerビルド |
| 02-environment-variables.md | 環境変数 |
| 03-database.md | データベース設定 |
| 04-initial-configuration.md | 初期設定 |
| 05-operational-guidance.md | 運用ガイダンス |
| 06-migration-strategy.md | マイグレーション戦略 |
content_09_project - プロジェクト情報 (7)
| ファイル | タイトル |
|---|---|
| project-01-faq.md | FAQ（よくある質問） |
| project-02-roadmap.md | ロードマップ |
| project-03-contributing.md | コントリビュートガイド |
| project-04-license.md | ライセンス |
| analytics-statistics-design.md | 統計・分析機能設計 |
| control-plane-separation-design.md | Control Plane分離設計 |
| security-event-pubsub-architecture.md | セキュリティイベントPub/Sub設計 |
content_20_testing - テスト (3)
| ファイル | タイトル |
|---|---|
| e2e-test-coverage.md | E2Eテストカバレッジ |
| unit-testing-strategy-by-module.md | モジュール別ユニットテスト戦略 |
| unit-testing-detailed-class-lists.md | クラス別テスト一覧 |
更新情報
| 日付 | 内容 |
|---|---|
| 2025-12-15 | 読者別ガイド形式に再構築 |
| 2025-10-07 | 初版作成 |
対象バージョン: idp-server v0.8.7+