REST-API-Endpunkte für Unternehmensorganisationen

Informationen zur Organisationsverwaltung

Diese Endpunkte sind nur für authentifizierte Websiteadministratoren verfügbar. Normale Benutzer erhalten eine 404-Antwort.

Create an organization

Parameter für „Create an organization“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Textparameter
Name, type, BESCHREIBUNG
`login` string Erforderlich The organization's username.
`admin` string Erforderlich The login of the user who will manage this organization.
`profile_name` string The organization's display name.

HTTP-Antwortstatuscodes für „Create an organization“

Statuscode	BESCHREIBUNG
`201`	Created

Codebeispiele für „Create an organization“

Beispiel für eine Anfrage

post/admin/organizations

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/organizations \
  -d '{"login":"github","profile_name":"GitHub, Inc.","admin":"monalisaoctocat"}'

Response

Status: 201

{
  "login": "github",
  "id": 1,
  "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
  "url": "https://HOSTNAME/orgs/github",
  "repos_url": "https://HOSTNAME/orgs/github/repos",
  "events_url": "https://HOSTNAME/orgs/github/events",
  "hooks_url": "https://HOSTNAME/orgs/github/hooks",
  "issues_url": "https://HOSTNAME/orgs/github/issues",
  "members_url": "https://HOSTNAME/orgs/github/members{/member}",
  "public_members_url": "https://HOSTNAME/orgs/github/public_members{/member}",
  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
  "description": "A great organization"
}

Update an organization name

Parameter für „Update an organization name“

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
`login` string Erforderlich The organization's new name.

HTTP-Antwortstatuscodes für „Update an organization name“

Statuscode	BESCHREIBUNG
`202`	Accepted

Codebeispiele für „Update an organization name“

Beispiel für eine Anfrage

patch/admin/organizations/{org}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/organizations/ORG \
  -d '{"login":"the-new-octocats"}'

Response

Status: 202

{
  "message": "Job queued to rename organization. It may take a few minutes to complete.",
  "url": "https://<hostname>/api/v3/organizations/1"
}