{
  "opencollection": "1.0.0",
  "info": {
    "name": "Github Groups API",
    "version": "1.1.4"
  },
  "items": [
    {
      "info": {
        "name": "Groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "GitHub List Self-hosted Runner Groups for an Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
              },
              {
                "name": "visible_to_repository",
                "value": "",
                "type": "query",
                "description": "Only return runner groups that are allowed to be used by this repository."
              }
            ]
          },
          "docs": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Create Self-hosted Runner Group for an Organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Get Self-hosted Runner Group for an Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "runner_group_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the self-hosted runner group."
              }
            ]
          },
          "docs": "Gets a specific self-hosted runner group for an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Update Self-hosted Runner Group for an Organization",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "runner_group_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the self-hosted runner group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Delete Self-hosted Runner Group from an Organization",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "runner_group_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the self-hosted runner group."
              }
            ]
          },
          "docs": "Deletes a self-hosted runner group for an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub List Repository Access to Self-hosted Runner Group in an Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/repositories",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "runner_group_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the self-hosted runner group."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
              }
            ]
          },
          "docs": "Lists the repositories with access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Set Repository Access for Self-hosted Runner Group in an Organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/repositories",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "runner_group_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the self-hosted runner group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Add Repository Access to Self-hosted Runner Group in an Organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/repositories/:repository_id",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "runner_group_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the self-hosted runner group."
              },
              {
                "name": "repository_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the repository."
              }
            ]
          },
          "docs": "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).\"\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Remove Repository Access to Self-hosted Runner Group in an Organization",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/repositories/:repository_id",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "runner_group_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the self-hosted runner group."
              },
              {
                "name": "repository_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the repository."
              }
            ]
          },
          "docs": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub List Self-hosted Runners in Group for an Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/runners",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "runner_group_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the self-hosted runner group."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
              }
            ]
          },
          "docs": "Lists self-hosted runners that are in a specific organization group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Set Self-hosted Runners in Group for an Organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/runners",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "runner_group_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the self-hosted runner group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Replaces the list of self-hosted runners that are part of an organization runner group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Add Self-hosted Runner to Group for an Organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/runners/:runner_id",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "runner_group_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the self-hosted runner group."
              },
              {
                "name": "runner_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the self-hosted runner."
              }
            ]
          },
          "docs": "Adds a self-hosted runner to a runner group configured in an organization.\n\nOAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Remove Self-hosted Runner from Group for an Organization",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/actions/runner-groups/:runner_group_id/runners/:runner_id",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "runner_group_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the self-hosted runner group."
              },
              {
                "name": "runner_id",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the self-hosted runner."
              }
            ]
          },
          "docs": "Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint."
        },
        {
          "info": {
            "name": "GitHub Get an External Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/external-group/:group_id",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "group_id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the group."
              }
            ]
          },
          "docs": "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.\n\nYou 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."
        },
        {
          "info": {
            "name": "GitHub List External Groups in an Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/external-groups",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
              },
              {
                "name": "page",
                "value": "42",
                "type": "query",
                "description": "Page token"
              },
              {
                "name": "display_name",
                "value": "octocat",
                "type": "query",
                "description": "Limits the list to groups containing the text in the group name"
              }
            ]
          },
          "docs": "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](ht"
        },
        {
          "info": {
            "name": "GitHub List Connection Between an External Group and Team",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/external-groups",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "team_slug",
                "value": "",
                "type": "path",
                "description": "The slug of the team name."
              }
            ]
          },
          "docs": "Lists a connection between a team and an external group.\n\nYou 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."
        },
        {
          "info": {
            "name": "GitHub Update the Connection Between an External Group and Team",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/external-groups",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "team_slug",
                "value": "",
                "type": "path",
                "description": "The slug of the team name."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a connection between a team and an external group.  Only one external group can be linked to a team.\n\nYou 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."
        },
        {
          "info": {
            "name": "GitHub Remove the Connection Between an External Group and Team",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}/api/v3/orgs/:org/teams/:team_slug/external-groups",
            "params": [
              {
                "name": "org",
                "value": "",
                "type": "path",
                "description": "The organization name. The name is not case sensitive."
              },
              {
                "name": "team_slug",
                "value": "",
                "type": "path",
                "description": "The slug of the team name."
              }
            ]
          },
          "docs": "Deletes a connection between a team and an external group.\n\nYou 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."
        },
        {
          "info": {
            "name": "GitHub List Provisioned Scim Groups for an Enterprise",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups",
            "params": [
              {
                "name": "filter",
                "value": "example_value",
                "type": "query",
                "description": "If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `externalId`, `id`, and `displayName`. For example, `?filter=\"externalId eq '9138790-10932-109120392-12321'\"`."
              },
              {
                "name": "excludedAttributes",
                "value": "",
                "type": "query",
                "description": "Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time."
              },
              {
                "name": "startIndex",
                "value": "",
                "type": "query",
                "description": "Used for pagination: the starting index of the first result to return when paginating through values."
              },
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "Used for pagination: the number of results to return per page."
              }
            ]
          },
          "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response."
        },
        {
          "info": {
            "name": "GitHub Provision Scim Enterprise Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user."
        },
        {
          "info": {
            "name": "GitHub Get Scim Provisioning Information for an Enterprise Group",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups/:scim_group_id",
            "params": [
              {
                "name": "scim_group_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier of the SCIM group."
              },
              {
                "name": "excludedAttributes",
                "value": "",
                "type": "query",
                "description": "Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time."
              }
            ]
          },
          "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM group."
        },
        {
          "info": {
            "name": "GitHub Set Scim Information for Provisioned Enterprise Group",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups/:scim_group_id",
            "params": [
              {
                "name": "scim_group_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier of the SCIM group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-"
        },
        {
          "info": {
            "name": "GitHub Update an Attribute for Scim Enterprise Group",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups/:scim_group_id",
            "params": [
              {
                "name": "scim_group_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier of the SCIM group."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).  Update can also be used to add gro"
        },
        {
          "info": {
            "name": "GitHub Delete Scim Group from an Enterprise",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}/api/v3/scim/v2/Groups/:scim_group_id",
            "params": [
              {
                "name": "scim_group_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier of the SCIM group."
              }
            ]
          },
          "docs": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\n Deletes a SCIM group from an enterprise."
        }
      ]
    }
  ],
  "bundled": true
}