gitabu 0.1.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.
Files changed (104) hide show
  1. checksums.yaml +7 -0
  2. data/.rspec +3 -0
  3. data/.rubocop.yml +33 -0
  4. data/CHANGELOG.md +3 -0
  5. data/Gemfile +10 -0
  6. data/Gemfile.lock +65 -0
  7. data/LICENSE.txt +21 -0
  8. data/README.md +42 -0
  9. data/Rakefile +12 -0
  10. data/gitabu.gemspec +41 -0
  11. data/lib/gitabu/api/v3/actions.rb +3724 -0
  12. data/lib/gitabu/api/v3/activity.rb +835 -0
  13. data/lib/gitabu/api/v3/apps.rb +961 -0
  14. data/lib/gitabu/api/v3/billing.rb +217 -0
  15. data/lib/gitabu/api/v3/branches.rb +1098 -0
  16. data/lib/gitabu/api/v3/checks.rb +384 -0
  17. data/lib/gitabu/api/v3/code_scanning.rb +315 -0
  18. data/lib/gitabu/api/v3/codes_of_conduct.rb +92 -0
  19. data/lib/gitabu/api/v3/codespaces.rb +650 -0
  20. data/lib/gitabu/api/v3/collaborators.rb +341 -0
  21. data/lib/gitabu/api/v3/commits.rb +428 -0
  22. data/lib/gitabu/api/v3/dependabot.rb +419 -0
  23. data/lib/gitabu/api/v3/deploy_keys.rb +152 -0
  24. data/lib/gitabu/api/v3/deployments.rb +356 -0
  25. data/lib/gitabu/api/v3/emojis.rb +67 -0
  26. data/lib/gitabu/api/v3/enterprise_admin.rb +495 -0
  27. data/lib/gitabu/api/v3/gists.rb +552 -0
  28. data/lib/gitabu/api/v3/git.rb +409 -0
  29. data/lib/gitabu/api/v3/gitignore.rb +92 -0
  30. data/lib/gitabu/api/v3/interactions.rb +275 -0
  31. data/lib/gitabu/api/v3/issues.rb +1119 -0
  32. data/lib/gitabu/api/v3/licenses.rb +118 -0
  33. data/lib/gitabu/api/v3/markdown.rb +94 -0
  34. data/lib/gitabu/api/v3/meta.rb +142 -0
  35. data/lib/gitabu/api/v3/metrics.rb +302 -0
  36. data/lib/gitabu/api/v3/migrations.rb +631 -0
  37. data/lib/gitabu/api/v3/orgs.rb +1291 -0
  38. data/lib/gitabu/api/v3/packages.rb +686 -0
  39. data/lib/gitabu/api/v3/pages.rb +282 -0
  40. data/lib/gitabu/api/v3/projects.rb +693 -0
  41. data/lib/gitabu/api/v3/pulls.rb +816 -0
  42. data/lib/gitabu/api/v3/rate_limit.rb +67 -0
  43. data/lib/gitabu/api/v3/reactions.rb +734 -0
  44. data/lib/gitabu/api/v3/releases.rb +411 -0
  45. data/lib/gitabu/api/v3/repos.rb +1136 -0
  46. data/lib/gitabu/api/v3/scim.rb +214 -0
  47. data/lib/gitabu/api/v3/search.rb +217 -0
  48. data/lib/gitabu/api/v3/secret_scanning.rb +201 -0
  49. data/lib/gitabu/api/v3/teams.rb +1963 -0
  50. data/lib/gitabu/api/v3/users.rb +851 -0
  51. data/lib/gitabu/api/v3/webhooks.rb +379 -0
  52. data/lib/gitabu/builder.rb +37 -0
  53. data/lib/gitabu/client.rb +8 -0
  54. data/lib/gitabu/generator.rb +75 -0
  55. data/lib/gitabu/http_client.rb +96 -0
  56. data/lib/gitabu/items.rb +110 -0
  57. data/lib/gitabu/public/api/v3/actions.json +5779 -0
  58. data/lib/gitabu/public/api/v3/activity.json +1248 -0
  59. data/lib/gitabu/public/api/v3/apps.json +1174 -0
  60. data/lib/gitabu/public/api/v3/billing.json +183 -0
  61. data/lib/gitabu/public/api/v3/branches.json +1886 -0
  62. data/lib/gitabu/public/api/v3/checks.json +856 -0
  63. data/lib/gitabu/public/api/v3/code_scanning.json +666 -0
  64. data/lib/gitabu/public/api/v3/codes_of_conduct.json +41 -0
  65. data/lib/gitabu/public/api/v3/codespaces.json +884 -0
  66. data/lib/gitabu/public/api/v3/collaborators.json +464 -0
  67. data/lib/gitabu/public/api/v3/commits.json +830 -0
  68. data/lib/gitabu/public/api/v3/dependabot.json +596 -0
  69. data/lib/gitabu/public/api/v3/deploy_keys.json +195 -0
  70. data/lib/gitabu/public/api/v3/deployments.json +698 -0
  71. data/lib/gitabu/public/api/v3/emojis.json +18 -0
  72. data/lib/gitabu/public/api/v3/enterprise_admin.json +881 -0
  73. data/lib/gitabu/public/api/v3/gists.json +689 -0
  74. data/lib/gitabu/public/api/v3/git.json +735 -0
  75. data/lib/gitabu/public/api/v3/gitignore.json +41 -0
  76. data/lib/gitabu/public/api/v3/interactions.json +265 -0
  77. data/lib/gitabu/public/api/v3/issues.json +2359 -0
  78. data/lib/gitabu/public/api/v3/licenses.json +100 -0
  79. data/lib/gitabu/public/api/v3/markdown.json +59 -0
  80. data/lib/gitabu/public/api/v3/meta.json +69 -0
  81. data/lib/gitabu/public/api/v3/metrics.json +342 -0
  82. data/lib/gitabu/public/api/v3/migrations.json +960 -0
  83. data/lib/gitabu/public/api/v3/orgs.json +1989 -0
  84. data/lib/gitabu/public/api/v3/packages.json +1078 -0
  85. data/lib/gitabu/public/api/v3/pages.json +373 -0
  86. data/lib/gitabu/public/api/v3/projects.json +966 -0
  87. data/lib/gitabu/public/api/v3/pulls.json +1768 -0
  88. data/lib/gitabu/public/api/v3/rate_limit.json +18 -0
  89. data/lib/gitabu/public/api/v3/reactions.json +1425 -0
  90. data/lib/gitabu/public/api/v3/releases.json +753 -0
  91. data/lib/gitabu/public/api/v3/repos.json +2314 -0
  92. data/lib/gitabu/public/api/v3/scim.json +412 -0
  93. data/lib/gitabu/public/api/v3/search.json +408 -0
  94. data/lib/gitabu/public/api/v3/secret_scanning.json +385 -0
  95. data/lib/gitabu/public/api/v3/teams.json +3126 -0
  96. data/lib/gitabu/public/api/v3/users.json +956 -0
  97. data/lib/gitabu/public/api/v3/webhooks.json +667 -0
  98. data/lib/gitabu/run.rb +237 -0
  99. data/lib/gitabu/scraper.rb +86 -0
  100. data/lib/gitabu/templates/template.rb.erb +70 -0
  101. data/lib/gitabu/version.rb +6 -0
  102. data/lib/gitabu.rb +57 -0
  103. data/sig/gitabu.rbs +4 -0
  104. metadata +177 -0
