GitHub Groups API

The Groups API from GitHub — 11 operation(s) for groups.

Documentation

📖
Documentation
https://docs.github.com/en/rest/apps
📖
Documentation
https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/ https://docs.github.com/en/rest/authentication/authenticating-to-the-rest-api
📖
Documentation
https://docs.github.com/en/rest/codes-of-conduct/codes-of-conduct
📖
Documentation
https://docs.github.com/en/rest/emojis
📖
Documentation
https://docs.github.com/en/rest/gitignore
📖
Documentation
https://docs.github.com/en/rest/apps/installations
📖
Documentation
https://docs.github.com/en/rest/enterprise-admin
📖
Documentation
https://docs.github.com/en/rest/activity/events
📖
Documentation
https://docs.github.com/en/rest/orgs
📖
Documentation
https://docs.github.com/en/rest/rate-limit
📖
Documentation
https://docs.github.com/en/enterprise-cloud@latest/rest/scim
📖
Documentation
https://docs.github.com/en/rest/using-the-rest-api/getting-started-with-the-rest-api
📖
Documentation
https://docs.github.com/en/rest/teams
📖
Documentation
https://docs.github.com/en/rest/meta/meta
📖
Documentation
https://docs.github.com/en/rest/actions
📖
Documentation
https://docs.github.com/en/rest/branches
📖
Documentation
https://docs.github.com/en/rest/code-scanning
📖
Documentation
https://docs.github.com/en/rest/collaborators
📖
Documentation
https://docs.github.com/en/rest/dependabot
📖
Documentation
https://docs.github.com/en/rest/webhooks
📖
Documentation
https://docs.github.com/en/rest/pulls
📖
Documentation
https://docs.github.com/en/rest/git/tags
📖
Documentation
https://docs.github.com/en/rest/repos/autolinks
📖
Documentation
https://docs.github.com/en/rest/collaborators/invitations

Specifications

Other Resources

OpenAPI Specification

github-groups-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  version: 1.1.4
  title: GitHub Application About Groups API
  description: 'Use the REST API to retrieve information about GitHub Apps and GitHub App

    installations.'
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT
  termsOfService: https://docs.github.com/articles/github-terms-of-service
  contact:
    name: Support
    url: https://support.github.com/contact?tags=dotcom-rest-api
  x-github-plan: ghes
  x-github-release: 3.9
servers:
- url: '{protocol}://{hostname}/api/v3'
  variables:
    hostname:
      description: Self-hosted Enterprise Server hostname
      default: HOSTNAME
    protocol:
      description: Self-hosted Enterprise Server protocol
      default: http
