認証 - GitHub Enterprise Cloud Docs

認証方法

Method	ユースケース(事例)	Copilot サブスクリプションが必要です
GitHubサインインユーザー	ユーザーがGitHubを使用してサインインする対話型アプリ	はい
GitHub OAuth アプリ	OAuth を介してユーザーに代わって動作するアプリ	はい
環境変数	CI/CD, 自動化, サーバー間	はい
サーバー間認証	組織に起因する自動化と直接組織の課金	ユーザーサブスクリプションなし。組織ポリシーが必要
BYOK (独自のキーを持ち込む)	独自の API キーの使用 (Microsoft Foundry、OpenAI など)	いいえ

GitHub サインインユーザー

これは、Copilot CLI を対話形式で実行するときの既定の認証方法です。ユーザーは OAuth デバイスフロー GitHub使用して認証を行い、SDK は保存された資格情報を使用します。

しくみ:

ユーザーは copilot CLI を実行し、GitHub OAuth 経由でサインインします
資格情報はシステムキーチェーンに安全に格納されます
SDK では、保存されている資格情報が自動的に使用されます

SDK の構成:

コード言語 navigation

.NET

using GitHub.Copilot;

// Default: uses logged-in user credentials
await using CopilotClient client = new();

import copilot "github.com/github/copilot-sdk/go"

// Default: uses logged-in user credentials
client := copilot.NewClient(nil)

Java

import com.github.copilot.CopilotClient;

// Default: uses logged-in user credentials
var client = new CopilotClient();
client.start().get();

Python

from copilot import CopilotClient

# Default: uses logged-in user credentials
client = CopilotClient()
await client.start()

Rust

use github_copilot_sdk::{Client, ClientOptions};

// Default: uses logged-in user credentials
let client = Client::start(ClientOptions::default()).await?;

TypeScript

import { CopilotClient } from "@github/copilot-sdk";

// Default: uses logged-in user credentials
const client = new CopilotClient();

使用するタイミング:

ユーザーが直接対話するデスクトップアプリケーション
開発環境とテスト環境
ユーザーが対話形式でサインインできるシナリオ

GitHub OAuth アプリ

OAuth GitHub アプリを使用して、アプリケーションを通じてユーザーを認証し、その資格情報を SDK に渡します。これにより、アプリケーションは、アプリを承認するユーザーに代わって、Copilot API 要求を行うことができます。

しくみ:

ユーザーが OAuth GitHub アプリを承認する
アプリがユーザーアクセストークン (gho_ または ghu_ プレフィックス) を受け取る
クライアント構成を使用してトークンを SDK に渡す

SDK の構成:

コード言語 navigation

.NET

using GitHub.Copilot;

await using var client = new CopilotClient(new CopilotClientOptions
{
    GitHubToken = userAccessToken,     // Token from OAuth flow
    UseLoggedInUser = false,           // Don't use stored CLI credentials
});

import copilot "github.com/github/copilot-sdk/go"

client := copilot.NewClient(&copilot.ClientOptions{
    GitHubToken:       userAccessToken,      // Token from OAuth flow
    UseLoggedInUser:   copilot.Bool(false),  // Don't use stored CLI credentials
})

Java

import com.github.copilot.CopilotClient;
import com.github.copilot.rpc.*;

var client = new CopilotClient(new CopilotClientOptions()
    .setGitHubToken(userAccessToken)  // Token from OAuth flow
    .setUseLoggedInUser(false)        // Don't use stored CLI credentials
);
client.start().get();

Python

from copilot import CopilotClient

client = CopilotClient({
    "github_token": user_access_token,  # Token from OAuth flow
    "use_logged_in_user": False,        # Don't use stored CLI credentials
})
await client.start()

Rust

use github_copilot_sdk::{Client, ClientOptions};

let client = Client::start(
    ClientOptions::default()
        .with_github_token(user_access_token)
        .with_use_logged_in_user(false),
).await?;

TypeScript

import { CopilotClient } from "@github/copilot-sdk";

const client = new CopilotClient({
    gitHubToken: userAccessToken,  // Token from OAuth flow
    useLoggedInUser: false,        // Don't use stored CLI credentials
});

サポートされているトークンの種類:

gho_ - OAuth ユーザーアクセストークン
ghu_ - GitHub App のユーザーアクセストークン
github_pat_ - きめ細かい個人用アクセストークン

サポート対象外:

ghp_ - 従来の個人用アクセストークン (非推奨)

使用するタイミング:

