-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathauth.html
More file actions
928 lines (855 loc) · 43.6 KB
/
auth.html
File metadata and controls
928 lines (855 loc) · 43.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.1">
<title>src.synmetrix_python_client.auth API documentation</title>
<meta name="description" content="">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
})</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>src.synmetrix_python_client.auth</code></h1>
</header>
<section id="section-intro">
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="src.synmetrix_python_client.auth.get_default_logger"><code class="name flex">
<span>def <span class="ident">get_default_logger</span></span>(<span>) ‑> logging.Logger</span>
</code></dt>
<dd>
<div class="desc"><p>Create a default logger with standard configuration.</p>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>logging.Logger</code></dt>
<dd>Configured logger instance with standard formatting</dd>
</dl></div>
</dd>
</dl>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="src.synmetrix_python_client.auth.AuthClient"><code class="flex name class">
<span>class <span class="ident">AuthClient</span></span>
<span>(</span><span>base_url: str, logger: Optional[logging.Logger] = None)</span>
</code></dt>
<dd>
<div class="desc"><p>Client for handling authentication operations.</p>
<p>This client provides methods for user authentication, token management,
and session handling.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>base_url</code></strong> : <code>str</code></dt>
<dd>Base URL of the authentication service</dd>
<dt><strong><code>logger</code></strong> : <code>Optional[logging.Logger]</code></dt>
<dd>Custom logger instance</dd>
</dl>
<h2 id="attributes">Attributes</h2>
<dl>
<dt><strong><code>base_url</code></strong> : <code>str</code></dt>
<dd>Base URL of the authentication service</dd>
<dt><strong><code>_access_token</code></strong> : <code>Optional[str]</code></dt>
<dd>Current JWT access token</dd>
<dt><strong><code>_refresh_token</code></strong> : <code>Optional[str]</code></dt>
<dd>Current refresh token</dd>
<dt><strong><code>_logger</code></strong> : <code>logging.Logger</code></dt>
<dd>Logger instance</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class AuthClient:
"""Client for handling authentication operations.
This client provides methods for user authentication, token management,
and session handling.
Args:
base_url (str): Base URL of the authentication service
logger (Optional[logging.Logger]): Custom logger instance
Attributes:
base_url (str): Base URL of the authentication service
_access_token (Optional[str]): Current JWT access token
_refresh_token (Optional[str]): Current refresh token
_logger (logging.Logger): Logger instance
"""
def __init__(
self,
base_url: str,
logger: Optional[logging.Logger] = None,
):
self.base_url = base_url.rstrip("/")
self._access_token: Optional[str] = None
self._refresh_token: Optional[str] = None
self._logger = logger or get_default_logger()
self._logger.debug("Initialized AuthClient with base URL: %s", base_url)
@property
def auth_headers(self) -> dict[str, str]:
"""Get authorization headers using current access token.
Returns:
dict[str, str]: Headers dictionary with Authorization if token exists
"""
if not self._access_token:
return {}
return {"Authorization": f"Bearer {self._access_token}"}
@staticmethod
def parse_access_token(access_token: str) -> dict[str, Any]:
jwt_payload = jwt.decode(access_token, options={"verify_signature": False})
hasura_payload = jwt_payload.get("hasura", {})
user_id = hasura_payload.get("x-hasura-user-id")
allowed_roles = hasura_payload.get("allowed_roles", [])
default_role = hasura_payload.get("default_role")
return {
"user_id": user_id,
"access_token_expires_at": jwt_payload["exp"],
"allowed_roles": allowed_roles,
"default_role": default_role,
}
async def _validate_response(self, response: httpx.Response) -> dict[str, Any]:
"""Validate and parse response."""
try:
# First try to get JSON data
data = response.text
self._logger.debug("Response data: %s", data)
# For successful responses (2xx)
if 200 <= response.status_code < 300:
self._logger.debug(
"Successful response with status %d",
response.status_code,
)
if response.status_code == 204:
return {}
try:
return json.loads(data)
except json.JSONDecodeError as e:
self._logger.error("JSON decode error: %s", str(e), exc_info=True)
raise AuthError(
message=data,
error="invalid_response",
status_code=response.status_code,
) from e
else:
self._logger.error("HTTP error response: %s", data)
raise AuthError(
message=data,
error="http_error",
status_code=response.status_code,
)
except httpx.HTTPError as e:
# For HTTP protocol errors
self._logger.error("HTTP protocol error: %s", str(e), exc_info=True)
raise e from e
except ValueError as e:
# For JSON decode errors
self._logger.error("JSON decode error: %s", str(e), exc_info=True)
raise AuthError(
message=str(e),
error="invalid_response",
status_code=response.status_code,
) from e
except Exception as e:
# For any other errors
self._logger.error("Unexpected error: %s", str(e), exc_info=True)
raise e from e
async def login(
self, email: str, password: str, cookie: bool = False
) -> AuthTokens:
"""Authenticate user with email and password.
Args:
email (str): User's email address
password (str): User's password
cookie (bool, optional): Whether to set auth cookie. Defaults to False.
Returns:
AuthTokens: Access and refresh tokens
Raises:
AuthError: If authentication fails
Example:
```python
client = AuthClient("https://app.synmetrix.org")
tokens = await client.login(email="user@example.com", password="your_password")
print(f"Access token: {tokens.access_token}")
```
"""
self._logger.info("Attempting login for user: %s", email)
try:
async with httpx.AsyncClient() as client:
response = await client.post(
f"{self.base_url}/auth/login",
json={"email": email, "password": password, "cookie": cookie},
)
data = await self._validate_response(response)
auth_response = AuthResponse(**data)
if auth_response.error:
self._logger.error("Login error: %s", auth_response.error)
raise AuthError(
message=auth_response.message or "",
error=auth_response.error,
status_code=auth_response.statusCode,
)
self._access_token = auth_response.jwt_token
self._refresh_token = auth_response.refresh_token
self._logger.info("Login successful for user: %s", email)
parsed_access_token = AuthClient.parse_access_token(
auth_response.jwt_token
)
return AuthTokens(
access_token=auth_response.jwt_token,
refresh_token=auth_response.refresh_token,
**parsed_access_token,
)
except Exception as e:
if isinstance(e, AuthError):
raise
self._logger.error("Login failed: %s", str(e), exc_info=True)
raise AuthError(
message=f"Login failed: {str(e)}",
error="login_error",
) from e
async def register(
self, email: str, password: str, cookie: bool = False
) -> AuthTokens:
"""Register a new user.
Args:
email (str): User's email address
password (str): User's password
cookie (bool, optional): Whether to set auth cookie. Defaults to False.
Returns:
AuthTokens: Access and refresh tokens
Raises:
AuthError: If registration fails
Example:
```python
client = AuthClient("https://app.synmetrix.org")
tokens = await client.register(
email="user@example.com", password="your_password"
)
print(f"Access token: {tokens.access_token}")
```
"""
async with httpx.AsyncClient() as client:
response = await client.post(
f"{self.base_url}/auth/register",
json={"email": email, "password": password, "cookie": cookie},
)
data = await self._validate_response(response)
auth_response = AuthResponse(**data)
if auth_response.error:
raise AuthError(
message=auth_response.message or "",
error=auth_response.error,
)
self._access_token = auth_response.jwt_token
self._refresh_token = auth_response.refresh_token
parsed_access_token = AuthClient.parse_access_token(auth_response.jwt_token)
return AuthTokens(
access_token=auth_response.jwt_token,
refresh_token=auth_response.refresh_token,
**parsed_access_token,
)
async def logout(self, all_sessions: bool = True) -> None:
"""Log out the current user.
Args:
all_sessions (bool, optional): Logout from all sessions. Defaults to True.
Raises:
AuthError: If not authenticated or logout fails
Example:
```python
client = AuthClient("https://app.synmetrix.org")
await client.logout()
```
"""
if not self._refresh_token or not self._access_token:
raise AuthError("Not authenticated")
async with httpx.AsyncClient() as client:
response = await client.post(
f"{self.base_url}/auth/logout",
params={"refresh_token": self._refresh_token},
headers=self.auth_headers,
json={"all": all_sessions},
)
await self._validate_response(response)
self._access_token = None
self._refresh_token = None
async def refresh_token(self, refresh_token: Optional[str] = None) -> AuthTokens:
"""Refresh access token using refresh token.
Args:
refresh_token (Optional[str], optional): Refresh token to use.
If None, uses stored token. Defaults to None.
Returns:
AuthTokens: New access and refresh tokens
Raises:
AuthError: If refresh fails or no token available
Example:
```python
client = AuthClient("https://app.synmetrix.org")
tokens = await client.refresh_token()
print(f"Access token: {tokens.access_token}")
```
"""
token = refresh_token or self._refresh_token
if not token:
raise AuthError("No refresh token available")
async with httpx.AsyncClient() as client:
response = await client.get(
f"{self.base_url}/auth/token/refresh",
params={"refresh_token": token},
)
data = await self._validate_response(response)
auth_response = AuthResponse(**data)
if auth_response.error:
raise AuthError(
message=auth_response.message or "",
error=auth_response.error,
)
self._access_token = auth_response.jwt_token
self._refresh_token = auth_response.refresh_token
parsed_access_token = AuthClient.parse_access_token(auth_response.jwt_token)
return AuthTokens(
access_token=auth_response.jwt_token,
refresh_token=auth_response.refresh_token,
**parsed_access_token,
)
async def change_password(self, old_password: str, new_password: str) -> None:
"""Change user password.
Args:
old_password (str): Current password
new_password (str): New password
Raises:
AuthError: If not authenticated or password change fails
Example:
```python
client = AuthClient("https://app.synmetrix.org")
await client.change_password(
old_password="old_password", new_password="new_password"
)
```
"""
if not self._access_token:
raise AuthError("Not authenticated")
async with httpx.AsyncClient() as client:
response = await client.post(
f"{self.base_url}/auth/change-password",
headers=self.auth_headers,
json={
"old_password": old_password,
"new_password": new_password,
},
)
await self._validate_response(response)
async def send_magic_link(self, email: str) -> AuthTokens:
"""Send magic link for passwordless authentication.
Args:
email (str): User's email address
Returns:
AuthTokens: Access and refresh tokens after magic link verification
Raises:
AuthError: If magic link sending fails
Example:
```python
client = AuthClient("https://app.synmetrix.org")
tokens = await client.send_magic_link(email="user@example.com")
print(f"Access token: {tokens.access_token}")
```
"""
async with httpx.AsyncClient() as client:
response = await client.post(
f"{self.base_url}/auth/register",
json={"email": email, "cookie": False},
)
data = await self._validate_response(response)
auth_response = AuthResponse(**data)
if auth_response.error:
raise AuthError(
message=auth_response.message or "",
error=auth_response.error,
)
self._access_token = auth_response.jwt_token
self._refresh_token = auth_response.refresh_token
parsed_access_token = AuthClient.parse_access_token(auth_response.jwt_token)
return AuthTokens(
access_token=auth_response.jwt_token,
refresh_token=auth_response.refresh_token,
**parsed_access_token,
)</code></pre>
</details>
<h3>Static methods</h3>
<dl>
<dt id="src.synmetrix_python_client.auth.AuthClient.parse_access_token"><code class="name flex">
<span>def <span class="ident">parse_access_token</span></span>(<span>access_token: str) ‑> dict[str, typing.Any]</span>
</code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
<h3>Instance variables</h3>
<dl>
<dt id="src.synmetrix_python_client.auth.AuthClient.auth_headers"><code class="name">prop <span class="ident">auth_headers</span> : dict[str, str]</code></dt>
<dd>
<div class="desc"><p>Get authorization headers using current access token.</p>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>dict[str, str]</code></dt>
<dd>Headers dictionary with Authorization if token exists</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@property
def auth_headers(self) -> dict[str, str]:
"""Get authorization headers using current access token.
Returns:
dict[str, str]: Headers dictionary with Authorization if token exists
"""
if not self._access_token:
return {}
return {"Authorization": f"Bearer {self._access_token}"}</code></pre>
</details>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="src.synmetrix_python_client.auth.AuthClient.change_password"><code class="name flex">
<span>async def <span class="ident">change_password</span></span>(<span>self, old_password: str, new_password: str) ‑> None</span>
</code></dt>
<dd>
<div class="desc"><p>Change user password.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>old_password</code></strong> : <code>str</code></dt>
<dd>Current password</dd>
<dt><strong><code>new_password</code></strong> : <code>str</code></dt>
<dd>New password</dd>
</dl>
<h2 id="raises">Raises</h2>
<dl>
<dt><code><a title="src.synmetrix_python_client.auth.AuthError" href="#src.synmetrix_python_client.auth.AuthError">AuthError</a></code></dt>
<dd>If not authenticated or password change fails</dd>
</dl>
<h2 id="example">Example</h2>
<pre><code class="language-python">client = AuthClient("https://app.synmetrix.org")
await client.change_password(
old_password="old_password", new_password="new_password"
)
</code></pre></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthClient.login"><code class="name flex">
<span>async def <span class="ident">login</span></span>(<span>self, email: str, password: str, cookie: bool = False) ‑> <a title="src.synmetrix_python_client.auth.AuthTokens" href="#src.synmetrix_python_client.auth.AuthTokens">AuthTokens</a></span>
</code></dt>
<dd>
<div class="desc"><p>Authenticate user with email and password.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>email</code></strong> : <code>str</code></dt>
<dd>User's email address</dd>
<dt><strong><code>password</code></strong> : <code>str</code></dt>
<dd>User's password</dd>
<dt><strong><code>cookie</code></strong> : <code>bool</code>, optional</dt>
<dd>Whether to set auth cookie. Defaults to False.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code><a title="src.synmetrix_python_client.auth.AuthTokens" href="#src.synmetrix_python_client.auth.AuthTokens">AuthTokens</a></code></dt>
<dd>Access and refresh tokens</dd>
</dl>
<h2 id="raises">Raises</h2>
<dl>
<dt><code><a title="src.synmetrix_python_client.auth.AuthError" href="#src.synmetrix_python_client.auth.AuthError">AuthError</a></code></dt>
<dd>If authentication fails</dd>
</dl>
<h2 id="example">Example</h2>
<pre><code class="language-python">client = AuthClient("https://app.synmetrix.org")
tokens = await client.login(email="user@example.com", password="your_password")
print(f"Access token: {tokens.access_token}")
</code></pre></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthClient.logout"><code class="name flex">
<span>async def <span class="ident">logout</span></span>(<span>self, all_sessions: bool = True) ‑> None</span>
</code></dt>
<dd>
<div class="desc"><p>Log out the current user.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>all_sessions</code></strong> : <code>bool</code>, optional</dt>
<dd>Logout from all sessions. Defaults to True.</dd>
</dl>
<h2 id="raises">Raises</h2>
<dl>
<dt><code><a title="src.synmetrix_python_client.auth.AuthError" href="#src.synmetrix_python_client.auth.AuthError">AuthError</a></code></dt>
<dd>If not authenticated or logout fails</dd>
</dl>
<h2 id="example">Example</h2>
<pre><code class="language-python">client = AuthClient("https://app.synmetrix.org")
await client.logout()
</code></pre></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthClient.refresh_token"><code class="name flex">
<span>async def <span class="ident">refresh_token</span></span>(<span>self, refresh_token: Optional[str] = None) ‑> <a title="src.synmetrix_python_client.auth.AuthTokens" href="#src.synmetrix_python_client.auth.AuthTokens">AuthTokens</a></span>
</code></dt>
<dd>
<div class="desc"><p>Refresh access token using refresh token.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>refresh_token</code></strong> : <code>Optional[str]</code>, optional</dt>
<dd>Refresh token to use.
If None, uses stored token. Defaults to None.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code><a title="src.synmetrix_python_client.auth.AuthTokens" href="#src.synmetrix_python_client.auth.AuthTokens">AuthTokens</a></code></dt>
<dd>New access and refresh tokens</dd>
</dl>
<h2 id="raises">Raises</h2>
<dl>
<dt><code><a title="src.synmetrix_python_client.auth.AuthError" href="#src.synmetrix_python_client.auth.AuthError">AuthError</a></code></dt>
<dd>If refresh fails or no token available</dd>
</dl>
<h2 id="example">Example</h2>
<pre><code class="language-python">client = AuthClient("https://app.synmetrix.org")
tokens = await client.refresh_token()
print(f"Access token: {tokens.access_token}")
</code></pre></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthClient.register"><code class="name flex">
<span>async def <span class="ident">register</span></span>(<span>self, email: str, password: str, cookie: bool = False) ‑> <a title="src.synmetrix_python_client.auth.AuthTokens" href="#src.synmetrix_python_client.auth.AuthTokens">AuthTokens</a></span>
</code></dt>
<dd>
<div class="desc"><p>Register a new user.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>email</code></strong> : <code>str</code></dt>
<dd>User's email address</dd>
<dt><strong><code>password</code></strong> : <code>str</code></dt>
<dd>User's password</dd>
<dt><strong><code>cookie</code></strong> : <code>bool</code>, optional</dt>
<dd>Whether to set auth cookie. Defaults to False.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code><a title="src.synmetrix_python_client.auth.AuthTokens" href="#src.synmetrix_python_client.auth.AuthTokens">AuthTokens</a></code></dt>
<dd>Access and refresh tokens</dd>
</dl>
<h2 id="raises">Raises</h2>
<dl>
<dt><code><a title="src.synmetrix_python_client.auth.AuthError" href="#src.synmetrix_python_client.auth.AuthError">AuthError</a></code></dt>
<dd>If registration fails</dd>
</dl>
<h2 id="example">Example</h2>
<pre><code class="language-python">client = AuthClient("https://app.synmetrix.org")
tokens = await client.register(
email="user@example.com", password="your_password"
)
print(f"Access token: {tokens.access_token}")
</code></pre></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthClient.send_magic_link"><code class="name flex">
<span>async def <span class="ident">send_magic_link</span></span>(<span>self, email: str) ‑> <a title="src.synmetrix_python_client.auth.AuthTokens" href="#src.synmetrix_python_client.auth.AuthTokens">AuthTokens</a></span>
</code></dt>
<dd>
<div class="desc"><p>Send magic link for passwordless authentication.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>email</code></strong> : <code>str</code></dt>
<dd>User's email address</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code><a title="src.synmetrix_python_client.auth.AuthTokens" href="#src.synmetrix_python_client.auth.AuthTokens">AuthTokens</a></code></dt>
<dd>Access and refresh tokens after magic link verification</dd>
</dl>
<h2 id="raises">Raises</h2>
<dl>
<dt><code><a title="src.synmetrix_python_client.auth.AuthError" href="#src.synmetrix_python_client.auth.AuthError">AuthError</a></code></dt>
<dd>If magic link sending fails</dd>
</dl>
<h2 id="example">Example</h2>
<pre><code class="language-python">client = AuthClient("https://app.synmetrix.org")
tokens = await client.send_magic_link(email="user@example.com")
print(f"Access token: {tokens.access_token}")
</code></pre></div>
</dd>
</dl>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthError"><code class="flex name class">
<span>class <span class="ident">AuthError</span></span>
<span>(</span><span>message: str, error: Optional[str] = None, status_code: Optional[int] = None)</span>
</code></dt>
<dd>
<div class="desc"><p>Exception raised for authentication-related errors.</p>
<h2 id="attributes">Attributes</h2>
<dl>
<dt><strong><code>message</code></strong> : <code>str</code></dt>
<dd>Human readable error description</dd>
<dt><strong><code>error</code></strong> : <code>Optional[str]</code></dt>
<dd>Error type or code</dd>
<dt><strong><code>status_code</code></strong> : <code>Optional[int]</code></dt>
<dd>HTTP status code if applicable</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class AuthError(Exception):
"""Exception raised for authentication-related errors.
Attributes:
message (str): Human readable error description
error (Optional[str]): Error type or code
status_code (Optional[int]): HTTP status code if applicable
"""
def __init__(
self,
message: str,
error: Optional[str] = None,
status_code: Optional[int] = None,
):
self.message = message
self.error = error
self.status_code = status_code
super().__init__(message)</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li>builtins.Exception</li>
<li>builtins.BaseException</li>
</ul>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthResponse"><code class="flex name class">
<span>class <span class="ident">AuthResponse</span></span>
<span>(</span><span>**data: Any)</span>
</code></dt>
<dd>
<div class="desc"><p>Response model for authentication operations.</p>
<h2 id="attributes">Attributes</h2>
<dl>
<dt><strong><code>jwt_token</code></strong> : <code>str</code></dt>
<dd>JWT access token for API authentication</dd>
<dt><strong><code>refresh_token</code></strong> : <code>str</code></dt>
<dd>Token used to refresh expired JWT tokens</dd>
<dt><strong><code>magicLink</code></strong> : <code>Optional[bool]</code></dt>
<dd>Flag indicating if magic link authentication was used</dd>
<dt><strong><code>error</code></strong> : <code>Optional[str]</code></dt>
<dd>Error message if authentication failed</dd>
<dt><strong><code>message</code></strong> : <code>Optional[str]</code></dt>
<dd>Additional message from the server</dd>
<dt><strong><code>statusCode</code></strong> : <code>Optional[int]</code></dt>
<dd>HTTP status code of the response</dd>
</dl>
<p>Create a new model by parsing and validating input data from keyword arguments.</p>
<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be
validated to form a valid model.</p>
<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class AuthResponse(BaseModel):
"""Response model for authentication operations.
Attributes:
jwt_token (str): JWT access token for API authentication
refresh_token (str): Token used to refresh expired JWT tokens
magicLink (Optional[bool]): Flag indicating if magic link authentication was used
error (Optional[str]): Error message if authentication failed
message (Optional[str]): Additional message from the server
statusCode (Optional[int]): HTTP status code of the response
"""
jwt_token: str
refresh_token: str
magicLink: Optional[bool] = None
error: Optional[str] = None
message: Optional[str] = None
statusCode: Optional[int] = None</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li>pydantic.main.BaseModel</li>
</ul>
<h3>Class variables</h3>
<dl>
<dt id="src.synmetrix_python_client.auth.AuthResponse.error"><code class="name">var <span class="ident">error</span> : Optional[str]</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthResponse.jwt_token"><code class="name">var <span class="ident">jwt_token</span> : str</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthResponse.magicLink"><code class="name">var <span class="ident">magicLink</span> : Optional[bool]</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthResponse.message"><code class="name">var <span class="ident">message</span> : Optional[str]</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthResponse.model_computed_fields"><code class="name">var <span class="ident">model_computed_fields</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthResponse.model_config"><code class="name">var <span class="ident">model_config</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthResponse.model_fields"><code class="name">var <span class="ident">model_fields</span></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthResponse.refresh_token"><code class="name">var <span class="ident">refresh_token</span> : str</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthResponse.statusCode"><code class="name">var <span class="ident">statusCode</span> : Optional[int]</code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthTokens"><code class="flex name class">
<span>class <span class="ident">AuthTokens</span></span>
<span>(</span><span>access_token: str, refresh_token: str, access_token_expires_at: int, user_id: str, allowed_roles: list[str], default_role: str)</span>
</code></dt>
<dd>
<div class="desc"><p>Data class for storing authentication tokens.</p>
<h2 id="attributes">Attributes</h2>
<dl>
<dt><strong><code>access_token</code></strong> : <code>str</code></dt>
<dd>JWT access token for API authentication</dd>
<dt><strong><code>refresh_token</code></strong> : <code>str</code></dt>
<dd>Token used to refresh expired JWT tokens</dd>
<dt><strong><code>access_token_expires_at</code></strong> : <code>int</code></dt>
<dd>Expiration timestamp of the access token</dd>
<dt><strong><code>user_id</code></strong> : <code>str</code></dt>
<dd>User ID associated with the access token</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@dataclass
class AuthTokens:
"""Data class for storing authentication tokens.
Attributes:
access_token (str): JWT access token for API authentication
refresh_token (str): Token used to refresh expired JWT tokens
access_token_expires_at (int): Expiration timestamp of the access token
user_id (str): User ID associated with the access token
"""
access_token: str
refresh_token: str
access_token_expires_at: int
user_id: str
allowed_roles: list[str]
default_role: str</code></pre>
</details>
<h3>Class variables</h3>
<dl>
<dt id="src.synmetrix_python_client.auth.AuthTokens.access_token"><code class="name">var <span class="ident">access_token</span> : str</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthTokens.access_token_expires_at"><code class="name">var <span class="ident">access_token_expires_at</span> : int</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthTokens.allowed_roles"><code class="name">var <span class="ident">allowed_roles</span> : list[str]</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthTokens.default_role"><code class="name">var <span class="ident">default_role</span> : str</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthTokens.refresh_token"><code class="name">var <span class="ident">refresh_token</span> : str</code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt id="src.synmetrix_python_client.auth.AuthTokens.user_id"><code class="name">var <span class="ident">user_id</span> : str</code></dt>
<dd>
<div class="desc"></div>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="src.synmetrix_python_client.auth.get_default_logger" href="#src.synmetrix_python_client.auth.get_default_logger">get_default_logger</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="src.synmetrix_python_client.auth.AuthClient" href="#src.synmetrix_python_client.auth.AuthClient">AuthClient</a></code></h4>
<ul class="two-column">
<li><code><a title="src.synmetrix_python_client.auth.AuthClient.auth_headers" href="#src.synmetrix_python_client.auth.AuthClient.auth_headers">auth_headers</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthClient.change_password" href="#src.synmetrix_python_client.auth.AuthClient.change_password">change_password</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthClient.login" href="#src.synmetrix_python_client.auth.AuthClient.login">login</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthClient.logout" href="#src.synmetrix_python_client.auth.AuthClient.logout">logout</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthClient.parse_access_token" href="#src.synmetrix_python_client.auth.AuthClient.parse_access_token">parse_access_token</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthClient.refresh_token" href="#src.synmetrix_python_client.auth.AuthClient.refresh_token">refresh_token</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthClient.register" href="#src.synmetrix_python_client.auth.AuthClient.register">register</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthClient.send_magic_link" href="#src.synmetrix_python_client.auth.AuthClient.send_magic_link">send_magic_link</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="src.synmetrix_python_client.auth.AuthError" href="#src.synmetrix_python_client.auth.AuthError">AuthError</a></code></h4>
</li>
<li>
<h4><code><a title="src.synmetrix_python_client.auth.AuthResponse" href="#src.synmetrix_python_client.auth.AuthResponse">AuthResponse</a></code></h4>
<ul class="">
<li><code><a title="src.synmetrix_python_client.auth.AuthResponse.error" href="#src.synmetrix_python_client.auth.AuthResponse.error">error</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthResponse.jwt_token" href="#src.synmetrix_python_client.auth.AuthResponse.jwt_token">jwt_token</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthResponse.magicLink" href="#src.synmetrix_python_client.auth.AuthResponse.magicLink">magicLink</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthResponse.message" href="#src.synmetrix_python_client.auth.AuthResponse.message">message</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthResponse.model_computed_fields" href="#src.synmetrix_python_client.auth.AuthResponse.model_computed_fields">model_computed_fields</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthResponse.model_config" href="#src.synmetrix_python_client.auth.AuthResponse.model_config">model_config</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthResponse.model_fields" href="#src.synmetrix_python_client.auth.AuthResponse.model_fields">model_fields</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthResponse.refresh_token" href="#src.synmetrix_python_client.auth.AuthResponse.refresh_token">refresh_token</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthResponse.statusCode" href="#src.synmetrix_python_client.auth.AuthResponse.statusCode">statusCode</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="src.synmetrix_python_client.auth.AuthTokens" href="#src.synmetrix_python_client.auth.AuthTokens">AuthTokens</a></code></h4>
<ul class="">
<li><code><a title="src.synmetrix_python_client.auth.AuthTokens.access_token" href="#src.synmetrix_python_client.auth.AuthTokens.access_token">access_token</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthTokens.access_token_expires_at" href="#src.synmetrix_python_client.auth.AuthTokens.access_token_expires_at">access_token_expires_at</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthTokens.allowed_roles" href="#src.synmetrix_python_client.auth.AuthTokens.allowed_roles">allowed_roles</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthTokens.default_role" href="#src.synmetrix_python_client.auth.AuthTokens.default_role">default_role</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthTokens.refresh_token" href="#src.synmetrix_python_client.auth.AuthTokens.refresh_token">refresh_token</a></code></li>
<li><code><a title="src.synmetrix_python_client.auth.AuthTokens.user_id" href="#src.synmetrix_python_client.auth.AuthTokens.user_id">user_id</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
</footer>
</body>
</html>