Teams

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

所有 GitHub 文档都是开源的。 看到错误或不清楚的内容了吗？ 提交拉取请求。

帮助我们创建出色的文档！

操作

输入搜索词以在 GitHub 文档中找到它。

Teams - GitHub AE Docs

使用 REST API 在 GitHub AE 组织中创建和管理团队。

快速入门

比较 GitHub 的 API

REST API 中的资源

Rate limits

媒体类型

身份验证

确保 API 凭据安全

故障排除

Libraries

议题事件类型

GitHub 事件类型

适用于 GitHub Apps 安装令牌的终结点

适用于 GitHub Apps 用户令牌的终结点

GitHub 应用的权限

概述

使用 API

使用 JavaScript 编写脚本

使用 Ruby 编写脚本

为用户发现资源

交付部署

将数据渲染为图形

处理注释

分页

构建 CI 服务器

最佳实践

入门 - Git 数据库

开始 - 检查

加密机密

Guides

Artifacts

权限

机密

自托管运行器组

自托管运行程序

工作流程作业

工作流运行

工作流

事件

通知

标星

关注中

活动

GitHub 应用

安装

OAuth 授权

Webhook

应用

分支

受保护的分支

检查运行

检查套件

检查

代码扫描

行为准则

协作者

邀请

提交

提交注释

提交状态

部署密钥

部署分支策略

部署

环境

部署状态

表情符号

管理统计

公告

审核日志

全局 Webhook

许可证

组织

预接收环境

用户

企业管理

Gists

注释

Blob

reference

标记

Trees

Git 数据库

Gitignore

问题

受理人

里程碑

时间线

Markdown

元数据

统计信息

指标

迁移

成员

外部协作者

Boards

卡片

Project boards

拉取

评价注释

审查请求

审阅

速率限制

反应

发行版本

发布资产

自动链接

前叉

Git LFS

存储库

搜索

机密扫描

讨论评论

讨论

外部组

关注者

GPG 密钥

Git SSH 密钥

Justice League

Groups of organization members that gives permissions on specified repositories.

Team

Lists all teams in an organization that are visible to the authenticated user.

The organization name. The name is not case sensitive.

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

List teams

name

description

List GitHub IDs for organization members who will become team maintainers.

maintainers

The full name (e.g., "organization-name/repository-name") of repositories to add the team to.

repo_names

The level of privacy this team should have. The options are: 
For a non-nested team:
<ul>
<li><code>secret</code> - only visible to organization owners and members of this team.</li>
<li><code>closed</code> - visible to all members of this organization. 
Default: <code>secret</code> 
For a parent or child team:</li>
<li><code>closed</code> - visible to all members of this organization. 
Default for child team: <code>closed</code></li>
</ul>

privacy

The notification setting the team has chosen. The options are:
<ul>
<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned.</li>
<li><code>notifications_disabled</code> - no one receives notifications. 
Default: <code>notifications_enabled</code></li>
</ul>

notification_setting

Deprecated. The permission that new repositories will be added to the team with when none is specified.

permission

The ID of a team to set as the parent team.

parent_team_id

github

Distinguished Name (DN) that team maps to within LDAP environment

The notification setting the team has set

Team Organization

Permission that the team will have for its repositories

The level of privacy this team should have

Full Team

To create a team, the authenticated user must be a member or owner of <code>{org}</code>. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "<a href="https://docs.github.com/github-ae@latest/articles/setting-team-creation-permissions-in-your-organization">Setting team creation permissions</a>."
When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of <code>maintainers</code>. For more information, see "<a href="https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/about-teams">About teams</a>".

Validation failed, or the endpoint has been spammed.

Create a team

Gets a team using the team's <code>slug</code>. To create the <code>slug</code>, GitHub AE replaces special characters in the <code>name</code> string, changes all words to lowercase, and replaces spaces with a <code>-</code> separator. For example, <code>"My TEam Näme"</code> would become <code>my-team-name</code>.
Note: You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}</code>.

team_slug

Get a team by name

The level of privacy this team should have. Editing teams without specifying this parameter leaves <code>privacy</code> intact. When a team is nested, the <code>privacy</code> for parent teams cannot be <code>secret</code>. The options are: 
For a non-nested team:
<ul>
<li><code>secret</code> - only visible to organization owners and members of this team.</li>
<li><code>closed</code> - visible to all members of this organization. 
For a parent or child team:</li>
<li><code>closed</code> - visible to all members of this organization.</li>
</ul>

The notification setting the team has chosen. Editing teams without specifying this parameter leaves <code>notification_setting</code> intact. The options are:
<ul>
<li><code>notifications_enabled</code> - team members receive notifications when the team is @mentioned.</li>
<li><code>notifications_disabled</code> - no one receives notifications.</li>
</ul>

new team name

Response when the updated information already exists

To edit a team, the authenticated user must either be an organization owner or a team maintainer.
Note: You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>PATCH /organizations/{org_id}/team/{team_id}</code>.

Update a team

To delete a team, the authenticated user must be an organization owner or team maintainer.
If you are an organization owner, deleting a parent team will delete all of its child teams as well.
Note: You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}</code>.

Delete a team

High-level roadmap for the upcoming year.

Organization Roadmap

Team Project

Lists the organization projects for a team.
Note: You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/projects</code>.

List team projects

Simple User

The organization permission for this project. Only present when owner is an organization.

Whether the project is private or not. Only present when owner is an organization.

Checks whether a team has <code>read</code>, <code>write</code>, or <code>admin</code> permissions for an organization project. The response includes projects inherited from a parent team.
Note: You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/projects/{project_id}</code>.

The unique identifier of the project.

project_id

Not Found if project is not managed by this team

Check team permissions for a project

The permission to grant to the team for this project. Default: the team's <code>permission</code> attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling this endpoint. For more information, see "<a href="https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs">HTTP verbs</a>."

Updates the permissions for the team to write for the project

Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have <code>admin</code> permissions for the project. The project and team must be part of the same organization.
Note: You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}</code>.

Forbidden if the project is not owned by the organization

Add or update team project permissions

Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have <code>read</code> access to both the team and project, or <code>admin</code> access to the team or project. This endpoint removes the project from the team, but does not delete the project.
Note: You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}</code>.

Remove a project from a team

https://web.archive.org/web/20231125111709/https://api.github.com/repos/octocat/Hello-World/contents/{+path}

Hello-World

Lists a team's repositories visible to the authenticated user.
Note: You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/repos</code>.

List team repositories