Skip to main content
Die REST-API verfügt jetzt über eine Versionskontrolle. Weitere Informationen findest du unter Informationen zur API-Versionsverwaltung.

REST-API-Endpunkte für Interaktionen in der Organisation

Verwende die REST-API, um vorübergehend einzuschränken, welcher Benutzertyp in den öffentlichen Repositorys der Organisation Kommentare eingeben, Issues eröffnen oder Pull Requests erstellen darf.

Informationen zu Organisationsinteraktionen

Organisationsbesitzer können vorübergehend einschränken, welcher Benutzertyp in den öffentlichen Repositorys der Organisation Kommentare eingeben, Issues eröffnen oder Pull Requests erstellen darf. Wenn Einschränkungen aktiviert sind, kann nur der angegebene Typ von GitHub Enterprise Cloud-Benutzer an Interaktionen teilnehmen. Einschränkungen laufen nach einem definierten Zeitraum automatisch ab. Hier findest du weitere Informationen zu den Typen von GitHub Enterprise Cloud-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

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.

Differenzierte Zugriffstoken für "Get interaction restrictions for an organization"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

  • "Administration" organization permissions (read)

Parameter für „Get interaction restrictions for an organization“

Header
Name, type, BESCHREIBUNG
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
org string Erforderlich

The organization name. The name is not case sensitive.

HTTP-Antwortstatuscodes für „Get interaction restrictions for an organization“

StatuscodeBESCHREIBUNG
200

OK

Codebeispiele für „Get interaction restrictions for an organization“

Wenn du unter GHE.com auf GitHub zugreifst, ersetze api.github.com unter api.SUBDOMAIN.ghe.com mit der dedizierten Unterdomäne deines Unternehmens.

Anforderungsbeispiel

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

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.

Differenzierte Zugriffstoken für "Set interaction restrictions for an organization"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

  • "Administration" organization permissions (write)

Parameter für „Set interaction restrictions for an organization“

Header
Name, type, BESCHREIBUNG
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
org string Erforderlich

The organization name. The name is not case sensitive.

Textparameter
Name, type, BESCHREIBUNG
limit string Erforderlich

The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.

Kann eine der Folgenden sein: existing_users, contributors_only, collaborators_only

expiry string

The duration of the interaction restriction. Default: one_day.

Kann eine der Folgenden sein: one_day, three_days, one_week, one_month, six_months

HTTP-Antwortstatuscodes für „Set interaction restrictions for an organization“

StatuscodeBESCHREIBUNG
200

OK

422

Validation failed, or the endpoint has been spammed.

Codebeispiele für „Set interaction restrictions for an organization“

Wenn du unter GHE.com auf GitHub zugreifst, ersetze api.github.com unter api.SUBDOMAIN.ghe.com mit der dedizierten Unterdomäne deines Unternehmens.

Anforderungsbeispiel

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

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

Differenzierte Zugriffstoken für "Remove interaction restrictions for an organization"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

  • "Administration" organization permissions (write)

Parameter für „Remove interaction restrictions for an organization“

Header
Name, type, BESCHREIBUNG
accept string

Setting to application/vnd.github+json is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
org string Erforderlich

The organization name. The name is not case sensitive.

HTTP-Antwortstatuscodes für „Remove interaction restrictions for an organization“

StatuscodeBESCHREIBUNG
204

No Content

Codebeispiele für „Remove interaction restrictions for an organization“

Wenn du unter GHE.com auf GitHub zugreifst, ersetze api.github.com unter api.SUBDOMAIN.ghe.com mit der dedizierten Unterdomäne deines Unternehmens.

Anforderungsbeispiel

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