{{ message }}
Repository navigation
Expand file tree
/
Copy pathaccount.py
More file actions
2889 lines (2484 loc) · 106 KB
/
Copy pathaccount.py
File metadata and controls
2889 lines (2484 loc) · 106 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
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from ..service import Service
from urllib.parse import quote
from typing import Any, Dict, List, Optional, Union, Type, TypeVar
from ..exception import AppwriteException
from appwrite.utils.deprecated import deprecated
from ..models.user import User
from ..models.oauth2_consent_list import Oauth2ConsentList
from ..models.oauth2_consent import Oauth2Consent
from ..models.oauth2_consent_token_list import Oauth2ConsentTokenList
from ..models.oauth2_consent_token import Oauth2ConsentToken
from ..models.identity_list import IdentityList
from ..models.membership_list import MembershipList
from ..enums.authenticator_type import AuthenticatorType
from ..models.mfa_type import MfaType
from ..enums.authentication_factor import AuthenticationFactor
from ..models.mfa_challenge import MfaChallenge
from ..models.session import Session
from ..models.mfa_factors import MfaFactors
from ..models.mfa_recovery_codes import MfaRecoveryCodes
from ..models.passkey_list import PasskeyList
from ..models.passkey_challenge import PasskeyChallenge
from ..models.passkey import Passkey
from ..models.preferences import Preferences
from ..models.token import Token
from ..models.session_list import SessionList
from ..enums.id_token_provider import IdTokenProvider
from ..enums.o_auth_provider import OAuthProvider
from ..models.token_secret import TokenSecret
T = TypeVar('T')
class Account(Service):
def __init__(self, client) -> None:
super(Account, self).__init__(client)
def get(
self,
model_type: Type[T] = dict,
) -> User[T]:
"""
Get the currently logged in user.
Parameters
----------
model_type : Type[T], optional
Pydantic model class for the user-defined data. Defaults to dict for backward compatibility.
Returns
-------
User[T]
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account'
api_params = {}
response = self.client.call(
'get',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'accept': 'application/json',
},
api_params,
)
return User.with_data(response, model_type)
def create(
self,
user_id: str,
email: str,
password: str,
name: Optional[str] = None,
model_type: Type[T] = dict,
) -> User[T]:
"""
Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession).
Parameters
----------
user_id : str
User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
email : str
User email.
password : str
New user password. Must be between 8 and 256 chars.
name : Optional[str]
User name. Max length: 128 chars.
model_type : Type[T], optional
Pydantic model class for the user-defined data. Defaults to dict for backward compatibility.
Returns
-------
User[T]
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account'
api_params = {}
if user_id is None:
raise AppwriteException('Missing required parameter: "user_id"')
if email is None:
raise AppwriteException('Missing required parameter: "email"')
if password is None:
raise AppwriteException('Missing required parameter: "password"')
api_params['userId'] = self._normalize_value(user_id)
api_params['email'] = self._normalize_value(email)
api_params['password'] = self._normalize_value(password)
if name is not None:
api_params['name'] = self._normalize_value(name)
response = self.client.call(
'post',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'content-type': 'application/json',
'accept': 'application/json',
},
api_params,
)
return User.with_data(response, model_type)
def list_consents(
self,
queries: Optional[List[str]] = None,
total: Optional[bool] = None,
) -> Oauth2ConsentList:
"""
Get a list of the OAuth2 consents the current user has given to third-party apps.
Parameters
----------
queries : Optional[List[str]]
Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
total : Optional[bool]
When set to false, the total count returned will be 0 and will not be calculated.
Returns
-------
Oauth2ConsentList
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/consents'
api_params = {}
if queries is not None:
api_params['queries'] = self._normalize_value(queries)
if total is not None:
api_params['total'] = self._normalize_value(total)
response = self.client.call(
'get',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'accept': 'application/json',
},
api_params,
)
return self._parse_response(response, model=Oauth2ConsentList)
def get_consent(
self,
consent_id: str,
) -> Oauth2Consent:
"""
Get an OAuth2 consent the current user has given to a third-party app by its unique ID.
Parameters
----------
consent_id : str
Consent unique ID.
Returns
-------
Oauth2Consent
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/consents/{consentId}'
api_params = {}
if consent_id is None or consent_id == '':
raise AppwriteException('Missing required parameter: "consent_id"')
api_path = api_path.replace('{consentId}', str(self._normalize_value(consent_id)))
response = self.client.call(
'get',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'accept': 'application/json',
},
api_params,
)
return self._parse_response(response, model=Oauth2Consent)
def delete_consent(
self,
consent_id: str,
) -> Dict[str, Any]:
"""
Delete an OAuth2 consent by its unique ID. All token families issued under the consent are revoked, and the app must ask for consent again to regain access.
Parameters
----------
consent_id : str
Consent unique ID.
Returns
-------
Dict[str, Any]
API response as a dictionary
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/consents/{consentId}'
api_params = {}
if consent_id is None or consent_id == '':
raise AppwriteException('Missing required parameter: "consent_id"')
api_path = api_path.replace('{consentId}', str(self._normalize_value(consent_id)))
response = self.client.call(
'delete',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'content-type': 'application/json',
'accept': 'application/json',
},
api_params,
)
return response
def list_consent_tokens(
self,
consent_id: str,
queries: Optional[List[str]] = None,
total: Optional[bool] = None,
) -> Oauth2ConsentTokenList:
"""
Get a list of the token families issued under an OAuth2 consent. Each entry represents one authorized device or session; the token secrets themselves are never returned.
Parameters
----------
consent_id : str
Consent unique ID.
queries : Optional[List[str]]
Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
total : Optional[bool]
When set to false, the total count returned will be 0 and will not be calculated.
Returns
-------
Oauth2ConsentTokenList
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/consents/{consentId}/tokens'
api_params = {}
if consent_id is None or consent_id == '':
raise AppwriteException('Missing required parameter: "consent_id"')
api_path = api_path.replace('{consentId}', str(self._normalize_value(consent_id)))
if queries is not None:
api_params['queries'] = self._normalize_value(queries)
if total is not None:
api_params['total'] = self._normalize_value(total)
response = self.client.call(
'get',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'accept': 'application/json',
},
api_params,
)
return self._parse_response(response, model=Oauth2ConsentTokenList)
def get_consent_token(
self,
consent_id: str,
token_id: str,
) -> Oauth2ConsentToken:
"""
Get a token family issued under an OAuth2 consent by its unique ID. The token secrets themselves are never returned.
Parameters
----------
consent_id : str
Consent unique ID.
token_id : str
Token unique ID.
Returns
-------
Oauth2ConsentToken
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/consents/{consentId}/tokens/{tokenId}'
api_params = {}
if consent_id is None or consent_id == '':
raise AppwriteException('Missing required parameter: "consent_id"')
if token_id is None or token_id == '':
raise AppwriteException('Missing required parameter: "token_id"')
api_path = api_path.replace('{consentId}', str(self._normalize_value(consent_id)))
api_path = api_path.replace('{tokenId}', str(self._normalize_value(token_id)))
response = self.client.call(
'get',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'accept': 'application/json',
},
api_params,
)
return self._parse_response(response, model=Oauth2ConsentToken)
def delete_consent_token(
self,
consent_id: str,
token_id: str,
) -> Dict[str, Any]:
"""
Delete a token family issued under an OAuth2 consent by its unique ID. The access and refresh tokens of the family stop working immediately; other token families and the consent itself are unaffected.
Parameters
----------
consent_id : str
Consent unique ID.
token_id : str
Token unique ID.
Returns
-------
Dict[str, Any]
API response as a dictionary
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/consents/{consentId}/tokens/{tokenId}'
api_params = {}
if consent_id is None or consent_id == '':
raise AppwriteException('Missing required parameter: "consent_id"')
if token_id is None or token_id == '':
raise AppwriteException('Missing required parameter: "token_id"')
api_path = api_path.replace('{consentId}', str(self._normalize_value(consent_id)))
api_path = api_path.replace('{tokenId}', str(self._normalize_value(token_id)))
response = self.client.call(
'delete',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'content-type': 'application/json',
'accept': 'application/json',
},
api_params,
)
return response
def update_email(
self,
email: str,
password: str,
model_type: Type[T] = dict,
) -> User[T]:
"""
Update currently logged in user account email address. After changing user address, the user confirmation status will get reset. A new confirmation email is not sent automatically however you can use the send confirmation email endpoint again to send the confirmation email. For security measures, user password is required to complete this request.
This endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.
Parameters
----------
email : str
User email.
password : str
User password. Must be at least 8 chars.
model_type : Type[T], optional
Pydantic model class for the user-defined data. Defaults to dict for backward compatibility.
Returns
-------
User[T]
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/email'
api_params = {}
if email is None:
raise AppwriteException('Missing required parameter: "email"')
if password is None:
raise AppwriteException('Missing required parameter: "password"')
api_params['email'] = self._normalize_value(email)
api_params['password'] = self._normalize_value(password)
response = self.client.call(
'patch',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'content-type': 'application/json',
'accept': 'application/json',
},
api_params,
)
return User.with_data(response, model_type)
def list_identities(
self,
queries: Optional[List[str]] = None,
total: Optional[bool] = None,
) -> IdentityList:
"""
Get the list of identities for the currently logged in user.
Parameters
----------
queries : Optional[List[str]]
Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry
total : Optional[bool]
When set to false, the total count returned will be 0 and will not be calculated.
Returns
-------
IdentityList
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/identities'
api_params = {}
if queries is not None:
api_params['queries'] = self._normalize_value(queries)
if total is not None:
api_params['total'] = self._normalize_value(total)
response = self.client.call(
'get',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'accept': 'application/json',
},
api_params,
)
return self._parse_response(response, model=IdentityList)
def delete_identity(
self,
identity_id: str,
) -> Dict[str, Any]:
"""
Delete an identity by its unique ID.
Parameters
----------
identity_id : str
Identity ID.
Returns
-------
Dict[str, Any]
API response as a dictionary
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/identities/{identityId}'
api_params = {}
if identity_id is None or identity_id == '':
raise AppwriteException('Missing required parameter: "identity_id"')
api_path = api_path.replace('{identityId}', str(self._normalize_value(identity_id)))
response = self.client.call(
'delete',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'content-type': 'application/json',
'accept': 'application/json',
},
api_params,
)
return response
def list_memberships(
self,
queries: Optional[List[str]] = None,
total: Optional[bool] = None,
) -> MembershipList:
"""
Get the team memberships of the currently logged in user.
Parameters
----------
queries : Optional[List[str]]
Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles
total : Optional[bool]
When set to false, the total count returned will be 0 and will not be calculated.
Returns
-------
MembershipList
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/memberships'
api_params = {}
if queries is not None:
api_params['queries'] = self._normalize_value(queries)
if total is not None:
api_params['total'] = self._normalize_value(total)
response = self.client.call(
'get',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'accept': 'application/json',
},
api_params,
)
return self._parse_response(response, model=MembershipList)
def update_mfa(
self,
mfa: bool,
model_type: Type[T] = dict,
) -> User[T]:
"""
Enable or disable MFA on an account.
Parameters
----------
mfa : bool
Enable or disable MFA.
model_type : Type[T], optional
Pydantic model class for the user-defined data. Defaults to dict for backward compatibility.
Returns
-------
User[T]
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/mfa'
api_params = {}
if mfa is None:
raise AppwriteException('Missing required parameter: "mfa"')
api_params['mfa'] = self._normalize_value(mfa)
response = self.client.call(
'patch',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'content-type': 'application/json',
'accept': 'application/json',
},
api_params,
)
return User.with_data(response, model_type)
def create_mfa_authenticator(
self,
type: AuthenticatorType,
) -> MfaType:
"""
Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) method.
Parameters
----------
type : AuthenticatorType
Type of authenticator. Must be `totp`
Returns
-------
MfaType
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/mfa/authenticators/{type}'
api_params = {}
if type is None:
raise AppwriteException('Missing required parameter: "type"')
api_path = api_path.replace('{type}', str(self._normalize_value(type)))
response = self.client.call(
'post',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'content-type': 'application/json',
'accept': 'application/json',
},
api_params,
)
return self._parse_response(response, model=MfaType)
def update_mfa_authenticator(
self,
type: AuthenticatorType,
otp: str,
model_type: Type[T] = dict,
) -> User[T]:
"""
Verify an authenticator app after adding it using the [add authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) method.
Parameters
----------
type : AuthenticatorType
Type of authenticator.
otp : str
Valid verification token.
model_type : Type[T], optional
Pydantic model class for the user-defined data. Defaults to dict for backward compatibility.
Returns
-------
User[T]
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/mfa/authenticators/{type}'
api_params = {}
if type is None:
raise AppwriteException('Missing required parameter: "type"')
if otp is None:
raise AppwriteException('Missing required parameter: "otp"')
api_path = api_path.replace('{type}', str(self._normalize_value(type)))
api_params['otp'] = self._normalize_value(otp)
response = self.client.call(
'put',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'content-type': 'application/json',
'accept': 'application/json',
},
api_params,
)
return User.with_data(response, model_type)
def delete_mfa_authenticator(
self,
type: AuthenticatorType,
) -> Dict[str, Any]:
"""
Delete an authenticator for a user by ID.
Parameters
----------
type : AuthenticatorType
Type of authenticator.
Returns
-------
Dict[str, Any]
API response as a dictionary
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/mfa/authenticators/{type}'
api_params = {}
if type is None:
raise AppwriteException('Missing required parameter: "type"')
api_path = api_path.replace('{type}', str(self._normalize_value(type)))
response = self.client.call(
'delete',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'content-type': 'application/json',
'accept': 'application/json',
},
api_params,
)
return response
def create_mfa_challenge(
self,
factor: AuthenticationFactor,
) -> MfaChallenge:
"""
Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) method.
Parameters
----------
factor : AuthenticationFactor
Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`, `custom`.
Returns
-------
MfaChallenge
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/mfa/challenges'
api_params = {}
if factor is None:
raise AppwriteException('Missing required parameter: "factor"')
api_params['factor'] = self._normalize_value(factor)
response = self.client.call(
'post',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'content-type': 'application/json',
'accept': 'application/json',
},
api_params,
)
return self._parse_response(response, model=MfaChallenge)
def update_mfa_challenge(
self,
challenge_id: str,
otp: str,
) -> Session:
"""
Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method.
Parameters
----------
challenge_id : str
ID of the challenge.
otp : str
Valid verification token.
Returns
-------
Session
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/mfa/challenges'
api_params = {}
if challenge_id is None:
raise AppwriteException('Missing required parameter: "challenge_id"')
if otp is None:
raise AppwriteException('Missing required parameter: "otp"')
api_params['challengeId'] = self._normalize_value(challenge_id)
api_params['otp'] = self._normalize_value(otp)
response = self.client.call(
'put',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'content-type': 'application/json',
'accept': 'application/json',
},
api_params,
)
return self._parse_response(response, model=Session)
def list_mfa_factors(
self,
) -> MfaFactors:
"""
List the factors available on the account to be used as a MFA challange.
Returns
-------
MfaFactors
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/mfa/factors'
api_params = {}
response = self.client.call(
'get',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'accept': 'application/json',
},
api_params,
)
return self._parse_response(response, model=MfaFactors)
def get_mfa_recovery_codes(
self,
) -> MfaRecoveryCodes:
"""
Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.
Returns
-------
MfaRecoveryCodes
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/mfa/recovery-codes'
api_params = {}
response = self.client.call(
'get',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'accept': 'application/json',
},
api_params,
)
return self._parse_response(response, model=MfaRecoveryCodes)
def create_mfa_recovery_codes(
self,
) -> MfaRecoveryCodes:
"""
Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method.
Returns
-------
MfaRecoveryCodes
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/mfa/recovery-codes'
api_params = {}
response = self.client.call(
'post',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'content-type': 'application/json',
'accept': 'application/json',
},
api_params,
)
return self._parse_response(response, model=MfaRecoveryCodes)
def update_mfa_recovery_codes(
self,
) -> MfaRecoveryCodes:
"""
Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.
Returns
-------
MfaRecoveryCodes
API response as a typed Pydantic model
Raises
------
AppwriteException
If API request fails
"""
api_path = '/account/mfa/recovery-codes'
api_params = {}
response = self.client.call(
'patch',
api_path,
{
'X-Appwrite-Project': self.client.get_config('project'),
'content-type': 'application/json',
'accept': 'application/json',
},
api_params,
)
return self._parse_response(response, model=MfaRecoveryCodes)
def update_name(
self,
name: str,
model_type: Type[T] = dict,
) -> User[T]:
"""
Update currently logged in user account name.
Parameters
----------
name : str
User name. Max length: 128 chars.
model_type : Type[T], optional
Pydantic model class for the user-defined data. Defaults to dict for backward compatibility.
Returns
-------
User[T]
API response as a typed Pydantic model
Raises
------
You can’t perform that action at this time.