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.
Las organizaciones
Usa la API REST para crear organizaciones en la empresa.
Acerca de la administración de la organización
Estos puntos de conexión solo están disponibles para los administradores de sitios autenticados. Los usuarios normales recibirán una respuesta 404
.
Create an organization
Parámetros
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros del cuerpo |
Nombre, Tipo, Descripción |
login stringRequeridoThe organization's username. |
admin stringRequeridoThe login of the user who will manage this organization. |
profile_name stringThe organization's display name. |
Códigos de estado de respuesta HTTP
status code | Descripción |
---|---|
201 | Created |
Ejemplos de código
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
Parámetros
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de la ruta de acceso |
Nombre, Tipo, Descripción |
org stringRequeridoThe organization name. The name is not case sensitive. |
Parámetros del cuerpo |
Nombre, Tipo, Descripción |
login stringRequeridoThe organization's new name. |
Códigos de estado de respuesta HTTP
status code | Descripción |
---|---|
202 | Accepted |
Ejemplos de código
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"
}