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
Use the REST API to create organizations on your enterprise.
About organization administration
These endpoints are only available to authenticated site administrators. Normal users will receive a 404
response.
Create an organization
Parameters for "Create an organization"
Name, Type, Description |
---|
accept string Setting to |
Name, Type, Description |
---|
login string RequiredThe organization's username. |
admin string RequiredThe login of the user who will manage this organization. |
profile_name string The organization's display name. |
HTTP response status codes for "Create an organization"
Status code | Description |
---|---|
201 | Created |
Code samples for "Create an organization"
post/admin/organizations
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://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 for "Update an organization name"
Name, Type, Description |
---|
accept string Setting to |
Name, Type, Description |
---|
org string RequiredThe organization name. The name is not case sensitive. |
Name, Type, Description |
---|
login string RequiredThe organization's new name. |
HTTP response status codes for "Update an organization name"
Status code | Description |
---|---|
202 | Accepted |
Code samples for "Update an organization name"
patch /admin /organizations /{org}
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://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"
}