Overview

Auth (認証)

+
認証 API

認証 API リファレンス

TaskWorks API の認証関連エンドポイントの詳細ドキュメントです。

# 認証 API リファレンス

TaskWorks API の認証関連エンドポイントの詳細ドキュメントです。すべてのエンドポイントはユーザー固有のデータのみを返します(RLS保護)。

## 認証方式

### ApiKey 認証(推奨)
```
Authorization: ApiKey <token>
```
- 設定 > APIキー管理 から生成
- トークンは一度しか表示されないため安全に保管
- ほとんどのエンドポイントで使用可能

### Bearer トークン認証
```
Authorization: Bearer <token>
```
- サービス間通信で使用
- 一部のエンドポイントで必須(例: /api/v1/blocks/windows)

### Cookie 認証
- 標準のセッションベース認証
- Webクライアントで使用
- Cookie専用エンドポイントで必須

## 共通レスポンス形式

すべての成功レスポンスは以下の構造に従います:
```json
{
  "data": <response_data>,
  "error": null
}
```

すべてのエラーレスポンスは以下の構造に従います:
```json
{
  "error": "<error_type>",
  "message": "<human_readable_message>",
  "code": "<optional_error_code>",
  "context": <optional_additional_context>
}
```

## HTTP ステータスコード

- 200: 成功
- 201: 作成完了
- 400: 不正なリクエスト(検証エラー)
- 401: 未認証(認証が必要)
- 403: 禁止(権限なし)
- 404: 未検出
- 409: 衝突(リソースの競合)
- 500: サーバー内部エラー

## ページネーション

一部のエンドポイントはカーソルベースのページネーションをサポート:
- cursor: 次ページの開始位置
- limit: 返す項目数(1-100、デフォルトはエンドポイントにより異なる)

レスポンス形式:
```json
{
  "data": {
    "items": [...],
    "nextCursor": "string | null",
    "hasMore": boolean
  },
  "error": null
}
```

## API エンドポイント

### 認証(Auth)

#### GET /api/v1/auth/me

現在認証されているユーザー情報を取得します。

**認証:** ApiKey / Bearer / Cookie

**レスポンス スキーマ:**
```json
{
  "data": {
    "id": "string",
    "userId": "string",
    "email": "string",
    "name": "string"
  },
  "error": null
}
```

**レスポンス例:**
```json
{
  "data": {
    "id": "user_123",
    "userId": "user_123",
    "email": "user@example.com",
    "name": "John Doe"
  },
  "error": null
}
```

**エラーケース:**
- 401: 認証が必要です

---

#### GET /api/v1/auth/api-keys

ユーザーのAPIキー一覧を取得します。

**認証:** Cookie のみ

**レスポンス スキーマ:**
```json
{
  "data": [
    {
      "id": "string",
      "name": "string | null",
      "scope": "string",
      "revoked": boolean,
      "expiresAt": "string | null",
      "lastUsedAt": "string | null",
      "createdAt": "string"
    }
  ],
  "error": null
}
```

---

#### POST /api/v1/auth/api-keys

新しいAPIキーを作成します。

**認証:** Cookie のみ

**リクエストボディ:**
```json
{
  "name": "string | null",
  "scope": "string",
  "expiresAt": "string | null"
}
```

**レスポンス スキーマ:**
```json
{
  "data": {
    "id": "string",
    "key": "string",
    "name": "string | null",
    "scope": "string",
    "expiresAt": "string | null",
    "createdAt": "string"
  },
  "error": null
}
```

---

#### DELETE /api/v1/auth/api-keys

APIキーを失効させます。

**認証:** Cookie のみ

**クエリパラメータ:**
- id: string(必須)- 失効させるAPIキーID

---

#### POST /api/v1/auth/api-keys/verify

APIキーの有効性を検証します。

**認証:** Cookie のみ

**リクエストボディ:**
```json
{
  "key": "string"
}
```

**レスポンス スキーマ:**
```json
{
  "data": {
    "valid": boolean,
    "userId": "string | null"
  },
  "error": null
}
```