コンテンツにスキップ

認証

Backlog CLI は API キーと OAuth 2.0 の2つの認証方式をサポートしています。

最もシンプルな認証方式です。Backlog の個人設定から API キーを発行して使用します。

Terminal window
backlog auth login --method api-key

パイプで API キーを渡すこともできます。

Terminal window
echo "YOUR_API_KEY" | backlog auth login --with-token

OAuth 2.0 による認証も利用可能です。

Terminal window
backlog auth login --method oauth

OAuth トークンの有効期限が切れた場合はリフレッシュできます。

Terminal window
backlog auth refresh
Terminal window
backlog auth status

特定のスペースの認証状態を確認する場合は、次のコマンドを実行します。

Terminal window
backlog auth status --hostname your-space.backlog.com

トークンを表示する場合は、次のコマンドを実行します。

Terminal window
backlog auth status --show-token

複数の Backlog スペースに認証できます。

Terminal window
# スペース A に認証
backlog auth login --hostname space-a.backlog.com
# スペース B に認証
backlog auth login --hostname space-b.backlog.com

デフォルトスペースの切り替え

Section titled “デフォルトスペースの切り替え”
Terminal window
backlog auth switch --hostname space-b.backlog.com

コマンド実行時のスペース指定

Section titled “コマンド実行時のスペース指定”

--space グローバルフラグで一時的にスペースを切り替えられます。

Terminal window
backlog issue list --project PROJ --space space-b.backlog.com
  1. --space フラグ / BACKLOG_SPACE 環境変数 / 設定ファイルの defaultSpace + 設定ファイルの認証情報
  2. BACKLOG_API_KEY + BACKLOG_SPACE 環境変数(フォールバック)

環境変数による認証(CI/AI ワークフロー向け)

Section titled “環境変数による認証(CI/AI ワークフロー向け)”

backlog auth login を実行できない非インタラクティブ環境(CI パイプライン、AI エージェント等)では、環境変数のみで認証できます。

Terminal window
export BACKLOG_SPACE=your-space.backlog.com
export BACKLOG_API_KEY=your-api-key
# backlog auth login なしで利用可能
backlog issue list --project YOUR_PROJECT

BACKLOG_API_KEY は設定ファイルの認証情報より優先度が低いため、~/.backlogrc にスペースが設定されている場合はそちらが使われます。

認証情報は ~/.backlogrc ファイルに保存されます。

Terminal window
# デフォルトスペースからログアウト
backlog auth logout
# 特定のスペースからログアウト
backlog auth logout --hostname your-space.backlog.com