Organizações

Use a API REST para criar organizações em sua empresa.

Sobre a administração de organização

Esses pontos de extremidade só estão disponíveis para administradores de site autenticados. Os usuários normais receberão uma resposta 404.

Create an organization

Parâmetros para "Create an organization"

Cabeçalhos
Name, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.
Parâmetros do corpo
Name, Tipo, Descrição
`login` string Obrigatório The organization's username.
`admin` string Obrigatório The login of the user who will manage this organization.
`profile_name` string The organization's display name.

Códigos de status de resposta HTTP para "Create an organization"

Código de status	Descrição
`201`	Created

Exemplos 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"

Cabeçalhos
Name, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.
Parâmetros de caminho
Name, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
Parâmetros do corpo
Name, Tipo, Descrição
`login` string Obrigatório The organization's new name.

Códigos de status de resposta HTTP para "Update an organization name"

Código de status	Descrição
`202`	Accepted

Exemplos 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"
}