Конечные точки REST API для взаимодействия с организацией
Используйте REST API для временного ограничения того, какой тип пользователя может комментировать, открывать проблемы или создавать запросы на вытягивание в общедоступных репозиториях организации.
Сведения о взаимодействии организации
Владельцы организации могут временно ограничить, какой тип пользователя может комментировать, открывать проблемы или создавать запросы на вытягивание в общедоступных репозиториях организации. Если ограничения включены, то только указанный тип пользователя GitHub Enterprise Cloud сможет участвовать во взаимодействии. Срок действия ограничений автоматически истекает по истечении заданного периода. Дополнительные сведения о типах пользователей GitHub Enterprise Cloud:
- Существующие пользователи. Когда вы ограничиваете взаимодействие до
existing_users
, к новым пользователям с созданными менее 24 часов назад учетными записями, которые ранее не внесли свой вклад и не являются участниками совместной работы, будут временно применены ограничения в организации. - Только участники: когда вы ограничиваете взаимодействие до
contributors_only
, ко всем пользователям, которые ранее не внесли свой вклад и не являются участниками совместной работы, будут временно применены ограничения в организации. - Только участники совместной работы. Когда вы ограничиваете взаимодействие до
collaborators_only
, к пользователям, которые не являются участниками совместной работы, будут временно применены ограничения в организации.
Установка ограничения взаимодействия на уровне организации перезапишет все ограничения взаимодействия, заданные для отдельных репозиториев, принадлежащих организации. Чтобы задать различные ограничения взаимодействия для отдельных репозиториев, принадлежащих организации, используйте конечные точки взаимодействия репозитория.
Get interaction restrictions for an organization
Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.
Подробные маркеры доступа для "Get interaction restrictions for an organization
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Administration" organization permissions (read)
Параметры для "Get interaction restrictions for an organization"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
org string Обязательное полеThe organization name. The name is not case sensitive. |
Коды состояния http-ответа для "Get interaction restrictions for an organization"
Код состояния | Описание |
---|---|
200 | OK |
Примеры кода для "Get interaction restrictions for an organization"
Если вы обращаетесь к 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/orgs/ORG/interaction-limits
Response
Status: 200
{
"limit": "collaborators_only",
"origin": "organization",
"expires_at": "2018-08-17T04:18:39Z"
}
Set interaction restrictions for an organization
Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.
Подробные маркеры доступа для "Set interaction restrictions for an organization
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Administration" organization permissions (write)
Параметры для "Set interaction restrictions for an organization"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
org string Обязательное полеThe organization name. The name is not case sensitive. |
Имя., Тип, 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 an organization"
Код состояния | Описание |
---|---|
200 | OK |
422 | Validation failed, or the endpoint has been spammed. |
Примеры кода для "Set interaction restrictions for an organization"
Если вы обращаетесь к 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/orgs/ORG/interaction-limits \
-d '{"limit":"collaborators_only","expiry":"one_month"}'
Response
Status: 200
{
"limit": "collaborators_only",
"origin": "organization",
"expires_at": "2018-08-17T04:18:39Z"
}
Remove interaction restrictions for an organization
Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.
Подробные маркеры доступа для "Remove interaction restrictions for an organization
Эта конечная точка работает со следующими точными типами маркеров:
- Маркеры доступа пользователей приложения GitHub
- Маркеры доступа к установке приложений GitHub
- Точные личные маркеры доступа
Маркер с точной детализацией должен иметь следующий набор разрешений.:
- "Administration" organization permissions (write)
Параметры для "Remove interaction restrictions for an organization"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
org string Обязательное полеThe organization name. The name is not case sensitive. |
Коды состояния http-ответа для "Remove interaction restrictions for an organization"
Код состояния | Описание |
---|---|
204 | No Content |
Примеры кода для "Remove interaction restrictions for an organization"
Если вы обращаетесь к 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/orgs/ORG/interaction-limits
Response
Status: 204