メインコンテンツまでスキップ

開発者ガイドマップ

idp-serverで実際に開発を行う開発者のための実践ガイド

このガイドの目的

このセクションは、idp-serverで実際に開発を行う開発者のための実践ガイドです。

対象読者

  • 新規参画開発者: idp-serverで初めて開発を行う方
  • 機能実装者: 新機能・API追加を担当する開発者
  • バグ修正者: 既存コードの理解・修正を行う開発者

🚀 クイックスタート

新規開発者(初日)

  1. サービス概要
  2. アーキテクチャ概要
  3. 設計原則
  4. 環境構築して動かしてみる

管理API実装者

  1. Control Plane概要
  2. システムレベルAPI
  3. Control Plane Track

OAuth/OIDCフロー実装者

  1. Application Plane概要
  2. Authorization Flow実装
  3. Application Plane Track

📚 学習の進め方

Phase 1: はじめに(このセクション)

まず、はじめにセクションのドキュメントを順に読んでください:

  1. サービス概要 - idp-serverの全体像・ユースケース
  2. アーキテクチャ概要 - 4層アーキテクチャ・責務分離の理解
  3. 設計原則 - 設計原則・ガイドライン

次に、実装に必要な基礎知識を習得:

ドキュメント説明
共通実装パターンよく使うパターン(Repository/Handler/EntryService)
トラブルシューティングよくある問題と解決策
コードレビューチェックリストPR前の必須チェック項目

Phase 2: 学習パス

体系的に学ぶ: 学習パス

Phase 3: API種別ガイド

Control Plane(管理API)

システム管理者・組織管理者向け - リソース設定・管理

ドキュメント説明
Control Plane 概要管理APIの全体像・種類
リソース一覧管理可能なリソース
システムレベルAPIテナント単位の管理API実装
組織レベルAPI組織単位の管理API実装(4ステップアクセス制御)

URL例: /v1/management/tenants/{tenantId}/clients

Application Plane(認証・認可フロー)

エンドユーザー・アプリケーション向け - OAuth/OIDC準拠の認証フロー

ドキュメント説明
Application Plane 概要OAuth/OIDCフローの全体像
Authorization Code Flow認可フロー実装
Token Endpointトークン発行実装
Authentication認証実装
UserInfoユーザー情報取得
CIBA Flowバックチャネル認証実装
Identity Verification身元確認
Federation外部IdP連携
Eventsイベント処理

URL例: /oauth/authorize, /oauth/token, /{tenant}/v1/me/profile

Phase 4: 実装ガイド

詳細な実装方法は 実装ガイド を参照してください。カテゴリ別に整理されています:

  • インフラ・基盤: Repository、Transaction、DataSource、Caching等
  • OAuth/OIDC: PKCE、FAPI、JOSE、Scope & Claims等
  • 認証: Authentication Interactor、Policy、Federation Provider
  • 外部連携: HTTP Request Executor、Notification、Security Event Hooks
  • 高度な機能: Plugin、Configuration Management、Audit Logging

🎯 Control Plane vs Application Plane

Control Plane(管理API)

役割: システム・リソースの設定管理

  • URL: /v1/management/...
  • ユーザー: システム管理者・組織管理者
  • 実装: Handler-Serviceパターン(権限チェック・Audit Log・Dry Run)

Application Plane(OAuth/OIDCフロー)

役割: 認証・認可フロー実行

  • URL: /{tenant-id}/v1/...
  • ユーザー: エンドユーザー・アプリケーション
  • 実装: シンプルな委譲パターン(権限チェックなし)

🔗 関連ドキュメント

  • Concepts - OAuth/OIDC仕様解説
  • How-To - 運用手順・デプロイガイド

最終更新: 2025-12-18