The REST API is now versioned. For more information, see "About API versioning."

Organisationsinteraktionen

Informationen zur Organisationsinteraktions-API

Mit der Organisationsinteraktions-API können Organisationsbesitzer*innen vorübergehend einschränken, welche Art von Benutzern in den öffentlichen Repositorys der Organisation Kommentare schreiben, Issues öffnen oder Pull Requests erstellen können. Wenn Einschränkungen aktiviert sind, kann nur der angegebene Typ von GitHub-Benutzer an Interaktionen teilnehmen. Einschränkungen laufen nach einem definierten Zeitraum automatisch ab. Hier findest du weitere Informationen zu den Typen von GitHub-Benutzern:

Vorhandene Benutzer: Wenn du Interaktionen auf existing_users beschränkst, werden neue Benutzer, deren Konten noch keine 24 Stunden alt sind, die noch keinen Beitrag geleistet haben und die keine Mitarbeiter sind, vorübergehend eingeschränkt. in der Organisation.
Nur Mitwirkende: Wenn du Interaktionen auf contributors_only beschränkst, werden Benutzer, die zuvor nicht mitgewirkt haben und keine Projektmitarbeiter sind, vorübergehend eingeschränkt. in der Organisation.
Nur Mitarbeiter: Wenn du Interaktionen auf collaborators_only beschränkst, werden Benutzer, die keine Mitarbeiter sind, vorübergehend eingeschränkt. in der Organisation.

Durch Festlegen des Interaktionslimits auf Organisationsebene werden alle Interaktionsbeschränkungen überschrieben, die für einzelne Repositorys im Besitz der Organisation festgelegt sind. Verwende stattdessen die Repositoryinteraktionsendpunkte, um unterschiedliche Interaktionslimits für einzelne Repositorys festzulegen, die der Organisation gehören.

Get interaction restrictions for an organization

Funktioniert mit 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.

Parameter

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`org`stringRequired The organization name. The name is not case sensitive.

HTTP-Antwortstatuscodes

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele

get/orgs/{org}/interaction-limits

curl \
  -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

Funktioniert mit 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.

Parameter

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`org`stringRequired The organization name. The name is not case sensitive.
Body parameters
Name, Type, Description
`limit`stringRequired The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. Can be one of: `existing_users`, `contributors_only`, `collaborators_only`
`expiry`string The duration of the interaction restriction. Default: `one_day`. Can be one of: `one_day`, `three_days`, `one_week`, `one_month`, `six_months`

HTTP-Antwortstatuscodes

Statuscode	BESCHREIBUNG
`200`	OK
`422`	Validation failed, or the endpoint has been spammed.

Codebeispiele

put/orgs/{org}/interaction-limits

curl \
  -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

Funktioniert mit GitHub Apps

Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.

Parameter

Headers
Name, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Name, Type, Description
`org`stringRequired The organization name. The name is not case sensitive.

HTTP-Antwortstatuscodes

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele

delete/orgs/{org}/interaction-limits

curl \
  -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