Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

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.

Organisations

Utilisez l’API REST pour créer des organisations sur votre entreprise.

À propos de l’administration de l’organisation

Ces points de terminaison sont uniquement disponibles pour les administrateurs de site authentifiés. Les utilisateurs normaux recevront une réponse 404.

Create an organization

Parameters

Headers
Nom, Type, Description
acceptstring

Setting to application/vnd.github+json is recommended.

Body parameters
Nom, Type, Description
loginstringRequired

The organization's username.

adminstringRequired

The login of the user who will manage this organization.

profile_namestring

The organization's display name.

HTTP response status codes

Status codeDescription
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
Nom, Type, Description
acceptstring

Setting to application/vnd.github+json is recommended.

Path parameters
Nom, Type, Description
orgstringRequired

The organization name. The name is not case sensitive.

Body parameters
Nom, Type, Description
loginstringRequired

The organization's new name.

HTTP response status codes

Status codeDescription
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" }