Skip to content

Commit 1e40010

Browse files
docs-botsabrowning1hpsin
authored
Update OpenAPI Description (#56428)
Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com> Co-authored-by: Hirsch Singhal <1666363+hpsin@users.noreply.github.com>
1 parent 3f72bc3 commit 1e40010

File tree

17 files changed

+4989
-594
lines changed

17 files changed

+4989
-594
lines changed

content/rest/enterprise-admin/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ children:
2727
- /management-console
2828
- /network-configurations
2929
- /org-pre-receive-hooks
30+
- /organization-installations
3031
- /orgs
3132
- /pre-receive-environments
3233
- /pre-receive-hooks
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: REST API for managing organization GitHub App installations
3+
shortTitle: GitHub App installations
4+
intro: Use the REST API to manage which {% data variables.product.prodname_github_apps %} are installed in your enterprise's organizations.
5+
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
6+
ghec: '*'
7+
topics:
8+
- API
9+
autogenerated: rest
10+
allowTitleToDifferFromFilename: true
11+
---
12+
13+
<!-- Content after this section is automatically generated -->

src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,144 @@
173173
}
174174
]
175175
},
176+
"enterprise_organization_installation_repositories": {
177+
"title": "Enterprise organization installation repositories",
178+
"displayTitle": "Enterprise permissions for \"Enterprise organization installation repositories\"",
179+
"permissions": [
180+
{
181+
"category": "enterprise-admin",
182+
"slug": "get-repositories-belonging-to-an-enterprise-owned-organization",
183+
"subcategory": "organization-installations",
184+
"verb": "get",
185+
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations/{org}/accessible_repositories",
186+
"additional-permissions": true,
187+
"access": "read"
188+
},
189+
{
190+
"category": "enterprise-admin",
191+
"slug": "get-the-repositories-accessible-to-a-given-github-app-installation",
192+
"subcategory": "organization-installations",
193+
"verb": "get",
194+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories",
195+
"additional-permissions": true,
196+
"access": "read"
197+
},
198+
{
199+
"category": "enterprise-admin",
200+
"slug": "toggle-installation-repository-access-between-selected-and-all-repositories",
201+
"subcategory": "organization-installations",
202+
"verb": "patch",
203+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories",
204+
"additional-permissions": true,
205+
"access": "write"
206+
},
207+
{
208+
"category": "enterprise-admin",
209+
"slug": "grant-repository-access-to-an-organization-installation",
210+
"subcategory": "organization-installations",
211+
"verb": "patch",
212+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/add",
213+
"additional-permissions": true,
214+
"access": "write"
215+
},
216+
{
217+
"category": "enterprise-admin",
218+
"slug": "remove-repository-access-from-an-organization-installation",
219+
"subcategory": "organization-installations",
220+
"verb": "patch",
221+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/remove",
222+
"additional-permissions": true,
223+
"access": "write"
224+
}
225+
]
226+
},
227+
"enterprise_organization_installations": {
228+
"title": "Enterprise organization installations",
229+
"displayTitle": "Enterprise permissions for \"Enterprise organization installations\"",
230+
"permissions": [
231+
{
232+
"category": "enterprise-admin",
233+
"slug": "get-enterprise-owned-organizations-that-can-have-github-apps-installed",
234+
"subcategory": "organization-installations",
235+
"verb": "get",
236+
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations",
237+
"additional-permissions": false,
238+
"access": "read"
239+
},
240+
{
241+
"category": "enterprise-admin",
242+
"slug": "get-repositories-belonging-to-an-enterprise-owned-organization",
243+
"subcategory": "organization-installations",
244+
"verb": "get",
245+
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations/{org}/accessible_repositories",
246+
"additional-permissions": true,
247+
"access": "read"
248+
},
249+
{
250+
"category": "enterprise-admin",
251+
"slug": "list-github-apps-installed-on-an-enterprise-owned-organization",
252+
"subcategory": "organization-installations",
253+
"verb": "get",
254+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations",
255+
"additional-permissions": false,
256+
"access": "read"
257+
},
258+
{
259+
"category": "enterprise-admin",
260+
"slug": "install-a-github-app-on-an-enterprise-owned-organization",
261+
"subcategory": "organization-installations",
262+
"verb": "post",
263+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations",
264+
"additional-permissions": false,
265+
"access": "write"
266+
},
267+
{
268+
"category": "enterprise-admin",
269+
"slug": "uninstall-a-github-app-from-an-enterprise-owned-organization",
270+
"subcategory": "organization-installations",
271+
"verb": "delete",
272+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}",
273+
"additional-permissions": false,
274+
"access": "write"
275+
},
276+
{
277+
"category": "enterprise-admin",
278+
"slug": "get-the-repositories-accessible-to-a-given-github-app-installation",
279+
"subcategory": "organization-installations",
280+
"verb": "get",
281+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories",
282+
"additional-permissions": true,
283+
"access": "read"
284+
},
285+
{
286+
"category": "enterprise-admin",
287+
"slug": "toggle-installation-repository-access-between-selected-and-all-repositories",
288+
"subcategory": "organization-installations",
289+
"verb": "patch",
290+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories",
291+
"additional-permissions": true,
292+
"access": "write"
293+
},
294+
{
295+
"category": "enterprise-admin",
296+
"slug": "grant-repository-access-to-an-organization-installation",
297+
"subcategory": "organization-installations",
298+
"verb": "patch",
299+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/add",
300+
"additional-permissions": true,
301+
"access": "write"
302+
},
303+
{
304+
"category": "enterprise-admin",
305+
"slug": "remove-repository-access-from-an-organization-installation",
306+
"subcategory": "organization-installations",
307+
"verb": "patch",
308+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/remove",
309+
"additional-permissions": true,
310+
"access": "write"
311+
}
312+
]
313+
},
176314
"organization_api_insights": {
177315
"title": "API Insights",
178316
"displayTitle": "Organization permissions for \"API Insights\"",

src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2564,6 +2564,60 @@
25642564
"verb": "get",
25652565
"requestPath": "/enterprise-installation/{enterprise_or_org}/server-statistics"
25662566
},
2567+
{
2568+
"slug": "get-enterprise-owned-organizations-that-can-have-github-apps-installed",
2569+
"subcategory": "organization-installations",
2570+
"verb": "get",
2571+
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations"
2572+
},
2573+
{
2574+
"slug": "get-repositories-belonging-to-an-enterprise-owned-organization",
2575+
"subcategory": "organization-installations",
2576+
"verb": "get",
2577+
"requestPath": "/enterprises/{enterprise}/apps/installable_organizations/{org}/accessible_repositories"
2578+
},
2579+
{
2580+
"slug": "list-github-apps-installed-on-an-enterprise-owned-organization",
2581+
"subcategory": "organization-installations",
2582+
"verb": "get",
2583+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations"
2584+
},
2585+
{
2586+
"slug": "install-a-github-app-on-an-enterprise-owned-organization",
2587+
"subcategory": "organization-installations",
2588+
"verb": "post",
2589+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations"
2590+
},
2591+
{
2592+
"slug": "uninstall-a-github-app-from-an-enterprise-owned-organization",
2593+
"subcategory": "organization-installations",
2594+
"verb": "delete",
2595+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}"
2596+
},
2597+
{
2598+
"slug": "get-the-repositories-accessible-to-a-given-github-app-installation",
2599+
"subcategory": "organization-installations",
2600+
"verb": "get",
2601+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories"
2602+
},
2603+
{
2604+
"slug": "toggle-installation-repository-access-between-selected-and-all-repositories",
2605+
"subcategory": "organization-installations",
2606+
"verb": "patch",
2607+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories"
2608+
},
2609+
{
2610+
"slug": "grant-repository-access-to-an-organization-installation",
2611+
"subcategory": "organization-installations",
2612+
"verb": "patch",
2613+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/add"
2614+
},
2615+
{
2616+
"slug": "remove-repository-access-from-an-organization-installation",
2617+
"subcategory": "organization-installations",
2618+
"verb": "patch",
2619+
"requestPath": "/enterprises/{enterprise}/apps/organizations/{org}/installations/{installation_id}/repositories/remove"
2620+
},
25672621
{
25682622
"slug": "get-the-audit-log-for-an-enterprise",
25692623
"subcategory": "audit-log",

0 commit comments

Comments
 (0)