PlanOpticon

planopticon / api / auth / index.html
1
2
<!doctype html>
3
<html lang="en" class="no-js">
4
<head>
5
6
<meta charset="utf-8">
7
<meta name="viewport" content="width=device-width,initial-scale=1">
8
9
<meta name="description" content="AI-powered video analysis and knowledge extraction">
10
11
12
<meta name="author" content="CONFLICT LLC">
13
14
15
<link rel="canonical" href="https://planopticon.dev/api/auth/">
16
17
18
<link rel="prev" href="../sources/">
19
20
21
<link rel="next" href="../../faq/">
22
23
24
25
26
27
<link rel="icon" href="../../assets/images/favicon.png">
28
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.4">
29
30
31
32
<title>Authentication - PlanOpticon</title>
33
34
35
36
<link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
37
38
39
<link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
40
41
42
43
44
45
46
47
48
49
50
51
52
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
53
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
54
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
55
56
57
58
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
59
60
<link rel="stylesheet" href="../../assets/css/custom.css">
61
62
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
63
64
65
66
67
68
</head>
69
70
71
72
73
74
75
76
77
78
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom">
79
80
81
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
82
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
83
<label class="md-overlay" for="__drawer"></label>
84
<div data-md-component="skip">
85
86
87
<a href="#auth-api-reference" class="md-skip">
88
Skip to content
89
</a>
90
91
</div>
92
<div data-md-component="announce">
93
94
</div>
95
96
97
98
99
<header class="md-header" data-md-component="header">
100
<nav class="md-header__inner md-grid" aria-label="Header">
101
<a href="../.." title="PlanOpticon" class="md-header__button md-logo" aria-label="PlanOpticon" data-md-component="logo">
102
103
<img src="../../assets/images/conflict-logo.svg" alt="logo">
104
105
</a>
106
<label class="md-header__button md-icon" for="__drawer">
107
108
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
109
</label>
110
<div class="md-header__title" data-md-component="header-title">
111
<div class="md-header__ellipsis">
112
<div class="md-header__topic">
113
<span class="md-ellipsis">
114
PlanOpticon
115
</span>
116
</div>
117
<div class="md-header__topic" data-md-component="header-topic">
118
<span class="md-ellipsis">
119
120
Authentication
121
122
</span>
123
</div>
124
</div>
125
</div>
126
127
128
<form class="md-header__option" data-md-component="palette">
129
130
131
132
133
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
134
135
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
136
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
137
</label>
138
139
140
141
142
143
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
144
145
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
146
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
147
</label>
148
149
150
</form>
151
152
153
154
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
155
156
157
158
159
160
<label class="md-header__button md-icon" for="__search">
161
162
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
163
</label>
164
<div class="md-search" data-md-component="search" role="dialog">
165
<label class="md-search__overlay" for="__search"></label>
166
<div class="md-search__inner" role="search">
167
<form class="md-search__form" name="search">
168
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
169
<label class="md-search__icon md-icon" for="__search">
170
171
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
172
173
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
174
</label>
175
<nav class="md-search__options" aria-label="Search">
176
177
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
178
179
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
180
</button>
181
</nav>
182
183
<div class="md-search__suggest" data-md-component="search-suggest"></div>
184
185
</form>
186
<div class="md-search__output">
187
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
188
<div class="md-search-result" data-md-component="search-result">
189
<div class="md-search-result__meta">
190
Initializing search
191
</div>
192
<ol class="md-search-result__list" role="presentation"></ol>
193
</div>
194
</div>
195
</div>
196
</div>
197
</div>
198
199
200
201
<div class="md-header__source">
202
<a href="https://github.com/ConflictHQ/PlanOpticon" title="Go to repository" class="md-source" data-md-component="source">
203
<div class="md-source__icon md-icon">
204
205
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
206
</div>
207
<div class="md-source__repository">
208
ConflictHQ/PlanOpticon
209
</div>
210
</a>
211
</div>
212
213
</nav>
214
215
</header>
216
217
<div class="md-container" data-md-component="container">
218
219
220
221
222
223
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
224
<div class="md-grid">
225
<ul class="md-tabs__list">
226
227
228
229
230
231
232
<li class="md-tabs__item">
233
<a href="../.." class="md-tabs__link">
234
235
236
237
238
239
Home
240
241
</a>
242
</li>
243
244
245
246
247
248
249
250
251
252
253
<li class="md-tabs__item">
254
<a href="../../getting-started/installation/" class="md-tabs__link">
255
256
257
258
Getting Started
259
260
</a>
261
</li>
262
263
264
265
266
267
268
269
270
271
272
273
<li class="md-tabs__item">
274
<a href="../../guide/single-video/" class="md-tabs__link">
275
276
277
278
User Guide
279
280
</a>
281
</li>
282
283
284
285
286
287
288
289
290
291
<li class="md-tabs__item">
292
<a href="../../use-cases/" class="md-tabs__link">
293
294
295
296
297
298
Use Cases
299
300
</a>
301
</li>
302
303
304
305
306
307
308
309
310
<li class="md-tabs__item">
311
<a href="../../cli-reference/" class="md-tabs__link">
312
313
314
315
316
317
CLI Reference
318
319
</a>
320
</li>
321
322
323
324
325
326
327
328
329
330
331
<li class="md-tabs__item">
332
<a href="../../architecture/overview/" class="md-tabs__link">
333
334
335
336
Architecture
337
338
</a>
339
</li>
340
341
342
343
344
345
346
347
348
349
350
351
352
353
<li class="md-tabs__item md-tabs__item--active">
354
<a href="../models/" class="md-tabs__link">
355
356
357
358
API Reference
359
360
</a>
361
</li>
362
363
364
365
366
367
368
369
370
371
<li class="md-tabs__item">
372
<a href="../../faq/" class="md-tabs__link">
373
374
375
376
377
378
FAQ & Troubleshooting
379
380
</a>
381
</li>
382
383
384
385
386
387
388
389
390
<li class="md-tabs__item">
391
<a href="../../contributing/" class="md-tabs__link">
392
393
394
395
396
397
Contributing
398
399
</a>
400
</li>
401
402
403
404
</ul>
405
</div>
406
</nav>
407
408
409
410
<main class="md-main" data-md-component="main">
411
<div class="md-main__inner md-grid">
412
413
414
415
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
416
<div class="md-sidebar__scrollwrap">
417
<div class="md-sidebar__inner">
418
419
420
421
422
423
424
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
425
<label class="md-nav__title" for="__drawer">
426
<a href="../.." title="PlanOpticon" class="md-nav__button md-logo" aria-label="PlanOpticon" data-md-component="logo">
427
428
<img src="../../assets/images/conflict-logo.svg" alt="logo">
429
430
</a>
431
PlanOpticon
432
</label>
433
434
<div class="md-nav__source">
435
<a href="https://github.com/ConflictHQ/PlanOpticon" title="Go to repository" class="md-source" data-md-component="source">
436
<div class="md-source__icon md-icon">
437
438
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
439
</div>
440
<div class="md-source__repository">
441
ConflictHQ/PlanOpticon
442
</div>
443
</a>
444
</div>
445
446
<ul class="md-nav__list" data-md-scrollfix>
447
448
449
450
451
452
453
454
<li class="md-nav__item">
455
<a href="../.." class="md-nav__link">
456
457
458
459
<span class="md-ellipsis">
460
461
462
Home
463
464
465
466
</span>
467
468
469
470
</a>
471
</li>
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
<li class="md-nav__item md-nav__item--nested">
492
493
494
495
496
497
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
498
499
500
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
501
502
503
504
<span class="md-ellipsis">
505
506
507
Getting Started
508
509
510
511
</span>
512
513
514
515
<span class="md-nav__icon md-icon"></span>
516
</label>
517
518
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
519
<label class="md-nav__title" for="__nav_2">
520
<span class="md-nav__icon md-icon"></span>
521
522
523
Getting Started
524
525
526
</label>
527
<ul class="md-nav__list" data-md-scrollfix>
528
529
530
531
532
533
534
535
<li class="md-nav__item">
536
<a href="../../getting-started/installation/" class="md-nav__link">
537
538
539
540
<span class="md-ellipsis">
541
542
543
Installation
544
545
546
547
</span>
548
549
550
551
</a>
552
</li>
553
554
555
556
557
558
559
560
561
562
563
<li class="md-nav__item">
564
<a href="../../getting-started/quickstart/" class="md-nav__link">
565
566
567
568
<span class="md-ellipsis">
569
570
571
Quick Start
572
573
574
575
</span>
576
577
578
579
</a>
580
</li>
581
582
583
584
585
586
587
588
589
590
591
<li class="md-nav__item">
592
<a href="../../getting-started/configuration/" class="md-nav__link">
593
594
595
596
<span class="md-ellipsis">
597
598
599
Configuration
600
601
602
603
</span>
604
605
606
607
</a>
608
</li>
609
610
611
612
613
</ul>
614
</nav>
615
616
</li>
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
<li class="md-nav__item md-nav__item--nested">
637
638
639
640
641
642
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
643
644
645
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
646
647
648
649
<span class="md-ellipsis">
650
651
652
User Guide
653
654
655
656
</span>
657
658
659
660
<span class="md-nav__icon md-icon"></span>
661
</label>
662
663
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
664
<label class="md-nav__title" for="__nav_3">
665
<span class="md-nav__icon md-icon"></span>
666
667
668
User Guide
669
670
671
</label>
672
<ul class="md-nav__list" data-md-scrollfix>
673
674
675
676
677
678
679
680
<li class="md-nav__item">
681
<a href="../../guide/single-video/" class="md-nav__link">
682
683
684
685
<span class="md-ellipsis">
686
687
688
Single Video Analysis
689
690
691
692
</span>
693
694
695
696
</a>
697
</li>
698
699
700
701
702
703
704
705
706
707
708
<li class="md-nav__item">
709
<a href="../../guide/batch/" class="md-nav__link">
710
711
712
713
<span class="md-ellipsis">
714
715
716
Batch Processing
717
718
719
720
</span>
721
722
723
724
</a>
725
</li>
726
727
728
729
730
731
732
733
734
735
736
<li class="md-nav__item">
737
<a href="../../guide/document-ingestion/" class="md-nav__link">
738
739
740
741
<span class="md-ellipsis">
742
743
744
Document Ingestion
745
746
747
748
</span>
749
750
751
752
</a>
753
</li>
754
755
756
757
758
759
760
761
762
763
764
<li class="md-nav__item">
765
<a href="../../guide/cloud-sources/" class="md-nav__link">
766
767
768
769
<span class="md-ellipsis">
770
771
772
Cloud Sources
773
774
775
776
</span>
777
778
779
780
</a>
781
</li>
782
783
784
785
786
787
788
789
790
791
792
<li class="md-nav__item">
793
<a href="../../guide/knowledge-graphs/" class="md-nav__link">
794
795
796
797
<span class="md-ellipsis">
798
799
800
Knowledge Graphs
801
802
803
804
</span>
805
806
807
808
</a>
809
</li>
810
811
812
813
814
815
816
817
818
819
820
<li class="md-nav__item">
821
<a href="../../guide/companion/" class="md-nav__link">
822
823
824
825
<span class="md-ellipsis">
826
827
828
Interactive Companion
829
830
831
832
</span>
833
834
835
836
</a>
837
</li>
838
839
840
841
842
843
844
845
846
847
848
<li class="md-nav__item">
849
<a href="../../guide/planning-agent/" class="md-nav__link">
850
851
852
853
<span class="md-ellipsis">
854
855
856
Planning Agent
857
858
859
860
</span>
861
862
863
864
</a>
865
</li>
866
867
868
869
870
871
872
873
874
875
876
<li class="md-nav__item">
877
<a href="../../guide/authentication/" class="md-nav__link">
878
879
880
881
<span class="md-ellipsis">
882
883
884
Authentication
885
886
887
888
</span>
889
890
891
892
</a>
893
</li>
894
895
896
897
898
899
900
901
902
903
904
<li class="md-nav__item">
905
<a href="../../guide/export/" class="md-nav__link">
906
907
908
909
<span class="md-ellipsis">
910
911
912
Export & Documents
913
914
915
916
</span>
917
918
919
920
</a>
921
</li>
922
923
924
925
926
927
928
929
930
931
932
<li class="md-nav__item">
933
<a href="../../guide/output-formats/" class="md-nav__link">
934
935
936
937
<span class="md-ellipsis">
938
939
940
Output Formats
941
942
943
944
</span>
945
946
947
948
</a>
949
</li>
950
951
952
953
954
</ul>
955
</nav>
956
957
</li>
958
959
960
961
962
963
964
965
966
967
<li class="md-nav__item">
968
<a href="../../use-cases/" class="md-nav__link">
969
970
971
972
<span class="md-ellipsis">
973
974
975
Use Cases
976
977
978
979
</span>
980
981
982
983
</a>
984
</li>
985
986
987
988
989
990
991
992
993
994
<li class="md-nav__item">
995
<a href="../../cli-reference/" class="md-nav__link">
996
997
998
999
<span class="md-ellipsis">
1000
1001
1002
CLI Reference
1003
1004
1005
1006
</span>
1007
1008
1009
1010
</a>
1011
</li>
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
<li class="md-nav__item md-nav__item--nested">
1032
1033
1034
1035
1036
1037
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
1038
1039
1040
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1041
1042
1043
1044
<span class="md-ellipsis">
1045
1046
1047
Architecture
1048
1049
1050
1051
</span>
1052
1053
1054
1055
<span class="md-nav__icon md-icon"></span>
1056
</label>
1057
1058
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1059
<label class="md-nav__title" for="__nav_6">
1060
<span class="md-nav__icon md-icon"></span>
1061
1062
1063
Architecture
1064
1065
1066
</label>
1067
<ul class="md-nav__list" data-md-scrollfix>
1068
1069
1070
1071
1072
1073
1074
1075
<li class="md-nav__item">
1076
<a href="../../architecture/overview/" class="md-nav__link">
1077
1078
1079
1080
<span class="md-ellipsis">
1081
1082
1083
Overview
1084
1085
1086
1087
</span>
1088
1089
1090
1091
</a>
1092
</li>
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
<li class="md-nav__item">
1104
<a href="../../architecture/providers/" class="md-nav__link">
1105
1106
1107
1108
<span class="md-ellipsis">
1109
1110
1111
Provider System
1112
1113
1114
1115
</span>
1116
1117
1118
1119
</a>
1120
</li>
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
<li class="md-nav__item">
1132
<a href="../../architecture/pipeline/" class="md-nav__link">
1133
1134
1135
1136
<span class="md-ellipsis">
1137
1138
1139
Processing Pipeline
1140
1141
1142
1143
</span>
1144
1145
1146
1147
</a>
1148
</li>
1149
1150
1151
1152
1153
</ul>
1154
</nav>
1155
1156
</li>
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
1182
1183
1184
1185
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" checked>
1186
1187
1188
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
1189
1190
1191
1192
<span class="md-ellipsis">
1193
1194
1195
API Reference
1196
1197
1198
1199
</span>
1200
1201
1202
1203
<span class="md-nav__icon md-icon"></span>
1204
</label>
1205
1206
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="true">
1207
<label class="md-nav__title" for="__nav_7">
1208
<span class="md-nav__icon md-icon"></span>
1209
1210
1211
API Reference
1212
1213
1214
</label>
1215
<ul class="md-nav__list" data-md-scrollfix>
1216
1217
1218
1219
1220
1221
1222
1223
<li class="md-nav__item">
1224
<a href="../models/" class="md-nav__link">
1225
1226
1227
1228
<span class="md-ellipsis">
1229
1230
1231
Models
1232
1233
1234
1235
</span>
1236
1237
1238
1239
</a>
1240
</li>
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
<li class="md-nav__item">
1252
<a href="../providers/" class="md-nav__link">
1253
1254
1255
1256
<span class="md-ellipsis">
1257
1258
1259
Providers
1260
1261
1262
1263
</span>
1264
1265
1266
1267
</a>
1268
</li>
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
<li class="md-nav__item">
1280
<a href="../analyzers/" class="md-nav__link">
1281
1282
1283
1284
<span class="md-ellipsis">
1285
1286
1287
Analyzers
1288
1289
1290
1291
</span>
1292
1293
1294
1295
</a>
1296
</li>
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
<li class="md-nav__item">
1308
<a href="../agent/" class="md-nav__link">
1309
1310
1311
1312
<span class="md-ellipsis">
1313
1314
1315
Agent & Skills
1316
1317
1318
1319
</span>
1320
1321
1322
1323
</a>
1324
</li>
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
<li class="md-nav__item">
1336
<a href="../sources/" class="md-nav__link">
1337
1338
1339
1340
<span class="md-ellipsis">
1341
1342
1343
Sources
1344
1345
1346
1347
</span>
1348
1349
1350
1351
</a>
1352
</li>
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
<li class="md-nav__item md-nav__item--active">
1366
1367
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1368
1369
1370
1371
1372
1373
<label class="md-nav__link md-nav__link--active" for="__toc">
1374
1375
1376
1377
<span class="md-ellipsis">
1378
1379
1380
Authentication
1381
1382
1383
1384
</span>
1385
1386
1387
1388
<span class="md-nav__icon md-icon"></span>
1389
</label>
1390
1391
<a href="./" class="md-nav__link md-nav__link--active">
1392
1393
1394
1395
<span class="md-ellipsis">
1396
1397
1398
Authentication
1399
1400
1401
1402
</span>
1403
1404
1405
1406
</a>
1407
1408
1409
1410
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1411
1412
1413
1414
1415
1416
1417
<label class="md-nav__title" for="__toc">
1418
<span class="md-nav__icon md-icon"></span>
1419
Table of contents
1420
</label>
1421
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1422
1423
<li class="md-nav__item">
1424
<a href="#video_processor.auth" class="md-nav__link">
1425
<span class="md-ellipsis">
1426
1427
auth
1428
1429
</span>
1430
</a>
1431
1432
<nav class="md-nav" aria-label="auth">
1433
<ul class="md-nav__list">
1434
1435
<li class="md-nav__item">
1436
<a href="#video_processor.auth.AuthConfig" class="md-nav__link">
1437
<span class="md-ellipsis">
1438
1439
AuthConfig
1440
1441
</span>
1442
</a>
1443
1444
</li>
1445
1446
<li class="md-nav__item">
1447
<a href="#video_processor.auth.AuthResult" class="md-nav__link">
1448
<span class="md-ellipsis">
1449
1450
AuthResult
1451
1452
</span>
1453
</a>
1454
1455
</li>
1456
1457
<li class="md-nav__item">
1458
<a href="#video_processor.auth.OAuthManager" class="md-nav__link">
1459
<span class="md-ellipsis">
1460
1461
OAuthManager
1462
1463
</span>
1464
</a>
1465
1466
<nav class="md-nav" aria-label="OAuthManager">
1467
<ul class="md-nav__list">
1468
1469
<li class="md-nav__item">
1470
<a href="#video_processor.auth.OAuthManager.authenticate" class="md-nav__link">
1471
<span class="md-ellipsis">
1472
1473
authenticate
1474
1475
</span>
1476
</a>
1477
1478
</li>
1479
1480
<li class="md-nav__item">
1481
<a href="#video_processor.auth.OAuthManager.clear_token" class="md-nav__link">
1482
<span class="md-ellipsis">
1483
1484
clear_token
1485
1486
</span>
1487
</a>
1488
1489
</li>
1490
1491
<li class="md-nav__item">
1492
<a href="#video_processor.auth.OAuthManager.get_token" class="md-nav__link">
1493
<span class="md-ellipsis">
1494
1495
get_token
1496
1497
</span>
1498
</a>
1499
1500
</li>
1501
1502
</ul>
1503
</nav>
1504
1505
</li>
1506
1507
<li class="md-nav__item">
1508
<a href="#video_processor.auth.get_auth_config" class="md-nav__link">
1509
<span class="md-ellipsis">
1510
1511
get_auth_config
1512
1513
</span>
1514
</a>
1515
1516
</li>
1517
1518
<li class="md-nav__item">
1519
<a href="#video_processor.auth.get_auth_manager" class="md-nav__link">
1520
<span class="md-ellipsis">
1521
1522
get_auth_manager
1523
1524
</span>
1525
</a>
1526
1527
</li>
1528
1529
</ul>
1530
</nav>
1531
1532
</li>
1533
1534
<li class="md-nav__item">
1535
<a href="#overview" class="md-nav__link">
1536
<span class="md-ellipsis">
1537
1538
Overview
1539
1540
</span>
1541
</a>
1542
1543
</li>
1544
1545
<li class="md-nav__item">
1546
<a href="#authconfig" class="md-nav__link">
1547
<span class="md-ellipsis">
1548
1549
AuthConfig
1550
1551
</span>
1552
</a>
1553
1554
<nav class="md-nav" aria-label="AuthConfig">
1555
<ul class="md-nav__list">
1556
1557
<li class="md-nav__item">
1558
<a href="#fields" class="md-nav__link">
1559
<span class="md-ellipsis">
1560
1561
Fields
1562
1563
</span>
1564
</a>
1565
1566
</li>
1567
1568
<li class="md-nav__item">
1569
<a href="#resolved-properties" class="md-nav__link">
1570
<span class="md-ellipsis">
1571
1572
Resolved Properties
1573
1574
</span>
1575
</a>
1576
1577
</li>
1578
1579
</ul>
1580
</nav>
1581
1582
</li>
1583
1584
<li class="md-nav__item">
1585
<a href="#authresult" class="md-nav__link">
1586
<span class="md-ellipsis">
1587
1588
AuthResult
1589
1590
</span>
1591
</a>
1592
1593
</li>
1594
1595
<li class="md-nav__item">
1596
<a href="#oauthmanager" class="md-nav__link">
1597
<span class="md-ellipsis">
1598
1599
OAuthManager
1600
1601
</span>
1602
</a>
1603
1604
<nav class="md-nav" aria-label="OAuthManager">
1605
<ul class="md-nav__list">
1606
1607
<li class="md-nav__item">
1608
<a href="#constructor" class="md-nav__link">
1609
<span class="md-ellipsis">
1610
1611
Constructor
1612
1613
</span>
1614
</a>
1615
1616
</li>
1617
1618
<li class="md-nav__item">
1619
<a href="#authenticate" class="md-nav__link">
1620
<span class="md-ellipsis">
1621
1622
authenticate()
1623
1624
</span>
1625
</a>
1626
1627
</li>
1628
1629
<li class="md-nav__item">
1630
<a href="#get_token" class="md-nav__link">
1631
<span class="md-ellipsis">
1632
1633
get_token()
1634
1635
</span>
1636
</a>
1637
1638
</li>
1639
1640
<li class="md-nav__item">
1641
<a href="#clear_token" class="md-nav__link">
1642
<span class="md-ellipsis">
1643
1644
clear_token()
1645
1646
</span>
1647
</a>
1648
1649
</li>
1650
1651
</ul>
1652
</nav>
1653
1654
</li>
1655
1656
<li class="md-nav__item">
1657
<a href="#authentication-flows" class="md-nav__link">
1658
<span class="md-ellipsis">
1659
1660
Authentication Flows
1661
1662
</span>
1663
</a>
1664
1665
<nav class="md-nav" aria-label="Authentication Flows">
1666
<ul class="md-nav__list">
1667
1668
<li class="md-nav__item">
1669
<a href="#saved-token-auto-refresh" class="md-nav__link">
1670
<span class="md-ellipsis">
1671
1672
Saved Token (auto-refresh)
1673
1674
</span>
1675
</a>
1676
1677
</li>
1678
1679
<li class="md-nav__item">
1680
<a href="#client-credentials-grant" class="md-nav__link">
1681
<span class="md-ellipsis">
1682
1683
Client Credentials Grant
1684
1685
</span>
1686
</a>
1687
1688
</li>
1689
1690
<li class="md-nav__item">
1691
<a href="#oauth-20-authorization-code-with-pkce" class="md-nav__link">
1692
<span class="md-ellipsis">
1693
1694
OAuth 2.0 Authorization Code with PKCE
1695
1696
</span>
1697
</a>
1698
1699
</li>
1700
1701
<li class="md-nav__item">
1702
<a href="#api-key-fallback" class="md-nav__link">
1703
<span class="md-ellipsis">
1704
1705
API Key Fallback
1706
1707
</span>
1708
</a>
1709
1710
</li>
1711
1712
</ul>
1713
</nav>
1714
1715
</li>
1716
1717
<li class="md-nav__item">
1718
<a href="#known_configs" class="md-nav__link">
1719
<span class="md-ellipsis">
1720
1721
KNOWN_CONFIGS
1722
1723
</span>
1724
</a>
1725
1726
<nav class="md-nav" aria-label="KNOWN_CONFIGS">
1727
<ul class="md-nav__list">
1728
1729
<li class="md-nav__item">
1730
<a href="#zoom" class="md-nav__link">
1731
<span class="md-ellipsis">
1732
1733
Zoom
1734
1735
</span>
1736
</a>
1737
1738
</li>
1739
1740
<li class="md-nav__item">
1741
<a href="#google-drive-meet-workspace" class="md-nav__link">
1742
<span class="md-ellipsis">
1743
1744
Google (Drive, Meet, Workspace)
1745
1746
</span>
1747
</a>
1748
1749
</li>
1750
1751
<li class="md-nav__item">
1752
<a href="#github" class="md-nav__link">
1753
<span class="md-ellipsis">
1754
1755
GitHub
1756
1757
</span>
1758
</a>
1759
1760
</li>
1761
1762
</ul>
1763
</nav>
1764
1765
</li>
1766
1767
<li class="md-nav__item">
1768
<a href="#helper-functions" class="md-nav__link">
1769
<span class="md-ellipsis">
1770
1771
Helper Functions
1772
1773
</span>
1774
</a>
1775
1776
<nav class="md-nav" aria-label="Helper Functions">
1777
<ul class="md-nav__list">
1778
1779
<li class="md-nav__item">
1780
<a href="#get_auth_config" class="md-nav__link">
1781
<span class="md-ellipsis">
1782
1783
get_auth_config()
1784
1785
</span>
1786
</a>
1787
1788
</li>
1789
1790
<li class="md-nav__item">
1791
<a href="#get_auth_manager" class="md-nav__link">
1792
<span class="md-ellipsis">
1793
1794
get_auth_manager()
1795
1796
</span>
1797
</a>
1798
1799
</li>
1800
1801
</ul>
1802
</nav>
1803
1804
</li>
1805
1806
<li class="md-nav__item">
1807
<a href="#usage-examples" class="md-nav__link">
1808
<span class="md-ellipsis">
1809
1810
Usage Examples
1811
1812
</span>
1813
</a>
1814
1815
<nav class="md-nav" aria-label="Usage Examples">
1816
<ul class="md-nav__list">
1817
1818
<li class="md-nav__item">
1819
<a href="#quick-authentication-for-a-known-service" class="md-nav__link">
1820
<span class="md-ellipsis">
1821
1822
Quick authentication for a known service
1823
1824
</span>
1825
</a>
1826
1827
</li>
1828
1829
<li class="md-nav__item">
1830
<a href="#custom-service-configuration" class="md-nav__link">
1831
<span class="md-ellipsis">
1832
1833
Custom service configuration
1834
1835
</span>
1836
</a>
1837
1838
</li>
1839
1840
<li class="md-nav__item">
1841
<a href="#using-auth-in-a-custom-source-connector" class="md-nav__link">
1842
<span class="md-ellipsis">
1843
1844
Using auth in a custom source connector
1845
1846
</span>
1847
</a>
1848
1849
</li>
1850
1851
<li class="md-nav__item">
1852
<a href="#logout-clear-saved-token" class="md-nav__link">
1853
<span class="md-ellipsis">
1854
1855
Logout / clear saved token
1856
1857
</span>
1858
</a>
1859
1860
</li>
1861
1862
<li class="md-nav__item">
1863
<a href="#token-storage-location" class="md-nav__link">
1864
<span class="md-ellipsis">
1865
1866
Token storage location
1867
1868
</span>
1869
</a>
1870
1871
</li>
1872
1873
</ul>
1874
</nav>
1875
1876
</li>
1877
1878
</ul>
1879
1880
</nav>
1881
1882
</li>
1883
1884
1885
1886
1887
</ul>
1888
</nav>
1889
1890
</li>
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
<li class="md-nav__item">
1901
<a href="../../faq/" class="md-nav__link">
1902
1903
1904
1905
<span class="md-ellipsis">
1906
1907
1908
FAQ & Troubleshooting
1909
1910
1911
1912
</span>
1913
1914
1915
1916
</a>
1917
</li>
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
<li class="md-nav__item">
1928
<a href="../../contributing/" class="md-nav__link">
1929
1930
1931
1932
<span class="md-ellipsis">
1933
1934
1935
Contributing
1936
1937
1938
1939
</span>
1940
1941
1942
1943
</a>
1944
</li>
1945
1946
1947
1948
</ul>
1949
</nav>
1950
</div>
1951
</div>
1952
</div>
1953
1954
1955
1956
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1957
<div class="md-sidebar__scrollwrap">
1958
<div class="md-sidebar__inner">
1959
1960
1961
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1962
1963
1964
1965
1966
1967
1968
<label class="md-nav__title" for="__toc">
1969
<span class="md-nav__icon md-icon"></span>
1970
Table of contents
1971
</label>
1972
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1973
1974
<li class="md-nav__item">
1975
<a href="#video_processor.auth" class="md-nav__link">
1976
<span class="md-ellipsis">
1977
1978
auth
1979
1980
</span>
1981
</a>
1982
1983
<nav class="md-nav" aria-label="auth">
1984
<ul class="md-nav__list">
1985
1986
<li class="md-nav__item">
1987
<a href="#video_processor.auth.AuthConfig" class="md-nav__link">
1988
<span class="md-ellipsis">
1989
1990
AuthConfig
1991
1992
</span>
1993
</a>
1994
1995
</li>
1996
1997
<li class="md-nav__item">
1998
<a href="#video_processor.auth.AuthResult" class="md-nav__link">
1999
<span class="md-ellipsis">
2000
2001
AuthResult
2002
2003
</span>
2004
</a>
2005
2006
</li>
2007
2008
<li class="md-nav__item">
2009
<a href="#video_processor.auth.OAuthManager" class="md-nav__link">
2010
<span class="md-ellipsis">
2011
2012
OAuthManager
2013
2014
</span>
2015
</a>
2016
2017
<nav class="md-nav" aria-label="OAuthManager">
2018
<ul class="md-nav__list">
2019
2020
<li class="md-nav__item">
2021
<a href="#video_processor.auth.OAuthManager.authenticate" class="md-nav__link">
2022
<span class="md-ellipsis">
2023
2024
authenticate
2025
2026
</span>
2027
</a>
2028
2029
</li>
2030
2031
<li class="md-nav__item">
2032
<a href="#video_processor.auth.OAuthManager.clear_token" class="md-nav__link">
2033
<span class="md-ellipsis">
2034
2035
clear_token
2036
2037
</span>
2038
</a>
2039
2040
</li>
2041
2042
<li class="md-nav__item">
2043
<a href="#video_processor.auth.OAuthManager.get_token" class="md-nav__link">
2044
<span class="md-ellipsis">
2045
2046
get_token
2047
2048
</span>
2049
</a>
2050
2051
</li>
2052
2053
</ul>
2054
</nav>
2055
2056
</li>
2057
2058
<li class="md-nav__item">
2059
<a href="#video_processor.auth.get_auth_config" class="md-nav__link">
2060
<span class="md-ellipsis">
2061
2062
get_auth_config
2063
2064
</span>
2065
</a>
2066
2067
</li>
2068
2069
<li class="md-nav__item">
2070
<a href="#video_processor.auth.get_auth_manager" class="md-nav__link">
2071
<span class="md-ellipsis">
2072
2073
get_auth_manager
2074
2075
</span>
2076
</a>
2077
2078
</li>
2079
2080
</ul>
2081
</nav>
2082
2083
</li>
2084
2085
<li class="md-nav__item">
2086
<a href="#overview" class="md-nav__link">
2087
<span class="md-ellipsis">
2088
2089
Overview
2090
2091
</span>
2092
</a>
2093
2094
</li>
2095
2096
<li class="md-nav__item">
2097
<a href="#authconfig" class="md-nav__link">
2098
<span class="md-ellipsis">
2099
2100
AuthConfig
2101
2102
</span>
2103
</a>
2104
2105
<nav class="md-nav" aria-label="AuthConfig">
2106
<ul class="md-nav__list">
2107
2108
<li class="md-nav__item">
2109
<a href="#fields" class="md-nav__link">
2110
<span class="md-ellipsis">
2111
2112
Fields
2113
2114
</span>
2115
</a>
2116
2117
</li>
2118
2119
<li class="md-nav__item">
2120
<a href="#resolved-properties" class="md-nav__link">
2121
<span class="md-ellipsis">
2122
2123
Resolved Properties
2124
2125
</span>
2126
</a>
2127
2128
</li>
2129
2130
</ul>
2131
</nav>
2132
2133
</li>
2134
2135
<li class="md-nav__item">
2136
<a href="#authresult" class="md-nav__link">
2137
<span class="md-ellipsis">
2138
2139
AuthResult
2140
2141
</span>
2142
</a>
2143
2144
</li>
2145
2146
<li class="md-nav__item">
2147
<a href="#oauthmanager" class="md-nav__link">
2148
<span class="md-ellipsis">
2149
2150
OAuthManager
2151
2152
</span>
2153
</a>
2154
2155
<nav class="md-nav" aria-label="OAuthManager">
2156
<ul class="md-nav__list">
2157
2158
<li class="md-nav__item">
2159
<a href="#constructor" class="md-nav__link">
2160
<span class="md-ellipsis">
2161
2162
Constructor
2163
2164
</span>
2165
</a>
2166
2167
</li>
2168
2169
<li class="md-nav__item">
2170
<a href="#authenticate" class="md-nav__link">
2171
<span class="md-ellipsis">
2172
2173
authenticate()
2174
2175
</span>
2176
</a>
2177
2178
</li>
2179
2180
<li class="md-nav__item">
2181
<a href="#get_token" class="md-nav__link">
2182
<span class="md-ellipsis">
2183
2184
get_token()
2185
2186
</span>
2187
</a>
2188
2189
</li>
2190
2191
<li class="md-nav__item">
2192
<a href="#clear_token" class="md-nav__link">
2193
<span class="md-ellipsis">
2194
2195
clear_token()
2196
2197
</span>
2198
</a>
2199
2200
</li>
2201
2202
</ul>
2203
</nav>
2204
2205
</li>
2206
2207
<li class="md-nav__item">
2208
<a href="#authentication-flows" class="md-nav__link">
2209
<span class="md-ellipsis">
2210
2211
Authentication Flows
2212
2213
</span>
2214
</a>
2215
2216
<nav class="md-nav" aria-label="Authentication Flows">
2217
<ul class="md-nav__list">
2218
2219
<li class="md-nav__item">
2220
<a href="#saved-token-auto-refresh" class="md-nav__link">
2221
<span class="md-ellipsis">
2222
2223
Saved Token (auto-refresh)
2224
2225
</span>
2226
</a>
2227
2228
</li>
2229
2230
<li class="md-nav__item">
2231
<a href="#client-credentials-grant" class="md-nav__link">
2232
<span class="md-ellipsis">
2233
2234
Client Credentials Grant
2235
2236
</span>
2237
</a>
2238
2239
</li>
2240
2241
<li class="md-nav__item">
2242
<a href="#oauth-20-authorization-code-with-pkce" class="md-nav__link">
2243
<span class="md-ellipsis">
2244
2245
OAuth 2.0 Authorization Code with PKCE
2246
2247
</span>
2248
</a>
2249
2250
</li>
2251
2252
<li class="md-nav__item">
2253
<a href="#api-key-fallback" class="md-nav__link">
2254
<span class="md-ellipsis">
2255
2256
API Key Fallback
2257
2258
</span>
2259
</a>
2260
2261
</li>
2262
2263
</ul>
2264
</nav>
2265
2266
</li>
2267
2268
<li class="md-nav__item">
2269
<a href="#known_configs" class="md-nav__link">
2270
<span class="md-ellipsis">
2271
2272
KNOWN_CONFIGS
2273
2274
</span>
2275
</a>
2276
2277
<nav class="md-nav" aria-label="KNOWN_CONFIGS">
2278
<ul class="md-nav__list">
2279
2280
<li class="md-nav__item">
2281
<a href="#zoom" class="md-nav__link">
2282
<span class="md-ellipsis">
2283
2284
Zoom
2285
2286
</span>
2287
</a>
2288
2289
</li>
2290
2291
<li class="md-nav__item">
2292
<a href="#google-drive-meet-workspace" class="md-nav__link">
2293
<span class="md-ellipsis">
2294
2295
Google (Drive, Meet, Workspace)
2296
2297
</span>
2298
</a>
2299
2300
</li>
2301
2302
<li class="md-nav__item">
2303
<a href="#github" class="md-nav__link">
2304
<span class="md-ellipsis">
2305
2306
GitHub
2307
2308
</span>
2309
</a>
2310
2311
</li>
2312
2313
</ul>
2314
</nav>
2315
2316
</li>
2317
2318
<li class="md-nav__item">
2319
<a href="#helper-functions" class="md-nav__link">
2320
<span class="md-ellipsis">
2321
2322
Helper Functions
2323
2324
</span>
2325
</a>
2326
2327
<nav class="md-nav" aria-label="Helper Functions">
2328
<ul class="md-nav__list">
2329
2330
<li class="md-nav__item">
2331
<a href="#get_auth_config" class="md-nav__link">
2332
<span class="md-ellipsis">
2333
2334
get_auth_config()
2335
2336
</span>
2337
</a>
2338
2339
</li>
2340
2341
<li class="md-nav__item">
2342
<a href="#get_auth_manager" class="md-nav__link">
2343
<span class="md-ellipsis">
2344
2345
get_auth_manager()
2346
2347
</span>
2348
</a>
2349
2350
</li>
2351
2352
</ul>
2353
</nav>
2354
2355
</li>
2356
2357
<li class="md-nav__item">
2358
<a href="#usage-examples" class="md-nav__link">
2359
<span class="md-ellipsis">
2360
2361
Usage Examples
2362
2363
</span>
2364
</a>
2365
2366
<nav class="md-nav" aria-label="Usage Examples">
2367
<ul class="md-nav__list">
2368
2369
<li class="md-nav__item">
2370
<a href="#quick-authentication-for-a-known-service" class="md-nav__link">
2371
<span class="md-ellipsis">
2372
2373
Quick authentication for a known service
2374
2375
</span>
2376
</a>
2377
2378
</li>
2379
2380
<li class="md-nav__item">
2381
<a href="#custom-service-configuration" class="md-nav__link">
2382
<span class="md-ellipsis">
2383
2384
Custom service configuration
2385
2386
</span>
2387
</a>
2388
2389
</li>
2390
2391
<li class="md-nav__item">
2392
<a href="#using-auth-in-a-custom-source-connector" class="md-nav__link">
2393
<span class="md-ellipsis">
2394
2395
Using auth in a custom source connector
2396
2397
</span>
2398
</a>
2399
2400
</li>
2401
2402
<li class="md-nav__item">
2403
<a href="#logout-clear-saved-token" class="md-nav__link">
2404
<span class="md-ellipsis">
2405
2406
Logout / clear saved token
2407
2408
</span>
2409
</a>
2410
2411
</li>
2412
2413
<li class="md-nav__item">
2414
<a href="#token-storage-location" class="md-nav__link">
2415
<span class="md-ellipsis">
2416
2417
Token storage location
2418
2419
</span>
2420
</a>
2421
2422
</li>
2423
2424
</ul>
2425
</nav>
2426
2427
</li>
2428
2429
</ul>
2430
2431
</nav>
2432
</div>
2433
</div>
2434
</div>
2435
2436
2437
2438
<div class="md-content" data-md-component="content">
2439
2440
<article class="md-content__inner md-typeset">
2441
2442
2443
2444
2445
2446
2447
2448
2449
<h1 id="auth-api-reference">Auth API Reference<a class="headerlink" href="#auth-api-reference" title="Permanent link">&para;</a></h1>
2450
2451
2452
<div class="doc doc-object doc-module">
2453
2454
2455
2456
<h2 id="video_processor.auth" class="doc doc-heading">
2457
<code>video_processor.auth</code>
2458
2459
2460
<a href="#video_processor.auth" class="headerlink" title="Permanent link">&para;</a></h2>
2461
2462
<div class="doc doc-contents first">
2463
2464
<p>Unified OAuth and authentication strategy for PlanOpticon connectors.</p>
2465
<p>Provides a consistent auth pattern across all source connectors:
2466
1. Saved token (auto-refresh if expired)
2467
2. OAuth 2.0 (Authorization Code with PKCE, or Client Credentials)
2468
3. API key fallback (environment variable)</p>
2469
<p>Usage in a connector:</p>
2470
<div class="highlight"><pre><span></span><code>from video_processor.auth import OAuthManager, AuthConfig
2471
2472
config = AuthConfig(
2473
service=&quot;notion&quot;,
2474
oauth_authorize_url=&quot;https://api.notion.com/v1/oauth/authorize&quot;,
2475
oauth_token_url=&quot;https://api.notion.com/v1/oauth/token&quot;,
2476
client_id_env=&quot;NOTION_CLIENT_ID&quot;,
2477
client_secret_env=&quot;NOTION_CLIENT_SECRET&quot;,
2478
api_key_env=&quot;NOTION_API_KEY&quot;,
2479
scopes=[&quot;read_content&quot;],
2480
)
2481
manager = OAuthManager(config)
2482
token = manager.authenticate() # Returns access token or None
2483
</code></pre></div>
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
<div class="doc doc-children">
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
<div class="doc doc-object doc-class">
2505
2506
2507
2508
<h3 id="video_processor.auth.AuthConfig" class="doc doc-heading">
2509
<code>AuthConfig</code>
2510
2511
2512
<span class="doc doc-labels">
2513
<small class="doc doc-label doc-label-dataclass"><code>dataclass</code></small>
2514
</span>
2515
2516
<a href="#video_processor.auth.AuthConfig" class="headerlink" title="Permanent link">&para;</a></h3>
2517
2518
2519
<div class="doc doc-contents ">
2520
2521
2522
2523
<p>Configuration for a service's authentication.</p>
2524
2525
2526
2527
2528
2529
2530
2531
2532
<details class="mkdocstrings-source">
2533
<summary>Source code in <code>video_processor/auth.py</code></summary>
2534
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-42"> 42</a></span>
2535
<span class="normal"><a href="#__codelineno-0-43"> 43</a></span>
2536
<span class="normal"><a href="#__codelineno-0-44"> 44</a></span>
2537
<span class="normal"><a href="#__codelineno-0-45"> 45</a></span>
2538
<span class="normal"><a href="#__codelineno-0-46"> 46</a></span>
2539
<span class="normal"><a href="#__codelineno-0-47"> 47</a></span>
2540
<span class="normal"><a href="#__codelineno-0-48"> 48</a></span>
2541
<span class="normal"><a href="#__codelineno-0-49"> 49</a></span>
2542
<span class="normal"><a href="#__codelineno-0-50"> 50</a></span>
2543
<span class="normal"><a href="#__codelineno-0-51"> 51</a></span>
2544
<span class="normal"><a href="#__codelineno-0-52"> 52</a></span>
2545
<span class="normal"><a href="#__codelineno-0-53"> 53</a></span>
2546
<span class="normal"><a href="#__codelineno-0-54"> 54</a></span>
2547
<span class="normal"><a href="#__codelineno-0-55"> 55</a></span>
2548
<span class="normal"><a href="#__codelineno-0-56"> 56</a></span>
2549
<span class="normal"><a href="#__codelineno-0-57"> 57</a></span>
2550
<span class="normal"><a href="#__codelineno-0-58"> 58</a></span>
2551
<span class="normal"><a href="#__codelineno-0-59"> 59</a></span>
2552
<span class="normal"><a href="#__codelineno-0-60"> 60</a></span>
2553
<span class="normal"><a href="#__codelineno-0-61"> 61</a></span>
2554
<span class="normal"><a href="#__codelineno-0-62"> 62</a></span>
2555
<span class="normal"><a href="#__codelineno-0-63"> 63</a></span>
2556
<span class="normal"><a href="#__codelineno-0-64"> 64</a></span>
2557
<span class="normal"><a href="#__codelineno-0-65"> 65</a></span>
2558
<span class="normal"><a href="#__codelineno-0-66"> 66</a></span>
2559
<span class="normal"><a href="#__codelineno-0-67"> 67</a></span>
2560
<span class="normal"><a href="#__codelineno-0-68"> 68</a></span>
2561
<span class="normal"><a href="#__codelineno-0-69"> 69</a></span>
2562
<span class="normal"><a href="#__codelineno-0-70"> 70</a></span>
2563
<span class="normal"><a href="#__codelineno-0-71"> 71</a></span>
2564
<span class="normal"><a href="#__codelineno-0-72"> 72</a></span>
2565
<span class="normal"><a href="#__codelineno-0-73"> 73</a></span>
2566
<span class="normal"><a href="#__codelineno-0-74"> 74</a></span>
2567
<span class="normal"><a href="#__codelineno-0-75"> 75</a></span>
2568
<span class="normal"><a href="#__codelineno-0-76"> 76</a></span>
2569
<span class="normal"><a href="#__codelineno-0-77"> 77</a></span>
2570
<span class="normal"><a href="#__codelineno-0-78"> 78</a></span>
2571
<span class="normal"><a href="#__codelineno-0-79"> 79</a></span>
2572
<span class="normal"><a href="#__codelineno-0-80"> 80</a></span>
2573
<span class="normal"><a href="#__codelineno-0-81"> 81</a></span>
2574
<span class="normal"><a href="#__codelineno-0-82"> 82</a></span>
2575
<span class="normal"><a href="#__codelineno-0-83"> 83</a></span>
2576
<span class="normal"><a href="#__codelineno-0-84"> 84</a></span>
2577
<span class="normal"><a href="#__codelineno-0-85"> 85</a></span>
2578
<span class="normal"><a href="#__codelineno-0-86"> 86</a></span>
2579
<span class="normal"><a href="#__codelineno-0-87"> 87</a></span>
2580
<span class="normal"><a href="#__codelineno-0-88"> 88</a></span>
2581
<span class="normal"><a href="#__codelineno-0-89"> 89</a></span>
2582
<span class="normal"><a href="#__codelineno-0-90"> 90</a></span>
2583
<span class="normal"><a href="#__codelineno-0-91"> 91</a></span>
2584
<span class="normal"><a href="#__codelineno-0-92"> 92</a></span>
2585
<span class="normal"><a href="#__codelineno-0-93"> 93</a></span>
2586
<span class="normal"><a href="#__codelineno-0-94"> 94</a></span>
2587
<span class="normal"><a href="#__codelineno-0-95"> 95</a></span>
2588
<span class="normal"><a href="#__codelineno-0-96"> 96</a></span>
2589
<span class="normal"><a href="#__codelineno-0-97"> 97</a></span>
2590
<span class="normal"><a href="#__codelineno-0-98"> 98</a></span>
2591
<span class="normal"><a href="#__codelineno-0-99"> 99</a></span>
2592
<span class="normal"><a href="#__codelineno-0-100">100</a></span>
2593
<span class="normal"><a href="#__codelineno-0-101">101</a></span>
2594
<span class="normal"><a href="#__codelineno-0-102">102</a></span>
2595
<span class="normal"><a href="#__codelineno-0-103">103</a></span>
2596
<span class="normal"><a href="#__codelineno-0-104">104</a></span>
2597
<span class="normal"><a href="#__codelineno-0-105">105</a></span>
2598
<span class="normal"><a href="#__codelineno-0-106">106</a></span>
2599
<span class="normal"><a href="#__codelineno-0-107">107</a></span>
2600
<span class="normal"><a href="#__codelineno-0-108">108</a></span>
2601
<span class="normal"><a href="#__codelineno-0-109">109</a></span>
2602
<span class="normal"><a href="#__codelineno-0-110">110</a></span>
2603
<span class="normal"><a href="#__codelineno-0-111">111</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-42" name="__codelineno-0-42"></a><span class="nd">@dataclass</span>
2604
<a id="__codelineno-0-43" name="__codelineno-0-43"></a><span class="k">class</span><span class="w"> </span><span class="nc">AuthConfig</span><span class="p">:</span>
2605
<a id="__codelineno-0-44" name="__codelineno-0-44"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Configuration for a service&#39;s authentication.&quot;&quot;&quot;</span>
2606
<a id="__codelineno-0-45" name="__codelineno-0-45"></a>
2607
<a id="__codelineno-0-46" name="__codelineno-0-46"></a> <span class="n">service</span><span class="p">:</span> <span class="nb">str</span>
2608
<a id="__codelineno-0-47" name="__codelineno-0-47"></a>
2609
<a id="__codelineno-0-48" name="__codelineno-0-48"></a> <span class="c1"># OAuth endpoints (set both for OAuth support)</span>
2610
<a id="__codelineno-0-49" name="__codelineno-0-49"></a> <span class="n">oauth_authorize_url</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
2611
<a id="__codelineno-0-50" name="__codelineno-0-50"></a> <span class="n">oauth_token_url</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
2612
<a id="__codelineno-0-51" name="__codelineno-0-51"></a>
2613
<a id="__codelineno-0-52" name="__codelineno-0-52"></a> <span class="c1"># Client credentials (checked from env if not provided)</span>
2614
<a id="__codelineno-0-53" name="__codelineno-0-53"></a> <span class="n">client_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
2615
<a id="__codelineno-0-54" name="__codelineno-0-54"></a> <span class="n">client_secret</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
2616
<a id="__codelineno-0-55" name="__codelineno-0-55"></a> <span class="n">client_id_env</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
2617
<a id="__codelineno-0-56" name="__codelineno-0-56"></a> <span class="n">client_secret_env</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
2618
<a id="__codelineno-0-57" name="__codelineno-0-57"></a>
2619
<a id="__codelineno-0-58" name="__codelineno-0-58"></a> <span class="c1"># API key fallback</span>
2620
<a id="__codelineno-0-59" name="__codelineno-0-59"></a> <span class="n">api_key_env</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
2621
<a id="__codelineno-0-60" name="__codelineno-0-60"></a>
2622
<a id="__codelineno-0-61" name="__codelineno-0-61"></a> <span class="c1"># OAuth scopes</span>
2623
<a id="__codelineno-0-62" name="__codelineno-0-62"></a> <span class="n">scopes</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">list</span><span class="p">)</span>
2624
<a id="__codelineno-0-63" name="__codelineno-0-63"></a>
2625
<a id="__codelineno-0-64" name="__codelineno-0-64"></a> <span class="c1"># Redirect URI for auth code flow</span>
2626
<a id="__codelineno-0-65" name="__codelineno-0-65"></a> <span class="n">redirect_uri</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;urn:ietf:wg:oauth:2.0:oob&quot;</span>
2627
<a id="__codelineno-0-66" name="__codelineno-0-66"></a>
2628
<a id="__codelineno-0-67" name="__codelineno-0-67"></a> <span class="c1"># Server-to-Server (client credentials grant)</span>
2629
<a id="__codelineno-0-68" name="__codelineno-0-68"></a> <span class="n">account_id</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
2630
<a id="__codelineno-0-69" name="__codelineno-0-69"></a> <span class="n">account_id_env</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
2631
<a id="__codelineno-0-70" name="__codelineno-0-70"></a>
2632
<a id="__codelineno-0-71" name="__codelineno-0-71"></a> <span class="c1"># Token storage</span>
2633
<a id="__codelineno-0-72" name="__codelineno-0-72"></a> <span class="n">token_path</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Path</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
2634
<a id="__codelineno-0-73" name="__codelineno-0-73"></a>
2635
<a id="__codelineno-0-74" name="__codelineno-0-74"></a> <span class="nd">@property</span>
2636
<a id="__codelineno-0-75" name="__codelineno-0-75"></a> <span class="k">def</span><span class="w"> </span><span class="nf">resolved_client_id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
2637
<a id="__codelineno-0-76" name="__codelineno-0-76"></a> <span class="k">return</span> <span class="p">(</span>
2638
<a id="__codelineno-0-77" name="__codelineno-0-77"></a> <span class="bp">self</span><span class="o">.</span><span class="n">client_id</span>
2639
<a id="__codelineno-0-78" name="__codelineno-0-78"></a> <span class="ow">or</span> <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">client_id_env</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">client_id_env</span> <span class="k">else</span> <span class="kc">None</span><span class="p">)</span>
2640
<a id="__codelineno-0-79" name="__codelineno-0-79"></a> <span class="ow">or</span> <span class="kc">None</span>
2641
<a id="__codelineno-0-80" name="__codelineno-0-80"></a> <span class="p">)</span>
2642
<a id="__codelineno-0-81" name="__codelineno-0-81"></a>
2643
<a id="__codelineno-0-82" name="__codelineno-0-82"></a> <span class="nd">@property</span>
2644
<a id="__codelineno-0-83" name="__codelineno-0-83"></a> <span class="k">def</span><span class="w"> </span><span class="nf">resolved_client_secret</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
2645
<a id="__codelineno-0-84" name="__codelineno-0-84"></a> <span class="k">return</span> <span class="p">(</span>
2646
<a id="__codelineno-0-85" name="__codelineno-0-85"></a> <span class="bp">self</span><span class="o">.</span><span class="n">client_secret</span>
2647
<a id="__codelineno-0-86" name="__codelineno-0-86"></a> <span class="ow">or</span> <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">client_secret_env</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">client_secret_env</span> <span class="k">else</span> <span class="kc">None</span><span class="p">)</span>
2648
<a id="__codelineno-0-87" name="__codelineno-0-87"></a> <span class="ow">or</span> <span class="kc">None</span>
2649
<a id="__codelineno-0-88" name="__codelineno-0-88"></a> <span class="p">)</span>
2650
<a id="__codelineno-0-89" name="__codelineno-0-89"></a>
2651
<a id="__codelineno-0-90" name="__codelineno-0-90"></a> <span class="nd">@property</span>
2652
<a id="__codelineno-0-91" name="__codelineno-0-91"></a> <span class="k">def</span><span class="w"> </span><span class="nf">resolved_api_key</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
2653
<a id="__codelineno-0-92" name="__codelineno-0-92"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">api_key_env</span><span class="p">:</span>
2654
<a id="__codelineno-0-93" name="__codelineno-0-93"></a> <span class="n">val</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">api_key_env</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span>
2655
<a id="__codelineno-0-94" name="__codelineno-0-94"></a> <span class="k">return</span> <span class="n">val</span> <span class="k">if</span> <span class="n">val</span> <span class="k">else</span> <span class="kc">None</span>
2656
<a id="__codelineno-0-95" name="__codelineno-0-95"></a> <span class="k">return</span> <span class="kc">None</span>
2657
<a id="__codelineno-0-96" name="__codelineno-0-96"></a>
2658
<a id="__codelineno-0-97" name="__codelineno-0-97"></a> <span class="nd">@property</span>
2659
<a id="__codelineno-0-98" name="__codelineno-0-98"></a> <span class="k">def</span><span class="w"> </span><span class="nf">resolved_account_id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
2660
<a id="__codelineno-0-99" name="__codelineno-0-99"></a> <span class="k">return</span> <span class="p">(</span>
2661
<a id="__codelineno-0-100" name="__codelineno-0-100"></a> <span class="bp">self</span><span class="o">.</span><span class="n">account_id</span>
2662
<a id="__codelineno-0-101" name="__codelineno-0-101"></a> <span class="ow">or</span> <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">account_id_env</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">account_id_env</span> <span class="k">else</span> <span class="kc">None</span><span class="p">)</span>
2663
<a id="__codelineno-0-102" name="__codelineno-0-102"></a> <span class="ow">or</span> <span class="kc">None</span>
2664
<a id="__codelineno-0-103" name="__codelineno-0-103"></a> <span class="p">)</span>
2665
<a id="__codelineno-0-104" name="__codelineno-0-104"></a>
2666
<a id="__codelineno-0-105" name="__codelineno-0-105"></a> <span class="nd">@property</span>
2667
<a id="__codelineno-0-106" name="__codelineno-0-106"></a> <span class="k">def</span><span class="w"> </span><span class="nf">resolved_token_path</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Path</span><span class="p">:</span>
2668
<a id="__codelineno-0-107" name="__codelineno-0-107"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">token_path</span> <span class="ow">or</span> <span class="n">TOKEN_DIR</span> <span class="o">/</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="si">}</span><span class="s2">_token.json&quot;</span>
2669
<a id="__codelineno-0-108" name="__codelineno-0-108"></a>
2670
<a id="__codelineno-0-109" name="__codelineno-0-109"></a> <span class="nd">@property</span>
2671
<a id="__codelineno-0-110" name="__codelineno-0-110"></a> <span class="k">def</span><span class="w"> </span><span class="nf">supports_oauth</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
2672
<a id="__codelineno-0-111" name="__codelineno-0-111"></a> <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">oauth_authorize_url</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">oauth_token_url</span><span class="p">)</span>
2673
</code></pre></div></td></tr></table></div>
2674
</details>
2675
2676
2677
2678
<div class="doc doc-children">
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
</div>
2692
2693
</div>
2694
2695
</div>
2696
2697
<div class="doc doc-object doc-class">
2698
2699
2700
2701
<h3 id="video_processor.auth.AuthResult" class="doc doc-heading">
2702
<code>AuthResult</code>
2703
2704
2705
<span class="doc doc-labels">
2706
<small class="doc doc-label doc-label-dataclass"><code>dataclass</code></small>
2707
</span>
2708
2709
<a href="#video_processor.auth.AuthResult" class="headerlink" title="Permanent link">&para;</a></h3>
2710
2711
2712
<div class="doc doc-contents ">
2713
2714
2715
2716
<p>Result of an authentication attempt.</p>
2717
2718
2719
2720
2721
2722
2723
2724
2725
<details class="mkdocstrings-source">
2726
<summary>Source code in <code>video_processor/auth.py</code></summary>
2727
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-114">114</a></span>
2728
<span class="normal"><a href="#__codelineno-0-115">115</a></span>
2729
<span class="normal"><a href="#__codelineno-0-116">116</a></span>
2730
<span class="normal"><a href="#__codelineno-0-117">117</a></span>
2731
<span class="normal"><a href="#__codelineno-0-118">118</a></span>
2732
<span class="normal"><a href="#__codelineno-0-119">119</a></span>
2733
<span class="normal"><a href="#__codelineno-0-120">120</a></span>
2734
<span class="normal"><a href="#__codelineno-0-121">121</a></span>
2735
<span class="normal"><a href="#__codelineno-0-122">122</a></span>
2736
<span class="normal"><a href="#__codelineno-0-123">123</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-114" name="__codelineno-0-114"></a><span class="nd">@dataclass</span>
2737
<a id="__codelineno-0-115" name="__codelineno-0-115"></a><span class="k">class</span><span class="w"> </span><span class="nc">AuthResult</span><span class="p">:</span>
2738
<a id="__codelineno-0-116" name="__codelineno-0-116"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Result of an authentication attempt.&quot;&quot;&quot;</span>
2739
<a id="__codelineno-0-117" name="__codelineno-0-117"></a>
2740
<a id="__codelineno-0-118" name="__codelineno-0-118"></a> <span class="n">success</span><span class="p">:</span> <span class="nb">bool</span>
2741
<a id="__codelineno-0-119" name="__codelineno-0-119"></a> <span class="n">access_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
2742
<a id="__codelineno-0-120" name="__codelineno-0-120"></a> <span class="n">method</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># &quot;saved_token&quot;, &quot;oauth_pkce&quot;, &quot;client_credentials&quot;, &quot;api_key&quot;</span>
2743
<a id="__codelineno-0-121" name="__codelineno-0-121"></a> <span class="n">expires_at</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
2744
<a id="__codelineno-0-122" name="__codelineno-0-122"></a> <span class="n">refresh_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
2745
<a id="__codelineno-0-123" name="__codelineno-0-123"></a> <span class="n">error</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
2746
</code></pre></div></td></tr></table></div>
2747
</details>
2748
2749
2750
2751
<div class="doc doc-children">
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
</div>
2765
2766
</div>
2767
2768
</div>
2769
2770
<div class="doc doc-object doc-class">
2771
2772
2773
2774
<h3 id="video_processor.auth.OAuthManager" class="doc doc-heading">
2775
<code>OAuthManager</code>
2776
2777
2778
<a href="#video_processor.auth.OAuthManager" class="headerlink" title="Permanent link">&para;</a></h3>
2779
2780
2781
<div class="doc doc-contents ">
2782
2783
2784
2785
<p>Manages OAuth and API key authentication for a service.</p>
2786
<p>Tries auth methods in order:
2787
1. Load saved token (refresh if expired)
2788
2. Client Credentials grant (if account_id is set)
2789
3. OAuth2 Authorization Code with PKCE (interactive)
2790
4. API key fallback</p>
2791
2792
2793
2794
2795
2796
2797
2798
2799
<details class="mkdocstrings-source">
2800
<summary>Source code in <code>video_processor/auth.py</code></summary>
2801
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-126">126</a></span>
2802
<span class="normal"><a href="#__codelineno-0-127">127</a></span>
2803
<span class="normal"><a href="#__codelineno-0-128">128</a></span>
2804
<span class="normal"><a href="#__codelineno-0-129">129</a></span>
2805
<span class="normal"><a href="#__codelineno-0-130">130</a></span>
2806
<span class="normal"><a href="#__codelineno-0-131">131</a></span>
2807
<span class="normal"><a href="#__codelineno-0-132">132</a></span>
2808
<span class="normal"><a href="#__codelineno-0-133">133</a></span>
2809
<span class="normal"><a href="#__codelineno-0-134">134</a></span>
2810
<span class="normal"><a href="#__codelineno-0-135">135</a></span>
2811
<span class="normal"><a href="#__codelineno-0-136">136</a></span>
2812
<span class="normal"><a href="#__codelineno-0-137">137</a></span>
2813
<span class="normal"><a href="#__codelineno-0-138">138</a></span>
2814
<span class="normal"><a href="#__codelineno-0-139">139</a></span>
2815
<span class="normal"><a href="#__codelineno-0-140">140</a></span>
2816
<span class="normal"><a href="#__codelineno-0-141">141</a></span>
2817
<span class="normal"><a href="#__codelineno-0-142">142</a></span>
2818
<span class="normal"><a href="#__codelineno-0-143">143</a></span>
2819
<span class="normal"><a href="#__codelineno-0-144">144</a></span>
2820
<span class="normal"><a href="#__codelineno-0-145">145</a></span>
2821
<span class="normal"><a href="#__codelineno-0-146">146</a></span>
2822
<span class="normal"><a href="#__codelineno-0-147">147</a></span>
2823
<span class="normal"><a href="#__codelineno-0-148">148</a></span>
2824
<span class="normal"><a href="#__codelineno-0-149">149</a></span>
2825
<span class="normal"><a href="#__codelineno-0-150">150</a></span>
2826
<span class="normal"><a href="#__codelineno-0-151">151</a></span>
2827
<span class="normal"><a href="#__codelineno-0-152">152</a></span>
2828
<span class="normal"><a href="#__codelineno-0-153">153</a></span>
2829
<span class="normal"><a href="#__codelineno-0-154">154</a></span>
2830
<span class="normal"><a href="#__codelineno-0-155">155</a></span>
2831
<span class="normal"><a href="#__codelineno-0-156">156</a></span>
2832
<span class="normal"><a href="#__codelineno-0-157">157</a></span>
2833
<span class="normal"><a href="#__codelineno-0-158">158</a></span>
2834
<span class="normal"><a href="#__codelineno-0-159">159</a></span>
2835
<span class="normal"><a href="#__codelineno-0-160">160</a></span>
2836
<span class="normal"><a href="#__codelineno-0-161">161</a></span>
2837
<span class="normal"><a href="#__codelineno-0-162">162</a></span>
2838
<span class="normal"><a href="#__codelineno-0-163">163</a></span>
2839
<span class="normal"><a href="#__codelineno-0-164">164</a></span>
2840
<span class="normal"><a href="#__codelineno-0-165">165</a></span>
2841
<span class="normal"><a href="#__codelineno-0-166">166</a></span>
2842
<span class="normal"><a href="#__codelineno-0-167">167</a></span>
2843
<span class="normal"><a href="#__codelineno-0-168">168</a></span>
2844
<span class="normal"><a href="#__codelineno-0-169">169</a></span>
2845
<span class="normal"><a href="#__codelineno-0-170">170</a></span>
2846
<span class="normal"><a href="#__codelineno-0-171">171</a></span>
2847
<span class="normal"><a href="#__codelineno-0-172">172</a></span>
2848
<span class="normal"><a href="#__codelineno-0-173">173</a></span>
2849
<span class="normal"><a href="#__codelineno-0-174">174</a></span>
2850
<span class="normal"><a href="#__codelineno-0-175">175</a></span>
2851
<span class="normal"><a href="#__codelineno-0-176">176</a></span>
2852
<span class="normal"><a href="#__codelineno-0-177">177</a></span>
2853
<span class="normal"><a href="#__codelineno-0-178">178</a></span>
2854
<span class="normal"><a href="#__codelineno-0-179">179</a></span>
2855
<span class="normal"><a href="#__codelineno-0-180">180</a></span>
2856
<span class="normal"><a href="#__codelineno-0-181">181</a></span>
2857
<span class="normal"><a href="#__codelineno-0-182">182</a></span>
2858
<span class="normal"><a href="#__codelineno-0-183">183</a></span>
2859
<span class="normal"><a href="#__codelineno-0-184">184</a></span>
2860
<span class="normal"><a href="#__codelineno-0-185">185</a></span>
2861
<span class="normal"><a href="#__codelineno-0-186">186</a></span>
2862
<span class="normal"><a href="#__codelineno-0-187">187</a></span>
2863
<span class="normal"><a href="#__codelineno-0-188">188</a></span>
2864
<span class="normal"><a href="#__codelineno-0-189">189</a></span>
2865
<span class="normal"><a href="#__codelineno-0-190">190</a></span>
2866
<span class="normal"><a href="#__codelineno-0-191">191</a></span>
2867
<span class="normal"><a href="#__codelineno-0-192">192</a></span>
2868
<span class="normal"><a href="#__codelineno-0-193">193</a></span>
2869
<span class="normal"><a href="#__codelineno-0-194">194</a></span>
2870
<span class="normal"><a href="#__codelineno-0-195">195</a></span>
2871
<span class="normal"><a href="#__codelineno-0-196">196</a></span>
2872
<span class="normal"><a href="#__codelineno-0-197">197</a></span>
2873
<span class="normal"><a href="#__codelineno-0-198">198</a></span>
2874
<span class="normal"><a href="#__codelineno-0-199">199</a></span>
2875
<span class="normal"><a href="#__codelineno-0-200">200</a></span>
2876
<span class="normal"><a href="#__codelineno-0-201">201</a></span>
2877
<span class="normal"><a href="#__codelineno-0-202">202</a></span>
2878
<span class="normal"><a href="#__codelineno-0-203">203</a></span>
2879
<span class="normal"><a href="#__codelineno-0-204">204</a></span>
2880
<span class="normal"><a href="#__codelineno-0-205">205</a></span>
2881
<span class="normal"><a href="#__codelineno-0-206">206</a></span>
2882
<span class="normal"><a href="#__codelineno-0-207">207</a></span>
2883
<span class="normal"><a href="#__codelineno-0-208">208</a></span>
2884
<span class="normal"><a href="#__codelineno-0-209">209</a></span>
2885
<span class="normal"><a href="#__codelineno-0-210">210</a></span>
2886
<span class="normal"><a href="#__codelineno-0-211">211</a></span>
2887
<span class="normal"><a href="#__codelineno-0-212">212</a></span>
2888
<span class="normal"><a href="#__codelineno-0-213">213</a></span>
2889
<span class="normal"><a href="#__codelineno-0-214">214</a></span>
2890
<span class="normal"><a href="#__codelineno-0-215">215</a></span>
2891
<span class="normal"><a href="#__codelineno-0-216">216</a></span>
2892
<span class="normal"><a href="#__codelineno-0-217">217</a></span>
2893
<span class="normal"><a href="#__codelineno-0-218">218</a></span>
2894
<span class="normal"><a href="#__codelineno-0-219">219</a></span>
2895
<span class="normal"><a href="#__codelineno-0-220">220</a></span>
2896
<span class="normal"><a href="#__codelineno-0-221">221</a></span>
2897
<span class="normal"><a href="#__codelineno-0-222">222</a></span>
2898
<span class="normal"><a href="#__codelineno-0-223">223</a></span>
2899
<span class="normal"><a href="#__codelineno-0-224">224</a></span>
2900
<span class="normal"><a href="#__codelineno-0-225">225</a></span>
2901
<span class="normal"><a href="#__codelineno-0-226">226</a></span>
2902
<span class="normal"><a href="#__codelineno-0-227">227</a></span>
2903
<span class="normal"><a href="#__codelineno-0-228">228</a></span>
2904
<span class="normal"><a href="#__codelineno-0-229">229</a></span>
2905
<span class="normal"><a href="#__codelineno-0-230">230</a></span>
2906
<span class="normal"><a href="#__codelineno-0-231">231</a></span>
2907
<span class="normal"><a href="#__codelineno-0-232">232</a></span>
2908
<span class="normal"><a href="#__codelineno-0-233">233</a></span>
2909
<span class="normal"><a href="#__codelineno-0-234">234</a></span>
2910
<span class="normal"><a href="#__codelineno-0-235">235</a></span>
2911
<span class="normal"><a href="#__codelineno-0-236">236</a></span>
2912
<span class="normal"><a href="#__codelineno-0-237">237</a></span>
2913
<span class="normal"><a href="#__codelineno-0-238">238</a></span>
2914
<span class="normal"><a href="#__codelineno-0-239">239</a></span>
2915
<span class="normal"><a href="#__codelineno-0-240">240</a></span>
2916
<span class="normal"><a href="#__codelineno-0-241">241</a></span>
2917
<span class="normal"><a href="#__codelineno-0-242">242</a></span>
2918
<span class="normal"><a href="#__codelineno-0-243">243</a></span>
2919
<span class="normal"><a href="#__codelineno-0-244">244</a></span>
2920
<span class="normal"><a href="#__codelineno-0-245">245</a></span>
2921
<span class="normal"><a href="#__codelineno-0-246">246</a></span>
2922
<span class="normal"><a href="#__codelineno-0-247">247</a></span>
2923
<span class="normal"><a href="#__codelineno-0-248">248</a></span>
2924
<span class="normal"><a href="#__codelineno-0-249">249</a></span>
2925
<span class="normal"><a href="#__codelineno-0-250">250</a></span>
2926
<span class="normal"><a href="#__codelineno-0-251">251</a></span>
2927
<span class="normal"><a href="#__codelineno-0-252">252</a></span>
2928
<span class="normal"><a href="#__codelineno-0-253">253</a></span>
2929
<span class="normal"><a href="#__codelineno-0-254">254</a></span>
2930
<span class="normal"><a href="#__codelineno-0-255">255</a></span>
2931
<span class="normal"><a href="#__codelineno-0-256">256</a></span>
2932
<span class="normal"><a href="#__codelineno-0-257">257</a></span>
2933
<span class="normal"><a href="#__codelineno-0-258">258</a></span>
2934
<span class="normal"><a href="#__codelineno-0-259">259</a></span>
2935
<span class="normal"><a href="#__codelineno-0-260">260</a></span>
2936
<span class="normal"><a href="#__codelineno-0-261">261</a></span>
2937
<span class="normal"><a href="#__codelineno-0-262">262</a></span>
2938
<span class="normal"><a href="#__codelineno-0-263">263</a></span>
2939
<span class="normal"><a href="#__codelineno-0-264">264</a></span>
2940
<span class="normal"><a href="#__codelineno-0-265">265</a></span>
2941
<span class="normal"><a href="#__codelineno-0-266">266</a></span>
2942
<span class="normal"><a href="#__codelineno-0-267">267</a></span>
2943
<span class="normal"><a href="#__codelineno-0-268">268</a></span>
2944
<span class="normal"><a href="#__codelineno-0-269">269</a></span>
2945
<span class="normal"><a href="#__codelineno-0-270">270</a></span>
2946
<span class="normal"><a href="#__codelineno-0-271">271</a></span>
2947
<span class="normal"><a href="#__codelineno-0-272">272</a></span>
2948
<span class="normal"><a href="#__codelineno-0-273">273</a></span>
2949
<span class="normal"><a href="#__codelineno-0-274">274</a></span>
2950
<span class="normal"><a href="#__codelineno-0-275">275</a></span>
2951
<span class="normal"><a href="#__codelineno-0-276">276</a></span>
2952
<span class="normal"><a href="#__codelineno-0-277">277</a></span>
2953
<span class="normal"><a href="#__codelineno-0-278">278</a></span>
2954
<span class="normal"><a href="#__codelineno-0-279">279</a></span>
2955
<span class="normal"><a href="#__codelineno-0-280">280</a></span>
2956
<span class="normal"><a href="#__codelineno-0-281">281</a></span>
2957
<span class="normal"><a href="#__codelineno-0-282">282</a></span>
2958
<span class="normal"><a href="#__codelineno-0-283">283</a></span>
2959
<span class="normal"><a href="#__codelineno-0-284">284</a></span>
2960
<span class="normal"><a href="#__codelineno-0-285">285</a></span>
2961
<span class="normal"><a href="#__codelineno-0-286">286</a></span>
2962
<span class="normal"><a href="#__codelineno-0-287">287</a></span>
2963
<span class="normal"><a href="#__codelineno-0-288">288</a></span>
2964
<span class="normal"><a href="#__codelineno-0-289">289</a></span>
2965
<span class="normal"><a href="#__codelineno-0-290">290</a></span>
2966
<span class="normal"><a href="#__codelineno-0-291">291</a></span>
2967
<span class="normal"><a href="#__codelineno-0-292">292</a></span>
2968
<span class="normal"><a href="#__codelineno-0-293">293</a></span>
2969
<span class="normal"><a href="#__codelineno-0-294">294</a></span>
2970
<span class="normal"><a href="#__codelineno-0-295">295</a></span>
2971
<span class="normal"><a href="#__codelineno-0-296">296</a></span>
2972
<span class="normal"><a href="#__codelineno-0-297">297</a></span>
2973
<span class="normal"><a href="#__codelineno-0-298">298</a></span>
2974
<span class="normal"><a href="#__codelineno-0-299">299</a></span>
2975
<span class="normal"><a href="#__codelineno-0-300">300</a></span>
2976
<span class="normal"><a href="#__codelineno-0-301">301</a></span>
2977
<span class="normal"><a href="#__codelineno-0-302">302</a></span>
2978
<span class="normal"><a href="#__codelineno-0-303">303</a></span>
2979
<span class="normal"><a href="#__codelineno-0-304">304</a></span>
2980
<span class="normal"><a href="#__codelineno-0-305">305</a></span>
2981
<span class="normal"><a href="#__codelineno-0-306">306</a></span>
2982
<span class="normal"><a href="#__codelineno-0-307">307</a></span>
2983
<span class="normal"><a href="#__codelineno-0-308">308</a></span>
2984
<span class="normal"><a href="#__codelineno-0-309">309</a></span>
2985
<span class="normal"><a href="#__codelineno-0-310">310</a></span>
2986
<span class="normal"><a href="#__codelineno-0-311">311</a></span>
2987
<span class="normal"><a href="#__codelineno-0-312">312</a></span>
2988
<span class="normal"><a href="#__codelineno-0-313">313</a></span>
2989
<span class="normal"><a href="#__codelineno-0-314">314</a></span>
2990
<span class="normal"><a href="#__codelineno-0-315">315</a></span>
2991
<span class="normal"><a href="#__codelineno-0-316">316</a></span>
2992
<span class="normal"><a href="#__codelineno-0-317">317</a></span>
2993
<span class="normal"><a href="#__codelineno-0-318">318</a></span>
2994
<span class="normal"><a href="#__codelineno-0-319">319</a></span>
2995
<span class="normal"><a href="#__codelineno-0-320">320</a></span>
2996
<span class="normal"><a href="#__codelineno-0-321">321</a></span>
2997
<span class="normal"><a href="#__codelineno-0-322">322</a></span>
2998
<span class="normal"><a href="#__codelineno-0-323">323</a></span>
2999
<span class="normal"><a href="#__codelineno-0-324">324</a></span>
3000
<span class="normal"><a href="#__codelineno-0-325">325</a></span>
3001
<span class="normal"><a href="#__codelineno-0-326">326</a></span>
3002
<span class="normal"><a href="#__codelineno-0-327">327</a></span>
3003
<span class="normal"><a href="#__codelineno-0-328">328</a></span>
3004
<span class="normal"><a href="#__codelineno-0-329">329</a></span>
3005
<span class="normal"><a href="#__codelineno-0-330">330</a></span>
3006
<span class="normal"><a href="#__codelineno-0-331">331</a></span>
3007
<span class="normal"><a href="#__codelineno-0-332">332</a></span>
3008
<span class="normal"><a href="#__codelineno-0-333">333</a></span>
3009
<span class="normal"><a href="#__codelineno-0-334">334</a></span>
3010
<span class="normal"><a href="#__codelineno-0-335">335</a></span>
3011
<span class="normal"><a href="#__codelineno-0-336">336</a></span>
3012
<span class="normal"><a href="#__codelineno-0-337">337</a></span>
3013
<span class="normal"><a href="#__codelineno-0-338">338</a></span>
3014
<span class="normal"><a href="#__codelineno-0-339">339</a></span>
3015
<span class="normal"><a href="#__codelineno-0-340">340</a></span>
3016
<span class="normal"><a href="#__codelineno-0-341">341</a></span>
3017
<span class="normal"><a href="#__codelineno-0-342">342</a></span>
3018
<span class="normal"><a href="#__codelineno-0-343">343</a></span>
3019
<span class="normal"><a href="#__codelineno-0-344">344</a></span>
3020
<span class="normal"><a href="#__codelineno-0-345">345</a></span>
3021
<span class="normal"><a href="#__codelineno-0-346">346</a></span>
3022
<span class="normal"><a href="#__codelineno-0-347">347</a></span>
3023
<span class="normal"><a href="#__codelineno-0-348">348</a></span>
3024
<span class="normal"><a href="#__codelineno-0-349">349</a></span>
3025
<span class="normal"><a href="#__codelineno-0-350">350</a></span>
3026
<span class="normal"><a href="#__codelineno-0-351">351</a></span>
3027
<span class="normal"><a href="#__codelineno-0-352">352</a></span>
3028
<span class="normal"><a href="#__codelineno-0-353">353</a></span>
3029
<span class="normal"><a href="#__codelineno-0-354">354</a></span>
3030
<span class="normal"><a href="#__codelineno-0-355">355</a></span>
3031
<span class="normal"><a href="#__codelineno-0-356">356</a></span>
3032
<span class="normal"><a href="#__codelineno-0-357">357</a></span>
3033
<span class="normal"><a href="#__codelineno-0-358">358</a></span>
3034
<span class="normal"><a href="#__codelineno-0-359">359</a></span>
3035
<span class="normal"><a href="#__codelineno-0-360">360</a></span>
3036
<span class="normal"><a href="#__codelineno-0-361">361</a></span>
3037
<span class="normal"><a href="#__codelineno-0-362">362</a></span>
3038
<span class="normal"><a href="#__codelineno-0-363">363</a></span>
3039
<span class="normal"><a href="#__codelineno-0-364">364</a></span>
3040
<span class="normal"><a href="#__codelineno-0-365">365</a></span>
3041
<span class="normal"><a href="#__codelineno-0-366">366</a></span>
3042
<span class="normal"><a href="#__codelineno-0-367">367</a></span>
3043
<span class="normal"><a href="#__codelineno-0-368">368</a></span>
3044
<span class="normal"><a href="#__codelineno-0-369">369</a></span>
3045
<span class="normal"><a href="#__codelineno-0-370">370</a></span>
3046
<span class="normal"><a href="#__codelineno-0-371">371</a></span>
3047
<span class="normal"><a href="#__codelineno-0-372">372</a></span>
3048
<span class="normal"><a href="#__codelineno-0-373">373</a></span>
3049
<span class="normal"><a href="#__codelineno-0-374">374</a></span>
3050
<span class="normal"><a href="#__codelineno-0-375">375</a></span>
3051
<span class="normal"><a href="#__codelineno-0-376">376</a></span>
3052
<span class="normal"><a href="#__codelineno-0-377">377</a></span>
3053
<span class="normal"><a href="#__codelineno-0-378">378</a></span>
3054
<span class="normal"><a href="#__codelineno-0-379">379</a></span>
3055
<span class="normal"><a href="#__codelineno-0-380">380</a></span>
3056
<span class="normal"><a href="#__codelineno-0-381">381</a></span>
3057
<span class="normal"><a href="#__codelineno-0-382">382</a></span>
3058
<span class="normal"><a href="#__codelineno-0-383">383</a></span>
3059
<span class="normal"><a href="#__codelineno-0-384">384</a></span>
3060
<span class="normal"><a href="#__codelineno-0-385">385</a></span>
3061
<span class="normal"><a href="#__codelineno-0-386">386</a></span>
3062
<span class="normal"><a href="#__codelineno-0-387">387</a></span>
3063
<span class="normal"><a href="#__codelineno-0-388">388</a></span>
3064
<span class="normal"><a href="#__codelineno-0-389">389</a></span>
3065
<span class="normal"><a href="#__codelineno-0-390">390</a></span>
3066
<span class="normal"><a href="#__codelineno-0-391">391</a></span>
3067
<span class="normal"><a href="#__codelineno-0-392">392</a></span>
3068
<span class="normal"><a href="#__codelineno-0-393">393</a></span>
3069
<span class="normal"><a href="#__codelineno-0-394">394</a></span>
3070
<span class="normal"><a href="#__codelineno-0-395">395</a></span>
3071
<span class="normal"><a href="#__codelineno-0-396">396</a></span>
3072
<span class="normal"><a href="#__codelineno-0-397">397</a></span>
3073
<span class="normal"><a href="#__codelineno-0-398">398</a></span>
3074
<span class="normal"><a href="#__codelineno-0-399">399</a></span>
3075
<span class="normal"><a href="#__codelineno-0-400">400</a></span>
3076
<span class="normal"><a href="#__codelineno-0-401">401</a></span>
3077
<span class="normal"><a href="#__codelineno-0-402">402</a></span>
3078
<span class="normal"><a href="#__codelineno-0-403">403</a></span>
3079
<span class="normal"><a href="#__codelineno-0-404">404</a></span>
3080
<span class="normal"><a href="#__codelineno-0-405">405</a></span>
3081
<span class="normal"><a href="#__codelineno-0-406">406</a></span>
3082
<span class="normal"><a href="#__codelineno-0-407">407</a></span>
3083
<span class="normal"><a href="#__codelineno-0-408">408</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-126" name="__codelineno-0-126"></a><span class="k">class</span><span class="w"> </span><span class="nc">OAuthManager</span><span class="p">:</span>
3084
<a id="__codelineno-0-127" name="__codelineno-0-127"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Manages OAuth and API key authentication for a service.</span>
3085
<a id="__codelineno-0-128" name="__codelineno-0-128"></a>
3086
<a id="__codelineno-0-129" name="__codelineno-0-129"></a><span class="sd"> Tries auth methods in order:</span>
3087
<a id="__codelineno-0-130" name="__codelineno-0-130"></a><span class="sd"> 1. Load saved token (refresh if expired)</span>
3088
<a id="__codelineno-0-131" name="__codelineno-0-131"></a><span class="sd"> 2. Client Credentials grant (if account_id is set)</span>
3089
<a id="__codelineno-0-132" name="__codelineno-0-132"></a><span class="sd"> 3. OAuth2 Authorization Code with PKCE (interactive)</span>
3090
<a id="__codelineno-0-133" name="__codelineno-0-133"></a><span class="sd"> 4. API key fallback</span>
3091
<a id="__codelineno-0-134" name="__codelineno-0-134"></a><span class="sd"> &quot;&quot;&quot;</span>
3092
<a id="__codelineno-0-135" name="__codelineno-0-135"></a>
3093
<a id="__codelineno-0-136" name="__codelineno-0-136"></a> <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n">AuthConfig</span><span class="p">):</span>
3094
<a id="__codelineno-0-137" name="__codelineno-0-137"></a> <span class="bp">self</span><span class="o">.</span><span class="n">config</span> <span class="o">=</span> <span class="n">config</span>
3095
<a id="__codelineno-0-138" name="__codelineno-0-138"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_token_data</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
3096
<a id="__codelineno-0-139" name="__codelineno-0-139"></a>
3097
<a id="__codelineno-0-140" name="__codelineno-0-140"></a> <span class="k">def</span><span class="w"> </span><span class="nf">authenticate</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AuthResult</span><span class="p">:</span>
3098
<a id="__codelineno-0-141" name="__codelineno-0-141"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Run the auth chain and return the result.&quot;&quot;&quot;</span>
3099
<a id="__codelineno-0-142" name="__codelineno-0-142"></a> <span class="c1"># 1. Saved token</span>
3100
<a id="__codelineno-0-143" name="__codelineno-0-143"></a> <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_try_saved_token</span><span class="p">()</span>
3101
<a id="__codelineno-0-144" name="__codelineno-0-144"></a> <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">success</span><span class="p">:</span>
3102
<a id="__codelineno-0-145" name="__codelineno-0-145"></a> <span class="k">return</span> <span class="n">result</span>
3103
<a id="__codelineno-0-146" name="__codelineno-0-146"></a>
3104
<a id="__codelineno-0-147" name="__codelineno-0-147"></a> <span class="c1"># 2. Client Credentials (Server-to-Server)</span>
3105
<a id="__codelineno-0-148" name="__codelineno-0-148"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_account_id</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">supports_oauth</span><span class="p">:</span>
3106
<a id="__codelineno-0-149" name="__codelineno-0-149"></a> <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_try_client_credentials</span><span class="p">()</span>
3107
<a id="__codelineno-0-150" name="__codelineno-0-150"></a> <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">success</span><span class="p">:</span>
3108
<a id="__codelineno-0-151" name="__codelineno-0-151"></a> <span class="k">return</span> <span class="n">result</span>
3109
<a id="__codelineno-0-152" name="__codelineno-0-152"></a>
3110
<a id="__codelineno-0-153" name="__codelineno-0-153"></a> <span class="c1"># 3. OAuth PKCE (interactive)</span>
3111
<a id="__codelineno-0-154" name="__codelineno-0-154"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">supports_oauth</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_client_id</span><span class="p">:</span>
3112
<a id="__codelineno-0-155" name="__codelineno-0-155"></a> <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_try_oauth_pkce</span><span class="p">()</span>
3113
<a id="__codelineno-0-156" name="__codelineno-0-156"></a> <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">success</span><span class="p">:</span>
3114
<a id="__codelineno-0-157" name="__codelineno-0-157"></a> <span class="k">return</span> <span class="n">result</span>
3115
<a id="__codelineno-0-158" name="__codelineno-0-158"></a>
3116
<a id="__codelineno-0-159" name="__codelineno-0-159"></a> <span class="c1"># 4. API key fallback</span>
3117
<a id="__codelineno-0-160" name="__codelineno-0-160"></a> <span class="n">api_key</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_api_key</span>
3118
<a id="__codelineno-0-161" name="__codelineno-0-161"></a> <span class="k">if</span> <span class="n">api_key</span><span class="p">:</span>
3119
<a id="__codelineno-0-162" name="__codelineno-0-162"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span>
3120
<a id="__codelineno-0-163" name="__codelineno-0-163"></a> <span class="n">success</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
3121
<a id="__codelineno-0-164" name="__codelineno-0-164"></a> <span class="n">access_token</span><span class="o">=</span><span class="n">api_key</span><span class="p">,</span>
3122
<a id="__codelineno-0-165" name="__codelineno-0-165"></a> <span class="n">method</span><span class="o">=</span><span class="s2">&quot;api_key&quot;</span><span class="p">,</span>
3123
<a id="__codelineno-0-166" name="__codelineno-0-166"></a> <span class="p">)</span>
3124
<a id="__codelineno-0-167" name="__codelineno-0-167"></a>
3125
<a id="__codelineno-0-168" name="__codelineno-0-168"></a> <span class="c1"># Build a helpful error message</span>
3126
<a id="__codelineno-0-169" name="__codelineno-0-169"></a> <span class="n">hints</span> <span class="o">=</span> <span class="p">[]</span>
3127
<a id="__codelineno-0-170" name="__codelineno-0-170"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">supports_oauth</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">client_id_env</span><span class="p">:</span>
3128
<a id="__codelineno-0-171" name="__codelineno-0-171"></a> <span class="n">hints</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Set </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">client_id_env</span><span class="si">}</span><span class="s2"> for OAuth&quot;</span><span class="p">)</span>
3129
<a id="__codelineno-0-172" name="__codelineno-0-172"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">client_secret_env</span><span class="p">:</span>
3130
<a id="__codelineno-0-173" name="__codelineno-0-173"></a> <span class="n">hints</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;and </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">client_secret_env</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
3131
<a id="__codelineno-0-174" name="__codelineno-0-174"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">api_key_env</span><span class="p">:</span>
3132
<a id="__codelineno-0-175" name="__codelineno-0-175"></a> <span class="n">hints</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;or set </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">api_key_env</span><span class="si">}</span><span class="s2"> for API key access&quot;</span><span class="p">)</span>
3133
<a id="__codelineno-0-176" name="__codelineno-0-176"></a> <span class="n">hint_str</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot; (&quot;</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">hints</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;)&quot;</span><span class="p">)</span> <span class="k">if</span> <span class="n">hints</span> <span class="k">else</span> <span class="s2">&quot;&quot;</span>
3134
<a id="__codelineno-0-177" name="__codelineno-0-177"></a>
3135
<a id="__codelineno-0-178" name="__codelineno-0-178"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span>
3136
<a id="__codelineno-0-179" name="__codelineno-0-179"></a> <span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
3137
<a id="__codelineno-0-180" name="__codelineno-0-180"></a> <span class="n">error</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;No auth method available for </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">service</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="n">hint_str</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span>
3138
<a id="__codelineno-0-181" name="__codelineno-0-181"></a> <span class="p">)</span>
3139
<a id="__codelineno-0-182" name="__codelineno-0-182"></a>
3140
<a id="__codelineno-0-183" name="__codelineno-0-183"></a> <span class="k">def</span><span class="w"> </span><span class="nf">get_token</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
3141
<a id="__codelineno-0-184" name="__codelineno-0-184"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Convenience: authenticate and return just the token.&quot;&quot;&quot;</span>
3142
<a id="__codelineno-0-185" name="__codelineno-0-185"></a> <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">authenticate</span><span class="p">()</span>
3143
<a id="__codelineno-0-186" name="__codelineno-0-186"></a> <span class="k">return</span> <span class="n">result</span><span class="o">.</span><span class="n">access_token</span> <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">success</span> <span class="k">else</span> <span class="kc">None</span>
3144
<a id="__codelineno-0-187" name="__codelineno-0-187"></a>
3145
<a id="__codelineno-0-188" name="__codelineno-0-188"></a> <span class="k">def</span><span class="w"> </span><span class="nf">_try_saved_token</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AuthResult</span><span class="p">:</span>
3146
<a id="__codelineno-0-189" name="__codelineno-0-189"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Load and validate a saved token.&quot;&quot;&quot;</span>
3147
<a id="__codelineno-0-190" name="__codelineno-0-190"></a> <span class="n">token_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_token_path</span>
3148
<a id="__codelineno-0-191" name="__codelineno-0-191"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">token_path</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
3149
<a id="__codelineno-0-192" name="__codelineno-0-192"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span><span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
3150
<a id="__codelineno-0-193" name="__codelineno-0-193"></a>
3151
<a id="__codelineno-0-194" name="__codelineno-0-194"></a> <span class="k">try</span><span class="p">:</span>
3152
<a id="__codelineno-0-195" name="__codelineno-0-195"></a> <span class="n">data</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">token_path</span><span class="o">.</span><span class="n">read_text</span><span class="p">())</span>
3153
<a id="__codelineno-0-196" name="__codelineno-0-196"></a> <span class="n">expires_at</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;expires_at&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
3154
<a id="__codelineno-0-197" name="__codelineno-0-197"></a>
3155
<a id="__codelineno-0-198" name="__codelineno-0-198"></a> <span class="k">if</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">&lt;</span> <span class="n">expires_at</span><span class="p">:</span>
3156
<a id="__codelineno-0-199" name="__codelineno-0-199"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_token_data</span> <span class="o">=</span> <span class="n">data</span>
3157
<a id="__codelineno-0-200" name="__codelineno-0-200"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span>
3158
<a id="__codelineno-0-201" name="__codelineno-0-201"></a> <span class="n">success</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
3159
<a id="__codelineno-0-202" name="__codelineno-0-202"></a> <span class="n">access_token</span><span class="o">=</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;access_token&quot;</span><span class="p">],</span>
3160
<a id="__codelineno-0-203" name="__codelineno-0-203"></a> <span class="n">method</span><span class="o">=</span><span class="s2">&quot;saved_token&quot;</span><span class="p">,</span>
3161
<a id="__codelineno-0-204" name="__codelineno-0-204"></a> <span class="n">expires_at</span><span class="o">=</span><span class="n">expires_at</span><span class="p">,</span>
3162
<a id="__codelineno-0-205" name="__codelineno-0-205"></a> <span class="p">)</span>
3163
<a id="__codelineno-0-206" name="__codelineno-0-206"></a>
3164
<a id="__codelineno-0-207" name="__codelineno-0-207"></a> <span class="c1"># Expired — try refresh</span>
3165
<a id="__codelineno-0-208" name="__codelineno-0-208"></a> <span class="k">if</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;refresh_token&quot;</span><span class="p">):</span>
3166
<a id="__codelineno-0-209" name="__codelineno-0-209"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_refresh_token</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
3167
<a id="__codelineno-0-210" name="__codelineno-0-210"></a>
3168
<a id="__codelineno-0-211" name="__codelineno-0-211"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span><span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
3169
<a id="__codelineno-0-212" name="__codelineno-0-212"></a> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
3170
<a id="__codelineno-0-213" name="__codelineno-0-213"></a> <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Failed to load saved token for </span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">service</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
3171
<a id="__codelineno-0-214" name="__codelineno-0-214"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span><span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
3172
<a id="__codelineno-0-215" name="__codelineno-0-215"></a>
3173
<a id="__codelineno-0-216" name="__codelineno-0-216"></a> <span class="k">def</span><span class="w"> </span><span class="nf">_refresh_token</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="n">Dict</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AuthResult</span><span class="p">:</span>
3174
<a id="__codelineno-0-217" name="__codelineno-0-217"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Refresh an expired OAuth token.&quot;&quot;&quot;</span>
3175
<a id="__codelineno-0-218" name="__codelineno-0-218"></a> <span class="k">try</span><span class="p">:</span>
3176
<a id="__codelineno-0-219" name="__codelineno-0-219"></a> <span class="kn">import</span><span class="w"> </span><span class="nn">requests</span>
3177
<a id="__codelineno-0-220" name="__codelineno-0-220"></a> <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
3178
<a id="__codelineno-0-221" name="__codelineno-0-221"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span><span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">error</span><span class="o">=</span><span class="s2">&quot;requests not installed&quot;</span><span class="p">)</span>
3179
<a id="__codelineno-0-222" name="__codelineno-0-222"></a>
3180
<a id="__codelineno-0-223" name="__codelineno-0-223"></a> <span class="n">client_id</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;client_id&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_client_id</span>
3181
<a id="__codelineno-0-224" name="__codelineno-0-224"></a> <span class="n">client_secret</span> <span class="o">=</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;client_secret&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_client_secret</span>
3182
<a id="__codelineno-0-225" name="__codelineno-0-225"></a>
3183
<a id="__codelineno-0-226" name="__codelineno-0-226"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">client_id</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;refresh_token&quot;</span><span class="p">):</span>
3184
<a id="__codelineno-0-227" name="__codelineno-0-227"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span><span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
3185
<a id="__codelineno-0-228" name="__codelineno-0-228"></a>
3186
<a id="__codelineno-0-229" name="__codelineno-0-229"></a> <span class="k">try</span><span class="p">:</span>
3187
<a id="__codelineno-0-230" name="__codelineno-0-230"></a> <span class="n">resp</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
3188
<a id="__codelineno-0-231" name="__codelineno-0-231"></a> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">oauth_token_url</span><span class="p">,</span>
3189
<a id="__codelineno-0-232" name="__codelineno-0-232"></a> <span class="n">data</span><span class="o">=</span><span class="p">{</span>
3190
<a id="__codelineno-0-233" name="__codelineno-0-233"></a> <span class="s2">&quot;grant_type&quot;</span><span class="p">:</span> <span class="s2">&quot;refresh_token&quot;</span><span class="p">,</span>
3191
<a id="__codelineno-0-234" name="__codelineno-0-234"></a> <span class="s2">&quot;refresh_token&quot;</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;refresh_token&quot;</span><span class="p">],</span>
3192
<a id="__codelineno-0-235" name="__codelineno-0-235"></a> <span class="p">},</span>
3193
<a id="__codelineno-0-236" name="__codelineno-0-236"></a> <span class="n">auth</span><span class="o">=</span><span class="p">(</span><span class="n">client_id</span><span class="p">,</span> <span class="n">client_secret</span> <span class="ow">or</span> <span class="s2">&quot;&quot;</span><span class="p">),</span>
3194
<a id="__codelineno-0-237" name="__codelineno-0-237"></a> <span class="n">timeout</span><span class="o">=</span><span class="mi">30</span><span class="p">,</span>
3195
<a id="__codelineno-0-238" name="__codelineno-0-238"></a> <span class="p">)</span>
3196
<a id="__codelineno-0-239" name="__codelineno-0-239"></a> <span class="n">resp</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
3197
<a id="__codelineno-0-240" name="__codelineno-0-240"></a> <span class="n">token_data</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
3198
<a id="__codelineno-0-241" name="__codelineno-0-241"></a>
3199
<a id="__codelineno-0-242" name="__codelineno-0-242"></a> <span class="n">new_data</span> <span class="o">=</span> <span class="p">{</span>
3200
<a id="__codelineno-0-243" name="__codelineno-0-243"></a> <span class="s2">&quot;access_token&quot;</span><span class="p">:</span> <span class="n">token_data</span><span class="p">[</span><span class="s2">&quot;access_token&quot;</span><span class="p">],</span>
3201
<a id="__codelineno-0-244" name="__codelineno-0-244"></a> <span class="s2">&quot;refresh_token&quot;</span><span class="p">:</span> <span class="n">token_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;refresh_token&quot;</span><span class="p">,</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;refresh_token&quot;</span><span class="p">]),</span>
3202
<a id="__codelineno-0-245" name="__codelineno-0-245"></a> <span class="s2">&quot;expires_at&quot;</span><span class="p">:</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">+</span> <span class="n">token_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;expires_in&quot;</span><span class="p">,</span> <span class="mi">3600</span><span class="p">)</span> <span class="o">-</span> <span class="mi">60</span><span class="p">,</span>
3203
<a id="__codelineno-0-246" name="__codelineno-0-246"></a> <span class="s2">&quot;client_id&quot;</span><span class="p">:</span> <span class="n">client_id</span><span class="p">,</span>
3204
<a id="__codelineno-0-247" name="__codelineno-0-247"></a> <span class="s2">&quot;client_secret&quot;</span><span class="p">:</span> <span class="n">client_secret</span> <span class="ow">or</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
3205
<a id="__codelineno-0-248" name="__codelineno-0-248"></a> <span class="p">}</span>
3206
<a id="__codelineno-0-249" name="__codelineno-0-249"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_save_token</span><span class="p">(</span><span class="n">new_data</span><span class="p">)</span>
3207
<a id="__codelineno-0-250" name="__codelineno-0-250"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_token_data</span> <span class="o">=</span> <span class="n">new_data</span>
3208
<a id="__codelineno-0-251" name="__codelineno-0-251"></a>
3209
<a id="__codelineno-0-252" name="__codelineno-0-252"></a> <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Refreshed OAuth token for </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">service</span><span class="p">)</span>
3210
<a id="__codelineno-0-253" name="__codelineno-0-253"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span>
3211
<a id="__codelineno-0-254" name="__codelineno-0-254"></a> <span class="n">success</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
3212
<a id="__codelineno-0-255" name="__codelineno-0-255"></a> <span class="n">access_token</span><span class="o">=</span><span class="n">new_data</span><span class="p">[</span><span class="s2">&quot;access_token&quot;</span><span class="p">],</span>
3213
<a id="__codelineno-0-256" name="__codelineno-0-256"></a> <span class="n">method</span><span class="o">=</span><span class="s2">&quot;saved_token&quot;</span><span class="p">,</span>
3214
<a id="__codelineno-0-257" name="__codelineno-0-257"></a> <span class="n">expires_at</span><span class="o">=</span><span class="n">new_data</span><span class="p">[</span><span class="s2">&quot;expires_at&quot;</span><span class="p">],</span>
3215
<a id="__codelineno-0-258" name="__codelineno-0-258"></a> <span class="n">refresh_token</span><span class="o">=</span><span class="n">new_data</span><span class="p">[</span><span class="s2">&quot;refresh_token&quot;</span><span class="p">],</span>
3216
<a id="__codelineno-0-259" name="__codelineno-0-259"></a> <span class="p">)</span>
3217
<a id="__codelineno-0-260" name="__codelineno-0-260"></a> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
3218
<a id="__codelineno-0-261" name="__codelineno-0-261"></a> <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Token refresh failed for </span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">service</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
3219
<a id="__codelineno-0-262" name="__codelineno-0-262"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span><span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
3220
<a id="__codelineno-0-263" name="__codelineno-0-263"></a>
3221
<a id="__codelineno-0-264" name="__codelineno-0-264"></a> <span class="k">def</span><span class="w"> </span><span class="nf">_try_client_credentials</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AuthResult</span><span class="p">:</span>
3222
<a id="__codelineno-0-265" name="__codelineno-0-265"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Server-to-Server OAuth using client credentials grant.&quot;&quot;&quot;</span>
3223
<a id="__codelineno-0-266" name="__codelineno-0-266"></a> <span class="k">try</span><span class="p">:</span>
3224
<a id="__codelineno-0-267" name="__codelineno-0-267"></a> <span class="kn">import</span><span class="w"> </span><span class="nn">requests</span>
3225
<a id="__codelineno-0-268" name="__codelineno-0-268"></a> <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
3226
<a id="__codelineno-0-269" name="__codelineno-0-269"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span><span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">error</span><span class="o">=</span><span class="s2">&quot;requests not installed&quot;</span><span class="p">)</span>
3227
<a id="__codelineno-0-270" name="__codelineno-0-270"></a>
3228
<a id="__codelineno-0-271" name="__codelineno-0-271"></a> <span class="n">client_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_client_id</span>
3229
<a id="__codelineno-0-272" name="__codelineno-0-272"></a> <span class="n">client_secret</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_client_secret</span>
3230
<a id="__codelineno-0-273" name="__codelineno-0-273"></a> <span class="n">account_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_account_id</span>
3231
<a id="__codelineno-0-274" name="__codelineno-0-274"></a>
3232
<a id="__codelineno-0-275" name="__codelineno-0-275"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">client_id</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">client_secret</span><span class="p">:</span>
3233
<a id="__codelineno-0-276" name="__codelineno-0-276"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span><span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
3234
<a id="__codelineno-0-277" name="__codelineno-0-277"></a>
3235
<a id="__codelineno-0-278" name="__codelineno-0-278"></a> <span class="k">try</span><span class="p">:</span>
3236
<a id="__codelineno-0-279" name="__codelineno-0-279"></a> <span class="n">resp</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
3237
<a id="__codelineno-0-280" name="__codelineno-0-280"></a> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">oauth_token_url</span><span class="p">,</span>
3238
<a id="__codelineno-0-281" name="__codelineno-0-281"></a> <span class="n">params</span><span class="o">=</span><span class="p">{</span>
3239
<a id="__codelineno-0-282" name="__codelineno-0-282"></a> <span class="s2">&quot;grant_type&quot;</span><span class="p">:</span> <span class="s2">&quot;account_credentials&quot;</span><span class="p">,</span>
3240
<a id="__codelineno-0-283" name="__codelineno-0-283"></a> <span class="s2">&quot;account_id&quot;</span><span class="p">:</span> <span class="n">account_id</span><span class="p">,</span>
3241
<a id="__codelineno-0-284" name="__codelineno-0-284"></a> <span class="p">},</span>
3242
<a id="__codelineno-0-285" name="__codelineno-0-285"></a> <span class="n">auth</span><span class="o">=</span><span class="p">(</span><span class="n">client_id</span><span class="p">,</span> <span class="n">client_secret</span><span class="p">),</span>
3243
<a id="__codelineno-0-286" name="__codelineno-0-286"></a> <span class="n">timeout</span><span class="o">=</span><span class="mi">30</span><span class="p">,</span>
3244
<a id="__codelineno-0-287" name="__codelineno-0-287"></a> <span class="p">)</span>
3245
<a id="__codelineno-0-288" name="__codelineno-0-288"></a> <span class="n">resp</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
3246
<a id="__codelineno-0-289" name="__codelineno-0-289"></a> <span class="n">token_data</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
3247
<a id="__codelineno-0-290" name="__codelineno-0-290"></a>
3248
<a id="__codelineno-0-291" name="__codelineno-0-291"></a> <span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
3249
<a id="__codelineno-0-292" name="__codelineno-0-292"></a> <span class="s2">&quot;access_token&quot;</span><span class="p">:</span> <span class="n">token_data</span><span class="p">[</span><span class="s2">&quot;access_token&quot;</span><span class="p">],</span>
3250
<a id="__codelineno-0-293" name="__codelineno-0-293"></a> <span class="s2">&quot;expires_at&quot;</span><span class="p">:</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">+</span> <span class="n">token_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;expires_in&quot;</span><span class="p">,</span> <span class="mi">3600</span><span class="p">)</span> <span class="o">-</span> <span class="mi">60</span><span class="p">,</span>
3251
<a id="__codelineno-0-294" name="__codelineno-0-294"></a> <span class="p">}</span>
3252
<a id="__codelineno-0-295" name="__codelineno-0-295"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_save_token</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
3253
<a id="__codelineno-0-296" name="__codelineno-0-296"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_token_data</span> <span class="o">=</span> <span class="n">data</span>
3254
<a id="__codelineno-0-297" name="__codelineno-0-297"></a>
3255
<a id="__codelineno-0-298" name="__codelineno-0-298"></a> <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Authenticated </span><span class="si">%s</span><span class="s2"> via client credentials&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">service</span><span class="p">)</span>
3256
<a id="__codelineno-0-299" name="__codelineno-0-299"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span>
3257
<a id="__codelineno-0-300" name="__codelineno-0-300"></a> <span class="n">success</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
3258
<a id="__codelineno-0-301" name="__codelineno-0-301"></a> <span class="n">access_token</span><span class="o">=</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;access_token&quot;</span><span class="p">],</span>
3259
<a id="__codelineno-0-302" name="__codelineno-0-302"></a> <span class="n">method</span><span class="o">=</span><span class="s2">&quot;client_credentials&quot;</span><span class="p">,</span>
3260
<a id="__codelineno-0-303" name="__codelineno-0-303"></a> <span class="n">expires_at</span><span class="o">=</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;expires_at&quot;</span><span class="p">],</span>
3261
<a id="__codelineno-0-304" name="__codelineno-0-304"></a> <span class="p">)</span>
3262
<a id="__codelineno-0-305" name="__codelineno-0-305"></a> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
3263
<a id="__codelineno-0-306" name="__codelineno-0-306"></a> <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Client credentials failed for </span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">service</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
3264
<a id="__codelineno-0-307" name="__codelineno-0-307"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span><span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
3265
<a id="__codelineno-0-308" name="__codelineno-0-308"></a>
3266
<a id="__codelineno-0-309" name="__codelineno-0-309"></a> <span class="k">def</span><span class="w"> </span><span class="nf">_try_oauth_pkce</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AuthResult</span><span class="p">:</span>
3267
<a id="__codelineno-0-310" name="__codelineno-0-310"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Interactive OAuth2 Authorization Code flow with PKCE.&quot;&quot;&quot;</span>
3268
<a id="__codelineno-0-311" name="__codelineno-0-311"></a> <span class="k">try</span><span class="p">:</span>
3269
<a id="__codelineno-0-312" name="__codelineno-0-312"></a> <span class="kn">import</span><span class="w"> </span><span class="nn">requests</span>
3270
<a id="__codelineno-0-313" name="__codelineno-0-313"></a> <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
3271
<a id="__codelineno-0-314" name="__codelineno-0-314"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span><span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">error</span><span class="o">=</span><span class="s2">&quot;requests not installed&quot;</span><span class="p">)</span>
3272
<a id="__codelineno-0-315" name="__codelineno-0-315"></a>
3273
<a id="__codelineno-0-316" name="__codelineno-0-316"></a> <span class="n">client_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_client_id</span>
3274
<a id="__codelineno-0-317" name="__codelineno-0-317"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">client_id</span><span class="p">:</span>
3275
<a id="__codelineno-0-318" name="__codelineno-0-318"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span><span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
3276
<a id="__codelineno-0-319" name="__codelineno-0-319"></a>
3277
<a id="__codelineno-0-320" name="__codelineno-0-320"></a> <span class="c1"># Generate PKCE verifier and challenge</span>
3278
<a id="__codelineno-0-321" name="__codelineno-0-321"></a> <span class="n">code_verifier</span> <span class="o">=</span> <span class="n">secrets</span><span class="o">.</span><span class="n">token_urlsafe</span><span class="p">(</span><span class="mi">64</span><span class="p">)</span>
3279
<a id="__codelineno-0-322" name="__codelineno-0-322"></a> <span class="n">code_challenge</span> <span class="o">=</span> <span class="p">(</span>
3280
<a id="__codelineno-0-323" name="__codelineno-0-323"></a> <span class="n">base64</span><span class="o">.</span><span class="n">urlsafe_b64encode</span><span class="p">(</span><span class="n">hashlib</span><span class="o">.</span><span class="n">sha256</span><span class="p">(</span><span class="n">code_verifier</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s2">&quot;ascii&quot;</span><span class="p">))</span><span class="o">.</span><span class="n">digest</span><span class="p">())</span>
3281
<a id="__codelineno-0-324" name="__codelineno-0-324"></a> <span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="sa">b</span><span class="s2">&quot;=&quot;</span><span class="p">)</span>
3282
<a id="__codelineno-0-325" name="__codelineno-0-325"></a> <span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s2">&quot;ascii&quot;</span><span class="p">)</span>
3283
<a id="__codelineno-0-326" name="__codelineno-0-326"></a> <span class="p">)</span>
3284
<a id="__codelineno-0-327" name="__codelineno-0-327"></a>
3285
<a id="__codelineno-0-328" name="__codelineno-0-328"></a> <span class="c1"># Build authorize URL</span>
3286
<a id="__codelineno-0-329" name="__codelineno-0-329"></a> <span class="n">params</span> <span class="o">=</span> <span class="p">(</span>
3287
<a id="__codelineno-0-330" name="__codelineno-0-330"></a> <span class="sa">f</span><span class="s2">&quot;?response_type=code&quot;</span>
3288
<a id="__codelineno-0-331" name="__codelineno-0-331"></a> <span class="sa">f</span><span class="s2">&quot;&amp;client_id=</span><span class="si">{</span><span class="n">client_id</span><span class="si">}</span><span class="s2">&quot;</span>
3289
<a id="__codelineno-0-332" name="__codelineno-0-332"></a> <span class="sa">f</span><span class="s2">&quot;&amp;redirect_uri=</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">redirect_uri</span><span class="si">}</span><span class="s2">&quot;</span>
3290
<a id="__codelineno-0-333" name="__codelineno-0-333"></a> <span class="sa">f</span><span class="s2">&quot;&amp;code_challenge=</span><span class="si">{</span><span class="n">code_challenge</span><span class="si">}</span><span class="s2">&quot;</span>
3291
<a id="__codelineno-0-334" name="__codelineno-0-334"></a> <span class="sa">f</span><span class="s2">&quot;&amp;code_challenge_method=S256&quot;</span>
3292
<a id="__codelineno-0-335" name="__codelineno-0-335"></a> <span class="p">)</span>
3293
<a id="__codelineno-0-336" name="__codelineno-0-336"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">scopes</span><span class="p">:</span>
3294
<a id="__codelineno-0-337" name="__codelineno-0-337"></a> <span class="n">params</span> <span class="o">+=</span> <span class="sa">f</span><span class="s2">&quot;&amp;scope=</span><span class="si">{</span><span class="s1">&#39;+&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">scopes</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span>
3295
<a id="__codelineno-0-338" name="__codelineno-0-338"></a>
3296
<a id="__codelineno-0-339" name="__codelineno-0-339"></a> <span class="n">authorize_url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">oauth_authorize_url</span><span class="si">}{</span><span class="n">params</span><span class="si">}</span><span class="s2">&quot;</span>
3297
<a id="__codelineno-0-340" name="__codelineno-0-340"></a>
3298
<a id="__codelineno-0-341" name="__codelineno-0-341"></a> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">Open this URL to authorize PlanOpticon (</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">service</span><span class="si">}</span><span class="s2">):&quot;</span><span class="p">)</span>
3299
<a id="__codelineno-0-342" name="__codelineno-0-342"></a> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">authorize_url</span><span class="si">}</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
3300
<a id="__codelineno-0-343" name="__codelineno-0-343"></a>
3301
<a id="__codelineno-0-344" name="__codelineno-0-344"></a> <span class="k">try</span><span class="p">:</span>
3302
<a id="__codelineno-0-345" name="__codelineno-0-345"></a> <span class="n">webbrowser</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">authorize_url</span><span class="p">)</span>
3303
<a id="__codelineno-0-346" name="__codelineno-0-346"></a> <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
3304
<a id="__codelineno-0-347" name="__codelineno-0-347"></a> <span class="k">pass</span>
3305
<a id="__codelineno-0-348" name="__codelineno-0-348"></a>
3306
<a id="__codelineno-0-349" name="__codelineno-0-349"></a> <span class="k">try</span><span class="p">:</span>
3307
<a id="__codelineno-0-350" name="__codelineno-0-350"></a> <span class="n">auth_code</span> <span class="o">=</span> <span class="nb">input</span><span class="p">(</span><span class="s2">&quot;Enter the authorization code: &quot;</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
3308
<a id="__codelineno-0-351" name="__codelineno-0-351"></a> <span class="k">except</span> <span class="p">(</span><span class="ne">KeyboardInterrupt</span><span class="p">,</span> <span class="ne">EOFError</span><span class="p">):</span>
3309
<a id="__codelineno-0-352" name="__codelineno-0-352"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span><span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">error</span><span class="o">=</span><span class="s2">&quot;Auth cancelled by user&quot;</span><span class="p">)</span>
3310
<a id="__codelineno-0-353" name="__codelineno-0-353"></a>
3311
<a id="__codelineno-0-354" name="__codelineno-0-354"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">auth_code</span><span class="p">:</span>
3312
<a id="__codelineno-0-355" name="__codelineno-0-355"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span><span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">error</span><span class="o">=</span><span class="s2">&quot;No auth code provided&quot;</span><span class="p">)</span>
3313
<a id="__codelineno-0-356" name="__codelineno-0-356"></a>
3314
<a id="__codelineno-0-357" name="__codelineno-0-357"></a> <span class="c1"># Exchange code for tokens</span>
3315
<a id="__codelineno-0-358" name="__codelineno-0-358"></a> <span class="n">client_secret</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_client_secret</span>
3316
<a id="__codelineno-0-359" name="__codelineno-0-359"></a> <span class="k">try</span><span class="p">:</span>
3317
<a id="__codelineno-0-360" name="__codelineno-0-360"></a> <span class="n">resp</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
3318
<a id="__codelineno-0-361" name="__codelineno-0-361"></a> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">oauth_token_url</span><span class="p">,</span>
3319
<a id="__codelineno-0-362" name="__codelineno-0-362"></a> <span class="n">data</span><span class="o">=</span><span class="p">{</span>
3320
<a id="__codelineno-0-363" name="__codelineno-0-363"></a> <span class="s2">&quot;grant_type&quot;</span><span class="p">:</span> <span class="s2">&quot;authorization_code&quot;</span><span class="p">,</span>
3321
<a id="__codelineno-0-364" name="__codelineno-0-364"></a> <span class="s2">&quot;code&quot;</span><span class="p">:</span> <span class="n">auth_code</span><span class="p">,</span>
3322
<a id="__codelineno-0-365" name="__codelineno-0-365"></a> <span class="s2">&quot;redirect_uri&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">redirect_uri</span><span class="p">,</span>
3323
<a id="__codelineno-0-366" name="__codelineno-0-366"></a> <span class="s2">&quot;code_verifier&quot;</span><span class="p">:</span> <span class="n">code_verifier</span><span class="p">,</span>
3324
<a id="__codelineno-0-367" name="__codelineno-0-367"></a> <span class="p">},</span>
3325
<a id="__codelineno-0-368" name="__codelineno-0-368"></a> <span class="n">auth</span><span class="o">=</span><span class="p">(</span><span class="n">client_id</span><span class="p">,</span> <span class="n">client_secret</span> <span class="ow">or</span> <span class="s2">&quot;&quot;</span><span class="p">),</span>
3326
<a id="__codelineno-0-369" name="__codelineno-0-369"></a> <span class="n">timeout</span><span class="o">=</span><span class="mi">30</span><span class="p">,</span>
3327
<a id="__codelineno-0-370" name="__codelineno-0-370"></a> <span class="p">)</span>
3328
<a id="__codelineno-0-371" name="__codelineno-0-371"></a> <span class="n">resp</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
3329
<a id="__codelineno-0-372" name="__codelineno-0-372"></a> <span class="n">token_data</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
3330
<a id="__codelineno-0-373" name="__codelineno-0-373"></a>
3331
<a id="__codelineno-0-374" name="__codelineno-0-374"></a> <span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
3332
<a id="__codelineno-0-375" name="__codelineno-0-375"></a> <span class="s2">&quot;access_token&quot;</span><span class="p">:</span> <span class="n">token_data</span><span class="p">[</span><span class="s2">&quot;access_token&quot;</span><span class="p">],</span>
3333
<a id="__codelineno-0-376" name="__codelineno-0-376"></a> <span class="s2">&quot;refresh_token&quot;</span><span class="p">:</span> <span class="n">token_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;refresh_token&quot;</span><span class="p">),</span>
3334
<a id="__codelineno-0-377" name="__codelineno-0-377"></a> <span class="s2">&quot;expires_at&quot;</span><span class="p">:</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">+</span> <span class="n">token_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;expires_in&quot;</span><span class="p">,</span> <span class="mi">3600</span><span class="p">)</span> <span class="o">-</span> <span class="mi">60</span><span class="p">,</span>
3335
<a id="__codelineno-0-378" name="__codelineno-0-378"></a> <span class="s2">&quot;client_id&quot;</span><span class="p">:</span> <span class="n">client_id</span><span class="p">,</span>
3336
<a id="__codelineno-0-379" name="__codelineno-0-379"></a> <span class="s2">&quot;client_secret&quot;</span><span class="p">:</span> <span class="n">client_secret</span> <span class="ow">or</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
3337
<a id="__codelineno-0-380" name="__codelineno-0-380"></a> <span class="p">}</span>
3338
<a id="__codelineno-0-381" name="__codelineno-0-381"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_save_token</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
3339
<a id="__codelineno-0-382" name="__codelineno-0-382"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_token_data</span> <span class="o">=</span> <span class="n">data</span>
3340
<a id="__codelineno-0-383" name="__codelineno-0-383"></a>
3341
<a id="__codelineno-0-384" name="__codelineno-0-384"></a> <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Authenticated </span><span class="si">%s</span><span class="s2"> via OAuth PKCE&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">service</span><span class="p">)</span>
3342
<a id="__codelineno-0-385" name="__codelineno-0-385"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span>
3343
<a id="__codelineno-0-386" name="__codelineno-0-386"></a> <span class="n">success</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
3344
<a id="__codelineno-0-387" name="__codelineno-0-387"></a> <span class="n">access_token</span><span class="o">=</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;access_token&quot;</span><span class="p">],</span>
3345
<a id="__codelineno-0-388" name="__codelineno-0-388"></a> <span class="n">method</span><span class="o">=</span><span class="s2">&quot;oauth_pkce&quot;</span><span class="p">,</span>
3346
<a id="__codelineno-0-389" name="__codelineno-0-389"></a> <span class="n">expires_at</span><span class="o">=</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;expires_at&quot;</span><span class="p">],</span>
3347
<a id="__codelineno-0-390" name="__codelineno-0-390"></a> <span class="n">refresh_token</span><span class="o">=</span><span class="n">data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;refresh_token&quot;</span><span class="p">),</span>
3348
<a id="__codelineno-0-391" name="__codelineno-0-391"></a> <span class="p">)</span>
3349
<a id="__codelineno-0-392" name="__codelineno-0-392"></a> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
3350
<a id="__codelineno-0-393" name="__codelineno-0-393"></a> <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;OAuth PKCE failed for </span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">service</span><span class="p">,</span> <span class="n">exc</span><span class="p">)</span>
3351
<a id="__codelineno-0-394" name="__codelineno-0-394"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span><span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">error</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">exc</span><span class="p">))</span>
3352
<a id="__codelineno-0-395" name="__codelineno-0-395"></a>
3353
<a id="__codelineno-0-396" name="__codelineno-0-396"></a> <span class="k">def</span><span class="w"> </span><span class="nf">_save_token</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">:</span> <span class="n">Dict</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
3354
<a id="__codelineno-0-397" name="__codelineno-0-397"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Persist token data to disk.&quot;&quot;&quot;</span>
3355
<a id="__codelineno-0-398" name="__codelineno-0-398"></a> <span class="n">token_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_token_path</span>
3356
<a id="__codelineno-0-399" name="__codelineno-0-399"></a> <span class="n">token_path</span><span class="o">.</span><span class="n">parent</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">parents</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">exist_ok</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
3357
<a id="__codelineno-0-400" name="__codelineno-0-400"></a> <span class="n">token_path</span><span class="o">.</span><span class="n">write_text</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
3358
<a id="__codelineno-0-401" name="__codelineno-0-401"></a> <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Saved </span><span class="si">%s</span><span class="s2"> token to </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">service</span><span class="p">,</span> <span class="n">token_path</span><span class="p">)</span>
3359
<a id="__codelineno-0-402" name="__codelineno-0-402"></a>
3360
<a id="__codelineno-0-403" name="__codelineno-0-403"></a> <span class="k">def</span><span class="w"> </span><span class="nf">clear_token</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
3361
<a id="__codelineno-0-404" name="__codelineno-0-404"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Remove saved token (logout).&quot;&quot;&quot;</span>
3362
<a id="__codelineno-0-405" name="__codelineno-0-405"></a> <span class="n">token_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_token_path</span>
3363
<a id="__codelineno-0-406" name="__codelineno-0-406"></a> <span class="k">if</span> <span class="n">token_path</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
3364
<a id="__codelineno-0-407" name="__codelineno-0-407"></a> <span class="n">token_path</span><span class="o">.</span><span class="n">unlink</span><span class="p">()</span>
3365
<a id="__codelineno-0-408" name="__codelineno-0-408"></a> <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Cleared </span><span class="si">%s</span><span class="s2"> token&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">service</span><span class="p">)</span>
3366
</code></pre></div></td></tr></table></div>
3367
</details>
3368
3369
3370
3371
<div class="doc doc-children">
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
<div class="doc doc-object doc-function">
3383
3384
3385
<h4 id="video_processor.auth.OAuthManager.authenticate" class="doc doc-heading">
3386
<code class="highlight language-python"><span class="n">authenticate</span><span class="p">()</span></code>
3387
3388
<a href="#video_processor.auth.OAuthManager.authenticate" class="headerlink" title="Permanent link">&para;</a></h4>
3389
3390
3391
<div class="doc doc-contents ">
3392
3393
<p>Run the auth chain and return the result.</p>
3394
3395
3396
<details class="mkdocstrings-source">
3397
<summary>Source code in <code>video_processor/auth.py</code></summary>
3398
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-140">140</a></span>
3399
<span class="normal"><a href="#__codelineno-0-141">141</a></span>
3400
<span class="normal"><a href="#__codelineno-0-142">142</a></span>
3401
<span class="normal"><a href="#__codelineno-0-143">143</a></span>
3402
<span class="normal"><a href="#__codelineno-0-144">144</a></span>
3403
<span class="normal"><a href="#__codelineno-0-145">145</a></span>
3404
<span class="normal"><a href="#__codelineno-0-146">146</a></span>
3405
<span class="normal"><a href="#__codelineno-0-147">147</a></span>
3406
<span class="normal"><a href="#__codelineno-0-148">148</a></span>
3407
<span class="normal"><a href="#__codelineno-0-149">149</a></span>
3408
<span class="normal"><a href="#__codelineno-0-150">150</a></span>
3409
<span class="normal"><a href="#__codelineno-0-151">151</a></span>
3410
<span class="normal"><a href="#__codelineno-0-152">152</a></span>
3411
<span class="normal"><a href="#__codelineno-0-153">153</a></span>
3412
<span class="normal"><a href="#__codelineno-0-154">154</a></span>
3413
<span class="normal"><a href="#__codelineno-0-155">155</a></span>
3414
<span class="normal"><a href="#__codelineno-0-156">156</a></span>
3415
<span class="normal"><a href="#__codelineno-0-157">157</a></span>
3416
<span class="normal"><a href="#__codelineno-0-158">158</a></span>
3417
<span class="normal"><a href="#__codelineno-0-159">159</a></span>
3418
<span class="normal"><a href="#__codelineno-0-160">160</a></span>
3419
<span class="normal"><a href="#__codelineno-0-161">161</a></span>
3420
<span class="normal"><a href="#__codelineno-0-162">162</a></span>
3421
<span class="normal"><a href="#__codelineno-0-163">163</a></span>
3422
<span class="normal"><a href="#__codelineno-0-164">164</a></span>
3423
<span class="normal"><a href="#__codelineno-0-165">165</a></span>
3424
<span class="normal"><a href="#__codelineno-0-166">166</a></span>
3425
<span class="normal"><a href="#__codelineno-0-167">167</a></span>
3426
<span class="normal"><a href="#__codelineno-0-168">168</a></span>
3427
<span class="normal"><a href="#__codelineno-0-169">169</a></span>
3428
<span class="normal"><a href="#__codelineno-0-170">170</a></span>
3429
<span class="normal"><a href="#__codelineno-0-171">171</a></span>
3430
<span class="normal"><a href="#__codelineno-0-172">172</a></span>
3431
<span class="normal"><a href="#__codelineno-0-173">173</a></span>
3432
<span class="normal"><a href="#__codelineno-0-174">174</a></span>
3433
<span class="normal"><a href="#__codelineno-0-175">175</a></span>
3434
<span class="normal"><a href="#__codelineno-0-176">176</a></span>
3435
<span class="normal"><a href="#__codelineno-0-177">177</a></span>
3436
<span class="normal"><a href="#__codelineno-0-178">178</a></span>
3437
<span class="normal"><a href="#__codelineno-0-179">179</a></span>
3438
<span class="normal"><a href="#__codelineno-0-180">180</a></span>
3439
<span class="normal"><a href="#__codelineno-0-181">181</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-140" name="__codelineno-0-140"></a><span class="k">def</span><span class="w"> </span><span class="nf">authenticate</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AuthResult</span><span class="p">:</span>
3440
<a id="__codelineno-0-141" name="__codelineno-0-141"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Run the auth chain and return the result.&quot;&quot;&quot;</span>
3441
<a id="__codelineno-0-142" name="__codelineno-0-142"></a> <span class="c1"># 1. Saved token</span>
3442
<a id="__codelineno-0-143" name="__codelineno-0-143"></a> <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_try_saved_token</span><span class="p">()</span>
3443
<a id="__codelineno-0-144" name="__codelineno-0-144"></a> <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">success</span><span class="p">:</span>
3444
<a id="__codelineno-0-145" name="__codelineno-0-145"></a> <span class="k">return</span> <span class="n">result</span>
3445
<a id="__codelineno-0-146" name="__codelineno-0-146"></a>
3446
<a id="__codelineno-0-147" name="__codelineno-0-147"></a> <span class="c1"># 2. Client Credentials (Server-to-Server)</span>
3447
<a id="__codelineno-0-148" name="__codelineno-0-148"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_account_id</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">supports_oauth</span><span class="p">:</span>
3448
<a id="__codelineno-0-149" name="__codelineno-0-149"></a> <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_try_client_credentials</span><span class="p">()</span>
3449
<a id="__codelineno-0-150" name="__codelineno-0-150"></a> <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">success</span><span class="p">:</span>
3450
<a id="__codelineno-0-151" name="__codelineno-0-151"></a> <span class="k">return</span> <span class="n">result</span>
3451
<a id="__codelineno-0-152" name="__codelineno-0-152"></a>
3452
<a id="__codelineno-0-153" name="__codelineno-0-153"></a> <span class="c1"># 3. OAuth PKCE (interactive)</span>
3453
<a id="__codelineno-0-154" name="__codelineno-0-154"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">supports_oauth</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_client_id</span><span class="p">:</span>
3454
<a id="__codelineno-0-155" name="__codelineno-0-155"></a> <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_try_oauth_pkce</span><span class="p">()</span>
3455
<a id="__codelineno-0-156" name="__codelineno-0-156"></a> <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">success</span><span class="p">:</span>
3456
<a id="__codelineno-0-157" name="__codelineno-0-157"></a> <span class="k">return</span> <span class="n">result</span>
3457
<a id="__codelineno-0-158" name="__codelineno-0-158"></a>
3458
<a id="__codelineno-0-159" name="__codelineno-0-159"></a> <span class="c1"># 4. API key fallback</span>
3459
<a id="__codelineno-0-160" name="__codelineno-0-160"></a> <span class="n">api_key</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_api_key</span>
3460
<a id="__codelineno-0-161" name="__codelineno-0-161"></a> <span class="k">if</span> <span class="n">api_key</span><span class="p">:</span>
3461
<a id="__codelineno-0-162" name="__codelineno-0-162"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span>
3462
<a id="__codelineno-0-163" name="__codelineno-0-163"></a> <span class="n">success</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
3463
<a id="__codelineno-0-164" name="__codelineno-0-164"></a> <span class="n">access_token</span><span class="o">=</span><span class="n">api_key</span><span class="p">,</span>
3464
<a id="__codelineno-0-165" name="__codelineno-0-165"></a> <span class="n">method</span><span class="o">=</span><span class="s2">&quot;api_key&quot;</span><span class="p">,</span>
3465
<a id="__codelineno-0-166" name="__codelineno-0-166"></a> <span class="p">)</span>
3466
<a id="__codelineno-0-167" name="__codelineno-0-167"></a>
3467
<a id="__codelineno-0-168" name="__codelineno-0-168"></a> <span class="c1"># Build a helpful error message</span>
3468
<a id="__codelineno-0-169" name="__codelineno-0-169"></a> <span class="n">hints</span> <span class="o">=</span> <span class="p">[]</span>
3469
<a id="__codelineno-0-170" name="__codelineno-0-170"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">supports_oauth</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">client_id_env</span><span class="p">:</span>
3470
<a id="__codelineno-0-171" name="__codelineno-0-171"></a> <span class="n">hints</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Set </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">client_id_env</span><span class="si">}</span><span class="s2"> for OAuth&quot;</span><span class="p">)</span>
3471
<a id="__codelineno-0-172" name="__codelineno-0-172"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">client_secret_env</span><span class="p">:</span>
3472
<a id="__codelineno-0-173" name="__codelineno-0-173"></a> <span class="n">hints</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;and </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">client_secret_env</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
3473
<a id="__codelineno-0-174" name="__codelineno-0-174"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">api_key_env</span><span class="p">:</span>
3474
<a id="__codelineno-0-175" name="__codelineno-0-175"></a> <span class="n">hints</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;or set </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">api_key_env</span><span class="si">}</span><span class="s2"> for API key access&quot;</span><span class="p">)</span>
3475
<a id="__codelineno-0-176" name="__codelineno-0-176"></a> <span class="n">hint_str</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot; (&quot;</span> <span class="o">+</span> <span class="s2">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">hints</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;)&quot;</span><span class="p">)</span> <span class="k">if</span> <span class="n">hints</span> <span class="k">else</span> <span class="s2">&quot;&quot;</span>
3476
<a id="__codelineno-0-177" name="__codelineno-0-177"></a>
3477
<a id="__codelineno-0-178" name="__codelineno-0-178"></a> <span class="k">return</span> <span class="n">AuthResult</span><span class="p">(</span>
3478
<a id="__codelineno-0-179" name="__codelineno-0-179"></a> <span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
3479
<a id="__codelineno-0-180" name="__codelineno-0-180"></a> <span class="n">error</span><span class="o">=</span><span class="sa">f</span><span class="s2">&quot;No auth method available for </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">service</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="n">hint_str</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span>
3480
<a id="__codelineno-0-181" name="__codelineno-0-181"></a> <span class="p">)</span>
3481
</code></pre></div></td></tr></table></div>
3482
</details>
3483
</div>
3484
3485
</div>
3486
3487
<div class="doc doc-object doc-function">
3488
3489
3490
<h4 id="video_processor.auth.OAuthManager.clear_token" class="doc doc-heading">
3491
<code class="highlight language-python"><span class="n">clear_token</span><span class="p">()</span></code>
3492
3493
<a href="#video_processor.auth.OAuthManager.clear_token" class="headerlink" title="Permanent link">&para;</a></h4>
3494
3495
3496
<div class="doc doc-contents ">
3497
3498
<p>Remove saved token (logout).</p>
3499
3500
3501
<details class="mkdocstrings-source">
3502
<summary>Source code in <code>video_processor/auth.py</code></summary>
3503
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-403">403</a></span>
3504
<span class="normal"><a href="#__codelineno-0-404">404</a></span>
3505
<span class="normal"><a href="#__codelineno-0-405">405</a></span>
3506
<span class="normal"><a href="#__codelineno-0-406">406</a></span>
3507
<span class="normal"><a href="#__codelineno-0-407">407</a></span>
3508
<span class="normal"><a href="#__codelineno-0-408">408</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-403" name="__codelineno-0-403"></a><span class="k">def</span><span class="w"> </span><span class="nf">clear_token</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
3509
<a id="__codelineno-0-404" name="__codelineno-0-404"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Remove saved token (logout).&quot;&quot;&quot;</span>
3510
<a id="__codelineno-0-405" name="__codelineno-0-405"></a> <span class="n">token_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_token_path</span>
3511
<a id="__codelineno-0-406" name="__codelineno-0-406"></a> <span class="k">if</span> <span class="n">token_path</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
3512
<a id="__codelineno-0-407" name="__codelineno-0-407"></a> <span class="n">token_path</span><span class="o">.</span><span class="n">unlink</span><span class="p">()</span>
3513
<a id="__codelineno-0-408" name="__codelineno-0-408"></a> <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Cleared </span><span class="si">%s</span><span class="s2"> token&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">service</span><span class="p">)</span>
3514
</code></pre></div></td></tr></table></div>
3515
</details>
3516
</div>
3517
3518
</div>
3519
3520
<div class="doc doc-object doc-function">
3521
3522
3523
<h4 id="video_processor.auth.OAuthManager.get_token" class="doc doc-heading">
3524
<code class="highlight language-python"><span class="n">get_token</span><span class="p">()</span></code>
3525
3526
<a href="#video_processor.auth.OAuthManager.get_token" class="headerlink" title="Permanent link">&para;</a></h4>
3527
3528
3529
<div class="doc doc-contents ">
3530
3531
<p>Convenience: authenticate and return just the token.</p>
3532
3533
3534
<details class="mkdocstrings-source">
3535
<summary>Source code in <code>video_processor/auth.py</code></summary>
3536
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-183">183</a></span>
3537
<span class="normal"><a href="#__codelineno-0-184">184</a></span>
3538
<span class="normal"><a href="#__codelineno-0-185">185</a></span>
3539
<span class="normal"><a href="#__codelineno-0-186">186</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-183" name="__codelineno-0-183"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_token</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
3540
<a id="__codelineno-0-184" name="__codelineno-0-184"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Convenience: authenticate and return just the token.&quot;&quot;&quot;</span>
3541
<a id="__codelineno-0-185" name="__codelineno-0-185"></a> <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">authenticate</span><span class="p">()</span>
3542
<a id="__codelineno-0-186" name="__codelineno-0-186"></a> <span class="k">return</span> <span class="n">result</span><span class="o">.</span><span class="n">access_token</span> <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">success</span> <span class="k">else</span> <span class="kc">None</span>
3543
</code></pre></div></td></tr></table></div>
3544
</details>
3545
</div>
3546
3547
</div>
3548
3549
3550
3551
</div>
3552
3553
</div>
3554
3555
</div>
3556
3557
3558
<div class="doc doc-object doc-function">
3559
3560
3561
<h3 id="video_processor.auth.get_auth_config" class="doc doc-heading">
3562
<code class="highlight language-python"><span class="n">get_auth_config</span><span class="p">(</span><span class="n">service</span><span class="p">)</span></code>
3563
3564
<a href="#video_processor.auth.get_auth_config" class="headerlink" title="Permanent link">&para;</a></h3>
3565
3566
3567
<div class="doc doc-contents ">
3568
3569
<p>Get a pre-built AuthConfig for a known service.</p>
3570
3571
3572
<details class="mkdocstrings-source">
3573
<summary>Source code in <code>video_processor/auth.py</code></summary>
3574
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-475">475</a></span>
3575
<span class="normal"><a href="#__codelineno-0-476">476</a></span>
3576
<span class="normal"><a href="#__codelineno-0-477">477</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-475" name="__codelineno-0-475"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_auth_config</span><span class="p">(</span><span class="n">service</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">AuthConfig</span><span class="p">]:</span>
3577
<a id="__codelineno-0-476" name="__codelineno-0-476"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Get a pre-built AuthConfig for a known service.&quot;&quot;&quot;</span>
3578
<a id="__codelineno-0-477" name="__codelineno-0-477"></a> <span class="k">return</span> <span class="n">KNOWN_CONFIGS</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">service</span><span class="p">)</span>
3579
</code></pre></div></td></tr></table></div>
3580
</details>
3581
</div>
3582
3583
</div>
3584
3585
<div class="doc doc-object doc-function">
3586
3587
3588
<h3 id="video_processor.auth.get_auth_manager" class="doc doc-heading">
3589
<code class="highlight language-python"><span class="n">get_auth_manager</span><span class="p">(</span><span class="n">service</span><span class="p">)</span></code>
3590
3591
<a href="#video_processor.auth.get_auth_manager" class="headerlink" title="Permanent link">&para;</a></h3>
3592
3593
3594
<div class="doc doc-contents ">
3595
3596
<p>Get an OAuthManager for a known service.</p>
3597
3598
3599
<details class="mkdocstrings-source">
3600
<summary>Source code in <code>video_processor/auth.py</code></summary>
3601
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-480">480</a></span>
3602
<span class="normal"><a href="#__codelineno-0-481">481</a></span>
3603
<span class="normal"><a href="#__codelineno-0-482">482</a></span>
3604
<span class="normal"><a href="#__codelineno-0-483">483</a></span>
3605
<span class="normal"><a href="#__codelineno-0-484">484</a></span>
3606
<span class="normal"><a href="#__codelineno-0-485">485</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-480" name="__codelineno-0-480"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_auth_manager</span><span class="p">(</span><span class="n">service</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">OAuthManager</span><span class="p">]:</span>
3607
<a id="__codelineno-0-481" name="__codelineno-0-481"></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Get an OAuthManager for a known service.&quot;&quot;&quot;</span>
3608
<a id="__codelineno-0-482" name="__codelineno-0-482"></a> <span class="n">config</span> <span class="o">=</span> <span class="n">get_auth_config</span><span class="p">(</span><span class="n">service</span><span class="p">)</span>
3609
<a id="__codelineno-0-483" name="__codelineno-0-483"></a> <span class="k">if</span> <span class="n">config</span><span class="p">:</span>
3610
<a id="__codelineno-0-484" name="__codelineno-0-484"></a> <span class="k">return</span> <span class="n">OAuthManager</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
3611
<a id="__codelineno-0-485" name="__codelineno-0-485"></a> <span class="k">return</span> <span class="kc">None</span>
3612
</code></pre></div></td></tr></table></div>
3613
</details>
3614
</div>
3615
3616
</div>
3617
3618
3619
3620
</div>
3621
3622
</div>
3623
3624
</div><hr />
3625
<h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">&para;</a></h2>
3626
<p>The <code>video_processor.auth</code> module provides a unified OAuth and authentication strategy for all PlanOpticon source connectors. It supports multiple authentication methods tried in a consistent order:</p>
3627
<ol>
3628
<li><strong>Saved token</strong> -- load from disk, auto-refresh if expired</li>
3629
<li><strong>Client Credentials</strong> -- server-to-server OAuth (e.g., Zoom S2S)</li>
3630
<li><strong>OAuth 2.0 PKCE</strong> -- interactive Authorization Code flow with PKCE</li>
3631
<li><strong>API key fallback</strong> -- environment variable lookup</li>
3632
</ol>
3633
<p>Tokens are persisted to <code>~/.planopticon/</code> and automatically refreshed on expiry.</p>
3634
<hr />
3635
<h2 id="authconfig">AuthConfig<a class="headerlink" href="#authconfig" title="Permanent link">&para;</a></h2>
3636
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.auth</span><span class="w"> </span><span class="kn">import</span> <span class="n">AuthConfig</span>
3637
</code></pre></div>
3638
<p>Dataclass configuring authentication for a specific service. Defines OAuth endpoints, client credentials, API key fallback, scopes, and token storage.</p>
3639
<h3 id="fields">Fields<a class="headerlink" href="#fields" title="Permanent link">&para;</a></h3>
3640
<table>
3641
<thead>
3642
<tr>
3643
<th>Field</th>
3644
<th>Type</th>
3645
<th>Default</th>
3646
<th>Description</th>
3647
</tr>
3648
</thead>
3649
<tbody>
3650
<tr>
3651
<td><code>service</code></td>
3652
<td><code>str</code></td>
3653
<td><em>required</em></td>
3654
<td>Service identifier (e.g., <code>"zoom"</code>, <code>"notion"</code>)</td>
3655
</tr>
3656
<tr>
3657
<td><code>oauth_authorize_url</code></td>
3658
<td><code>Optional[str]</code></td>
3659
<td><code>None</code></td>
3660
<td>OAuth authorization endpoint URL</td>
3661
</tr>
3662
<tr>
3663
<td><code>oauth_token_url</code></td>
3664
<td><code>Optional[str]</code></td>
3665
<td><code>None</code></td>
3666
<td>OAuth token exchange endpoint URL</td>
3667
</tr>
3668
<tr>
3669
<td><code>client_id</code></td>
3670
<td><code>Optional[str]</code></td>
3671
<td><code>None</code></td>
3672
<td>OAuth client ID (direct value)</td>
3673
</tr>
3674
<tr>
3675
<td><code>client_secret</code></td>
3676
<td><code>Optional[str]</code></td>
3677
<td><code>None</code></td>
3678
<td>OAuth client secret (direct value)</td>
3679
</tr>
3680
<tr>
3681
<td><code>client_id_env</code></td>
3682
<td><code>Optional[str]</code></td>
3683
<td><code>None</code></td>
3684
<td>Environment variable for client ID</td>
3685
</tr>
3686
<tr>
3687
<td><code>client_secret_env</code></td>
3688
<td><code>Optional[str]</code></td>
3689
<td><code>None</code></td>
3690
<td>Environment variable for client secret</td>
3691
</tr>
3692
<tr>
3693
<td><code>api_key_env</code></td>
3694
<td><code>Optional[str]</code></td>
3695
<td><code>None</code></td>
3696
<td>Environment variable for API key fallback</td>
3697
</tr>
3698
<tr>
3699
<td><code>scopes</code></td>
3700
<td><code>List[str]</code></td>
3701
<td><code>[]</code></td>
3702
<td>OAuth scopes to request</td>
3703
</tr>
3704
<tr>
3705
<td><code>redirect_uri</code></td>
3706
<td><code>str</code></td>
3707
<td><code>"urn:ietf:wg:oauth:2.0:oob"</code></td>
3708
<td>Redirect URI for auth code flow</td>
3709
</tr>
3710
<tr>
3711
<td><code>account_id</code></td>
3712
<td><code>Optional[str]</code></td>
3713
<td><code>None</code></td>
3714
<td>Account ID for client credentials grant (direct value)</td>
3715
</tr>
3716
<tr>
3717
<td><code>account_id_env</code></td>
3718
<td><code>Optional[str]</code></td>
3719
<td><code>None</code></td>
3720
<td>Environment variable for account ID</td>
3721
</tr>
3722
<tr>
3723
<td><code>token_path</code></td>
3724
<td><code>Optional[Path]</code></td>
3725
<td><code>None</code></td>
3726
<td>Custom token storage path</td>
3727
</tr>
3728
</tbody>
3729
</table>
3730
<h3 id="resolved-properties">Resolved Properties<a class="headerlink" href="#resolved-properties" title="Permanent link">&para;</a></h3>
3731
<p>These properties resolve values by checking the direct field first, then falling back to the environment variable.</p>
3732
<table>
3733
<thead>
3734
<tr>
3735
<th>Property</th>
3736
<th>Return Type</th>
3737
<th>Description</th>
3738
</tr>
3739
</thead>
3740
<tbody>
3741
<tr>
3742
<td><code>resolved_client_id</code></td>
3743
<td><code>Optional[str]</code></td>
3744
<td>Client ID from <code>client_id</code> or <code>os.environ[client_id_env]</code></td>
3745
</tr>
3746
<tr>
3747
<td><code>resolved_client_secret</code></td>
3748
<td><code>Optional[str]</code></td>
3749
<td>Client secret from <code>client_secret</code> or <code>os.environ[client_secret_env]</code></td>
3750
</tr>
3751
<tr>
3752
<td><code>resolved_api_key</code></td>
3753
<td><code>Optional[str]</code></td>
3754
<td>API key from <code>os.environ[api_key_env]</code></td>
3755
</tr>
3756
<tr>
3757
<td><code>resolved_account_id</code></td>
3758
<td><code>Optional[str]</code></td>
3759
<td>Account ID from <code>account_id</code> or <code>os.environ[account_id_env]</code></td>
3760
</tr>
3761
<tr>
3762
<td><code>resolved_token_path</code></td>
3763
<td><code>Path</code></td>
3764
<td>Token file path: <code>token_path</code> or <code>~/.planopticon/{service}_token.json</code></td>
3765
</tr>
3766
<tr>
3767
<td><code>supports_oauth</code></td>
3768
<td><code>bool</code></td>
3769
<td><code>True</code> if both <code>oauth_authorize_url</code> and <code>oauth_token_url</code> are set</td>
3770
</tr>
3771
</tbody>
3772
</table>
3773
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.auth</span><span class="w"> </span><span class="kn">import</span> <span class="n">AuthConfig</span>
3774
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>
3775
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="n">config</span> <span class="o">=</span> <span class="n">AuthConfig</span><span class="p">(</span>
3776
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a> <span class="n">service</span><span class="o">=</span><span class="s2">&quot;notion&quot;</span><span class="p">,</span>
3777
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a> <span class="n">oauth_authorize_url</span><span class="o">=</span><span class="s2">&quot;https://api.notion.com/v1/oauth/authorize&quot;</span><span class="p">,</span>
3778
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a> <span class="n">oauth_token_url</span><span class="o">=</span><span class="s2">&quot;https://api.notion.com/v1/oauth/token&quot;</span><span class="p">,</span>
3779
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a> <span class="n">client_id_env</span><span class="o">=</span><span class="s2">&quot;NOTION_CLIENT_ID&quot;</span><span class="p">,</span>
3780
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a> <span class="n">client_secret_env</span><span class="o">=</span><span class="s2">&quot;NOTION_CLIENT_SECRET&quot;</span><span class="p">,</span>
3781
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a> <span class="n">api_key_env</span><span class="o">=</span><span class="s2">&quot;NOTION_API_KEY&quot;</span><span class="p">,</span>
3782
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a> <span class="n">scopes</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;read_content&quot;</span><span class="p">],</span>
3783
<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="p">)</span>
3784
<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a>
3785
<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a><span class="c1"># Check resolved values</span>
3786
<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a><span class="nb">print</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_client_id</span><span class="p">)</span> <span class="c1"># From NOTION_CLIENT_ID env var</span>
3787
<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a><span class="nb">print</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">supports_oauth</span><span class="p">)</span> <span class="c1"># True</span>
3788
<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a><span class="nb">print</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">resolved_token_path</span><span class="p">)</span> <span class="c1"># ~/.planopticon/notion_token.json</span>
3789
</code></pre></div>
3790
<hr />
3791
<h2 id="authresult">AuthResult<a class="headerlink" href="#authresult" title="Permanent link">&para;</a></h2>
3792
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.auth</span><span class="w"> </span><span class="kn">import</span> <span class="n">AuthResult</span>
3793
</code></pre></div>
3794
<p>Dataclass representing the result of an authentication attempt.</p>
3795
<table>
3796
<thead>
3797
<tr>
3798
<th>Field</th>
3799
<th>Type</th>
3800
<th>Default</th>
3801
<th>Description</th>
3802
</tr>
3803
</thead>
3804
<tbody>
3805
<tr>
3806
<td><code>success</code></td>
3807
<td><code>bool</code></td>
3808
<td><em>required</em></td>
3809
<td>Whether authentication succeeded</td>
3810
</tr>
3811
<tr>
3812
<td><code>access_token</code></td>
3813
<td><code>Optional[str]</code></td>
3814
<td><code>None</code></td>
3815
<td>The access token (if successful)</td>
3816
</tr>
3817
<tr>
3818
<td><code>method</code></td>
3819
<td><code>Optional[str]</code></td>
3820
<td><code>None</code></td>
3821
<td>Auth method used: <code>"saved_token"</code>, <code>"oauth_pkce"</code>, <code>"client_credentials"</code>, <code>"api_key"</code></td>
3822
</tr>
3823
<tr>
3824
<td><code>expires_at</code></td>
3825
<td><code>Optional[float]</code></td>
3826
<td><code>None</code></td>
3827
<td>Token expiration as Unix timestamp</td>
3828
</tr>
3829
<tr>
3830
<td><code>refresh_token</code></td>
3831
<td><code>Optional[str]</code></td>
3832
<td><code>None</code></td>
3833
<td>OAuth refresh token (if available)</td>
3834
</tr>
3835
<tr>
3836
<td><code>error</code></td>
3837
<td><code>Optional[str]</code></td>
3838
<td><code>None</code></td>
3839
<td>Error message (if failed)</td>
3840
</tr>
3841
</tbody>
3842
</table>
3843
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="n">result</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">authenticate</span><span class="p">()</span>
3844
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">success</span><span class="p">:</span>
3845
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Authenticated via </span><span class="si">{</span><span class="n">result</span><span class="o">.</span><span class="n">method</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
3846
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Token: </span><span class="si">{</span><span class="n">result</span><span class="o">.</span><span class="n">access_token</span><span class="p">[:</span><span class="mi">20</span><span class="p">]</span><span class="si">}</span><span class="s2">...&quot;</span><span class="p">)</span>
3847
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a> <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">expires_at</span><span class="p">:</span>
3848
<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a> <span class="kn">import</span><span class="w"> </span><span class="nn">time</span>
3849
<a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a> <span class="n">remaining</span> <span class="o">=</span> <span class="n">result</span><span class="o">.</span><span class="n">expires_at</span> <span class="o">-</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
3850
<a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Expires in </span><span class="si">{</span><span class="n">remaining</span><span class="o">/</span><span class="mi">60</span><span class="si">:</span><span class="s2">.0f</span><span class="si">}</span><span class="s2"> minutes&quot;</span><span class="p">)</span>
3851
<a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a><span class="k">else</span><span class="p">:</span>
3852
<a id="__codelineno-3-10" name="__codelineno-3-10" href="#__codelineno-3-10"></a> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Auth failed: </span><span class="si">{</span><span class="n">result</span><span class="o">.</span><span class="n">error</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
3853
</code></pre></div>
3854
<hr />
3855
<h2 id="oauthmanager">OAuthManager<a class="headerlink" href="#oauthmanager" title="Permanent link">&para;</a></h2>
3856
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.auth</span><span class="w"> </span><span class="kn">import</span> <span class="n">OAuthManager</span>
3857
</code></pre></div>
3858
<p>Manages the full authentication lifecycle for a service. Tries auth methods in priority order and handles token persistence, refresh, and PKCE flow.</p>
3859
<h3 id="constructor">Constructor<a class="headerlink" href="#constructor" title="Permanent link">&para;</a></h3>
3860
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n">AuthConfig</span><span class="p">)</span>
3861
</code></pre></div>
3862
<table>
3863
<thead>
3864
<tr>
3865
<th>Parameter</th>
3866
<th>Type</th>
3867
<th>Description</th>
3868
</tr>
3869
</thead>
3870
<tbody>
3871
<tr>
3872
<td><code>config</code></td>
3873
<td><code>AuthConfig</code></td>
3874
<td>Authentication configuration for the target service</td>
3875
</tr>
3876
</tbody>
3877
</table>
3878
<h3 id="authenticate">authenticate()<a class="headerlink" href="#authenticate" title="Permanent link">&para;</a></h3>
3879
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="k">def</span><span class="w"> </span><span class="nf">authenticate</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">AuthResult</span>
3880
</code></pre></div>
3881
<p>Run the full auth chain and return the result. Methods are tried in order:</p>
3882
<ol>
3883
<li><strong>Saved token</strong> -- checks <code>~/.planopticon/{service}_token.json</code>, refreshes if expired</li>
3884
<li><strong>Client Credentials</strong> -- if <code>account_id</code> is set and OAuth is configured, uses the client credentials grant (server-to-server)</li>
3885
<li><strong>OAuth PKCE</strong> -- if OAuth is configured and client ID is available, opens a browser for interactive authorization with PKCE</li>
3886
<li><strong>API key</strong> -- falls back to the environment variable specified in <code>api_key_env</code></li>
3887
</ol>
3888
<p><strong>Returns:</strong> <code>AuthResult</code> -- success/failure with token and method details.</p>
3889
<p>If all methods fail, returns an <code>AuthResult</code> with <code>success=False</code> and a helpful error message listing which environment variables to set.</p>
3890
<h3 id="get_token">get_token()<a class="headerlink" href="#get_token" title="Permanent link">&para;</a></h3>
3891
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_token</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
3892
</code></pre></div>
3893
<p>Convenience method: run <code>authenticate()</code> and return just the access token string.</p>
3894
<p><strong>Returns:</strong> <code>Optional[str]</code> -- the access token, or <code>None</code> if authentication failed.</p>
3895
<h3 id="clear_token">clear_token()<a class="headerlink" href="#clear_token" title="Permanent link">&para;</a></h3>
3896
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="k">def</span><span class="w"> </span><span class="nf">clear_token</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span>
3897
</code></pre></div>
3898
<p>Remove the saved token file for this service (effectively a logout). The next <code>authenticate()</code> call will require re-authentication.</p>
3899
<hr />
3900
<h2 id="authentication-flows">Authentication Flows<a class="headerlink" href="#authentication-flows" title="Permanent link">&para;</a></h2>
3901
<h3 id="saved-token-auto-refresh">Saved Token (auto-refresh)<a class="headerlink" href="#saved-token-auto-refresh" title="Permanent link">&para;</a></h3>
3902
<p>Tokens are saved to <code>~/.planopticon/{service}_token.json</code> as JSON. On each <code>authenticate()</code> call, the saved token is loaded and checked:</p>
3903
<ul>
3904
<li>If the token has not expired (<code>time.time() &lt; expires_at</code>), it is returned immediately</li>
3905
<li>If expired but a refresh token is available, the manager attempts to refresh using the OAuth token endpoint</li>
3906
<li>The refreshed token is saved back to disk</li>
3907
</ul>
3908
<h3 id="client-credentials-grant">Client Credentials Grant<a class="headerlink" href="#client-credentials-grant" title="Permanent link">&para;</a></h3>
3909
<p>Used for server-to-server authentication (e.g., Zoom Server-to-Server OAuth). Requires <code>account_id</code>, <code>client_id</code>, and <code>client_secret</code>. Sends a POST to the token endpoint with <code>grant_type=account_credentials</code>.</p>
3910
<h3 id="oauth-20-authorization-code-with-pkce">OAuth 2.0 Authorization Code with PKCE<a class="headerlink" href="#oauth-20-authorization-code-with-pkce" title="Permanent link">&para;</a></h3>
3911
<p>Interactive flow for user authentication:</p>
3912
<ol>
3913
<li>Generates a PKCE code verifier and S256 challenge</li>
3914
<li>Constructs the authorization URL with client ID, redirect URI, scopes, and PKCE challenge</li>
3915
<li>Opens the URL in the user's browser</li>
3916
<li>Prompts the user to paste the authorization code</li>
3917
<li>Exchanges the code for tokens at the token endpoint</li>
3918
<li>Saves the tokens to disk</li>
3919
</ol>
3920
<h3 id="api-key-fallback">API Key Fallback<a class="headerlink" href="#api-key-fallback" title="Permanent link">&para;</a></h3>
3921
<p>If no OAuth flow succeeds, falls back to checking the environment variable specified in <code>api_key_env</code>. Returns the value directly as the access token.</p>
3922
<hr />
3923
<h2 id="known_configs">KNOWN_CONFIGS<a class="headerlink" href="#known_configs" title="Permanent link">&para;</a></h2>
3924
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.auth</span><span class="w"> </span><span class="kn">import</span> <span class="n">KNOWN_CONFIGS</span>
3925
</code></pre></div>
3926
<p>Pre-built <code>AuthConfig</code> instances for supported services. These cover the most common cloud integrations and can be used directly or as templates for custom configurations.</p>
3927
<table>
3928
<thead>
3929
<tr>
3930
<th>Service Key</th>
3931
<th>Service</th>
3932
<th>OAuth Endpoints</th>
3933
<th>Client ID Env</th>
3934
<th>API Key Env</th>
3935
</tr>
3936
</thead>
3937
<tbody>
3938
<tr>
3939
<td><code>"zoom"</code></td>
3940
<td>Zoom</td>
3941
<td><code>zoom.us/oauth/...</code></td>
3942
<td><code>ZOOM_CLIENT_ID</code></td>
3943
<td>--</td>
3944
</tr>
3945
<tr>
3946
<td><code>"notion"</code></td>
3947
<td>Notion</td>
3948
<td><code>api.notion.com/v1/oauth/...</code></td>
3949
<td><code>NOTION_CLIENT_ID</code></td>
3950
<td><code>NOTION_API_KEY</code></td>
3951
</tr>
3952
<tr>
3953
<td><code>"dropbox"</code></td>
3954
<td>Dropbox</td>
3955
<td><code>dropbox.com/oauth2/...</code></td>
3956
<td><code>DROPBOX_APP_KEY</code></td>
3957
<td><code>DROPBOX_ACCESS_TOKEN</code></td>
3958
</tr>
3959
<tr>
3960
<td><code>"github"</code></td>
3961
<td>GitHub</td>
3962
<td><code>github.com/login/oauth/...</code></td>
3963
<td><code>GITHUB_CLIENT_ID</code></td>
3964
<td><code>GITHUB_TOKEN</code></td>
3965
</tr>
3966
<tr>
3967
<td><code>"google"</code></td>
3968
<td>Google</td>
3969
<td><code>accounts.google.com/o/oauth2/...</code></td>
3970
<td><code>GOOGLE_CLIENT_ID</code></td>
3971
<td><code>GOOGLE_API_KEY</code></td>
3972
</tr>
3973
<tr>
3974
<td><code>"microsoft"</code></td>
3975
<td>Microsoft</td>
3976
<td><code>login.microsoftonline.com/.../oauth2/...</code></td>
3977
<td><code>MICROSOFT_CLIENT_ID</code></td>
3978
<td>--</td>
3979
</tr>
3980
</tbody>
3981
</table>
3982
<h3 id="zoom">Zoom<a class="headerlink" href="#zoom" title="Permanent link">&para;</a></h3>
3983
<p>Supports both Server-to-Server (via <code>ZOOM_ACCOUNT_ID</code>) and OAuth PKCE flows.</p>
3984
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="c1"># Server-to-Server</span>
3985
<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="nb">export</span><span class="w"> </span><span class="nv">ZOOM_CLIENT_ID</span><span class="o">=</span><span class="s2">&quot;...&quot;</span>
3986
<a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a><span class="nb">export</span><span class="w"> </span><span class="nv">ZOOM_CLIENT_SECRET</span><span class="o">=</span><span class="s2">&quot;...&quot;</span>
3987
<a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a><span class="nb">export</span><span class="w"> </span><span class="nv">ZOOM_ACCOUNT_ID</span><span class="o">=</span><span class="s2">&quot;...&quot;</span>
3988
<a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a>
3989
<a id="__codelineno-10-6" name="__codelineno-10-6" href="#__codelineno-10-6"></a><span class="c1"># Or interactive OAuth (omit ZOOM_ACCOUNT_ID)</span>
3990
<a id="__codelineno-10-7" name="__codelineno-10-7" href="#__codelineno-10-7"></a><span class="nb">export</span><span class="w"> </span><span class="nv">ZOOM_CLIENT_ID</span><span class="o">=</span><span class="s2">&quot;...&quot;</span>
3991
<a id="__codelineno-10-8" name="__codelineno-10-8" href="#__codelineno-10-8"></a><span class="nb">export</span><span class="w"> </span><span class="nv">ZOOM_CLIENT_SECRET</span><span class="o">=</span><span class="s2">&quot;...&quot;</span>
3992
</code></pre></div>
3993
<h3 id="google-drive-meet-workspace">Google (Drive, Meet, Workspace)<a class="headerlink" href="#google-drive-meet-workspace" title="Permanent link">&para;</a></h3>
3994
<p>Supports OAuth PKCE and API key fallback. Scopes include Drive and Docs read-only access.</p>
3995
<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a><span class="nb">export</span><span class="w"> </span><span class="nv">GOOGLE_CLIENT_ID</span><span class="o">=</span><span class="s2">&quot;...&quot;</span>
3996
<a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a><span class="nb">export</span><span class="w"> </span><span class="nv">GOOGLE_CLIENT_SECRET</span><span class="o">=</span><span class="s2">&quot;...&quot;</span>
3997
<a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a><span class="c1"># Or for API-key-only access:</span>
3998
<a id="__codelineno-11-4" name="__codelineno-11-4" href="#__codelineno-11-4"></a><span class="nb">export</span><span class="w"> </span><span class="nv">GOOGLE_API_KEY</span><span class="o">=</span><span class="s2">&quot;...&quot;</span>
3999
</code></pre></div>
4000
<h3 id="github">GitHub<a class="headerlink" href="#github" title="Permanent link">&para;</a></h3>
4001
<p>Supports OAuth PKCE and personal access token. Requests <code>repo</code> and <code>read:org</code> scopes.</p>
4002
<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="c1"># OAuth</span>
4003
<a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a><span class="nb">export</span><span class="w"> </span><span class="nv">GITHUB_CLIENT_ID</span><span class="o">=</span><span class="s2">&quot;...&quot;</span>
4004
<a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a><span class="nb">export</span><span class="w"> </span><span class="nv">GITHUB_CLIENT_SECRET</span><span class="o">=</span><span class="s2">&quot;...&quot;</span>
4005
<a id="__codelineno-12-4" name="__codelineno-12-4" href="#__codelineno-12-4"></a><span class="c1"># Or personal access token</span>
4006
<a id="__codelineno-12-5" name="__codelineno-12-5" href="#__codelineno-12-5"></a><span class="nb">export</span><span class="w"> </span><span class="nv">GITHUB_TOKEN</span><span class="o">=</span><span class="s2">&quot;ghp_...&quot;</span>
4007
</code></pre></div>
4008
<hr />
4009
<h2 id="helper-functions">Helper Functions<a class="headerlink" href="#helper-functions" title="Permanent link">&para;</a></h2>
4010
<h3 id="get_auth_config">get_auth_config()<a class="headerlink" href="#get_auth_config" title="Permanent link">&para;</a></h3>
4011
<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_auth_config</span><span class="p">(</span><span class="n">service</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">AuthConfig</span><span class="p">]</span>
4012
</code></pre></div>
4013
<p>Get a pre-built <code>AuthConfig</code> for a known service.</p>
4014
<p><strong>Parameters:</strong></p>
4015
<table>
4016
<thead>
4017
<tr>
4018
<th>Parameter</th>
4019
<th>Type</th>
4020
<th>Description</th>
4021
</tr>
4022
</thead>
4023
<tbody>
4024
<tr>
4025
<td><code>service</code></td>
4026
<td><code>str</code></td>
4027
<td>Service name (e.g., <code>"zoom"</code>, <code>"notion"</code>, <code>"github"</code>)</td>
4028
</tr>
4029
</tbody>
4030
</table>
4031
<p><strong>Returns:</strong> <code>Optional[AuthConfig]</code> -- the config, or <code>None</code> if the service is not in <code>KNOWN_CONFIGS</code>.</p>
4032
<h3 id="get_auth_manager">get_auth_manager()<a class="headerlink" href="#get_auth_manager" title="Permanent link">&para;</a></h3>
4033
<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a><span class="k">def</span><span class="w"> </span><span class="nf">get_auth_manager</span><span class="p">(</span><span class="n">service</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">OAuthManager</span><span class="p">]</span>
4034
</code></pre></div>
4035
<p>Get an <code>OAuthManager</code> for a known service. Convenience wrapper that looks up the config and creates the manager in one call.</p>
4036
<p><strong>Returns:</strong> <code>Optional[OAuthManager]</code> -- the manager, or <code>None</code> if the service is not known.</p>
4037
<hr />
4038
<h2 id="usage-examples">Usage Examples<a class="headerlink" href="#usage-examples" title="Permanent link">&para;</a></h2>
4039
<h3 id="quick-authentication-for-a-known-service">Quick authentication for a known service<a class="headerlink" href="#quick-authentication-for-a-known-service" title="Permanent link">&para;</a></h3>
4040
<div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.auth</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_auth_manager</span>
4041
<a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a>
4042
<a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a><span class="n">manager</span> <span class="o">=</span> <span class="n">get_auth_manager</span><span class="p">(</span><span class="s2">&quot;zoom&quot;</span><span class="p">)</span>
4043
<a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a><span class="k">if</span> <span class="n">manager</span><span class="p">:</span>
4044
<a id="__codelineno-15-5" name="__codelineno-15-5" href="#__codelineno-15-5"></a> <span class="n">result</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">authenticate</span><span class="p">()</span>
4045
<a id="__codelineno-15-6" name="__codelineno-15-6" href="#__codelineno-15-6"></a> <span class="k">if</span> <span class="n">result</span><span class="o">.</span><span class="n">success</span><span class="p">:</span>
4046
<a id="__codelineno-15-7" name="__codelineno-15-7" href="#__codelineno-15-7"></a> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Authenticated via </span><span class="si">{</span><span class="n">result</span><span class="o">.</span><span class="n">method</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
4047
<a id="__codelineno-15-8" name="__codelineno-15-8" href="#__codelineno-15-8"></a> <span class="c1"># Use result.access_token for API calls</span>
4048
<a id="__codelineno-15-9" name="__codelineno-15-9" href="#__codelineno-15-9"></a> <span class="k">else</span><span class="p">:</span>
4049
<a id="__codelineno-15-10" name="__codelineno-15-10" href="#__codelineno-15-10"></a> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Failed: </span><span class="si">{</span><span class="n">result</span><span class="o">.</span><span class="n">error</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
4050
</code></pre></div>
4051
<h3 id="custom-service-configuration">Custom service configuration<a class="headerlink" href="#custom-service-configuration" title="Permanent link">&para;</a></h3>
4052
<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.auth</span><span class="w"> </span><span class="kn">import</span> <span class="n">AuthConfig</span><span class="p">,</span> <span class="n">OAuthManager</span>
4053
<a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a>
4054
<a id="__codelineno-16-3" name="__codelineno-16-3" href="#__codelineno-16-3"></a><span class="n">config</span> <span class="o">=</span> <span class="n">AuthConfig</span><span class="p">(</span>
4055
<a id="__codelineno-16-4" name="__codelineno-16-4" href="#__codelineno-16-4"></a> <span class="n">service</span><span class="o">=</span><span class="s2">&quot;my_service&quot;</span><span class="p">,</span>
4056
<a id="__codelineno-16-5" name="__codelineno-16-5" href="#__codelineno-16-5"></a> <span class="n">oauth_authorize_url</span><span class="o">=</span><span class="s2">&quot;https://my-service.com/oauth/authorize&quot;</span><span class="p">,</span>
4057
<a id="__codelineno-16-6" name="__codelineno-16-6" href="#__codelineno-16-6"></a> <span class="n">oauth_token_url</span><span class="o">=</span><span class="s2">&quot;https://my-service.com/oauth/token&quot;</span><span class="p">,</span>
4058
<a id="__codelineno-16-7" name="__codelineno-16-7" href="#__codelineno-16-7"></a> <span class="n">client_id_env</span><span class="o">=</span><span class="s2">&quot;MY_SERVICE_CLIENT_ID&quot;</span><span class="p">,</span>
4059
<a id="__codelineno-16-8" name="__codelineno-16-8" href="#__codelineno-16-8"></a> <span class="n">client_secret_env</span><span class="o">=</span><span class="s2">&quot;MY_SERVICE_CLIENT_SECRET&quot;</span><span class="p">,</span>
4060
<a id="__codelineno-16-9" name="__codelineno-16-9" href="#__codelineno-16-9"></a> <span class="n">api_key_env</span><span class="o">=</span><span class="s2">&quot;MY_SERVICE_API_KEY&quot;</span><span class="p">,</span>
4061
<a id="__codelineno-16-10" name="__codelineno-16-10" href="#__codelineno-16-10"></a> <span class="n">scopes</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;read&quot;</span><span class="p">,</span> <span class="s2">&quot;write&quot;</span><span class="p">],</span>
4062
<a id="__codelineno-16-11" name="__codelineno-16-11" href="#__codelineno-16-11"></a><span class="p">)</span>
4063
<a id="__codelineno-16-12" name="__codelineno-16-12" href="#__codelineno-16-12"></a>
4064
<a id="__codelineno-16-13" name="__codelineno-16-13" href="#__codelineno-16-13"></a><span class="n">manager</span> <span class="o">=</span> <span class="n">OAuthManager</span><span class="p">(</span><span class="n">config</span><span class="p">)</span>
4065
<a id="__codelineno-16-14" name="__codelineno-16-14" href="#__codelineno-16-14"></a><span class="n">token</span> <span class="o">=</span> <span class="n">manager</span><span class="o">.</span><span class="n">get_token</span><span class="p">()</span> <span class="c1"># Returns str or None</span>
4066
</code></pre></div>
4067
<h3 id="using-auth-in-a-custom-source-connector">Using auth in a custom source connector<a class="headerlink" href="#using-auth-in-a-custom-source-connector" title="Permanent link">&para;</a></h3>
4068
<div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">pathlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Path</span>
4069
<a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a><span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span>
4070
<a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a>
4071
<a id="__codelineno-17-4" name="__codelineno-17-4" href="#__codelineno-17-4"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.auth</span><span class="w"> </span><span class="kn">import</span> <span class="n">OAuthManager</span><span class="p">,</span> <span class="n">AuthConfig</span>
4072
<a id="__codelineno-17-5" name="__codelineno-17-5" href="#__codelineno-17-5"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.sources.base</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseSource</span><span class="p">,</span> <span class="n">SourceFile</span>
4073
<a id="__codelineno-17-6" name="__codelineno-17-6" href="#__codelineno-17-6"></a>
4074
<a id="__codelineno-17-7" name="__codelineno-17-7" href="#__codelineno-17-7"></a><span class="k">class</span><span class="w"> </span><span class="nc">CustomSource</span><span class="p">(</span><span class="n">BaseSource</span><span class="p">):</span>
4075
<a id="__codelineno-17-8" name="__codelineno-17-8" href="#__codelineno-17-8"></a> <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
4076
<a id="__codelineno-17-9" name="__codelineno-17-9" href="#__codelineno-17-9"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_config</span> <span class="o">=</span> <span class="n">AuthConfig</span><span class="p">(</span>
4077
<a id="__codelineno-17-10" name="__codelineno-17-10" href="#__codelineno-17-10"></a> <span class="n">service</span><span class="o">=</span><span class="s2">&quot;custom&quot;</span><span class="p">,</span>
4078
<a id="__codelineno-17-11" name="__codelineno-17-11" href="#__codelineno-17-11"></a> <span class="n">api_key_env</span><span class="o">=</span><span class="s2">&quot;CUSTOM_API_KEY&quot;</span><span class="p">,</span>
4079
<a id="__codelineno-17-12" name="__codelineno-17-12" href="#__codelineno-17-12"></a> <span class="p">)</span>
4080
<a id="__codelineno-17-13" name="__codelineno-17-13" href="#__codelineno-17-13"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_manager</span> <span class="o">=</span> <span class="n">OAuthManager</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_config</span><span class="p">)</span>
4081
<a id="__codelineno-17-14" name="__codelineno-17-14" href="#__codelineno-17-14"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_token</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
4082
<a id="__codelineno-17-15" name="__codelineno-17-15" href="#__codelineno-17-15"></a>
4083
<a id="__codelineno-17-16" name="__codelineno-17-16" href="#__codelineno-17-16"></a> <span class="k">def</span><span class="w"> </span><span class="nf">authenticate</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
4084
<a id="__codelineno-17-17" name="__codelineno-17-17" href="#__codelineno-17-17"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_token</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_manager</span><span class="o">.</span><span class="n">get_token</span><span class="p">()</span>
4085
<a id="__codelineno-17-18" name="__codelineno-17-18" href="#__codelineno-17-18"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_token</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
4086
<a id="__codelineno-17-19" name="__codelineno-17-19" href="#__codelineno-17-19"></a>
4087
<a id="__codelineno-17-20" name="__codelineno-17-20" href="#__codelineno-17-20"></a> <span class="k">def</span><span class="w"> </span><span class="nf">list_videos</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="n">SourceFile</span><span class="p">]:</span>
4088
<a id="__codelineno-17-21" name="__codelineno-17-21" href="#__codelineno-17-21"></a> <span class="c1"># Use self._token to query the API</span>
4089
<a id="__codelineno-17-22" name="__codelineno-17-22" href="#__codelineno-17-22"></a> <span class="o">...</span>
4090
<a id="__codelineno-17-23" name="__codelineno-17-23" href="#__codelineno-17-23"></a>
4091
<a id="__codelineno-17-24" name="__codelineno-17-24" href="#__codelineno-17-24"></a> <span class="k">def</span><span class="w"> </span><span class="nf">download</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file</span><span class="p">:</span> <span class="n">SourceFile</span><span class="p">,</span> <span class="n">destination</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Path</span><span class="p">:</span>
4092
<a id="__codelineno-17-25" name="__codelineno-17-25" href="#__codelineno-17-25"></a> <span class="c1"># Use self._token for authenticated downloads</span>
4093
<a id="__codelineno-17-26" name="__codelineno-17-26" href="#__codelineno-17-26"></a> <span class="o">...</span>
4094
</code></pre></div>
4095
<h3 id="logout-clear-saved-token">Logout / clear saved token<a class="headerlink" href="#logout-clear-saved-token" title="Permanent link">&para;</a></h3>
4096
<div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a><span class="kn">from</span><span class="w"> </span><span class="nn">video_processor.auth</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_auth_manager</span>
4097
<a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a>
4098
<a id="__codelineno-18-3" name="__codelineno-18-3" href="#__codelineno-18-3"></a><span class="n">manager</span> <span class="o">=</span> <span class="n">get_auth_manager</span><span class="p">(</span><span class="s2">&quot;zoom&quot;</span><span class="p">)</span>
4099
<a id="__codelineno-18-4" name="__codelineno-18-4" href="#__codelineno-18-4"></a><span class="k">if</span> <span class="n">manager</span><span class="p">:</span>
4100
<a id="__codelineno-18-5" name="__codelineno-18-5" href="#__codelineno-18-5"></a> <span class="n">manager</span><span class="o">.</span><span class="n">clear_token</span><span class="p">()</span>
4101
<a id="__codelineno-18-6" name="__codelineno-18-6" href="#__codelineno-18-6"></a> <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Zoom token cleared&quot;</span><span class="p">)</span>
4102
</code></pre></div>
4103
<h3 id="token-storage-location">Token storage location<a class="headerlink" href="#token-storage-location" title="Permanent link">&para;</a></h3>
4104
<p>All tokens are stored under <code>~/.planopticon/</code>:</p>
4105
<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a>~/.planopticon/
4106
<a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a> zoom_token.json
4107
<a id="__codelineno-19-3" name="__codelineno-19-3" href="#__codelineno-19-3"></a> notion_token.json
4108
<a id="__codelineno-19-4" name="__codelineno-19-4" href="#__codelineno-19-4"></a> github_token.json
4109
<a id="__codelineno-19-5" name="__codelineno-19-5" href="#__codelineno-19-5"></a> google_token.json
4110
<a id="__codelineno-19-6" name="__codelineno-19-6" href="#__codelineno-19-6"></a> microsoft_token.json
4111
<a id="__codelineno-19-7" name="__codelineno-19-7" href="#__codelineno-19-7"></a> dropbox_token.json
4112
</code></pre></div>
4113
<p>Each file contains a JSON object with <code>access_token</code>, <code>refresh_token</code> (if applicable), <code>expires_at</code>, and client credentials for refresh.</p>
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
</article>
4128
</div>
4129
4130
4131
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
4132
4133
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
4134
</div>
4135
4136
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
4137
4138
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
4139
Back to top
4140
</button>
4141
4142
</main>
4143
4144
<footer class="md-footer">
4145
4146
<div class="md-footer-meta md-typeset">
4147
<div class="md-footer-meta__inner md-grid">
4148
<div class="md-copyright">
4149
4150
<div class="md-copyright__highlight">
4151
Copyright &copy; 2026 CONFLICT LLC
4152
</div>
4153
4154
4155
Made with
4156
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
4157
Material for MkDocs
4158
</a>
4159
4160
</div>
4161
4162
4163
<div class="md-social">
4164
4165
4166
4167
4168
4169
4170
4171
4172
<a href="https://github.com/ConflictHQ/PlanOpticon" target="_blank" rel="noopener" title="github.com" class="md-social__link">
4173
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
4174
</a>
4175
4176
</div>
4177
4178
</div>
4179
</div>
4180
</footer>
4181
4182
</div>
4183
<div class="md-dialog" data-md-component="dialog">
4184
<div class="md-dialog__inner md-typeset"></div>
4185
</div>
4186
4187
4188
4189
4190
4191
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.instant", "navigation.tabs", "navigation.sections", "navigation.expand", "navigation.top", "search.suggest", "search.highlight", "content.code.copy", "content.tabs.link", "header.autohide"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
4192
4193
4194
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
4195
4196
4197
</body>
4198
</html>

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button