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.
Organizations
The Organization Administration API allows you to create organizations on your enterprise.
It is only available to authenticated site administrators. Normal users will receive a 404
response if they try to access it.
Create an organization
Parameters
Headers |
---|
Name, Type, Description |
accept stringSetting to |
Body parameters |
Name, Type, Description |
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 | Description |
---|---|
201 | Created |
Code samples
post/admin/organizations
curl \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: token <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 |
---|
Name, Type, Description |
accept stringSetting to |
Path parameters |
Name, Type, Description |
org stringRequiredThe organization name. The name is not case sensitive. |
Body parameters |
Name, Type, Description |
login stringRequiredThe organization's new name. |
HTTP response status codes
Status code | Description |
---|---|
202 | Accepted |
Code samples
patch /admin /organizations /{org}
curl \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: token <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"
}