Organizaciones

La API de Administración Organizacional te permite crear organizaciones en tu empresa.

Solo se encuentra disponible para los administradores de sitio autenticados. Los usuarios normales recibirán una respuesta 404 si intentan acceder a ella.

Create an organization

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de cuerpo
Nombre, Tipo, Descripción
`login`stringRequerido The organization's username.
`admin`stringRequerido The login of the user who will manage this organization.
`profile_name`string The organization's display name.

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`201`	Created

Ejemplos de código

post/admin/organizations

curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <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

Parámetros

Encabezados
Nombre, Tipo, Descripción
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Parámetros de ruta
Nombre, Tipo, Descripción
`org`stringRequerido The organization name. The name is not case sensitive.
Parámetros de cuerpo
Nombre, Tipo, Descripción
`login`stringRequerido The organization's new name.

Códigos de estado de respuesta HTTP

Código de estado	Descripción
`202`	Accepted

Ejemplos de código

patch/admin/organizations/{org}

curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <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"
}