forked from clerk/clerk-sdk-python
-
Notifications
You must be signed in to change notification settings - Fork 0
/
examples.yaml
2236 lines (2236 loc) · 105 KB
/
examples.yaml
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
overlay: 1.0.0
info:
title: Overlay File generated by an LLM to add examples
version: 0.0.1
extends: file://clerk.yaml
actions:
- target: $["paths"]["/public/interstitial"]["get"]["parameters"][0]["schema"]
update:
example: "frontend-api_1a2b3c4d"
- target: $["paths"]["/public/interstitial"]["get"]["parameters"][1]["schema"]
update:
example: "pub_1a2b3c4d"
- target: $["components"]["parameters"]["LimitParameter"]["schema"]
update:
example: 20
- target: $["components"]["parameters"]["OffsetParameter"]["schema"]
update:
example: 10
- target: $["components"]["schemas"]["Session"]["properties"]["object"]
update:
example: "session"
- target: $["components"]["schemas"]["Session"]["properties"]["id"]
update:
example: "sess_123456789abcd"
- target: $["components"]["schemas"]["Session"]["properties"]["user_id"]
update:
example: "user_123456789abcd"
- target: $["components"]["schemas"]["Session"]["properties"]["client_id"]
update:
example: "client_123456789abcd"
- target: $["components"]["schemas"]["Session"]["properties"]["status"]
update:
example: "active"
- target: $["components"]["schemas"]["Session"]["properties"]["last_active_organization_id"]
update:
example: "org_123456789abcd"
- target: $["components"]["schemas"]["Session"]["properties"]["last_active_at"]
update:
example: 1622471123
- target: $["components"]["schemas"]["Session"]["properties"]["expire_at"]
update:
example: 1685471123
- target: $["components"]["schemas"]["Session"]["properties"]["abandon_at"]
update:
example: 1630471123
- target: $["components"]["schemas"]["Session"]["properties"]["updated_at"]
update:
example: 1622532323
- target: $["components"]["schemas"]["Session"]["properties"]["created_at"]
update:
example: 1622470000
- target: $["components"]["schemas"]["Client"]["properties"]["object"]
update:
example: "client"
- target: $["components"]["schemas"]["Client"]["properties"]["id"]
update:
example: "client_123456789abcd"
- target: $["components"]["schemas"]["Client"]["properties"]["session_ids"]
update:
example: ["sess_123456789abcd", "sess_23456789abcd"]
- target: $["components"]["schemas"]["Client"]["properties"]["sign_in_id"]
update:
example: "signin_123456789abcd"
- target: $["components"]["schemas"]["Client"]["properties"]["sign_up_id"]
update:
example: "signup_123456789abcd"
- target: $["components"]["schemas"]["Client"]["properties"]["last_active_session_id"]
update:
example: "session_123456789abcd"
- target: $["components"]["schemas"]["Client"]["properties"]["updated_at"]
update:
example: 1632580323
- target: $["components"]["schemas"]["Client"]["properties"]["created_at"]
update:
example: 1622481123
- target: $["components"]["schemas"]["ClerkError"]["properties"]["message"]
update:
example: "Invalid input"
- target: $["components"]["schemas"]["ClerkError"]["properties"]["long_message"]
update:
example: "The input provided does not meet the requirements."
- target: $["components"]["schemas"]["ClerkError"]["properties"]["code"]
update:
example: "400_bad_request"
- target: $["components"]["schemas"]["ClerkError"]["properties"]["clerk_trace_id"]
update:
example: "trace_123456789abcd"
- target: $["components"]["schemas"]["ClerkErrors"]["properties"]["errors"]
update:
example:
[
{
"message": "Invalid input",
"long_message": "The input provided does not meet the requirements.",
"code": "400_bad_request",
"clerk_trace_id": "trace_123456789abcd",
},
]
- target: $["paths"]["/clients/verify"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["token"]
update:
example: "jwt_token_example"
- target: $["components"]["schemas"]["ClerkError"]["properties"]["meta"]
update:
example: {}
- target: $["components"]["schemas"]["ClerkErrors"]["properties"]["meta"]
update:
example: {}
- target: $["paths"]["/clients/{client_id}"]["get"]["parameters"][0]["schema"]
update:
example: "cli_123456789"
- target: $["paths"]["/email_addresses"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["user_id"]
update:
example: "user_12345"
- target: $["paths"]["/email_addresses"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["email_address"]
update:
example: "[email protected]"
- target: $["paths"]["/email_addresses"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["verified"]
update:
example: false
- target: $["paths"]["/email_addresses"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["primary"]
update:
example: true
- target: $["components"]["schemas"]["OTP"]["properties"]["status"]
update:
example: "verified"
- target: $["components"]["schemas"]["OTP"]["properties"]["strategy"]
update:
example: "email_code"
- target: $["components"]["schemas"]["OTP"]["properties"]["attempts"]
update:
example: 1
- target: $["components"]["schemas"]["OTP"]["properties"]["expire_at"]
update:
example: 1615462399
- target: $["components"]["schemas"]["Admin"]["properties"]["status"]
update:
example: "verified"
- target: $["components"]["schemas"]["Admin"]["properties"]["strategy"]
update:
example: "admin"
- target: $["components"]["schemas"]["Admin"]["properties"]["attempts"]
update:
example: 0
- target: $["components"]["schemas"]["Admin"]["properties"]["expire_at"]
update:
example: 1620000000
- target: $["components"]["schemas"]["Oauth"]["properties"]["status"]
update:
example: "verified"
- target: $["components"]["schemas"]["Oauth"]["properties"]["strategy"]
update:
example: "oauth_google"
- target: $["components"]["schemas"]["Oauth"]["properties"]["external_verification_redirect_url"]
update:
example: "https://oauth.google.com/verify"
- target: $["components"]["schemas"]["Oauth"]["properties"]["error"]
update:
example: null
- target: $["components"]["schemas"]["Oauth"]["properties"]["expire_at"]
update:
example: 1615462399
- target: $["components"]["schemas"]["Oauth"]["properties"]["attempts"]
update:
example: 1
- target: $["components"]["schemas"]["IdentificationLink"]["properties"]["type"]
update:
example: "oauth_google"
- target: $["components"]["schemas"]["IdentificationLink"]["properties"]["id"]
update:
example: "link_12345"
- target: $["components"]["schemas"]["EmailAddress"]["properties"]["id"]
update:
example: "email_id_56789"
- target: $["components"]["schemas"]["EmailAddress"]["properties"]["object"]
update:
example: "email_address"
- target: $["components"]["schemas"]["EmailAddress"]["properties"]["email_address"]
update:
example: "[email protected]"
- target: $["components"]["schemas"]["EmailAddress"]["properties"]["reserved"]
update:
example: false
- target: $["components"]["schemas"]["EmailAddress"]["properties"]["verification"]
update:
example: { "status": "verified", "strategy": "admin" }
- target: $["components"]["schemas"]["EmailAddress"]["properties"]["linked_to"]
update:
example: [{ "type": "oauth_google", "id": "link_12345" }]
- target: $["components"]["schemas"]["EmailAddress"]["properties"]["created_at"]
update:
example: 1615458901
- target: $["components"]["schemas"]["EmailAddress"]["properties"]["updated_at"]
update:
example: 1615459001
- target: $["paths"]["/email_addresses/{email_address_id}"]["get"]["parameters"][0]["schema"]
update:
example: "email_address_id_example"
- target: $["paths"]["/email_addresses/{email_address_id}"]["delete"]["parameters"][0]["schema"]
update:
example: "email_address_id_example"
- target: $["paths"]["/email_addresses/{email_address_id}"]["patch"]["parameters"][0]["schema"]
update:
example: "email_address_id_example"
- target: $["paths"]["/email_addresses/{email_address_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["verified"]
update:
example: false
- target: $["paths"]["/email_addresses/{email_address_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["primary"]
update:
example: true
- target: $["components"]["schemas"]["DeletedObject"]["properties"]["object"]
update:
example: "deleted_object"
- target: $["components"]["schemas"]["DeletedObject"]["properties"]["id"]
update:
example: "deleted_object_id_example"
- target: $["components"]["schemas"]["DeletedObject"]["properties"]["slug"]
update:
example: "deleted-object-slug"
- target: $["components"]["schemas"]["DeletedObject"]["properties"]["deleted"]
update:
example: true
- target: $["paths"]["/phone_numbers"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["user_id"]
update:
example: "usr_12345"
- target: $["paths"]["/phone_numbers"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["phone_number"]
update:
example: "+11234567890"
- target: $["paths"]["/phone_numbers"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["verified"]
update:
example: true
- target: $["paths"]["/phone_numbers"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["primary"]
update:
example: false
- target: $["paths"]["/phone_numbers"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["reserved_for_second_factor"]
update:
example: false
- target: $["components"]["schemas"]["PhoneNumber"]["properties"]["id"]
update:
example: "ph_123456789"
- target: $["components"]["schemas"]["PhoneNumber"]["properties"]["object"]
update:
example: "phone_number"
- target: $["components"]["schemas"]["PhoneNumber"]["properties"]["phone_number"]
update:
example: "+11234567890"
- target: $["components"]["schemas"]["PhoneNumber"]["properties"]["reserved_for_second_factor"]
update:
example: false
- target: $["components"]["schemas"]["PhoneNumber"]["properties"]["default_second_factor"]
update:
example: true
- target: $["components"]["schemas"]["PhoneNumber"]["properties"]["reserved"]
update:
example: false
- target: $["components"]["schemas"]["PhoneNumber"]["properties"]["backup_codes"]
update:
example: ["code1", "code2", "code3"]
- target: $["components"]["schemas"]["PhoneNumber"]["properties"]["created_at"]
update:
example: 1594842023
- target: $["components"]["schemas"]["PhoneNumber"]["properties"]["updated_at"]
update:
example: 1604842023
- target: $["paths"]["/phone_numbers/{phone_number_id}"]["get"]["parameters"][0]["schema"]
update:
example: "phone_12345" # Added example
- target: $["paths"]["/phone_numbers/{phone_number_id}"]["delete"]["parameters"][0]["schema"]
update:
example: "phone_12345" # Added example
- target: $["paths"]["/phone_numbers/{phone_number_id}"]["patch"]["parameters"][0]["schema"]
update:
example: "phone_12345" # Added example
- target: $["paths"]["/phone_numbers/{phone_number_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["verified"]
update:
example: false # Added example
- target: $["paths"]["/phone_numbers/{phone_number_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["primary"]
update:
example: true # Added example
- target: $["paths"]["/phone_numbers/{phone_number_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["reserved_for_second_factor"]
update:
example: true # Added example
- target: $["paths"]["/sessions"]["get"]["parameters"][0]["schema"]
update:
example: "client_123"
- target: $["paths"]["/sessions"]["get"]["parameters"][1]["schema"]
update:
example: "user_456"
- target: $["paths"]["/sessions"]["get"]["parameters"][2]["schema"]
update:
example: "active"
- target: $["components"]["responses"]["Session.List"]["content"]["application/json"]["schema"]
update:
example:
[
{
"object": "session",
"id": "sess_12345",
"user_id": "user_456",
"client_id": "client_123",
"status": "active",
"last_active_organization_id": "org_789",
"last_active_at": 1617970799,
"expire_at": 1620559199,
"abandon_at": 1618853599,
"updated_at": 1619459200,
"created_at": 1617864359,
},
]
- target: $["paths"]["/sessions/{session_id}"]["get"]["parameters"][0]["schema"]
update:
example: "sess_1234567890abcdef"
- target: $["paths"]["/sessions/{session_id}/revoke"]["post"]["parameters"][0]["schema"]
update:
example: "sess_1234567890abcdef"
- target: $["components"]["schemas"]["Session"]["properties"]["actor"]
update:
example: null
- target: $["paths"]["/sessions/{session_id}/verify"]["post"]["parameters"][0]["schema"]
update:
example: "sess_w8q4g9s60j28fghv00f3"
- target: $["paths"]["/sessions/{session_id}/verify"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["token"]
update:
example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXNzaW9uX2lkIjoic2Vzc193OHF4ZzZzNm9qMjhmZ2h2MDBmMyIsImlhdCI6MTU4MjY0OTg2Mn0.J4KP2L6bEZ6YccHFW4E2vKbOLw_mmO0gF_GNRw-wtLM"
- target: $["paths"]["/sessions/{session_id}/tokens/{template_name}"]["post"]["parameters"][0]["schema"]
update:
example: "ses_123abcd4567"
- target: $["paths"]["/sessions/{session_id}/tokens/{template_name}"]["post"]["parameters"][1]["schema"]
update:
example: "custom_hasura"
- target: $["paths"]["/sessions/{session_id}/tokens/{template_name}"]["post"]["responses"]["200"]["content"]["application/json"]["schema"]["properties"]["object"]
update:
example: "token"
- target: $["paths"]["/sessions/{session_id}/tokens/{template_name}"]["post"]["responses"]["200"]["content"]["application/json"]["schema"]["properties"]["jwt"]
update:
example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvZSBCbG9nZ3MiLCJpYXQiOjE1MTYyMzkwMjJ9.qKVwLLnbfqfM5VCfU8vDhXXXS0VklRcsErgTpELYgfw"
- target: $["paths"]["/templates/{template_type}"]["get"]["parameters"][0]
update:
example: "email"
- target: $["components"]["schemas"]["Template"]["properties"]["id"]
update:
example: "temp_12345"
- target: $["components"]["schemas"]["Template"]["properties"]["object"]
update:
example: "template"
- target: $["components"]["schemas"]["Template"]["properties"]["instance_id"]
update:
example: "inst_67890"
- target: $["components"]["schemas"]["Template"]["properties"]["resource_type"]
update:
example: "system"
- target: $["components"]["schemas"]["Template"]["properties"]["template_type"]
update:
example: "email"
- target: $["components"]["schemas"]["Template"]["properties"]["name"]
update:
example: "Welcome Email"
- target: $["components"]["schemas"]["Template"]["properties"]["slug"]
update:
example: "welcome_email"
- target: $["components"]["schemas"]["Template"]["properties"]["position"]
update:
example: 1
- target: $["components"]["schemas"]["Template"]["properties"]["can_revert"]
update:
example: false
- target: $["components"]["schemas"]["Template"]["properties"]["can_delete"]
update:
example: true
- target: $["components"]["schemas"]["Template"]["properties"]["can_disable"]
update:
example: false
- target: $["components"]["schemas"]["Template"]["properties"]["subject"]
update:
example: "Welcome to our service!"
- target: $["components"]["schemas"]["Template"]["properties"]["markup"]
update:
example: "<p>Hello, {{ user.name }}</p>"
- target: $["components"]["schemas"]["Template"]["properties"]["body"]
update:
example: "You are now signed up. Welcome!"
- target: $["components"]["schemas"]["Template"]["properties"]["available_variables"]
update:
example: ["user.name", "user.email"]
- target: $["components"]["schemas"]["Template"]["properties"]["required_variables"]
update:
example: ["user.name"]
- target: $["components"]["schemas"]["Template"]["properties"]["from_email_name"]
update:
example: "Clerk Support"
- target: $["components"]["schemas"]["Template"]["properties"]["reply_to_email_name"]
update:
example: "[email protected]"
- target: $["components"]["schemas"]["Template"]["properties"]["delivered_by_clerk"]
update:
example: true
- target: $["components"]["schemas"]["Template"]["properties"]["updated_at"]
update:
example: 1610000000
- target: $["components"]["schemas"]["Template"]["properties"]["created_at"]
update:
example: 1600000000
- target: $["paths"]["/templates/{template_type}/{slug}"]["get"]["parameters"][0]["schema"]
update:
example: "email"
- target: $["paths"]["/templates/{template_type}/{slug}"]["get"]["parameters"][1]["schema"]
update:
example: "welcome-email"
- target: $["paths"]["/templates/{template_type}/{slug}"]["put"]["parameters"][0]["schema"]
update:
example: "sms"
- target: $["paths"]["/templates/{template_type}/{slug}"]["put"]["parameters"][1]["schema"]
update:
example: "verification-code"
- target: $["paths"]["/templates/{template_type}/{slug}"]["put"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["name"]
update:
example: "Verification Code"
- target: $["paths"]["/templates/{template_type}/{slug}"]["put"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["subject"]
update:
example: "Your Verification Code"
- target: $["paths"]["/templates/{template_type}/{slug}"]["put"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["markup"]
update:
example: "<p>Your code: {{code}}</p>"
- target: $["paths"]["/templates/{template_type}/{slug}"]["put"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["body"]
update:
example: "Use this code to verify your email: {{code}}"
- target: $["paths"]["/templates/{template_type}/{slug}"]["put"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["delivered_by_clerk"]
update:
example: true
- target: $["paths"]["/templates/{template_type}/{slug}"]["put"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["from_email_name"]
update:
example: "hello"
- target: $["paths"]["/templates/{template_type}/{slug}"]["put"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["reply_to_email_name"]
update:
example: "support"
- target: $["paths"]["/templates/{template_type}/{slug}/revert"]["post"]["parameters"][0]["schema"]
update:
example: "email"
- target: $["paths"]["/templates/{template_type}/{slug}/revert"]["post"]["parameters"][1]["schema"]
update:
example: "welcome-email"
- target: $["paths"]["/templates/{template_type}/{slug}/preview"]["post"]["parameters"][0]["schema"]
update:
example: "email"
- target: $["paths"]["/templates/{template_type}/{slug}/preview"]["post"]["parameters"][1]["schema"]
update:
example: "welcome-email"
- target: $["paths"]["/templates/{template_type}/{slug}/preview"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["subject"]
update:
example: "Welcome to our service!"
- target: $["paths"]["/templates/{template_type}/{slug}/preview"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["body"]
update:
example: "Hi, thank you for joining our service."
- target: $["paths"]["/templates/{template_type}/{slug}/preview"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["from_email_name"]
update:
example: "hello"
- target: $["paths"]["/templates/{template_type}/{slug}/preview"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["reply_to_email_name"]
update:
example: "support"
- target: $["paths"]["/templates/{template_type}/{slug}/toggle_delivery"]["post"]["parameters"][0]["schema"]
update:
example: "email"
- target: $["paths"]["/templates/{template_type}/{slug}/toggle_delivery"]["post"]["parameters"][1]["schema"]
update:
example: "welcome-email"
- target: $["paths"]["/templates/{template_type}/{slug}/toggle_delivery"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["delivered_by_clerk"]
update:
example: true
- target: $["paths"]["/users"]["get"]["parameters"][0]["schema"]
update:
example: ["[email protected]"]
- target: $["paths"]["/users"]["get"]["parameters"][1]["schema"]
update:
example: ["+12345678901"]
- target: $["paths"]["/users"]["get"]["parameters"][2]["schema"]
update:
example: ["external-id-123"]
- target: $["paths"]["/users"]["get"]["parameters"][3]["schema"]
update:
example: ["user123"]
- target: $["paths"]["/users"]["get"]["parameters"][4]["schema"]
update:
example: ["0x123456789abcdef0x123456789abcdef"]
- target: $["paths"]["/users"]["get"]["parameters"][5]["schema"]
update:
example: ["user-id-123"]
- target: $["paths"]["/users"]["get"]["parameters"][6]["schema"]
update:
example: ["org-id-123"]
- target: $["paths"]["/users"]["get"]["parameters"][7]["schema"]
update:
example: "John"
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["external_id"]
update:
example: "ext-id-001"
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["first_name"]
update:
example: "John"
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["last_name"]
update:
example: "Doe"
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["email_address"]["items"]
update:
example: "[email protected]"
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["phone_number"]["items"]
update:
example: "+12345678901"
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["web3_wallet"]["items"]
update:
example: "0x123456789abcdef0x123456789abcdef"
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["username"]
update:
example: "johndoe123"
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["password"]
update:
example: "Secure*Pass4"
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["password_digest"]
update:
example: "$argon2i$v=19$m=4096,t=3,p=1$4t6CL3P7YiHBtwESXawI8Hm20zJj4cs7/4/G3c187e0$m7RQFczcKr5bIR0IIxbpO2P0tyrLjf3eUW3M3QSwnLc"
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["password_hasher"]
update:
example: "argon2i"
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["skip_password_checks"]
update:
example: false
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["skip_password_requirement"]
update:
example: false
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["totp_secret"]
update:
example: "base32totpsecretkey"
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["backup_codes"]
update:
example:
- "123456"
- "654321"
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["public_metadata"]
update:
example: { "role": "user" }
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["private_metadata"]
update:
example: { "internal_id": "789" }
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["unsafe_metadata"]
update:
example: { "preferences": { "theme": "dark" } }
- target: $["paths"]["/users"]["post"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["created_at"]
update:
example: "2023-03-15T07:15:20.902Z"
- target: $["components"]["schemas"]["PhoneNumber"]["properties"]["verification"]
update:
example:
{
"status": "verified",
"strategy": "phone_code",
"attempts": 2,
"expire_at": 1622852400,
}
- target: $["components"]["schemas"]["PhoneNumber"]["properties"]["linked_to"]
update:
example: [{ "type": "oauth_google", "id": "link_id_123" }]
- target: $["components"]["schemas"]["Web3Signature"]["properties"]["status"]
update:
example: "verified"
- target: $["components"]["schemas"]["Web3Signature"]["properties"]["strategy"]
update:
example: "web3_metamask_signature"
- target: $["components"]["schemas"]["Web3Signature"]["properties"]["nonce"]
update:
example: "nonce_value"
- target: $["components"]["schemas"]["Web3Signature"]["properties"]["attempts"]
update:
example: null
- target: $["components"]["schemas"]["Web3Signature"]["properties"]["expire_at"]
update:
example: null
- target: $["components"]["schemas"]["Web3Wallet"]["properties"]["id"]
update:
example: "wallet_id_123"
- target: $["components"]["schemas"]["Web3Wallet"]["properties"]["object"]
update:
example: "web3_wallet"
- target: $["components"]["schemas"]["Web3Wallet"]["properties"]["web3_wallet"]
update:
example: "0x123456789abcdef"
- target: $["components"]["schemas"]["Web3Wallet"]["properties"]["verification"]
update:
example:
{
"status": "verified",
"strategy": "web3_metamask_signature",
"nonce": "nonce_value",
}
- target: $["components"]["schemas"]["Web3Wallet"]["properties"]["created_at"]
update:
example: 1609459200
- target: $["components"]["schemas"]["Web3Wallet"]["properties"]["updated_at"]
update:
example: 1609459200
- target: $["components"]["schemas"]["Passkey"]["properties"]["status"]
update:
example: "verified"
- target: $["components"]["schemas"]["Passkey"]["properties"]["strategy"]
update:
example: "passkey"
- target: $["components"]["schemas"]["Passkey"]["properties"]["nonce"]
update:
example: "nonce_value"
- target: $["components"]["schemas"]["Passkey"]["properties"]["attempts"]
update:
example: null
- target: $["components"]["schemas"]["Passkey"]["properties"]["expire_at"]
update:
example: null
- target: $["components"]["schemas"]["schemas-Passkey"]["properties"]["id"]
update:
example: "passkey_id_123"
- target: $["components"]["schemas"]["schemas-Passkey"]["properties"]["object"]
update:
example: "passkey"
- target: $["components"]["schemas"]["schemas-Passkey"]["properties"]["name"]
update:
example: "My Passkey"
- target: $["components"]["schemas"]["schemas-Passkey"]["properties"]["last_used_at"]
update:
example: 1615852800
- target: $["components"]["schemas"]["schemas-Passkey"]["properties"]["verification"]
update:
example:
{ "status": "verified", "strategy": "passkey", "nonce": "nonce_value" }
- target: $["components"]["schemas"]["SAML"]["properties"]["status"]
update:
example: "verified"
- target: $["components"]["schemas"]["SAML"]["properties"]["strategy"]
update:
example: "saml"
- target: $["components"]["schemas"]["SAML"]["properties"]["external_verification_redirect_url"]
update:
example: "https://example.com/saml_callback"
- target: $["components"]["schemas"]["SAML"]["properties"]["error"]
update:
example: null
- target: $["components"]["schemas"]["SAML"]["properties"]["expire_at"]
update:
example: 1622852400
- target: $["components"]["schemas"]["SAML"]["properties"]["attempts"]
update:
example: null
- target: $["components"]["schemas"]["Ticket"]["properties"]["status"]
update:
example: "verified"
- target: $["components"]["schemas"]["Ticket"]["properties"]["strategy"]
update:
example: "ticket"
- target: $["components"]["schemas"]["Ticket"]["properties"]["attempts"]
update:
example: null
- target: $["components"]["schemas"]["Ticket"]["properties"]["expire_at"]
update:
example: null
- target: $["components"]["schemas"]["SAMLAccount"]["properties"]["id"]
update:
example: "saml_account_id_123"
- target: $["components"]["schemas"]["SAMLAccount"]["properties"]["object"]
update:
example: "saml_account"
- target: $["components"]["schemas"]["SAMLAccount"]["properties"]["provider"]
update:
example: "SAML Provider"
- target: $["components"]["schemas"]["SAMLAccount"]["properties"]["active"]
update:
example: true
- target: $["components"]["schemas"]["SAMLAccount"]["properties"]["email_address"]
update:
example: "[email protected]"
- target: $["components"]["schemas"]["SAMLAccount"]["properties"]["first_name"]
update:
example: "John"
- target: $["components"]["schemas"]["SAMLAccount"]["properties"]["last_name"]
update:
example: "Doe"
- target: $["components"]["schemas"]["SAMLAccount"]["properties"]["provider_user_id"]
update:
example: "prov_user_id_123"
- target: $["components"]["schemas"]["SAMLAccount"]["properties"]["public_metadata"]
update:
example: { "department": "IT" }
- target: $["components"]["schemas"]["SAMLAccount"]["properties"]["verification"]
update:
example:
{
"status": "verified",
"strategy": "saml",
"external_verification_redirect_url": "https://example.com/saml_callback",
}
- target: $["components"]["schemas"]["User"]["properties"]["id"]
update:
example: "user_id_123"
- target: $["components"]["schemas"]["User"]["properties"]["object"]
update:
example: "user"
- target: $["components"]["schemas"]["User"]["properties"]["external_id"]
update:
example: "external_user_id_123"
- target: $["components"]["schemas"]["User"]["properties"]["primary_email_address_id"]
update:
example: "email_id_123"
- target: $["components"]["schemas"]["User"]["properties"]["primary_phone_number_id"]
update:
example: "phone_id_123"
- target: $["components"]["schemas"]["User"]["properties"]["primary_web3_wallet_id"]
update:
example: "wallet_id_123"
- target: $["components"]["schemas"]["User"]["properties"]["username"]
update:
example: "john_doe"
- target: $["components"]["schemas"]["User"]["properties"]["first_name"]
update:
example: "John"
- target: $["components"]["schemas"]["User"]["properties"]["last_name"]
update:
example: "Doe"
- target: $["components"]["schemas"]["User"]["properties"]["profile_image_url"]
update:
example: "https://example.com/profile.jpg"
- target: $["components"]["schemas"]["User"]["properties"]["image_url"]
update:
example: "https://example.com/new-profile.jpg"
- target: $["components"]["schemas"]["User"]["properties"]["has_image"]
update:
example: true
- target: $["components"]["schemas"]["User"]["properties"]["public_metadata"]
update:
example: { "role": "admin" }
- target: $["components"]["schemas"]["User"]["properties"]["private_metadata"]
update:
example: { "ssn": "123-45-6789" }
- target: $["components"]["schemas"]["User"]["properties"]["unsafe_metadata"]
update:
example: { "theme": "dark" }
- target: $["components"]["schemas"]["User"]["properties"]["email_addresses"]
update:
example:
[
{
"id": "email_id_123",
"object": "email_address",
"email_address": "[email protected]",
"verification": { "status": "verified", "strategy": "email_code" },
"created_at": 1609459200,
"updated_at": 1609459200,
},
]
- target: $["components"]["schemas"]["User"]["properties"]["phone_numbers"]
update:
example:
[
{
"id": "phone_id_123",
"object": "phone_number",
"phone_number": "+12345678901",
"verification": { "status": "verified", "strategy": "phone_code" },
"created_at": 1609459200,
"updated_at": 1609459200,
},
]
- target: $["components"]["schemas"]["User"]["properties"]["web3_wallets"]
update:
example:
[
{
"id": "wallet_id_123",
"object": "web3_wallet",
"web3_wallet": "0x123456789abcdef",
"verification":
{ "status": "verified", "strategy": "web3_metamask_signature" },
"created_at": 1609459200,
"updated_at": 1609459200,
},
]
- target: $["components"]["schemas"]["User"]["properties"]["passkeys"]
update:
example:
[
{
"id": "passkey_id_123",
"object": "passkey",
"name": "My Passkey",
"last_used_at": 1615852800,
"verification": { "status": "verified", "strategy": "passkey" },
},
]
- target: $["components"]["schemas"]["User"]["properties"]["password_enabled"]
update:
example: true
- target: $["components"]["schemas"]["User"]["properties"]["two_factor_enabled"]
update:
example: true
- target: $["components"]["schemas"]["User"]["properties"]["totp_enabled"]
update:
example: true
- target: $["components"]["schemas"]["User"]["properties"]["backup_code_enabled"]
update:
example: true
- target: $["components"]["schemas"]["User"]["properties"]["mfa_enabled_at"]
update:
example: 1615852800
- target: $["components"]["schemas"]["User"]["properties"]["mfa_disabled_at"]
update:
example: null
- target: $["components"]["schemas"]["User"]["properties"]["external_accounts"]
update:
example:
[
{
"id": "ext_account_id_123",
"provider": "Facebook",
"user_id": "user_id_at_provider",
},
]
- target: $["components"]["schemas"]["User"]["properties"]["saml_accounts"]
update:
example:
[
{
"id": "saml_account_id_123",
"object": "saml_account",
"provider": "SAML Provider",
"active": true,
"email_address": "[email protected]",
"public_metadata": { "department": "IT" },
"verification": { "status": "verified", "strategy": "saml" },
},
]
- target: $["components"]["schemas"]["User"]["properties"]["last_sign_in_at"]
update:
example: 1622852400
- target: $["components"]["schemas"]["User"]["properties"]["banned"]
update:
example: false
- target: $["components"]["schemas"]["User"]["properties"]["locked"]
update:
example: false
- target: $["components"]["schemas"]["User"]["properties"]["lockout_expires_in_seconds"]
update:
example: null
- target: $["components"]["schemas"]["User"]["properties"]["verification_attempts_remaining"]
update:
example: 5
- target: $["components"]["schemas"]["User"]["properties"]["updated_at"]
update:
example: 1622852400
- target: $["components"]["schemas"]["User"]["properties"]["created_at"]
update:
example: 1609459200
- target: $["components"]["schemas"]["User"]["properties"]["delete_self_enabled"]
update:
example: true
- target: $["components"]["schemas"]["User"]["properties"]["create_organization_enabled"]
update:
example: true
- target: $["paths"]["/users/count"]["get"]["parameters"][0]["schema"]
update:
example: ["[email protected]"]
- target: $["paths"]["/users/count"]["get"]["parameters"][1]["schema"]
update:
example: ["+1234567890"]
- target: $["paths"]["/users/count"]["get"]["parameters"][2]["schema"]
update:
example: ["external-id-123"]
- target: $["paths"]["/users/count"]["get"]["parameters"][3]["schema"]
update:
example: ["username123"]
- target: $["paths"]["/users/count"]["get"]["parameters"][4]["schema"]
update:
example: ["0x123456789abcdef"]
- target: $["paths"]["/users/count"]["get"]["parameters"][5]["schema"]
update:
example: ["user-id-123"]
- target: $["paths"]["/users/count"]["get"]["parameters"][6]["schema"]
update:
example: "John Doe"
- target: $["components"]["schemas"]["TotalCount"]["properties"]["object"]
update:
example: "total_count"
- target: $["components"]["schemas"]["TotalCount"]["properties"]["total_count"]
update:
example: 100
- target: $["paths"]["/users/{user_id}"]["get"]["parameters"][0]["schema"]
update:
example: "usr_1"
- target: $["paths"]["/users/{user_id}"]["patch"]["parameters"][0]["schema"]
update:
example: "usr_1"
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["external_id"]
update:
example: "ext_123"
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["first_name"]
update:
example: "Jane"
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["last_name"]
update:
example: "Doe"
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["primary_email_address_id"]
update:
example: "eml_12345"
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["notify_primary_email_address_changed"]
update:
example: true
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["primary_phone_number_id"]
update:
example: "phn_67890"
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["primary_web3_wallet_id"]
update:
example: "wlt_123"
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["username"]
update:
example: "janedoe"
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["profile_image_id"]
update:
example: "img_789"
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["password"]
update:
example: "secretPass123!"
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["password_digest"]
update:
example: "$argon2i$v=19$m=4096,t=3,p=1$4t6CL3P7YiHBtwESXawI8Hm20zJj4cs7/4/G3c187e0$m7RQFczcKr5bIR0IIxbpO2P0tyrLjf3eUW3M3QSwnLc"
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["password_hasher"]
update:
example: "argon2i"
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["skip_password_checks"]
update:
example: false
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["sign_out_of_other_sessions"]
update:
example: true
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["totp_secret"]
update:
example: "ABCD1234EFGH5678"
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["backup_codes"]
update:
example:
- "123456"
- "654321"
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["public_metadata"]
update:
example: { "theme": "dark" }
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["private_metadata"]
update:
example: { "vip": true }
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["unsafe_metadata"]
update:
example: { "age": 30 }
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["delete_self_enabled"]
update:
example: true
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["create_organization_enabled"]
update:
example: false
- target: $["paths"]["/users/{user_id}"]["patch"]["requestBody"]["content"]["application/json"]["schema"]["properties"]["created_at"]
update:
example: "2021-04-05T14:30:00.000Z"
- target: $["paths"]["/users/{user_id}"]["delete"]["parameters"][0]["schema"]
update:
example: "usr_1"
- target: $["paths"]["/users/{user_id}/ban"]["post"]["parameters"][0]["schema"]
update:
example: "user_12345"
- target: $["paths"]["/users/{user_id}/unban"]["post"]["parameters"][0]["schema"]
update:
example: "user_12345"
- target: $["paths"]["/users/{user_id}/lock"]["post"]["parameters"][0]["schema"]
update:
example: "user_123456789"
- target: $["paths"]["/users/{user_id}/unlock"]["post"]["parameters"][0]["schema"]
update:
example: "user_12345"
- target: $["paths"]["/users/{user_id}/profile_image"]["post"]["parameters"][0]["schema"]
update:
example: "usr_test123"
- target: $["paths"]["/users/{user_id}/profile_image"]["delete"]["parameters"][0]["schema"]
update:
example: "usr_test123"
- target: $["paths"]["/users/{user_id}/metadata"]["patch"]["parameters"][0]["schema"]
update:
example: "user_123456789"
- target: $["paths"]["/users/{user_id}/oauth_access_tokens/{provider}"]["get"]["parameters"][0]["schema"]
update:
example: "user_123"
- target: $["paths"]["/users/{user_id}/oauth_access_tokens/{provider}"]["get"]["parameters"][1]["schema"]
update:
example: "oauth_google"
- target: $["paths"]["/users/{user_id}/oauth_access_tokens/{provider}"]["get"]["responses"]["200"]["content"]["application/json"]["schema"]["items"]["properties"]["object"]
update:
example: "oauth_access_token"
- target: $["paths"]["/users/{user_id}/oauth_access_tokens/{provider}"]["get"]["responses"]["200"]["content"]["application/json"]["schema"]["items"]["properties"]["external_account_id"]
update:
example: "external_account_456"
- target: $["paths"]["/users/{user_id}/oauth_access_tokens/{provider}"]["get"]["responses"]["200"]["content"]["application/json"]["schema"]["items"]["properties"]["provider_user_id"]
update:
example: "provider_user_789"
- target: $["paths"]["/users/{user_id}/oauth_access_tokens/{provider}"]["get"]["responses"]["200"]["content"]["application/json"]["schema"]["items"]["properties"]["token"]