ユーザーが GitHub 経由でサインインする Web アプリケーション
Copilot上に構築された SaaS アプリケーション
異なるユーザーに代わって要求を行う必要があるマルチユーザーアプリケーション

詳細については、「GitHub OAuth のセットアップ」を参照してください。

セッションスコープのGitHub トークンのローテーション

マルチユーザーサービスと統合の場合は、有効期間の長いトークンを 1 つ格納するのではなく、各セッションにトークンプロバイダーを設定します。ランタイムは、有効なGitHub ホストのプロバイダーを呼び出し、要求をinitialまたはrefreshとして識別します。セッション ID は、クラウドセッションがまだ ID を受け取っていない場合にのみ存在しません。

タグ付けされたトークンの結果または明示的なキャンセルを返します。すべてのトークンの結果には、コールバックが完了したときの残りの正の秒数という expiresInが含まれている必要があります。運用GitHubトークンは通常 8 時間続くので、8 * 60 * 60は一般的な値です。静的セッションごとのトークンとプロバイダーの両方を設定しないでください。

コード言語 navigation

TypeScript

const session = await client.createSession({
    gitHubTokenProvider: async ({ host, sessionId, reason }) => {
        const token = await acquireGitHubToken({ host, sessionId, reason });
        return {
            kind: "token",
            accessToken: token.value,
            expiresIn: token.secondsRemaining,
        };
    },
});

Python

async def provide_github_token(args):
    token = await acquire_github_token(
        host=args["host"],
        session_id=args["session_id"],
        reason=args["reason"],
    )
    return {
        "kind": "token",
        "accessToken": token.value,
        "expiresIn": token.seconds_remaining,
    }

session = await client.create_session(github_token_provider=provide_github_token)

session, err := client.CreateSession(ctx, &copilot.SessionConfig{
    GitHubTokenProvider: func(args copilot.GitHubTokenProviderArgs) (*copilot.GitHubTokenProviderResult, error) {
        token, secondsRemaining, err := acquireGitHubToken(args.Host, args.SessionID, args.Reason)
        if err != nil {
            return nil, err
        }
        return copilot.GitHubTokenResult(&copilot.GitHubToken{
            AccessToken: token,
            ExpiresIn:   secondsRemaining,
        }), nil
    },
})

.NET

await using var session = await client.CreateSessionAsync(new SessionConfig
{
    GitHubTokenProvider = async args =>
    {
        var token = await AcquireGitHubTokenAsync(args.Host, args.SessionId, args.Reason);
        return GitHubTokenProviderResult.FromToken(new GitHubToken
        {
            AccessToken = token.Value,
            ExpiresIn = token.SecondsRemaining,
        });
    },
});

Java

var session = client.createSession(new SessionConfig()
    .setGitHubTokenProvider(args ->
        acquireGitHubToken(args.host(), args.sessionId(), args.reason())
            .thenApply(token -> GitHubTokenProviderResult.token(
                token.value(), token.secondsRemaining())))
    .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
).get();

Rust

let provider = Arc::new(|args: GitHubTokenProviderArgs| async move {
    let token = acquire_github_token(&args.host, args.session_id.as_ref(), args.reason).await?;
    Ok(GitHubTokenProviderResult::Token(GitHubToken::new(
        token.value,
        token.seconds_remaining,
    )))
});

let session = client
    .create_session(SessionConfig::default().with_github_token_provider(provider))
    .await?;

ランタイムは、セッションの作成または再開の一環として、 initial の取得を実行します。取り消された取得、プロバイダーエラー、無効な応答、または安定したアカウント ID を持たないトークンは、作成操作または再開操作を拒否します。ランタイムはアンビエント認証にフォールバックしません。

セッションが確立されると、ランタイムは資格情報を使用する各操作の前に非同期プレフライトを実行します。現在のトークンの残りが 1 時間以下の場合は、 refresh を要求します。アイドル状態のセッションは、次に認証情報を必要とする操作が実行されるまで更新されません。ランタイムでは、このコールバックにバックグラウンドタイマー、拒否ドリブン再生、401/403 チャレンジ伝達、アップスコープは使用されません。

環境変数

自動化、CI/CD パイプライン、およびサーバー間のシナリオでは、環境変数を使用して認証できます。

ユーザーの個人用アクセストークンを使用しない組織属性の自動化については、サーバー間認証を参照してください。

サポートされている環境変数 (優先度順):

COPILOT_GITHUB_TOKEN - Copilot を明示的に使用する場合に推奨
GH_TOKEN - GitHub CLI互換
GITHUB_TOKEN - GitHub Actions に対応

