TeamCity RESTAPI リファレンス 2026.1 ヘルプ

二要素認証の管理

この記事では、TeamCity REST API を介した二要素認証機能の制御に関する一般的なユースケースについて説明します。これらのエンドポイントは、アクセストークンによる認証のみを受け入れることに注意してください。

2FA のセットアップ

現在のユーザーの 2FA のセットアップを開始するには、次のエンドポイントを使用します。

/app/rest/2FA/setup

このメソッドは、セットアップの確認のために、秘密鍵、回復キーのセット、UUID を返します。

2FA 設定の確認

現在のユーザーの 2FA の設定を確認するには、次のエンドポイントを使用します。

/app/rest/2FA/confirm?uuid=<uuid>&password=<password>

ここで、uuid/setup メソッドによって返される UUID であり、password は 6 桁の TOTP パスワードです。提供されたパスワードが UUID によって検出された秘密鍵と一致する場合、2FA セットアップは終了します。

ユーザーの 2FA を無効にする

特定のユーザーの秘密鍵と回復鍵を削除するには、次を使用します。

/app/rest/2FA/<userLocator>/disable

ここで、userLocatorUserLocator と入力されます。例: john.doe ユーザー名の 2FA を無効にするには、次を送信します。

/app/rest/2FA/username:john.doe/disable

ユーザーが TeamCity にアクセスできなくなるのを防ぐために、2FA を無効にすると、デフォルトの 1 週間の猶予期間のリフレッシュもトリガーされます。

回復キーを生成する

現在のユーザーの新しい回復キーのセットを生成するには、次を使用します。

/app/rest/2FA/newRecoveryKeys

回復キーの形式は [0-9a-f]{6}-[0-9a-f]{6} です。古い回復キーは破棄されます。

ユーザーのリフレッシュ猶予期間

猶予期間により、2FA を設定していないユーザーは TeamCity を引き続き使用できます。この期間は teamcity.auth.2fa.grace.period プロパティによって異なり、デフォルト値は 1 週間です。

この期間は、ユーザーに対して 2FA を明示的に無効にすると自動的にリフレッシュされます。特定のユーザーの猶予期間を手動でリフレッシュするには、次のエンドポイントを使用します。

/app/rest/2FA/<userLocator>/refreshGracePeriod