@@ -0,0 +1,881 @@
1
+ {
2
+ "result": [
3
+ {
4
+ "namespace_description": "Get the audit log for an enterprise",
5
+ "method": "get",
6
+ "endpoint": "/enterprises/{enterprise}/audit-log",
7
+ "field_0": {
8
+ "field_type": "header",
9
+ "fields": {
10
+ "name": "accept",
11
+ "type": "string",
12
+ "in": "header",
13
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
14
+ }
15
+ },
16
+ "field_1": {
17
+ "field_type": "path",
18
+ "fields": {
19
+ "name": "enterprise",
20
+ "type": "string",
21
+ "in": "path",
22
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
23
+ }
24
+ },
25
+ "field_2": {
26
+ "field_type": "query",
27
+ "fields": {
28
+ "name": "phrase",
29
+ "type": "string",
30
+ "in": "query",
31
+ "description": "A search phrase. For more information, see Searching the audit log."
32
+ }
33
+ },
34
+ "field_3": {
35
+ "field_type": "query",
36
+ "fields": {
37
+ "name": "include",
38
+ "type": "string",
39
+ "in": "query",
40
+ "description": "The event types to include:\n\nweb - returns web (non-Git) events.\ngit - returns Git events.\nall - returns both web and Git events.\n\nThe default is web."
41
+ }
42
+ },
43
+ "field_4": {
44
+ "field_type": "query",
45
+ "fields": {
46
+ "name": "after",
47
+ "type": "string",
48
+ "in": "query",
49
+ "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor."
50
+ }
51
+ },
52
+ "field_5": {
53
+ "field_type": "query",
54
+ "fields": {
55
+ "name": "before",
56
+ "type": "string",
57
+ "in": "query",
58
+ "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor."
59
+ }
60
+ },
61
+ "field_6": {
62
+ "field_type": "query",
63
+ "fields": {
64
+ "name": "order",
65
+ "type": "string",
66
+ "in": "query",
67
+ "description": "The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.\nThe default is desc."
68
+ }
69
+ },
70
+ "field_7": {
71
+ "field_type": "query",
72
+ "fields": {
73
+ "name": "page",
74
+ "type": "integer",
75
+ "in": "query",
76
+ "description": "Page number of the results to fetch.Default: 1"
77
+ }
78
+ },
79
+ "field_8": {
80
+ "field_type": "query",
81
+ "fields": {
82
+ "name": "per_page",
83
+ "type": "integer",
84
+ "in": "query",
85
+ "description": "Results per page (max 100)Default: 30"
86
+ }
87
+ }
88
+ },
89
+ {
90
+ "namespace_description": "Get GitHub Actions billing for an enterprise",
91
+ "method": "get",
92
+ "endpoint": "/enterprises/{enterprise}/settings/billing/actions",
93
+ "field_0": {
94
+ "field_type": "header",
95
+ "fields": {
96
+ "name": "accept",
97
+ "type": "string",
98
+ "in": "header",
99
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
100
+ }
101
+ },
102
+ "field_1": {
103
+ "field_type": "path",
104
+ "fields": {
105
+ "name": "enterprise",
106
+ "type": "string",
107
+ "in": "path",
108
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
109
+ }
110
+ }
111
+ },
112
+ {
113
+ "namespace_description": "Get GitHub Advanced Security active committers for an enterprise",
114
+ "method": "get",
115
+ "endpoint": "/enterprises/{enterprise}/settings/billing/advanced-security",
116
+ "field_0": {
117
+ "field_type": "header",
118
+ "fields": {
119
+ "name": "accept",
120
+ "type": "string",
121
+ "in": "header",
122
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
123
+ }
124
+ },
125
+ "field_1": {
126
+ "field_type": "path",
127
+ "fields": {
128
+ "name": "enterprise",
129
+ "type": "string",
130
+ "in": "path",
131
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
132
+ }
133
+ },
134
+ "field_2": {
135
+ "field_type": "query",
136
+ "fields": {
137
+ "name": "per_page",
138
+ "type": "integer",
139
+ "in": "query",
140
+ "description": "Results per page (max 100)Default: 30"
141
+ }
142
+ },
143
+ "field_3": {
144
+ "field_type": "query",
145
+ "fields": {
146
+ "name": "page",
147
+ "type": "integer",
148
+ "in": "query",
149
+ "description": "Page number of the results to fetch.Default: 1"
150
+ }
151
+ }
152
+ },
153
+ {
154
+ "namespace_description": "Get GitHub Packages billing for an enterprise",
155
+ "method": "get",
156
+ "endpoint": "/enterprises/{enterprise}/settings/billing/packages",
157
+ "field_0": {
158
+ "field_type": "header",
159
+ "fields": {
160
+ "name": "accept",
161
+ "type": "string",
162
+ "in": "header",
163
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
164
+ }
165
+ },
166
+ "field_1": {
167
+ "field_type": "path",
168
+ "fields": {
169
+ "name": "enterprise",
170
+ "type": "string",
171
+ "in": "path",
172
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
173
+ }
174
+ }
175
+ },
176
+ {
177
+ "namespace_description": "Get shared storage billing for an enterprise",
178
+ "method": "get",
179
+ "endpoint": "/enterprises/{enterprise}/settings/billing/shared-storage",
180
+ "field_0": {
181
+ "field_type": "header",
182
+ "fields": {
183
+ "name": "accept",
184
+ "type": "string",
185
+ "in": "header",
186
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
187
+ }
188
+ },
189
+ "field_1": {
190
+ "field_type": "path",
191
+ "fields": {
192
+ "name": "enterprise",
193
+ "type": "string",
194
+ "in": "path",
195
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
196
+ }
197
+ }
198
+ },
199
+ {
200
+ "namespace_description": "List provisioned SCIM groups for an enterprise",
201
+ "method": "get",
202
+ "endpoint": "/scim/v2/enterprises/{enterprise}/Groups",
203
+ "field_0": {
204
+ "field_type": "header",
205
+ "fields": {
206
+ "name": "accept",
207
+ "type": "string",
208
+ "in": "header",
209
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
210
+ }
211
+ },
212
+ "field_1": {
213
+ "field_type": "path",
214
+ "fields": {
215
+ "name": "enterprise",
216
+ "type": "string",
217
+ "in": "path",
218
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
219
+ }
220
+ },
221
+ "field_2": {
222
+ "field_type": "query",
223
+ "fields": {
224
+ "name": "startIndex",
225
+ "type": "integer",
226
+ "in": "query",
227
+ "description": "Used for pagination: the index of the first result to return."
228
+ }
229
+ },
230
+ "field_3": {
231
+ "field_type": "query",
232
+ "fields": {
233
+ "name": "count",
234
+ "type": "integer",
235
+ "in": "query",
236
+ "description": "Used for pagination: the number of results to return."
237
+ }
238
+ },
239
+ "field_4": {
240
+ "field_type": "query",
241
+ "fields": {
242
+ "name": "filter",
243
+ "type": "string",
244
+ "in": "query",
245
+ "description": "filter results"
246
+ }
247
+ },
248
+ "field_5": {
249
+ "field_type": "query",
250
+ "fields": {
251
+ "name": "excludedAttributes",
252
+ "type": "string",
253
+ "in": "query",
254
+ "description": "attributes to exclude"
255
+ }
256
+ }
257
+ },
258
+ {
259
+ "namespace_description": "Provision a SCIM enterprise group and invite users",
260
+ "method": "post",
261
+ "endpoint": "/scim/v2/enterprises/{enterprise}/Groups",
262
+ "field_0": {
263
+ "field_type": "header",
264
+ "fields": {
265
+ "name": "accept",
266
+ "type": "string",
267
+ "in": "header",
268
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
269
+ }
270
+ },
271
+ "field_1": {
272
+ "field_type": "path",
273
+ "fields": {
274
+ "name": "enterprise",
275
+ "type": "string",
276
+ "in": "path",
277
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
278
+ }
279
+ },
280
+ "field_2": {
281
+ "field_type": "body",
282
+ "fields": {
283
+ "name": "schemas",
284
+ "type": "array of strings",
285
+ "in": "body",
286
+ "description": "Required. The SCIM schema URIs."
287
+ }
288
+ },
289
+ "field_3": {
290
+ "field_type": "body",
291
+ "fields": {
292
+ "name": "displayName",
293
+ "type": "string",
294
+ "in": "body",
295
+ "description": "Required. The name of the SCIM group. This must match the GitHub organization that the group maps to."
296
+ }
297
+ },
298
+ "field_4": {
299
+ "field_type": "body",
300
+ "fields": {
301
+ "name": "members",
302
+ "type": "array of objects",
303
+ "in": "body",
304
+ "description": ""
305
+ }
306
+ },
307
+ "field_5": {
308
+ "field_type": null,
309
+ "fields": {
310
+ "name": "Properties of themembersitemsName (Type)Descriptionvalue (string)Required. The SCIM user ID for a user.",
311
+ "type": null,
312
+ "in": null,
313
+ "description": null
314
+ }
315
+ }
316
+ },
317
+ {
318
+ "namespace_description": "Get SCIM provisioning information for an enterprise group",
319
+ "method": "get",
320
+ "endpoint": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}",
321
+ "field_0": {
322
+ "field_type": "header",
323
+ "fields": {
324
+ "name": "accept",
325
+ "type": "string",
326
+ "in": "header",
327
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
328
+ }
329
+ },
330
+ "field_1": {
331
+ "field_type": "path",
332
+ "fields": {
333
+ "name": "enterprise",
334
+ "type": "string",
335
+ "in": "path",
336
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
337
+ }
338
+ },
339
+ "field_2": {
340
+ "field_type": "path",
341
+ "fields": {
342
+ "name": "scim_group_id",
343
+ "type": "string",
344
+ "in": "path",
345
+ "description": "Identifier generated by the GitHub SCIM endpoint."
346
+ }
347
+ },
348
+ "field_3": {
349
+ "field_type": "query",
350
+ "fields": {
351
+ "name": "excludedAttributes",
352
+ "type": "string",
353
+ "in": "query",
354
+ "description": "Attributes to exclude."
355
+ }
356
+ }
357
+ },
358
+ {
359
+ "namespace_description": "Set SCIM information for a provisioned enterprise group",
360
+ "method": "put",
361
+ "endpoint": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}",
362
+ "field_0": {
363
+ "field_type": "header",
364
+ "fields": {
365
+ "name": "accept",
366
+ "type": "string",
367
+ "in": "header",
368
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
369
+ }
370
+ },
371
+ "field_1": {
372
+ "field_type": "path",
373
+ "fields": {
374
+ "name": "enterprise",
375
+ "type": "string",
376
+ "in": "path",
377
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
378
+ }
379
+ },
380
+ "field_2": {
381
+ "field_type": "path",
382
+ "fields": {
383
+ "name": "scim_group_id",
384
+ "type": "string",
385
+ "in": "path",
386
+ "description": "Identifier generated by the GitHub SCIM endpoint."
387
+ }
388
+ },
389
+ "field_3": {
390
+ "field_type": "body",
391
+ "fields": {
392
+ "name": "schemas",
393
+ "type": "array of strings",
394
+ "in": "body",
395
+ "description": "Required. The SCIM schema URIs."
396
+ }
397
+ },
398
+ "field_4": {
399
+ "field_type": "body",
400
+ "fields": {
401
+ "name": "displayName",
402
+ "type": "string",
403
+ "in": "body",
404
+ "description": "Required. The name of the SCIM group. This must match the GitHub organization that the group maps to."
405
+ }
406
+ },
407
+ "field_5": {
408
+ "field_type": "body",
409
+ "fields": {
410
+ "name": "members",
411
+ "type": "array of objects",
412
+ "in": "body",
413
+ "description": ""
414
+ }
415
+ },
416
+ "field_6": {
417
+ "field_type": null,
418
+ "fields": {
419
+ "name": "Properties of themembersitemsName (Type)Descriptionvalue (string)Required. The SCIM user ID for a user.",
420
+ "type": null,
421
+ "in": null,
422
+ "description": null
423
+ }
424
+ }
425
+ },
426
+ {
427
+ "namespace_description": "Update an attribute for a SCIM enterprise group",
428
+ "method": "patch",
429
+ "endpoint": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}",
430
+ "field_0": {
431
+ "field_type": "header",
432
+ "fields": {
433
+ "name": "accept",
434
+ "type": "string",
435
+ "in": "header",
436
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
437
+ }
438
+ },
439
+ "field_1": {
440
+ "field_type": "path",
441
+ "fields": {
442
+ "name": "enterprise",
443
+ "type": "string",
444
+ "in": "path",
445
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
446
+ }
447
+ },
448
+ "field_2": {
449
+ "field_type": "path",
450
+ "fields": {
451
+ "name": "scim_group_id",
452
+ "type": "string",
453
+ "in": "path",
454
+ "description": "Identifier generated by the GitHub SCIM endpoint."
455
+ }
456
+ },
457
+ "field_3": {
458
+ "field_type": "body",
459
+ "fields": {
460
+ "name": "schemas",
461
+ "type": "array of strings",
462
+ "in": "body",
463
+ "description": "Required. The SCIM schema URIs."
464
+ }
465
+ },
466
+ "field_4": {
467
+ "field_type": "body",
468
+ "fields": {
469
+ "name": "Operations",
470
+ "type": "array of objects",
471
+ "in": "body",
472
+ "description": "Required. Array of SCIM operations."
473
+ }
474
+ },
475
+ "field_5": {
476
+ "field_type": null,
477
+ "fields": {
478
+ "name": "Properties of theOperationsitemsName (Type)Descriptionop (string)Required. path (string)value ()Can be any value - string, number, array or object.",
479
+ "type": null,
480
+ "in": null,
481
+ "description": null
482
+ }
483
+ }
484
+ },
485
+ {
486
+ "namespace_description": "Delete a SCIM group from an enterprise",
487
+ "method": "delete",
488
+ "endpoint": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}",
489
+ "field_0": {
490
+ "field_type": "header",
491
+ "fields": {
492
+ "name": "accept",
493
+ "type": "string",
494
+ "in": "header",
495
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
496
+ }
497
+ },
498
+ "field_1": {
499
+ "field_type": "path",
500
+ "fields": {
501
+ "name": "enterprise",
502
+ "type": "string",
503
+ "in": "path",
504
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
505
+ }
506
+ },
507
+ "field_2": {
508
+ "field_type": "path",
509
+ "fields": {
510
+ "name": "scim_group_id",
511
+ "type": "string",
512
+ "in": "path",
513
+ "description": "Identifier generated by the GitHub SCIM endpoint."
514
+ }
515
+ }
516
+ },
517
+ {
518
+ "namespace_description": "List SCIM provisioned identities for an enterprise",
519
+ "method": "get",
520
+ "endpoint": "/scim/v2/enterprises/{enterprise}/Users",
521
+ "field_0": {
522
+ "field_type": "header",
523
+ "fields": {
524
+ "name": "accept",
525
+ "type": "string",
526
+ "in": "header",
527
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
528
+ }
529
+ },
530
+ "field_1": {
531
+ "field_type": "path",
532
+ "fields": {
533
+ "name": "enterprise",
534
+ "type": "string",
535
+ "in": "path",
536
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
537
+ }
538
+ },
539
+ "field_2": {
540
+ "field_type": "query",
541
+ "fields": {
542
+ "name": "startIndex",
543
+ "type": "integer",
544
+ "in": "query",
545
+ "description": "Used for pagination: the index of the first result to return."
546
+ }
547
+ },
548
+ "field_3": {
549
+ "field_type": "query",
550
+ "fields": {
551
+ "name": "count",
552
+ "type": "integer",
553
+ "in": "query",
554
+ "description": "Used for pagination: the number of results to return."
555
+ }
556
+ },
557
+ "field_4": {
558
+ "field_type": "query",
559
+ "fields": {
560
+ "name": "filter",
561
+ "type": "string",
562
+ "in": "query",
563
+ "description": "filter results"
564
+ }
565
+ }
566
+ },
567
+ {
568
+ "namespace_description": "Provision and invite a SCIM enterprise user",
569
+ "method": "post",
570
+ "endpoint": "/scim/v2/enterprises/{enterprise}/Users",
571
+ "field_0": {
572
+ "field_type": "header",
573
+ "fields": {
574
+ "name": "accept",
575
+ "type": "string",
576
+ "in": "header",
577
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
578
+ }
579
+ },
580
+ "field_1": {
581
+ "field_type": "path",
582
+ "fields": {
583
+ "name": "enterprise",
584
+ "type": "string",
585
+ "in": "path",
586
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
587
+ }
588
+ },
589
+ "field_2": {
590
+ "field_type": "body",
591
+ "fields": {
592
+ "name": "schemas",
593
+ "type": "array of strings",
594
+ "in": "body",
595
+ "description": "Required. The SCIM schema URIs."
596
+ }
597
+ },
598
+ "field_3": {
599
+ "field_type": "body",
600
+ "fields": {
601
+ "name": "userName",
602
+ "type": "string",
603
+ "in": "body",
604
+ "description": "Required. The username for the user."
605
+ }
606
+ },
607
+ "field_4": {
608
+ "field_type": "body",
609
+ "fields": {
610
+ "name": "name",
611
+ "type": "object",
612
+ "in": "body",
613
+ "description": "Required. "
614
+ }
615
+ },
616
+ "field_5": {
617
+ "field_type": null,
618
+ "fields": {
619
+ "name": "Properties of thenameobjectName (Type)DescriptiongivenName (string)Required. The first name of the user.familyName (string)Required. The last name of the user.",
620
+ "type": null,
621
+ "in": null,
622
+ "description": null
623
+ }
624
+ },
625
+ "field_6": {
626
+ "field_type": "body",
627
+ "fields": {
628
+ "name": "emails",
629
+ "type": "array of objects",
630
+ "in": "body",
631
+ "description": "Required. List of user emails."
632
+ }
633
+ },
634
+ "field_7": {
635
+ "field_type": null,
636
+ "fields": {
637
+ "name": "Properties of theemailsitemsName (Type)Descriptionvalue (string)Required. The email address.type (string)Required. The type of email address.primary (boolean)Required. Whether this email address is the primary address.",
638
+ "type": null,
639
+ "in": null,
640
+ "description": null
641
+ }
642
+ },
643
+ "field_8": {
644
+ "field_type": "body",
645
+ "fields": {
646
+ "name": "groups",
647
+ "type": "array of objects",
648
+ "in": "body",
649
+ "description": "List of SCIM group IDs the user is a member of."
650
+ }
651
+ },
652
+ "field_9": {
653
+ "field_type": null,
654
+ "fields": {
655
+ "name": "Properties of thegroupsitemsName (Type)Descriptionvalue (string)",
656
+ "type": null,
657
+ "in": null,
658
+ "description": null
659
+ }
660
+ }
661
+ },
662
+ {
663
+ "namespace_description": "Get SCIM provisioning information for an enterprise user",
664
+ "method": "get",
665
+ "endpoint": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}",
666
+ "field_0": {
667
+ "field_type": "header",
668
+ "fields": {
669
+ "name": "accept",
670
+ "type": "string",
671
+ "in": "header",
672
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
673
+ }
674
+ },
675
+ "field_1": {
676
+ "field_type": "path",
677
+ "fields": {
678
+ "name": "enterprise",
679
+ "type": "string",
680
+ "in": "path",
681
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
682
+ }
683
+ },
684
+ "field_2": {
685
+ "field_type": "path",
686
+ "fields": {
687
+ "name": "scim_user_id",
688
+ "type": "string",
689
+ "in": "path",
690
+ "description": "scim_user_id parameter"
691
+ }
692
+ }
693
+ },
694
+ {
695
+ "namespace_description": "Set SCIM information for a provisioned enterprise user",
696
+ "method": "put",
697
+ "endpoint": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}",
698
+ "field_0": {
699
+ "field_type": "header",
700
+ "fields": {
701
+ "name": "accept",
702
+ "type": "string",
703
+ "in": "header",
704
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
705
+ }
706
+ },
707
+ "field_1": {
708
+ "field_type": "path",
709
+ "fields": {
710
+ "name": "enterprise",
711
+ "type": "string",
712
+ "in": "path",
713
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
714
+ }
715
+ },
716
+ "field_2": {
717
+ "field_type": "path",
718
+ "fields": {
719
+ "name": "scim_user_id",
720
+ "type": "string",
721
+ "in": "path",
722
+ "description": "scim_user_id parameter"
723
+ }
724
+ },
725
+ "field_3": {
726
+ "field_type": "body",
727
+ "fields": {
728
+ "name": "schemas",
729
+ "type": "array of strings",
730
+ "in": "body",
731
+ "description": "Required. The SCIM schema URIs."
732
+ }
733
+ },
734
+ "field_4": {
735
+ "field_type": "body",
736
+ "fields": {
737
+ "name": "userName",
738
+ "type": "string",
739
+ "in": "body",
740
+ "description": "Required. The username for the user."
741
+ }
742
+ },
743
+ "field_5": {
744
+ "field_type": "body",
745
+ "fields": {
746
+ "name": "name",
747
+ "type": "object",
748
+ "in": "body",
749
+ "description": "Required. "
750
+ }
751
+ },
752
+ "field_6": {
753
+ "field_type": null,
754
+ "fields": {
755
+ "name": "Properties of thenameobjectName (Type)DescriptiongivenName (string)Required. The first name of the user.familyName (string)Required. The last name of the user.",
756
+ "type": null,
757
+ "in": null,
758
+ "description": null
759
+ }
760
+ },
761
+ "field_7": {
762
+ "field_type": "body",
763
+ "fields": {
764
+ "name": "emails",
765
+ "type": "array of objects",
766
+ "in": "body",
767
+ "description": "Required. List of user emails."
768
+ }
769
+ },
770
+ "field_8": {
771
+ "field_type": null,
772
+ "fields": {
773
+ "name": "Properties of theemailsitemsName (Type)Descriptionvalue (string)Required. The email address.type (string)Required. The type of email address.primary (boolean)Required. Whether this email address is the primary address.",
774
+ "type": null,
775
+ "in": null,
776
+ "description": null
777
+ }
778
+ },
779
+ "field_9": {
780
+ "field_type": "body",
781
+ "fields": {
782
+ "name": "groups",
783
+ "type": "array of objects",
784
+ "in": "body",
785
+ "description": "List of SCIM group IDs the user is a member of."
786
+ }
787
+ },
788
+ "field_10": {
789
+ "field_type": null,
790
+ "fields": {
791
+ "name": "Properties of thegroupsitemsName (Type)Descriptionvalue (string)",
792
+ "type": null,
793
+ "in": null,
794
+ "description": null
795
+ }
796
+ }
797
+ },
798
+ {
799
+ "namespace_description": "Update an attribute for a SCIM enterprise user",
800
+ "method": "patch",
801
+ "endpoint": "{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n",
802
+ "field_0": {
803
+ "field_type": "header",
804
+ "fields": {
805
+ "name": "accept",
806
+ "type": "string",
807
+ "in": "header",
808
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
809
+ }
810
+ },
811
+ "field_1": {
812
+ "field_type": "path",
813
+ "fields": {
814
+ "name": "enterprise",
815
+ "type": "string",
816
+ "in": "path",
817
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
818
+ }
819
+ },
820
+ "field_2": {
821
+ "field_type": "path",
822
+ "fields": {
823
+ "name": "scim_user_id",
824
+ "type": "string",
825
+ "in": "path",
826
+ "description": "scim_user_id parameter"
827
+ }
828
+ },
829
+ "field_3": {
830
+ "field_type": "body",
831
+ "fields": {
832
+ "name": "schemas",
833
+ "type": "array of strings",
834
+ "in": "body",
835
+ "description": "Required. The SCIM schema URIs."
836
+ }
837
+ },
838
+ "field_4": {
839
+ "field_type": "body",
840
+ "fields": {
841
+ "name": "Operations",
842
+ "type": "array of objects",
843
+ "in": "body",
844
+ "description": "Required. Array of SCIM operations."
845
+ }
846
+ }
847
+ },
848
+ {
849
+ "namespace_description": "Delete a SCIM user from an enterprise",
850
+ "method": "delete",
851
+ "endpoint": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}",
852
+ "field_0": {
853
+ "field_type": "header",
854
+ "fields": {
855
+ "name": "accept",
856
+ "type": "string",
857
+ "in": "header",
858
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
859
+ }
860
+ },
861
+ "field_1": {
862
+ "field_type": "path",
863
+ "fields": {
864
+ "name": "enterprise",
865
+ "type": "string",
866
+ "in": "path",
867
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id."
868
+ }
869
+ },
870
+ "field_2": {
871
+ "field_type": "path",
872
+ "fields": {
873
+ "name": "scim_user_id",
874
+ "type": "string",
875
+ "in": "path",
876
+ "description": "scim_user_id parameter"
877
+ }
878
+ }
879
+ }
880
+ ]
881
+ }