インストールトークンエンドポイント: GitHub 認証トークンをプログラムで発行する方法

主なプロパティ

エンドポイント

/app/oauth/githubapp/installationToken

リクエストの種類

POST

ヘッダー

• コンテンツタイプ : application/x-www-form-urlencoded

• 受諾 : application/json

• (オプション) X-TC-GitHub-PAT : 個人の GitHub アクセストークン（GitHub ユーザー設定ページで発行されます）を表す US-ASCII 文字列。省略された場合、TeamCity は内部ストレージに保存されている既存のトークンをチェックすることで、ユーザーとその権限を識別しようとします。詳細については、特記事項のセクションを参照してください。

本文

次のキーを持つ x-www-form-urlencoded 文字列:

• projectId — 新しく発行された認証トークンを所有するプロジェクトの内部 ID。

• connectionId — 新しいトークンを発行するために使用される GitHub アプリ接続の内部 ID。デフォルトでは PROJECT_EXT_INT32 形式です。

• repositoryName — 新しく発行されたトークンがアクセスできるリポジトリの名前。ユーザー名は省略してください（「johndoe/my-repo-name」ではなく「my-repo-name」）。`repositoryName=name1&repositoryName=name2&..." という形式で複数のリポジトリをリストできます。

  対応する GitHub アプリをインストールした組織またはユーザーが所有するリポジトリの名前のみを受け入れます。

レスポンス

リクエストが成功すると、次のフィールドを含む JSON ペイロードを含む HTTP 200 "OK" 応答が返されます。

• tokenId — 新しく発行されたトークンの完全な ID。

• permissions — 発行されたトークンのアクセス権限を記述する権限と値のペアのリスト。

• repositories — このトークンを使用してアクセスできるリポジトリ名の配列。

• personalAccessTokenSource — ユーザーの個人アクセストークンが X-TC-GitHub-PAT ヘッダーを介して明示的に提供されたか、TeamCity によって取得されたかに応じて、「USER_PROVIDED」または「TOKEN_STORAGE_LOOKUP」のいずれかを返します。

失敗したリクエストはコード 400「不正なリクエスト」を返します。

以下の cURL サンプルは、「PROJECT_EXT_31」ID を持つ GitHub App 接続を使用して、「sample-java-app-maven」および「HelpLinkGenerator」リポジトリへのアクセス権を持つトークンを発行する方法を示しています。このトークンは、「GitHubMavenJavaApp」ID を持つプロジェクトによって所有されます。

成功した場合、リクエストは次のペイロードを返します。

発行されたトークンは、親プロジェクト設定の VCS 認証トークンタブに表示されます。

特記事項

• POST リクエストを送信するユーザーは、参照先の TeamCity プロジェクトのプロジェクト管理者である必要があります。このプロジェクト（およびその子サブプロジェクト）のみが、新しく発行されたトークンを使用できます。

• 発行されたトークンは、リクエストボディで指定されたリポジトリ名に対してのみアクセス権限を持ちます。任意のユーザー / 組織のリポジトリにアクセスできる無制限のトークンを発行することはできません。

• TeamCity は、インストールトークンの権限を、選択された GitHub リポジトリ全体でユーザーが持つ最低レベルに制限します。そのため、ユーザーは事前に対応する GitHub アプリ接続を介して TeamCity にサインインしている必要があります（ログインするか、「新規プロジェクト」ページでリポジトリを一覧表示するなど）。または、X-TC-GitHub-PAT を使用して、ユーザーの個人アクセストークン（PAT）を明示的に指定することもできます。