更新可能なアクセストークンを管理する
TeamCity には、VCS ホスティングプロバイダーへのアクセスが機能上必要なエンティティが複数あります: VCS ルート、 コミットステータスパブリッシャー、 プルリクエスト機能などです。 これらのエンティティは通常、複数の VCS 認証オプションを提供します。
通常のユーザー名 / ログイン資格情報 — この認証方法は最も脆弱であるため、主要な VCS ホスティングプロバイダーによって徐々に廃止されています。
個人アクセストークン (PAT) - VCS プロバイダー側で発行され、その後 TeamCity オブジェクトにコピーされます。 これらのトークンは、発行ユーザーと同じかそれより少ない権限を付与します。
リフレッシュ可能なトークン - 個人用または非個人用のトークン。 このトークンを取得するために、TeamCity は既存の OAuth (または OAuth に似た) 接続を使用して VCS プロバイダーと通信します。
このトピックでは、リフレッシュ可能なトークンを発行、割り当て、管理する方法について説明します。
サポートされる接続
トークンを発行するには、TeamCity はプロジェクトの 接続設定で構成された接続を使用して、VCS ホスティングプロバイダーと通信します。 現在、リフレッシュ可能なアクセストークンは次の接続でサポートされています。
トークン管理
VCS 認証トークン ページでは、このプロジェクトとそのサブプロジェクトに対して発行されたすべてのリフレッシュ可能なトークンに一元的にアクセスできます。 このページを開くには:
個々のプロジェクトまたは ルート プロジェクトに移動します。
プロジェクト設定を開き、 VCS 認証トークン設定タブに移動します。
このページでは、トークンの名前、関連する接続、トークンを発行したユーザー別にトークンを見つけることができます。 フィルターを適用しない場合、このページには最近使用された 10 個のトークンが表示されます。
継承されたトークンを表示 チェックボックスを使用すると、親プロジェクトで発行されたが、現在表示されているプロジェクトで使用可能なトークンを表示できます。
新しいトークンを発行するには、 新しいトークンを生成する をクリックします。 ポップアップ表示されるダイアログで、トークンのお名前と TeamCity 接続を指定します。 さらに、トークンのスコープを特定の TeamCity プロジェクトと (GitHub アプリトークンの場合) VCS リポジトリに制限できます。
プロジェクトスコープ
生成されたトークンは、現在編集中のプロジェクトとそのすべてのサブプロジェクトでデフォルトで使用できます。 つまり、ルートプロジェクトの VCS 認証トークン ページからトークンを作成すると、このトークンはデフォルトでサーバー上のどのプロジェクトでも使用できます。 トークンが最初に構成されたプロジェクトは、 プロジェクトスコープ で表示できます。
VCS 認証トークン ページには、各プロジェクトで使用可能なトークンのみが表示されることに注意してください。 プロジェクト A 用に新しいトークンを作成し、そのスコープをサブプロジェクト A.2 と A.3 に制限すると、TeamCity は、現在のプロジェクトがこのトークンにアクセスできず、ダイアログを閉じた後にこのトークンを表示できないことを通知します。
リポジトリスコープ
GitHub アプリの接続は、リポジトリごとのきめ細かいトークン権限をサポートしています。 この接続を使用してリフレッシュ可能なトークンを作成する場合、このトークンがアクセスできるリポジトリを指定する必要があります。 ユーザー名 / 組織名なしでリポジトリ名を入力します (myUser/myRepo ではなく myRepo)。 リポジトリは、対応する GitHub アプリがインストールされているのと同じアカウントでホストされている必要があることに注意してください。
セキュリティ上の理由から、グローバルリポジトリアクセス権限を持つトークンを発行することはできません。
更新可能なトークンを作成して割り当てる方法
VCS プロバイダーへのアクセスを必要とするオブジェクトごとに、リフレッシュ可能なトークンを手動で設定する必要はありません。 たとえば、既存の接続から新しいプロジェクトまたは構成を作成すると (新規プロジェクト/構成ページで <接続のお名前> から タイルをクリックして)、TeamCity は自動的にトークンを生成し、関連する VCS ルートに渡します。
同様に、 コミットステータスパブリッシャー などのビルド機能を設定する場合は、新しいトークンを発行する代わりに、デフォルトの VCS ルート認証方法を採用することを選択できます。
トークンを手動で割り当てるには、ビルド機能またはルートの認証設定に移動します。 ここで、新しいトークンを生成するか、既存のトークンを使用できます。
新しいトークンを生成する
新規生成ボタンをクリックします。 VCS 認証トークンページと同様に、このボタンはプロジェクト管理者のみが使用できます。
トークンのお名前を入力し、VCS プロバイダーとの通信に使用する TeamCity 接続を選択します。 プロジェクトスコープは、このプロジェクトとそのサブプロジェクトに自動的に制限されます。
セットアップを終了するには、 保存をクリックします。
既存のトークンを選択
鉛筆アイコンをクリックして、 トークンテキストボックスを有効化します。 VCS 認証トークンページと同様に、このボタンはプロジェクト管理者のみが使用できます。
git トークンリストリンクをクリックして、 VCS 認証トークンページを新しいタブで開きます。
VCS 認証トークンページで、使用するトークンを見つけ、 ID をコピーボタンをクリックします。
編集したオブジェクトに戻り、トークン ID を貼り付けます。
セットアップを終了するには、 保存をクリックします。
InstallationToken エンドポイント経由で GitHub 認証トークンを発行する
TeamCity GitHub アプリ 接続は、TeamCity が GitHub リポジトリにアクセスできる認証トークンを発行できます。 これは通常、UI でプロジェクトを作成するか、 VCS 認証トークンページで手動でトークンを発行すると自動的に行われます。
<TeamCity_サーバー_URL/アプリ/oauth/githubapp/installationToken エンドポイントは、UI を使用せずにこれらのトークンを生成する別の方法を提供します。 特に、 REST API 経由でビルド構成と VCS ルートを構成する場合に便利です。これにより、それらのルートに必要なトークン ID をプログラムで取得できます。
詳細については、こちらの記事を参照してください: InstallationToken エンドポイント: GitHub 認証トークンをプログラムで発行する方法。