Взаимодействие с организацией

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

Сведения о взаимодействии с организацией

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

Существующие пользователи. Когда вы ограничиваете взаимодействие до existing_users, к новым пользователям с созданными менее 24 часов назад учетными записями, которые ранее не внесли свой вклад и не являются участниками совместной работы, будут временно применены ограничения в организации.
Только участники: когда вы ограничиваете взаимодействие до contributors_only, ко всем пользователям, которые ранее не внесли свой вклад и не являются участниками совместной работы, будут временно применены ограничения в организации.
Только участники совместной работы. Когда вы ограничиваете взаимодействие до collaborators_only, к пользователям, которые не являются участниками совместной работы, будут временно применены ограничения в организации.

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

Get interaction restrictions for an organization

Работа с GitHub Apps

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"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`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"

get/orgs/{org}/interaction-limits

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

Работа с GitHub Apps

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"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`org` string Обязательно The organization name. The name is not case sensitive.
Параметры запроса
Имя, Тип, Описание
`limit` string Обязательно The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Может быть одним из: `existing_users`, `contributors_only`, `collaborators_only`
`expiry` string The duration of the interaction restriction. Default: `one_day`. Может быть одним из: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`

Коды состояния HTTP-ответа для "Set interaction restrictions for an organization"

Код состояния	Описание
`200`	OK
`422`	Validation failed, or the endpoint has been spammed.

Примеры кода для "Set interaction restrictions for an organization"

put/orgs/{org}/interaction-limits

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

Работа с GitHub Apps

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"

Заголовки
Имя, Тип, Описание
`accept` string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`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"

delete/orgs/{org}/interaction-limits

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