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
Parameters
Headers |
---|
名称, Type, 说明 |
accept stringSetting to |
Body parameters |
名称, Type, 说明 |
login stringRequiredThe organization's username. |
admin stringRequiredThe login of the user who will manage this organization. |
profile_name stringThe organization's display name. |
HTTP response status codes
Status code | 说明 |
---|---|
201 | Created |
Code samples
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
Parameters
Headers |
---|
名称, Type, 说明 |
accept stringSetting to |
Path parameters |
名称, Type, 说明 |
org stringRequiredThe organization name. The name is not case sensitive. |
Body parameters |
名称, Type, 说明 |
login stringRequiredThe organization's new name. |
HTTP response status codes
Status code | 说明 |
---|---|
202 | Accepted |
Code samples
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"
}