Конечные точки маркеров доступа к установке приложений GitHub | Документация GitHub Enterprise Server 37

API GitHub предоставляет различные конечные точки для управления и обновления маркеров доступа к установке приложений GitHub Enterprise Server 37. Это позволяет администраторам эффективно контролировать доступ к ресурсам и управлять безопасностью на своем сервере GitHub Enterprise.

Маркеры доступа - это безопасные токены аутентификации, которые позволяют приложениям взаимодействовать с API GitHub от имени конкретного пользователя или организации. Каждое приложение может иметь несколько маркеров доступа, каждый из которых имеет свои ограничения и разрешения.

API GitHub предоставляет конечные точки для создания, получения, обновления и удаления маркеров доступа к установке приложений GitHub Enterprise Server 37. Вы можете использовать эти конечные точки для автоматизации процесса управления маркерами доступа и обеспечения безопасности своего сервера GitHub Enterprise.

Используя конечные точки API GitHub, вы можете управлять разрешениями маркеров доступа, устанавливать ограничения на их использование, проверять их статус и многое другое. Это позволяет эффективно контролировать доступ к ресурсам вашего сервера GitHub Enterprise и обеспечивать безопасность вашей установки.

Описание

Описание

Конечные точки для маркеров доступа к установке приложений GitHub предоставляют возможность управления маркерами доступа, которые используются для проверки подлинности запросов на установку приложения на установку GitHub.

Маркер доступа для установки приложения GitHub может быть создан с использованием авторизации OAuth. Он может быть использован для установки приложения на установку GitHub.

API маркера доступа установки приложения GitHub позволяет создавать, получать и удалять маркеры доступа, а также получать информацию о маркерах доступа.

Вы можете использовать эти конечные точки API для интеграции маркеров доступа к установке с вашими собственными инструментами и системами.

Использование

Для использования конечных точек для маркеров доступа к установке приложений GitHub, вам потребуется сгенерировать маркер доступа. Для этого:

1. Откройте раздел "Настройки" на вашей установке GitHub Enterprise Server.
2. Выберите "Маркеры доступа" в боковой панели слева.
3. Нажмите кнопку "Создать маркер доступа".
4. Введите название маркера доступа и выберите необходимые разрешения.
5. Нажмите кнопку "Создать маркер доступа".

После создания маркера доступа вы получите уникальный токен авторизации, который будет использоваться при отправке запросов к конечным точкам API.

Чтобы использовать конечные точки для маркеров доступа к установке приложений GitHub, вам необходимо отправлять HTTP-запросы с использованием этого токена. Например, вы можете использовать curl для отправки запросов из командной строки:

curl -H "Authorization: token YOUR_ACCESS_TOKEN" https://github.YOUR_DOMAIN/api/v3/endpoint

Убедитесь, что вместо YOUR_ACCESS_TOKEN вы указываете ваш маркер доступа, а вместо YOUR_DOMAIN - URL вашей установки GitHub Enterprise Server.

Вы также можете использовать различные клиентские библиотеки для отправки запросов к конечным точкам API, такие как Octokit для JavaScript или PyGithub для Python.

Используйте доступные конечные точки API для получения информации о репозиториях, коммитах, ветках, пул-реквестах и других объектах вашей установки GitHub Enterprise Server. Конечные точки API позволяют автоматизировать множество задач и интегрировать вашу установку GitHub с другими системами.

Обратите внимание, что при использовании конечных точек для маркеров доступа к установке приложений GitHub необходимо обеспечить безопасность и защиту вашего маркера доступа. Не делитесь своими маркерами доступа с непроверенными лицами и следите за использованием маркеров доступа в ваших проектах.

Подробности по конечным точкам

При использовании маркеров доступа к установке приложений GitHub на GitHub Enterprise Server 3.7 вы можете взаимодействовать с различными конечными точками API, чтобы получить информацию о репозиториях, организациях, пользовательских аккаунтах и многом другом.

Ниже приведены некоторые основные конечные точки API, которые можно использовать с маркерами доступа к установке приложений GitHub:

• GET /repos/{owner}/{repo} - возвращает информацию о конкретном репозитории
• GET /users/{username} - возвращает информацию о конкретном пользователе
• GET /orgs/{org} - возвращает информацию об организации
• GET /user - возвращает информацию о текущем пользователе

Каждая конечная точка имеет свой уникальный набор параметров запроса и может возвращать различный формат данных в ответе. Дополнительные сведения о каждой конечной точке API и ее возможностях можно найти в документации GitHub.

При использовании маркеров доступа к установке приложений GitHub для взаимодействия с конечными точками API, убедитесь, что у вас есть необходимые разрешения и авторизация для доступа к требуемым данным. Обратитесь к документации API GitHub для получения подробной информации о правах доступа и ограничениях.

Конечная точка "Получить список маркеров доступа"

Конечная точка "Получить список маркеров доступа" позволяет получить список всех маркеров доступа, которые были созданы для установки приложений на GitHub Enterprise Server.

Для вызова этой конечной точки необходим авторизованный доступ с правами администратора. В ответ на запрос будет возвращен список маркеров доступа в формате JSON. Каждый объект маркера доступа содержит информацию о его ID, имени, дате создания и организации, к которой он привязан.

Пример запроса:

GET /app/installations/:installation_id/access_tokens

Где :installation_id - идентификатор установки приложения.

Пример ответа:

[
{
"id": 12345678,
"name": "Access Token 1",
"created_at": "2022-01-01T00:00:00Z",
"organization": "example-org"
},
{
"id": 98765432,
"name": "Access Token 2",
"created_at": "2022-01-02T00:00:00Z",
"organization": "example-org"
}
]

Возможно использование пагинации для получения большого количества маркеров доступа. Для этого необходимо задать параметры page (страница) и per_page (количество объектов на странице) в запросе.

Пример запроса с пагинацией:

GET /app/installations/:installation_id/access_tokens?page=2&per_page=50

Где page - номер страницы, per_page - количество объектов на странице.

Конечная точка "Получить список маркеров доступа" является важным инструментом для управления доступом к установке приложений GitHub Enterprise Server. Она позволяет администратору получить полный список маркеров доступа, а также управлять ими, если требуется.

Конечная точка "Создать маркер доступа"

Конечная точка "Создать маркер доступа" позволяет генерировать уникальные маркеры доступа для использования в установке приложений на GitHub Enterprise Server.

HTTP-метод: POST

URL-адрес: /api/v1/apps/installations/{installation_id}/access_tokens

Параметры пути:

Тело запроса:

Пример тела запроса:

{
"permissions": {
"issues": "write",
"pull_requests": "read"
}
}

Ответ:

Пример ответа:

{
"token": "your_access_token",
"expires_at": "2022-12-31T23:59:59Z"
}

Полученный маркер доступа может быть использован для аутентификации и авторизации во всех запросах API, связанных с установкой приложения на GitHub Enterprise Server.

Конечная точка "Удалить маркер доступа"

Конечная точка "Удалить маркер доступа" позволяет удалить маркер доступа со связанными с ним разрешениями и ограничениями.

Для удаления маркера доступа необходимо отправить запрос DELETE по следующему URL:

DELETE /applications/:client_id/token

Где :client_id - идентификатор клиента, связанный с маркером доступа, который необходимо удалить.

В ответ на успешное выполнение запроса будет возвращен статус 204 No Content.

Примечание: После удаления маркера доступа он станет недействительным, и все запросы, выполняемые с использованием этого маркера, будут отклонены.

Если маркер доступа не существует или не принадлежит текущему пользователю, будет возвращен статус 404 Not Found.