Конечные точки REST API для взаимодействия с пользователем
Используйте REST API для временного ограничения того, какой тип пользователя может комментировать, открывать проблемы или создавать запросы на вытягивание в общедоступных репозиториях.
Сведения о взаимодействии пользователей
Rest API можно использовать для временного ограничения того, какой тип пользователя может комментировать, открывать проблемы или создавать запросы на вытягивание в общедоступных репозиториях. Если ограничения включены, то только указанный тип пользователя GitHub Enterprise Cloud сможет участвовать во взаимодействии. Срок действия ограничений автоматически истекает по истечении заданного периода. Дополнительные сведения о типах пользователей GitHub Enterprise Cloud:
- Существующие пользователи. Когда вы ограничиваете взаимодействие до
existing_users
, к новым пользователям с созданными менее 24 часов назад учетными записями, которые ранее не внесли свой вклад и не являются участниками совместной работы, будут временно применены ограничения взаимодействие с вашими репозиториями. - Только участники: когда вы ограничиваете взаимодействие до
contributors_only
, ко всем пользователям, которые ранее не внесли свой вклад и не являются участниками совместной работы, будут временно применены ограничения взаимодействие с вашими репозиториями. - Только участники совместной работы. Когда вы ограничиваете взаимодействие до
collaborators_only
, к пользователям, которые не являются участниками совместной работы, будут временно применены ограничения взаимодействие с вашими репозиториями.
Установка ограничения взаимодействия на уровне пользователя перезапишет все ограничения взаимодействия, заданные для отдельных репозиториев, принадлежащих пользователю. Чтобы задать различные ограничения взаимодействия для отдельных репозиториев, принадлежащих пользователю, используйте конечные точки взаимодействия репозитория.
Get interaction restrictions for your public repositories
Shows which type of GitHub user can interact with your public repositories and when the restriction expires.
Подробные маркеры доступа для "Get interaction restrictions for your public repositories
Эта конечная точка работает со следующими точными типами маркеров:
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Interaction limits" user permissions (read)
Коды состояния http-ответа для "Get interaction restrictions for your public repositories"
Код состояния | Описание |
---|---|
200 | Default response |
204 | Response when there are no restrictions |
Примеры кода для "Get interaction restrictions for your public repositories"
Если вы обращаетесь к GitHub в GHE.com, замените api.github.com
выделенный поддомен api.SUBDOMAIN.ghe.com
предприятия.
Пример запроса
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/user/interaction-limits
Default response
Status: 200
{
"limit": "collaborators_only",
"origin": "organization",
"expires_at": "2018-08-17T04:18:39Z"
}
Set interaction restrictions for your public repositories
Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.
Подробные маркеры доступа для "Set interaction restrictions for your public repositories
Эта конечная точка работает со следующими точными типами маркеров:
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Interaction limits" user permissions (write)
Параметры для "Set interaction restrictions for your public repositories"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
limit string Обязательное полеThe type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Возможные значения: |
expiry string The duration of the interaction restriction. Default: Возможные значения: |
Коды состояния http-ответа для "Set interaction restrictions for your public repositories"
Код состояния | Описание |
---|---|
200 | OK |
422 | Validation failed, or the endpoint has been spammed. |
Примеры кода для "Set interaction restrictions for your public repositories"
Если вы обращаетесь к GitHub в GHE.com, замените api.github.com
выделенный поддомен api.SUBDOMAIN.ghe.com
предприятия.
Пример запроса
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/user/interaction-limits \
-d '{"limit":"collaborators_only","expiry":"one_month"}'
Response
Status: 200
{
"limit": "collaborators_only",
"origin": "user",
"expires_at": "2018-08-17T04:18:39Z"
}
Remove interaction restrictions from your public repositories
Removes any interaction restrictions from your public repositories.
Подробные маркеры доступа для "Remove interaction restrictions from your public repositories
Эта конечная точка работает со следующими точными типами маркеров:
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Interaction limits" user permissions (write)
Коды состояния http-ответа для "Remove interaction restrictions from your public repositories"
Код состояния | Описание |
---|---|
204 | No Content |
Примеры кода для "Remove interaction restrictions from your public repositories"
Если вы обращаетесь к GitHub в GHE.com, замените api.github.com
выделенный поддомен api.SUBDOMAIN.ghe.com
предприятия.
Пример запроса
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/user/interaction-limits
Response
Status: 204