adoptai-mcp 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +70 -0
- package/bin/adoptai-mcp.js +2 -0
- package/dist/apps/canva.js +1 -0
- package/dist/apps/figma.js +1 -0
- package/dist/apps/github.js +2 -0
- package/dist/apps/notion.js +1 -0
- package/dist/apps/registry.js +20 -0
- package/dist/apps/salesforce.js +1 -0
- package/dist/cli/add.js +532 -0
- package/dist/cli/index.js +39 -0
- package/dist/cli/list.js +19 -0
- package/dist/cli/remove.js +37 -0
- package/dist/cli/serve.js +27 -0
- package/dist/cli/status.js +24 -0
- package/dist/config/clients.js +118 -0
- package/dist/config/credentials.js +34 -0
- package/dist/core/auth-manager.js +237 -0
- package/dist/core/config-writer.js +161 -0
- package/dist/core/doctor.js +199 -0
- package/dist/core/package.json +3 -0
- package/dist/core/server-base.js +81 -0
- package/dist/integrations/canva/.env +3 -0
- package/dist/integrations/canva/auth.js +287 -0
- package/dist/integrations/canva/env.js +9 -0
- package/dist/integrations/canva/index.js +12 -0
- package/dist/integrations/canva/package.json +31 -0
- package/dist/integrations/canva/publish-to-adoptai.js +365 -0
- package/dist/integrations/canva/setup.js +90 -0
- package/dist/integrations/canva/tools.js +1315 -0
- package/dist/integrations/canva/tools.original.js +1315 -0
- package/dist/integrations/figma/auth.js +48 -0
- package/dist/integrations/figma/index.js +11 -0
- package/dist/integrations/figma/package.json +27 -0
- package/dist/integrations/figma/publish-to-adoptai.js +384 -0
- package/dist/integrations/figma/setup.js +90 -0
- package/dist/integrations/figma/tools.js +1137 -0
- package/dist/integrations/github/auth.js +53 -0
- package/dist/integrations/github/index.js +11 -0
- package/dist/integrations/github/package.json +28 -0
- package/dist/integrations/github/publish-to-adoptai.js +240 -0
- package/dist/integrations/github/setup.js +103 -0
- package/dist/integrations/github/tools.js +78 -0
- package/dist/integrations/github-actions/auth.js +53 -0
- package/dist/integrations/github-actions/index.js +11 -0
- package/dist/integrations/github-actions/package.json +27 -0
- package/dist/integrations/github-actions/setup.js +103 -0
- package/dist/integrations/github-actions/tools.js +5642 -0
- package/dist/integrations/github-activity/auth.js +53 -0
- package/dist/integrations/github-activity/index.js +11 -0
- package/dist/integrations/github-activity/package.json +27 -0
- package/dist/integrations/github-activity/setup.js +103 -0
- package/dist/integrations/github-activity/tools.js +925 -0
- package/dist/integrations/github-apps/auth.js +53 -0
- package/dist/integrations/github-apps/index.js +11 -0
- package/dist/integrations/github-apps/package.json +27 -0
- package/dist/integrations/github-apps/setup.js +103 -0
- package/dist/integrations/github-apps/tools.js +791 -0
- package/dist/integrations/github-billing/auth.js +53 -0
- package/dist/integrations/github-billing/index.js +11 -0
- package/dist/integrations/github-billing/package.json +27 -0
- package/dist/integrations/github-billing/setup.js +103 -0
- package/dist/integrations/github-billing/tools.js +438 -0
- package/dist/integrations/github-checks/auth.js +53 -0
- package/dist/integrations/github-checks/index.js +11 -0
- package/dist/integrations/github-checks/package.json +27 -0
- package/dist/integrations/github-checks/setup.js +103 -0
- package/dist/integrations/github-checks/tools.js +607 -0
- package/dist/integrations/github-code-scanning/auth.js +53 -0
- package/dist/integrations/github-code-scanning/index.js +11 -0
- package/dist/integrations/github-code-scanning/package.json +27 -0
- package/dist/integrations/github-code-scanning/setup.js +103 -0
- package/dist/integrations/github-code-scanning/tools.js +987 -0
- package/dist/integrations/github-dependabot/auth.js +53 -0
- package/dist/integrations/github-dependabot/index.js +11 -0
- package/dist/integrations/github-dependabot/package.json +27 -0
- package/dist/integrations/github-dependabot/setup.js +103 -0
- package/dist/integrations/github-dependabot/tools.js +915 -0
- package/dist/integrations/github-gists/auth.js +53 -0
- package/dist/integrations/github-gists/index.js +11 -0
- package/dist/integrations/github-gists/package.json +27 -0
- package/dist/integrations/github-gists/setup.js +103 -0
- package/dist/integrations/github-gists/tools.js +545 -0
- package/dist/integrations/github-git/auth.js +53 -0
- package/dist/integrations/github-git/index.js +11 -0
- package/dist/integrations/github-git/package.json +27 -0
- package/dist/integrations/github-git/setup.js +103 -0
- package/dist/integrations/github-git/tools.js +513 -0
- package/dist/integrations/github-issues/auth.js +53 -0
- package/dist/integrations/github-issues/index.js +11 -0
- package/dist/integrations/github-issues/package.json +27 -0
- package/dist/integrations/github-issues/setup.js +103 -0
- package/dist/integrations/github-issues/tools.js +2232 -0
- package/dist/integrations/github-orgs/auth.js +53 -0
- package/dist/integrations/github-orgs/index.js +11 -0
- package/dist/integrations/github-orgs/package.json +27 -0
- package/dist/integrations/github-orgs/setup.js +103 -0
- package/dist/integrations/github-orgs/tools.js +3512 -0
- package/dist/integrations/github-packages/auth.js +53 -0
- package/dist/integrations/github-packages/index.js +11 -0
- package/dist/integrations/github-packages/package.json +27 -0
- package/dist/integrations/github-packages/setup.js +103 -0
- package/dist/integrations/github-packages/tools.js +1088 -0
- package/dist/integrations/github-pulls/auth.js +53 -0
- package/dist/integrations/github-pulls/index.js +11 -0
- package/dist/integrations/github-pulls/package.json +27 -0
- package/dist/integrations/github-pulls/setup.js +103 -0
- package/dist/integrations/github-pulls/tools.js +1252 -0
- package/dist/integrations/github-reactions/auth.js +53 -0
- package/dist/integrations/github-reactions/index.js +11 -0
- package/dist/integrations/github-reactions/package.json +27 -0
- package/dist/integrations/github-reactions/setup.js +103 -0
- package/dist/integrations/github-reactions/tools.js +706 -0
- package/dist/integrations/github-repos/auth.js +53 -0
- package/dist/integrations/github-repos/index.js +11 -0
- package/dist/integrations/github-repos/package.json +27 -0
- package/dist/integrations/github-repos/setup.js +103 -0
- package/dist/integrations/github-repos/tools.js +7286 -0
- package/dist/integrations/github-search/auth.js +53 -0
- package/dist/integrations/github-search/index.js +11 -0
- package/dist/integrations/github-search/package.json +27 -0
- package/dist/integrations/github-search/setup.js +103 -0
- package/dist/integrations/github-search/tools.js +370 -0
- package/dist/integrations/github-teams/auth.js +53 -0
- package/dist/integrations/github-teams/index.js +11 -0
- package/dist/integrations/github-teams/package.json +27 -0
- package/dist/integrations/github-teams/setup.js +103 -0
- package/dist/integrations/github-teams/tools.js +633 -0
- package/dist/integrations/github-users/auth.js +53 -0
- package/dist/integrations/github-users/index.js +11 -0
- package/dist/integrations/github-users/package.json +27 -0
- package/dist/integrations/github-users/setup.js +103 -0
- package/dist/integrations/github-users/tools.js +1118 -0
- package/dist/integrations/notion/api.js +108 -0
- package/dist/integrations/notion/auth.js +59 -0
- package/dist/integrations/notion/endpoints.json +630 -0
- package/dist/integrations/notion/index.js +11 -0
- package/dist/integrations/notion/package.json +33 -0
- package/dist/integrations/notion/publish-to-adoptai.js +271 -0
- package/dist/integrations/notion/scripts/generate-endpoints.mjs +306 -0
- package/dist/integrations/notion/setup.js +89 -0
- package/dist/integrations/notion/tools.js +586 -0
- package/dist/integrations/notion/tools.original.js +568 -0
- package/dist/integrations/salesforce/.env +8 -0
- package/dist/integrations/salesforce/.env.example +15 -0
- package/dist/integrations/salesforce/auth.js +311 -0
- package/dist/integrations/salesforce/endpoints.json +1359 -0
- package/dist/integrations/salesforce/env.js +9 -0
- package/dist/integrations/salesforce/index.js +12 -0
- package/dist/integrations/salesforce/package.json +42 -0
- package/dist/integrations/salesforce/publish-smart-specs.js +890 -0
- package/dist/integrations/salesforce/publish-to-adoptai.js +386 -0
- package/dist/integrations/salesforce/scripts/extract-postman.mjs +222 -0
- package/dist/integrations/salesforce/setup.js +112 -0
- package/dist/integrations/salesforce/tools.js +4544 -0
- package/dist/integrations/salesforce/tools.original.js +4487 -0
- package/dist/server/mcp-server.js +50 -0
- package/dist/server/tool-loader.js +47 -0
- package/dist/specs/figma-api.json +13621 -0
- package/dist/specs/split/salesforce-auth.json +3931 -0
- package/dist/specs/split/salesforce-bulk-v1.json +1489 -0
- package/dist/specs/split/salesforce-bulk-v2.json +1951 -0
- package/dist/specs/split/salesforce-composite.json +1246 -0
- package/dist/specs/split/salesforce-connect.json +11639 -0
- package/dist/specs/split/salesforce-einstein-prediction-service.json +576 -0
- package/dist/specs/split/salesforce-event-platform.json +2682 -0
- package/dist/specs/split/salesforce-graphql.json +1754 -0
- package/dist/specs/split/salesforce-industries.json +4115 -0
- package/dist/specs/split/salesforce-metadata.json +555 -0
- package/dist/specs/split/salesforce-rest.json +4798 -0
- package/dist/specs/split/salesforce-soap.json +210 -0
- package/dist/specs/split/salesforce-subscription-management.json +1299 -0
- package/dist/specs/split/salesforce-tooling.json +2026 -0
- package/dist/specs/split/salesforce-ui.json +7426 -0
- package/package.json +47 -0
|
@@ -0,0 +1,3512 @@
|
|
|
1
|
+
import axios from 'axios';
|
|
2
|
+
import { buildAuthHeaders } from './auth.js';
|
|
3
|
+
|
|
4
|
+
const BASE_URL = 'https://api.github.com';
|
|
5
|
+
const APP_ID = 'github-orgs';
|
|
6
|
+
|
|
7
|
+
function handleError(err) {
|
|
8
|
+
const status = err.response?.status;
|
|
9
|
+
const msg = err.response?.data?.message || err.response?.data?.error || err.message;
|
|
10
|
+
if (status === 401) throw new Error(`Token invalid.
|
|
11
|
+
Run: npx adoptai-${APP_ID}-mcp --client cursor`);
|
|
12
|
+
if (status === 403) throw new Error('Insufficient permissions. Check your API key scopes.');
|
|
13
|
+
if (status === 404) throw new Error('Resource not found. Check your parameters.');
|
|
14
|
+
if (status === 429) throw new Error('Rate limit exceeded. Please wait and try again.');
|
|
15
|
+
throw new Error(msg || 'API request failed');
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
async function apiRequest(method, pathTemplate, params = {}, opts = {}) {
|
|
19
|
+
const { deleteSendsJsonBody = false } = opts;
|
|
20
|
+
const headers = buildAuthHeaders();
|
|
21
|
+
let url = BASE_URL + pathTemplate;
|
|
22
|
+
const pathKeys = [...pathTemplate.matchAll(/{([^}]+)}/g)].map((m) => m[1]);
|
|
23
|
+
for (const key of pathKeys) {
|
|
24
|
+
const value = params[key];
|
|
25
|
+
if (value !== undefined && value !== null) url = url.replace(`{${key}}`, encodeURIComponent(String(value)));
|
|
26
|
+
}
|
|
27
|
+
const rest = { ...params };
|
|
28
|
+
for (const key of pathKeys) delete rest[key];
|
|
29
|
+
const m = method.toUpperCase();
|
|
30
|
+
const useQuery = m === 'GET' || (m === 'DELETE' && !deleteSendsJsonBody);
|
|
31
|
+
const queryParams = {};
|
|
32
|
+
const bodyParams = {};
|
|
33
|
+
for (const [key, value] of Object.entries(rest)) {
|
|
34
|
+
if (value === undefined) continue;
|
|
35
|
+
if (useQuery) queryParams[key] = value; else bodyParams[key] = value;
|
|
36
|
+
}
|
|
37
|
+
try {
|
|
38
|
+
const res = await axios({
|
|
39
|
+
method: m, url,
|
|
40
|
+
headers: { 'Content-Type': 'application/json', ...headers },
|
|
41
|
+
params: Object.keys(queryParams).length ? queryParams : undefined,
|
|
42
|
+
data: Object.keys(bodyParams).length ? bodyParams : undefined,
|
|
43
|
+
timeout: 30000,
|
|
44
|
+
});
|
|
45
|
+
if (res.status === 204 || res.data === '' || res.data === undefined) return { ok: true, status: res.status };
|
|
46
|
+
return res.data;
|
|
47
|
+
} catch (err) { handleError(err); }
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
const ENDPOINTS = [
|
|
51
|
+
{
|
|
52
|
+
"name": "orgs_list",
|
|
53
|
+
"description": "List organizations",
|
|
54
|
+
"method": "GET",
|
|
55
|
+
"path": "/organizations",
|
|
56
|
+
"deleteSendsJsonBody": false,
|
|
57
|
+
"inputSchema": {
|
|
58
|
+
"type": "object",
|
|
59
|
+
"properties": {
|
|
60
|
+
"since": {
|
|
61
|
+
"type": "number",
|
|
62
|
+
"description": "An organization ID. Only return organizations with an ID greater than this ID."
|
|
63
|
+
},
|
|
64
|
+
"per_page": {
|
|
65
|
+
"type": "number",
|
|
66
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
67
|
+
}
|
|
68
|
+
},
|
|
69
|
+
"required": []
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"name": "orgs_get",
|
|
74
|
+
"description": "Get an organization",
|
|
75
|
+
"method": "GET",
|
|
76
|
+
"path": "/orgs/{org}",
|
|
77
|
+
"deleteSendsJsonBody": false,
|
|
78
|
+
"inputSchema": {
|
|
79
|
+
"type": "object",
|
|
80
|
+
"properties": {
|
|
81
|
+
"org": {
|
|
82
|
+
"type": "string",
|
|
83
|
+
"description": "The organization name. The name is not case sensitive."
|
|
84
|
+
}
|
|
85
|
+
},
|
|
86
|
+
"required": [
|
|
87
|
+
"org"
|
|
88
|
+
]
|
|
89
|
+
}
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"name": "orgs_update",
|
|
93
|
+
"description": "Update an organization",
|
|
94
|
+
"method": "PATCH",
|
|
95
|
+
"path": "/orgs/{org}",
|
|
96
|
+
"deleteSendsJsonBody": false,
|
|
97
|
+
"inputSchema": {
|
|
98
|
+
"type": "object",
|
|
99
|
+
"properties": {
|
|
100
|
+
"org": {
|
|
101
|
+
"type": "string",
|
|
102
|
+
"description": "The organization name. The name is not case sensitive."
|
|
103
|
+
},
|
|
104
|
+
"billing_email": {
|
|
105
|
+
"type": "string",
|
|
106
|
+
"description": "Billing email address. This address is not publicized."
|
|
107
|
+
},
|
|
108
|
+
"company": {
|
|
109
|
+
"type": "string",
|
|
110
|
+
"description": "The company name."
|
|
111
|
+
},
|
|
112
|
+
"email": {
|
|
113
|
+
"type": "string",
|
|
114
|
+
"description": "The publicly visible email address."
|
|
115
|
+
},
|
|
116
|
+
"twitter_username": {
|
|
117
|
+
"type": "string",
|
|
118
|
+
"description": "The Twitter username of the company."
|
|
119
|
+
},
|
|
120
|
+
"location": {
|
|
121
|
+
"type": "string",
|
|
122
|
+
"description": "The location."
|
|
123
|
+
},
|
|
124
|
+
"name": {
|
|
125
|
+
"type": "string",
|
|
126
|
+
"description": "The shorthand name of the company."
|
|
127
|
+
},
|
|
128
|
+
"description": {
|
|
129
|
+
"type": "string",
|
|
130
|
+
"description": "The description of the company. The maximum size is 160 characters."
|
|
131
|
+
},
|
|
132
|
+
"has_organization_projects": {
|
|
133
|
+
"type": "boolean",
|
|
134
|
+
"description": "Whether an organization can use organization projects."
|
|
135
|
+
},
|
|
136
|
+
"has_repository_projects": {
|
|
137
|
+
"type": "boolean",
|
|
138
|
+
"description": "Whether repositories that belong to the organization can use repository projects."
|
|
139
|
+
},
|
|
140
|
+
"default_repository_permission": {
|
|
141
|
+
"type": "string",
|
|
142
|
+
"description": "Default permission level members have for organization repositories.",
|
|
143
|
+
"enum": [
|
|
144
|
+
"read",
|
|
145
|
+
"write",
|
|
146
|
+
"admin",
|
|
147
|
+
"none"
|
|
148
|
+
]
|
|
149
|
+
},
|
|
150
|
+
"members_can_create_repositories": {
|
|
151
|
+
"type": "boolean",
|
|
152
|
+
"description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details."
|
|
153
|
+
},
|
|
154
|
+
"members_can_create_internal_repositories": {
|
|
155
|
+
"type": "boolean",
|
|
156
|
+
"description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."
|
|
157
|
+
},
|
|
158
|
+
"members_can_create_private_repositories": {
|
|
159
|
+
"type": "boolean",
|
|
160
|
+
"description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."
|
|
161
|
+
},
|
|
162
|
+
"members_can_create_public_repositories": {
|
|
163
|
+
"type": "boolean",
|
|
164
|
+
"description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation."
|
|
165
|
+
},
|
|
166
|
+
"members_allowed_repository_creation_type": {
|
|
167
|
+
"type": "string",
|
|
168
|
+
"description": "Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n**Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.",
|
|
169
|
+
"enum": [
|
|
170
|
+
"all",
|
|
171
|
+
"private",
|
|
172
|
+
"none"
|
|
173
|
+
]
|
|
174
|
+
},
|
|
175
|
+
"members_can_create_pages": {
|
|
176
|
+
"type": "boolean",
|
|
177
|
+
"description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted."
|
|
178
|
+
},
|
|
179
|
+
"members_can_create_public_pages": {
|
|
180
|
+
"type": "boolean",
|
|
181
|
+
"description": "Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted."
|
|
182
|
+
},
|
|
183
|
+
"members_can_create_private_pages": {
|
|
184
|
+
"type": "boolean",
|
|
185
|
+
"description": "Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted."
|
|
186
|
+
},
|
|
187
|
+
"members_can_fork_private_repositories": {
|
|
188
|
+
"type": "boolean",
|
|
189
|
+
"description": "Whether organization members can fork private organization repositories."
|
|
190
|
+
},
|
|
191
|
+
"web_commit_signoff_required": {
|
|
192
|
+
"type": "boolean",
|
|
193
|
+
"description": "Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface."
|
|
194
|
+
},
|
|
195
|
+
"blog": {
|
|
196
|
+
"type": "string",
|
|
197
|
+
"description": "The blog field"
|
|
198
|
+
},
|
|
199
|
+
"advanced_security_enabled_for_new_repositories": {
|
|
200
|
+
"type": "boolean",
|
|
201
|
+
"description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
|
|
202
|
+
},
|
|
203
|
+
"dependabot_alerts_enabled_for_new_repositories": {
|
|
204
|
+
"type": "boolean",
|
|
205
|
+
"description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
|
|
206
|
+
},
|
|
207
|
+
"dependabot_security_updates_enabled_for_new_repositories": {
|
|
208
|
+
"type": "boolean",
|
|
209
|
+
"description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
|
|
210
|
+
},
|
|
211
|
+
"dependency_graph_enabled_for_new_repositories": {
|
|
212
|
+
"type": "boolean",
|
|
213
|
+
"description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
|
|
214
|
+
},
|
|
215
|
+
"secret_scanning_enabled_for_new_repositories": {
|
|
216
|
+
"type": "boolean",
|
|
217
|
+
"description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
|
|
218
|
+
},
|
|
219
|
+
"secret_scanning_push_protection_enabled_for_new_repositories": {
|
|
220
|
+
"type": "boolean",
|
|
221
|
+
"description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nYou can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request."
|
|
222
|
+
},
|
|
223
|
+
"secret_scanning_push_protection_custom_link_enabled": {
|
|
224
|
+
"type": "boolean",
|
|
225
|
+
"description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection."
|
|
226
|
+
},
|
|
227
|
+
"secret_scanning_push_protection_custom_link": {
|
|
228
|
+
"type": "string",
|
|
229
|
+
"description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret."
|
|
230
|
+
},
|
|
231
|
+
"deploy_keys_enabled_for_repositories": {
|
|
232
|
+
"type": "boolean",
|
|
233
|
+
"description": "Controls whether or not deploy keys may be added and used for repositories in the organization."
|
|
234
|
+
}
|
|
235
|
+
},
|
|
236
|
+
"required": [
|
|
237
|
+
"org"
|
|
238
|
+
]
|
|
239
|
+
}
|
|
240
|
+
},
|
|
241
|
+
{
|
|
242
|
+
"name": "orgs_delete",
|
|
243
|
+
"description": "Delete an organization",
|
|
244
|
+
"method": "DELETE",
|
|
245
|
+
"path": "/orgs/{org}",
|
|
246
|
+
"deleteSendsJsonBody": false,
|
|
247
|
+
"inputSchema": {
|
|
248
|
+
"type": "object",
|
|
249
|
+
"properties": {
|
|
250
|
+
"org": {
|
|
251
|
+
"type": "string",
|
|
252
|
+
"description": "The organization name. The name is not case sensitive."
|
|
253
|
+
}
|
|
254
|
+
},
|
|
255
|
+
"required": [
|
|
256
|
+
"org"
|
|
257
|
+
]
|
|
258
|
+
}
|
|
259
|
+
},
|
|
260
|
+
{
|
|
261
|
+
"name": "orgs_create_artifact_deployment_record",
|
|
262
|
+
"description": "Create an artifact deployment record",
|
|
263
|
+
"method": "POST",
|
|
264
|
+
"path": "/orgs/{org}/artifacts/metadata/deployment-record",
|
|
265
|
+
"deleteSendsJsonBody": false,
|
|
266
|
+
"inputSchema": {
|
|
267
|
+
"type": "object",
|
|
268
|
+
"properties": {
|
|
269
|
+
"org": {
|
|
270
|
+
"type": "string",
|
|
271
|
+
"description": "The organization name. The name is not case sensitive."
|
|
272
|
+
},
|
|
273
|
+
"name": {
|
|
274
|
+
"type": "string",
|
|
275
|
+
"description": "The name of the artifact."
|
|
276
|
+
},
|
|
277
|
+
"digest": {
|
|
278
|
+
"type": "string",
|
|
279
|
+
"description": "The hex encoded digest of the artifact."
|
|
280
|
+
},
|
|
281
|
+
"version": {
|
|
282
|
+
"type": "string",
|
|
283
|
+
"description": "The artifact version."
|
|
284
|
+
},
|
|
285
|
+
"status": {
|
|
286
|
+
"type": "string",
|
|
287
|
+
"description": "The status of the artifact. Can be either deployed or decommissioned.",
|
|
288
|
+
"enum": [
|
|
289
|
+
"deployed",
|
|
290
|
+
"decommissioned"
|
|
291
|
+
]
|
|
292
|
+
},
|
|
293
|
+
"logical_environment": {
|
|
294
|
+
"type": "string",
|
|
295
|
+
"description": "The stage of the deployment."
|
|
296
|
+
},
|
|
297
|
+
"physical_environment": {
|
|
298
|
+
"type": "string",
|
|
299
|
+
"description": "The physical region of the deployment."
|
|
300
|
+
},
|
|
301
|
+
"cluster": {
|
|
302
|
+
"type": "string",
|
|
303
|
+
"description": "The deployment cluster."
|
|
304
|
+
},
|
|
305
|
+
"deployment_name": {
|
|
306
|
+
"type": "string",
|
|
307
|
+
"description": "The unique identifier for the deployment represented by the new record. To accommodate differing\ncontainers and namespaces within a cluster, the following format is recommended:\n{namespaceName}-{deploymentName}-{containerName}.\n"
|
|
308
|
+
},
|
|
309
|
+
"tags": {
|
|
310
|
+
"type": "object",
|
|
311
|
+
"description": "The tags associated with the deployment."
|
|
312
|
+
},
|
|
313
|
+
"runtime_risks": {
|
|
314
|
+
"type": "array",
|
|
315
|
+
"description": "A list of runtime risks associated with the deployment."
|
|
316
|
+
},
|
|
317
|
+
"github_repository": {
|
|
318
|
+
"type": "string",
|
|
319
|
+
"description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter."
|
|
320
|
+
}
|
|
321
|
+
},
|
|
322
|
+
"required": [
|
|
323
|
+
"org",
|
|
324
|
+
"name",
|
|
325
|
+
"digest",
|
|
326
|
+
"status",
|
|
327
|
+
"logical_environment",
|
|
328
|
+
"deployment_name"
|
|
329
|
+
]
|
|
330
|
+
}
|
|
331
|
+
},
|
|
332
|
+
{
|
|
333
|
+
"name": "orgs_set_cluster_deployment_records",
|
|
334
|
+
"description": "Set cluster deployment records",
|
|
335
|
+
"method": "POST",
|
|
336
|
+
"path": "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}",
|
|
337
|
+
"deleteSendsJsonBody": false,
|
|
338
|
+
"inputSchema": {
|
|
339
|
+
"type": "object",
|
|
340
|
+
"properties": {
|
|
341
|
+
"org": {
|
|
342
|
+
"type": "string",
|
|
343
|
+
"description": "The organization name. The name is not case sensitive."
|
|
344
|
+
},
|
|
345
|
+
"cluster": {
|
|
346
|
+
"type": "string",
|
|
347
|
+
"description": "The cluster name."
|
|
348
|
+
},
|
|
349
|
+
"logical_environment": {
|
|
350
|
+
"type": "string",
|
|
351
|
+
"description": "The stage of the deployment."
|
|
352
|
+
},
|
|
353
|
+
"physical_environment": {
|
|
354
|
+
"type": "string",
|
|
355
|
+
"description": "The physical region of the deployment."
|
|
356
|
+
},
|
|
357
|
+
"deployments": {
|
|
358
|
+
"type": "array",
|
|
359
|
+
"description": "The list of deployments to record."
|
|
360
|
+
}
|
|
361
|
+
},
|
|
362
|
+
"required": [
|
|
363
|
+
"org",
|
|
364
|
+
"cluster",
|
|
365
|
+
"logical_environment",
|
|
366
|
+
"deployments"
|
|
367
|
+
]
|
|
368
|
+
}
|
|
369
|
+
},
|
|
370
|
+
{
|
|
371
|
+
"name": "orgs_create_artifact_storage_record",
|
|
372
|
+
"description": "Create artifact metadata storage record",
|
|
373
|
+
"method": "POST",
|
|
374
|
+
"path": "/orgs/{org}/artifacts/metadata/storage-record",
|
|
375
|
+
"deleteSendsJsonBody": false,
|
|
376
|
+
"inputSchema": {
|
|
377
|
+
"type": "object",
|
|
378
|
+
"properties": {
|
|
379
|
+
"org": {
|
|
380
|
+
"type": "string",
|
|
381
|
+
"description": "The organization name. The name is not case sensitive."
|
|
382
|
+
},
|
|
383
|
+
"name": {
|
|
384
|
+
"type": "string",
|
|
385
|
+
"description": "The name of the artifact."
|
|
386
|
+
},
|
|
387
|
+
"digest": {
|
|
388
|
+
"type": "string",
|
|
389
|
+
"description": "The digest of the artifact (algorithm:hex-encoded-digest)."
|
|
390
|
+
},
|
|
391
|
+
"version": {
|
|
392
|
+
"type": "string",
|
|
393
|
+
"description": "The artifact version."
|
|
394
|
+
},
|
|
395
|
+
"artifact_url": {
|
|
396
|
+
"type": "string",
|
|
397
|
+
"description": "The URL where the artifact is stored."
|
|
398
|
+
},
|
|
399
|
+
"path": {
|
|
400
|
+
"type": "string",
|
|
401
|
+
"description": "The path of the artifact."
|
|
402
|
+
},
|
|
403
|
+
"registry_url": {
|
|
404
|
+
"type": "string",
|
|
405
|
+
"description": "The base URL of the artifact registry."
|
|
406
|
+
},
|
|
407
|
+
"repository": {
|
|
408
|
+
"type": "string",
|
|
409
|
+
"description": "The repository name within the registry."
|
|
410
|
+
},
|
|
411
|
+
"status": {
|
|
412
|
+
"type": "string",
|
|
413
|
+
"description": "The status of the artifact (e.g., active, inactive).",
|
|
414
|
+
"enum": [
|
|
415
|
+
"active",
|
|
416
|
+
"eol",
|
|
417
|
+
"deleted"
|
|
418
|
+
]
|
|
419
|
+
},
|
|
420
|
+
"github_repository": {
|
|
421
|
+
"type": "string",
|
|
422
|
+
"description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter."
|
|
423
|
+
}
|
|
424
|
+
},
|
|
425
|
+
"required": [
|
|
426
|
+
"org",
|
|
427
|
+
"name",
|
|
428
|
+
"digest",
|
|
429
|
+
"registry_url"
|
|
430
|
+
]
|
|
431
|
+
}
|
|
432
|
+
},
|
|
433
|
+
{
|
|
434
|
+
"name": "orgs_list_artifact_deployment_records",
|
|
435
|
+
"description": "List artifact deployment records",
|
|
436
|
+
"method": "GET",
|
|
437
|
+
"path": "/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records",
|
|
438
|
+
"deleteSendsJsonBody": false,
|
|
439
|
+
"inputSchema": {
|
|
440
|
+
"type": "object",
|
|
441
|
+
"properties": {
|
|
442
|
+
"org": {
|
|
443
|
+
"type": "string",
|
|
444
|
+
"description": "The organization name. The name is not case sensitive."
|
|
445
|
+
},
|
|
446
|
+
"subject_digest": {
|
|
447
|
+
"type": "string",
|
|
448
|
+
"description": "The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`."
|
|
449
|
+
}
|
|
450
|
+
},
|
|
451
|
+
"required": [
|
|
452
|
+
"org",
|
|
453
|
+
"subject_digest"
|
|
454
|
+
]
|
|
455
|
+
}
|
|
456
|
+
},
|
|
457
|
+
{
|
|
458
|
+
"name": "orgs_list_artifact_storage_records",
|
|
459
|
+
"description": "List artifact storage records",
|
|
460
|
+
"method": "GET",
|
|
461
|
+
"path": "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records",
|
|
462
|
+
"deleteSendsJsonBody": false,
|
|
463
|
+
"inputSchema": {
|
|
464
|
+
"type": "object",
|
|
465
|
+
"properties": {
|
|
466
|
+
"org": {
|
|
467
|
+
"type": "string",
|
|
468
|
+
"description": "The organization name. The name is not case sensitive."
|
|
469
|
+
},
|
|
470
|
+
"subject_digest": {
|
|
471
|
+
"type": "string",
|
|
472
|
+
"description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`."
|
|
473
|
+
}
|
|
474
|
+
},
|
|
475
|
+
"required": [
|
|
476
|
+
"org",
|
|
477
|
+
"subject_digest"
|
|
478
|
+
]
|
|
479
|
+
}
|
|
480
|
+
},
|
|
481
|
+
{
|
|
482
|
+
"name": "orgs_list_attestations_bulk",
|
|
483
|
+
"description": "List attestations by bulk subject digests",
|
|
484
|
+
"method": "POST",
|
|
485
|
+
"path": "/orgs/{org}/attestations/bulk-list",
|
|
486
|
+
"deleteSendsJsonBody": false,
|
|
487
|
+
"inputSchema": {
|
|
488
|
+
"type": "object",
|
|
489
|
+
"properties": {
|
|
490
|
+
"per_page": {
|
|
491
|
+
"type": "number",
|
|
492
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
493
|
+
},
|
|
494
|
+
"before": {
|
|
495
|
+
"type": "string",
|
|
496
|
+
"description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
497
|
+
},
|
|
498
|
+
"after": {
|
|
499
|
+
"type": "string",
|
|
500
|
+
"description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
501
|
+
},
|
|
502
|
+
"org": {
|
|
503
|
+
"type": "string",
|
|
504
|
+
"description": "The organization name. The name is not case sensitive."
|
|
505
|
+
},
|
|
506
|
+
"subject_digests": {
|
|
507
|
+
"type": "array",
|
|
508
|
+
"description": "List of subject digests to fetch attestations for."
|
|
509
|
+
},
|
|
510
|
+
"predicate_type": {
|
|
511
|
+
"type": "string",
|
|
512
|
+
"description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types."
|
|
513
|
+
}
|
|
514
|
+
},
|
|
515
|
+
"required": [
|
|
516
|
+
"org",
|
|
517
|
+
"subject_digests"
|
|
518
|
+
]
|
|
519
|
+
}
|
|
520
|
+
},
|
|
521
|
+
{
|
|
522
|
+
"name": "orgs_delete_attestations_bulk",
|
|
523
|
+
"description": "Delete attestations in bulk",
|
|
524
|
+
"method": "POST",
|
|
525
|
+
"path": "/orgs/{org}/attestations/delete-request",
|
|
526
|
+
"deleteSendsJsonBody": false,
|
|
527
|
+
"inputSchema": {
|
|
528
|
+
"type": "object",
|
|
529
|
+
"properties": {
|
|
530
|
+
"org": {
|
|
531
|
+
"type": "string",
|
|
532
|
+
"description": "The organization name. The name is not case sensitive."
|
|
533
|
+
}
|
|
534
|
+
},
|
|
535
|
+
"required": [
|
|
536
|
+
"org"
|
|
537
|
+
]
|
|
538
|
+
}
|
|
539
|
+
},
|
|
540
|
+
{
|
|
541
|
+
"name": "orgs_delete_attestations_by_subject_digest",
|
|
542
|
+
"description": "Delete attestations by subject digest",
|
|
543
|
+
"method": "DELETE",
|
|
544
|
+
"path": "/orgs/{org}/attestations/digest/{subject_digest}",
|
|
545
|
+
"deleteSendsJsonBody": false,
|
|
546
|
+
"inputSchema": {
|
|
547
|
+
"type": "object",
|
|
548
|
+
"properties": {
|
|
549
|
+
"org": {
|
|
550
|
+
"type": "string",
|
|
551
|
+
"description": "The organization name. The name is not case sensitive."
|
|
552
|
+
},
|
|
553
|
+
"subject_digest": {
|
|
554
|
+
"type": "string",
|
|
555
|
+
"description": "Subject Digest"
|
|
556
|
+
}
|
|
557
|
+
},
|
|
558
|
+
"required": [
|
|
559
|
+
"org",
|
|
560
|
+
"subject_digest"
|
|
561
|
+
]
|
|
562
|
+
}
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
"name": "orgs_list_attestation_repositories",
|
|
566
|
+
"description": "List attestation repositories",
|
|
567
|
+
"method": "GET",
|
|
568
|
+
"path": "/orgs/{org}/attestations/repositories",
|
|
569
|
+
"deleteSendsJsonBody": false,
|
|
570
|
+
"inputSchema": {
|
|
571
|
+
"type": "object",
|
|
572
|
+
"properties": {
|
|
573
|
+
"per_page": {
|
|
574
|
+
"type": "number",
|
|
575
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
576
|
+
},
|
|
577
|
+
"before": {
|
|
578
|
+
"type": "string",
|
|
579
|
+
"description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
580
|
+
},
|
|
581
|
+
"after": {
|
|
582
|
+
"type": "string",
|
|
583
|
+
"description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
584
|
+
},
|
|
585
|
+
"org": {
|
|
586
|
+
"type": "string",
|
|
587
|
+
"description": "The organization name. The name is not case sensitive."
|
|
588
|
+
},
|
|
589
|
+
"predicate_type": {
|
|
590
|
+
"type": "string",
|
|
591
|
+
"description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types."
|
|
592
|
+
}
|
|
593
|
+
},
|
|
594
|
+
"required": [
|
|
595
|
+
"org"
|
|
596
|
+
]
|
|
597
|
+
}
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
"name": "orgs_delete_attestations_by_id",
|
|
601
|
+
"description": "Delete attestations by ID",
|
|
602
|
+
"method": "DELETE",
|
|
603
|
+
"path": "/orgs/{org}/attestations/{attestation_id}",
|
|
604
|
+
"deleteSendsJsonBody": false,
|
|
605
|
+
"inputSchema": {
|
|
606
|
+
"type": "object",
|
|
607
|
+
"properties": {
|
|
608
|
+
"org": {
|
|
609
|
+
"type": "string",
|
|
610
|
+
"description": "The organization name. The name is not case sensitive."
|
|
611
|
+
},
|
|
612
|
+
"attestation_id": {
|
|
613
|
+
"type": "number",
|
|
614
|
+
"description": "Attestation ID"
|
|
615
|
+
}
|
|
616
|
+
},
|
|
617
|
+
"required": [
|
|
618
|
+
"org",
|
|
619
|
+
"attestation_id"
|
|
620
|
+
]
|
|
621
|
+
}
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
"name": "orgs_list_attestations",
|
|
625
|
+
"description": "List attestations",
|
|
626
|
+
"method": "GET",
|
|
627
|
+
"path": "/orgs/{org}/attestations/{subject_digest}",
|
|
628
|
+
"deleteSendsJsonBody": false,
|
|
629
|
+
"inputSchema": {
|
|
630
|
+
"type": "object",
|
|
631
|
+
"properties": {
|
|
632
|
+
"per_page": {
|
|
633
|
+
"type": "number",
|
|
634
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
635
|
+
},
|
|
636
|
+
"before": {
|
|
637
|
+
"type": "string",
|
|
638
|
+
"description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
639
|
+
},
|
|
640
|
+
"after": {
|
|
641
|
+
"type": "string",
|
|
642
|
+
"description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
643
|
+
},
|
|
644
|
+
"org": {
|
|
645
|
+
"type": "string",
|
|
646
|
+
"description": "The organization name. The name is not case sensitive."
|
|
647
|
+
},
|
|
648
|
+
"subject_digest": {
|
|
649
|
+
"type": "string",
|
|
650
|
+
"description": "The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`."
|
|
651
|
+
},
|
|
652
|
+
"predicate_type": {
|
|
653
|
+
"type": "string",
|
|
654
|
+
"description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, `release`, or freeform text\nfor custom predicate types."
|
|
655
|
+
}
|
|
656
|
+
},
|
|
657
|
+
"required": [
|
|
658
|
+
"org",
|
|
659
|
+
"subject_digest"
|
|
660
|
+
]
|
|
661
|
+
}
|
|
662
|
+
},
|
|
663
|
+
{
|
|
664
|
+
"name": "orgs_list_blocked_users",
|
|
665
|
+
"description": "List users blocked by an organization",
|
|
666
|
+
"method": "GET",
|
|
667
|
+
"path": "/orgs/{org}/blocks",
|
|
668
|
+
"deleteSendsJsonBody": false,
|
|
669
|
+
"inputSchema": {
|
|
670
|
+
"type": "object",
|
|
671
|
+
"properties": {
|
|
672
|
+
"org": {
|
|
673
|
+
"type": "string",
|
|
674
|
+
"description": "The organization name. The name is not case sensitive."
|
|
675
|
+
},
|
|
676
|
+
"per_page": {
|
|
677
|
+
"type": "number",
|
|
678
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
679
|
+
},
|
|
680
|
+
"page": {
|
|
681
|
+
"type": "number",
|
|
682
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
683
|
+
}
|
|
684
|
+
},
|
|
685
|
+
"required": [
|
|
686
|
+
"org"
|
|
687
|
+
]
|
|
688
|
+
}
|
|
689
|
+
},
|
|
690
|
+
{
|
|
691
|
+
"name": "orgs_check_blocked_user",
|
|
692
|
+
"description": "Check if a user is blocked by an organization",
|
|
693
|
+
"method": "GET",
|
|
694
|
+
"path": "/orgs/{org}/blocks/{username}",
|
|
695
|
+
"deleteSendsJsonBody": false,
|
|
696
|
+
"inputSchema": {
|
|
697
|
+
"type": "object",
|
|
698
|
+
"properties": {
|
|
699
|
+
"org": {
|
|
700
|
+
"type": "string",
|
|
701
|
+
"description": "The organization name. The name is not case sensitive."
|
|
702
|
+
},
|
|
703
|
+
"username": {
|
|
704
|
+
"type": "string",
|
|
705
|
+
"description": "The handle for the GitHub user account."
|
|
706
|
+
}
|
|
707
|
+
},
|
|
708
|
+
"required": [
|
|
709
|
+
"org",
|
|
710
|
+
"username"
|
|
711
|
+
]
|
|
712
|
+
}
|
|
713
|
+
},
|
|
714
|
+
{
|
|
715
|
+
"name": "orgs_block_user",
|
|
716
|
+
"description": "Block a user from an organization",
|
|
717
|
+
"method": "PUT",
|
|
718
|
+
"path": "/orgs/{org}/blocks/{username}",
|
|
719
|
+
"deleteSendsJsonBody": false,
|
|
720
|
+
"inputSchema": {
|
|
721
|
+
"type": "object",
|
|
722
|
+
"properties": {
|
|
723
|
+
"org": {
|
|
724
|
+
"type": "string",
|
|
725
|
+
"description": "The organization name. The name is not case sensitive."
|
|
726
|
+
},
|
|
727
|
+
"username": {
|
|
728
|
+
"type": "string",
|
|
729
|
+
"description": "The handle for the GitHub user account."
|
|
730
|
+
}
|
|
731
|
+
},
|
|
732
|
+
"required": [
|
|
733
|
+
"org",
|
|
734
|
+
"username"
|
|
735
|
+
]
|
|
736
|
+
}
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
"name": "orgs_unblock_user",
|
|
740
|
+
"description": "Unblock a user from an organization",
|
|
741
|
+
"method": "DELETE",
|
|
742
|
+
"path": "/orgs/{org}/blocks/{username}",
|
|
743
|
+
"deleteSendsJsonBody": false,
|
|
744
|
+
"inputSchema": {
|
|
745
|
+
"type": "object",
|
|
746
|
+
"properties": {
|
|
747
|
+
"org": {
|
|
748
|
+
"type": "string",
|
|
749
|
+
"description": "The organization name. The name is not case sensitive."
|
|
750
|
+
},
|
|
751
|
+
"username": {
|
|
752
|
+
"type": "string",
|
|
753
|
+
"description": "The handle for the GitHub user account."
|
|
754
|
+
}
|
|
755
|
+
},
|
|
756
|
+
"required": [
|
|
757
|
+
"org",
|
|
758
|
+
"username"
|
|
759
|
+
]
|
|
760
|
+
}
|
|
761
|
+
},
|
|
762
|
+
{
|
|
763
|
+
"name": "orgs_list_failed_invitations",
|
|
764
|
+
"description": "List failed organization invitations",
|
|
765
|
+
"method": "GET",
|
|
766
|
+
"path": "/orgs/{org}/failed_invitations",
|
|
767
|
+
"deleteSendsJsonBody": false,
|
|
768
|
+
"inputSchema": {
|
|
769
|
+
"type": "object",
|
|
770
|
+
"properties": {
|
|
771
|
+
"org": {
|
|
772
|
+
"type": "string",
|
|
773
|
+
"description": "The organization name. The name is not case sensitive."
|
|
774
|
+
},
|
|
775
|
+
"per_page": {
|
|
776
|
+
"type": "number",
|
|
777
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
778
|
+
},
|
|
779
|
+
"page": {
|
|
780
|
+
"type": "number",
|
|
781
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
782
|
+
}
|
|
783
|
+
},
|
|
784
|
+
"required": [
|
|
785
|
+
"org"
|
|
786
|
+
]
|
|
787
|
+
}
|
|
788
|
+
},
|
|
789
|
+
{
|
|
790
|
+
"name": "orgs_list_webhooks",
|
|
791
|
+
"description": "List organization webhooks",
|
|
792
|
+
"method": "GET",
|
|
793
|
+
"path": "/orgs/{org}/hooks",
|
|
794
|
+
"deleteSendsJsonBody": false,
|
|
795
|
+
"inputSchema": {
|
|
796
|
+
"type": "object",
|
|
797
|
+
"properties": {
|
|
798
|
+
"org": {
|
|
799
|
+
"type": "string",
|
|
800
|
+
"description": "The organization name. The name is not case sensitive."
|
|
801
|
+
},
|
|
802
|
+
"per_page": {
|
|
803
|
+
"type": "number",
|
|
804
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
805
|
+
},
|
|
806
|
+
"page": {
|
|
807
|
+
"type": "number",
|
|
808
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
809
|
+
}
|
|
810
|
+
},
|
|
811
|
+
"required": [
|
|
812
|
+
"org"
|
|
813
|
+
]
|
|
814
|
+
}
|
|
815
|
+
},
|
|
816
|
+
{
|
|
817
|
+
"name": "orgs_create_webhook",
|
|
818
|
+
"description": "Create an organization webhook",
|
|
819
|
+
"method": "POST",
|
|
820
|
+
"path": "/orgs/{org}/hooks",
|
|
821
|
+
"deleteSendsJsonBody": false,
|
|
822
|
+
"inputSchema": {
|
|
823
|
+
"type": "object",
|
|
824
|
+
"properties": {
|
|
825
|
+
"org": {
|
|
826
|
+
"type": "string",
|
|
827
|
+
"description": "The organization name. The name is not case sensitive."
|
|
828
|
+
},
|
|
829
|
+
"name": {
|
|
830
|
+
"type": "string",
|
|
831
|
+
"description": "Must be passed as \"web\"."
|
|
832
|
+
},
|
|
833
|
+
"config": {
|
|
834
|
+
"type": "object",
|
|
835
|
+
"description": "Key/value pairs to provide settings for this webhook."
|
|
836
|
+
},
|
|
837
|
+
"events": {
|
|
838
|
+
"type": "array",
|
|
839
|
+
"description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events."
|
|
840
|
+
},
|
|
841
|
+
"active": {
|
|
842
|
+
"type": "boolean",
|
|
843
|
+
"description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications."
|
|
844
|
+
}
|
|
845
|
+
},
|
|
846
|
+
"required": [
|
|
847
|
+
"org",
|
|
848
|
+
"name",
|
|
849
|
+
"config"
|
|
850
|
+
]
|
|
851
|
+
}
|
|
852
|
+
},
|
|
853
|
+
{
|
|
854
|
+
"name": "orgs_get_webhook",
|
|
855
|
+
"description": "Get an organization webhook",
|
|
856
|
+
"method": "GET",
|
|
857
|
+
"path": "/orgs/{org}/hooks/{hook_id}",
|
|
858
|
+
"deleteSendsJsonBody": false,
|
|
859
|
+
"inputSchema": {
|
|
860
|
+
"type": "object",
|
|
861
|
+
"properties": {
|
|
862
|
+
"org": {
|
|
863
|
+
"type": "string",
|
|
864
|
+
"description": "The organization name. The name is not case sensitive."
|
|
865
|
+
},
|
|
866
|
+
"hook_id": {
|
|
867
|
+
"type": "number",
|
|
868
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery."
|
|
869
|
+
}
|
|
870
|
+
},
|
|
871
|
+
"required": [
|
|
872
|
+
"org",
|
|
873
|
+
"hook_id"
|
|
874
|
+
]
|
|
875
|
+
}
|
|
876
|
+
},
|
|
877
|
+
{
|
|
878
|
+
"name": "orgs_update_webhook",
|
|
879
|
+
"description": "Update an organization webhook",
|
|
880
|
+
"method": "PATCH",
|
|
881
|
+
"path": "/orgs/{org}/hooks/{hook_id}",
|
|
882
|
+
"deleteSendsJsonBody": false,
|
|
883
|
+
"inputSchema": {
|
|
884
|
+
"type": "object",
|
|
885
|
+
"properties": {
|
|
886
|
+
"org": {
|
|
887
|
+
"type": "string",
|
|
888
|
+
"description": "The organization name. The name is not case sensitive."
|
|
889
|
+
},
|
|
890
|
+
"hook_id": {
|
|
891
|
+
"type": "number",
|
|
892
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery."
|
|
893
|
+
},
|
|
894
|
+
"config": {
|
|
895
|
+
"type": "object",
|
|
896
|
+
"description": "Key/value pairs to provide settings for this webhook."
|
|
897
|
+
},
|
|
898
|
+
"events": {
|
|
899
|
+
"type": "array",
|
|
900
|
+
"description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for."
|
|
901
|
+
},
|
|
902
|
+
"active": {
|
|
903
|
+
"type": "boolean",
|
|
904
|
+
"description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications."
|
|
905
|
+
},
|
|
906
|
+
"name": {
|
|
907
|
+
"type": "string",
|
|
908
|
+
"description": "The name field"
|
|
909
|
+
}
|
|
910
|
+
},
|
|
911
|
+
"required": [
|
|
912
|
+
"org",
|
|
913
|
+
"hook_id"
|
|
914
|
+
]
|
|
915
|
+
}
|
|
916
|
+
},
|
|
917
|
+
{
|
|
918
|
+
"name": "orgs_delete_webhook",
|
|
919
|
+
"description": "Delete an organization webhook",
|
|
920
|
+
"method": "DELETE",
|
|
921
|
+
"path": "/orgs/{org}/hooks/{hook_id}",
|
|
922
|
+
"deleteSendsJsonBody": false,
|
|
923
|
+
"inputSchema": {
|
|
924
|
+
"type": "object",
|
|
925
|
+
"properties": {
|
|
926
|
+
"org": {
|
|
927
|
+
"type": "string",
|
|
928
|
+
"description": "The organization name. The name is not case sensitive."
|
|
929
|
+
},
|
|
930
|
+
"hook_id": {
|
|
931
|
+
"type": "number",
|
|
932
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery."
|
|
933
|
+
}
|
|
934
|
+
},
|
|
935
|
+
"required": [
|
|
936
|
+
"org",
|
|
937
|
+
"hook_id"
|
|
938
|
+
]
|
|
939
|
+
}
|
|
940
|
+
},
|
|
941
|
+
{
|
|
942
|
+
"name": "orgs_get_webhook_config_for_org",
|
|
943
|
+
"description": "Get a webhook configuration for an organization",
|
|
944
|
+
"method": "GET",
|
|
945
|
+
"path": "/orgs/{org}/hooks/{hook_id}/config",
|
|
946
|
+
"deleteSendsJsonBody": false,
|
|
947
|
+
"inputSchema": {
|
|
948
|
+
"type": "object",
|
|
949
|
+
"properties": {
|
|
950
|
+
"org": {
|
|
951
|
+
"type": "string",
|
|
952
|
+
"description": "The organization name. The name is not case sensitive."
|
|
953
|
+
},
|
|
954
|
+
"hook_id": {
|
|
955
|
+
"type": "number",
|
|
956
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery."
|
|
957
|
+
}
|
|
958
|
+
},
|
|
959
|
+
"required": [
|
|
960
|
+
"org",
|
|
961
|
+
"hook_id"
|
|
962
|
+
]
|
|
963
|
+
}
|
|
964
|
+
},
|
|
965
|
+
{
|
|
966
|
+
"name": "orgs_update_webhook_config_for_org",
|
|
967
|
+
"description": "Update a webhook configuration for an organization",
|
|
968
|
+
"method": "PATCH",
|
|
969
|
+
"path": "/orgs/{org}/hooks/{hook_id}/config",
|
|
970
|
+
"deleteSendsJsonBody": false,
|
|
971
|
+
"inputSchema": {
|
|
972
|
+
"type": "object",
|
|
973
|
+
"properties": {
|
|
974
|
+
"org": {
|
|
975
|
+
"type": "string",
|
|
976
|
+
"description": "The organization name. The name is not case sensitive."
|
|
977
|
+
},
|
|
978
|
+
"hook_id": {
|
|
979
|
+
"type": "number",
|
|
980
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery."
|
|
981
|
+
},
|
|
982
|
+
"url": {
|
|
983
|
+
"type": "string",
|
|
984
|
+
"description": "The URL to which the payloads will be delivered."
|
|
985
|
+
},
|
|
986
|
+
"content_type": {
|
|
987
|
+
"type": "string",
|
|
988
|
+
"description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`."
|
|
989
|
+
},
|
|
990
|
+
"secret": {
|
|
991
|
+
"type": "string",
|
|
992
|
+
"description": "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/webhooks/event-payloads/#delivery-headers)."
|
|
993
|
+
},
|
|
994
|
+
"insecure_ssl": {
|
|
995
|
+
"type": "string",
|
|
996
|
+
"description": "The insecure_ssl field"
|
|
997
|
+
}
|
|
998
|
+
},
|
|
999
|
+
"required": [
|
|
1000
|
+
"org",
|
|
1001
|
+
"hook_id"
|
|
1002
|
+
]
|
|
1003
|
+
}
|
|
1004
|
+
},
|
|
1005
|
+
{
|
|
1006
|
+
"name": "orgs_list_webhook_deliveries",
|
|
1007
|
+
"description": "List deliveries for an organization webhook",
|
|
1008
|
+
"method": "GET",
|
|
1009
|
+
"path": "/orgs/{org}/hooks/{hook_id}/deliveries",
|
|
1010
|
+
"deleteSendsJsonBody": false,
|
|
1011
|
+
"inputSchema": {
|
|
1012
|
+
"type": "object",
|
|
1013
|
+
"properties": {
|
|
1014
|
+
"org": {
|
|
1015
|
+
"type": "string",
|
|
1016
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1017
|
+
},
|
|
1018
|
+
"hook_id": {
|
|
1019
|
+
"type": "number",
|
|
1020
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery."
|
|
1021
|
+
},
|
|
1022
|
+
"per_page": {
|
|
1023
|
+
"type": "number",
|
|
1024
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
1025
|
+
},
|
|
1026
|
+
"cursor": {
|
|
1027
|
+
"type": "string",
|
|
1028
|
+
"description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors."
|
|
1029
|
+
},
|
|
1030
|
+
"status": {
|
|
1031
|
+
"type": "string",
|
|
1032
|
+
"description": "Returns webhook deliveries filtered by delivery outcome classification based on `status_code` range. A `status` of `success` returns deliveries with a `status_code` in the 200-399 range (inclusive). A `status` of `failure` returns deliveries with a `status_code` in the 400-599 range (inclusive).",
|
|
1033
|
+
"enum": [
|
|
1034
|
+
"success",
|
|
1035
|
+
"failure"
|
|
1036
|
+
]
|
|
1037
|
+
}
|
|
1038
|
+
},
|
|
1039
|
+
"required": [
|
|
1040
|
+
"org",
|
|
1041
|
+
"hook_id"
|
|
1042
|
+
]
|
|
1043
|
+
}
|
|
1044
|
+
},
|
|
1045
|
+
{
|
|
1046
|
+
"name": "orgs_get_webhook_delivery",
|
|
1047
|
+
"description": "Get a webhook delivery for an organization webhook",
|
|
1048
|
+
"method": "GET",
|
|
1049
|
+
"path": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}",
|
|
1050
|
+
"deleteSendsJsonBody": false,
|
|
1051
|
+
"inputSchema": {
|
|
1052
|
+
"type": "object",
|
|
1053
|
+
"properties": {
|
|
1054
|
+
"org": {
|
|
1055
|
+
"type": "string",
|
|
1056
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1057
|
+
},
|
|
1058
|
+
"hook_id": {
|
|
1059
|
+
"type": "number",
|
|
1060
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery."
|
|
1061
|
+
},
|
|
1062
|
+
"delivery_id": {
|
|
1063
|
+
"type": "number",
|
|
1064
|
+
"description": "The delivery_id parameter"
|
|
1065
|
+
}
|
|
1066
|
+
},
|
|
1067
|
+
"required": [
|
|
1068
|
+
"org",
|
|
1069
|
+
"hook_id",
|
|
1070
|
+
"delivery_id"
|
|
1071
|
+
]
|
|
1072
|
+
}
|
|
1073
|
+
},
|
|
1074
|
+
{
|
|
1075
|
+
"name": "orgs_redeliver_webhook_delivery",
|
|
1076
|
+
"description": "Redeliver a delivery for an organization webhook",
|
|
1077
|
+
"method": "POST",
|
|
1078
|
+
"path": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts",
|
|
1079
|
+
"deleteSendsJsonBody": false,
|
|
1080
|
+
"inputSchema": {
|
|
1081
|
+
"type": "object",
|
|
1082
|
+
"properties": {
|
|
1083
|
+
"org": {
|
|
1084
|
+
"type": "string",
|
|
1085
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1086
|
+
},
|
|
1087
|
+
"hook_id": {
|
|
1088
|
+
"type": "number",
|
|
1089
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery."
|
|
1090
|
+
},
|
|
1091
|
+
"delivery_id": {
|
|
1092
|
+
"type": "number",
|
|
1093
|
+
"description": "The delivery_id parameter"
|
|
1094
|
+
}
|
|
1095
|
+
},
|
|
1096
|
+
"required": [
|
|
1097
|
+
"org",
|
|
1098
|
+
"hook_id",
|
|
1099
|
+
"delivery_id"
|
|
1100
|
+
]
|
|
1101
|
+
}
|
|
1102
|
+
},
|
|
1103
|
+
{
|
|
1104
|
+
"name": "orgs_ping_webhook",
|
|
1105
|
+
"description": "Ping an organization webhook",
|
|
1106
|
+
"method": "POST",
|
|
1107
|
+
"path": "/orgs/{org}/hooks/{hook_id}/pings",
|
|
1108
|
+
"deleteSendsJsonBody": false,
|
|
1109
|
+
"inputSchema": {
|
|
1110
|
+
"type": "object",
|
|
1111
|
+
"properties": {
|
|
1112
|
+
"org": {
|
|
1113
|
+
"type": "string",
|
|
1114
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1115
|
+
},
|
|
1116
|
+
"hook_id": {
|
|
1117
|
+
"type": "number",
|
|
1118
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery."
|
|
1119
|
+
}
|
|
1120
|
+
},
|
|
1121
|
+
"required": [
|
|
1122
|
+
"org",
|
|
1123
|
+
"hook_id"
|
|
1124
|
+
]
|
|
1125
|
+
}
|
|
1126
|
+
},
|
|
1127
|
+
{
|
|
1128
|
+
"name": "api_insights_get_route_stats_by_actor",
|
|
1129
|
+
"description": "Get route stats by actor",
|
|
1130
|
+
"method": "GET",
|
|
1131
|
+
"path": "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}",
|
|
1132
|
+
"deleteSendsJsonBody": false,
|
|
1133
|
+
"inputSchema": {
|
|
1134
|
+
"type": "object",
|
|
1135
|
+
"properties": {
|
|
1136
|
+
"org": {
|
|
1137
|
+
"type": "string",
|
|
1138
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1139
|
+
},
|
|
1140
|
+
"actor_type": {
|
|
1141
|
+
"type": "string",
|
|
1142
|
+
"description": "The type of the actor",
|
|
1143
|
+
"enum": [
|
|
1144
|
+
"installation",
|
|
1145
|
+
"classic_pat",
|
|
1146
|
+
"fine_grained_pat",
|
|
1147
|
+
"oauth_app",
|
|
1148
|
+
"github_app_user_to_server"
|
|
1149
|
+
]
|
|
1150
|
+
},
|
|
1151
|
+
"actor_id": {
|
|
1152
|
+
"type": "number",
|
|
1153
|
+
"description": "The ID of the actor"
|
|
1154
|
+
},
|
|
1155
|
+
"min_timestamp": {
|
|
1156
|
+
"type": "string",
|
|
1157
|
+
"description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1158
|
+
},
|
|
1159
|
+
"max_timestamp": {
|
|
1160
|
+
"type": "string",
|
|
1161
|
+
"description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1162
|
+
},
|
|
1163
|
+
"page": {
|
|
1164
|
+
"type": "number",
|
|
1165
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
1166
|
+
},
|
|
1167
|
+
"per_page": {
|
|
1168
|
+
"type": "number",
|
|
1169
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
1170
|
+
},
|
|
1171
|
+
"direction": {
|
|
1172
|
+
"type": "string",
|
|
1173
|
+
"description": "The direction to sort the results by.",
|
|
1174
|
+
"enum": [
|
|
1175
|
+
"asc",
|
|
1176
|
+
"desc"
|
|
1177
|
+
]
|
|
1178
|
+
},
|
|
1179
|
+
"sort": {
|
|
1180
|
+
"type": "array",
|
|
1181
|
+
"description": "The property to sort the results by."
|
|
1182
|
+
},
|
|
1183
|
+
"api_route_substring": {
|
|
1184
|
+
"type": "string",
|
|
1185
|
+
"description": "Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search."
|
|
1186
|
+
}
|
|
1187
|
+
},
|
|
1188
|
+
"required": [
|
|
1189
|
+
"org",
|
|
1190
|
+
"actor_type",
|
|
1191
|
+
"actor_id",
|
|
1192
|
+
"min_timestamp"
|
|
1193
|
+
]
|
|
1194
|
+
}
|
|
1195
|
+
},
|
|
1196
|
+
{
|
|
1197
|
+
"name": "api_insights_get_subject_stats",
|
|
1198
|
+
"description": "Get subject stats",
|
|
1199
|
+
"method": "GET",
|
|
1200
|
+
"path": "/orgs/{org}/insights/api/subject-stats",
|
|
1201
|
+
"deleteSendsJsonBody": false,
|
|
1202
|
+
"inputSchema": {
|
|
1203
|
+
"type": "object",
|
|
1204
|
+
"properties": {
|
|
1205
|
+
"org": {
|
|
1206
|
+
"type": "string",
|
|
1207
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1208
|
+
},
|
|
1209
|
+
"min_timestamp": {
|
|
1210
|
+
"type": "string",
|
|
1211
|
+
"description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1212
|
+
},
|
|
1213
|
+
"max_timestamp": {
|
|
1214
|
+
"type": "string",
|
|
1215
|
+
"description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1216
|
+
},
|
|
1217
|
+
"page": {
|
|
1218
|
+
"type": "number",
|
|
1219
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
1220
|
+
},
|
|
1221
|
+
"per_page": {
|
|
1222
|
+
"type": "number",
|
|
1223
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
1224
|
+
},
|
|
1225
|
+
"direction": {
|
|
1226
|
+
"type": "string",
|
|
1227
|
+
"description": "The direction to sort the results by.",
|
|
1228
|
+
"enum": [
|
|
1229
|
+
"asc",
|
|
1230
|
+
"desc"
|
|
1231
|
+
]
|
|
1232
|
+
},
|
|
1233
|
+
"sort": {
|
|
1234
|
+
"type": "array",
|
|
1235
|
+
"description": "The property to sort the results by."
|
|
1236
|
+
},
|
|
1237
|
+
"subject_name_substring": {
|
|
1238
|
+
"type": "string",
|
|
1239
|
+
"description": "Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search."
|
|
1240
|
+
}
|
|
1241
|
+
},
|
|
1242
|
+
"required": [
|
|
1243
|
+
"org",
|
|
1244
|
+
"min_timestamp"
|
|
1245
|
+
]
|
|
1246
|
+
}
|
|
1247
|
+
},
|
|
1248
|
+
{
|
|
1249
|
+
"name": "api_insights_get_summary_stats",
|
|
1250
|
+
"description": "Get summary stats",
|
|
1251
|
+
"method": "GET",
|
|
1252
|
+
"path": "/orgs/{org}/insights/api/summary-stats",
|
|
1253
|
+
"deleteSendsJsonBody": false,
|
|
1254
|
+
"inputSchema": {
|
|
1255
|
+
"type": "object",
|
|
1256
|
+
"properties": {
|
|
1257
|
+
"org": {
|
|
1258
|
+
"type": "string",
|
|
1259
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1260
|
+
},
|
|
1261
|
+
"min_timestamp": {
|
|
1262
|
+
"type": "string",
|
|
1263
|
+
"description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1264
|
+
},
|
|
1265
|
+
"max_timestamp": {
|
|
1266
|
+
"type": "string",
|
|
1267
|
+
"description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1268
|
+
}
|
|
1269
|
+
},
|
|
1270
|
+
"required": [
|
|
1271
|
+
"org",
|
|
1272
|
+
"min_timestamp"
|
|
1273
|
+
]
|
|
1274
|
+
}
|
|
1275
|
+
},
|
|
1276
|
+
{
|
|
1277
|
+
"name": "api_insights_get_summary_stats_by_user",
|
|
1278
|
+
"description": "Get summary stats by user",
|
|
1279
|
+
"method": "GET",
|
|
1280
|
+
"path": "/orgs/{org}/insights/api/summary-stats/users/{user_id}",
|
|
1281
|
+
"deleteSendsJsonBody": false,
|
|
1282
|
+
"inputSchema": {
|
|
1283
|
+
"type": "object",
|
|
1284
|
+
"properties": {
|
|
1285
|
+
"org": {
|
|
1286
|
+
"type": "string",
|
|
1287
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1288
|
+
},
|
|
1289
|
+
"user_id": {
|
|
1290
|
+
"type": "string",
|
|
1291
|
+
"description": "The ID of the user to query for stats"
|
|
1292
|
+
},
|
|
1293
|
+
"min_timestamp": {
|
|
1294
|
+
"type": "string",
|
|
1295
|
+
"description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1296
|
+
},
|
|
1297
|
+
"max_timestamp": {
|
|
1298
|
+
"type": "string",
|
|
1299
|
+
"description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1300
|
+
}
|
|
1301
|
+
},
|
|
1302
|
+
"required": [
|
|
1303
|
+
"org",
|
|
1304
|
+
"user_id",
|
|
1305
|
+
"min_timestamp"
|
|
1306
|
+
]
|
|
1307
|
+
}
|
|
1308
|
+
},
|
|
1309
|
+
{
|
|
1310
|
+
"name": "api_insights_get_summary_stats_by_actor",
|
|
1311
|
+
"description": "Get summary stats by actor",
|
|
1312
|
+
"method": "GET",
|
|
1313
|
+
"path": "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}",
|
|
1314
|
+
"deleteSendsJsonBody": false,
|
|
1315
|
+
"inputSchema": {
|
|
1316
|
+
"type": "object",
|
|
1317
|
+
"properties": {
|
|
1318
|
+
"org": {
|
|
1319
|
+
"type": "string",
|
|
1320
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1321
|
+
},
|
|
1322
|
+
"min_timestamp": {
|
|
1323
|
+
"type": "string",
|
|
1324
|
+
"description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1325
|
+
},
|
|
1326
|
+
"max_timestamp": {
|
|
1327
|
+
"type": "string",
|
|
1328
|
+
"description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1329
|
+
},
|
|
1330
|
+
"actor_type": {
|
|
1331
|
+
"type": "string",
|
|
1332
|
+
"description": "The type of the actor",
|
|
1333
|
+
"enum": [
|
|
1334
|
+
"installation",
|
|
1335
|
+
"classic_pat",
|
|
1336
|
+
"fine_grained_pat",
|
|
1337
|
+
"oauth_app",
|
|
1338
|
+
"github_app_user_to_server"
|
|
1339
|
+
]
|
|
1340
|
+
},
|
|
1341
|
+
"actor_id": {
|
|
1342
|
+
"type": "number",
|
|
1343
|
+
"description": "The ID of the actor"
|
|
1344
|
+
}
|
|
1345
|
+
},
|
|
1346
|
+
"required": [
|
|
1347
|
+
"org",
|
|
1348
|
+
"min_timestamp",
|
|
1349
|
+
"actor_type",
|
|
1350
|
+
"actor_id"
|
|
1351
|
+
]
|
|
1352
|
+
}
|
|
1353
|
+
},
|
|
1354
|
+
{
|
|
1355
|
+
"name": "api_insights_get_time_stats",
|
|
1356
|
+
"description": "Get time stats",
|
|
1357
|
+
"method": "GET",
|
|
1358
|
+
"path": "/orgs/{org}/insights/api/time-stats",
|
|
1359
|
+
"deleteSendsJsonBody": false,
|
|
1360
|
+
"inputSchema": {
|
|
1361
|
+
"type": "object",
|
|
1362
|
+
"properties": {
|
|
1363
|
+
"org": {
|
|
1364
|
+
"type": "string",
|
|
1365
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1366
|
+
},
|
|
1367
|
+
"min_timestamp": {
|
|
1368
|
+
"type": "string",
|
|
1369
|
+
"description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1370
|
+
},
|
|
1371
|
+
"max_timestamp": {
|
|
1372
|
+
"type": "string",
|
|
1373
|
+
"description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1374
|
+
},
|
|
1375
|
+
"timestamp_increment": {
|
|
1376
|
+
"type": "string",
|
|
1377
|
+
"description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)"
|
|
1378
|
+
}
|
|
1379
|
+
},
|
|
1380
|
+
"required": [
|
|
1381
|
+
"org",
|
|
1382
|
+
"min_timestamp",
|
|
1383
|
+
"timestamp_increment"
|
|
1384
|
+
]
|
|
1385
|
+
}
|
|
1386
|
+
},
|
|
1387
|
+
{
|
|
1388
|
+
"name": "api_insights_get_time_stats_by_user",
|
|
1389
|
+
"description": "Get time stats by user",
|
|
1390
|
+
"method": "GET",
|
|
1391
|
+
"path": "/orgs/{org}/insights/api/time-stats/users/{user_id}",
|
|
1392
|
+
"deleteSendsJsonBody": false,
|
|
1393
|
+
"inputSchema": {
|
|
1394
|
+
"type": "object",
|
|
1395
|
+
"properties": {
|
|
1396
|
+
"org": {
|
|
1397
|
+
"type": "string",
|
|
1398
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1399
|
+
},
|
|
1400
|
+
"user_id": {
|
|
1401
|
+
"type": "string",
|
|
1402
|
+
"description": "The ID of the user to query for stats"
|
|
1403
|
+
},
|
|
1404
|
+
"min_timestamp": {
|
|
1405
|
+
"type": "string",
|
|
1406
|
+
"description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1407
|
+
},
|
|
1408
|
+
"max_timestamp": {
|
|
1409
|
+
"type": "string",
|
|
1410
|
+
"description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1411
|
+
},
|
|
1412
|
+
"timestamp_increment": {
|
|
1413
|
+
"type": "string",
|
|
1414
|
+
"description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)"
|
|
1415
|
+
}
|
|
1416
|
+
},
|
|
1417
|
+
"required": [
|
|
1418
|
+
"org",
|
|
1419
|
+
"user_id",
|
|
1420
|
+
"min_timestamp",
|
|
1421
|
+
"timestamp_increment"
|
|
1422
|
+
]
|
|
1423
|
+
}
|
|
1424
|
+
},
|
|
1425
|
+
{
|
|
1426
|
+
"name": "api_insights_get_time_stats_by_actor",
|
|
1427
|
+
"description": "Get time stats by actor",
|
|
1428
|
+
"method": "GET",
|
|
1429
|
+
"path": "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}",
|
|
1430
|
+
"deleteSendsJsonBody": false,
|
|
1431
|
+
"inputSchema": {
|
|
1432
|
+
"type": "object",
|
|
1433
|
+
"properties": {
|
|
1434
|
+
"org": {
|
|
1435
|
+
"type": "string",
|
|
1436
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1437
|
+
},
|
|
1438
|
+
"actor_type": {
|
|
1439
|
+
"type": "string",
|
|
1440
|
+
"description": "The type of the actor",
|
|
1441
|
+
"enum": [
|
|
1442
|
+
"installation",
|
|
1443
|
+
"classic_pat",
|
|
1444
|
+
"fine_grained_pat",
|
|
1445
|
+
"oauth_app",
|
|
1446
|
+
"github_app_user_to_server"
|
|
1447
|
+
]
|
|
1448
|
+
},
|
|
1449
|
+
"actor_id": {
|
|
1450
|
+
"type": "number",
|
|
1451
|
+
"description": "The ID of the actor"
|
|
1452
|
+
},
|
|
1453
|
+
"min_timestamp": {
|
|
1454
|
+
"type": "string",
|
|
1455
|
+
"description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1456
|
+
},
|
|
1457
|
+
"max_timestamp": {
|
|
1458
|
+
"type": "string",
|
|
1459
|
+
"description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1460
|
+
},
|
|
1461
|
+
"timestamp_increment": {
|
|
1462
|
+
"type": "string",
|
|
1463
|
+
"description": "The increment of time used to breakdown the query results (5m, 10m, 1h, etc.)"
|
|
1464
|
+
}
|
|
1465
|
+
},
|
|
1466
|
+
"required": [
|
|
1467
|
+
"org",
|
|
1468
|
+
"actor_type",
|
|
1469
|
+
"actor_id",
|
|
1470
|
+
"min_timestamp",
|
|
1471
|
+
"timestamp_increment"
|
|
1472
|
+
]
|
|
1473
|
+
}
|
|
1474
|
+
},
|
|
1475
|
+
{
|
|
1476
|
+
"name": "api_insights_get_user_stats",
|
|
1477
|
+
"description": "Get user stats",
|
|
1478
|
+
"method": "GET",
|
|
1479
|
+
"path": "/orgs/{org}/insights/api/user-stats/{user_id}",
|
|
1480
|
+
"deleteSendsJsonBody": false,
|
|
1481
|
+
"inputSchema": {
|
|
1482
|
+
"type": "object",
|
|
1483
|
+
"properties": {
|
|
1484
|
+
"org": {
|
|
1485
|
+
"type": "string",
|
|
1486
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1487
|
+
},
|
|
1488
|
+
"user_id": {
|
|
1489
|
+
"type": "string",
|
|
1490
|
+
"description": "The ID of the user to query for stats"
|
|
1491
|
+
},
|
|
1492
|
+
"min_timestamp": {
|
|
1493
|
+
"type": "string",
|
|
1494
|
+
"description": "The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1495
|
+
},
|
|
1496
|
+
"max_timestamp": {
|
|
1497
|
+
"type": "string",
|
|
1498
|
+
"description": "The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
1499
|
+
},
|
|
1500
|
+
"page": {
|
|
1501
|
+
"type": "number",
|
|
1502
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
1503
|
+
},
|
|
1504
|
+
"per_page": {
|
|
1505
|
+
"type": "number",
|
|
1506
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
1507
|
+
},
|
|
1508
|
+
"direction": {
|
|
1509
|
+
"type": "string",
|
|
1510
|
+
"description": "The direction to sort the results by.",
|
|
1511
|
+
"enum": [
|
|
1512
|
+
"asc",
|
|
1513
|
+
"desc"
|
|
1514
|
+
]
|
|
1515
|
+
},
|
|
1516
|
+
"sort": {
|
|
1517
|
+
"type": "array",
|
|
1518
|
+
"description": "The property to sort the results by."
|
|
1519
|
+
},
|
|
1520
|
+
"actor_name_substring": {
|
|
1521
|
+
"type": "string",
|
|
1522
|
+
"description": "Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search."
|
|
1523
|
+
}
|
|
1524
|
+
},
|
|
1525
|
+
"required": [
|
|
1526
|
+
"org",
|
|
1527
|
+
"user_id",
|
|
1528
|
+
"min_timestamp"
|
|
1529
|
+
]
|
|
1530
|
+
}
|
|
1531
|
+
},
|
|
1532
|
+
{
|
|
1533
|
+
"name": "orgs_list_app_installations",
|
|
1534
|
+
"description": "List app installations for an organization",
|
|
1535
|
+
"method": "GET",
|
|
1536
|
+
"path": "/orgs/{org}/installations",
|
|
1537
|
+
"deleteSendsJsonBody": false,
|
|
1538
|
+
"inputSchema": {
|
|
1539
|
+
"type": "object",
|
|
1540
|
+
"properties": {
|
|
1541
|
+
"org": {
|
|
1542
|
+
"type": "string",
|
|
1543
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1544
|
+
},
|
|
1545
|
+
"per_page": {
|
|
1546
|
+
"type": "number",
|
|
1547
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
1548
|
+
},
|
|
1549
|
+
"page": {
|
|
1550
|
+
"type": "number",
|
|
1551
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
1552
|
+
}
|
|
1553
|
+
},
|
|
1554
|
+
"required": [
|
|
1555
|
+
"org"
|
|
1556
|
+
]
|
|
1557
|
+
}
|
|
1558
|
+
},
|
|
1559
|
+
{
|
|
1560
|
+
"name": "orgs_list_pending_invitations",
|
|
1561
|
+
"description": "List pending organization invitations",
|
|
1562
|
+
"method": "GET",
|
|
1563
|
+
"path": "/orgs/{org}/invitations",
|
|
1564
|
+
"deleteSendsJsonBody": false,
|
|
1565
|
+
"inputSchema": {
|
|
1566
|
+
"type": "object",
|
|
1567
|
+
"properties": {
|
|
1568
|
+
"org": {
|
|
1569
|
+
"type": "string",
|
|
1570
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1571
|
+
},
|
|
1572
|
+
"per_page": {
|
|
1573
|
+
"type": "number",
|
|
1574
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
1575
|
+
},
|
|
1576
|
+
"page": {
|
|
1577
|
+
"type": "number",
|
|
1578
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
1579
|
+
},
|
|
1580
|
+
"role": {
|
|
1581
|
+
"type": "string",
|
|
1582
|
+
"description": "Filter invitations by their member role.",
|
|
1583
|
+
"enum": [
|
|
1584
|
+
"all",
|
|
1585
|
+
"admin",
|
|
1586
|
+
"direct_member",
|
|
1587
|
+
"billing_manager",
|
|
1588
|
+
"hiring_manager"
|
|
1589
|
+
]
|
|
1590
|
+
},
|
|
1591
|
+
"invitation_source": {
|
|
1592
|
+
"type": "string",
|
|
1593
|
+
"description": "Filter invitations by their invitation source.",
|
|
1594
|
+
"enum": [
|
|
1595
|
+
"all",
|
|
1596
|
+
"member",
|
|
1597
|
+
"scim"
|
|
1598
|
+
]
|
|
1599
|
+
}
|
|
1600
|
+
},
|
|
1601
|
+
"required": [
|
|
1602
|
+
"org"
|
|
1603
|
+
]
|
|
1604
|
+
}
|
|
1605
|
+
},
|
|
1606
|
+
{
|
|
1607
|
+
"name": "orgs_create_invitation",
|
|
1608
|
+
"description": "Create an organization invitation",
|
|
1609
|
+
"method": "POST",
|
|
1610
|
+
"path": "/orgs/{org}/invitations",
|
|
1611
|
+
"deleteSendsJsonBody": false,
|
|
1612
|
+
"inputSchema": {
|
|
1613
|
+
"type": "object",
|
|
1614
|
+
"properties": {
|
|
1615
|
+
"org": {
|
|
1616
|
+
"type": "string",
|
|
1617
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1618
|
+
},
|
|
1619
|
+
"invitee_id": {
|
|
1620
|
+
"type": "number",
|
|
1621
|
+
"description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting."
|
|
1622
|
+
},
|
|
1623
|
+
"email": {
|
|
1624
|
+
"type": "string",
|
|
1625
|
+
"description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user."
|
|
1626
|
+
},
|
|
1627
|
+
"role": {
|
|
1628
|
+
"type": "string",
|
|
1629
|
+
"description": "The role for the new member. \n * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. \n * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization.",
|
|
1630
|
+
"enum": [
|
|
1631
|
+
"admin",
|
|
1632
|
+
"direct_member",
|
|
1633
|
+
"billing_manager",
|
|
1634
|
+
"reinstate"
|
|
1635
|
+
]
|
|
1636
|
+
},
|
|
1637
|
+
"team_ids": {
|
|
1638
|
+
"type": "array",
|
|
1639
|
+
"description": "Specify IDs for the teams you want to invite new members to."
|
|
1640
|
+
}
|
|
1641
|
+
},
|
|
1642
|
+
"required": [
|
|
1643
|
+
"org"
|
|
1644
|
+
]
|
|
1645
|
+
}
|
|
1646
|
+
},
|
|
1647
|
+
{
|
|
1648
|
+
"name": "orgs_cancel_invitation",
|
|
1649
|
+
"description": "Cancel an organization invitation",
|
|
1650
|
+
"method": "DELETE",
|
|
1651
|
+
"path": "/orgs/{org}/invitations/{invitation_id}",
|
|
1652
|
+
"deleteSendsJsonBody": false,
|
|
1653
|
+
"inputSchema": {
|
|
1654
|
+
"type": "object",
|
|
1655
|
+
"properties": {
|
|
1656
|
+
"org": {
|
|
1657
|
+
"type": "string",
|
|
1658
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1659
|
+
},
|
|
1660
|
+
"invitation_id": {
|
|
1661
|
+
"type": "number",
|
|
1662
|
+
"description": "The unique identifier of the invitation."
|
|
1663
|
+
}
|
|
1664
|
+
},
|
|
1665
|
+
"required": [
|
|
1666
|
+
"org",
|
|
1667
|
+
"invitation_id"
|
|
1668
|
+
]
|
|
1669
|
+
}
|
|
1670
|
+
},
|
|
1671
|
+
{
|
|
1672
|
+
"name": "orgs_list_invitation_teams",
|
|
1673
|
+
"description": "List organization invitation teams",
|
|
1674
|
+
"method": "GET",
|
|
1675
|
+
"path": "/orgs/{org}/invitations/{invitation_id}/teams",
|
|
1676
|
+
"deleteSendsJsonBody": false,
|
|
1677
|
+
"inputSchema": {
|
|
1678
|
+
"type": "object",
|
|
1679
|
+
"properties": {
|
|
1680
|
+
"org": {
|
|
1681
|
+
"type": "string",
|
|
1682
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1683
|
+
},
|
|
1684
|
+
"invitation_id": {
|
|
1685
|
+
"type": "number",
|
|
1686
|
+
"description": "The unique identifier of the invitation."
|
|
1687
|
+
},
|
|
1688
|
+
"per_page": {
|
|
1689
|
+
"type": "number",
|
|
1690
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
1691
|
+
},
|
|
1692
|
+
"page": {
|
|
1693
|
+
"type": "number",
|
|
1694
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
1695
|
+
}
|
|
1696
|
+
},
|
|
1697
|
+
"required": [
|
|
1698
|
+
"org",
|
|
1699
|
+
"invitation_id"
|
|
1700
|
+
]
|
|
1701
|
+
}
|
|
1702
|
+
},
|
|
1703
|
+
{
|
|
1704
|
+
"name": "orgs_list_issue_fields",
|
|
1705
|
+
"description": "List issue fields for an organization",
|
|
1706
|
+
"method": "GET",
|
|
1707
|
+
"path": "/orgs/{org}/issue-fields",
|
|
1708
|
+
"deleteSendsJsonBody": false,
|
|
1709
|
+
"inputSchema": {
|
|
1710
|
+
"type": "object",
|
|
1711
|
+
"properties": {
|
|
1712
|
+
"org": {
|
|
1713
|
+
"type": "string",
|
|
1714
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1715
|
+
}
|
|
1716
|
+
},
|
|
1717
|
+
"required": [
|
|
1718
|
+
"org"
|
|
1719
|
+
]
|
|
1720
|
+
}
|
|
1721
|
+
},
|
|
1722
|
+
{
|
|
1723
|
+
"name": "orgs_create_issue_field",
|
|
1724
|
+
"description": "Create issue field for an organization",
|
|
1725
|
+
"method": "POST",
|
|
1726
|
+
"path": "/orgs/{org}/issue-fields",
|
|
1727
|
+
"deleteSendsJsonBody": false,
|
|
1728
|
+
"inputSchema": {
|
|
1729
|
+
"type": "object",
|
|
1730
|
+
"properties": {
|
|
1731
|
+
"org": {
|
|
1732
|
+
"type": "string",
|
|
1733
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1734
|
+
},
|
|
1735
|
+
"name": {
|
|
1736
|
+
"type": "string",
|
|
1737
|
+
"description": "Name of the issue field."
|
|
1738
|
+
},
|
|
1739
|
+
"description": {
|
|
1740
|
+
"type": "string",
|
|
1741
|
+
"description": "Description of the issue field."
|
|
1742
|
+
},
|
|
1743
|
+
"data_type": {
|
|
1744
|
+
"type": "string",
|
|
1745
|
+
"description": "The data type of the issue field.",
|
|
1746
|
+
"enum": [
|
|
1747
|
+
"text",
|
|
1748
|
+
"date",
|
|
1749
|
+
"single_select",
|
|
1750
|
+
"number"
|
|
1751
|
+
]
|
|
1752
|
+
},
|
|
1753
|
+
"visibility": {
|
|
1754
|
+
"type": "string",
|
|
1755
|
+
"description": "The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues). Only used when the visibility settings feature is enabled. Defaults to `organization_members_only`.",
|
|
1756
|
+
"enum": [
|
|
1757
|
+
"organization_members_only",
|
|
1758
|
+
"all"
|
|
1759
|
+
]
|
|
1760
|
+
},
|
|
1761
|
+
"options": {
|
|
1762
|
+
"type": "array",
|
|
1763
|
+
"description": "Options for single select fields. Required when data_type is 'single_select'."
|
|
1764
|
+
}
|
|
1765
|
+
},
|
|
1766
|
+
"required": [
|
|
1767
|
+
"org",
|
|
1768
|
+
"name",
|
|
1769
|
+
"data_type"
|
|
1770
|
+
]
|
|
1771
|
+
}
|
|
1772
|
+
},
|
|
1773
|
+
{
|
|
1774
|
+
"name": "orgs_update_issue_field",
|
|
1775
|
+
"description": "Update issue field for an organization",
|
|
1776
|
+
"method": "PATCH",
|
|
1777
|
+
"path": "/orgs/{org}/issue-fields/{issue_field_id}",
|
|
1778
|
+
"deleteSendsJsonBody": false,
|
|
1779
|
+
"inputSchema": {
|
|
1780
|
+
"type": "object",
|
|
1781
|
+
"properties": {
|
|
1782
|
+
"org": {
|
|
1783
|
+
"type": "string",
|
|
1784
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1785
|
+
},
|
|
1786
|
+
"issue_field_id": {
|
|
1787
|
+
"type": "number",
|
|
1788
|
+
"description": "The unique identifier of the issue field."
|
|
1789
|
+
},
|
|
1790
|
+
"name": {
|
|
1791
|
+
"type": "string",
|
|
1792
|
+
"description": "Name of the issue field."
|
|
1793
|
+
},
|
|
1794
|
+
"description": {
|
|
1795
|
+
"type": "string",
|
|
1796
|
+
"description": "Description of the issue field."
|
|
1797
|
+
},
|
|
1798
|
+
"visibility": {
|
|
1799
|
+
"type": "string",
|
|
1800
|
+
"description": "The visibility of the issue field. Can be `organization_members_only` (visible only within the organization) or `all` (visible to all users who can see issues). Only used when the visibility settings feature is enabled.",
|
|
1801
|
+
"enum": [
|
|
1802
|
+
"organization_members_only",
|
|
1803
|
+
"all"
|
|
1804
|
+
]
|
|
1805
|
+
},
|
|
1806
|
+
"options": {
|
|
1807
|
+
"type": "array",
|
|
1808
|
+
"description": "Options for single select fields. Only applicable when updating single_select fields."
|
|
1809
|
+
}
|
|
1810
|
+
},
|
|
1811
|
+
"required": [
|
|
1812
|
+
"org",
|
|
1813
|
+
"issue_field_id"
|
|
1814
|
+
]
|
|
1815
|
+
}
|
|
1816
|
+
},
|
|
1817
|
+
{
|
|
1818
|
+
"name": "orgs_delete_issue_field",
|
|
1819
|
+
"description": "Delete issue field for an organization",
|
|
1820
|
+
"method": "DELETE",
|
|
1821
|
+
"path": "/orgs/{org}/issue-fields/{issue_field_id}",
|
|
1822
|
+
"deleteSendsJsonBody": false,
|
|
1823
|
+
"inputSchema": {
|
|
1824
|
+
"type": "object",
|
|
1825
|
+
"properties": {
|
|
1826
|
+
"org": {
|
|
1827
|
+
"type": "string",
|
|
1828
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1829
|
+
},
|
|
1830
|
+
"issue_field_id": {
|
|
1831
|
+
"type": "number",
|
|
1832
|
+
"description": "The unique identifier of the issue field."
|
|
1833
|
+
}
|
|
1834
|
+
},
|
|
1835
|
+
"required": [
|
|
1836
|
+
"org",
|
|
1837
|
+
"issue_field_id"
|
|
1838
|
+
]
|
|
1839
|
+
}
|
|
1840
|
+
},
|
|
1841
|
+
{
|
|
1842
|
+
"name": "orgs_list_issue_types",
|
|
1843
|
+
"description": "List issue types for an organization",
|
|
1844
|
+
"method": "GET",
|
|
1845
|
+
"path": "/orgs/{org}/issue-types",
|
|
1846
|
+
"deleteSendsJsonBody": false,
|
|
1847
|
+
"inputSchema": {
|
|
1848
|
+
"type": "object",
|
|
1849
|
+
"properties": {
|
|
1850
|
+
"org": {
|
|
1851
|
+
"type": "string",
|
|
1852
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1853
|
+
}
|
|
1854
|
+
},
|
|
1855
|
+
"required": [
|
|
1856
|
+
"org"
|
|
1857
|
+
]
|
|
1858
|
+
}
|
|
1859
|
+
},
|
|
1860
|
+
{
|
|
1861
|
+
"name": "orgs_create_issue_type",
|
|
1862
|
+
"description": "Create issue type for an organization",
|
|
1863
|
+
"method": "POST",
|
|
1864
|
+
"path": "/orgs/{org}/issue-types",
|
|
1865
|
+
"deleteSendsJsonBody": false,
|
|
1866
|
+
"inputSchema": {
|
|
1867
|
+
"type": "object",
|
|
1868
|
+
"properties": {
|
|
1869
|
+
"org": {
|
|
1870
|
+
"type": "string",
|
|
1871
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1872
|
+
},
|
|
1873
|
+
"name": {
|
|
1874
|
+
"type": "string",
|
|
1875
|
+
"description": "Name of the issue type."
|
|
1876
|
+
},
|
|
1877
|
+
"is_enabled": {
|
|
1878
|
+
"type": "boolean",
|
|
1879
|
+
"description": "Whether or not the issue type is enabled at the organization level."
|
|
1880
|
+
},
|
|
1881
|
+
"description": {
|
|
1882
|
+
"type": "string",
|
|
1883
|
+
"description": "Description of the issue type."
|
|
1884
|
+
},
|
|
1885
|
+
"color": {
|
|
1886
|
+
"type": "string",
|
|
1887
|
+
"description": "Color for the issue type.",
|
|
1888
|
+
"enum": [
|
|
1889
|
+
"gray",
|
|
1890
|
+
"blue",
|
|
1891
|
+
"green",
|
|
1892
|
+
"yellow",
|
|
1893
|
+
"orange",
|
|
1894
|
+
"red",
|
|
1895
|
+
"pink",
|
|
1896
|
+
"purple",
|
|
1897
|
+
null
|
|
1898
|
+
]
|
|
1899
|
+
}
|
|
1900
|
+
},
|
|
1901
|
+
"required": [
|
|
1902
|
+
"org",
|
|
1903
|
+
"name",
|
|
1904
|
+
"is_enabled"
|
|
1905
|
+
]
|
|
1906
|
+
}
|
|
1907
|
+
},
|
|
1908
|
+
{
|
|
1909
|
+
"name": "orgs_update_issue_type",
|
|
1910
|
+
"description": "Update issue type for an organization",
|
|
1911
|
+
"method": "PUT",
|
|
1912
|
+
"path": "/orgs/{org}/issue-types/{issue_type_id}",
|
|
1913
|
+
"deleteSendsJsonBody": false,
|
|
1914
|
+
"inputSchema": {
|
|
1915
|
+
"type": "object",
|
|
1916
|
+
"properties": {
|
|
1917
|
+
"org": {
|
|
1918
|
+
"type": "string",
|
|
1919
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1920
|
+
},
|
|
1921
|
+
"issue_type_id": {
|
|
1922
|
+
"type": "number",
|
|
1923
|
+
"description": "The unique identifier of the issue type."
|
|
1924
|
+
},
|
|
1925
|
+
"name": {
|
|
1926
|
+
"type": "string",
|
|
1927
|
+
"description": "Name of the issue type."
|
|
1928
|
+
},
|
|
1929
|
+
"is_enabled": {
|
|
1930
|
+
"type": "boolean",
|
|
1931
|
+
"description": "Whether or not the issue type is enabled at the organization level."
|
|
1932
|
+
},
|
|
1933
|
+
"description": {
|
|
1934
|
+
"type": "string",
|
|
1935
|
+
"description": "Description of the issue type."
|
|
1936
|
+
},
|
|
1937
|
+
"color": {
|
|
1938
|
+
"type": "string",
|
|
1939
|
+
"description": "Color for the issue type.",
|
|
1940
|
+
"enum": [
|
|
1941
|
+
"gray",
|
|
1942
|
+
"blue",
|
|
1943
|
+
"green",
|
|
1944
|
+
"yellow",
|
|
1945
|
+
"orange",
|
|
1946
|
+
"red",
|
|
1947
|
+
"pink",
|
|
1948
|
+
"purple",
|
|
1949
|
+
null
|
|
1950
|
+
]
|
|
1951
|
+
}
|
|
1952
|
+
},
|
|
1953
|
+
"required": [
|
|
1954
|
+
"org",
|
|
1955
|
+
"issue_type_id",
|
|
1956
|
+
"name",
|
|
1957
|
+
"is_enabled"
|
|
1958
|
+
]
|
|
1959
|
+
}
|
|
1960
|
+
},
|
|
1961
|
+
{
|
|
1962
|
+
"name": "orgs_delete_issue_type",
|
|
1963
|
+
"description": "Delete issue type for an organization",
|
|
1964
|
+
"method": "DELETE",
|
|
1965
|
+
"path": "/orgs/{org}/issue-types/{issue_type_id}",
|
|
1966
|
+
"deleteSendsJsonBody": false,
|
|
1967
|
+
"inputSchema": {
|
|
1968
|
+
"type": "object",
|
|
1969
|
+
"properties": {
|
|
1970
|
+
"org": {
|
|
1971
|
+
"type": "string",
|
|
1972
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1973
|
+
},
|
|
1974
|
+
"issue_type_id": {
|
|
1975
|
+
"type": "number",
|
|
1976
|
+
"description": "The unique identifier of the issue type."
|
|
1977
|
+
}
|
|
1978
|
+
},
|
|
1979
|
+
"required": [
|
|
1980
|
+
"org",
|
|
1981
|
+
"issue_type_id"
|
|
1982
|
+
]
|
|
1983
|
+
}
|
|
1984
|
+
},
|
|
1985
|
+
{
|
|
1986
|
+
"name": "orgs_list_members",
|
|
1987
|
+
"description": "List organization members",
|
|
1988
|
+
"method": "GET",
|
|
1989
|
+
"path": "/orgs/{org}/members",
|
|
1990
|
+
"deleteSendsJsonBody": false,
|
|
1991
|
+
"inputSchema": {
|
|
1992
|
+
"type": "object",
|
|
1993
|
+
"properties": {
|
|
1994
|
+
"org": {
|
|
1995
|
+
"type": "string",
|
|
1996
|
+
"description": "The organization name. The name is not case sensitive."
|
|
1997
|
+
},
|
|
1998
|
+
"filter": {
|
|
1999
|
+
"type": "string",
|
|
2000
|
+
"description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners.",
|
|
2001
|
+
"enum": [
|
|
2002
|
+
"2fa_disabled",
|
|
2003
|
+
"2fa_insecure",
|
|
2004
|
+
"all"
|
|
2005
|
+
]
|
|
2006
|
+
},
|
|
2007
|
+
"role": {
|
|
2008
|
+
"type": "string",
|
|
2009
|
+
"description": "Filter members returned by their role.",
|
|
2010
|
+
"enum": [
|
|
2011
|
+
"all",
|
|
2012
|
+
"admin",
|
|
2013
|
+
"member"
|
|
2014
|
+
]
|
|
2015
|
+
},
|
|
2016
|
+
"per_page": {
|
|
2017
|
+
"type": "number",
|
|
2018
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2019
|
+
},
|
|
2020
|
+
"page": {
|
|
2021
|
+
"type": "number",
|
|
2022
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2023
|
+
}
|
|
2024
|
+
},
|
|
2025
|
+
"required": [
|
|
2026
|
+
"org"
|
|
2027
|
+
]
|
|
2028
|
+
}
|
|
2029
|
+
},
|
|
2030
|
+
{
|
|
2031
|
+
"name": "orgs_check_membership_for_user",
|
|
2032
|
+
"description": "Check organization membership for a user",
|
|
2033
|
+
"method": "GET",
|
|
2034
|
+
"path": "/orgs/{org}/members/{username}",
|
|
2035
|
+
"deleteSendsJsonBody": false,
|
|
2036
|
+
"inputSchema": {
|
|
2037
|
+
"type": "object",
|
|
2038
|
+
"properties": {
|
|
2039
|
+
"org": {
|
|
2040
|
+
"type": "string",
|
|
2041
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2042
|
+
},
|
|
2043
|
+
"username": {
|
|
2044
|
+
"type": "string",
|
|
2045
|
+
"description": "The handle for the GitHub user account."
|
|
2046
|
+
}
|
|
2047
|
+
},
|
|
2048
|
+
"required": [
|
|
2049
|
+
"org",
|
|
2050
|
+
"username"
|
|
2051
|
+
]
|
|
2052
|
+
}
|
|
2053
|
+
},
|
|
2054
|
+
{
|
|
2055
|
+
"name": "orgs_remove_member",
|
|
2056
|
+
"description": "Remove an organization member",
|
|
2057
|
+
"method": "DELETE",
|
|
2058
|
+
"path": "/orgs/{org}/members/{username}",
|
|
2059
|
+
"deleteSendsJsonBody": false,
|
|
2060
|
+
"inputSchema": {
|
|
2061
|
+
"type": "object",
|
|
2062
|
+
"properties": {
|
|
2063
|
+
"org": {
|
|
2064
|
+
"type": "string",
|
|
2065
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2066
|
+
},
|
|
2067
|
+
"username": {
|
|
2068
|
+
"type": "string",
|
|
2069
|
+
"description": "The handle for the GitHub user account."
|
|
2070
|
+
}
|
|
2071
|
+
},
|
|
2072
|
+
"required": [
|
|
2073
|
+
"org",
|
|
2074
|
+
"username"
|
|
2075
|
+
]
|
|
2076
|
+
}
|
|
2077
|
+
},
|
|
2078
|
+
{
|
|
2079
|
+
"name": "orgs_get_membership_for_user",
|
|
2080
|
+
"description": "Get organization membership for a user",
|
|
2081
|
+
"method": "GET",
|
|
2082
|
+
"path": "/orgs/{org}/memberships/{username}",
|
|
2083
|
+
"deleteSendsJsonBody": false,
|
|
2084
|
+
"inputSchema": {
|
|
2085
|
+
"type": "object",
|
|
2086
|
+
"properties": {
|
|
2087
|
+
"org": {
|
|
2088
|
+
"type": "string",
|
|
2089
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2090
|
+
},
|
|
2091
|
+
"username": {
|
|
2092
|
+
"type": "string",
|
|
2093
|
+
"description": "The handle for the GitHub user account."
|
|
2094
|
+
}
|
|
2095
|
+
},
|
|
2096
|
+
"required": [
|
|
2097
|
+
"org",
|
|
2098
|
+
"username"
|
|
2099
|
+
]
|
|
2100
|
+
}
|
|
2101
|
+
},
|
|
2102
|
+
{
|
|
2103
|
+
"name": "orgs_set_membership_for_user",
|
|
2104
|
+
"description": "Set organization membership for a user",
|
|
2105
|
+
"method": "PUT",
|
|
2106
|
+
"path": "/orgs/{org}/memberships/{username}",
|
|
2107
|
+
"deleteSendsJsonBody": false,
|
|
2108
|
+
"inputSchema": {
|
|
2109
|
+
"type": "object",
|
|
2110
|
+
"properties": {
|
|
2111
|
+
"org": {
|
|
2112
|
+
"type": "string",
|
|
2113
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2114
|
+
},
|
|
2115
|
+
"username": {
|
|
2116
|
+
"type": "string",
|
|
2117
|
+
"description": "The handle for the GitHub user account."
|
|
2118
|
+
},
|
|
2119
|
+
"role": {
|
|
2120
|
+
"type": "string",
|
|
2121
|
+
"description": "The role to give the user in the organization. Can be one of: \n * `admin` - The user will become an owner of the organization. \n * `member` - The user will become a non-owner member of the organization.",
|
|
2122
|
+
"enum": [
|
|
2123
|
+
"admin",
|
|
2124
|
+
"member"
|
|
2125
|
+
]
|
|
2126
|
+
}
|
|
2127
|
+
},
|
|
2128
|
+
"required": [
|
|
2129
|
+
"org",
|
|
2130
|
+
"username"
|
|
2131
|
+
]
|
|
2132
|
+
}
|
|
2133
|
+
},
|
|
2134
|
+
{
|
|
2135
|
+
"name": "orgs_remove_membership_for_user",
|
|
2136
|
+
"description": "Remove organization membership for a user",
|
|
2137
|
+
"method": "DELETE",
|
|
2138
|
+
"path": "/orgs/{org}/memberships/{username}",
|
|
2139
|
+
"deleteSendsJsonBody": false,
|
|
2140
|
+
"inputSchema": {
|
|
2141
|
+
"type": "object",
|
|
2142
|
+
"properties": {
|
|
2143
|
+
"org": {
|
|
2144
|
+
"type": "string",
|
|
2145
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2146
|
+
},
|
|
2147
|
+
"username": {
|
|
2148
|
+
"type": "string",
|
|
2149
|
+
"description": "The handle for the GitHub user account."
|
|
2150
|
+
}
|
|
2151
|
+
},
|
|
2152
|
+
"required": [
|
|
2153
|
+
"org",
|
|
2154
|
+
"username"
|
|
2155
|
+
]
|
|
2156
|
+
}
|
|
2157
|
+
},
|
|
2158
|
+
{
|
|
2159
|
+
"name": "orgs_list_org_roles",
|
|
2160
|
+
"description": "Get all organization roles for an organization",
|
|
2161
|
+
"method": "GET",
|
|
2162
|
+
"path": "/orgs/{org}/organization-roles",
|
|
2163
|
+
"deleteSendsJsonBody": false,
|
|
2164
|
+
"inputSchema": {
|
|
2165
|
+
"type": "object",
|
|
2166
|
+
"properties": {
|
|
2167
|
+
"org": {
|
|
2168
|
+
"type": "string",
|
|
2169
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2170
|
+
}
|
|
2171
|
+
},
|
|
2172
|
+
"required": [
|
|
2173
|
+
"org"
|
|
2174
|
+
]
|
|
2175
|
+
}
|
|
2176
|
+
},
|
|
2177
|
+
{
|
|
2178
|
+
"name": "orgs_revoke_all_org_roles_team",
|
|
2179
|
+
"description": "Remove all organization roles for a team",
|
|
2180
|
+
"method": "DELETE",
|
|
2181
|
+
"path": "/orgs/{org}/organization-roles/teams/{team_slug}",
|
|
2182
|
+
"deleteSendsJsonBody": false,
|
|
2183
|
+
"inputSchema": {
|
|
2184
|
+
"type": "object",
|
|
2185
|
+
"properties": {
|
|
2186
|
+
"org": {
|
|
2187
|
+
"type": "string",
|
|
2188
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2189
|
+
},
|
|
2190
|
+
"team_slug": {
|
|
2191
|
+
"type": "string",
|
|
2192
|
+
"description": "The slug of the team name."
|
|
2193
|
+
}
|
|
2194
|
+
},
|
|
2195
|
+
"required": [
|
|
2196
|
+
"org",
|
|
2197
|
+
"team_slug"
|
|
2198
|
+
]
|
|
2199
|
+
}
|
|
2200
|
+
},
|
|
2201
|
+
{
|
|
2202
|
+
"name": "orgs_assign_team_to_org_role",
|
|
2203
|
+
"description": "Assign an organization role to a team",
|
|
2204
|
+
"method": "PUT",
|
|
2205
|
+
"path": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}",
|
|
2206
|
+
"deleteSendsJsonBody": false,
|
|
2207
|
+
"inputSchema": {
|
|
2208
|
+
"type": "object",
|
|
2209
|
+
"properties": {
|
|
2210
|
+
"org": {
|
|
2211
|
+
"type": "string",
|
|
2212
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2213
|
+
},
|
|
2214
|
+
"team_slug": {
|
|
2215
|
+
"type": "string",
|
|
2216
|
+
"description": "The slug of the team name."
|
|
2217
|
+
},
|
|
2218
|
+
"role_id": {
|
|
2219
|
+
"type": "number",
|
|
2220
|
+
"description": "The unique identifier of the role."
|
|
2221
|
+
}
|
|
2222
|
+
},
|
|
2223
|
+
"required": [
|
|
2224
|
+
"org",
|
|
2225
|
+
"team_slug",
|
|
2226
|
+
"role_id"
|
|
2227
|
+
]
|
|
2228
|
+
}
|
|
2229
|
+
},
|
|
2230
|
+
{
|
|
2231
|
+
"name": "orgs_revoke_org_role_team",
|
|
2232
|
+
"description": "Remove an organization role from a team",
|
|
2233
|
+
"method": "DELETE",
|
|
2234
|
+
"path": "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}",
|
|
2235
|
+
"deleteSendsJsonBody": false,
|
|
2236
|
+
"inputSchema": {
|
|
2237
|
+
"type": "object",
|
|
2238
|
+
"properties": {
|
|
2239
|
+
"org": {
|
|
2240
|
+
"type": "string",
|
|
2241
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2242
|
+
},
|
|
2243
|
+
"team_slug": {
|
|
2244
|
+
"type": "string",
|
|
2245
|
+
"description": "The slug of the team name."
|
|
2246
|
+
},
|
|
2247
|
+
"role_id": {
|
|
2248
|
+
"type": "number",
|
|
2249
|
+
"description": "The unique identifier of the role."
|
|
2250
|
+
}
|
|
2251
|
+
},
|
|
2252
|
+
"required": [
|
|
2253
|
+
"org",
|
|
2254
|
+
"team_slug",
|
|
2255
|
+
"role_id"
|
|
2256
|
+
]
|
|
2257
|
+
}
|
|
2258
|
+
},
|
|
2259
|
+
{
|
|
2260
|
+
"name": "orgs_revoke_all_org_roles_user",
|
|
2261
|
+
"description": "Remove all organization roles for a user",
|
|
2262
|
+
"method": "DELETE",
|
|
2263
|
+
"path": "/orgs/{org}/organization-roles/users/{username}",
|
|
2264
|
+
"deleteSendsJsonBody": false,
|
|
2265
|
+
"inputSchema": {
|
|
2266
|
+
"type": "object",
|
|
2267
|
+
"properties": {
|
|
2268
|
+
"org": {
|
|
2269
|
+
"type": "string",
|
|
2270
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2271
|
+
},
|
|
2272
|
+
"username": {
|
|
2273
|
+
"type": "string",
|
|
2274
|
+
"description": "The handle for the GitHub user account."
|
|
2275
|
+
}
|
|
2276
|
+
},
|
|
2277
|
+
"required": [
|
|
2278
|
+
"org",
|
|
2279
|
+
"username"
|
|
2280
|
+
]
|
|
2281
|
+
}
|
|
2282
|
+
},
|
|
2283
|
+
{
|
|
2284
|
+
"name": "orgs_assign_user_to_org_role",
|
|
2285
|
+
"description": "Assign an organization role to a user",
|
|
2286
|
+
"method": "PUT",
|
|
2287
|
+
"path": "/orgs/{org}/organization-roles/users/{username}/{role_id}",
|
|
2288
|
+
"deleteSendsJsonBody": false,
|
|
2289
|
+
"inputSchema": {
|
|
2290
|
+
"type": "object",
|
|
2291
|
+
"properties": {
|
|
2292
|
+
"org": {
|
|
2293
|
+
"type": "string",
|
|
2294
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2295
|
+
},
|
|
2296
|
+
"username": {
|
|
2297
|
+
"type": "string",
|
|
2298
|
+
"description": "The handle for the GitHub user account."
|
|
2299
|
+
},
|
|
2300
|
+
"role_id": {
|
|
2301
|
+
"type": "number",
|
|
2302
|
+
"description": "The unique identifier of the role."
|
|
2303
|
+
}
|
|
2304
|
+
},
|
|
2305
|
+
"required": [
|
|
2306
|
+
"org",
|
|
2307
|
+
"username",
|
|
2308
|
+
"role_id"
|
|
2309
|
+
]
|
|
2310
|
+
}
|
|
2311
|
+
},
|
|
2312
|
+
{
|
|
2313
|
+
"name": "orgs_revoke_org_role_user",
|
|
2314
|
+
"description": "Remove an organization role from a user",
|
|
2315
|
+
"method": "DELETE",
|
|
2316
|
+
"path": "/orgs/{org}/organization-roles/users/{username}/{role_id}",
|
|
2317
|
+
"deleteSendsJsonBody": false,
|
|
2318
|
+
"inputSchema": {
|
|
2319
|
+
"type": "object",
|
|
2320
|
+
"properties": {
|
|
2321
|
+
"org": {
|
|
2322
|
+
"type": "string",
|
|
2323
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2324
|
+
},
|
|
2325
|
+
"username": {
|
|
2326
|
+
"type": "string",
|
|
2327
|
+
"description": "The handle for the GitHub user account."
|
|
2328
|
+
},
|
|
2329
|
+
"role_id": {
|
|
2330
|
+
"type": "number",
|
|
2331
|
+
"description": "The unique identifier of the role."
|
|
2332
|
+
}
|
|
2333
|
+
},
|
|
2334
|
+
"required": [
|
|
2335
|
+
"org",
|
|
2336
|
+
"username",
|
|
2337
|
+
"role_id"
|
|
2338
|
+
]
|
|
2339
|
+
}
|
|
2340
|
+
},
|
|
2341
|
+
{
|
|
2342
|
+
"name": "orgs_get_org_role",
|
|
2343
|
+
"description": "Get an organization role",
|
|
2344
|
+
"method": "GET",
|
|
2345
|
+
"path": "/orgs/{org}/organization-roles/{role_id}",
|
|
2346
|
+
"deleteSendsJsonBody": false,
|
|
2347
|
+
"inputSchema": {
|
|
2348
|
+
"type": "object",
|
|
2349
|
+
"properties": {
|
|
2350
|
+
"org": {
|
|
2351
|
+
"type": "string",
|
|
2352
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2353
|
+
},
|
|
2354
|
+
"role_id": {
|
|
2355
|
+
"type": "number",
|
|
2356
|
+
"description": "The unique identifier of the role."
|
|
2357
|
+
}
|
|
2358
|
+
},
|
|
2359
|
+
"required": [
|
|
2360
|
+
"org",
|
|
2361
|
+
"role_id"
|
|
2362
|
+
]
|
|
2363
|
+
}
|
|
2364
|
+
},
|
|
2365
|
+
{
|
|
2366
|
+
"name": "orgs_list_org_role_teams",
|
|
2367
|
+
"description": "List teams that are assigned to an organization role",
|
|
2368
|
+
"method": "GET",
|
|
2369
|
+
"path": "/orgs/{org}/organization-roles/{role_id}/teams",
|
|
2370
|
+
"deleteSendsJsonBody": false,
|
|
2371
|
+
"inputSchema": {
|
|
2372
|
+
"type": "object",
|
|
2373
|
+
"properties": {
|
|
2374
|
+
"org": {
|
|
2375
|
+
"type": "string",
|
|
2376
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2377
|
+
},
|
|
2378
|
+
"role_id": {
|
|
2379
|
+
"type": "number",
|
|
2380
|
+
"description": "The unique identifier of the role."
|
|
2381
|
+
},
|
|
2382
|
+
"per_page": {
|
|
2383
|
+
"type": "number",
|
|
2384
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2385
|
+
},
|
|
2386
|
+
"page": {
|
|
2387
|
+
"type": "number",
|
|
2388
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2389
|
+
}
|
|
2390
|
+
},
|
|
2391
|
+
"required": [
|
|
2392
|
+
"org",
|
|
2393
|
+
"role_id"
|
|
2394
|
+
]
|
|
2395
|
+
}
|
|
2396
|
+
},
|
|
2397
|
+
{
|
|
2398
|
+
"name": "orgs_list_org_role_users",
|
|
2399
|
+
"description": "List users that are assigned to an organization role",
|
|
2400
|
+
"method": "GET",
|
|
2401
|
+
"path": "/orgs/{org}/organization-roles/{role_id}/users",
|
|
2402
|
+
"deleteSendsJsonBody": false,
|
|
2403
|
+
"inputSchema": {
|
|
2404
|
+
"type": "object",
|
|
2405
|
+
"properties": {
|
|
2406
|
+
"org": {
|
|
2407
|
+
"type": "string",
|
|
2408
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2409
|
+
},
|
|
2410
|
+
"role_id": {
|
|
2411
|
+
"type": "number",
|
|
2412
|
+
"description": "The unique identifier of the role."
|
|
2413
|
+
},
|
|
2414
|
+
"per_page": {
|
|
2415
|
+
"type": "number",
|
|
2416
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2417
|
+
},
|
|
2418
|
+
"page": {
|
|
2419
|
+
"type": "number",
|
|
2420
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2421
|
+
}
|
|
2422
|
+
},
|
|
2423
|
+
"required": [
|
|
2424
|
+
"org",
|
|
2425
|
+
"role_id"
|
|
2426
|
+
]
|
|
2427
|
+
}
|
|
2428
|
+
},
|
|
2429
|
+
{
|
|
2430
|
+
"name": "orgs_list_outside_collaborators",
|
|
2431
|
+
"description": "List outside collaborators for an organization",
|
|
2432
|
+
"method": "GET",
|
|
2433
|
+
"path": "/orgs/{org}/outside_collaborators",
|
|
2434
|
+
"deleteSendsJsonBody": false,
|
|
2435
|
+
"inputSchema": {
|
|
2436
|
+
"type": "object",
|
|
2437
|
+
"properties": {
|
|
2438
|
+
"org": {
|
|
2439
|
+
"type": "string",
|
|
2440
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2441
|
+
},
|
|
2442
|
+
"filter": {
|
|
2443
|
+
"type": "string",
|
|
2444
|
+
"description": "Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned.",
|
|
2445
|
+
"enum": [
|
|
2446
|
+
"2fa_disabled",
|
|
2447
|
+
"2fa_insecure",
|
|
2448
|
+
"all"
|
|
2449
|
+
]
|
|
2450
|
+
},
|
|
2451
|
+
"per_page": {
|
|
2452
|
+
"type": "number",
|
|
2453
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2454
|
+
},
|
|
2455
|
+
"page": {
|
|
2456
|
+
"type": "number",
|
|
2457
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2458
|
+
}
|
|
2459
|
+
},
|
|
2460
|
+
"required": [
|
|
2461
|
+
"org"
|
|
2462
|
+
]
|
|
2463
|
+
}
|
|
2464
|
+
},
|
|
2465
|
+
{
|
|
2466
|
+
"name": "orgs_convert_member_to_outside_collaborator",
|
|
2467
|
+
"description": "Convert an organization member to outside collaborator",
|
|
2468
|
+
"method": "PUT",
|
|
2469
|
+
"path": "/orgs/{org}/outside_collaborators/{username}",
|
|
2470
|
+
"deleteSendsJsonBody": false,
|
|
2471
|
+
"inputSchema": {
|
|
2472
|
+
"type": "object",
|
|
2473
|
+
"properties": {
|
|
2474
|
+
"org": {
|
|
2475
|
+
"type": "string",
|
|
2476
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2477
|
+
},
|
|
2478
|
+
"username": {
|
|
2479
|
+
"type": "string",
|
|
2480
|
+
"description": "The handle for the GitHub user account."
|
|
2481
|
+
},
|
|
2482
|
+
"async": {
|
|
2483
|
+
"type": "boolean",
|
|
2484
|
+
"description": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued."
|
|
2485
|
+
}
|
|
2486
|
+
},
|
|
2487
|
+
"required": [
|
|
2488
|
+
"org",
|
|
2489
|
+
"username"
|
|
2490
|
+
]
|
|
2491
|
+
}
|
|
2492
|
+
},
|
|
2493
|
+
{
|
|
2494
|
+
"name": "orgs_remove_outside_collaborator",
|
|
2495
|
+
"description": "Remove outside collaborator from an organization",
|
|
2496
|
+
"method": "DELETE",
|
|
2497
|
+
"path": "/orgs/{org}/outside_collaborators/{username}",
|
|
2498
|
+
"deleteSendsJsonBody": false,
|
|
2499
|
+
"inputSchema": {
|
|
2500
|
+
"type": "object",
|
|
2501
|
+
"properties": {
|
|
2502
|
+
"org": {
|
|
2503
|
+
"type": "string",
|
|
2504
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2505
|
+
},
|
|
2506
|
+
"username": {
|
|
2507
|
+
"type": "string",
|
|
2508
|
+
"description": "The handle for the GitHub user account."
|
|
2509
|
+
}
|
|
2510
|
+
},
|
|
2511
|
+
"required": [
|
|
2512
|
+
"org",
|
|
2513
|
+
"username"
|
|
2514
|
+
]
|
|
2515
|
+
}
|
|
2516
|
+
},
|
|
2517
|
+
{
|
|
2518
|
+
"name": "orgs_list_pat_grant_requests",
|
|
2519
|
+
"description": "List requests to access organization resources with fine-grained personal access tokens",
|
|
2520
|
+
"method": "GET",
|
|
2521
|
+
"path": "/orgs/{org}/personal-access-token-requests",
|
|
2522
|
+
"deleteSendsJsonBody": false,
|
|
2523
|
+
"inputSchema": {
|
|
2524
|
+
"type": "object",
|
|
2525
|
+
"properties": {
|
|
2526
|
+
"org": {
|
|
2527
|
+
"type": "string",
|
|
2528
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2529
|
+
},
|
|
2530
|
+
"per_page": {
|
|
2531
|
+
"type": "number",
|
|
2532
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2533
|
+
},
|
|
2534
|
+
"page": {
|
|
2535
|
+
"type": "number",
|
|
2536
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2537
|
+
},
|
|
2538
|
+
"sort": {
|
|
2539
|
+
"type": "string",
|
|
2540
|
+
"description": "The property by which to sort the results.",
|
|
2541
|
+
"enum": [
|
|
2542
|
+
"created_at"
|
|
2543
|
+
]
|
|
2544
|
+
},
|
|
2545
|
+
"direction": {
|
|
2546
|
+
"type": "string",
|
|
2547
|
+
"description": "The direction to sort the results by.",
|
|
2548
|
+
"enum": [
|
|
2549
|
+
"asc",
|
|
2550
|
+
"desc"
|
|
2551
|
+
]
|
|
2552
|
+
},
|
|
2553
|
+
"owner": {
|
|
2554
|
+
"type": "array",
|
|
2555
|
+
"description": "A list of owner usernames to use to filter the results."
|
|
2556
|
+
},
|
|
2557
|
+
"repository": {
|
|
2558
|
+
"type": "string",
|
|
2559
|
+
"description": "The name of the repository to use to filter the results."
|
|
2560
|
+
},
|
|
2561
|
+
"permission": {
|
|
2562
|
+
"type": "string",
|
|
2563
|
+
"description": "The permission to use to filter the results."
|
|
2564
|
+
},
|
|
2565
|
+
"last_used_before": {
|
|
2566
|
+
"type": "string",
|
|
2567
|
+
"description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
2568
|
+
},
|
|
2569
|
+
"last_used_after": {
|
|
2570
|
+
"type": "string",
|
|
2571
|
+
"description": "Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
2572
|
+
},
|
|
2573
|
+
"token_id": {
|
|
2574
|
+
"type": "array",
|
|
2575
|
+
"description": "The ID of the token"
|
|
2576
|
+
}
|
|
2577
|
+
},
|
|
2578
|
+
"required": [
|
|
2579
|
+
"org"
|
|
2580
|
+
]
|
|
2581
|
+
}
|
|
2582
|
+
},
|
|
2583
|
+
{
|
|
2584
|
+
"name": "orgs_review_pat_grant_requests_in_bulk",
|
|
2585
|
+
"description": "Review requests to access organization resources with fine-grained personal access tokens",
|
|
2586
|
+
"method": "POST",
|
|
2587
|
+
"path": "/orgs/{org}/personal-access-token-requests",
|
|
2588
|
+
"deleteSendsJsonBody": false,
|
|
2589
|
+
"inputSchema": {
|
|
2590
|
+
"type": "object",
|
|
2591
|
+
"properties": {
|
|
2592
|
+
"org": {
|
|
2593
|
+
"type": "string",
|
|
2594
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2595
|
+
},
|
|
2596
|
+
"pat_request_ids": {
|
|
2597
|
+
"type": "array",
|
|
2598
|
+
"description": "Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values."
|
|
2599
|
+
},
|
|
2600
|
+
"action": {
|
|
2601
|
+
"type": "string",
|
|
2602
|
+
"description": "Action to apply to the requests.",
|
|
2603
|
+
"enum": [
|
|
2604
|
+
"approve",
|
|
2605
|
+
"deny"
|
|
2606
|
+
]
|
|
2607
|
+
},
|
|
2608
|
+
"reason": {
|
|
2609
|
+
"type": "string",
|
|
2610
|
+
"description": "Reason for approving or denying the requests. Max 1024 characters."
|
|
2611
|
+
}
|
|
2612
|
+
},
|
|
2613
|
+
"required": [
|
|
2614
|
+
"org",
|
|
2615
|
+
"action"
|
|
2616
|
+
]
|
|
2617
|
+
}
|
|
2618
|
+
},
|
|
2619
|
+
{
|
|
2620
|
+
"name": "orgs_review_pat_grant_request",
|
|
2621
|
+
"description": "Review a request to access organization resources with a fine-grained personal access token",
|
|
2622
|
+
"method": "POST",
|
|
2623
|
+
"path": "/orgs/{org}/personal-access-token-requests/{pat_request_id}",
|
|
2624
|
+
"deleteSendsJsonBody": false,
|
|
2625
|
+
"inputSchema": {
|
|
2626
|
+
"type": "object",
|
|
2627
|
+
"properties": {
|
|
2628
|
+
"org": {
|
|
2629
|
+
"type": "string",
|
|
2630
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2631
|
+
},
|
|
2632
|
+
"pat_request_id": {
|
|
2633
|
+
"type": "number",
|
|
2634
|
+
"description": "Unique identifier of the request for access via fine-grained personal access token."
|
|
2635
|
+
},
|
|
2636
|
+
"action": {
|
|
2637
|
+
"type": "string",
|
|
2638
|
+
"description": "Action to apply to the request.",
|
|
2639
|
+
"enum": [
|
|
2640
|
+
"approve",
|
|
2641
|
+
"deny"
|
|
2642
|
+
]
|
|
2643
|
+
},
|
|
2644
|
+
"reason": {
|
|
2645
|
+
"type": "string",
|
|
2646
|
+
"description": "Reason for approving or denying the request. Max 1024 characters."
|
|
2647
|
+
}
|
|
2648
|
+
},
|
|
2649
|
+
"required": [
|
|
2650
|
+
"org",
|
|
2651
|
+
"pat_request_id",
|
|
2652
|
+
"action"
|
|
2653
|
+
]
|
|
2654
|
+
}
|
|
2655
|
+
},
|
|
2656
|
+
{
|
|
2657
|
+
"name": "orgs_list_pat_grant_request_repositories",
|
|
2658
|
+
"description": "List repositories requested to be accessed by a fine-grained personal access token",
|
|
2659
|
+
"method": "GET",
|
|
2660
|
+
"path": "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories",
|
|
2661
|
+
"deleteSendsJsonBody": false,
|
|
2662
|
+
"inputSchema": {
|
|
2663
|
+
"type": "object",
|
|
2664
|
+
"properties": {
|
|
2665
|
+
"org": {
|
|
2666
|
+
"type": "string",
|
|
2667
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2668
|
+
},
|
|
2669
|
+
"pat_request_id": {
|
|
2670
|
+
"type": "number",
|
|
2671
|
+
"description": "Unique identifier of the request for access via fine-grained personal access token."
|
|
2672
|
+
},
|
|
2673
|
+
"per_page": {
|
|
2674
|
+
"type": "number",
|
|
2675
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2676
|
+
},
|
|
2677
|
+
"page": {
|
|
2678
|
+
"type": "number",
|
|
2679
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2680
|
+
}
|
|
2681
|
+
},
|
|
2682
|
+
"required": [
|
|
2683
|
+
"org",
|
|
2684
|
+
"pat_request_id"
|
|
2685
|
+
]
|
|
2686
|
+
}
|
|
2687
|
+
},
|
|
2688
|
+
{
|
|
2689
|
+
"name": "orgs_list_pat_grants",
|
|
2690
|
+
"description": "List fine-grained personal access tokens with access to organization resources",
|
|
2691
|
+
"method": "GET",
|
|
2692
|
+
"path": "/orgs/{org}/personal-access-tokens",
|
|
2693
|
+
"deleteSendsJsonBody": false,
|
|
2694
|
+
"inputSchema": {
|
|
2695
|
+
"type": "object",
|
|
2696
|
+
"properties": {
|
|
2697
|
+
"org": {
|
|
2698
|
+
"type": "string",
|
|
2699
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2700
|
+
},
|
|
2701
|
+
"per_page": {
|
|
2702
|
+
"type": "number",
|
|
2703
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2704
|
+
},
|
|
2705
|
+
"page": {
|
|
2706
|
+
"type": "number",
|
|
2707
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2708
|
+
},
|
|
2709
|
+
"sort": {
|
|
2710
|
+
"type": "string",
|
|
2711
|
+
"description": "The property by which to sort the results.",
|
|
2712
|
+
"enum": [
|
|
2713
|
+
"created_at"
|
|
2714
|
+
]
|
|
2715
|
+
},
|
|
2716
|
+
"direction": {
|
|
2717
|
+
"type": "string",
|
|
2718
|
+
"description": "The direction to sort the results by.",
|
|
2719
|
+
"enum": [
|
|
2720
|
+
"asc",
|
|
2721
|
+
"desc"
|
|
2722
|
+
]
|
|
2723
|
+
},
|
|
2724
|
+
"owner": {
|
|
2725
|
+
"type": "array",
|
|
2726
|
+
"description": "A list of owner usernames to use to filter the results."
|
|
2727
|
+
},
|
|
2728
|
+
"repository": {
|
|
2729
|
+
"type": "string",
|
|
2730
|
+
"description": "The name of the repository to use to filter the results."
|
|
2731
|
+
},
|
|
2732
|
+
"permission": {
|
|
2733
|
+
"type": "string",
|
|
2734
|
+
"description": "The permission to use to filter the results."
|
|
2735
|
+
},
|
|
2736
|
+
"last_used_before": {
|
|
2737
|
+
"type": "string",
|
|
2738
|
+
"description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
2739
|
+
},
|
|
2740
|
+
"last_used_after": {
|
|
2741
|
+
"type": "string",
|
|
2742
|
+
"description": "Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
|
|
2743
|
+
},
|
|
2744
|
+
"token_id": {
|
|
2745
|
+
"type": "array",
|
|
2746
|
+
"description": "The ID of the token"
|
|
2747
|
+
}
|
|
2748
|
+
},
|
|
2749
|
+
"required": [
|
|
2750
|
+
"org"
|
|
2751
|
+
]
|
|
2752
|
+
}
|
|
2753
|
+
},
|
|
2754
|
+
{
|
|
2755
|
+
"name": "orgs_update_pat_accesses",
|
|
2756
|
+
"description": "Update the access to organization resources via fine-grained personal access tokens",
|
|
2757
|
+
"method": "POST",
|
|
2758
|
+
"path": "/orgs/{org}/personal-access-tokens",
|
|
2759
|
+
"deleteSendsJsonBody": false,
|
|
2760
|
+
"inputSchema": {
|
|
2761
|
+
"type": "object",
|
|
2762
|
+
"properties": {
|
|
2763
|
+
"org": {
|
|
2764
|
+
"type": "string",
|
|
2765
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2766
|
+
},
|
|
2767
|
+
"action": {
|
|
2768
|
+
"type": "string",
|
|
2769
|
+
"description": "Action to apply to the fine-grained personal access token.",
|
|
2770
|
+
"enum": [
|
|
2771
|
+
"revoke"
|
|
2772
|
+
]
|
|
2773
|
+
},
|
|
2774
|
+
"pat_ids": {
|
|
2775
|
+
"type": "array",
|
|
2776
|
+
"description": "The IDs of the fine-grained personal access tokens."
|
|
2777
|
+
}
|
|
2778
|
+
},
|
|
2779
|
+
"required": [
|
|
2780
|
+
"org",
|
|
2781
|
+
"action",
|
|
2782
|
+
"pat_ids"
|
|
2783
|
+
]
|
|
2784
|
+
}
|
|
2785
|
+
},
|
|
2786
|
+
{
|
|
2787
|
+
"name": "orgs_update_pat_access",
|
|
2788
|
+
"description": "Update the access a fine-grained personal access token has to organization resources",
|
|
2789
|
+
"method": "POST",
|
|
2790
|
+
"path": "/orgs/{org}/personal-access-tokens/{pat_id}",
|
|
2791
|
+
"deleteSendsJsonBody": false,
|
|
2792
|
+
"inputSchema": {
|
|
2793
|
+
"type": "object",
|
|
2794
|
+
"properties": {
|
|
2795
|
+
"org": {
|
|
2796
|
+
"type": "string",
|
|
2797
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2798
|
+
},
|
|
2799
|
+
"pat_id": {
|
|
2800
|
+
"type": "number",
|
|
2801
|
+
"description": "The unique identifier of the fine-grained personal access token."
|
|
2802
|
+
},
|
|
2803
|
+
"action": {
|
|
2804
|
+
"type": "string",
|
|
2805
|
+
"description": "Action to apply to the fine-grained personal access token.",
|
|
2806
|
+
"enum": [
|
|
2807
|
+
"revoke"
|
|
2808
|
+
]
|
|
2809
|
+
}
|
|
2810
|
+
},
|
|
2811
|
+
"required": [
|
|
2812
|
+
"org",
|
|
2813
|
+
"pat_id",
|
|
2814
|
+
"action"
|
|
2815
|
+
]
|
|
2816
|
+
}
|
|
2817
|
+
},
|
|
2818
|
+
{
|
|
2819
|
+
"name": "orgs_list_pat_grant_repositories",
|
|
2820
|
+
"description": "List repositories a fine-grained personal access token has access to",
|
|
2821
|
+
"method": "GET",
|
|
2822
|
+
"path": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories",
|
|
2823
|
+
"deleteSendsJsonBody": false,
|
|
2824
|
+
"inputSchema": {
|
|
2825
|
+
"type": "object",
|
|
2826
|
+
"properties": {
|
|
2827
|
+
"org": {
|
|
2828
|
+
"type": "string",
|
|
2829
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2830
|
+
},
|
|
2831
|
+
"pat_id": {
|
|
2832
|
+
"type": "number",
|
|
2833
|
+
"description": "Unique identifier of the fine-grained personal access token."
|
|
2834
|
+
},
|
|
2835
|
+
"per_page": {
|
|
2836
|
+
"type": "number",
|
|
2837
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2838
|
+
},
|
|
2839
|
+
"page": {
|
|
2840
|
+
"type": "number",
|
|
2841
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
2842
|
+
}
|
|
2843
|
+
},
|
|
2844
|
+
"required": [
|
|
2845
|
+
"org",
|
|
2846
|
+
"pat_id"
|
|
2847
|
+
]
|
|
2848
|
+
}
|
|
2849
|
+
},
|
|
2850
|
+
{
|
|
2851
|
+
"name": "orgs_custom_properties_for_repos_get_organization_definition",
|
|
2852
|
+
"description": "Get all custom properties for an organization",
|
|
2853
|
+
"method": "GET",
|
|
2854
|
+
"path": "/orgs/{org}/properties/schema",
|
|
2855
|
+
"deleteSendsJsonBody": false,
|
|
2856
|
+
"inputSchema": {
|
|
2857
|
+
"type": "object",
|
|
2858
|
+
"properties": {
|
|
2859
|
+
"org": {
|
|
2860
|
+
"type": "string",
|
|
2861
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2862
|
+
}
|
|
2863
|
+
},
|
|
2864
|
+
"required": [
|
|
2865
|
+
"org"
|
|
2866
|
+
]
|
|
2867
|
+
}
|
|
2868
|
+
},
|
|
2869
|
+
{
|
|
2870
|
+
"name": "orgs_custom_properties_for_repos_create_or_update_organizati",
|
|
2871
|
+
"description": "Create or update custom properties for an organization",
|
|
2872
|
+
"method": "PATCH",
|
|
2873
|
+
"path": "/orgs/{org}/properties/schema",
|
|
2874
|
+
"deleteSendsJsonBody": false,
|
|
2875
|
+
"inputSchema": {
|
|
2876
|
+
"type": "object",
|
|
2877
|
+
"properties": {
|
|
2878
|
+
"org": {
|
|
2879
|
+
"type": "string",
|
|
2880
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2881
|
+
},
|
|
2882
|
+
"properties": {
|
|
2883
|
+
"type": "array",
|
|
2884
|
+
"description": "The array of custom properties to create or update."
|
|
2885
|
+
}
|
|
2886
|
+
},
|
|
2887
|
+
"required": [
|
|
2888
|
+
"org",
|
|
2889
|
+
"properties"
|
|
2890
|
+
]
|
|
2891
|
+
}
|
|
2892
|
+
},
|
|
2893
|
+
{
|
|
2894
|
+
"name": "orgs_custom_properties_for_repos_get_organization_definiti_2",
|
|
2895
|
+
"description": "Get a custom property for an organization",
|
|
2896
|
+
"method": "GET",
|
|
2897
|
+
"path": "/orgs/{org}/properties/schema/{custom_property_name}",
|
|
2898
|
+
"deleteSendsJsonBody": false,
|
|
2899
|
+
"inputSchema": {
|
|
2900
|
+
"type": "object",
|
|
2901
|
+
"properties": {
|
|
2902
|
+
"org": {
|
|
2903
|
+
"type": "string",
|
|
2904
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2905
|
+
},
|
|
2906
|
+
"custom_property_name": {
|
|
2907
|
+
"type": "string",
|
|
2908
|
+
"description": "The custom property name"
|
|
2909
|
+
}
|
|
2910
|
+
},
|
|
2911
|
+
"required": [
|
|
2912
|
+
"org",
|
|
2913
|
+
"custom_property_name"
|
|
2914
|
+
]
|
|
2915
|
+
}
|
|
2916
|
+
},
|
|
2917
|
+
{
|
|
2918
|
+
"name": "orgs_custom_properties_for_repos_create_or_update_organiza_2",
|
|
2919
|
+
"description": "Create or update a custom property for an organization",
|
|
2920
|
+
"method": "PUT",
|
|
2921
|
+
"path": "/orgs/{org}/properties/schema/{custom_property_name}",
|
|
2922
|
+
"deleteSendsJsonBody": false,
|
|
2923
|
+
"inputSchema": {
|
|
2924
|
+
"type": "object",
|
|
2925
|
+
"properties": {
|
|
2926
|
+
"org": {
|
|
2927
|
+
"type": "string",
|
|
2928
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2929
|
+
},
|
|
2930
|
+
"custom_property_name": {
|
|
2931
|
+
"type": "string",
|
|
2932
|
+
"description": "The custom property name"
|
|
2933
|
+
},
|
|
2934
|
+
"value_type": {
|
|
2935
|
+
"type": "string",
|
|
2936
|
+
"description": "The type of the value for the property",
|
|
2937
|
+
"enum": [
|
|
2938
|
+
"string",
|
|
2939
|
+
"single_select",
|
|
2940
|
+
"multi_select",
|
|
2941
|
+
"true_false",
|
|
2942
|
+
"url"
|
|
2943
|
+
]
|
|
2944
|
+
},
|
|
2945
|
+
"required": {
|
|
2946
|
+
"type": "boolean",
|
|
2947
|
+
"description": "Whether the property is required."
|
|
2948
|
+
},
|
|
2949
|
+
"default_value": {
|
|
2950
|
+
"type": "array",
|
|
2951
|
+
"description": "Default value of the property"
|
|
2952
|
+
},
|
|
2953
|
+
"description": {
|
|
2954
|
+
"type": "string",
|
|
2955
|
+
"description": "Short description of the property"
|
|
2956
|
+
},
|
|
2957
|
+
"allowed_values": {
|
|
2958
|
+
"type": "array",
|
|
2959
|
+
"description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values."
|
|
2960
|
+
},
|
|
2961
|
+
"values_editable_by": {
|
|
2962
|
+
"type": "string",
|
|
2963
|
+
"description": "Who can edit the values of the property",
|
|
2964
|
+
"enum": [
|
|
2965
|
+
"org_actors",
|
|
2966
|
+
"org_and_repo_actors",
|
|
2967
|
+
null
|
|
2968
|
+
]
|
|
2969
|
+
},
|
|
2970
|
+
"require_explicit_values": {
|
|
2971
|
+
"type": "boolean",
|
|
2972
|
+
"description": "Whether setting properties values is mandatory"
|
|
2973
|
+
}
|
|
2974
|
+
},
|
|
2975
|
+
"required": [
|
|
2976
|
+
"org",
|
|
2977
|
+
"custom_property_name",
|
|
2978
|
+
"value_type"
|
|
2979
|
+
]
|
|
2980
|
+
}
|
|
2981
|
+
},
|
|
2982
|
+
{
|
|
2983
|
+
"name": "orgs_custom_properties_for_repos_delete_organization_definit",
|
|
2984
|
+
"description": "Remove a custom property for an organization",
|
|
2985
|
+
"method": "DELETE",
|
|
2986
|
+
"path": "/orgs/{org}/properties/schema/{custom_property_name}",
|
|
2987
|
+
"deleteSendsJsonBody": false,
|
|
2988
|
+
"inputSchema": {
|
|
2989
|
+
"type": "object",
|
|
2990
|
+
"properties": {
|
|
2991
|
+
"org": {
|
|
2992
|
+
"type": "string",
|
|
2993
|
+
"description": "The organization name. The name is not case sensitive."
|
|
2994
|
+
},
|
|
2995
|
+
"custom_property_name": {
|
|
2996
|
+
"type": "string",
|
|
2997
|
+
"description": "The custom property name"
|
|
2998
|
+
}
|
|
2999
|
+
},
|
|
3000
|
+
"required": [
|
|
3001
|
+
"org",
|
|
3002
|
+
"custom_property_name"
|
|
3003
|
+
]
|
|
3004
|
+
}
|
|
3005
|
+
},
|
|
3006
|
+
{
|
|
3007
|
+
"name": "orgs_custom_properties_for_repos_get_organization_values",
|
|
3008
|
+
"description": "List custom property values for organization repositories",
|
|
3009
|
+
"method": "GET",
|
|
3010
|
+
"path": "/orgs/{org}/properties/values",
|
|
3011
|
+
"deleteSendsJsonBody": false,
|
|
3012
|
+
"inputSchema": {
|
|
3013
|
+
"type": "object",
|
|
3014
|
+
"properties": {
|
|
3015
|
+
"org": {
|
|
3016
|
+
"type": "string",
|
|
3017
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3018
|
+
},
|
|
3019
|
+
"per_page": {
|
|
3020
|
+
"type": "number",
|
|
3021
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
3022
|
+
},
|
|
3023
|
+
"page": {
|
|
3024
|
+
"type": "number",
|
|
3025
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
3026
|
+
},
|
|
3027
|
+
"repository_query": {
|
|
3028
|
+
"type": "string",
|
|
3029
|
+
"description": "Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers."
|
|
3030
|
+
}
|
|
3031
|
+
},
|
|
3032
|
+
"required": [
|
|
3033
|
+
"org"
|
|
3034
|
+
]
|
|
3035
|
+
}
|
|
3036
|
+
},
|
|
3037
|
+
{
|
|
3038
|
+
"name": "orgs_custom_properties_for_repos_create_or_update_organiza_3",
|
|
3039
|
+
"description": "Create or update custom property values for organization repositories",
|
|
3040
|
+
"method": "PATCH",
|
|
3041
|
+
"path": "/orgs/{org}/properties/values",
|
|
3042
|
+
"deleteSendsJsonBody": false,
|
|
3043
|
+
"inputSchema": {
|
|
3044
|
+
"type": "object",
|
|
3045
|
+
"properties": {
|
|
3046
|
+
"org": {
|
|
3047
|
+
"type": "string",
|
|
3048
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3049
|
+
},
|
|
3050
|
+
"repository_names": {
|
|
3051
|
+
"type": "array",
|
|
3052
|
+
"description": "The names of repositories that the custom property values will be applied to."
|
|
3053
|
+
},
|
|
3054
|
+
"properties": {
|
|
3055
|
+
"type": "array",
|
|
3056
|
+
"description": "List of custom property names and associated values to apply to the repositories."
|
|
3057
|
+
}
|
|
3058
|
+
},
|
|
3059
|
+
"required": [
|
|
3060
|
+
"org",
|
|
3061
|
+
"repository_names",
|
|
3062
|
+
"properties"
|
|
3063
|
+
]
|
|
3064
|
+
}
|
|
3065
|
+
},
|
|
3066
|
+
{
|
|
3067
|
+
"name": "orgs_list_public_members",
|
|
3068
|
+
"description": "List public organization members",
|
|
3069
|
+
"method": "GET",
|
|
3070
|
+
"path": "/orgs/{org}/public_members",
|
|
3071
|
+
"deleteSendsJsonBody": false,
|
|
3072
|
+
"inputSchema": {
|
|
3073
|
+
"type": "object",
|
|
3074
|
+
"properties": {
|
|
3075
|
+
"org": {
|
|
3076
|
+
"type": "string",
|
|
3077
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3078
|
+
},
|
|
3079
|
+
"per_page": {
|
|
3080
|
+
"type": "number",
|
|
3081
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
3082
|
+
},
|
|
3083
|
+
"page": {
|
|
3084
|
+
"type": "number",
|
|
3085
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
3086
|
+
}
|
|
3087
|
+
},
|
|
3088
|
+
"required": [
|
|
3089
|
+
"org"
|
|
3090
|
+
]
|
|
3091
|
+
}
|
|
3092
|
+
},
|
|
3093
|
+
{
|
|
3094
|
+
"name": "orgs_check_public_membership_for_user",
|
|
3095
|
+
"description": "Check public organization membership for a user",
|
|
3096
|
+
"method": "GET",
|
|
3097
|
+
"path": "/orgs/{org}/public_members/{username}",
|
|
3098
|
+
"deleteSendsJsonBody": false,
|
|
3099
|
+
"inputSchema": {
|
|
3100
|
+
"type": "object",
|
|
3101
|
+
"properties": {
|
|
3102
|
+
"org": {
|
|
3103
|
+
"type": "string",
|
|
3104
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3105
|
+
},
|
|
3106
|
+
"username": {
|
|
3107
|
+
"type": "string",
|
|
3108
|
+
"description": "The handle for the GitHub user account."
|
|
3109
|
+
}
|
|
3110
|
+
},
|
|
3111
|
+
"required": [
|
|
3112
|
+
"org",
|
|
3113
|
+
"username"
|
|
3114
|
+
]
|
|
3115
|
+
}
|
|
3116
|
+
},
|
|
3117
|
+
{
|
|
3118
|
+
"name": "orgs_set_public_membership_for_authenticated_user",
|
|
3119
|
+
"description": "Set public organization membership for the authenticated user",
|
|
3120
|
+
"method": "PUT",
|
|
3121
|
+
"path": "/orgs/{org}/public_members/{username}",
|
|
3122
|
+
"deleteSendsJsonBody": false,
|
|
3123
|
+
"inputSchema": {
|
|
3124
|
+
"type": "object",
|
|
3125
|
+
"properties": {
|
|
3126
|
+
"org": {
|
|
3127
|
+
"type": "string",
|
|
3128
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3129
|
+
},
|
|
3130
|
+
"username": {
|
|
3131
|
+
"type": "string",
|
|
3132
|
+
"description": "The handle for the GitHub user account."
|
|
3133
|
+
}
|
|
3134
|
+
},
|
|
3135
|
+
"required": [
|
|
3136
|
+
"org",
|
|
3137
|
+
"username"
|
|
3138
|
+
]
|
|
3139
|
+
}
|
|
3140
|
+
},
|
|
3141
|
+
{
|
|
3142
|
+
"name": "orgs_remove_public_membership_for_authenticated_user",
|
|
3143
|
+
"description": "Remove public organization membership for the authenticated user",
|
|
3144
|
+
"method": "DELETE",
|
|
3145
|
+
"path": "/orgs/{org}/public_members/{username}",
|
|
3146
|
+
"deleteSendsJsonBody": false,
|
|
3147
|
+
"inputSchema": {
|
|
3148
|
+
"type": "object",
|
|
3149
|
+
"properties": {
|
|
3150
|
+
"org": {
|
|
3151
|
+
"type": "string",
|
|
3152
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3153
|
+
},
|
|
3154
|
+
"username": {
|
|
3155
|
+
"type": "string",
|
|
3156
|
+
"description": "The handle for the GitHub user account."
|
|
3157
|
+
}
|
|
3158
|
+
},
|
|
3159
|
+
"required": [
|
|
3160
|
+
"org",
|
|
3161
|
+
"username"
|
|
3162
|
+
]
|
|
3163
|
+
}
|
|
3164
|
+
},
|
|
3165
|
+
{
|
|
3166
|
+
"name": "orgs_get_org_ruleset_history",
|
|
3167
|
+
"description": "Get organization ruleset history",
|
|
3168
|
+
"method": "GET",
|
|
3169
|
+
"path": "/orgs/{org}/rulesets/{ruleset_id}/history",
|
|
3170
|
+
"deleteSendsJsonBody": false,
|
|
3171
|
+
"inputSchema": {
|
|
3172
|
+
"type": "object",
|
|
3173
|
+
"properties": {
|
|
3174
|
+
"org": {
|
|
3175
|
+
"type": "string",
|
|
3176
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3177
|
+
},
|
|
3178
|
+
"per_page": {
|
|
3179
|
+
"type": "number",
|
|
3180
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
3181
|
+
},
|
|
3182
|
+
"page": {
|
|
3183
|
+
"type": "number",
|
|
3184
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
3185
|
+
},
|
|
3186
|
+
"ruleset_id": {
|
|
3187
|
+
"type": "number",
|
|
3188
|
+
"description": "The ID of the ruleset."
|
|
3189
|
+
}
|
|
3190
|
+
},
|
|
3191
|
+
"required": [
|
|
3192
|
+
"org",
|
|
3193
|
+
"ruleset_id"
|
|
3194
|
+
]
|
|
3195
|
+
}
|
|
3196
|
+
},
|
|
3197
|
+
{
|
|
3198
|
+
"name": "orgs_get_org_ruleset_version",
|
|
3199
|
+
"description": "Get organization ruleset version",
|
|
3200
|
+
"method": "GET",
|
|
3201
|
+
"path": "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}",
|
|
3202
|
+
"deleteSendsJsonBody": false,
|
|
3203
|
+
"inputSchema": {
|
|
3204
|
+
"type": "object",
|
|
3205
|
+
"properties": {
|
|
3206
|
+
"org": {
|
|
3207
|
+
"type": "string",
|
|
3208
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3209
|
+
},
|
|
3210
|
+
"ruleset_id": {
|
|
3211
|
+
"type": "number",
|
|
3212
|
+
"description": "The ID of the ruleset."
|
|
3213
|
+
},
|
|
3214
|
+
"version_id": {
|
|
3215
|
+
"type": "number",
|
|
3216
|
+
"description": "The ID of the version"
|
|
3217
|
+
}
|
|
3218
|
+
},
|
|
3219
|
+
"required": [
|
|
3220
|
+
"org",
|
|
3221
|
+
"ruleset_id",
|
|
3222
|
+
"version_id"
|
|
3223
|
+
]
|
|
3224
|
+
}
|
|
3225
|
+
},
|
|
3226
|
+
{
|
|
3227
|
+
"name": "orgs_get_immutable_releases_settings",
|
|
3228
|
+
"description": "Get immutable releases settings for an organization",
|
|
3229
|
+
"method": "GET",
|
|
3230
|
+
"path": "/orgs/{org}/settings/immutable-releases",
|
|
3231
|
+
"deleteSendsJsonBody": false,
|
|
3232
|
+
"inputSchema": {
|
|
3233
|
+
"type": "object",
|
|
3234
|
+
"properties": {
|
|
3235
|
+
"org": {
|
|
3236
|
+
"type": "string",
|
|
3237
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3238
|
+
}
|
|
3239
|
+
},
|
|
3240
|
+
"required": [
|
|
3241
|
+
"org"
|
|
3242
|
+
]
|
|
3243
|
+
}
|
|
3244
|
+
},
|
|
3245
|
+
{
|
|
3246
|
+
"name": "orgs_set_immutable_releases_settings",
|
|
3247
|
+
"description": "Set immutable releases settings for an organization",
|
|
3248
|
+
"method": "PUT",
|
|
3249
|
+
"path": "/orgs/{org}/settings/immutable-releases",
|
|
3250
|
+
"deleteSendsJsonBody": false,
|
|
3251
|
+
"inputSchema": {
|
|
3252
|
+
"type": "object",
|
|
3253
|
+
"properties": {
|
|
3254
|
+
"org": {
|
|
3255
|
+
"type": "string",
|
|
3256
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3257
|
+
},
|
|
3258
|
+
"enforced_repositories": {
|
|
3259
|
+
"type": "string",
|
|
3260
|
+
"description": "The policy that controls how immutable releases are enforced in the organization.",
|
|
3261
|
+
"enum": [
|
|
3262
|
+
"all",
|
|
3263
|
+
"none",
|
|
3264
|
+
"selected"
|
|
3265
|
+
]
|
|
3266
|
+
},
|
|
3267
|
+
"selected_repository_ids": {
|
|
3268
|
+
"type": "array",
|
|
3269
|
+
"description": "An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints."
|
|
3270
|
+
}
|
|
3271
|
+
},
|
|
3272
|
+
"required": [
|
|
3273
|
+
"org",
|
|
3274
|
+
"enforced_repositories"
|
|
3275
|
+
]
|
|
3276
|
+
}
|
|
3277
|
+
},
|
|
3278
|
+
{
|
|
3279
|
+
"name": "orgs_get_immutable_releases_settings_repositories",
|
|
3280
|
+
"description": "List selected repositories for immutable releases enforcement",
|
|
3281
|
+
"method": "GET",
|
|
3282
|
+
"path": "/orgs/{org}/settings/immutable-releases/repositories",
|
|
3283
|
+
"deleteSendsJsonBody": false,
|
|
3284
|
+
"inputSchema": {
|
|
3285
|
+
"type": "object",
|
|
3286
|
+
"properties": {
|
|
3287
|
+
"org": {
|
|
3288
|
+
"type": "string",
|
|
3289
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3290
|
+
},
|
|
3291
|
+
"page": {
|
|
3292
|
+
"type": "number",
|
|
3293
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
3294
|
+
},
|
|
3295
|
+
"per_page": {
|
|
3296
|
+
"type": "number",
|
|
3297
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
3298
|
+
}
|
|
3299
|
+
},
|
|
3300
|
+
"required": [
|
|
3301
|
+
"org"
|
|
3302
|
+
]
|
|
3303
|
+
}
|
|
3304
|
+
},
|
|
3305
|
+
{
|
|
3306
|
+
"name": "orgs_set_immutable_releases_settings_repositories",
|
|
3307
|
+
"description": "Set selected repositories for immutable releases enforcement",
|
|
3308
|
+
"method": "PUT",
|
|
3309
|
+
"path": "/orgs/{org}/settings/immutable-releases/repositories",
|
|
3310
|
+
"deleteSendsJsonBody": false,
|
|
3311
|
+
"inputSchema": {
|
|
3312
|
+
"type": "object",
|
|
3313
|
+
"properties": {
|
|
3314
|
+
"org": {
|
|
3315
|
+
"type": "string",
|
|
3316
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3317
|
+
},
|
|
3318
|
+
"selected_repository_ids": {
|
|
3319
|
+
"type": "array",
|
|
3320
|
+
"description": "An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints."
|
|
3321
|
+
}
|
|
3322
|
+
},
|
|
3323
|
+
"required": [
|
|
3324
|
+
"org",
|
|
3325
|
+
"selected_repository_ids"
|
|
3326
|
+
]
|
|
3327
|
+
}
|
|
3328
|
+
},
|
|
3329
|
+
{
|
|
3330
|
+
"name": "orgs_enable_selected_repository_immutable_releases_organizat",
|
|
3331
|
+
"description": "Enable a selected repository for immutable releases in an organization",
|
|
3332
|
+
"method": "PUT",
|
|
3333
|
+
"path": "/orgs/{org}/settings/immutable-releases/repositories/{repository_id}",
|
|
3334
|
+
"deleteSendsJsonBody": false,
|
|
3335
|
+
"inputSchema": {
|
|
3336
|
+
"type": "object",
|
|
3337
|
+
"properties": {
|
|
3338
|
+
"org": {
|
|
3339
|
+
"type": "string",
|
|
3340
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3341
|
+
},
|
|
3342
|
+
"repository_id": {
|
|
3343
|
+
"type": "number",
|
|
3344
|
+
"description": "The unique identifier of the repository."
|
|
3345
|
+
}
|
|
3346
|
+
},
|
|
3347
|
+
"required": [
|
|
3348
|
+
"org",
|
|
3349
|
+
"repository_id"
|
|
3350
|
+
]
|
|
3351
|
+
}
|
|
3352
|
+
},
|
|
3353
|
+
{
|
|
3354
|
+
"name": "orgs_disable_selected_repository_immutable_releases_organiza",
|
|
3355
|
+
"description": "Disable a selected repository for immutable releases in an organization",
|
|
3356
|
+
"method": "DELETE",
|
|
3357
|
+
"path": "/orgs/{org}/settings/immutable-releases/repositories/{repository_id}",
|
|
3358
|
+
"deleteSendsJsonBody": false,
|
|
3359
|
+
"inputSchema": {
|
|
3360
|
+
"type": "object",
|
|
3361
|
+
"properties": {
|
|
3362
|
+
"org": {
|
|
3363
|
+
"type": "string",
|
|
3364
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3365
|
+
},
|
|
3366
|
+
"repository_id": {
|
|
3367
|
+
"type": "number",
|
|
3368
|
+
"description": "The unique identifier of the repository."
|
|
3369
|
+
}
|
|
3370
|
+
},
|
|
3371
|
+
"required": [
|
|
3372
|
+
"org",
|
|
3373
|
+
"repository_id"
|
|
3374
|
+
]
|
|
3375
|
+
}
|
|
3376
|
+
},
|
|
3377
|
+
{
|
|
3378
|
+
"name": "orgs_list_memberships_for_authenticated_user",
|
|
3379
|
+
"description": "List organization memberships for the authenticated user",
|
|
3380
|
+
"method": "GET",
|
|
3381
|
+
"path": "/user/memberships/orgs",
|
|
3382
|
+
"deleteSendsJsonBody": false,
|
|
3383
|
+
"inputSchema": {
|
|
3384
|
+
"type": "object",
|
|
3385
|
+
"properties": {
|
|
3386
|
+
"state": {
|
|
3387
|
+
"type": "string",
|
|
3388
|
+
"description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.",
|
|
3389
|
+
"enum": [
|
|
3390
|
+
"active",
|
|
3391
|
+
"pending"
|
|
3392
|
+
]
|
|
3393
|
+
},
|
|
3394
|
+
"per_page": {
|
|
3395
|
+
"type": "number",
|
|
3396
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
3397
|
+
},
|
|
3398
|
+
"page": {
|
|
3399
|
+
"type": "number",
|
|
3400
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
3401
|
+
}
|
|
3402
|
+
},
|
|
3403
|
+
"required": []
|
|
3404
|
+
}
|
|
3405
|
+
},
|
|
3406
|
+
{
|
|
3407
|
+
"name": "orgs_get_membership_for_authenticated_user",
|
|
3408
|
+
"description": "Get an organization membership for the authenticated user",
|
|
3409
|
+
"method": "GET",
|
|
3410
|
+
"path": "/user/memberships/orgs/{org}",
|
|
3411
|
+
"deleteSendsJsonBody": false,
|
|
3412
|
+
"inputSchema": {
|
|
3413
|
+
"type": "object",
|
|
3414
|
+
"properties": {
|
|
3415
|
+
"org": {
|
|
3416
|
+
"type": "string",
|
|
3417
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3418
|
+
}
|
|
3419
|
+
},
|
|
3420
|
+
"required": [
|
|
3421
|
+
"org"
|
|
3422
|
+
]
|
|
3423
|
+
}
|
|
3424
|
+
},
|
|
3425
|
+
{
|
|
3426
|
+
"name": "orgs_update_membership_for_authenticated_user",
|
|
3427
|
+
"description": "Update an organization membership for the authenticated user",
|
|
3428
|
+
"method": "PATCH",
|
|
3429
|
+
"path": "/user/memberships/orgs/{org}",
|
|
3430
|
+
"deleteSendsJsonBody": false,
|
|
3431
|
+
"inputSchema": {
|
|
3432
|
+
"type": "object",
|
|
3433
|
+
"properties": {
|
|
3434
|
+
"org": {
|
|
3435
|
+
"type": "string",
|
|
3436
|
+
"description": "The organization name. The name is not case sensitive."
|
|
3437
|
+
},
|
|
3438
|
+
"state": {
|
|
3439
|
+
"type": "string",
|
|
3440
|
+
"description": "The state that the membership should be in. Only `\"active\"` will be accepted.",
|
|
3441
|
+
"enum": [
|
|
3442
|
+
"active"
|
|
3443
|
+
]
|
|
3444
|
+
}
|
|
3445
|
+
},
|
|
3446
|
+
"required": [
|
|
3447
|
+
"org",
|
|
3448
|
+
"state"
|
|
3449
|
+
]
|
|
3450
|
+
}
|
|
3451
|
+
},
|
|
3452
|
+
{
|
|
3453
|
+
"name": "orgs_list_for_authenticated_user",
|
|
3454
|
+
"description": "List organizations for the authenticated user",
|
|
3455
|
+
"method": "GET",
|
|
3456
|
+
"path": "/user/orgs",
|
|
3457
|
+
"deleteSendsJsonBody": false,
|
|
3458
|
+
"inputSchema": {
|
|
3459
|
+
"type": "object",
|
|
3460
|
+
"properties": {
|
|
3461
|
+
"per_page": {
|
|
3462
|
+
"type": "number",
|
|
3463
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
3464
|
+
},
|
|
3465
|
+
"page": {
|
|
3466
|
+
"type": "number",
|
|
3467
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
3468
|
+
}
|
|
3469
|
+
},
|
|
3470
|
+
"required": []
|
|
3471
|
+
}
|
|
3472
|
+
},
|
|
3473
|
+
{
|
|
3474
|
+
"name": "orgs_list_for_user",
|
|
3475
|
+
"description": "List organizations for a user",
|
|
3476
|
+
"method": "GET",
|
|
3477
|
+
"path": "/users/{username}/orgs",
|
|
3478
|
+
"deleteSendsJsonBody": false,
|
|
3479
|
+
"inputSchema": {
|
|
3480
|
+
"type": "object",
|
|
3481
|
+
"properties": {
|
|
3482
|
+
"username": {
|
|
3483
|
+
"type": "string",
|
|
3484
|
+
"description": "The handle for the GitHub user account."
|
|
3485
|
+
},
|
|
3486
|
+
"per_page": {
|
|
3487
|
+
"type": "number",
|
|
3488
|
+
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
3489
|
+
},
|
|
3490
|
+
"page": {
|
|
3491
|
+
"type": "number",
|
|
3492
|
+
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\""
|
|
3493
|
+
}
|
|
3494
|
+
},
|
|
3495
|
+
"required": [
|
|
3496
|
+
"username"
|
|
3497
|
+
]
|
|
3498
|
+
}
|
|
3499
|
+
}
|
|
3500
|
+
];
|
|
3501
|
+
|
|
3502
|
+
export const tools = ENDPOINTS.map((e) => ({
|
|
3503
|
+
name: e.name,
|
|
3504
|
+
description: e.description,
|
|
3505
|
+
method: e.method,
|
|
3506
|
+
path: e.path,
|
|
3507
|
+
deleteSendsJsonBody: Boolean(e.deleteSendsJsonBody),
|
|
3508
|
+
inputSchema: e.inputSchema,
|
|
3509
|
+
handler: async (params) => ({
|
|
3510
|
+
content: [{ type: 'text', text: JSON.stringify(await apiRequest(e.method, e.path, params, { deleteSendsJsonBody: e.deleteSendsJsonBody }), null, 2) }],
|
|
3511
|
+
}),
|
|
3512
|
+
}));
|