Recientemente hemos movido parte de la documentación de la API REST. Si no encuentras lo que estás buscando, puedes probar la página de la API REST Acciones.
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 para "Create an organization"
Encabezados |
---|
Nombre, Tipo, Descripción |
accept string Setting to |
Parámetros del cuerpo |
Nombre, Tipo, Descripción |
login string RequeridoThe organization's username. |
admin string RequeridoThe login of the user who will manage this organization. |
profile_name string The organization's display name. |
Códigos de estado de respuesta HTTP para "Create an organization"
status code | Descripción |
---|---|
201 | Created |
Ejemplos de código para "Create an organization"
post/admin/organizations
curl -L \
-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://HOSTNAME/orgs/github",
"repos_url": "https://HOSTNAME/orgs/github/repos",
"events_url": "https://HOSTNAME/orgs/github/events",
"hooks_url": "https://HOSTNAME/orgs/github/hooks",
"issues_url": "https://HOSTNAME/orgs/github/issues",
"members_url": "https://HOSTNAME/orgs/github/members{/member}",
"public_members_url": "https://HOSTNAME/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 para "Update an organization name"
Encabezados |
---|
Nombre, Tipo, Descripción |
accept string Setting to |
Parámetros de la ruta de acceso |
Nombre, Tipo, Descripción |
org string RequeridoThe organization name. The name is not case sensitive. |
Parámetros del cuerpo |
Nombre, Tipo, Descripción |
login string RequeridoThe organization's new name. |
Códigos de estado de respuesta HTTP para "Update an organization name"
status code | Descripción |
---|---|
202 | Accepted |
Ejemplos de código para "Update an organization name"
patch /admin /organizations /{org}
curl -L \
-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"
}