しくみ:

サポートされている環境変数の 1 つを有効なトークンで設定する
SDK はトークンを自動的に検出して使用します

SDK の構成:

コードの変更は必要ありません。SDK は環境変数を自動的に検出します。

コード言語 navigation

.NET

using GitHub.Copilot;

// Token is read from environment variable automatically
await using CopilotClient client = new();

import copilot "github.com/github/copilot-sdk/go"

// Token is read from environment variable automatically
client := copilot.NewClient(nil)

Java

import com.github.copilot.CopilotClient;

// Token is read from environment variable automatically
var client = new CopilotClient();
client.start().get();

Python

from copilot import CopilotClient

# Token is read from environment variable automatically
client = CopilotClient()
await client.start()

Rust

use github_copilot_sdk::{Client, ClientOptions};

// Token is read from environment variable automatically
let client = Client::start(ClientOptions::default()).await?;

TypeScript

import { CopilotClient } from "@github/copilot-sdk";

// Token is read from environment variable automatically
const client = new CopilotClient();

使用するタイミング:

CI/CD パイプライン (GitHub Actions、Jenkins など)
自動テスト
サービスアカウントを持つサーバー側アプリケーション
対話型ログインを使用しない場合の開発

BYOK (独自のキーを持ち込む)

BYOK を使用すると、Microsoft Foundry、OpenAI、Anthropicなどのモデルプロバイダーから独自の API キーを使用できます。これにより、GitHub Copilot認証が完全にバイパスされます。

主な利点:

GitHub Copilot サブスクリプションは必要ありません
エンタープライズモデルのデプロイを使用する
モデルプロバイダーへの直接請求
Microsoft Foundry、OpenAI、Anthropic、および OpenAI 互換エンドポイントのサポート

次のような詳細については、 BYOK (独自のキーを持ち込む) を参照してください。

Microsoft Foundry のセットアップ
プロバイダー構成オプション
制限事項と考慮事項
完全なコード例

認証の優先順位

複数の認証方法を使用できる場合、SDK では次の優先順位で使用されます。

明示的な gitHubToken - SDK クライアントまたはセッション構成に直接渡されるトークン
ダイレクト API トークン - GITHUB_COPILOT_API_TOKEN with COPILOT_API_URL
環境変数トークン - COPILOT_GITHUB_TOKEN → GH_TOKEN → GITHUB_TOKEN
保存された OAuth 資格情報 - 以前の copilot CLI ログインから
GitHub CLI - gh auth 資格情報

マルチユーザーサーバーモードの場合は、セッションごとに gitHubToken を渡して、各セッションが正しいGitHub ID で実行されるようにします。マルチテナントとサーバーの展開を参照してください。

SDK が保存された認証情報または gh CLI 認証を自動的に使用しないようにするには、ログイン済みユーザーへのフォールバックを無効にするように構成します。

コード言語 navigation

.NET

await using var client = new CopilotClient(new CopilotClientOptions
{
    UseLoggedInUser = false,  // Only use explicit tokens
});

client := copilot.NewClient(&copilot.ClientOptions{
    UseLoggedInUser: copilot.Bool(false),  // Only use explicit tokens
})

Java

import com.github.copilot.CopilotClient;
import com.github.copilot.rpc.*;

var client = new CopilotClient(new CopilotClientOptions()
    .setUseLoggedInUser(false)  // Only use explicit tokens
);
client.start().get();

Python

client = CopilotClient({
    "use_logged_in_user": False,  # Only use explicit tokens
})

Rust

use github_copilot_sdk::{Client, ClientOptions};

let client = Client::start(
    ClientOptions::default().with_use_logged_in_user(false),
).await?;

TypeScript

const client = new CopilotClient({
    useLoggedInUser: false,  // Only use explicit tokens
});

次のステップ

BYOK (独自のキーを持ち込む) - 独自の API キーを使用する方法について説明します
Build your first Copilot-powered app - 初めてのCopilot搭載アプリを構築する
GitHub Copilot SDK での MCP サーバーの使用 - 外部ツールに接続する

認証

この記事で

認証方法

GitHub サインインユーザー

コード言語 navigation

GitHub OAuth アプリ

コード言語 navigation

セッションスコープのGitHub トークンのローテーション

コード言語 navigation

環境変数

コード言語 navigation

BYOK (独自のキーを持ち込む)

認証の優先順位

コード言語 navigation

次のステップ

このドキュメントは役に立ちましたか?

まだ助けが必要ですか？