APIs.io Engineering Platform Orgs API
Interact with GitHub Orgs.
This API exposes 49 operations across 30 paths, and defines 31 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
49 operations
30 paths
31 schemas
9 DELETE25 GET6 PATCH5 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
APIs.io Engineering Platform Orgs API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 49
Across 30 paths, the API surfaces 49 operations — 9 DELETE, 25 GET, 6 PATCH, 5 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Orgs 49
Interact with GitHub Orgs.
GET
/organizations
APIs.io Engineering Platform List organizations
GET
/organizations/{organization_id}/custom_rolesdeprecated
APIs.io Engineering Platform Deprecated - List custom repository roles in an organization
GET
/orgs/{org}
APIs.io Engineering Platform Get an organization
PATCH
/orgs/{org}
APIs.io Engineering Platform Update an organization
DELETE
/orgs/{org}
APIs.io Engineering Platform Delete an organization
GET
/orgs/{org}/announcement
APIs.io Engineering Platform Get announcement banner for organization
PATCH
/orgs/{org}/announcement
APIs.io Engineering Platform Set announcement banner for organization
DELETE
/orgs/{org}/announcement
APIs.io Engineering Platform Remove announcement banner from organization
GET
/orgs/{org}/audit-log
APIs.io Engineering Platform Get the audit log for an organization
GET
/orgs/{org}/custom-repository-roles
APIs.io Engineering Platform List custom repository roles in an organization
POST
/orgs/{org}/custom-repository-roles
APIs.io Engineering Platform Create a custom repository role
GET
/orgs/{org}/custom-repository-roles/{role_id}
APIs.io Engineering Platform Get a custom repository role
PATCH
/orgs/{org}/custom-repository-roles/{role_id}
APIs.io Engineering Platform Update a custom repository role
DELETE
/orgs/{org}/custom-repository-roles/{role_id}
APIs.io Engineering Platform Delete a custom repository role
GET
/orgs/{org}/hooks
APIs.io Engineering Platform List organization webhooks
POST
/orgs/{org}/hooks
APIs.io Engineering Platform Create an organization webhook
GET
/orgs/{org}/hooks/{hook_id}
APIs.io Engineering Platform Get an organization webhook
PATCH
/orgs/{org}/hooks/{hook_id}
APIs.io Engineering Platform Update an organization webhook
DELETE
/orgs/{org}/hooks/{hook_id}
APIs.io Engineering Platform Delete an organization webhook
GET
/orgs/{org}/hooks/{hook_id}/config
APIs.io Engineering Platform Get a webhook configuration for an organization
PATCH
/orgs/{org}/hooks/{hook_id}/config
APIs.io Engineering Platform Update a webhook configuration for an organization
GET
/orgs/{org}/hooks/{hook_id}/deliveries
APIs.io Engineering Platform List deliveries for an organization webhook
GET
/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}
APIs.io Engineering Platform Get a webhook delivery for an organization webhook
POST
/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts
APIs.io Engineering Platform Redeliver a delivery for an organization webhook
POST
/orgs/{org}/hooks/{hook_id}/pings
APIs.io Engineering Platform Ping an organization webhook
GET
/orgs/{org}/installations
APIs.io Engineering Platform List app installations for an organization
GET
/orgs/{org}/members
APIs.io Engineering Platform List organization members
GET
/orgs/{org}/members/{username}
APIs.io Engineering Platform Check organization membership for a user
DELETE
/orgs/{org}/members/{username}
APIs.io Engineering Platform Remove an organization member
GET
/orgs/{org}/memberships/{username}
APIs.io Engineering Platform Get organization membership for a user
PUT
/orgs/{org}/memberships/{username}
APIs.io Engineering Platform Set organization membership for a user
DELETE
/orgs/{org}/memberships/{username}
APIs.io Engineering Platform Remove organization membership for a user
GET
/orgs/{org}/outside_collaborators
APIs.io Engineering Platform List outside collaborators for an organization
PUT
/orgs/{org}/outside_collaborators/{username}
APIs.io Engineering Platform Convert an organization member to outside collaborator
DELETE
/orgs/{org}/outside_collaborators/{username}
APIs.io Engineering Platform Remove outside collaborator from an organization
GET
/orgs/{org}/public_members
APIs.io Engineering Platform List public organization members
GET
/orgs/{org}/public_members/{username}
APIs.io Engineering Platform Check public organization membership for a user
PUT
/orgs/{org}/public_members/{username}
APIs.io Engineering Platform Set public organization membership for the authenticated user
DELETE
/orgs/{org}/public_members/{username}
APIs.io Engineering Platform Remove public organization membership for the authenticated user
GET
/orgs/{org}/repository-fine-grained-permissions
APIs.io Engineering Platform List repository fine-grained permissions for an organization
GET
/orgs/{org}/security-managers
APIs.io Engineering Platform List security manager teams
PUT
/orgs/{org}/security-managers/teams/{team_slug}
APIs.io Engineering Platform Add a security manager team
DELETE
/orgs/{org}/security-managers/teams/{team_slug}
APIs.io Engineering Platform Remove a security manager team
POST
/orgs/{org}/{security_product}/{enablement}
APIs.io Engineering Platform Enable or disable a security feature for an organization
GET
/user/memberships/orgs
APIs.io Engineering Platform List organization memberships for the authenticated user
GET
/user/memberships/orgs/{org}
APIs.io Engineering Platform Get an organization membership for the authenticated user
PATCH
/user/memberships/orgs/{org}
APIs.io Engineering Platform Update an organization membership for the authenticated user
GET
/user/orgs
APIs.io Engineering Platform List organizations for the authenticated user
GET
/users/{username}/orgs
APIs.io Engineering Platform List organizations for a user
Schemas 31
The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are organization-full (56 properties), app-permissions (45 properties), audit-log-event (43 properties), simple-user (21 properties). Each schema is shown below with its type and property counts.
nullable-simple-user
object
A GitHub user.
21 properties
18 required
announcement-expiration
string
The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format: YYYY-MM-DDTHH:MM:SSZ. To set an an…
enterprise
object
An enterprise on GitHub.
10 properties
8 required
webhook-config-secret
string
If provided, the secret will be used as the key to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-serve…
announcement-message
string
The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs…
announcement-user-dismissible
boolean
Whether an announcement can be dismissed by the user.
repository-fine-grained-permission
object
A fine-grained permission that protects repository resources.
2 properties
2 required
announcement
object
Enterprise global announcement
2 properties
1 required
org-hook
object
Org Hook
11 properties
10 required
basic-error
object
Basic Error
4 properties
organization-full
object
Organization Full
56 properties
23 required
team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
app-permissions
object
The permissions granted to the user access token.
45 properties
scim-error
object
Scim Error
6 properties
organization-custom-repository-role-update-schema
object
4 properties
webhook-config
object
Configuration object of the webhook
4 properties
organization-custom-repository-role-create-schema
object
4 properties
3 required
org-membership
object
Org Membership
7 properties
6 required
announcement-banner
object
Announcement at either the repository, organization, or enterprise level
3 properties
3 required
hook-delivery
object
Delivery made by a webhook.
15 properties
13 required
validation-error
object
Validation Error
3 properties
2 required
validation-error-simple
object
Validation Error Simple
3 properties
2 required
installation
object
Installation
20 properties
17 required
webhook-config-content-type
string
The media type used to serialize the payloads. Supported values include json and form. The default is form.
organization-simple
object
A GitHub organization.
12 properties
12 required
hook-delivery-item
object
Delivery made by a webhook, without request and response information.
12 properties
11 required
organization-custom-repository-role
object
Custom repository roles created by organization owners
8 properties
7 required
simple-user
object
A GitHub user.
21 properties
18 required
webhook-config-url
string
The URL to which the payloads will be delivered.
audit-log-event
object
43 properties
webhook-config-insecure-ssl
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Orgs