We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the Actions REST API page.
Организации
Используйте REST API для создания организаций на предприятии.
Сведения об администрировании организации
Эти конечные точки доступны только администраторам сайта, прошедшим проверку подлинности . Обычные пользователи получат 404
ответ.
Create an organization
Параметры
Заголовки |
---|
Имя, Тип, Описание |
accept stringSetting to |
Параметры запроса |
Имя, Тип, Описание |
login stringОбязательноThe organization's username. |
admin stringОбязательноThe login of the user who will manage this organization. |
profile_name stringThe organization's display name. |
Коды состояния HTTP-ответа
Код состояния | Описание |
---|---|
201 | Created |
Примеры кода
post/admin/organizations
curl \
-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://api.github.com/orgs/github",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"hooks_url": "https://api.github.com/orgs/github/hooks",
"issues_url": "https://api.github.com/orgs/github/issues",
"members_url": "https://api.github.com/orgs/github/members{/member}",
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization"
}
Update an organization name
Параметры
Заголовки |
---|
Имя, Тип, Описание |
accept stringSetting to |
Параметры пути |
Имя, Тип, Описание |
org stringОбязательноThe organization name. The name is not case sensitive. |
Параметры запроса |
Имя, Тип, Описание |
login stringОбязательноThe organization's new name. |
Коды состояния HTTP-ответа
Код состояния | Описание |
---|---|
202 | Accepted |
Примеры кода
patch /admin /organizations /{org}
curl \
-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"
}