{"meta":{"title":"Настройка GitHub OAuth","intro":"Позвольте пользователям аутентифицироваться через свои аккаунты GitHub, чтобы использовать Copilot через ваше приложение. Это поддерживает индивидуальные аккаунты, членства организаций и корпоративные идентичности.","product":"GitHub Copilot","breadcrumbs":[{"href":"/ru/copilot","title":"GitHub Copilot"},{"href":"/ru/copilot/how-tos","title":"Инструкции"},{"href":"/ru/copilot/how-tos/copilot-sdk","title":"Второй пилот SDK"},{"href":"/ru/copilot/how-tos/copilot-sdk/setup","title":"Настройте Copilot SDK"},{"href":"/ru/copilot/how-tos/copilot-sdk/setup/github-oauth","title":"GitHub OAuth"}],"documentType":"article"},"body":"# Настройка GitHub OAuth\n\nПозвольте пользователям аутентифицироваться через свои аккаунты GitHub, чтобы использовать Copilot через ваше приложение. Это поддерживает индивидуальные аккаунты, членства организаций и корпоративные идентичности.\n\n\n\n\n\n**Лучше всего для:** Многопользовательских приложений, внутренних инструментов с управлением доступом к организации, SaaS-продуктов, приложений, где у пользователей есть GitHub аккаунты.\n\n## Принцип работы\n\nВы создаёте OAuth приложение GitHub (или приложение GitHub), пользователи его авторизуют, и вы передаёте их токен доступа SDK. Запросы на Copilot выполняются от имени каждого аутентифицированного пользователя с использованием их подписки Copilot.\n\n![Диаграмма: диаграмма последовательностей, показывающая описанный процесс.](/assets/images/help/copilot/copilot-sdk/setup-github-oauth-diagram-0.png)\n\n**Ключевые характеристики:**\n\n* Каждый пользователь аутентифицируется со своей собственной учетной записью GitHub\n* Использование Copilot оплачивается по подписке каждого пользователя\n* Поддерживает организации GitHub и корпоративные аккаунты\n* Ваше приложение никогда не обрабатывает ключи API моделей — GitHub управляет всем\n\n## Architecture\n\n![Диаграмма: блок-схема, показывающая описанный процесс.](/assets/images/help/copilot/copilot-sdk/setup-github-oauth-diagram-1.png)\n\n## Шаг 1: создать приложение GitHub OAuth\n\n1. Перейдите в **GitHub Настройки → Настройки разработчика → OAuth Apps → New OAuth App** (или для организаций: **Настройки организации → Настройки разработчика**)\n\n2. Заполните:\n * **Название приложения**: Название вашего приложения\n * **URL главной страницы**: URL вашего приложения\n * **URL обратного вызова авторизации**: ваша конечная точка обратного вызова OAuth (например, `https://yourapp.com/auth/callback`)\n\n3. Запишите свой **клиентский идентификатор** и сгенерируйте **секрет клиента**\n\n> \\*\\*GitHub Приложение против OAuth: \\*\\* Оба подходят. Приложения GitHub предлагают более тонкие разрешения и рекомендуются для новых проектов. Приложения OAuth проще настроить. Поток токенов с точки зрения SDK остаётся таким же.\n\n## Шаг 2: реализовать поток OAuth\n\nВаше приложение обрабатывает стандартный поток GitHub OAuth. Вот обмен токенами на стороне сервера:\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## Шаг 3: передать токен SDK\n\nСоздайте SDK-клиент для каждого аутентифицированного пользователя, передавая их токен:\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## Доступ к предприятиям и организациям\n\nGitHub OAuth естественно поддерживает корпоративные сценарии. Когда пользователи проходят аутентификацию через GitHub, появляются их членства в организации и корпоративные ассоциации.\n\n![Диаграмма: блок-схема, показывающая описанный процесс.](/assets/images/help/copilot/copilot-sdk/setup-github-oauth-diagram-2.png)\n\n### Проверьте членство в организации\n\nПосле OAuth проверьте, принадлежит ли пользователь вашей организации:\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### Управляемые корпоративными пользователями (EMU)\n\nДля корпоративных управляемых пользователей GitHub процесс идентичен — пользователи EMU аутентифицируются через GitHub OAuth, как и любой другой пользователь. Их корпоративные политики (ограничения IP, SAML SSO) автоматически выполняются GitHub.\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## Поддерживаемые типы токенов\n\n| Префикс токена | Исходный материал | Работает? |\n| -------------------- | -------------------------------------------- | --------- |\n| `gho_` | Токен доступа пользователя OAuth | ✅ |\n| `ghu_` | Токен доступа пользователя приложения GitHub | ✅ |\n| `github_pat_` | Точный личный маркер доступа | ✅ |\n| `ghp_` | Классический личный токен доступа | |\n| ❌ (не рекомендуется) | | |\n\n## Жизненный цикл токена\n\n![Диаграмма: блок-схема, показывающая описанный процесс.](/assets/images/help/copilot/copilot-sdk/setup-github-oauth-diagram-3.png)\n\n**Важно:** Ваше приложение отвечает за хранение токенов, обновление и обработку истечения срока действия. SDK использует тот токен, который вы предоставите — он не управляет жизненным циклом OAuth.\n\n### Паттерн обновления токенов\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## Многопользовательские паттерны\n\n### Один клиент на пользователя (рекомендуется)\n\nКаждый пользователь получает свой SDK-клиент со своим токеном. Это обеспечивает самую сильную изоляцию.\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 с токенами для каждого запроса\n\nДля меньшего ресурсного следа можно запускать один внешний CLI-сервер и передавать токены за сессию. См. [Настройка серверных сервисов](/ru/copilot/how-tos/copilot-sdk/setup/backend-services) для этой схемы.\n\n## Ограничения\n\n| Limitation | Details |\n| ---------------------------------------------- | ------------------------------------------------------------ |\n| **Copilot требуется подписка** | Каждому пользователю нужна активная подписка на Copilot |\n| **Управление токенами — ваша ответственность** | Храните, обновляйте и обрабатывайте истечение срока действия |\n| **GitHub требуется аккаунт** | Пользователи должны иметь аккаунты GitHub |\n| **Ограничения по скорости на пользователя** | С учётом лимитов Copilot каждого пользователя |\n\n## Когда двигаться дальше\n\n| Необходимость | Следующее руководство |\n| -------------------------------------------------------------------------------------- | --------------------- |\n| Пользователи без аккаунтов GitHub | |\n| [БЁК (принеси свой ключ)](/ru/copilot/how-tos/copilot-sdk/auth/byok) | |\n| Запускайте SDK на серверах | |\n| [Настройка серверных сервисов](/ru/copilot/how-tos/copilot-sdk/setup/backend-services) | |\n| Работа с множеством одновременных пользователей | |\n| [Масштабирование и многоарендность](/ru/copilot/how-tos/copilot-sdk/setup/scaling) | |\n\n## Дальнейшие действия\n\n* **[АВТОТИТР](/ru/copilot/how-tos/copilot-sdk/auth/authenticate)**: Полная ссылка на метод аутентификации\n* **[Настройка серверных сервисов](/ru/copilot/how-tos/copilot-sdk/setup/backend-services)**: Запустите SDK-сервер\n* **[Масштабирование и многоарендность](/ru/copilot/how-tos/copilot-sdk/setup/scaling)**: Обрабатывайте множество пользователей в масштабах"}