認証 - GitHub Copilot SDK for Laravel

認証

Copilot SDKは複数の認証方法をサポートします。用途に合わせて選択してください。

認証方法

方法	主な用途	Copilotサブスクリプション	備考
GitHubログイン（CLI）	開発・手動実行	必要	`copilot` CLIのログイン情報を利用
OAuth GitHub App / PAT	ユーザーごとのトークン	必要	`github_token`で指定
環境変数	CI/CD・サーバー運用	必要	`COPILOT_GITHUB_TOKEN` など
BYOK（Bring Your Own Key）	自前のモデルプロバイダー	不要	カスタムプロバイダー設定
Microsoft Entra ID	組み込みのサインイン	Entraアプリ登録が必要	`entra.clientId`でホストアプリを識別

BYOKは Custom providers を参照。

Microsoft Entra ID

組み込みのMicrosoft Entraサインインとトークン更新を使うには、ホストアプリケーションをクライアントに登録します。clientIdにはEntraアプリ登録のアプリケーション（クライアント）IDを指定します。EntraAuthConfigインスタンスまたは配列を渡せます。空文字や空白のみの値はInvalidArgumentExceptionをスローします。

use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\EntraAuthConfig;

Copilot::useStdio([
    'entra' => new EntraAuthConfig(clientId: config('services.entra.client_id')),
])->run(prompt: 'Hello');
Copilot::stop();

配列で渡すこともできます。

Copilot::useStdio([
    'entra' => ['clientId' => config('services.entra.client_id')],
])->run(prompt: 'Hello');
Copilot::stop();

SDKはserver.connectハンドシェイク時にクライアントIDをランタイムへ送信します。この登録は、トークンを明示的に要求するaccounts.acquireEntraTokenサーバーRPCとは別のものです。Entra設定を指定していて、ランタイムが古くconnectに対応していない場合、SDKは設定を黙って無視せずにThis runtime does not support Entra client configuration.をスローします。その場合はランタイムを更新してください。他の認証方法は引き続き利用できます。

ネットワークコールバック

network設定で、ランタイムのプロキシ解決とKerberos Negotiate認証をホスト側のコールバックに委譲できます。利用するCopilotランタイムはnetwork.setProvider RPCをサポートしている必要があります。未対応の場合、クライアント起動時にランタイムの更新を案内する例外が発生します。コールバックにはリクエスト型と、キャンセルを確認できるCancellationTokenが渡されます。

use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Support\CancellationToken;
use Revolution\Copilot\Types\Rpc\NetworkAuthenticateNegotiateRequest;
use Revolution\Copilot\Types\Rpc\NetworkResolveProxyRequest;

Copilot::useStdio([
    'network' => [
        'scope' => 'runtime',
        'resolveProxy' => function (NetworkResolveProxyRequest $request, CancellationToken $signal) use ($proxyResolver): ?string {
            return $proxyResolver->resolve($request->url, $signal);
        },
        'authenticateNegotiate' => function (NetworkAuthenticateNegotiateRequest $request, CancellationToken $signal) use ($credentials): ?string {
            return $credentials->acquire($request->spn, $signal);
        },
    ],
])->run(prompt: 'Hello');
Copilot::stop();

resolveProxyはPROXY proxy.example:8080; DIRECTのようなPAC形式の文字列、または直接接続するDIRECTを返します。nullを返すとランタイム自身がプロキシを解決します。authenticateNegotiateはNegotiate プレフィックスを含まない、単回使用のbase64 SPNEGOトークンを返し、資格情報がなければnullを返します。コールバックが例外を投げた場合はRPCが失敗し、直接接続にはフォールバックしません。SPNは資格情報を発行する前に検証してください。 scopeは省略するとconnectionです。connectionはこのクライアントが作成または再開したセッションのリクエストだけを対象にします。runtimeは共有のバックグラウンド通信も対象にしますが、同時にこのscopeを保持できる接続は1つだけです。

GitHubログイン（CLI）

copilot もしくは gh CLIでログイン済みの場合は、何も指定しなければ保存済みの認証情報が使われます。

use Revolution\Copilot\Facades\Copilot;

$response = Copilot::run(prompt: 'Hello');

OAuth GitHub App / PAT

OAuthフローで取得したユーザーアクセストークン、またはFine-grained PATをgithub_tokenに渡します。

gho_ / ghu_ / github_pat_ を想定
ghp_（Classic PAT）は非推奨

use Revolution\Copilot\Facades\Copilot;

$config = array_merge(config('copilot'), [
    'github_token' => $user->github_token,
]);

$response = Copilot::useStdio($config)->run(prompt: '...');
Copilot::stop();

github_tokenを指定するとuse_logged_in_userは自動でfalseになります。明示的に切り替えたい場合は次の通り。

$config = [
    'github_token' => $user->github_token,
    'use_logged_in_user' => true,
];

