Points de terminaison d’API REST pour la synchronisation d’équipe

À propos de la synchronisation d’équipe

Pour utiliser ces points de terminaison, l’utilisateur authentifié doit être un responsable d’équipe ou un propriétaire de l’organisation associée à l’équipe. Le jeton que vous utilisez pour l’authentification doit également être autorisé à être utilisé avec votre fournisseur d’identité (SSO). Pour plus d’informations, consultez « Autorisation d’un jeton d’accès personnel à utiliser avec l’authentification unique SAML ».

Vous pouvez gérer les membres de l’équipe GitHub Enterprise Cloud via votre fournisseur d’identité avec la synchronisation d’équipe. La synchronisation d’équipe doit être activée pour utiliser ces points de terminaison. Pour plus d’informations, consultez « Gestion de la synchronisation des équipes pour votre organisation ».

Remarque : Ces points de terminaison ne peuvent pas être utilisés avec Enterprise Managed Users. Pour en savoir plus sur la gestion d’une organisation avec utilisateurs managés, consultez « Points de terminaison d’API REST pour les groupes externes ».

List IdP groups for an organization

Lists IdP groups available in an organization.

Jetons d’accès affinés pour « List IdP groups for an organization »

Ce point de terminaison fonctionne avec les types de jetons suivants:

Le jeton doit avoir l’ensemble d’autorisations suivant:

members:write

Paramètres pour « List IdP groups for an organization »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`org` string Obligatoire The organization name. The name is not case sensitive.

Paramètres de requête
Nom, Type, Description
`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".

Codes d’état de la réponse HTTP pour « List IdP groups for an organization »

Code d’état	Description
`200`	OK

Exemples de code pour « List IdP groups for an organization »

Exemple de requête

get/orgs/{org}/team-sync/groups

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/orgs/ORG/team-sync/groups

Response

Status: 200

{
  "groups": [
    {
      "group_id": "123",
      "group_name": "Octocat admins",
      "group_description": "The people who configure your octoworld."
    },
    {
      "group_id": "456",
      "group_name": "Octocat docs members",
      "group_description": "The people who make your octoworld come to life."
    }
  ]
}

List IdP groups for a team

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.

Paramètres pour « List IdP groups for a team »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`org` string Obligatoire The organization name. The name is not case sensitive.
`team_slug` string Obligatoire The slug of the team name.

Codes d’état de la réponse HTTP pour « List IdP groups for a team »

Code d’état	Description
`200`	OK

Exemples de code pour « List IdP groups for a team »

Exemple de requête

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

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/orgs/ORG/teams/TEAM_SLUG/team-sync/group-mappings

Response

Status: 200

{
  "groups": [
    {
      "group_id": "123",
      "group_name": "Octocat admins",
      "group_description": "The people who configure your octoworld."
    },
    {
      "group_id": "456",
      "group_name": "Octocat docs members",
      "group_description": "The people who make your octoworld come to life."
    }
  ]
}

Create or update IdP group connections

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.

Paramètres pour « Create or update IdP group connections »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`org` string Obligatoire The organization name. The name is not case sensitive.
`team_slug` string Obligatoire The slug of the team name.

Nom, Type, Description

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.

Properties of groups

Nom, Type, Description
`group_id` string Obligatoire ID of the IdP group.
`group_name` string Obligatoire Name of the IdP group.
`group_description` string Obligatoire Description of the IdP group.

Codes d’état de la réponse HTTP pour « Create or update IdP group connections »

Code d’état	Description
`200`	OK

Exemples de code pour « Create or update IdP group connections »

Exemple de requête

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

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/orgs/ORG/teams/TEAM_SLUG/team-sync/group-mappings \
  -d '{"groups":[{"group_id":"123","group_name":"Octocat admins","group_description":"string"}]}'

Response

Status: 200

{
  "groups": [
    {
      "group_id": "123",
      "group_name": "Octocat admins",
      "group_description": "The people who configure your octoworld."
    },
    {
      "group_id": "456",
      "group_name": "Octocat docs members",
      "group_description": "The people who make your octoworld come to life."
    }
  ]
}

List IdP groups for a team (Legacy)

Deprecation Notice: This endpoint route is deprecated 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.

Paramètres pour « List IdP groups for a team (Legacy) »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`team_id` integer Obligatoire The unique identifier of the team.

Codes d’état de la réponse HTTP pour « List IdP groups for a team (Legacy) »

Code d’état	Description
`200`	OK
`403`	Forbidden
`404`	Resource not found

Exemples de code pour « List IdP groups for a team (Legacy) »

Exemple de requête

get/teams/{team_id}/team-sync/group-mappings

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/teams/TEAM_ID/team-sync/group-mappings

Response

Status: 200

{
  "groups": [
    {
      "group_id": "123",
      "group_name": "Octocat admins",
      "group_description": "The people who configure your octoworld."
    },
    {
      "group_id": "456",
      "group_name": "Octocat docs members",
      "group_description": "The people who make your octoworld come to life."
    }
  ]
}

Create or update IdP group connections (Legacy)

Deprecation Notice: This endpoint route is deprecated 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.

Paramètres pour « Create or update IdP group connections (Legacy) »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`team_id` integer Obligatoire The unique identifier of the team.

Nom, Type, Description

groups array of objects Obligatoire

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.

Properties of groups

Nom, Type, Description
`group_id` string Obligatoire ID of the IdP group.
`group_name` string Obligatoire Name of the IdP group.
`group_description` string Obligatoire Description of the IdP group.
`id` string
`name` string
`description` string

synced_at string

Codes d’état de la réponse HTTP pour « Create or update IdP group connections (Legacy) »

Code d’état	Description
`200`	OK
`403`	Forbidden
`422`	Validation failed, or the endpoint has been spammed.

Exemples de code pour « Create or update IdP group connections (Legacy) »

Exemple de requête

patch/teams/{team_id}/team-sync/group-mappings

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/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

Status: 200

{
  "groups": [
    {
      "group_id": "123",
      "group_name": "Octocat admins",
      "group_description": "The people who configure your octoworld."
    }
  ]
}