現在、GitHub AE は限定的リリースです。

GitHub への認証方法について

この記事の内容

認証先に応じて異なる認証情報を使用し、GitHub AE への認証を行うことで、アカウントのリソースに安全にアクセスできます。

GitHub

の認証について

アカウントを安全に保つには、GitHub AE のリソースにアクセスする前に認証する必要があります。 GitHub AE への認証を行うときは、自分が確かに本人であることを証明するために、固有の認証情報を提供または確認します。

GitHub AE のリソースには、ブラウザ内、GitHub Desktop または別のデスクトップアプリケーション経由、API 経由、またはコマンドライン経由など、さまざまな方法でアクセスできます。 GitHub AE へのアクセス方法は、それぞれ異なる認証モードをサポートしています。

  • ID プロバイダー (IdP)
  • Personal access token
  • SSH キー

ブラウザで認証する

GitHub AE への認証は、IdP を使ってブラウザー内で行うことができます。 詳しくは、「SAMLのシングルサインオンでの認証について」を参照してください。

GitHub Desktop で認証する

お使いのブラウザを使用して GitHub Desktop で認証できます。 詳しくは、「GitHub Desktop での GitHub への認証」を参照してください。

API で認証する

さまざまな方法で API を使用して認証できます。 詳しくは、「REST API に対する認証」を参照してください。

personal access token で API に認証を行う

個人用に GitHub REST API を使用する場合は、personal access token を作成できます。personal access token の作成について詳しくは、「個人用アクセス トークンを管理する」を参照してください。

アプリを使用した API への認証

Organization または他のユーザーの代わりに API を使用する場合、GitHub では、GitHub App の使用が推奨されます。 詳しくは、「GitHub アプリでの認証について」を参照してください。

また、OAuth app を使用して OAuth トークンを作成し、REST API にアクセスすることもできます。 しかし、GitHub では、代わりに GitHub App を使用することが推奨されます。 GitHub Apps を使うと、アプリのアクセスとアクセス許可をより詳細に制御できます。

GitHub Actions ワークフローにおける API への認証

GitHub Actions ワークフローで API を使用する場合、GitHub では、トークンを作成するのではなく、組み込み GITHUB_TOKEN で認証することが推奨されます。 permissions キーを使用して、GITHUB_TOKEN へのアクセス許可を付与できます。

GITHUB_TOKEN は、ワークフローを含むリポジトリ内のリソースにのみアクセスできることに注意してください。 ワークフロー リポジトリの外部にあるリソースを変更する必要がある場合は、personal access token または GitHub App を使う必要があります。

詳しくは、「自動トークン認証」を参照してください。

コマンドラインで認証する

コマンドラインから GitHub AE のリポジトリにアクセスするには、HTTPS と SSH の 2 つの方法がありますが、それぞれ認証方法が異なります。 認証方法は、リポジトリのクローンを作成するときに HTTPS または SSH リモート URL を選択したかどうかに基づいて決まります。 アクセス方法について詳しくは、「リモートリポジトリについて」をご覧ください。

HTTPS

ファイアウォールまたはプロキシの内側からでも、HTTPS を介して GitHub AE 上のすべてのリポジトリを操作できます。

GitHub CLI で認証する場合は、personal access token または Web ブラウザーを使って認証できます。 GitHub CLI を使用した認証の詳細については、「gh auth login」を参照してください。

GitHub CLI なしで認証する場合は、personal access token で認証する必要があります。 Git からパスワードの入力するダイアログが表示されたら、personal access token を入力します。 または、Git Credential Manager などの資格情報ヘルパーを使用することもできます。詳細については、「個人用アクセス トークンを管理する」を参照してください。 Git を使って GitHub AE で認証するたびに、資格情報ヘルパーでキャッシュしない限り、GitHub AE で認証するための資格情報を入力するように求められます。

SSH

SSH 接続はファイアウォールとプロキシから許可されない場合がありますが、SSH 経由で GitHub AE 上のすべてのリポジトリを操作できます。

GitHub CLI で認証すると、CLI によってマシン上で SSH 公開キーが検索され、アップロード用のものを選ぶようにダイアログが表示されます。 GitHub CLI でアップロード用の SSH 公開キーが見つからない場合は、新しい SSH 公開/秘密キーペアを生成し、GitHub AE 上のアカウントに公開キーをアップロードできます。 これで、personal access token を使うか、Web ブラウザー経由で認証できるようになります。 GitHub CLI を使用した認証の詳細については、「gh auth login」を参照してください。

GitHub CLI なしで認証する場合は、ローカル コンピューターで SSH 公開/秘密キーペアを生成し、GitHub AE のアカウントに公開キーを追加する必要があります。 詳しくは、「新しい SSH キーを生成して ssh-agent に追加する」を参照してください。 Git を使って GitHub AE で認証するたびに、キーを保存していない限り、SSH キー パスフレーズを入力するように求められます。

GitHub のトークンフォーマット

GitHub は、トークンの種別を示すプレフィックスで始まるトークンを発行します。

トークンの種類Prefix詳細情報
Personal access tokenghp_「個人用アクセス トークンを管理する」
OAuth アクセス トークンgho_「OAuth アプリの承認」
GitHub App のユーザー アクセス トークンghu_ユーザーに代わって GitHub アプリで認証する
GitHub App インストール アクセス トークンghs_「GitHub App インストールとしての認証」
GitHub App のトークンのリフレッシュghr_ユーザー アクセス トークンを更新する