API キー

TeamDay で CLI と API アクセスの認証を管理する方法を学びます。

目次

認証方法

TeamDay は 2 つの認証方法をサポートしています:

メソッドユースケース有効期限最適な用途
OAuth 2.1CLI インタラクティブ使用15 分 (アクセストークン)
90 日 (リフレッシュトークン)
ヒューマンユーザー、開発
Personal Access Token (PAT)API オートメーション手動取り消しのみCI/CD、スクリプト、オートメーション

OAuth と PAT の比較

OAuth を使用する場合:

  • CLI でインタラクティブに作業
  • ヒューマンユーザーの場合
  • 自動トークン更新が必要
  • 短期間のアクセスを希望

PAT を使用する場合:

  • スクリプトまたは CI/CD でオートメーション
  • バックグラウンドジョブの実行
  • 長期アクセスが必要
  • シンプルなベアラートークン認証が必要

Personal Access Tokens

Personal Access Tokens (PAT) はプログラムによるアクセス用の長期認証情報です。

PAT を作成

UI 経由:

ステップ 1: 設定に移動

プロフィールアイコン → 設定

ステップ 2: API キーに移動

左サイドバーで「API キー」をクリック

ステップ 3: 「トークンを作成」をクリック

「+ 新しい Personal Access Token」ボタンをクリック

ステップ 4: トークンを設定

  • 名前 (必須)
    • このトークンのわかりやすい名前
    • 例: "CI/CD Pipeline"、"Automation Scripts"、"Production Bot"
  • 有効期限 (オプション)
    • デフォルト: 有効期限なし
    • オプション: 30 日、90 日、1 年、カスタム、なし
    • 推奨: セキュリティのために有効期限を設定
  • スコープ (近日公開)
    • 現在: 完全なアクセス
    • 将来: 細かい権限 (agents:read、tasks:write など)

ステップ 5: トークンをコピー

⚠️ 重要: トークンは 1 回だけ表示されます!

詳細については、Personal Access Tokens ガイド を参照してください。