适用于企业团队成员的 REST API 终结点

关于企业团队

注意

这些终结点目前为公共预览版，可能会更改。

此 API 文档适用于使用 GitHub Enterprise Cloud 的企业。

如果你的企业使用的是面向非 GHE 的 Copilot Business，请参考此前已向你共享的早期访问文档链接。

这些终结点仅对拥有经典 personal access tokens 且具备 read:enterprisescope 权限（针对 GET API）和 admin:enterprise 权限（针对其他 API）的企业团队中经过身份验证的成员开放。

这些终结点与 fine-grained personal access tokens 或 GitHub Apps 访问令牌不兼容。

GitHub 会从团队 name 生成企业团队的 slug，并添加 ent: 前缀。

List enterprise teams

List all teams in the enterprise for the authenticated user

“List enterprise teams”的细粒度访问令牌

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

“List enterprise teams”的参数

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

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name.

查询参数
名称, 类型, 说明
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 默认: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 默认: `1`

“List enterprise teams”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`403`	Forbidden

“List enterprise teams”的示例代码

请求示例

get/enterprises/{enterprise}/teams

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/teams

Response

Status: 200

[
  {
    "id": 1,
    "name": "Justice League",
    "description": "A great team.",
    "slug": "justice-league",
    "url": "https://api.github.com/enterprises/dc/teams/justice-league",
    "group_id": "62ab9291-fae2-468e-974b-7e45096d5021",
    "html_url": "https://github.com/enterprises/dc/teams/justice-league",
    "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}",
    "created_at": "2019-01-26T19:01:12Z",
    "updated_at": "2019-01-26T19:14:43Z"
  }
]

Create an enterprise team

To create an enterprise team, the authenticated user must be an owner of the enterprise.

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

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

“Create an enterprise team”的参数

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

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name.

正文参数
名称, 类型, 说明
`name` string 必须 The name of the team.
`description` string or null A description of the team.
`sync_to_organizations` string Retired: this field is no longer supported. Whether the enterprise team should be reflected in each organization. This value cannot be set. 默认: `disabled` 可以是以下选项之一: `all`, `disabled`
`organization_selection_type` string Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. `selected`: The team is assigned to specific organizations. You can then use the add organization assignments API endpoint. `all`: The team is assigned to all current and future organizations in the enterprise. 默认: `disabled` 可以是以下选项之一: `disabled`, `selected`, `all`
`group_id` string or null The ID of the IdP group to assign team membership with. You can get this value from the REST API endpoints for SCIM.

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

状态代码	说明
`201`	Created

“Create an enterprise team”的示例代码

请求示例

post/enterprises/{enterprise}/teams

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/teams \
  -d '{"name":"Justice League","description":"A great team.","group_id":"62ab9291-fae2-468e-974b-7e45096d5021"}'

Response

Status: 201

[
  {
    "id": 1,
    "name": "Justice League",
    "description": "A great team.",
    "slug": "justice-league",
    "url": "https://api.github.com/enterprises/dc/teams/justice-league",
    "group_id": "62ab9291-fae2-468e-974b-7e45096d5021",
    "html_url": "https://github.com/enterprises/dc/teams/justice-league",
    "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}",
    "created_at": "2019-01-26T19:01:12Z",
    "updated_at": "2019-01-26T19:14:43Z"
  }
]

Get an enterprise team

Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a - separator and adds the "ent:" prefix. For example, "My TEam Näme" would become ent:my-team-name.

“Get an enterprise team”的细粒度访问令牌

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

“Get an enterprise team”的参数

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

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name.
`team_slug` string 必须 The slug of the team name.

“Get an enterprise team”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`403`	Forbidden

“Get an enterprise team”的示例代码

请求示例

get/enterprises/{enterprise}/teams/{team_slug}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/teams/TEAM_SLUG

Response

Status: 200

[
  {
    "id": 1,
    "name": "Justice League",
    "description": "A great team.",
    "slug": "justice-league",
    "url": "https://api.github.com/enterprises/dc/teams/justice-league",
    "group_id": "62ab9291-fae2-468e-974b-7e45096d5021",
    "html_url": "https://github.com/enterprises/dc/teams/justice-league",
    "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}",
    "created_at": "2019-01-26T19:01:12Z",
    "updated_at": "2019-01-26T19:14:43Z"
  }
]

Update an enterprise team

To edit a team, the authenticated user must be an enterprise owner.

“Update an enterprise team”的细粒度访问令牌

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

“Update an enterprise team”的参数

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

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name.
`team_slug` string 必须 The slug of the team name.

正文参数
名称, 类型, 说明
`name` string or null A new name for the team.
`description` string or null A new description for the team.
`sync_to_organizations` string Retired: this field is no longer supported. Whether the enterprise team should be reflected in each organization. This value cannot be changed. 默认: `disabled` 可以是以下选项之一: `all`, `disabled`
`organization_selection_type` string Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. `selected`: The team is assigned to specific organizations. You can then use the add organization assignments API. `all`: The team is assigned to all current and future organizations in the enterprise. 默认: `disabled` 可以是以下选项之一: `disabled`, `selected`, `all`
`group_id` string or null The ID of the IdP group to assign team membership with. The new IdP group will replace the existing one, or replace existing direct members if the team isn't currently linked to an IdP group.

“Update an enterprise team”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`403`	Forbidden

“Update an enterprise team”的示例代码

请求示例

patch/enterprises/{enterprise}/teams/{team_slug}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/teams/TEAM_SLUG \
  -d '{"name":"Justice League","description":"A great team.","group_id":"62ab9291-fae2-468e-974b-7e45096d5021"}'

Response

Status: 200

[
  {
    "id": 1,
    "name": "Justice League",
    "description": "A great team.",
    "slug": "justice-league",
    "url": "https://api.github.com/enterprises/dc/teams/justice-league",
    "group_id": "62ab9291-fae2-468e-974b-7e45096d5021",
    "html_url": "https://github.com/enterprises/dc/teams/justice-league",
    "members_url": "https://api.github.com/enterprises/dc/teams/justice-league/members{/member}",
    "created_at": "2019-01-26T19:01:12Z",
    "updated_at": "2019-01-26T19:14:43Z"
  }
]

Delete an enterprise team

To delete an enterprise team, the authenticated user must be an enterprise owner.

If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well.

“Delete an enterprise team”的细粒度访问令牌

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

“Delete an enterprise team”的参数

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

路径参数
名称, 类型, 说明
`enterprise` string 必须 The slug version of the enterprise name.
`team_slug` string 必须 The slug of the team name.

“Delete an enterprise team”的 HTTP 响应状态代码

状态代码	说明
`204`	No Content
`403`	Forbidden

“Delete an enterprise team”的示例代码

请求示例

delete/enterprises/{enterprise}/teams/{team_slug}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/teams/TEAM_SLUG

Response

Status: 204