How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GitHub Groups API

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

GitHub Groups API is one of 350 APIs that GitHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and an API reference.

This API exposes 24 operations across 11 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 1.1.4.

Requests are made against a single base URL, {protocol}://{hostname}/api/v3.

24 operations 11 paths 17 schemas 5 DELETE9 GET3 PATCH2 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.4
Base URL
https://api.github.com
Authentication
HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

GitHub Groups API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerHttpAuthentication).

  • bearerHttpAuthentication — Bearer Token

Paths & Operations 24

Across 11 paths, the API surfaces 24 operations — 5 DELETE, 9 GET, 3 PATCH, 2 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Groups 24
GET
/orgs/{org}/actions/runner-groups
GitHub List Self-hosted Runner Groups for an Organization
listSelfhostedRunnerGroupsForAnOrganization 4 params → 200
POST
/orgs/{org}/actions/runner-groups
GitHub Create Self-hosted Runner Group for an Organization
createSelfhostedRunnerGroupForAnOrganization 1 param body → 201
GET
/orgs/{org}/actions/runner-groups/{runner_group_id}
GitHub Get Self-hosted Runner Group for an Organization
getSelfhostedRunnerGroupForAnOrganization 2 params → 200
PATCH
/orgs/{org}/actions/runner-groups/{runner_group_id}
GitHub Update Self-hosted Runner Group for an Organization
updateSelfhostedRunnerGroupForAnOrganization 2 params body → 200
DELETE
/orgs/{org}/actions/runner-groups/{runner_group_id}
GitHub Delete Self-hosted Runner Group from an Organization
deleteSelfhostedRunnerGroupFromAnOrganization 2 params → 204
GET
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories
GitHub List Repository Access to Self-hosted Runner Group in an Organization
listRepositoryAccessToSelfhostedRunnerGroupInAnOrganization 4 params → 200
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories
GitHub Set Repository Access for Self-hosted Runner Group in an Organization
setRepositoryAccessForSelfhostedRunnerGroupInAnOrganization 2 params body → 204
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}
GitHub Add Repository Access to Self-hosted Runner Group in an Organization
addRepositoryAccessToSelfhostedRunnerGroupInAnOrganization 3 params → 204
DELETE
/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}
GitHub Remove Repository Access to Self-hosted Runner Group in an Organization
removeRepositoryAccessToSelfhostedRunnerGroupInAnOrganization 3 params → 204
GET
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners
GitHub List Self-hosted Runners in Group for an Organization
listSelfhostedRunnersInGroupForAnOrganization 4 params → 200
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners
GitHub Set Self-hosted Runners in Group for an Organization
setSelfhostedRunnersInGroupForAnOrganization 2 params body → 204
PUT
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
GitHub Add Self-hosted Runner to Group for an Organization
addSelfhostedRunnerToGroupForAnOrganization 3 params → 204
DELETE
/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}
GitHub Remove Self-hosted Runner from Group for an Organization
removeSelfhostedRunnerFromGroupForAnOrganization 3 params → 204
GET
/orgs/{org}/external-group/{group_id}
GitHub Get an External Group
getAnExternalGroup 2 params → 200
GET
/orgs/{org}/external-groups
GitHub List External Groups in an Organization
listExternalGroupsInAnOrganization 4 params → 200
GET
/orgs/{org}/teams/{team_slug}/external-groups
GitHub List Connection Between an External Group and Team
listConnectionBetweenAnExternalGroupAndTeam 2 params → 200
PATCH
/orgs/{org}/teams/{team_slug}/external-groups
GitHub Update the Connection Between an External Group and Team
updateTheConnectionBetweenAnExternalGroupAndTeam 2 params body → 200
DELETE
/orgs/{org}/teams/{team_slug}/external-groups
GitHub Remove the Connection Between an External Group and Team
removeTheConnectionBetweenAnExternalGroupAndTeam 2 params → 204
GET
/scim/v2/Groups
GitHub List Provisioned Scim Groups for an Enterprise
listProvisionedScimGroupsForAnEnterprise 4 params → 200400401403429500
POST
/scim/v2/Groups
GitHub Provision Scim Enterprise Group
provisionScimEnterpriseGroup body → 201400401403409429500
GET
/scim/v2/Groups/{scim_group_id}
GitHub Get Scim Provisioning Information for an Enterprise Group
getScimProvisioningInformationForAnEnterpriseGroup 2 params → 200400401403404429500
PUT
/scim/v2/Groups/{scim_group_id}
GitHub Set Scim Information for Provisioned Enterprise Group
setScimInformationForProvisionedEnterpriseGroup 1 param body → 200400401403404409429500
PATCH
/scim/v2/Groups/{scim_group_id}
GitHub Update an Attribute for Scim Enterprise Group
updateAnAttributeForScimEnterpriseGroup 1 param body → 200204400401403404409429
DELETE
/scim/v2/Groups/{scim_group_id}
GitHub Delete Scim Group from an Enterprise
deleteScimGroupFromAnEnterprise 1 param → 204400401403404429500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are minimal-repository (87 properties), simple-user (21 properties), runner-groups-org (12 properties), runner (7 properties). Each schema is shown below with its type and property counts.

code-of-conduct
object
Code Of Conduct
5 properties 4 required
minimal-repository
object
Minimal Repository
87 properties 46 required
runner-groups-org
object
12 properties 7 required
security-and-analysis
objectnull
3 properties
simple-user
object
A GitHub user.
21 properties 18 required
external-group
object
Information about an external group's usage and its members
5 properties 4 required
runner
object
A self hosted runner
7 properties 6 required
external-groups
object
A list of external groups available to be connected to a team
1 property
runner-label
object
A label for a self hosted runner
3 properties 1 required
scim-error
object
Scim Error
6 properties
scim-enterprise-group-list
object
5 properties 5 required
basic-error
object
Basic Error
4 properties
scim-enterprise-group-response
patch-schema
object
2 properties 2 required
group
object
4 properties 4 required
group-response
object
4 properties 1 required
meta
object
The metadata associated with the creation/updates to the user.
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

github-groups-api-openapi.yml Raw ↑

Other APIs GitHub publishes across the network.

GitHub Events API
GitHub Feeds API
GitHub Gists API
GitHub Issues API
GitHub Licenses API
GitHub Markdown API
GitHub Meta API
GitHub Notifications API
GitHub Octocat API
GitHub Projects API
GitHub Repos API
GitHub Search API
Where this information came from

This is an independent, third-party profile of GitHub Groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.