tags:
- name: Groups
paths:
  /orgs/{org}/actions/runner-groups:
    get:
      summary: GitHub List Self-hosted Runner Groups for an Organization
      description: 'Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.


        OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
      operationId: listSelfhostedRunnerGroupsForAnOrganization
      tags:
      - Groups
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/per-page'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/visible-to-repository'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: object
                required:
                - total_count
                - runner_groups
                properties:
                  total_count:
                    type: number
                  runner_groups:
                    type: array
                    items:
                      $ref: '#/components/schemas/runner-groups-org'
              examples:
                default:
                  $ref: '#/components/examples/runner-groups-org'
      x-github:
        enabledForGitHubApps: true
        githubCloudOnly: true
        category: actions
        subcategory: self-hosted-runner-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      summary: GitHub Create Self-hosted Runner Group for an Organization
      description: 'Creates a new self-hosted runner group for an organization.


        OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
      operationId: createSelfhostedRunnerGroupForAnOrganization
      tags:
      - Groups
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  description: Name of the runner group.
                  type: string
                visibility:
                  description: Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.
                  type: string
                  enum:
                  - selected
                  - all
                  - private
                  default: all
                selected_repository_ids:
                  description: List of repository IDs that can access the runner group.
                  type: array
                  items:
                    type: integer
                    description: Unique identifier of the repository.
                runners:
                  description: List of runner IDs to add to the runner group.
                  type: array
                  items:
                    type: integer
                    description: Unique identifier of the runner.
                allows_public_repositories:
                  description: Whether the runner group can be used by `public` repositories.
                  type: boolean
                  default: false
                restricted_to_workflows:
                  description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.
                  type: boolean
                  default: false
                selected_workflows:
                  description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.
                  type: array
                  items:
                    type: string
                    description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.
                    example: octo-org/octo-repo/.github/workflows/deploy.yaml@main
              required:
              - name
            examples:
              default:
                value:
                  name: Expensive hardware runners
                  visibility: selected
                  selected_repository_ids:
                  - 32
                  - 91
                  runners:
                  - 9
                  - 2
      responses:
        '201':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runner-groups-org'
              examples:
                default:
                  $ref: '#/components/examples/runner-group'
      x-github:
        enabledForGitHubApps: true
        githubCloudOnly: true
        category: actions
        subcategory: self-hosted-runner-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /orgs/{org}/actions/runner-groups/{runner_group_id}:
    get:
      summary: GitHub Get Self-hosted Runner Group for an Organization
      description: 'Gets a specific self-hosted runner group for an organization.


        OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
      operationId: getSelfhostedRunnerGroupForAnOrganization
      tags:
      - Groups
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/runner-group-id'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runner-groups-org'
              examples:
                default:
                  $ref: '#/components/examples/runner-group-item'
      x-github:
        enabledForGitHubApps: true
        githubCloudOnly: true
        category: actions
        subcategory: self-hosted-runner-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      summary: GitHub Update Self-hosted Runner Group for an Organization
      description: 'Updates the `name` and `visibility` of a self-hosted runner group in an organization.


        OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
      operationId: updateSelfhostedRunnerGroupForAnOrganization
      tags:
      - Groups
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/runner-group-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  description: Name of the runner group.
                  type: string
                visibility:
                  description: Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.
                  type: string
                  enum:
                  - selected
                  - all
                  - private
                allows_public_repositories:
                  description: Whether the runner group can be used by `public` repositories.
                  type: boolean
                  default: false
                restricted_to_workflows:
                  description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.
                  type: boolean
                  default: false
                selected_workflows:
                  description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.
                  type: array
                  items:
                    type: string
                    description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.
                    example: octo-org/octo-repo/.github/workflows/deploy.yaml@main
              required:
              - name
            examples:
              default:
                value:
                  name: Expensive hardware runners
                  visibility: selected
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runner-groups-org'
              examples:
                default:
                  $ref: '#/components/examples/runner-group'
      x-github:
        enabledForGitHubApps: true
        githubCloudOnly: true
        category: actions
        subcategory: self-hosted-runner-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      summary: GitHub Delete Self-hosted Runner Group from an Organization
      description: 'Deletes a self-hosted runner group for an organization.


        OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
      operationId: deleteSelfhostedRunnerGroupFromAnOrganization
      tags:
      - Groups
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/runner-group-id'
      responses:
        '204':
          description: Response
      x-github:
        enabledForGitHubApps: true
        githubCloudOnly: true
        category: actions
        subcategory: self-hosted-runner-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories:
    get:
      summary: GitHub List Repository Access to Self-hosted Runner Group in an Organization
      description: 'Lists the repositories with access to a self-hosted runner group configured in an organization.


        OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
      operationId: listRepositoryAccessToSelfhostedRunnerGroupInAnOrganization
      tags:
      - Groups
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/runner-group-id'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/per-page'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: object
                required:
                - total_count
                - repositories
                properties:
                  total_count:
                    type: number
                  repositories:
                    type: array
                    items:
                      $ref: '#/components/schemas/minimal-repository'
              examples:
                default:
                  $ref: '#/components/examples/minimal-repository-paginated'
      x-github:
        enabledForGitHubApps: true
        githubCloudOnly: true
        category: actions
        subcategory: self-hosted-runner-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      summary: GitHub Set Repository Access for Self-hosted Runner Group in an Organization
      description: 'Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.


        OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
      operationId: setRepositoryAccessForSelfhostedRunnerGroupInAnOrganization
      tags:
      - Groups
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/runner-group-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                selected_repository_ids:
                  description: List of repository IDs that can access the runner group.
                  type: array
                  items:
                    type: integer
                    description: Unique identifier of the repository.
              required:
              - selected_repository_ids
            examples:
              default:
                value:
                  selected_repository_ids:
                  - 32
                  - 91
      responses:
        '204':
          description: Response
      x-github:
        enabledForGitHubApps: true
        githubCloudOnly: true
        category: actions
        subcategory: self-hosted-runner-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}:
    put:
      summary: GitHub Add Repository Access to Self-hosted Runner Group in an Organization
      description: 'Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)."


        OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
      operationId: addRepositoryAccessToSelfhostedRunnerGroupInAnOrganization
      tags:
      - Groups
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/runner-group-id'
      - $ref: '#/components/parameters/repository-id'
      responses:
        '204':
          description: Response
      x-github:
        enabledForGitHubApps: true
        githubCloudOnly: true
        category: actions
        subcategory: self-hosted-runner-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      summary: GitHub Remove Repository Access to Self-hosted Runner Group in an Organization
      description: 'Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)."


        OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
      operationId: removeRepositoryAccessToSelfhostedRunnerGroupInAnOrganization
      tags:
      - Groups
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/runner-group-id'
      - $ref: '#/components/parameters/repository-id'
      responses:
        '204':
          description: Response
      x-github:
        enabledForGitHubApps: true
        githubCloudOnly: true
        category: actions
        subcategory: self-hosted-runner-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /orgs/{org}/actions/runner-groups/{runner_group_id}/runners:
    get:
      summary: GitHub List Self-hosted Runners in Group for an Organization
      description: 'Lists self-hosted runners that are in a specific organization group.


        OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
      operationId: listSelfhostedRunnersInGroupForAnOrganization
      tags:
      - Groups
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/runner-group-id'
      - $ref: '#/components/parameters/per-page'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: object
                required:
                - total_count
                - runners
                properties:
                  total_count:
                    type: number
                  runners:
                    type: array
                    items:
                      $ref: '#/components/schemas/runner'
              examples:
                default:
                  $ref: '#/components/examples/runner-paginated'
          headers:
            Link:
              $ref: '#/components/headers/link'
      x-github:
        enabledForGitHubApps: true
        githubCloudOnly: true
        category: actions
        subcategory: self-hosted-runner-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      summary: GitHub Set Self-hosted Runners in Group for an Organization
      description: 'Replaces the list of self-hosted runners that are part of an organization runner group.


        OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
      operationId: setSelfhostedRunnersInGroupForAnOrganization
      tags:
      - Groups
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/runner-group-id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                runners:
                  description: List of runner IDs to add to the runner group.
                  type: array
                  items:
                    type: integer
                    description: Unique identifier of the runner.
              required:
              - runners
            examples:
              default:
                value:
                  runners:
                  - 9
                  - 2
      responses:
        '204':
          description: Response
      x-github:
        enabledForGitHubApps: true
        githubCloudOnly: true
        category: actions
        subcategory: self-hosted-runner-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}:
    put:
      summary: GitHub Add Self-hosted Runner to Group for an Organization
      description: 'Adds a self-hosted runner to a runner group configured in an organization.


        OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
      operationId: addSelfhostedRunnerToGroupForAnOrganization
      tags:
      - Groups
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/runner-group-id'
      - $ref: '#/components/parameters/runner-id'
      responses:
        '204':
          description: Response
      x-github:
        enabledForGitHubApps: true
        githubCloudOnly: true
        category: actions
        subcategory: self-hosted-runner-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      summary: GitHub Remove Self-hosted Runner from Group for an Organization
      description: 'Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.


        OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
      operationId: removeSelfhostedRunnerFromGroupForAnOrganization
      tags:
      - Groups
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/runner-group-id'
      - $ref: '#/components/parameters/runner-id'
      responses:
        '204':
          description: Response
      x-github:
        enabledForGitHubApps: true
        githubCloudOnly: true
        category: actions
        subcategory: self-hosted-runner-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /orgs/{org}/external-group/{group_id}:
    get:
      summary: GitHub Get an External Group
      description: 'Displays information about the specific group''s usage.  Provides a list of the group''s external members as well as a list of teams that this group is connected to.


        You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub''s products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation.'
      tags:
      - Groups
      operationId: getAnExternalGroup
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/teams/external-groups#get-an-external-group
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/group-id'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/external-group'
              examples:
                default:
                  $ref: '#/components/examples/external-group'
      x-github:
        githubCloudOnly: true
        enabledForGitHubApps: true
        category: teams
        subcategory: external-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /orgs/{org}/external-groups:
    get:
      summary: GitHub List External Groups in an Organization
      description: 'Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned.  You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)."


        You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub''s products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation.'
      tags:
      - Groups
      operationId: listExternalGroupsInAnOrganization
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/teams/external-groups#list-external-groups-in-an-organization
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/per-page'
      - name: page
        description: Page token
        in: query
        schema:
          type: integer
        example: 42
      - name: display_name
        description: Limits the list to groups containing the text in the group name
        in: query
        schema:
          type: string
        example: octocat
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/external-groups'
              examples:
                default:
                  $ref: '#/components/examples/external-groups'
          headers:
            Link:
              example: <https://api.github.com/resource?per_page=2&page=url-encoded-next-page-token>; rel="next"
              schema:
                type: string
      x-github:
        githubCloudOnly: true
        enabledForGitHubApps: true
        category: teams
        subcategory: external-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /orgs/{org}/teams/{team_slug}/external-groups:
    get:
      summary: GitHub List Connection Between an External Group and Team
      description: 'Lists a connection between a team and an external group.


        You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub''s products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation.'
      tags:
      - Groups
      operationId: listConnectionBetweenAnExternalGroupAndTeam
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/team-slug'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/external-groups'
              examples:
                default:
                  $ref: '#/components/examples/external-groups'
      x-github:
        githubCloudOnly: true
        enabledForGitHubApps: true
        category: teams
        subcategory: external-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      summary: GitHub Update the Connection Between an External Group and Team
      description: 'Creates a connection between a team and an external group.  Only one external group can be linked to a team.


        You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub''s products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation.'
      tags:
      - Groups
      operationId: updateTheConnectionBetweenAnExternalGroupAndTeam
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/team-slug'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                group_id:
                  type: integer
                  description: External Group Id
                  example: 1
              required:
              - group_id
            examples:
              default:
                value:
                  group_id: 123
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/external-group'
              examples:
                default:
                  $ref: '#/components/examples/external-group'
      x-github:
        githubCloudOnly: true
        enabledForGitHubApps: false
        category: teams
        subcategory: external-groups
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      summary: GitHub Remove the Connection Between an External Group and Team
      description: 'Deletes a connection between a team and an external group.


        You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub''s products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.'
      tags:
      - Groups
      operationId: removeTheConnectionBetweenAnExternalGroupAndTeam
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team
      parameters:
      - $ref: '#/components/parameters/org'
      - $ref: '#/components/parameters/team-slug'
      responses:
        '204':
          description: Response
      x-github:
        githubCloudOnly: true
        enabledForGitHubApps: false
        category: teams
        subcat

# --- truncated at 32 KB (703 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/openapi/github-groups-api-openapi.yml