Skip to main content

​
概要

Karasu LAB APIは、モダンなWeb アプリケーション向けの包括的な認証・認可システムを提供します。

​
主な機能

認証システム

メールアドレス/パスワード認証、SNS連携(Google, Discord, GitHub)、JWT トークンベース認証

OAuth 2.0 / OpenID Connect

PKCE対応のOAuth 2.0認可サーバー、OpenID Connect Discovery、サードパーティアプリケーション連携

多要素認証 (MFA)

TOTP形式の認証アプリ対応、バックアップコード、メールバックアップ機能

セッション管理

複数デバイスのセッション管理、リモートログアウト、アクセストークンのリフレッシュ

​
クイックスタート

​
認証フロー

  1. ユーザー登録: POST /auth/register
  2. ログイン: POST /auth/login
  3. プロフィール取得: GET /auth/profile (Bearer Token)

​
SNS認証フロー

  1. 認証URL取得: POST /auth/state
  2. 外部プロバイダーで認証: リダイレクト
  3. コールバック処理: GET /auth/callback/:provider
  4. トークン検証: POST /auth/verify

​
OAuth 2.0フロー

  1. クライアント作成: POST /oauth/client
  2. 認可リクエスト: GET /oauth/authorize
  3. トークン取得: POST /oauth/token
  4. ユーザー情報取得: GET /oauth/userinfo

​
API エンドポイント

左側のサイドバーから各コントローラーのエンドポイントにアクセスできます。
  • App: ヘルスチェックとバージョン情報
  • Auth: 認証・ログイン・SNS連携
  • MFA: 多要素認証の設定と検証
  • Users: ユーザー情報の取得
  • Account: アカウント管理とパスワード変更
  • OAuth: OAuth 2.0認可サーバー
  • Sessions: セッション管理
  • Role: ロール・権限管理
  • Dify: AIチャット統合
  • Markdown: マークダウンユーティリティ
  • Well-Known: OpenID Connect Discovery

​
認証方式

​
Bearer Token (JWT)

ほとんどのエンドポイントはJWT認証が必要です。 
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

​
Cookie認証

一部のエンドポイントではクッキーベースの認証も使用されます。 
Cookie: accessToken=...; refreshToken=...

​
エラーハンドリング

APIはHTTPステータスコードと構造化されたエラーレスポンスを返します。 
{
  "error": "INVALID_CREDENTIALS",
  "message": "Invalid email or password",
  "statusCode": 401
}

​
サポート

技術的な質問や問題がある場合は、以下にお問い合わせください: