{"meta":{"title":"Configuração do OAuth do GitHub","intro":"Permitir que os usuários se autentiquem com suas contas GitHub para usar Copilot por meio de seu aplicativo. Isso dá suporte a contas individuais, associações à organização e identidades empresariais.","product":"GitHub Copilot","breadcrumbs":[{"href":"/pt/copilot","title":"GitHub Copilot"},{"href":"/pt/copilot/how-tos","title":"Instruções"},{"href":"/pt/copilot/how-tos/copilot-sdk","title":"SDK do Copilot"},{"href":"/pt/copilot/how-tos/copilot-sdk/setup","title":"Configurar o SDK do Copilot"},{"href":"/pt/copilot/how-tos/copilot-sdk/setup/github-oauth","title":"GitHub OAuth"}],"documentType":"article"},"body":"# Configuração do OAuth do GitHub\n\nPermitir que os usuários se autentiquem com suas contas GitHub para usar Copilot por meio de seu aplicativo. Isso dá suporte a contas individuais, associações à organização e identidades empresariais.\n\n\n\n\n\n**Best for:** aplicativos multiusuários, ferramentas internas com controle de acesso da organização, produtos SaaS, aplicativos em que os usuários têm contas GitHub.\n\n## Como funciona\n\nVocê cria um aplicativo OAuth GitHub (ou GitHub App), os usuários o autorizam e transmitem o token de acesso para o SDK. As solicitações do Copilot são feitas em nome de cada usuário autenticado, usando sua assinatura do Copilot.\n\n![Diagrama: diagrama de sequência mostrando o processo descrito.](/assets/images/help/copilot/copilot-sdk/setup-github-oauth-diagram-0.png)\n\n**Principais características:**\n\n* Cada usuário autentica com sua própria conta de GitHub\n* O uso do Copilot é cobrado na assinatura de cada usuário\n* Oferece suporte a organizações do GitHub e contas empresariais\n* Seu aplicativo nunca lida com chaves de API de modelo — GitHub gerencia tudo\n\n## Architecture\n\n![Diagrama: Fluxograma mostrando o processo descrito.](/assets/images/help/copilot/copilot-sdk/setup-github-oauth-diagram-1.png)\n\n## Etapa 1: criar um aplicativo OAuth GitHub\n\n1. Acesse **GitHub Configurações → Configurações do Desenvolvedor → Aplicativos OAuth → Novo Aplicativo OAuth** (ou para organizações: configurações de **Organização → configurações do desenvolvedor**)\n\n2. Preencha:\n * **Nome do aplicativo**: nome do seu aplicativo\n * **URL da home page**: URL do aplicativo\n * **URL de callback de autorização**: Seu endpoint de callback do OAuth (por exemplo, `https://yourapp.com/auth/callback`)\n\n3. Anote a **ID do cliente** e gere um **segredo do cliente**\n\n> **GitHub App vs OAuth App:** Ambos funcionam. os aplicativos GitHub oferecem permissões mais refinadas e são recomendados para novos projetos. Os Aplicativos OAuth são mais simples de configurar. O fluxo de token é o mesmo da perspectiva do SDK.\n\n## Etapa 2: implementar o fluxo OAuth\n\nSeu aplicativo lida com o fluxo OAuth de GitHub padrão. Aqui está a troca de tokens do lado do servidor:\n\n```typescript\n// Server-side: Exchange authorization code for user token\nasync function handleOAuthCallback(code: string): Promise {\n const response = await fetch(\"https://github.com/login/oauth/access_token\", {\n method: \"POST\",\n headers: {\n \"Content-Type\": \"application/json\",\n Accept: \"application/json\",\n },\n body: JSON.stringify({\n client_id: process.env.GITHUB_CLIENT_ID,\n client_secret: process.env.GITHUB_CLIENT_SECRET,\n code,\n }),\n });\n\n const data = await response.json();\n return data.access_token; // gho_xxxx or ghu_xxxx\n}\n```\n\n## Etapa 3: passar o token para o SDK\n\nCrie um cliente SDK para cada usuário autenticado, passando seu token:\n\n
\n
TypeScript
\n\n```typescript\nimport { CopilotClient } from \"@github/copilot-sdk\";\n\n// Create a client for an authenticated user\nfunction createClientForUser(userToken: string): CopilotClient {\n return new CopilotClient({\n gitHubToken: userToken,\n useLoggedInUser: false, // Don't fall back to CLI login\n });\n}\n\n// Usage\nconst client = createClientForUser(\"gho_user_access_token\");\nconst session = await client.createSession({\n sessionId: `user-${userId}-session`,\n model: \"gpt-5.4\",\n});\n\nconst response = await session.sendAndWait({ prompt: \"Hello!\" });\n```\n\n
\n\n
Python
\n\n```python\nfrom copilot import CopilotClient\nfrom copilot.session import PermissionHandler\n\ndef create_client_for_user(user_token: str) -> CopilotClient:\n return CopilotClient({\n \"github_token\": user_token,\n \"use_logged_in_user\": False,\n })\n\n# Usage\nclient = create_client_for_user(\"gho_user_access_token\")\nawait client.start()\n\nsession = await client.create_session(on_permission_request=PermissionHandler.approve_all, model=\"gpt-5.4\", session_id=f\"user-{user_id}-session\")\n\nresponse = await session.send_and_wait(\"Hello!\")\n```\n\n
\n\n
Go
\n\n```golang\nfunc createClientForUser(userToken string) *copilot.Client {\n return copilot.NewClient(&copilot.ClientOptions{\n GitHubToken: userToken,\n UseLoggedInUser: copilot.Bool(false),\n })\n}\n\n// Usage\nclient := createClientForUser(\"gho_user_access_token\")\nclient.Start(ctx)\ndefer client.Stop()\n\nsession, _ := client.CreateSession(ctx, &copilot.SessionConfig{\n SessionID: fmt.Sprintf(\"user-%s-session\", userID),\n Model: \"gpt-5.4\",\n})\nresponse, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: \"Hello!\"})\n```\n\n
\n\n
.NET
\n\n```csharp\nCopilotClient CreateClientForUser(string userToken) =>\n new CopilotClient(new CopilotClientOptions\n {\n GitHubToken = userToken,\n UseLoggedInUser = false,\n });\n\n// Usage\nawait using var client = CreateClientForUser(\"gho_user_access_token\");\nawait using var session = await client.CreateSessionAsync(new SessionConfig\n{\n SessionId = $\"user-{userId}-session\",\n Model = \"gpt-5.4\",\n});\n\nvar response = await session.SendAndWaitAsync(\n new MessageOptions { Prompt = \"Hello!\" });\n```\n\n
\n\n
Java
\n\n\n\n```java\nimport com.github.copilot.CopilotClient;\nimport com.github.copilot.rpc.*;\n\nCopilotClient createClientForUser(String userToken) throws Exception {\n var client = new CopilotClient(new CopilotClientOptions()\n .setGitHubToken(userToken)\n .setUseLoggedInUser(false)\n );\n client.start().get();\n return client;\n}\n\n// Usage — use try-with-resources to ensure cleanup\nvar userId = \"user1\";\ntry (var client = createClientForUser(\"gho_user_access_token\")) {\n var session = client.createSession(new SessionConfig()\n .setSessionId(String.format(\"user-%s-session\", userId))\n .setModel(\"gpt-5.4\")\n .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)\n ).get();\n\n var response = session.sendAndWait(new MessageOptions()\n .setPrompt(\"Hello!\")).get();\n}\n```\n\n
\n\n
\n\n## Acesso empresarial e organizacional\n\nGitHub OAuth naturalmente dá suporte a cenários empresariais. Quando os usuários se autenticam com o GitHub, seus vínculos com organizações e empresas também são trazidos junto.\n\n![Diagrama: Fluxograma mostrando o processo descrito.](/assets/images/help/copilot/copilot-sdk/setup-github-oauth-diagram-2.png)\n\n### Verificar a associação à organização\n\nApós o OAuth, verifique se o usuário pertence à sua organização:\n\n```typescript\nasync function verifyOrgMembership(\n token: string,\n requiredOrg: string\n): Promise {\n const response = await fetch(\"https://api.github.com/user/orgs\", {\n headers: { Authorization: `Bearer ${token}` },\n });\n const orgs = await response.json();\n return orgs.some((org: any) => org.login === requiredOrg);\n}\n\n// In your auth flow\nconst token = await handleOAuthCallback(code);\nif (!await verifyOrgMembership(token, \"my-company\")) {\n throw new Error(\"User is not a member of the required organization\");\n}\nconst client = createClientForUser(token);\n```\n\n### Usuários corporativos gerenciados (EMU)\n\nPara Usuários Gerenciados do GitHub Enterprise, o fluxo é idêntico: os usuários do EMU se autenticam via GitHub OAuth como qualquer outro usuário. Suas políticas corporativas (restrições de IP, SSO do SAML) são impostas por GitHub automaticamente.\n\n```typescript\n// No special SDK configuration needed for EMU\n// Enterprise policies are enforced server-side by GitHub\nconst client = new CopilotClient({\n gitHubToken: emuUserToken, // Works the same as regular tokens\n useLoggedInUser: false,\n});\n```\n\n## Tipos de token com suporte\n\n| Prefixo de token | Fonte | Funciona? |\n| ---------------- | ----------------------------------------------- | --------- |\n| `gho_` | Token de acesso do usuário OAuth | ✅ |\n| `ghu_` | token de acesso do usuário do aplicativo GitHub | ✅ |\n| `github_pat_` | Token de acesso pessoal refinado | ✅ |\n| `ghp_` | Token de acesso pessoal clássico | |\n| ❌ (preterido) | | |\n\n## Ciclo de vida do token\n\n![Diagrama: Fluxograma mostrando o processo descrito.](/assets/images/help/copilot/copilot-sdk/setup-github-oauth-diagram-3.png)\n\n**Importante:** Seu aplicativo é responsável pelo armazenamento de tokens, atualização e tratamento de expiração. O SDK usa qualquer token fornecido, ele não gerencia o ciclo de vida do OAuth.\n\n### Padrão de atualização de token\n\n```typescript\nasync function getOrRefreshToken(userId: string): Promise {\n const stored = await tokenStore.get(userId);\n\n if (stored && !isExpired(stored)) {\n return stored.accessToken;\n }\n\n if (stored?.refreshToken) {\n const refreshed = await refreshGitHubToken(stored.refreshToken);\n await tokenStore.set(userId, refreshed);\n return refreshed.accessToken;\n }\n\n throw new Error(\"User must re-authenticate\");\n}\n```\n\n## Padrões de vários usuários\n\n### Um cliente por usuário (recomendado)\n\nCada usuário obtém seu próprio cliente SDK com seu próprio token. Isso fornece o isolamento mais forte.\n\n```typescript\nconst clients = new Map();\n\nfunction getClientForUser(userId: string, token: string): CopilotClient {\n if (!clients.has(userId)) {\n clients.set(userId, new CopilotClient({\n gitHubToken: token,\n useLoggedInUser: false,\n }));\n }\n return clients.get(userId)!;\n}\n```\n\n### CLI compartilhada com tokens por solicitação\n\nPara um menor consumo de recursos, você pode executar um único servidor CLI externo e fornecer tokens por sessão. Consulte [Configuração de serviços de back-end](/pt/copilot/how-tos/copilot-sdk/setup/backend-services) para esse padrão.\n\n## Limitações\n\n| Limitation | Detalhes |\n| ---------------------------------------------------- | ------------------------------------------------------- |\n| **Assinatura do Copilot necessária** | Cada usuário precisa de uma assinatura de Copilot ativa |\n| **O gerenciamento de tokens é sua responsabilidade** | Armazenar, renovar e gerenciar a expiração |\n| **GitHub conta necessária** | Os usuários devem ter contas GitHub |\n| **Limites de taxa por usuário** | Sujeito aos limites de uso do Copilot de cada usuário |\n\n## Quando seguir em frente\n\n| Necessidade | Próximo Guia |\n| ------------------------------------------------------------------------------------------------ | ------------ |\n| Usuários sem contas de GitHub | |\n| [BYOK (Bring Your Own Key - traga sua própria chave)](/pt/copilot/how-tos/copilot-sdk/auth/byok) | |\n| Executar o SDK em servidores | |\n| [Configuração de serviços de back-end](/pt/copilot/how-tos/copilot-sdk/setup/backend-services) | |\n| Manipular muitos usuários simultâneos | |\n| [Escalabilidade e multitenância](/pt/copilot/how-tos/copilot-sdk/setup/scaling) | |\n\n## Próximas Etapas \n\n* **[Autenticação](/pt/copilot/how-tos/copilot-sdk/auth/authenticate)**: Referência completa do método de autenticação\n* **[Configuração de serviços de back-end](/pt/copilot/how-tos/copilot-sdk/setup/backend-services)**: Executar o SDK no servidor\n* **[Escalabilidade e multitenância](/pt/copilot/how-tos/copilot-sdk/setup/scaling)**: Lidar com muitos usuários em grande escala"}