Конечные точки для точных персональных маркеров доступа — документация GitHub Enterprise Server 3.10

Документация GitHub Enterprise Server 3.10 предоставляет подробную информацию о конечных точках для точных персональных маркеров доступа. Точные персональные маркеры доступа - это уникальные коды, которые используются для аутентификации и авторизации в системе GitHub.

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

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

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

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

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

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

Следующие конечные точки API доступны для управления точными персональными маркерами доступа:

• Создание точного персонального маркера доступа: POST /authorizations
• Получение информации о точном персональном маркере доступа: GET /authorizations/{authorization_id}
• Обновление точного персонального маркера доступа: PATCH /authorizations/{authorization_id}
• Удаление точного персонального маркера доступа: DELETE /authorizations/{authorization_id}

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

При отправке запросов к конечным точкам API необходимо передавать параметры в теле запроса или в строке запроса в зависимости от типа запроса и необходимости передачи данных. В ответ на запросы API возвращают соответствующие данные или коды состояния.

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

Что такое точные персональные маркеры доступа?

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

Точные персональные маркеры доступа могут быть использованы в различных случаях, включая автоматизацию рабочих процессов, интеграцию с внешними системами или разработку инструментов для управления задачами в репозиториях.

Какую роль они играют в GitHub Enterprise Server 3.10?

Конечные точки для точных персональных маркеров доступа (PAT) играют важную роль в GitHub Enterprise Server 3.10. Они позволяют пользователям создавать, использовать и управлять персональными маркерами доступа для автоматической аутентификации и доступа к API GitHub. Конечные точки PAT API предоставляют различные операции, которые пользователи могут выполнять с персональными маркерами доступа, такие как создание, обновление, удаление и получение информации о существующих маркерах доступа.

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

Конечные точки PAT API также позволяют пользователям управлять правами и ограничениями своих персональных маркеров доступа. Это может включать ограничение типов операций, которые можно выполнять с использованием маркера доступа, а также ограничение времени его действия.

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

Описание конечных точек

Конечные точки (endpoints) веб-сервиса предоставляют доступ к определенным функциям и возможностям. С помощью конечных точек вы можете отправлять запросы на выполнение определенных действий или получать информацию из системы.

Для работы с точными персональными маркерами доступа на GitHub Enterprise Server 310 предоставляется набор конечных точек, которые позволяют:

Каждая конечная точка имеет свой HTTP-метод, путь (URI) и параметры, которые передаются в запросе. В ответ на запрос сервер возвращает соответствующий код ответа и данные, если они есть.

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

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

Конечная точка /user/:username/token используется для создания нового точного персонального маркера доступа для указанного пользователя.

Метод: POST

Параметры URL:

Параметры запроса:

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

POST /user/exampleUser/token

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

{
"scopes": ["repo"],
"note": "Access token for repository access"
}

Ответ:

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

Status: 201 Created
Body: {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZXMiOlsicmVwbyJdLCJpYXQiOjE2MzE1MzAxMzAsImV4cCI6MTY0MjA0NzEzM30.wGeGkbLlWWh7F6LhgWV3Vh6I7laz39WiD3F0D2aIDpU",
"scope": "repo",
"note": "Access token for repository access"
}

Важно: Сохраните полученный маркер доступа, так как он не будет отображаться снова.

Конечная точка для получения информации о точных персональных маркерах доступа

Конечная точка /users/:username/token позволяет получить информацию о точных персональных маркерах доступа для указанного пользователя.

Для доступа к этой конечной точке необходима авторизация с помощью базовой аутентификации или токена авторизации. При обращении к этой конечной точке в HTTP-заголовке Authorization должен быть передан токен авторизации. В случае успешной авторизации, в ответ будет возвращена информация о точных персональных маркерах доступа пользователя.

Для использования данной конечной точки следует выполнить GET-запрос:

GET /users/:username/token

Где :username должен быть заменен на имя пользователя, для которого нужно получить информацию о маркерах доступа.

В ответ на данную GET-запрос будет возвращен JSON-объект, содержащий следующую информацию о точных персональных маркерах доступа пользователя:

• token - точный персональный маркер доступа пользователя;
• expires_at - дата и время истечения срока действия маркера доступа;
• permissions - список разрешений, связанных с данным маркером доступа.

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

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

DELETE /user/migrations/:migration_id/:delete_token

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

Чтобы использовать эту конечную точку, вам необходимо быть аутентифицированным пользователем, у которого есть доступ к миграции. Вы должны предоставить идентификатор миграции в `migration_id` и действительный токен удаления в `delete_token`.

Если операция удаления успешна, конечная точка вернет код состояния 204 No Content.

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

DELETE /user/migrations/123456/delete_token123456 

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

Status: 204 No Content 

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

Использование конечных точек

Конечные точки (endpoints) предоставляют доступ к различным функциям и операциям в GitHub Enterprise Server. Используя конечные точки, вы можете взаимодействовать с репозиториями, пользователями, задачами и другими элементами системы.

Чтобы использовать конечные точки, вы должны отправить HTTP-запросы соответствующим адресам и параметрам. Запросы можно выполнять с помощью различных программ и инструментов, включая командную строку, браузер или различные API-клиенты.

Взаимодействие с конечными точками основывается на различных методах HTTP, таких как GET, POST, PATCH и DELETE. Каждый метод выполняет определенное действие в системе. Каждая конечная точка имеет свой адрес и список параметров, которые могут быть переданы в запросе.

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

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

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

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