メインコンテンツへスキップ
Management API は、認可サーバーの設定と、その内部のエンティティ(サービス、クライアント、トークン)を管理する Authlete API 群です。OAuth 2.0 / OpenID Connect のプロトコルリクエストをランタイムで処理する Core API とは異なり、Management API は認可サーバーの構築・運用のためにプロトコルフローの外で使用します。

典型的なユースケース

  • プロビジョニング — Infrastructure as Code パイプラインからサービスを作成・設定し、本番・ステージング・開発などの環境を複製する。
  • クライアントのライフサイクル管理 — 開発者ポータルや管理ツールから新しいクライアントアプリケーションを登録し、シークレットを更新したり、クライアントを無効化したりする。
  • トークンの管理 — エンドユーザーやクライアントに発行されたアクセストークンを一覧する、デバイス紛失や不正利用報告時にトークンを失効させる、既存の認可サーバーからトークンを移行する。
  • エンドユーザー向けの認可済みアプリ画面 — エンドユーザーが認可済みのアプリケーションを一覧表示し、ユーザーが個別にクライアントを取り消せるようにする。
  • 運用と監査 — 発行済みトークンの調査、有効期限ポリシーの変更、クライアント一覧の監査。

認証

Management API の呼び出しには、操作に応じた権限が付与されたサービスアクセストークンが必要です。トークンの作成と権限の付与については認証を参照してください。 サービスの作成と削除は例外で、IdP エンドポイントで提供され、組織トークンを使います。詳細はサービス管理を参照してください。

Management API と管理コンソール

Authlete 管理コンソールは Management API の上に構築されています。コンソールで行える操作(サービスの作成、クライアントの登録、トークンの参照など)は同じ API として公開されているため、ワークフローに応じて使い分けられます。
  • 人が対話的に行う変更 → 管理コンソール
  • 反復可能・自動化・監査可能な変更 → Management API を直接利用

次のステップ