# 用于团队同步的 REST API 终结点

使用 REST API 管理 GitHub 团队与外部身份提供商 (IdP) 组之间的连接。

## 关于团队同步

要使用这些终结点，经过身份验证的用户必须是团队维护员或与团队关联的组织所有者。 用于身份验证的令牌还需要获得授权才能与 IdP (SSO) 提供程序一起使用。 有关详细信息，请参阅“[授权个人访问令牌以与单点登录一起使用](/zh/enterprise-cloud@latest/authentication/authenticating-with-single-sign-on/authorizing-a-personal-access-token-for-use-with-single-sign-on)”。

您可以借助团队同步功能，通过您的 IdP 管理 GitHub 团队成员。 必须启用团队同步才能使用这些终结点。 有关详细信息，请参阅“[管理组织中的团队同步](/zh/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization)”。

> \[!NOTE]
> 这些终结点不能与 Enterprise Managed Users 一起使用。 若要详细了解如何管理 具有托管用户的组织，请参阅 [外部组的 REST API 终结点](/zh/enterprise-cloud@latest/rest/teams/external-groups)。

> \[!NOTE]
> Most endpoints use `Authorization: Bearer <YOUR-TOKEN>` and `Accept: application/vnd.github+json` headers, plus `X-GitHub-Api-Version: 2026-03-10`. Curl examples below omit these standard headers for brevity.

## List IdP groups for an organization

```
GET /orgs/{org}/team-sync/groups
```

Lists IdP groups available in an organization.

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`org`** (string) (required)
  The organization name. The name is not case sensitive.

* **`per_page`** (integer)
  The number of results per page (max 100). For more information, see "Using pagination in the REST API."
  Default: `30`

* **`page`** (string)
  Page token

* **`q`** (string)
  Filters the results to return only those that begin with the value specified by this parameter. For example, a value of ab will return results that begin with "ab".

### HTTP response status codes

* **200** - OK

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/orgs/ORG/team-sync/groups
```

**Response schema (Status: 200):**

* `groups`: array of objects:
  * `group_id`: required, string
  * `group_name`: required, string
  * `group_description`: required, string
  * `status`: string
  * `synced_at`: string or null

## List IdP groups for a team

```
GET /orgs/{org}/teams/{team_slug}/team-sync/group-mappings
```

List IdP groups connected to a team on GitHub Enterprise Cloud.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
Note

You can also specify a team by org\_id and team\_id using the route GET /organizations/{org\_id}/team/{team\_id}/team-sync/group-mappings.

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`org`** (string) (required)
  The organization name. The name is not case sensitive.

* **`team_slug`** (string) (required)
  The slug of the team name.

### HTTP response status codes

* **200** - OK

* **422** - Unprocessable entity if you attempt to modify an enterprise team at the organization level.

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/team-sync/group-mappings
```

**Response schema (Status: 200):**

Same response schema as [List IdP groups for an organization](#list-idp-groups-for-an-organization).

## Create or update IdP group connections

```
PATCH /orgs/{org}/teams/{team_slug}/team-sync/group-mappings
```

Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
Note

You can also specify a team by org\_id and team\_id using the route PATCH /organizations/{org\_id}/team/{team\_id}/team-sync/group-mappings.

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`org`** (string) (required)
  The organization name. The name is not case sensitive.

* **`team_slug`** (string) (required)
  The slug of the team name.

#### Body parameters

* **`groups`** (array of objects)
  The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.
  * **`group_id`** (string) (required)
    ID of the IdP group.
  * **`group_name`** (string) (required)
    Name of the IdP group.
  * **`group_description`** (string) (required)
    Description of the IdP group.

### HTTP response status codes

* **200** - OK

* **422** - Unprocessable entity if you attempt to modify an enterprise team at the organization level.

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X PATCH \
  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/team-sync/group-mappings \
  -d '{
  "groups": [
    {
      "group_id": "123",
      "group_name": "Octocat admins",
      "group_description": "string"
    }
  ]
}'
```

**Response schema (Status: 200):**

Same response schema as [List IdP groups for an organization](#list-idp-groups-for-an-organization).

## List IdP groups for a team (Legacy)

```
GET /teams/{team_id}/team-sync/group-mappings
```

Warning

Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List IdP groups for a team endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
List IdP groups connected to a team on GitHub Enterprise Cloud.

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`team_id`** (integer) (required)
  The unique identifier of the team.

### HTTP response status codes

* **200** - OK

* **403** - Forbidden

* **404** - Resource not found

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/teams/TEAM_ID/team-sync/group-mappings
```

**Response schema (Status: 200):**

Same response schema as [List IdP groups for an organization](#list-idp-groups-for-an-organization).

## Create or update IdP group connections (Legacy)

```
PATCH /teams/{team_id}/team-sync/group-mappings
```

Warning

Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create or update IdP group connections endpoint.

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`team_id`** (integer) (required)
  The unique identifier of the team.

#### Body parameters

* **`groups`** (array of objects) (required)
  The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.
  * **`group_id`** (string) (required)
    ID of the IdP group.
  * **`group_name`** (string) (required)
    Name of the IdP group.
  * **`group_description`** (string) (required)
    Description of the IdP group.
  * **`id`** (string)
  * **`name`** (string)
  * **`description`** (string)

* **`synced_at`** (string)

### HTTP response status codes

* **200** - OK

* **403** - Forbidden

* **422** - Validation failed, or the endpoint has been spammed.

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X PATCH \
  https://api.github.com/teams/TEAM_ID/team-sync/group-mappings \
  -d '{
  "groups": [
    {
      "group_id": "123",
      "group_name": "Octocat admins",
      "description": "The people who configure your octoworld.",
      "group_description": "string"
    }
  ]
}'
```

**Response schema (Status: 200):**

Same response schema as [List IdP groups for an organization](#list-idp-groups-for-an-organization).