はじめに
GitHubの個人アクセストークン(Personal Access Token、以下PAT)は、APIやCLIツールを使ってGitHubのリポジトリにアクセスする際に必要となる重要な認証手段です。この記事では、GitHubで個人アクセストークンを発行する手順と設定方法について説明します。
1. 個人アクセストークンとは
個人アクセストークンは、GitHubアカウントのユーザー名とパスワードの代わりに使用することができる認証トークンです。これにより、API呼び出しや、Gitコマンドの実行時にセキュアにアクセスすることができます。
例えば、VertexAIワークベンチのコード管理やlookerのモデル管理をしたい場合に使用します。
2. 個人アクセストークンの用途
個人アクセストークンは、以下のような用途に使用されます:
- GitHub APIの認証
- Gitコマンドでリポジトリにアクセスするため
- CI/CDパイプラインでの自動化ツールによる認証
- その他のツールやサービスがGitHubリポジトリにアクセスする際の認証
3. 個人アクセストークンを発行する手順
-
GitHubにログイン:GitHubのアカウントにログインします。
-
設定ページに移動:右上のプロフィールアイコンをクリックし、
Settings
を選択します。 -
Personal access tokens:
Personal access tokens
をクリックし、Tokens (classic)
を選択します。
-
トークンの設定:トークンに名前を付け、有効期限とスコープを設定します(以下で詳細説明)。
4. トークンの設定項目
有効期限(Expiration)
トークンの有効期限を設定します。デフォルトは30日間です。有効期限が過ぎるとトークンは無効になります。例えば、「The token will expire on Sat, Jul 20 2024」と表示される場合、その日付にトークンが無効になります。
スコープ(Scopes)
スコープは、トークンがアクセスできるリソースと操作の範囲を定義します。以下に主要なスコープとその説明を示します:
- repo:プライベートリポジトリへの完全なアクセス
- repo:status:コミットステータスへのアクセス
- public_repo:パブリックリポジトリへのアクセス
- repo:invite:リポジトリ招待へのアクセス
- workflow:GitHub Actionsのワークフローの更新
- write:packages:パッケージのアップロード
- read:packages:パッケージのダウンロード
- delete:packages:パッケージの削除
- admin:org:組織とチームの完全な管理
- write:org:組織とチームメンバーシップの読み書き
- read:org:組織とチームメンバーシップの読み取り
- gist:Gistの作成
- notifications:通知へのアクセス
- user:ユーザーデータの更新
- read:user:ユーザープロファイルデータの読み取り
- delete_repo:リポジトリの削除
適切なスコープを選択し、トークンの使用目的に応じたアクセス権限を設定します。
5. トークンの管理とセキュリティ
- 安全な保管:トークンはパスワードと同様に安全に保管します。第三者に漏れないように注意しましょう。
- 必要最小限の権限:必要最低限のスコープだけを付与することでセキュリティリスクを軽減します。
- 定期的な更新:定期的にトークンを更新し、不要なトークンは削除します。
6. まとめ
GitHubの個人アクセストークンは、リポジトリへのセキュアなアクセスを提供する便利なツールです。トークンを発行し、適切なスコープと有効期限を設定することで、効率的かつ安全にGitHubを利用することができます。トークンの管理とセキュリティにも十分注意しましょう。
このガイドが、GitHubで個人アクセストークンを発行する際の参考になれば幸いです。