詳細は GitHub token を参照。 github_tokenとuse_logged_in_userはstdioモード専用です。TCPモードではCopilot CLI側で認証済みである必要があります。

ホストで生成したシークレットをマスク

ホストアプリケーションがMCP OAuthなどでトークンを動的に取得する場合は、Copilot CLIのリダクションフィルターに登録します。CLIは登録された値をセッションログとエクスポートでマスクします。

use Revolution\Copilot\Facades\Copilot;

$accessToken = $oauthProvider->getAccessToken();

Copilot::client()->rpc()->secrets()->addFilterValues([
    'values' => [$accessToken],
]);

この呼び出しは、onMcpAuthRequestでのトークン取得・受け渡しとは別のものです。トークンを取得した後に明示的に呼び出してください。SDKはこのRPCのために値を保存したり、別途ログに記録したりしません。

環境変数

環境変数でトークンを渡す場合は、CLIが自動的に検出します。優先順位は上から順です。

COPILOT_GITHUB_TOKEN
GH_TOKEN
GITHUB_TOKEN

COPILOT_GITHUB_TOKEN=github_pat_xxx

use Revolution\Copilot\Facades\Copilot;

$response = Copilot::run(prompt: 'Hello');

TCPモードではCLIサーバー側の環境変数を設定してください。

認証の優先順位

SDKは以下の順で認証情報を解決します。

github_token（明示指定）
環境変数トークン（COPILOT_GITHUB_TOKEN → GH_TOKEN → GITHUB_TOKEN）
CLIに保存されたOAuth認証情報
gh CLIの認証情報

自動ログインを無効化

保存済みの認証情報を使いたくない場合はuse_logged_in_userをfalseにします。 falseにすると、認証に使われるのは明示的に指定したトークン（github_token）だけで、環境変数トークン（COPILOT_GITHUB_TOKEN、GH_TOKEN、GITHUB_TOKEN）は無視されます。

use Revolution\Copilot\Facades\Copilot;

$response = Copilot::useStdio([
    'use_logged_in_user' => false,
])->run(prompt: 'Hello');

github_tokenと同様にstdioモードのみ対応です。TCPモードではCopilot CLI側で認証済みである必要があります。

認証状態の確認

auth.getStatusの結果を取得して確認できます。

use Revolution\Copilot\Facades\Copilot;

$status = Copilot::client()->getAuthStatus();

if (! $status->isAuthenticated) {
    // 未認証
}

対話型ログインのアカウント選択

セッションRPCからloginAccountsを列挙すると、指定したプロバイダーで再利用できる保存済みIDを取得できます。各項目のlabelは表示用、activeはそのIDが現在のセッションの有効なアカウントに対応するかを示します。accountIdはプロバイダーが所有する不透明なIDです。内容を解析・加工せず、そのままログイン開始時に渡してください。

use Revolution\Copilot\Enums\AuthLoginMode;
use Revolution\Copilot\Enums\LoginProviderKind;
use Revolution\Copilot\Types\Rpc\AuthLoginBeginRequest;

$accounts = $session->rpc()->accounts();
$identities = $accounts->enumerate(
    'loginAccounts',
    provider: LoginProviderKind::ENTRA,
);

if (isset($identities[0])) {
    $accounts->begin(new AuthLoginBeginRequest(
        kind: LoginProviderKind::ENTRA,
        mode: AuthLoginMode::Default,
        accountId: $identities[0]->accountId,
    ));
}

通常のプロバイダー動作で保存済みIDを使う場合はmode: 'default'を指定します。プロバイダーのアカウント選択UIを明示的に表示したい場合はmode: 'selectAccount'を使い、この場合はaccountIdを渡しません。既存のbegin(LoginProviderKind::ENTRA)のような呼び出しも引き続き利用できます。

最新情報は GitHub リポジトリを参照してください。

GitHub Copilot

SDK

AI SDK

VOICEVOX

スターターキット

フィード・RSS

ミドルウェア

認証 - GitHub Copilot SDK for Laravel

認証

認証方法

Microsoft Entra ID

ネットワークコールバック

GitHubログイン（CLI）

OAuth GitHub App / PAT

ホストで生成したシークレットをマスク

環境変数

認証の優先順位

自動ログインを無効化

認証状態の確認

対話型ログインのアカウント選択

​認証

​認証方法

​Microsoft Entra ID

​ネットワークコールバック

​GitHubログイン（CLI）

​OAuth GitHub App / PAT

​ホストで生成したシークレットをマスク

​環境変数

​認証の優先順位

​自動ログインを無効化

​認証状態の確認

​対話型ログインのアカウント選択

認証

認証方法

Microsoft Entra ID

ネットワークコールバック

GitHubログイン（CLI）

OAuth GitHub App / PAT

ホストで生成したシークレットをマスク

環境変数

認証の優先順位

自動ログインを無効化

認証状態の確認

対話型ログインのアカウント選択