适用于企业组织的 REST API 终结点

关于组织管理

这些终结点仅适用于经过身份验证的网站管理员。普通用户将收到 404 响应。

这些终结点仅支持使用 personal access token (classic) 进行身份验证。有关详细信息，请参阅“管理个人访问令牌”。

Create an organization

“Create an organization”的细粒度访问令牌

此终结点不适用于 GitHub 应用程序用户访问令牌、GitHub 应用程序安装访问令牌或细粒度个人访问令牌。

“Create an organization”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

正文参数
名称, 类型, 说明
`login` string 必须 The organization's username.
`admin` string 必须 The login of the user who will manage this organization.
`profile_name` string The organization's display name.

“Create an organization”的 HTTP 响应状态代码

状态代码	说明
`201`	Created

“Create an organization”的示例代码

请求示例

post/admin/organizations

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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

“Update an organization name”的细粒度访问令牌

此终结点不适用于 GitHub 应用程序用户访问令牌、GitHub 应用程序安装访问令牌或细粒度个人访问令牌。

“Update an organization name”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`org` string 必须 The organization name. The name is not case sensitive.

正文参数
名称, 类型, 说明
`login` string 必须 The organization's new name.

“Update an organization name”的 HTTP 响应状态代码

状态代码	说明
`202`	Accepted

“Update an organization name”的示例代码

请求示例

patch/admin/organizations/{org}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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"
}