Text of docs.github.com › en › copilot › how-tos › copilot-sdk › setup › github-oauth as Styx crawled it on Nov 19, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

GitHub OAuth setup - GitHub Docs

Skip to main content Skip to content Collapse sidebar Expand sidebar GitHub OAuth setup Let users authenticate with their GitHub accounts to use Copilot through your application. This supports individual accounts, organization memberships, and enterprise identities. In this article Best for: Multi-user apps, internal tools with org access control, SaaS products, apps where users have GitHub accounts. How it works You create a GitHub OAuth App (or GitHub App), users authorize it, and you pass their access token to the SDK.

Copilot requests are made on behalf of each authenticated user, using their Copilot subscription. Key characteristics: Each user authenticates with their own GitHub account Copilot usage is billed to each user's subscription Supports GitHub organizations and enterprise accounts Your app never handles model API keys—GitHub manages everything Architecture Step 1: create a GitHub OAuth app Go to GitHub Settings → Developer Settings → OAuth Apps → New OAuth App (or for organizations: Organization Settings → Developer Settings ) Fill in: Application name : Your app's name Homepage URL : Your app's URL Authorization callback URL : Your OAuth callback endpoint (e.g., https://yourapp.com/auth/callback ) Note your Client ID and generate a Client Secret GitHub App vs OAuth App: Both work.

GitHub Apps offer finer-grained permissions and are recommended for new projects. OAuth Apps are simpler to set up. The token flow is the same from the SDK's perspective. Step 2: implement the OAuth flow Your application handles the standard GitHub OAuth flow. Here's the server-side token exchange: // Server-side: Exchange authorization code for user token async function handleOAuthCallback ( code : string ): Promise < string > { const response = await fetch ( "https://github.com/login/oauth/access_token" , { method : "POST" , headers : { "Content-Type" : "application/json" , Accept : "application/json" , }, body : JSON . stringify ({ client_id : process. env .

GITHUB_CLIENT_ID , client_secret : process. env . GITHUB_CLIENT_SECRET , code, }), }); const data = await response. json (); return data. access_token ; // gho_xxxx or ghu_xxxx } Step 3: pass the token to the SDK Create an SDK client for each authenticated user, passing their token: TypeScript import { CopilotClient } from "@github/copilot-sdk" ; // Create a client for an authenticated user function createClientForUser ( userToken : string ): CopilotClient { return new CopilotClient ({ gitHubToken : userToken, useLoggedInUser : false , // Don't fall back to CLI login }); } // Usage const client = createClientForUser ( "gho_user_access_token" ); const session = await client. createSession ({ sessionId : `user- ${userId} -session` , model : "gpt-5.4" , }); const response = await session. sendAndWait ({ prompt : "Hello!" }); Python from copilot import CopilotClient from copilot.session import PermissionHandler def create_client_for_user ( user_token: str ) -> CopilotClient: return CopilotClient({ "github_token" : user_token, "use_logged_in_user" : False , }) # Usage client = create_client_for_user( "gho_user_access_token" ) await client.start() session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model= "gpt-5.4" , session_id= f"user- {user_id} -session" ) response = await session.send_and_wait( "Hello!" ) Go func createClientForUser (userToken string ) *copilot.Client { return copilot.NewClient(&copilot.ClientOptions{ GitHubToken: userToken, UseLoggedInUser: copilot.Bool( false ), }) } // Usage client := createClientForUser( "gho_user_access_token" ) client.Start(ctx) defer client.Stop() session, _ := client.CreateSession(ctx, &copilot.SessionConfig{ SessionID: fmt.Sprintf( "user-%s-session" , userID), Model: "gpt-5.4" , }) response, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: "Hello!" }) .NET CopilotClient CreateClientForUser ( string userToken ) => new CopilotClient( new CopilotClientOptions { GitHubToken = userToken, UseLoggedInUser = false , }); // Usage await using var client = CreateClientForUser( "gho_user_access_token" ); await using var session = await client.CreateSessionAsync( new SessionConfig { SessionId = $"user- {userId} -session" , Model = "gpt-5.4" , }); var response = await session.SendAndWaitAsync( new MessageOptions { Prompt = "Hello!" }); Java import com.github.copilot.CopilotClient; import com.github.copilot.rpc.*; CopilotClient createClientForUser (String userToken) throws Exception { var client = new CopilotClient ( new CopilotClientOptions () .setGitHubToken(userToken) .setUseLoggedInUser( false ) ); client.start().get(); return client; } // Usage — use try-with-resources to ensure cleanup var userId = "user1" ; try ( var client = createClientForUser( "gho_user_access_token" )) { var session = client.createSession( new SessionConfig () .setSessionId(String.format( "user-%s-session" , userId)) .setModel( "gpt-5.4" ) .setOnPermissionRequest(PermissionHandler.APPROVE_ALL) ).get(); var response = session.sendAndWait( new MessageOptions () .setPrompt( "Hello!" )).get(); } Enterprise and organization access GitHub OAuth naturally supports enterprise scenarios.

When users authenticate with GitHub, their org memberships and enterprise associations come along. Verify organization membership After OAuth, check that the user belongs to your organization: async function verifyOrgMembership ( token : string , requiredOrg : string ): Promise < boolean > { const response = await fetch ( "https://api.github.com/user/orgs" , { headers : { Authorization : `Bearer ${token} ` }, }); const orgs = await response. json (); return orgs. some ( ( org : any ) => org. login === requiredOrg); } // In your auth flow const token = await handleOAuthCallback (code); if (! await verifyOrgMembership (token, "my-company" )) { throw new Error ( "User is not a member of the required organization" ); } const client = createClientForUser (token); Enterprise managed users (EMU) For GitHub Enterprise Managed Users, the flow is identical—EMU users authenticate through GitHub OAuth like any other user.

Their enterprise policies (IP restrictions, SAML SSO) are enforced by GitHub automatically. // No special SDK configuration needed for EMU // Enterprise policies are enforced server-side by GitHub const client = new CopilotClient ({ gitHubToken : emuUserToken, // Works the same as regular tokens useLoggedInUser : false , }); Supported token types Token Prefix Source Works? gho_ OAuth user access token ✅ ghu_ GitHub App user access token ✅ github_pat_ Fine-grained personal access token ✅ ghp_ Classic personal access token ❌ (deprecated) Token lifecycle Important: Your application is responsible for token storage, refresh, and expiration handling.

The SDK uses whatever token you provide—it doesn't manage the OAuth lifecycle. Token refresh pattern async function getOrRefreshToken ( userId : string ): Promise < string > { const stored = await tokenStore. get (userId); if (stored && ! isExpired (stored)) { return stored. accessToken ; } if (stored?. refreshToken ) { const refreshed = await refreshGitHubToken (stored. refreshToken ); await tokenStore. set (userId, refreshed); return refreshed. accessToken ; } throw new Error ( "User must re-authenticate" ); } Multi-user patterns One client per user (recommended) Each user gets their own SDK client with their own token.

This provides the strongest isolation. const clients = new Map < string , CopilotClient >(); function getClientForUser ( userId : string , token : string ): CopilotClient { if (!clients. has (userId)) { clients. set (userId, new CopilotClient ({ gitHubToken : token, useLoggedInUser : false , })); } return clients. get (userId)!; } Shared CLI with per-request tokens For a lighter resource footprint, you can run a single external CLI server and pass tokens per session.

See Backend services setup for this pattern. Limitations Limitation Details Copilot subscription required Each user nee

The rest of this page is on the live site.