generated from openziti/template-repo
-
Notifications
You must be signed in to change notification settings - Fork 2
/
client.yml
5424 lines (5419 loc) · 172 KB
/
client.yml
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
consumes:
- application/json
produces:
- application/json
schemes:
- https
swagger: "2.0"
info:
description: OpenZiti Edge Client API
title: Ziti Edge Client
contact:
name: OpenZiti
url: https://openziti.discourse.group
email: help@openziti.org
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.26.20
host: demo.ziti.dev
basePath: /edge/client/v1
paths:
/:
get:
security: []
tags:
- Informational
summary: Returns version information
operationId: listRoot
responses:
"200":
description: Version information for the controller
schema:
$ref: '#/definitions/listVersionEnvelope'
/.well-known/est/cacerts:
get:
security: []
description: |
This endpoint is used during enrollments to bootstrap trust between enrolling clients and the Ziti Edge API.
This endpoint returns a base64 encoded PKCS7 store. The content can be base64 decoded and parsed by any library
that supports parsing PKCS7 stores.
produces:
- application/pkcs7-mime
tags:
- Well Known
summary: Get CA Cert Store
operationId: listWellKnownCas
responses:
"200":
description: A base64 encoded PKCS7 store
schema:
type: string
example: |
MIIMUQYJKoZIhvcNAQcCoIIMQjCCDD4CAQExADALBgkqhkiG9w0BBwGgggwkMIIG
BjCCA+6gAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwgZcxCzAJBgNVBAYTAlVTMRcw
FQYDVQQIDA5Ob3J0aCBDYXJvbGluYTESMBAGA1UEBwwJQ2hhcmxvdHRlMRMwEQYD
VQQKDApOZXRGb3VuZHJ5MSkwJwYDVQQLDCBOZXRGb3VuZHJ5IENlcnRpZmljYXRl
IEF1dGhvcml0eTEbMBkGA1UEAwwSTmV0Rm91bmRyeSBSb290IENBMB4XDTE4MDUx
ODE2NTcyM1oXDTI4MDUxNTE2NTcyM1owgYsxCzAJBgNVBAYTAlVTMRcwFQYDVQQI
DA5Ob3J0aCBDYXJvbGluYTETMBEGA1UECgwKTmV0Rm91bmRyeTEpMCcGA1UECwwg
TmV0Rm91bmRyeSBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkxIzAhBgNVBAMMGk5ldEZv
dW5kcnkgSW50ZXJtZWRpYXRlIENBMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIIC
CgKCAgEAsb1EPhMUweS9WpjT7L54xAOmZqugJ6fhSrFfLUwNUy172q+ASvZTpT1z
KIPcZpGmPB3TX2bHaAR67BbRkUR11JgWE3U8+FsGrYmPZtaKM6fg8Mh0WZ41oMYQ
NJyQixOktrgqfybyJoT5PeT5AA7QQmd8mku2X9nkAu6gWPf2nHNc7SeQdijmyQQa
VK3oqyaxOzWzsU/XbfMEz/ObkefUxgt5Z6jlK0xcW0Q+QgtawMKLUiuo6obWRPcl
7Hm9Sze8XJS5pbvS5JkUszxoRZuDVHZylrlHIpA/IL+BnvS+M7SP28UWe9skrv/s
6ACpJtuPJ1EYf5fakugOpY7i+hq7YNi//csbc49Qjn2OtttrR7JcTaHUEU1I/tQb
QGAtNkI4pJjRVUdDawQFQlWHZD1COixNLErs2HzAI00DhLrY6SKITI/kjN0Xx010
XdMcdfay0PLWm6RwxiRmMQFL4GNIC895NF1q6xV4W4rWgqUNlcvKpy+i1chWpRbU
He16ul0qh10fcESrRvAbXn5YrQJLrwbSr+85ubN8lYdNLE0qg2cIXZlUilarZZzW
ghtCe+KkUpjfRuAi/CqfSwNK3QXEfeVEK6S49mHeSekOizFIw7fmDhCz9vXwMOnb
ryRSLEJks0gIRcSDVChXheAqC98y4kcQdniNWFnqJXoqA+rrSokCAwEAAaNmMGQw
HQYDVR0OBBYEFK8UXC/sq6dGVFAqEXHsQDzqzwuUMB8GA1UdIwQYMBaAFEHz6RRu
OuXj2mwAzOeUinfWeivpMBIGA1UdEwEB/wQIMAYBAf8CAQAwDgYDVR0PAQH/BAQD
AgGGMA0GCSqGSIb3DQEBCwUAA4ICAQBDAAaOE2Nbb49eOjyTNxIeOB+ZKQjJ1hUE
gRrootAA8NYbtKW/vyxTWnNi5XOGXd4DFS9OKZ0mL/7NyLc0mbTwPH2ZT8KTPUTS
Cpo6yktZ/7TMjyAtWZiOMg2EH+6m/nlNSXk/v5fb8+JQLdZfpxoA017dHh3tc8l7
KOskCZNwQHgF/YMXrPXUNbsGkXRuJLtpjPw5O9GvPys7p+a1aJH1WCTly9zfB6j+
rMF+UGCPDT30sxitVlohik83j6pKLgEAP/gi8nJbILlTP7ce+gJeHR2tfDvmK91X
6QgCF2STUFBU7/9H1/pPRRykOxQpAd8xqSgqGEyp9Ie4tysZjwoUEnG8IVJ5ykrI
Fximvnb4B+LABV9WEo08n8m1R8wEryrISi8fBPn3Pr5nuayOfFLa15CLTkZF40FN
8ika1qNZy8bWRDwTZJQUUb7VCheRWcMwdZdNmhl3J+VZLpQ+ruW7b2ajwacHz5Nw
BHKNcmxXb/4vHq/BnlcayHnSqT6036+OZQ+owDegcYmWV6LaM7xLErjHz2EE38M2
YSiW5SU1zluDe+iHb6l3Gd3Fj/X1gkMWFgYh0XPMSUSyimLNYzy4THKzmWlcQNFo
LLiIDbLrMt+vk+vBkIsNTTPXRJOFPBhmIF6uIUj+2YhzNotX/pQtqMKms3pPlmHq
dH6biwygETCCBhYwggP+oAMCAQICCQDquKpymLJ5WzANBgkqhkiG9w0BAQsFADCB
lzELMAkGA1UEBhMCVVMxFzAVBgNVBAgMDk5vcnRoIENhcm9saW5hMRIwEAYDVQQH
DAlDaGFybG90dGUxEzARBgNVBAoMCk5ldEZvdW5kcnkxKTAnBgNVBAsMIE5ldEZv
dW5kcnkgQ2VydGlmaWNhdGUgQXV0aG9yaXR5MRswGQYDVQQDDBJOZXRGb3VuZHJ5
IFJvb3QgQ0EwHhcNMTgwNTE4MTY1NDQ3WhcNMzgwNTEzMTY1NDQ3WjCBlzELMAkG
A1UEBhMCVVMxFzAVBgNVBAgMDk5vcnRoIENhcm9saW5hMRIwEAYDVQQHDAlDaGFy
bG90dGUxEzARBgNVBAoMCk5ldEZvdW5kcnkxKTAnBgNVBAsMIE5ldEZvdW5kcnkg
Q2VydGlmaWNhdGUgQXV0aG9yaXR5MRswGQYDVQQDDBJOZXRGb3VuZHJ5IFJvb3Qg
Q0EwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDKq/Xa+749Cr3WJGYD
DIEtNKIRnTFc6TeiRSm/O7hG2+1Nrh/dObjZJuDjsopWP8NFA/DwlNyEphYKAeSw
HDmu+4nFd6ifoeDE2lYq6bNhLcgN+A3MlN5Phb2rnO32YYZwHXGWov+jtd2gaK0f
WsH8CQxn6n2v7qvPMTeYFP8p4jqTZw2bvZWw+LMYTFCy541DFqQLQasMg10mXRAV
XO7Oa9y+D1re1zLq4wS6u8ItJoKzfmvZkMvD90C/tQ4u0iJaL7GB2SE9MOPDeGVv
pnoSAIkSVmvRDUAj2x9PuukykzoL1OAWzc5Cg+5LxRmLejVE7PvPcHaTtNag2tRD
w2vbMeFKN8NvQH1QYcaPWZe4Vl9b6DAuTaH5RN919H/F+ZHyjZybVPwC14lflneI
KyNy8JEV/YMIbEADWnuiedzDehk2Opn+0+9Zr2X/xfjCo8iWHFbNaVnQX7wdRaOo
783lEouncqe46FDBLBpyAuDKHQpIT3MK8rkC/1yBNxsH44vMweUZuK0u7PC9KHtm
pQfuflYGfxA34kY6WU3jzyQHetoLYjoxTqNEEjuGpwy2o1j7RaCBEFIbYlnlbhpE
WFTaQf96z2GQ6m1U3y7JyDflHSu9Fo1JNkG3qXsjDwda/6W7NRJRgdFrhnOwrm7F
6L9X4P1HnzU/VJL66LwPmiHVjQIDAQABo2MwYTAdBgNVHQ4EFgQUQfPpFG465ePa
bADM55SKd9Z6K+kwHwYDVR0jBBgwFoAUQfPpFG465ePabADM55SKd9Z6K+kwDwYD
VR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIB
ACfU74aKWROaxnue8tZb5PFkEbnDRcRrKXRhnptA0vrgB4ydnYxX9hEBZD8o6PBy
3rewvl5meSOBE6zyb4JD80lHdzHSVFIwbzsNOeEjCslv/PA/3Y+J7DCt6gPNMDeY
uEssdqeSiMoYz2gnven4flSMKgTAJd3/SpVrn35HzXiU9MkmFVpPEMnTctOjw+Jn
cCkG5+D9N14dxtgZ/tUfbH+GUfhyGVxRdPrX5KQqAyapMfEaMXXa8KNs7PG+sDiS
WI+Sg9jUGtxgkfKdVNtFW+QMXyy7eT3iXPA+1r2hFAhgfIaGtBJUhxPHMhKtjbAg
AX+6+2D3GAbaD1+lcQHhKry3hygQ3OX79FJW6zyPS0tiV/LfovHqX/3x9q5PTVBO
wEOS2/LCc4R2M7S+HIPf4eSJ+nH4uCIdJ42WCror/mRsuL7geCksi70GHuCynP4y
qQFszu/UtbBEsN8loTnLpOInxaGB1Y8UPm14b2Lo1/3HkoMVh0/UaHJ0TmnZ1r7m
fGhfRyAZYRdvT1sB+Eb4b5A2zEZqsTc9IwFOhnI4ZilPoZ5s2xejqrVw3GSvovEh
dprrQmvxuh+VQ23y/+/4z9b2xWyDu2zVveB4whqPe2rkgxJrEl4GfLk2DW+dN6j8
3Zl4lPoUZYwzkC6raCaHyFlAoaTbqz0H6rvVJYxJPS6UoQAxAA==
/authenticate:
post:
security: []
description: |
Allowed authentication methods include "password", "cert", and "ext-jwt"
tags:
- Authentication
summary: Authenticate via a method supplied via a query string parameter
operationId: authenticate
parameters:
- name: auth
in: body
schema:
$ref: '#/definitions/authenticate'
responses:
"200":
description: The API session associated with the session used to issue the
request
schema:
$ref: '#/definitions/currentApiSessionDetailEnvelope'
examples:
default:
data:
_links:
self:
href: ./current-api-session
configTypes: []
createdAt: "2020-03-09T19:03:49.1883693Z"
expiresAt: "2020-03-09T19:34:21.5600897Z"
id: 27343114-b44f-406e-9981-f3c4f2f28d54
identity:
_links:
self:
href: ./identities/66352d7b-a6b2-4ce9-85bb-9f18e318704d
id: 66352d7b-a6b2-4ce9-85bb-9f18e318704d
name: Default Admin
urlName: identities
tags:
- userField1: 123
- userField2: asdf
token: 28bb0ed2-0577-4632-ae70-d17106b92871
updatedAt: "2020-03-09T19:04:21.5600897Z"
meta: {}
"400":
description: The supplied request contains invalid fields or could not be
parsed (json and non-json bodies). The error's code, message, and cause
fields can be inspected for further information
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause:
details:
context: (root)
field: (root)
property: fooField3
field: (root)
message: '(root): fooField3 is required'
type: required
value:
fooField: abc
fooField2: def
causeMessage: schema validation failed
code: COULD_NOT_VALIDATE
message: The supplied request contains an invalid document
requestId: ac6766d6-3a09-44b3-8d8a-1b541d97fdd9
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
"401":
description: The authentication request could not be processed as the credentials
are invalid
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause: ""
causeMessage: ""
code: INVALID_AUTH
message: The authentication request failed
requestId: 5952ed10-3091-474f-a691-47ebab6990dc
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
"429":
description: The resource requested is rate limited and the rate limit has
been exceeded
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
causeMessage: you have hit a rate limit in the requested operation
code: RATE_LIMITED
message: The resource is rate limited and the rate limit has been
exceeded. Please try again later
requestId: 270908d6-f2ef-4577-b973-67bec18ae376
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
parameters:
- enum:
- password
- cert
- ext-jwt
type: string
name: method
in: query
required: true
/authenticate/mfa:
post:
security:
- ztSession: []
- oauth2:
- openid
description: Completes MFA authentication by submitting a MFA time based one
time token or backup code.
tags:
- Authentication
- MFA
summary: Complete MFA authentication
operationId: authenticateMfa
parameters:
- description: An MFA validation request
name: mfaAuth
in: body
required: true
schema:
$ref: '#/definitions/mfaCode'
responses:
"200":
description: Base empty response
schema:
$ref: '#/definitions/empty'
"401":
description: Base empty response
schema:
$ref: '#/definitions/empty'
"429":
description: The resource requested is rate limited and the rate limit has
been exceeded
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
causeMessage: you have hit a rate limit in the requested operation
code: RATE_LIMITED
message: The resource is rate limited and the rate limit has been
exceeded. Please try again later
requestId: 270908d6-f2ef-4577-b973-67bec18ae376
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
/controllers:
get:
security:
- ztSession: []
- oauth2:
- openid
description: Retrieves a list of controllers
tags:
- Controllers
summary: List controllers
operationId: listControllers
parameters:
- type: integer
name: limit
in: query
- type: integer
name: offset
in: query
- type: string
name: filter
in: query
responses:
"200":
description: A list of controllers
schema:
$ref: '#/definitions/listControllersEnvelope'
"400":
description: The supplied request contains invalid fields or could not be
parsed (json and non-json bodies). The error's code, message, and cause
fields can be inspected for further information
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause:
details:
context: (root)
field: (root)
property: fooField3
field: (root)
message: '(root): fooField3 is required'
type: required
value:
fooField: abc
fooField2: def
causeMessage: schema validation failed
code: COULD_NOT_VALIDATE
message: The supplied request contains an invalid document
requestId: ac6766d6-3a09-44b3-8d8a-1b541d97fdd9
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
"401":
description: The supplied session does not have the correct access rights
to request this resource
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause: ""
causeMessage: ""
code: UNAUTHORIZED
message: The request could not be completed. The session is not authorized
or the credentials are invalid
requestId: 0bfe7a04-9229-4b7a-812c-9eb3cc0eac0f
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
"429":
description: The resource requested is rate limited and the rate limit has
been exceeded
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
causeMessage: you have hit a rate limit in the requested operation
code: RATE_LIMITED
message: The resource is rate limited and the rate limit has been
exceeded. Please try again later
requestId: 270908d6-f2ef-4577-b973-67bec18ae376
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
/current-api-session:
get:
security:
- ztSession: []
- oauth2:
- openid
description: Retrieves the API session that was used to issue the current request
tags:
- Current API Session
summary: Return the current API session
operationId: getCurrentAPISession
responses:
"200":
description: The API session associated with the session used to issue the
request
schema:
$ref: '#/definitions/currentApiSessionDetailEnvelope'
examples:
default:
data:
_links:
self:
href: ./current-api-session
configTypes: []
createdAt: "2020-03-09T19:03:49.1883693Z"
expiresAt: "2020-03-09T19:34:21.5600897Z"
id: 27343114-b44f-406e-9981-f3c4f2f28d54
identity:
_links:
self:
href: ./identities/66352d7b-a6b2-4ce9-85bb-9f18e318704d
id: 66352d7b-a6b2-4ce9-85bb-9f18e318704d
name: Default Admin
urlName: identities
tags:
- userField1: 123
- userField2: asdf
token: 28bb0ed2-0577-4632-ae70-d17106b92871
updatedAt: "2020-03-09T19:04:21.5600897Z"
meta: {}
"401":
description: The supplied session does not have the correct access rights
to request this resource
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause: ""
causeMessage: ""
code: UNAUTHORIZED
message: The request could not be completed. The session is not authorized
or the credentials are invalid
requestId: 0bfe7a04-9229-4b7a-812c-9eb3cc0eac0f
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
delete:
security:
- ztSession: []
- oauth2:
- openid
description: Terminates the current API session
tags:
- Current API Session
summary: Logout
responses:
"200":
description: Base empty response
schema:
$ref: '#/definitions/empty'
"401":
description: The supplied session does not have the correct access rights
to request this resource
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause: ""
causeMessage: ""
code: UNAUTHORIZED
message: The request could not be completed. The session is not authorized
or the credentials are invalid
requestId: 0bfe7a04-9229-4b7a-812c-9eb3cc0eac0f
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
/current-api-session/certificates:
get:
security:
- ztSession: []
- oauth2:
- openid
description: Retrieves a list of certificate resources for the current API session;
supports filtering, sorting, and pagination
tags:
- Current API Session
summary: List the ephemeral certificates available for the current API Session
operationId: listCurrentApiSessionCertificates
parameters:
- type: integer
name: limit
in: query
- type: integer
name: offset
in: query
- type: string
name: filter
in: query
responses:
"200":
description: A list of the current API Session's certificate
schema:
$ref: '#/definitions/listCurrentApiSessionCertificatesEnvelope'
"400":
description: The supplied request contains invalid fields or could not be
parsed (json and non-json bodies). The error's code, message, and cause
fields can be inspected for further information
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause:
details:
context: (root)
field: (root)
property: fooField3
field: (root)
message: '(root): fooField3 is required'
type: required
value:
fooField: abc
fooField2: def
causeMessage: schema validation failed
code: COULD_NOT_VALIDATE
message: The supplied request contains an invalid document
requestId: ac6766d6-3a09-44b3-8d8a-1b541d97fdd9
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
"401":
description: The supplied session does not have the correct access rights
to request this resource
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause: ""
causeMessage: ""
code: UNAUTHORIZED
message: The request could not be completed. The session is not authorized
or the credentials are invalid
requestId: 0bfe7a04-9229-4b7a-812c-9eb3cc0eac0f
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
"429":
description: The resource requested is rate limited and the rate limit has
been exceeded
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
causeMessage: you have hit a rate limit in the requested operation
code: RATE_LIMITED
message: The resource is rate limited and the rate limit has been
exceeded. Please try again later
requestId: 270908d6-f2ef-4577-b973-67bec18ae376
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
post:
security:
- ztSession: []
- oauth2:
- openid
description: Creates an ephemeral certificate for the current API Session. This
endpoint expects a PEM encoded CSRs to be provided for fulfillment as a property
of a JSON payload. It is up to the client to manage the private key backing
the CSR request.
tags:
- Current API Session
summary: Creates an ephemeral certificate for the current API Session
operationId: createCurrentApiSessionCertificate
parameters:
- description: The payload describing the CSR used to create a session certificate
name: sessionCertificate
in: body
required: true
schema:
$ref: '#/definitions/currentApiSessionCertificateCreate'
responses:
"201":
description: A response of a create API Session certificate
schema:
$ref: '#/definitions/createCurrentApiSessionCertificateEnvelope'
"400":
description: The supplied request contains invalid fields or could not be
parsed (json and non-json bodies). The error's code, message, and cause
fields can be inspected for further information
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause:
details:
context: (root)
field: (root)
property: fooField3
field: (root)
message: '(root): fooField3 is required'
type: required
value:
fooField: abc
fooField2: def
causeMessage: schema validation failed
code: COULD_NOT_VALIDATE
message: The supplied request contains an invalid document
requestId: ac6766d6-3a09-44b3-8d8a-1b541d97fdd9
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
"401":
description: The supplied session does not have the correct access rights
to request this resource
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause: ""
causeMessage: ""
code: UNAUTHORIZED
message: The request could not be completed. The session is not authorized
or the credentials are invalid
requestId: 0bfe7a04-9229-4b7a-812c-9eb3cc0eac0f
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
"429":
description: The resource requested is rate limited and the rate limit has
been exceeded
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
causeMessage: you have hit a rate limit in the requested operation
code: RATE_LIMITED
message: The resource is rate limited and the rate limit has been
exceeded. Please try again later
requestId: 270908d6-f2ef-4577-b973-67bec18ae376
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
/current-api-session/certificates/{id}:
get:
security:
- ztSession: []
- oauth2:
- openid
description: Retrieves a single ephemeral certificate by id
tags:
- Current API Session
summary: Retrieves an ephemeral certificate
operationId: detailCurrentApiSessionCertificate
responses:
"200":
description: A response containing a single API Session certificate
schema:
$ref: '#/definitions/detailCurrentApiSessionCertificateEnvelope'
"401":
description: The supplied session does not have the correct access rights
to request this resource
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause: ""
causeMessage: ""
code: UNAUTHORIZED
message: The request could not be completed. The session is not authorized
or the credentials are invalid
requestId: 0bfe7a04-9229-4b7a-812c-9eb3cc0eac0f
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
"404":
description: The requested resource does not exist
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars:
id: 71a3000f-7dda-491a-9b90-a19f4ee6c406
cause: null
causeMessage: ""
code: NOT_FOUND
message: The resource requested was not found or is no longer available
requestId: 270908d6-f2ef-4577-b973-67bec18ae376
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
"429":
description: The resource requested is rate limited and the rate limit has
been exceeded
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
causeMessage: you have hit a rate limit in the requested operation
code: RATE_LIMITED
message: The resource is rate limited and the rate limit has been
exceeded. Please try again later
requestId: 270908d6-f2ef-4577-b973-67bec18ae376
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
delete:
security:
- ztSession: []
- oauth2:
- openid
description: |
Delete an ephemeral certificateby id
tags:
- Current API Session
summary: Delete an ephemeral certificate
operationId: deleteCurrentApiSessionCertificate
responses:
"200":
description: The delete request was successful and the resource has been
removed
schema:
$ref: '#/definitions/empty'
"400":
description: The supplied request contains invalid fields or could not be
parsed (json and non-json bodies). The error's code, message, and cause
fields can be inspected for further information
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause:
details:
context: (root)
field: (root)
property: fooField3
field: (root)
message: '(root): fooField3 is required'
type: required
value:
fooField: abc
fooField2: def
causeMessage: schema validation failed
code: COULD_NOT_VALIDATE
message: The supplied request contains an invalid document
requestId: ac6766d6-3a09-44b3-8d8a-1b541d97fdd9
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
"401":
description: The supplied session does not have the correct access rights
to request this resource
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause: ""
causeMessage: ""
code: UNAUTHORIZED
message: The request could not be completed. The session is not authorized
or the credentials are invalid
requestId: 0bfe7a04-9229-4b7a-812c-9eb3cc0eac0f
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
"429":
description: The resource requested is rate limited and the rate limit has
been exceeded
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
causeMessage: you have hit a rate limit in the requested operation
code: RATE_LIMITED
message: The resource is rate limited and the rate limit has been
exceeded. Please try again later
requestId: 270908d6-f2ef-4577-b973-67bec18ae376
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
parameters:
- type: string
description: The id of the requested resource
name: id
in: path
required: true
/current-api-session/service-updates:
get:
security:
- ztSession: []
- oauth2:
- openid
description: |
Retrieves data indicating the last time data relevant to this API Session was altered that would necessitate
service refreshes.
tags:
- Current API Session
- Services
summary: Returns data indicating whether a client should updates it service
list
operationId: listServiceUpdates
responses:
"200":
description: Data indicating necessary service updates
schema:
$ref: '#/definitions/listCurrentApiSessionServiceUpdatesEnvelope'
"401":
description: The supplied session does not have the correct access rights
to request this resource
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause: ""
causeMessage: ""
code: UNAUTHORIZED
message: The request could not be completed. The session is not authorized
or the credentials are invalid
requestId: 0bfe7a04-9229-4b7a-812c-9eb3cc0eac0f
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
"429":
description: The resource requested is rate limited and the rate limit has
been exceeded
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
causeMessage: you have hit a rate limit in the requested operation
code: RATE_LIMITED
message: The resource is rate limited and the rate limit has been
exceeded. Please try again later
requestId: 270908d6-f2ef-4577-b973-67bec18ae376
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
/current-identity:
get:
security:
- ztSession: []
- oauth2:
- openid
description: Returns the identity associated with the API sessions used to issue
the current request
tags:
- Current Identity
summary: Return the current identity
operationId: getCurrentIdentity
responses:
"200":
description: The identity associated with the API Session used to issue
the request
schema:
$ref: '#/definitions/currentIdentityDetailEnvelope'
examples:
default:
data:
_links:
edge-router-policies:
href: ./identities/66352d7b-a6b2-4ce9-85bb-9f18e318704d/edge-routers
self:
href: ./identities/66352d7b-a6b2-4ce9-85bb-9f18e318704d
service-policies:
href: ./identities/66352d7b-a6b2-4ce9-85bb-9f18e318704d/identities
authenticators:
updb:
username: admin
createdAt: "2020-01-13T16:38:13.6854788Z"
enrollment: {}
id: 66352d7b-a6b2-4ce9-85bb-9f18e318704d
isAdmin: true
isDefaultAdmin: true
name: Default Admin
roleAttributes: []
tags: {}
type:
_links:
self:
href: ./identity-types/User
id: User
name: User
urlName: identity-types
updatedAt: "2020-01-13T16:38:13.6854788Z"
meta: {}
"401":
description: The supplied session does not have the correct access rights
to request this resource
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause: ""
causeMessage: ""
code: UNAUTHORIZED
message: The request could not be completed. The session is not authorized
or the credentials are invalid
requestId: 0bfe7a04-9229-4b7a-812c-9eb3cc0eac0f
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
/current-identity/authenticators:
get:
security:
- ztSession: []
- oauth2:
- openid
description: Retrieves a list of authenticators assigned to the current API
session's identity; supports filtering, sorting, and pagination.
tags:
- Current API Session
summary: List authenticators for the current identity
operationId: listCurrentIdentityAuthenticators
parameters:
- type: integer
name: limit
in: query
- type: integer
name: offset
in: query
- type: string
name: filter
in: query
responses:
"200":
description: A list of authenticators
schema:
$ref: '#/definitions/listAuthenticatorsEnvelope'
"400":
description: The supplied request contains invalid fields or could not be
parsed (json and non-json bodies). The error's code, message, and cause
fields can be inspected for further information
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}
cause:
details:
context: (root)
field: (root)
property: fooField3
field: (root)
message: '(root): fooField3 is required'
type: required
value:
fooField: abc
fooField2: def
causeMessage: schema validation failed
code: COULD_NOT_VALIDATE
message: The supplied request contains an invalid document
requestId: ac6766d6-3a09-44b3-8d8a-1b541d97fdd9
meta:
apiEnrollmentVersion: 0.0.1
apiVersion: 0.0.1
"401":
description: The supplied session does not have the correct access rights
to request this resource
schema:
$ref: '#/definitions/apiErrorEnvelope'
examples:
application/json:
error:
args:
urlVars: {}