forked from clerk/clerk-sdk-python
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgen.lock
2047 lines (2047 loc) · 186 KB
/
gen.lock
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
lockVersion: 2.0.0
id: bfe29c99-6e67-43fe-b928-64d6a5ed6aa8
management:
docChecksum: b774ab4868edf5a0a8859b821fbe9e0c
docVersion: v1
speakeasyVersion: 1.476.2
generationVersion: 2.495.1
releaseVersion: 1.7.1
configChecksum: c9e8658b9ff3134c9da644c2c3a1c32b
repoURL: https://github.com/clerk/clerk-sdk-python.git
installationURL: https://github.com/clerk/clerk-sdk-python.git
published: true
features:
python:
additionalDependencies: 1.0.0
additionalProperties: 1.0.1
constsAndDefaults: 1.0.5
core: 5.10.5
customCodeRegions: 0.1.1
defaultEnabledRetries: 0.2.0
deprecations: 3.0.2
enumUnions: 0.1.0
envVarSecurityUsage: 0.3.2
examples: 3.0.1
flatRequests: 1.0.1
flattening: 3.1.0
globalSecurity: 3.0.2
globalSecurityCallbacks: 1.0.0
globalSecurityFlattening: 1.0.0
globalServerURLs: 3.1.0
groups: 3.0.0
methodArguments: 1.0.2
multipartFileContentType: 1.0.0
nameOverrides: 3.0.1
nullables: 1.0.0
openEnums: 1.0.0
responseFormat: 1.0.1
retries: 3.0.2
sdkHooks: 1.0.0
unions: 3.0.4
uploadStreams: 1.0.0
generatedFiles:
- .gitattributes
- .python-version
- .vscode/settings.json
- USAGE.md
- docs/models/actor.md
- docs/models/actortoken.md
- docs/models/actortokenactor.md
- docs/models/actortokenobject.md
- docs/models/actortokenstatus.md
- docs/models/adddomainrequestbody.md
- docs/models/admin.md
- docs/models/adminverificationphonenumberstatus.md
- docs/models/adminverificationstatus.md
- docs/models/adminverificationstrategy.md
- docs/models/adminverificationweb3walletstatus.md
- docs/models/adminverificationweb3walletstrategy.md
- docs/models/allowlistidentifier.md
- docs/models/allowlistidentifierobject.md
- docs/models/attributemapping.md
- docs/models/banuserrequest.md
- docs/models/blocklistidentifier.md
- docs/models/blocklistidentifieridentifiertype.md
- docs/models/blocklistidentifierobject.md
- docs/models/blocklistidentifiers.md
- docs/models/changeproductioninstancedomainrequestbody.md
- docs/models/claims.md
- docs/models/clerkerror.md
- docs/models/clerkerrorerrormeta.md
- docs/models/clerkerrors.md
- docs/models/clerkerrorsmeta.md
- docs/models/client.md
- docs/models/cnametarget.md
- docs/models/codetype.md
- docs/models/createactortokenactor.md
- docs/models/createactortokenrequestbody.md
- docs/models/createallowlistidentifierrequestbody.md
- docs/models/createblocklistidentifierrequestbody.md
- docs/models/createemailaddressrequestbody.md
- docs/models/createinvitationrequestbody.md
- docs/models/createjwttemplateclaims.md
- docs/models/createjwttemplaterequestbody.md
- docs/models/createoauthapplicationrequestbody.md
- docs/models/createorganizationdomainrequest.md
- docs/models/createorganizationdomainrequestbody.md
- docs/models/createorganizationinvitationbulkrequest.md
- docs/models/createorganizationinvitationbulkrequestbody.md
- docs/models/createorganizationinvitationrequest.md
- docs/models/createorganizationinvitationrequestbody.md
- docs/models/createorganizationmembershiprequest.md
- docs/models/createorganizationmembershiprequestbody.md
- docs/models/createorganizationrequestbody.md
- docs/models/createphonenumberrequestbody.md
- docs/models/createredirecturlrequestbody.md
- docs/models/createsamlconnectionattributemapping.md
- docs/models/createsamlconnectionrequestbody.md
- docs/models/createsessionrequestbody.md
- docs/models/createsessiontokenfromtemplateobject.md
- docs/models/createsessiontokenfromtemplaterequest.md
- docs/models/createsessiontokenfromtemplaterequestbody.md
- docs/models/createsessiontokenfromtemplateresponsebody.md
- docs/models/createsessiontokenobject.md
- docs/models/createsessiontokenrequest.md
- docs/models/createsessiontokenrequestbody.md
- docs/models/createsessiontokenresponsebody.md
- docs/models/createsignintokenrequestbody.md
- docs/models/createuserrequestbody.md
- docs/models/createusertotprequest.md
- docs/models/createwaitlistentryrequestbody.md
- docs/models/deleteallowlistidentifierrequest.md
- docs/models/deletebackupcoderequest.md
- docs/models/deletebackupcoderesponsebody.md
- docs/models/deleteblocklistidentifierrequest.md
- docs/models/deletedobject.md
- docs/models/deletedomainrequest.md
- docs/models/deleteemailaddressrequest.md
- docs/models/deleteexternalaccountrequest.md
- docs/models/deletejwttemplaterequest.md
- docs/models/deleteoauthapplicationrequest.md
- docs/models/deleteorganizationdomainrequest.md
- docs/models/deleteorganizationlogorequest.md
- docs/models/deleteorganizationmembershiprequest.md
- docs/models/deleteorganizationrequest.md
- docs/models/deletephonenumberrequest.md
- docs/models/deleteredirecturlrequest.md
- docs/models/deletesamlconnectionrequest.md
- docs/models/deletetotprequest.md
- docs/models/deletetotpresponsebody.md
- docs/models/deleteuserprofileimagerequest.md
- docs/models/deleteuserrequest.md
- docs/models/disablemfarequest.md
- docs/models/disablemfaresponsebody.md
- docs/models/domain.md
- docs/models/domainobject.md
- docs/models/domains.md
- docs/models/domainsenrollmentmodes.md
- docs/models/emailaddress.md
- docs/models/emailaddressobject.md
- docs/models/enrollmentmode.md
- docs/models/error.md
- docs/models/errorclerkerror.md
- docs/models/errormeta.md
- docs/models/externalaccount.md
- docs/models/externalaccounts.md
- docs/models/file.md
- docs/models/fromoauth.md
- docs/models/fromoauthverificationstatus.md
- docs/models/getclientlistrequest.md
- docs/models/getclientrequest.md
- docs/models/getemailaddressrequest.md
- docs/models/getjwttemplaterequest.md
- docs/models/getoauthaccesstokenrequest.md
- docs/models/getoauthapplicationrequest.md
- docs/models/getorganizationinvitationrequest.md
- docs/models/getorganizationrequest.md
- docs/models/getphonenumberrequest.md
- docs/models/getpublicinterstitialrequest.md
- docs/models/getredirecturlrequest.md
- docs/models/getsamlconnectionrequest.md
- docs/models/getsessionlistrequest.md
- docs/models/getsessionrequest.md
- docs/models/gettemplatelistrequest.md
- docs/models/gettemplaterequest.md
- docs/models/getuserlistrequest.md
- docs/models/getuserrequest.md
- docs/models/getuserscountrequest.md
- docs/models/identificationlink.md
- docs/models/identifiertype.md
- docs/models/instance.md
- docs/models/instancegetorganizationmembershipsrequest.md
- docs/models/instanceobject.md
- docs/models/instancerestrictions.md
- docs/models/instancerestrictionsobject.md
- docs/models/instancesettings.md
- docs/models/instancesettingsobject.md
- docs/models/invitation.md
- docs/models/invitationobject.md
- docs/models/invitationrevoked.md
- docs/models/invitationrevokedobject.md
- docs/models/invitationrevokedstatus.md
- docs/models/invitationstatus.md
- docs/models/jwks.md
- docs/models/jwttemplate.md
- docs/models/jwttemplateobject.md
- docs/models/keys.md
- docs/models/latestactivity.md
- docs/models/listinstanceorganizationinvitationsqueryparamstatus.md
- docs/models/listinstanceorganizationinvitationsrequest.md
- docs/models/listinvitationsqueryparamstatus.md
- docs/models/listinvitationsrequest.md
- docs/models/listoauthapplicationsrequest.md
- docs/models/listorganizationdomainsrequest.md
- docs/models/listorganizationinvitationsqueryparamstatus.md
- docs/models/listorganizationinvitationsrequest.md
- docs/models/listorganizationmembershipsrequest.md
- docs/models/listorganizationsrequest.md
- docs/models/listpendingorganizationinvitationsrequest.md
- docs/models/listsamlconnectionsrequest.md
- docs/models/listwaitlistentriesqueryparamstatus.md
- docs/models/listwaitlistentriesrequest.md
- docs/models/lockuserrequest.md
- docs/models/mergeorganizationmetadatarequest.md
- docs/models/mergeorganizationmetadatarequestbody.md
- docs/models/meta.md
- docs/models/nonce.md
- docs/models/oauthapplication.md
- docs/models/oauthapplicationobject.md
- docs/models/oauthapplications.md
- docs/models/oauthapplicationwithsecret.md
- docs/models/oauthapplicationwithsecretobject.md
- docs/models/object.md
- docs/models/organization.md
- docs/models/organizationdomain.md
- docs/models/organizationdomainobject.md
- docs/models/organizationdomains.md
- docs/models/organizationdomainstatus.md
- docs/models/organizationdomainverification.md
- docs/models/organizationinvitation.md
- docs/models/organizationinvitationobject.md
- docs/models/organizationinvitations.md
- docs/models/organizationinvitationswithpublicorganizationdata.md
- docs/models/organizationinvitationwithpublicorganizationdata.md
- docs/models/organizationinvitationwithpublicorganizationdataobject.md
- docs/models/organizationmembership.md
- docs/models/organizationmembershipobject.md
- docs/models/organizationmembershiporganization.md
- docs/models/organizationmembershiporganizationobject.md
- docs/models/organizationmemberships.md
- docs/models/organizationobject.md
- docs/models/organizations.md
- docs/models/organizationsettings.md
- docs/models/organizationsettingsobject.md
- docs/models/organizationwithlogo.md
- docs/models/organizationwithlogoobject.md
- docs/models/otp.md
- docs/models/otpverificationstatus.md
- docs/models/otpverificationstrategy.md
- docs/models/passkey.md
- docs/models/passkeyverificationstatus.md
- docs/models/passkeyverificationstrategy.md
- docs/models/pathparamtemplatetype.md
- docs/models/phonenumber.md
- docs/models/phonenumberobject.md
- docs/models/phonenumberverification.md
- docs/models/previewtemplaterequest.md
- docs/models/previewtemplaterequestbody.md
- docs/models/previewtemplateresponsebody.md
- docs/models/provider.md
- docs/models/proxycheck.md
- docs/models/proxycheckobject.md
- docs/models/publicorganizationdata.md
- docs/models/publicuserdata.md
- docs/models/queryparamstatus.md
- docs/models/redirecturl.md
- docs/models/redirecturlobject.md
- docs/models/requestbody.md
- docs/models/responsebody.md
- docs/models/reverttemplatepathparamtemplatetype.md
- docs/models/reverttemplaterequest.md
- docs/models/revokeactortokenrequest.md
- docs/models/revokeinvitationrequest.md
- docs/models/revokeorganizationinvitationrequest.md
- docs/models/revokeorganizationinvitationrequestbody.md
- docs/models/revokesessionrequest.md
- docs/models/revokesignintokenrequest.md
- docs/models/rotateoauthapplicationsecretrequest.md
- docs/models/saml.md
- docs/models/samlaccount.md
- docs/models/samlaccountobject.md
- docs/models/samlaccountverification.md
- docs/models/samlconnection.md
- docs/models/samlconnections.md
- docs/models/samlconnectionsamlconnection.md
- docs/models/samlerrorclerkerror.md
- docs/models/samlverificationstatus.md
- docs/models/samlverificationstrategy.md
- docs/models/schemaspasskey.md
- docs/models/schemaspasskeyobject.md
- docs/models/schemaspasskeyverification.md
- docs/models/schemassamlconnection.md
- docs/models/schemassamlconnectionobject.md
- docs/models/security.md
- docs/models/session.md
- docs/models/sessionobject.md
- docs/models/setuserprofileimagerequest.md
- docs/models/setuserprofileimagerequestbody.md
- docs/models/signintoken.md
- docs/models/signintokenobject.md
- docs/models/signintokenstatus.md
- docs/models/signup.md
- docs/models/signupobject.md
- docs/models/signupstatus.md
- docs/models/status.md
- docs/models/strategy.md
- docs/models/svixurl.md
- docs/models/template.md
- docs/models/templateobject.md
- docs/models/templateslug.md
- docs/models/templatetype.md
- docs/models/testingtoken.md
- docs/models/testingtokenobject.md
- docs/models/ticket.md
- docs/models/ticketverificationstatus.md
- docs/models/ticketverificationstrategy.md
- docs/models/toggletemplatedeliverypathparamtemplatetype.md
- docs/models/toggletemplatedeliveryrequest.md
- docs/models/toggletemplatedeliveryrequestbody.md
- docs/models/totalcount.md
- docs/models/totalcountobject.md
- docs/models/totp.md
- docs/models/type.md
- docs/models/unbanuserrequest.md
- docs/models/unlockuserrequest.md
- docs/models/updatedomainrequest.md
- docs/models/updatedomainrequestbody.md
- docs/models/updateemailaddressrequest.md
- docs/models/updateemailaddressrequestbody.md
- docs/models/updateinstanceauthconfigrequestbody.md
- docs/models/updateinstanceorganizationsettingsrequestbody.md
- docs/models/updateinstancerequestbody.md
- docs/models/updateinstancerestrictionsrequestbody.md
- docs/models/updatejwttemplateclaims.md
- docs/models/updatejwttemplaterequest.md
- docs/models/updatejwttemplaterequestbody.md
- docs/models/updateoauthapplicationrequest.md
- docs/models/updateoauthapplicationrequestbody.md
- docs/models/updateorganizationdomainrequest.md
- docs/models/updateorganizationdomainrequestbody.md
- docs/models/updateorganizationmembershipmetadatarequest.md
- docs/models/updateorganizationmembershipmetadatarequestbody.md
- docs/models/updateorganizationmembershiprequest.md
- docs/models/updateorganizationmembershiprequestbody.md
- docs/models/updateorganizationrequest.md
- docs/models/updateorganizationrequestbody.md
- docs/models/updatephonenumberrequest.md
- docs/models/updatephonenumberrequestbody.md
- docs/models/updateproductioninstancedomainrequestbody.md
- docs/models/updatesamlconnectionattributemapping.md
- docs/models/updatesamlconnectionrequest.md
- docs/models/updatesamlconnectionrequestbody.md
- docs/models/updatesignuprequest.md
- docs/models/updatesignuprequestbody.md
- docs/models/updateusermetadatarequest.md
- docs/models/updateusermetadatarequestbody.md
- docs/models/updateuserrequest.md
- docs/models/updateuserrequestbody.md
- docs/models/uploadorganizationlogofile.md
- docs/models/uploadorganizationlogorequest.md
- docs/models/uploadorganizationlogorequestbody.md
- docs/models/upserttemplatepathparamtemplatetype.md
- docs/models/upserttemplaterequest.md
- docs/models/upserttemplaterequestbody.md
- docs/models/user.md
- docs/models/userobject.md
- docs/models/userpasskeydeleterequest.md
- docs/models/usersgetorganizationinvitationsqueryparamstatus.md
- docs/models/usersgetorganizationinvitationsrequest.md
- docs/models/usersgetorganizationmembershipsrequest.md
- docs/models/userweb3walletdeleterequest.md
- docs/models/utils/retryconfig.md
- docs/models/verification.md
- docs/models/verificationadmin.md
- docs/models/verificationerror.md
- docs/models/verificationotp.md
- docs/models/verifications.md
- docs/models/verificationstatus.md
- docs/models/verificationstrategy.md
- docs/models/verifyclientrequestbody.md
- docs/models/verifydomainproxyrequestbody.md
- docs/models/verifypasswordrequest.md
- docs/models/verifypasswordrequestbody.md
- docs/models/verifypasswordresponsebody.md
- docs/models/verifysessionrequest.md
- docs/models/verifysessionrequestbody.md
- docs/models/verifytotprequest.md
- docs/models/verifytotprequestbody.md
- docs/models/verifytotpresponsebody.md
- docs/models/waitlistentries.md
- docs/models/waitlistentry.md
- docs/models/waitlistentryinvitation.md
- docs/models/waitlistentryinvitationobject.md
- docs/models/waitlistentryinvitationstatus.md
- docs/models/waitlistentryobject.md
- docs/models/waitlistentrystatus.md
- docs/models/web3signature.md
- docs/models/web3signatureverificationstatus.md
- docs/models/web3signatureverificationstrategy.md
- docs/models/web3wallet.md
- docs/models/web3walletobject.md
- docs/models/web3walletverification.md
- docs/models/web3walletverificationadmin.md
- docs/sdks/actortokens/README.md
- docs/sdks/allowlistblocklist/README.md
- docs/sdks/allowlistidentifiers/README.md
- docs/sdks/betafeatures/README.md
- docs/sdks/blocklistidentifierssdk/README.md
- docs/sdks/clerk/README.md
- docs/sdks/clerkredirecturls/README.md
- docs/sdks/clients/README.md
- docs/sdks/domainssdk/README.md
- docs/sdks/emailaddresses/README.md
- docs/sdks/emailandsmstemplates/README.md
- docs/sdks/emailsmstemplates/README.md
- docs/sdks/instancesettingssdk/README.md
- docs/sdks/invitations/README.md
- docs/sdks/jwkssdk/README.md
- docs/sdks/jwttemplates/README.md
- docs/sdks/miscellaneous/README.md
- docs/sdks/oauthapplicationssdk/README.md
- docs/sdks/organizationdomainsdk/README.md
- docs/sdks/organizationdomainssdk/README.md
- docs/sdks/organizationinvitationssdk/README.md
- docs/sdks/organizationmembershipssdk/README.md
- docs/sdks/organizationssdk/README.md
- docs/sdks/phonenumbers/README.md
- docs/sdks/proxychecks/README.md
- docs/sdks/redirecturls/README.md
- docs/sdks/samlconnectionssdk/README.md
- docs/sdks/sessions/README.md
- docs/sdks/signintokens/README.md
- docs/sdks/signups/README.md
- docs/sdks/templates/README.md
- docs/sdks/testingtokens/README.md
- docs/sdks/users/README.md
- docs/sdks/waitlistentriessdk/README.md
- docs/sdks/webhooks/README.md
- poetry.toml
- py.typed
- pylintrc
- pyproject.toml
- scripts/prepare-readme.py
- scripts/publish.sh
- src/clerk_backend_api/__init__.py
- src/clerk_backend_api/_hooks/__init__.py
- src/clerk_backend_api/_hooks/sdkhooks.py
- src/clerk_backend_api/_hooks/types.py
- src/clerk_backend_api/_version.py
- src/clerk_backend_api/actortokens.py
- src/clerk_backend_api/allowlistblocklist.py
- src/clerk_backend_api/allowlistidentifiers.py
- src/clerk_backend_api/basesdk.py
- src/clerk_backend_api/betafeatures.py
- src/clerk_backend_api/blocklistidentifiers_sdk.py
- src/clerk_backend_api/clerk_redirecturls.py
- src/clerk_backend_api/clients.py
- src/clerk_backend_api/domains_sdk.py
- src/clerk_backend_api/emailaddresses.py
- src/clerk_backend_api/emailandsmstemplates.py
- src/clerk_backend_api/emailsmstemplates.py
- src/clerk_backend_api/httpclient.py
- src/clerk_backend_api/instance_settings_sdk.py
- src/clerk_backend_api/invitations.py
- src/clerk_backend_api/jwks_sdk.py
- src/clerk_backend_api/jwttemplates.py
- src/clerk_backend_api/miscellaneous.py
- src/clerk_backend_api/models/__init__.py
- src/clerk_backend_api/models/actortoken.py
- src/clerk_backend_api/models/adddomainop.py
- src/clerk_backend_api/models/allowlistidentifier.py
- src/clerk_backend_api/models/banuserop.py
- src/clerk_backend_api/models/blocklistidentifier.py
- src/clerk_backend_api/models/blocklistidentifiers.py
- src/clerk_backend_api/models/changeproductioninstancedomainop.py
- src/clerk_backend_api/models/clerkerror.py
- src/clerk_backend_api/models/clerkerrors.py
- src/clerk_backend_api/models/client.py
- src/clerk_backend_api/models/cnametarget.py
- src/clerk_backend_api/models/createactortokenop.py
- src/clerk_backend_api/models/createallowlistidentifierop.py
- src/clerk_backend_api/models/createblocklistidentifierop.py
- src/clerk_backend_api/models/createbulkinvitationsop.py
- src/clerk_backend_api/models/createemailaddressop.py
- src/clerk_backend_api/models/createinvitationop.py
- src/clerk_backend_api/models/createjwttemplateop.py
- src/clerk_backend_api/models/createoauthapplicationop.py
- src/clerk_backend_api/models/createorganizationdomainop.py
- src/clerk_backend_api/models/createorganizationinvitationbulkop.py
- src/clerk_backend_api/models/createorganizationinvitationop.py
- src/clerk_backend_api/models/createorganizationmembershipop.py
- src/clerk_backend_api/models/createorganizationop.py
- src/clerk_backend_api/models/createphonenumberop.py
- src/clerk_backend_api/models/createredirecturlop.py
- src/clerk_backend_api/models/createsamlconnectionop.py
- src/clerk_backend_api/models/createsessionop.py
- src/clerk_backend_api/models/createsessiontokenfromtemplateop.py
- src/clerk_backend_api/models/createsessiontokenop.py
- src/clerk_backend_api/models/createsignintokenop.py
- src/clerk_backend_api/models/createuserop.py
- src/clerk_backend_api/models/createusertotpop.py
- src/clerk_backend_api/models/createwaitlistentryop.py
- src/clerk_backend_api/models/deleteallowlistidentifierop.py
- src/clerk_backend_api/models/deletebackupcodeop.py
- src/clerk_backend_api/models/deleteblocklistidentifierop.py
- src/clerk_backend_api/models/deletedobject.py
- src/clerk_backend_api/models/deletedomainop.py
- src/clerk_backend_api/models/deleteemailaddressop.py
- src/clerk_backend_api/models/deleteexternalaccountop.py
- src/clerk_backend_api/models/deletejwttemplateop.py
- src/clerk_backend_api/models/deleteoauthapplicationop.py
- src/clerk_backend_api/models/deleteorganizationdomainop.py
- src/clerk_backend_api/models/deleteorganizationlogoop.py
- src/clerk_backend_api/models/deleteorganizationmembershipop.py
- src/clerk_backend_api/models/deleteorganizationop.py
- src/clerk_backend_api/models/deletephonenumberop.py
- src/clerk_backend_api/models/deleteredirecturlop.py
- src/clerk_backend_api/models/deletesamlconnectionop.py
- src/clerk_backend_api/models/deletetotpop.py
- src/clerk_backend_api/models/deleteuserop.py
- src/clerk_backend_api/models/deleteuserprofileimageop.py
- src/clerk_backend_api/models/disablemfaop.py
- src/clerk_backend_api/models/domain.py
- src/clerk_backend_api/models/domains.py
- src/clerk_backend_api/models/emailaddress.py
- src/clerk_backend_api/models/getclientlistop.py
- src/clerk_backend_api/models/getclientop.py
- src/clerk_backend_api/models/getemailaddressop.py
- src/clerk_backend_api/models/getjwttemplateop.py
- src/clerk_backend_api/models/getoauthaccesstokenop.py
- src/clerk_backend_api/models/getoauthapplicationop.py
- src/clerk_backend_api/models/getorganizationinvitationop.py
- src/clerk_backend_api/models/getorganizationop.py
- src/clerk_backend_api/models/getphonenumberop.py
- src/clerk_backend_api/models/getpublicinterstitialop.py
- src/clerk_backend_api/models/getredirecturlop.py
- src/clerk_backend_api/models/getsamlconnectionop.py
- src/clerk_backend_api/models/getsessionlistop.py
- src/clerk_backend_api/models/getsessionop.py
- src/clerk_backend_api/models/gettemplatelistop.py
- src/clerk_backend_api/models/gettemplateop.py
- src/clerk_backend_api/models/getuserlistop.py
- src/clerk_backend_api/models/getuserop.py
- src/clerk_backend_api/models/getuserscountop.py
- src/clerk_backend_api/models/identificationlink.py
- src/clerk_backend_api/models/instance.py
- src/clerk_backend_api/models/instancegetorganizationmembershipsop.py
- src/clerk_backend_api/models/instancerestrictions.py
- src/clerk_backend_api/models/instancesettings.py
- src/clerk_backend_api/models/invitation.py
- src/clerk_backend_api/models/invitation_revoked.py
- src/clerk_backend_api/models/jwks.py
- src/clerk_backend_api/models/jwttemplate.py
- src/clerk_backend_api/models/listinstanceorganizationinvitationsop.py
- src/clerk_backend_api/models/listinvitationsop.py
- src/clerk_backend_api/models/listoauthapplicationsop.py
- src/clerk_backend_api/models/listorganizationdomainsop.py
- src/clerk_backend_api/models/listorganizationinvitationsop.py
- src/clerk_backend_api/models/listorganizationmembershipsop.py
- src/clerk_backend_api/models/listorganizationsop.py
- src/clerk_backend_api/models/listpendingorganizationinvitationsop.py
- src/clerk_backend_api/models/listsamlconnectionsop.py
- src/clerk_backend_api/models/listwaitlistentriesop.py
- src/clerk_backend_api/models/lockuserop.py
- src/clerk_backend_api/models/mergeorganizationmetadataop.py
- src/clerk_backend_api/models/oauthapplication.py
- src/clerk_backend_api/models/oauthapplications.py
- src/clerk_backend_api/models/oauthapplicationwithsecret.py
- src/clerk_backend_api/models/organization.py
- src/clerk_backend_api/models/organizationdomain.py
- src/clerk_backend_api/models/organizationdomains.py
- src/clerk_backend_api/models/organizationinvitation.py
- src/clerk_backend_api/models/organizationinvitations.py
- src/clerk_backend_api/models/organizationinvitationswithpublicorganizationdata.py
- src/clerk_backend_api/models/organizationinvitationwithpublicorganizationdata.py
- src/clerk_backend_api/models/organizationmembership.py
- src/clerk_backend_api/models/organizationmemberships.py
- src/clerk_backend_api/models/organizations.py
- src/clerk_backend_api/models/organizationsettings.py
- src/clerk_backend_api/models/organizationwithlogo.py
- src/clerk_backend_api/models/phonenumber.py
- src/clerk_backend_api/models/previewtemplateop.py
- src/clerk_backend_api/models/proxycheck.py
- src/clerk_backend_api/models/redirecturl.py
- src/clerk_backend_api/models/reverttemplateop.py
- src/clerk_backend_api/models/revokeactortokenop.py
- src/clerk_backend_api/models/revokeinvitationop.py
- src/clerk_backend_api/models/revokeorganizationinvitationop.py
- src/clerk_backend_api/models/revokesessionop.py
- src/clerk_backend_api/models/revokesignintokenop.py
- src/clerk_backend_api/models/rotateoauthapplicationsecretop.py
- src/clerk_backend_api/models/samlaccount.py
- src/clerk_backend_api/models/samlconnections.py
- src/clerk_backend_api/models/schemas_passkey.py
- src/clerk_backend_api/models/schemas_samlconnection.py
- src/clerk_backend_api/models/sdkerror.py
- src/clerk_backend_api/models/security.py
- src/clerk_backend_api/models/session.py
- src/clerk_backend_api/models/setuserprofileimageop.py
- src/clerk_backend_api/models/signintoken.py
- src/clerk_backend_api/models/signup.py
- src/clerk_backend_api/models/svixurl.py
- src/clerk_backend_api/models/template.py
- src/clerk_backend_api/models/testingtoken.py
- src/clerk_backend_api/models/toggletemplatedeliveryop.py
- src/clerk_backend_api/models/totalcount.py
- src/clerk_backend_api/models/totp.py
- src/clerk_backend_api/models/unbanuserop.py
- src/clerk_backend_api/models/unlockuserop.py
- src/clerk_backend_api/models/updatedomainop.py
- src/clerk_backend_api/models/updateemailaddressop.py
- src/clerk_backend_api/models/updateinstanceauthconfigop.py
- src/clerk_backend_api/models/updateinstanceop.py
- src/clerk_backend_api/models/updateinstanceorganizationsettingsop.py
- src/clerk_backend_api/models/updateinstancerestrictionsop.py
- src/clerk_backend_api/models/updatejwttemplateop.py
- src/clerk_backend_api/models/updateoauthapplicationop.py
- src/clerk_backend_api/models/updateorganizationdomainop.py
- src/clerk_backend_api/models/updateorganizationmembershipmetadataop.py
- src/clerk_backend_api/models/updateorganizationmembershipop.py
- src/clerk_backend_api/models/updateorganizationop.py
- src/clerk_backend_api/models/updatephonenumberop.py
- src/clerk_backend_api/models/updateproductioninstancedomainop.py
- src/clerk_backend_api/models/updatesamlconnectionop.py
- src/clerk_backend_api/models/updatesignupop.py
- src/clerk_backend_api/models/updateusermetadataop.py
- src/clerk_backend_api/models/updateuserop.py
- src/clerk_backend_api/models/uploadorganizationlogoop.py
- src/clerk_backend_api/models/upserttemplateop.py
- src/clerk_backend_api/models/user.py
- src/clerk_backend_api/models/userpasskeydeleteop.py
- src/clerk_backend_api/models/usersgetorganizationinvitationsop.py
- src/clerk_backend_api/models/usersgetorganizationmembershipsop.py
- src/clerk_backend_api/models/userweb3walletdeleteop.py
- src/clerk_backend_api/models/verifyclientop.py
- src/clerk_backend_api/models/verifydomainproxyop.py
- src/clerk_backend_api/models/verifypasswordop.py
- src/clerk_backend_api/models/verifysessionop.py
- src/clerk_backend_api/models/verifytotpop.py
- src/clerk_backend_api/models/waitlistentries.py
- src/clerk_backend_api/models/waitlistentry.py
- src/clerk_backend_api/models/web3wallet.py
- src/clerk_backend_api/oauthapplications_sdk.py
- src/clerk_backend_api/organizationdomain_sdk.py
- src/clerk_backend_api/organizationdomains_sdk.py
- src/clerk_backend_api/organizationinvitations_sdk.py
- src/clerk_backend_api/organizationmemberships_sdk.py
- src/clerk_backend_api/organizations_sdk.py
- src/clerk_backend_api/phonenumbers.py
- src/clerk_backend_api/proxychecks.py
- src/clerk_backend_api/py.typed
- src/clerk_backend_api/redirecturls.py
- src/clerk_backend_api/samlconnections_sdk.py
- src/clerk_backend_api/sdk.py
- src/clerk_backend_api/sdkconfiguration.py
- src/clerk_backend_api/sessions.py
- src/clerk_backend_api/signintokens.py
- src/clerk_backend_api/signups.py
- src/clerk_backend_api/templates.py
- src/clerk_backend_api/testingtokens.py
- src/clerk_backend_api/types/__init__.py
- src/clerk_backend_api/types/basemodel.py
- src/clerk_backend_api/users.py
- src/clerk_backend_api/utils/__init__.py
- src/clerk_backend_api/utils/annotations.py
- src/clerk_backend_api/utils/enums.py
- src/clerk_backend_api/utils/eventstreaming.py
- src/clerk_backend_api/utils/forms.py
- src/clerk_backend_api/utils/headers.py
- src/clerk_backend_api/utils/logger.py
- src/clerk_backend_api/utils/metadata.py
- src/clerk_backend_api/utils/queryparams.py
- src/clerk_backend_api/utils/requestbodies.py
- src/clerk_backend_api/utils/retries.py
- src/clerk_backend_api/utils/security.py
- src/clerk_backend_api/utils/serializers.py
- src/clerk_backend_api/utils/url.py
- src/clerk_backend_api/utils/values.py
- src/clerk_backend_api/waitlist_entries_sdk.py
- src/clerk_backend_api/webhooks.py
examples:
GetPublicInterstitial:
speakeasy-default-get-public-interstitial:
parameters:
query:
frontendApi: "frontend-api_1a2b3c4d"
publishable_key: "pub_1a2b3c4d"
GetJWKS:
speakeasy-default-get-JWKS:
responses:
"200":
application/json: {"keys": [{"use": "<value>", "kty": "<value>", "kid": "<id>", "alg": "<value>", "n": "<value>", "e": "<value>", "x": "<value>", "crv": "<value>"}, {"use": "<value>", "kty": "<value>", "kid": "<id>", "alg": "<value>", "n": "<value>", "e": "<value>", "x": "<value>", "crv": "<value>"}, {"use": "<value>", "kty": "<value>", "kid": "<id>", "alg": "<value>", "n": "<value>", "e": "<value>", "x": "<value>", "crv": "<value>"}]}
GetClientList:
speakeasy-default-get-client-list:
parameters:
query:
limit: 20
offset: 10
responses:
"200":
application/json: [{"object": "client", "id": "client_123456789abcd", "session_ids": ["sess_123456789abcd", "sess_23456789abcd"], "sessions": [{"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": false, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "58.39.162.163", "city": "Lake Aryannaton", "country": "Panama"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}, {"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": false, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "018a:1ecd:a17c:0d9e:31d2:a99a:2bc9:c682", "city": "Fort Alexiefurt", "country": "Ukraine"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}], "sign_in_id": "signin_123456789abcd", "sign_up_id": "signup_123456789abcd", "last_active_session_id": "session_123456789abcd", "updated_at": 1632580323, "created_at": 1622481123}, {"object": "client", "id": "client_123456789abcd", "session_ids": ["sess_123456789abcd", "sess_23456789abcd"], "sessions": [{"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": true, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "ccbf:131c:b3e6:bb11:6fa5:72e9:0bfb:bed0", "city": "Zackerycester", "country": "Saint Vincent and the Grenadines"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}, {"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": true, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "166.176.154.104", "city": "Port Ernestinaview", "country": "Barbados"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}, {"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": true, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "f98a:4d1d:9444:2eca:a0aa:a6c2:dc28:d8ea", "city": "Livermore", "country": "Cook Islands"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}], "sign_in_id": "signin_123456789abcd", "sign_up_id": "signup_123456789abcd", "last_active_session_id": "session_123456789abcd", "updated_at": 1632580323, "created_at": 1622481123}, {"object": "client", "id": "client_123456789abcd", "session_ids": ["sess_123456789abcd", "sess_23456789abcd"], "sessions": [{"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": false, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "214.132.198.41", "city": "East Gideonside", "country": "Angola"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}], "sign_in_id": "signin_123456789abcd", "sign_up_id": "signup_123456789abcd", "last_active_session_id": "session_123456789abcd", "updated_at": 1632580323, "created_at": 1622481123}]
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
VerifyClient:
speakeasy-default-verify-client:
requestBody:
application/json: {"token": "jwt_token_example"}
responses:
"200":
application/json: {"object": "client", "id": "client_123456789abcd", "session_ids": ["sess_123456789abcd", "sess_23456789abcd"], "sessions": [{"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": true, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "58.193.100.66", "city": "West Matteoville", "country": "Oman"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}, {"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": true, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "b769:20fd:df0e:4479:fbef:8fcc:b2fa:de28", "city": "East Deloresview", "country": "Canada"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}, {"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": true, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "51e3:ddfe:7a17:c6bf:2a53:9ca8:ba8e:b53d", "city": "East Name", "country": "Australia"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}], "sign_in_id": "signin_123456789abcd", "sign_up_id": "signup_123456789abcd", "last_active_session_id": "session_123456789abcd", "updated_at": 1632580323, "created_at": 1622481123}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
GetClient:
speakeasy-default-get-client:
parameters:
path:
client_id: "cli_123456789"
responses:
"200":
application/json: {"object": "client", "id": "client_123456789abcd", "session_ids": ["sess_123456789abcd", "sess_23456789abcd"], "sessions": [{"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": false, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "bfa9:54e9:b146:2cb8:adc7:735b:6aaf:e70f", "city": "Herbertville", "country": "Canada"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}, {"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": false, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "220.165.137.74", "city": "Runolfssonview", "country": "Guyana"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}], "sign_in_id": "signin_123456789abcd", "sign_up_id": "signup_123456789abcd", "last_active_session_id": "session_123456789abcd", "updated_at": 1632580323, "created_at": 1622481123}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
CreateEmailAddress:
speakeasy-default-create-email-address:
requestBody:
application/json: {"user_id": "user_12345", "email_address": "[email protected]", "verified": false, "primary": true}
responses:
"200":
application/json: {"id": "email_id_56789", "object": "email_address", "email_address": "[email protected]", "reserved": false, "verification": {"status": "verified", "strategy": "admin", "error": {"message": "Invalid input", "long_message": "The input provided does not meet the requirements.", "code": "400_bad_request", "meta": {}, "clerk_trace_id": "trace_123456789abcd"}, "expire_at": 1620000000, "attempts": 0}, "linked_to": [{"type": "oauth_google", "id": "link_12345"}], "matches_sso_connection": true, "created_at": 1615458901, "updated_at": 1615459001}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
GetEmailAddress:
speakeasy-default-get-email-address:
parameters:
path:
email_address_id: "email_address_id_example"
responses:
"200":
application/json: {"id": "email_id_56789", "object": "email_address", "email_address": "[email protected]", "reserved": false, "verification": {"status": "verified", "strategy": "admin", "error": {"message": "Invalid input", "long_message": "The input provided does not meet the requirements.", "code": "400_bad_request", "meta": {}, "clerk_trace_id": "trace_123456789abcd"}, "expire_at": 1620000000, "attempts": 0}, "linked_to": [{"type": "oauth_google", "id": "link_12345"}], "matches_sso_connection": false, "created_at": 1615458901, "updated_at": 1615459001}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
DeleteEmailAddress:
speakeasy-default-delete-email-address:
parameters:
path:
email_address_id: "email_address_id_example"
responses:
"200":
application/json: {"object": "deleted_object", "id": "deleted_object_id_example", "slug": "deleted-object-slug", "deleted": true}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
UpdateEmailAddress:
speakeasy-default-update-email-address:
parameters:
path:
email_address_id: "email_address_id_example"
requestBody:
application/json: {"verified": false, "primary": true}
responses:
"200":
application/json: {"id": "email_id_56789", "object": "email_address", "email_address": "[email protected]", "reserved": false, "verification": {"status": "verified", "strategy": "admin", "error": {"message": "Invalid input", "long_message": "The input provided does not meet the requirements.", "code": "400_bad_request", "meta": {}, "clerk_trace_id": "trace_123456789abcd"}, "expire_at": 1620000000, "attempts": 0}, "linked_to": [{"type": "oauth_google", "id": "link_12345"}], "matches_sso_connection": false, "created_at": 1615458901, "updated_at": 1615459001}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
CreatePhoneNumber:
speakeasy-default-create-phone-number:
requestBody:
application/json: {"user_id": "usr_12345", "phone_number": "+11234567890", "verified": true, "primary": false, "reserved_for_second_factor": false}
responses:
"200":
application/json: {"id": "ph_123456789", "object": "phone_number", "phone_number": "+11234567890", "reserved_for_second_factor": false, "default_second_factor": true, "reserved": false, "verification": {"status": "verified", "strategy": "email_code", "attempts": 1, "expire_at": 1615462399}, "linked_to": [{"type": "oauth_google", "id": "link_12345"}], "backup_codes": ["code1", "code2", "code3"], "created_at": 1594842023, "updated_at": 1604842023}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
GetPhoneNumber:
speakeasy-default-get-phone-number:
parameters:
path:
phone_number_id: "phone_12345"
responses:
"200":
application/json: {"id": "ph_123456789", "object": "phone_number", "phone_number": "+11234567890", "reserved_for_second_factor": false, "default_second_factor": true, "reserved": false, "verification": {"status": "verified", "strategy": "email_code", "attempts": 1, "expire_at": 1615462399}, "linked_to": [{"type": "oauth_google", "id": "link_12345"}], "backup_codes": ["code1", "code2", "code3"], "created_at": 1594842023, "updated_at": 1604842023}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
DeletePhoneNumber:
speakeasy-default-delete-phone-number:
parameters:
path:
phone_number_id: "phone_12345"
responses:
"200":
application/json: {"object": "deleted_object", "id": "deleted_object_id_example", "slug": "deleted-object-slug", "deleted": true}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
UpdatePhoneNumber:
speakeasy-default-update-phone-number:
parameters:
path:
phone_number_id: "phone_12345"
requestBody:
application/json: {"verified": false, "primary": true, "reserved_for_second_factor": true}
responses:
"200":
application/json: {"id": "ph_123456789", "object": "phone_number", "phone_number": "+11234567890", "reserved_for_second_factor": false, "default_second_factor": true, "reserved": false, "verification": {"status": "verified", "strategy": "email_code", "attempts": 1, "expire_at": 1615462399}, "linked_to": [{"type": "oauth_google", "id": "link_12345"}], "backup_codes": ["code1", "code2", "code3"], "created_at": 1594842023, "updated_at": 1604842023}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
GetSessionList:
speakeasy-default-get-session-list:
parameters:
query:
client_id: "client_123"
user_id: "user_456"
status: "active"
limit: 20
offset: 10
responses:
"200":
application/json: [{"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": false, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "e353:de0f:11fb:d018:a1ec:da17:c0d9:e31d", "city": "South Herminiaview", "country": "Republic of Korea"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}]
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
createSession:
speakeasy-default-create-session:
requestBody:
application/json: {"user_id": "<id>"}
responses:
"200":
application/json: {"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": false, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "252.214.104.239", "city": "Urielborough", "country": "Peru"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
GetSession:
speakeasy-default-get-session:
parameters:
path:
session_id: "sess_1234567890abcdef"
responses:
"200":
application/json: {"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": false, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "bbfa:954e:9b14:62cb:8adc:7735:b6aa:fe70", "city": "Kendall", "country": "Iran"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
RevokeSession:
speakeasy-default-revoke-session:
parameters:
path:
session_id: "sess_1234567890abcdef"
responses:
"200":
application/json: {"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": false, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "31.46.247.141", "city": "Sioux Falls", "country": "Austria"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
VerifySession:
speakeasy-default-verify-session:
parameters:
path:
session_id: "sess_w8q4g9s60j28fghv00f3"
requestBody:
application/json: {"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXNzaW9uX2lkIjoic2Vzc193OHF4ZzZzNm9qMjhmZ2h2MDBmMyIsImlhdCI6MTU4MjY0OTg2Mn0.J4KP2L6bEZ6YccHFW4E2vKbOLw_mmO0gF_GNRw-wtLM"}
responses:
"200":
application/json: {"object": "session", "id": "sess_123456789abcd", "user_id": "user_123456789abcd", "client_id": "client_123456789abcd", "actor": null, "status": "active", "last_active_organization_id": "org_123456789abcd", "last_active_at": 1622471123, "latest_activity": {"object": "<value>", "id": "<id>", "device_type": "<value>", "is_mobile": false, "browser_name": "<value>", "browser_version": "<value>", "ip_address": "47.58.193.100", "city": "North Eduardo", "country": "Papua New Guinea"}, "expire_at": 1685471123, "abandon_at": 1630471123, "updated_at": 1622532323, "created_at": 1622470000}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
CreateSessionToken:
speakeasy-default-create-session-token:
parameters:
path:
session_id: "<id>"
requestBody:
application/json: {"expires_in_seconds": 6005.84}
responses:
"200":
application/json: {"object": "token", "jwt": "<value>"}
"401":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
CreateSessionTokenFromTemplate:
speakeasy-default-create-session-token-from-template:
parameters:
path:
session_id: "ses_123abcd4567"
template_name: "custom_hasura"
requestBody:
application/json: {"expires_in_seconds": 2299.84}
responses:
"200":
application/json: {"object": "token", "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvZSBCbG9nZ3MiLCJpYXQiOjE1MTYyMzkwMjJ9.qKVwLLnbfqfM5VCfU8vDhXXXS0VklRcsErgTpELYgfw"}
"401":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
GetTemplateList:
"":
parameters:
path:
template_type: "email"
responses:
"200":
application/json: [{"id": "temp_12345", "object": "template", "instance_id": "inst_67890", "resource_type": "system", "template_type": "email", "name": "Welcome Email", "slug": "welcome_email", "position": 1, "can_revert": false, "can_delete": true, "can_toggle": false, "subject": "Welcome to our service!", "markup": "<p>Hello, {{ user.name }}</p>", "body": "You are now signed up. Welcome!", "available_variables": ["user.name", "user.email"], "required_variables": ["user.name"], "from_email_name": "Clerk Support", "reply_to_email_name": "[email protected]", "delivered_by_clerk": true, "enabled": false, "updated_at": 1610000000, "created_at": 1600000000}, {"id": "temp_12345", "object": "template", "instance_id": "inst_67890", "resource_type": "system", "template_type": "email", "name": "Welcome Email", "slug": "welcome_email", "position": 1, "can_revert": false, "can_delete": true, "can_toggle": true, "subject": "Welcome to our service!", "markup": "<p>Hello, {{ user.name }}</p>", "body": "You are now signed up. Welcome!", "available_variables": ["user.name", "user.email"], "required_variables": ["user.name"], "from_email_name": "Clerk Support", "reply_to_email_name": "[email protected]", "delivered_by_clerk": true, "enabled": true, "updated_at": 1610000000, "created_at": 1600000000}, {"id": "temp_12345", "object": "template", "instance_id": "inst_67890", "resource_type": "system", "template_type": "email", "name": "Welcome Email", "slug": "welcome_email", "position": 1, "can_revert": false, "can_delete": true, "can_toggle": true, "subject": "Welcome to our service!", "markup": "<p>Hello, {{ user.name }}</p>", "body": "You are now signed up. Welcome!", "available_variables": ["user.name", "user.email"], "required_variables": ["user.name"], "from_email_name": "Clerk Support", "reply_to_email_name": "[email protected]", "delivered_by_clerk": true, "enabled": false, "updated_at": 1610000000, "created_at": 1600000000}]
"400":
application/json: {"errors": [{"message": "Invalid input", "long_message": "The input provided does not meet the requirements.", "code": "400_bad_request", "meta": {}, "clerk_trace_id": "trace_123456789abcd"}], "meta": {}}
RevertTemplate:
speakeasy-default-revert-template:
parameters:
path:
template_type: "email"
slug: "welcome-email"
responses:
"200":
application/json: {"id": "temp_12345", "object": "template", "instance_id": "inst_67890", "resource_type": "system", "template_type": "email", "name": "Welcome Email", "slug": "welcome_email", "position": 1, "can_revert": false, "can_delete": true, "can_toggle": true, "subject": "Welcome to our service!", "markup": "<p>Hello, {{ user.name }}</p>", "body": "You are now signed up. Welcome!", "available_variables": ["user.name", "user.email"], "required_variables": ["user.name"], "from_email_name": "Clerk Support", "reply_to_email_name": "[email protected]", "delivered_by_clerk": true, "enabled": false, "updated_at": 1610000000, "created_at": 1600000000}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
GetTemplate:
speakeasy-default-get-template:
parameters:
path:
template_type: "email"
slug: "welcome-email"
responses:
"200":
application/json: {"id": "temp_12345", "object": "template", "instance_id": "inst_67890", "resource_type": "system", "template_type": "email", "name": "Welcome Email", "slug": "welcome_email", "position": 1, "can_revert": false, "can_delete": true, "can_toggle": false, "subject": "Welcome to our service!", "markup": "<p>Hello, {{ user.name }}</p>", "body": "You are now signed up. Welcome!", "available_variables": ["user.name", "user.email"], "required_variables": ["user.name"], "from_email_name": "Clerk Support", "reply_to_email_name": "[email protected]", "delivered_by_clerk": true, "enabled": false, "updated_at": 1610000000, "created_at": 1600000000}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
ToggleTemplateDelivery:
speakeasy-default-toggle-template-delivery:
parameters:
path:
template_type: "email"
slug: "welcome-email"
requestBody:
application/json: {"delivered_by_clerk": true}
responses:
"200":
application/json: {"id": "temp_12345", "object": "template", "instance_id": "inst_67890", "resource_type": "system", "template_type": "email", "name": "Welcome Email", "slug": "welcome_email", "position": 1, "can_revert": false, "can_delete": true, "can_toggle": false, "subject": "Welcome to our service!", "markup": "<p>Hello, {{ user.name }}</p>", "body": "You are now signed up. Welcome!", "available_variables": ["user.name", "user.email"], "required_variables": ["user.name"], "from_email_name": "Clerk Support", "reply_to_email_name": "[email protected]", "delivered_by_clerk": true, "enabled": false, "updated_at": 1610000000, "created_at": 1600000000}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
UpsertTemplate:
speakeasy-default-upsert-template:
parameters:
path:
template_type: "sms"
slug: "verification-code"
requestBody:
application/json: {"name": "Verification Code", "subject": "Your Verification Code", "markup": "<p>Your code: {{code}}</p>", "body": "Use this code to verify your email: {{code}}", "delivered_by_clerk": true, "from_email_name": "hello", "reply_to_email_name": "support"}
responses:
"200":
application/json: {"id": "temp_12345", "object": "template", "instance_id": "inst_67890", "resource_type": "system", "template_type": "email", "name": "Welcome Email", "slug": "welcome_email", "position": 1, "can_revert": false, "can_delete": true, "can_toggle": false, "subject": "Welcome to our service!", "markup": "<p>Hello, {{ user.name }}</p>", "body": "You are now signed up. Welcome!", "available_variables": ["user.name", "user.email"], "required_variables": ["user.name"], "from_email_name": "Clerk Support", "reply_to_email_name": "[email protected]", "delivered_by_clerk": true, "enabled": true, "updated_at": 1610000000, "created_at": 1600000000}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
PreviewTemplate:
speakeasy-default-preview-template:
parameters:
path:
template_type: "email"
slug: "welcome-email"
requestBody:
application/json: {"subject": "Welcome to our service!", "body": "Hi, thank you for joining our service.", "from_email_name": "hello", "reply_to_email_name": "support"}
responses:
"200":
application/json: {}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
GetUserList:
"":
parameters:
query:
email_address: ["[email protected]"]
phone_number: ["+12345678901"]
external_id: ["external-id-123"]
username: ["user123"]
web3_wallet: ["0x123456789abcdef0x123456789abcdef"]
user_id: ["user-id-123"]
organization_id: ["org-id-123"]
query: "John"
email_address_query: "<value>"
phone_number_query: "<value>"
username_query: "<value>"
name_query: "<value>"
last_active_at_before: 1700690400000
last_active_at_after: 1700690400000
last_active_at_since: 1700690400000
created_at_before: 1730160000000
created_at_after: 1730160000000
limit: 20
offset: 10
order_by: "-created_at"
responses:
"200":
application/json: [{"id": "user_id_123", "object": "user", "external_id": "external_user_id_123", "primary_email_address_id": "email_id_123", "primary_phone_number_id": "phone_id_123", "primary_web3_wallet_id": "wallet_id_123", "username": "john_doe", "first_name": "John", "last_name": "Doe", "image_url": "https://example.com/new-profile.jpg", "has_image": true, "public_metadata": {"role": "admin"}, "private_metadata": {"ssn": "123-45-6789"}, "unsafe_metadata": {"theme": "dark"}, "email_addresses": [{"id": "email_id_123", "object": "email_address", "email_address": "[email protected]", "reserved": false, "verification": {"status": "verified", "strategy": "admin", "error": {"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}, "expire_at": 1620000000, "attempts": 0}, "linked_to": [{"type": "oauth_google", "id": "link_12345"}], "matches_sso_connection": false, "created_at": 1609459200, "updated_at": 1609459200}], "phone_numbers": [{"id": "phone_id_123", "object": "phone_number", "phone_number": "+12345678901", "reserved_for_second_factor": false, "default_second_factor": true, "reserved": false, "verification": {"status": "verified", "strategy": "phone_code", "attempts": 2, "expire_at": 1622852400}, "linked_to": [{"type": "oauth_google", "id": "link_id_123"}], "backup_codes": ["code1", "code2", "code3"], "created_at": 1609459200, "updated_at": 1609459200}], "web3_wallets": [{"id": "wallet_id_123", "object": "web3_wallet", "web3_wallet": "0x123456789abcdef", "verification": {"status": "verified", "strategy": "admin", "attempts": 0, "expire_at": 1620000000}, "created_at": 1609459200, "updated_at": 1609459200}], "passkeys": [{"id": "passkey_id_123", "object": "passkey", "name": "My Passkey", "last_used_at": 1615852800, "verification": {"status": "verified", "strategy": "passkey", "nonce": "nonce", "attempts": null, "expire_at": null}}], "password_enabled": true, "two_factor_enabled": true, "totp_enabled": true, "backup_code_enabled": true, "mfa_enabled_at": 1615852800, "mfa_disabled_at": null, "external_accounts": [{}], "saml_accounts": [{"id": "saml_account_id_123", "object": "saml_account", "provider": "SAML Provider", "active": true, "email_address": "[email protected]", "first_name": "John", "last_name": "Doe", "provider_user_id": "prov_user_id_123", "public_metadata": {"department": "IT"}, "verification": {"status": "verified", "strategy": "saml", "attempts": null, "expire_at": null}, "saml_connection": {"id": "sc_1234567890", "name": "My Company SAML Config", "domain": "mycompany.com", "active": true, "provider": "saml_custom", "sync_user_attributes": true, "allow_subdomains": false, "allow_idp_initiated": true, "disable_additional_identifications": true, "created_at": 1614768000, "updated_at": 1622540800}}], "last_sign_in_at": 1622852400, "banned": false, "locked": false, "lockout_expires_in_seconds": null, "verification_attempts_remaining": 5, "updated_at": 1622852400, "created_at": 1609459200, "delete_self_enabled": true, "create_organization_enabled": true, "create_organizations_limit": 152837, "last_active_at": 1700690400000, "legal_accepted_at": 1700690400000}, {"id": "user_id_123", "object": "user", "external_id": "external_user_id_123", "primary_email_address_id": "email_id_123", "primary_phone_number_id": "phone_id_123", "primary_web3_wallet_id": "wallet_id_123", "username": "john_doe", "first_name": "John", "last_name": "Doe", "image_url": "https://example.com/new-profile.jpg", "has_image": true, "public_metadata": {"role": "admin"}, "private_metadata": {"ssn": "123-45-6789"}, "unsafe_metadata": {"theme": "dark"}, "email_addresses": [{"id": "email_id_123", "object": "email_address", "email_address": "[email protected]", "reserved": false, "verification": {"status": "verified", "strategy": "admin", "error": {"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}, "expire_at": 1620000000, "attempts": 0}, "linked_to": [{"type": "oauth_google", "id": "link_12345"}], "matches_sso_connection": false, "created_at": 1609459200, "updated_at": 1609459200}], "phone_numbers": [{"id": "phone_id_123", "object": "phone_number", "phone_number": "+12345678901", "reserved_for_second_factor": false, "default_second_factor": true, "reserved": false, "verification": {"status": "verified", "strategy": "phone_code", "attempts": 2, "expire_at": 1622852400}, "linked_to": [{"type": "oauth_google", "id": "link_id_123"}], "backup_codes": ["code1", "code2", "code3"], "created_at": 1609459200, "updated_at": 1609459200}], "web3_wallets": [{"id": "wallet_id_123", "object": "web3_wallet", "web3_wallet": "0x123456789abcdef", "verification": {"status": "verified", "strategy": "admin", "attempts": 0, "expire_at": 1620000000}, "created_at": 1609459200, "updated_at": 1609459200}], "passkeys": [{"id": "passkey_id_123", "object": "passkey", "name": "My Passkey", "last_used_at": 1615852800, "verification": {"status": "verified", "strategy": "passkey", "nonce": "nonce", "attempts": null, "expire_at": null}}], "password_enabled": true, "two_factor_enabled": true, "totp_enabled": true, "backup_code_enabled": true, "mfa_enabled_at": 1615852800, "mfa_disabled_at": null, "external_accounts": [{}], "saml_accounts": [{"id": "saml_account_id_123", "object": "saml_account", "provider": "SAML Provider", "active": true, "email_address": "[email protected]", "first_name": "John", "last_name": "Doe", "provider_user_id": "prov_user_id_123", "public_metadata": {"department": "IT"}, "verification": {"status": "verified", "strategy": "saml", "attempts": null, "expire_at": null}, "saml_connection": {"id": "sc_1234567890", "name": "My Company SAML Config", "domain": "mycompany.com", "active": true, "provider": "saml_custom", "sync_user_attributes": true, "allow_subdomains": false, "allow_idp_initiated": true, "disable_additional_identifications": false, "created_at": 1614768000, "updated_at": 1622540800}}], "last_sign_in_at": 1622852400, "banned": false, "locked": false, "lockout_expires_in_seconds": null, "verification_attempts_remaining": 5, "updated_at": 1622852400, "created_at": 1609459200, "delete_self_enabled": true, "create_organization_enabled": true, "create_organizations_limit": 86140, "last_active_at": 1700690400000, "legal_accepted_at": 1700690400000}, {"id": "user_id_123", "object": "user", "external_id": "external_user_id_123", "primary_email_address_id": "email_id_123", "primary_phone_number_id": "phone_id_123", "primary_web3_wallet_id": "wallet_id_123", "username": "john_doe", "first_name": "John", "last_name": "Doe", "image_url": "https://example.com/new-profile.jpg", "has_image": true, "public_metadata": {"role": "admin"}, "private_metadata": {"ssn": "123-45-6789"}, "unsafe_metadata": {"theme": "dark"}, "email_addresses": [{"id": "email_id_123", "object": "email_address", "email_address": "[email protected]", "reserved": false, "verification": {"status": "verified", "strategy": "from_oauth_apple", "error": {"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}, "expire_at": 1615462399, "attempts": 1}, "linked_to": [{"type": "oauth_google", "id": "link_12345"}], "matches_sso_connection": false, "created_at": 1609459200, "updated_at": 1609459200}], "phone_numbers": [{"id": "phone_id_123", "object": "phone_number", "phone_number": "+12345678901", "reserved_for_second_factor": false, "default_second_factor": true, "reserved": false, "verification": {"status": "verified", "strategy": "admin", "attempts": 2, "expire_at": 1622852400}, "linked_to": [{"type": "oauth_google", "id": "link_id_123"}], "backup_codes": ["code1", "code2", "code3"], "created_at": 1609459200, "updated_at": 1609459200}], "web3_wallets": [{"id": "wallet_id_123", "object": "web3_wallet", "web3_wallet": "0x123456789abcdef", "verification": {"status": "verified", "strategy": "admin", "attempts": 0, "expire_at": 1620000000}, "created_at": 1609459200, "updated_at": 1609459200}], "passkeys": [{"id": "passkey_id_123", "object": "passkey", "name": "My Passkey", "last_used_at": 1615852800, "verification": {"status": "verified", "strategy": "passkey", "nonce": "nonce", "attempts": null, "expire_at": null}}], "password_enabled": true, "two_factor_enabled": true, "totp_enabled": true, "backup_code_enabled": true, "mfa_enabled_at": 1615852800, "mfa_disabled_at": null, "external_accounts": [{}], "saml_accounts": [{"id": "saml_account_id_123", "object": "saml_account", "provider": "SAML Provider", "active": true, "email_address": "[email protected]", "first_name": "John", "last_name": "Doe", "provider_user_id": "prov_user_id_123", "public_metadata": {"department": "IT"}, "verification": {"status": "verified", "strategy": "saml", "external_verification_redirect_url": "https://example.com/saml_callback", "error": null, "expire_at": 1622852400, "attempts": null}, "saml_connection": {"id": "sc_1234567890", "name": "My Company SAML Config", "domain": "mycompany.com", "active": true, "provider": "saml_custom", "sync_user_attributes": true, "allow_subdomains": false, "allow_idp_initiated": true, "disable_additional_identifications": true, "created_at": 1614768000, "updated_at": 1622540800}}], "last_sign_in_at": 1622852400, "banned": false, "locked": false, "lockout_expires_in_seconds": null, "verification_attempts_remaining": 5, "updated_at": 1622852400, "created_at": 1609459200, "delete_self_enabled": true, "create_organization_enabled": true, "create_organizations_limit": 54607, "last_active_at": 1700690400000, "legal_accepted_at": 1700690400000}]
"400":
application/json: {"errors": [{"message": "Invalid input", "long_message": "The input provided does not meet the requirements.", "code": "400_bad_request", "meta": {}, "clerk_trace_id": "trace_123456789abcd"}], "meta": {}}
CreateUser:
speakeasy-default-create-user:
requestBody:
application/json: {"external_id": "ext-id-001", "first_name": "John", "last_name": "Doe", "email_address": ["[email protected]"], "phone_number": ["+12345678901"], "web3_wallet": ["0x123456789abcdef0x123456789abcdef"], "username": "johndoe123", "password": "Secure*Pass4", "password_digest": "$argon2i$v=19$m=4096,t=3,p=1$4t6CL3P7YiHBtwESXawI8Hm20zJj4cs7/4/G3c187e0$m7RQFczcKr5bIR0IIxbpO2P0tyrLjf3eUW3M3QSwnLc", "password_hasher": "<value>", "skip_password_checks": false, "skip_password_requirement": false, "totp_secret": "base32totpsecretkey", "backup_codes": ["123456", "654321"], "public_metadata": {"role": "user"}, "private_metadata": {"internal_id": "789"}, "unsafe_metadata": {"preferences": {"theme": "dark"}}, "delete_self_enabled": true, "legal_accepted_at": "<value>", "skip_legal_checks": false, "create_organization_enabled": true, "create_organizations_limit": 134365, "created_at": "2023-03-15T07:15:20.902Z"}
responses:
"200":
application/json: {"id": "user_id_123", "object": "user", "external_id": "external_user_id_123", "primary_email_address_id": "email_id_123", "primary_phone_number_id": "phone_id_123", "primary_web3_wallet_id": "wallet_id_123", "username": "john_doe", "first_name": "John", "last_name": "Doe", "image_url": "https://example.com/new-profile.jpg", "has_image": true, "public_metadata": {"role": "admin"}, "private_metadata": {"ssn": "123-45-6789"}, "unsafe_metadata": {"theme": "dark"}, "email_addresses": [{"id": "email_id_56789", "object": "email_address", "email_address": "[email protected]", "reserved": false, "verification": {"status": "verified", "strategy": "admin", "attempts": 0, "expire_at": 1620000000}, "linked_to": [{"type": "oauth_google", "id": "link_12345"}], "matches_sso_connection": true, "created_at": 1615458901, "updated_at": 1615459001}], "phone_numbers": [{"id": "ph_123456789", "object": "phone_number", "phone_number": "+11234567890", "reserved_for_second_factor": false, "default_second_factor": true, "reserved": false, "verification": {"status": "verified", "strategy": "email_code", "attempts": 1, "expire_at": 1615462399}, "linked_to": [{"type": "oauth_google", "id": "link_12345"}], "backup_codes": ["code1", "code2", "code3"], "created_at": 1594842023, "updated_at": 1604842023}], "web3_wallets": [{"id": "wallet_id_123", "object": "web3_wallet", "web3_wallet": "0x123456789abcdef", "verification": {"status": "verified", "strategy": "web3_metamask_signature", "nonce": "nonce_value", "message": "<value>", "attempts": null, "expire_at": null}, "created_at": 1609459200, "updated_at": 1609459200}], "passkeys": [{"id": "passkey_id_123", "object": "passkey", "name": "My Passkey", "last_used_at": 1615852800, "verification": {"status": "verified", "strategy": "passkey", "nonce": "nonce", "attempts": null, "expire_at": null}}], "password_enabled": true, "two_factor_enabled": true, "totp_enabled": true, "backup_code_enabled": true, "mfa_enabled_at": 1615852800, "mfa_disabled_at": null, "external_accounts": [{}], "saml_accounts": [{"id": "saml_account_id_123", "object": "saml_account", "provider": "SAML Provider", "active": true, "email_address": "[email protected]", "first_name": "John", "last_name": "Doe", "provider_user_id": "prov_user_id_123", "public_metadata": {"department": "IT"}, "verification": {"status": "verified", "strategy": "ticket", "attempts": null, "expire_at": null}, "saml_connection": {"id": "sc_1234567890", "name": "My Company SAML Config", "domain": "mycompany.com", "active": true, "provider": "saml_custom", "sync_user_attributes": true, "allow_subdomains": false, "allow_idp_initiated": true, "disable_additional_identifications": true, "created_at": 1614768000, "updated_at": 1622540800}}], "last_sign_in_at": 1622852400, "banned": false, "locked": false, "lockout_expires_in_seconds": null, "verification_attempts_remaining": 5, "updated_at": 1622852400, "created_at": 1609459200, "delete_self_enabled": true, "create_organization_enabled": true, "create_organizations_limit": 86, "last_active_at": 1700690400000, "legal_accepted_at": 1700690400000}
"400":
application/json: {"errors": [{"message": "Error message", "long_message": "Longer error message with more details", "code": "error_code", "meta": {}, "clerk_trace_id": "trace_id"}], "meta": {}}
GetUsersCount:
speakeasy-default-get-users-count:
parameters:
query:
email_address: ["[email protected]"]
phone_number: ["+1234567890"]
external_id: ["external-id-123"]
username: ["username123"]
web3_wallet: ["0x123456789abcdef"]
user_id: ["user-id-123"]
query: "John Doe"
email_address_query: "<value>"
phone_number_query: "<value>"
username_query: "<value>"
responses:
"200":
application/json: {"object": "total_count", "total_count": 100}
"422":