-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
599 lines (595 loc) · 155 KB
/
index.html
File metadata and controls
599 lines (595 loc) · 155 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>API Reference | ReDoc</title>
<!-- needed for adaptive design -->
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/png" href="favicon.png">
<!--
ReDoc uses font options from the parent element
So override default browser styles
-->
<style>
body {
margin: 0;
padding: 0;
}
</style>
<script src="https://cdn.redocly.com/redoc/v2.2.0/bundles/redoc.standalone.js"></script><style data-styled="true" data-styled-version="6.1.13">.dFrZq{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
@media print,screen and (max-width: 75rem){.dFrZq{width:100%;padding:40px 40px;}}/*!sc*/
data-styled.g4[id="sc-fAUdSK"]{content:"dFrZq,"}/*!sc*/
.bvhSud{padding:40px 0;}/*!sc*/
.bvhSud:last-child{min-height:calc(100vh + 1px);}/*!sc*/
.bvhSud>.bvhSud:last-child{min-height:initial;}/*!sc*/
@media print,screen and (max-width: 75rem){.bvhSud{padding:0;}}/*!sc*/
.aYCdu{padding:40px 0;position:relative;}/*!sc*/
.aYCdu:last-child{min-height:calc(100vh + 1px);}/*!sc*/
.aYCdu>.aYCdu:last-child{min-height:initial;}/*!sc*/
@media print,screen and (max-width: 75rem){.aYCdu{padding:0;}}/*!sc*/
.aYCdu:not(:last-of-type):after{position:absolute;bottom:0;width:100%;display:block;content:'';border-bottom:1px solid rgba(0, 0, 0, 0.2);}/*!sc*/
data-styled.g5[id="sc-dntaoT"]{content:"bvhSud,aYCdu,"}/*!sc*/
.gOjFGl{width:40%;color:#ffffff;background-color:#263238;padding:0 40px;}/*!sc*/
@media print,screen and (max-width: 75rem){.gOjFGl{width:100%;padding:40px 40px;}}/*!sc*/
data-styled.g6[id="sc-ivxoEo"]{content:"gOjFGl,"}/*!sc*/
.oECKJ{background-color:#263238;}/*!sc*/
data-styled.g7[id="sc-ghWlax"]{content:"oECKJ,"}/*!sc*/
.dECWTf{display:flex;width:100%;padding:0;}/*!sc*/
@media print,screen and (max-width: 75rem){.dECWTf{flex-direction:column;}}/*!sc*/
data-styled.g8[id="sc-kLhKbu"]{content:"dECWTf,"}/*!sc*/
.kHkxTT{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#333333;}/*!sc*/
data-styled.g9[id="sc-ixGGxD"]{content:"kHkxTT,"}/*!sc*/
.wHiQv{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;margin:0 0 20px;}/*!sc*/
data-styled.g10[id="sc-khLCKb"]{content:"wHiQv,"}/*!sc*/
.zvQzH{color:#ffffff;}/*!sc*/
data-styled.g12[id="sc-keTIit"]{content:"zvQzH,"}/*!sc*/
.eJAAZj{border-bottom:1px solid rgba(38, 50, 56, 0.3);margin:1em 0 1em 0;color:rgba(38, 50, 56, 0.5);font-weight:normal;text-transform:uppercase;font-size:0.929em;line-height:20px;}/*!sc*/
data-styled.g13[id="sc-dpBQxM"]{content:"eJAAZj,"}/*!sc*/
.hbTOAm{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.hbTOAm:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
h1:hover>.hbTOAm::before,h2:hover>.hbTOAm::before,.hbTOAm:hover::before{visibility:visible;}/*!sc*/
data-styled.g14[id="sc-jwIPbr"]{content:"hbTOAm,"}/*!sc*/
.gkUOTk{height:18px;width:18px;min-width:18px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
.ccTkAM{height:18px;width:18px;min-width:18px;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
.kVOWjS{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
.kVOWjS polygon{fill:#d41f1c;}/*!sc*/
.fmmJjS{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/
.fmmJjS polygon{fill:white;}/*!sc*/
.hmCwJW{height:1.5em;width:1.5em;min-width:1.5em;vertical-align:middle;float:left;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
.hmCwJW polygon{fill:#1d8127;}/*!sc*/
.bEpxpV{height:1.3em;width:1.3em;min-width:1.3em;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/
data-styled.g15[id="sc-cHqXqK"]{content:"gkUOTk,ccTkAM,kVOWjS,fmmJjS,hmCwJW,bEpxpV,"}/*!sc*/
.jmDXKf{display:inline-block;padding:2px 8px;margin:0;background-color:#ffa500;color:#ffffff;font-size:13px;vertical-align:middle;line-height:1.6;border-radius:4px;font-weight:600;font-size:12px;}/*!sc*/
.jmDXKf +span[type]{margin-left:4px;}/*!sc*/
data-styled.g16[id="sc-jtQUzJ"]{content:"jmDXKf,"}/*!sc*/
.iyKqKI{border-left:1px solid #7c7cbb;box-sizing:border-box;position:relative;padding:10px 10px 10px 0;}/*!sc*/
@media screen and (max-width: 50rem){.iyKqKI{display:block;overflow:hidden;}}/*!sc*/
tr:first-of-type>.iyKqKI,tr.last>.iyKqKI{border-left-width:0;background-position:top left;background-repeat:no-repeat;background-size:1px 100%;}/*!sc*/
tr:first-of-type>.iyKqKI{background-image:linear-gradient(
to bottom,
transparent 0%,
transparent 22px,
#7c7cbb 22px,
#7c7cbb 100%
);}/*!sc*/
tr.last>.iyKqKI{background-image:linear-gradient(
to bottom,
#7c7cbb 0%,
#7c7cbb 22px,
transparent 22px,
transparent 100%
);}/*!sc*/
tr.last+tr>.iyKqKI{border-left-color:transparent;}/*!sc*/
tr.last:first-child>.iyKqKI{background:none;border-left-color:transparent;}/*!sc*/
data-styled.g18[id="sc-ovuCP"]{content:"iyKqKI,"}/*!sc*/
.iQpMVv{vertical-align:top;line-height:20px;white-space:nowrap;font-size:13px;font-family:Courier,monospace;}/*!sc*/
.iQpMVv.deprecated{text-decoration:line-through;color:#707070;}/*!sc*/
data-styled.g20[id="sc-eauhAA"]{content:"iQpMVv,"}/*!sc*/
.cHXoZJ{border-bottom:1px solid #9fb4be;padding:10px 0;width:75%;box-sizing:border-box;}/*!sc*/
tr.expanded .cHXoZJ{border-bottom:none;}/*!sc*/
@media screen and (max-width: 50rem){.cHXoZJ{padding:0 20px;border-bottom:none;border-left:1px solid #7c7cbb;}tr.last>.cHXoZJ{border-left:none;}}/*!sc*/
data-styled.g21[id="sc-fFoeYl"]{content:"cHXoZJ,"}/*!sc*/
.kPDxnK{color:#7c7cbb;font-family:Courier,monospace;margin-right:10px;}/*!sc*/
.kPDxnK::before{content:'';display:inline-block;vertical-align:middle;width:10px;height:1px;background:#7c7cbb;}/*!sc*/
.kPDxnK::after{content:'';display:inline-block;vertical-align:middle;width:1px;background:#7c7cbb;height:7px;}/*!sc*/
data-styled.g22[id="sc-gQaihK"]{content:"kPDxnK,"}/*!sc*/
.eNFxPe{border-collapse:separate;border-radius:3px;font-size:14px;border-spacing:0;width:100%;}/*!sc*/
.eNFxPe >tr{vertical-align:middle;}/*!sc*/
@media screen and (max-width: 50rem){.eNFxPe{display:block;}.eNFxPe >tr,.eNFxPe >tbody>tr{display:block;}}/*!sc*/
@media screen and (max-width: 50rem) and (-ms-high-contrast:none){.eNFxPe td{float:left;width:100%;}}/*!sc*/
.eNFxPe .sc-iuUfFv,.eNFxPe .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv,.eNFxPe .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv{margin:1em;margin-right:0;background:#fafafa;}/*!sc*/
.eNFxPe .sc-iuUfFv .sc-iuUfFv,.eNFxPe .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv,.eNFxPe .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv .sc-iuUfFv{background:#ffffff;}/*!sc*/
data-styled.g24[id="sc-dprtRQ"]{content:"eNFxPe,"}/*!sc*/
.fbQvpV >ul{list-style:none;padding:0;margin:0;margin:0 -5px;}/*!sc*/
.fbQvpV >ul >li{padding:5px 10px;display:inline-block;background-color:#11171a;border-bottom:1px solid rgba(0, 0, 0, 0.5);cursor:pointer;text-align:center;outline:none;color:#ccc;margin:0 5px 5px 5px;border:1px solid #07090b;border-radius:5px;min-width:60px;font-size:0.9em;font-weight:bold;}/*!sc*/
.fbQvpV >ul >li.react-tabs__tab--selected{color:#333333;background:#ffffff;}/*!sc*/
.fbQvpV >ul >li.react-tabs__tab--selected:focus{outline:auto;}/*!sc*/
.fbQvpV >ul >li:only-child{flex:none;min-width:100px;}/*!sc*/
.fbQvpV >ul >li.tab-success{color:#1d8127;}/*!sc*/
.fbQvpV >ul >li.tab-redirect{color:#ffa500;}/*!sc*/
.fbQvpV >ul >li.tab-info{color:#87ceeb;}/*!sc*/
.fbQvpV >ul >li.tab-error{color:#d41f1c;}/*!sc*/
.fbQvpV >.react-tabs__tab-panel{background:#11171a;}/*!sc*/
.fbQvpV >.react-tabs__tab-panel>div,.fbQvpV >.react-tabs__tab-panel>pre{padding:20px;margin:0;}/*!sc*/
.fbQvpV >.react-tabs__tab-panel>div>pre{padding:0;}/*!sc*/
data-styled.g30[id="sc-bMTdWJ"]{content:"fbQvpV,"}/*!sc*/
.drsioI code[class*='language-'],.drsioI pre[class*='language-']{text-shadow:0 -0.1em 0.2em black;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none;}/*!sc*/
@media print{.drsioI code[class*='language-'],.drsioI pre[class*='language-']{text-shadow:none;}}/*!sc*/
.drsioI pre[class*='language-']{padding:1em;margin:0.5em 0;overflow:auto;}/*!sc*/
.drsioI .token.comment,.drsioI .token.prolog,.drsioI .token.doctype,.drsioI .token.cdata{color:hsl(30, 20%, 50%);}/*!sc*/
.drsioI .token.punctuation{opacity:0.7;}/*!sc*/
.drsioI .namespace{opacity:0.7;}/*!sc*/
.drsioI .token.property,.drsioI .token.tag,.drsioI .token.number,.drsioI .token.constant,.drsioI .token.symbol{color:#4a8bb3;}/*!sc*/
.drsioI .token.boolean{color:#e64441;}/*!sc*/
.drsioI .token.selector,.drsioI .token.attr-name,.drsioI .token.string,.drsioI .token.char,.drsioI .token.builtin,.drsioI .token.inserted{color:#a0fbaa;}/*!sc*/
.drsioI .token.selector+a,.drsioI .token.attr-name+a,.drsioI .token.string+a,.drsioI .token.char+a,.drsioI .token.builtin+a,.drsioI .token.inserted+a,.drsioI .token.selector+a:visited,.drsioI .token.attr-name+a:visited,.drsioI .token.string+a:visited,.drsioI .token.char+a:visited,.drsioI .token.builtin+a:visited,.drsioI .token.inserted+a:visited{color:#4ed2ba;text-decoration:underline;}/*!sc*/
.drsioI .token.property.string{color:white;}/*!sc*/
.drsioI .token.operator,.drsioI .token.entity,.drsioI .token.url,.drsioI .token.variable{color:hsl(40, 90%, 60%);}/*!sc*/
.drsioI .token.atrule,.drsioI .token.attr-value,.drsioI .token.keyword{color:hsl(350, 40%, 70%);}/*!sc*/
.drsioI .token.regex,.drsioI .token.important{color:#e90;}/*!sc*/
.drsioI .token.important,.drsioI .token.bold{font-weight:bold;}/*!sc*/
.drsioI .token.italic{font-style:italic;}/*!sc*/
.drsioI .token.entity{cursor:help;}/*!sc*/
.drsioI .token.deleted{color:red;}/*!sc*/
data-styled.g32[id="sc-epnzzT"]{content:"drsioI,"}/*!sc*/
.hhzNne{opacity:0.7;transition:opacity 0.3s ease;text-align:right;}/*!sc*/
.hhzNne:focus-within{opacity:1;}/*!sc*/
.hhzNne >button{background-color:transparent;border:0;color:inherit;padding:2px 10px;font-family:Roboto,sans-serif;font-size:14px;line-height:1.5em;cursor:pointer;outline:0;}/*!sc*/
.hhzNne >button :hover,.hhzNne >button :focus{background:rgba(255, 255, 255, 0.1);}/*!sc*/
data-styled.g33[id="sc-uYFMi"]{content:"hhzNne,"}/*!sc*/
.cpBPUN{position:relative;}/*!sc*/
data-styled.g37[id="sc-dEkLRj"]{content:"cpBPUN,"}/*!sc*/
.bweot{position:absolute;pointer-events:none;z-index:1;top:50%;-webkit-transform:translateY(-50%);-ms-transform:translateY(-50%);transform:translateY(-50%);right:8px;margin:auto;text-align:center;}/*!sc*/
.JXohG{position:absolute;pointer-events:none;z-index:1;top:50%;-webkit-transform:translateY(-50%);-ms-transform:translateY(-50%);transform:translateY(-50%);right:8px;margin:auto;text-align:center;}/*!sc*/
.JXohG polyline{color:white;}/*!sc*/
data-styled.g38[id="sc-kZrBCu"]{content:"bweot,JXohG,"}/*!sc*/
.iHjPVQ{box-sizing:border-box;min-width:100px;outline:none;display:inline-block;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.5);vertical-align:bottom;padding:2px 0px 2px 6px;position:relative;width:auto;background:white;color:#263238;font-family:Montserrat,sans-serif;font-size:0.929em;line-height:1.5em;cursor:pointer;transition:border 0.25s ease,color 0.25s ease,box-shadow 0.25s ease;}/*!sc*/
.iHjPVQ label{box-sizing:border-box;min-width:100px;outline:none;display:inline-block;font-family:Montserrat,sans-serif;color:#333333;vertical-align:bottom;width:auto;text-transform:none;padding:0 22px 0 4px;font-size:0.929em;line-height:1.5em;font-family:inherit;text-overflow:ellipsis;overflow:hidden;white-space:nowrap;}/*!sc*/
.iHjPVQ .dropdown-select{position:absolute;top:0;left:0;width:100%;height:100%;opacity:0;border:none;appearance:none;cursor:pointer;color:#333333;line-height:inherit;font-family:inherit;}/*!sc*/
.iHjPVQ:hover,.iHjPVQ:focus-within{border:1px solid #32329f;color:#32329f;box-shadow:0px 0px 0px 1px #32329f;}/*!sc*/
data-styled.g39[id="sc-diYFot"]{content:"iHjPVQ,"}/*!sc*/
.dkmakt{margin-left:10px;text-transform:none;font-size:0.969em;font-size:1em;border:none;padding:0 1.2em 0 0;background:transparent;}/*!sc*/
.dkmakt:hover,.dkmakt:focus-within{border:none;box-shadow:none;}/*!sc*/
.dkmakt:hover label,.dkmakt:focus-within label{color:#32329f;text-shadow:0px 0px 0px #32329f;}/*!sc*/
data-styled.g40[id="sc-kEfuZE"]{content:"dkmakt,"}/*!sc*/
.khtVmz{margin-left:10px;text-transform:none;font-size:0.929em;color:black;}/*!sc*/
data-styled.g41[id="sc-dhCplO"]{content:"khtVmz,"}/*!sc*/
.dWZUhK{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.dWZUhK p:last-child{margin-bottom:0;}/*!sc*/
.dWZUhK h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
.dWZUhK h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.dWZUhK code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.dWZUhK pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
.dWZUhK pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.dWZUhK pre code:before,.dWZUhK pre code:after{content:none;}/*!sc*/
.dWZUhK blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.dWZUhK img{max-width:100%;box-sizing:content-box;}/*!sc*/
.dWZUhK ul,.dWZUhK ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.dWZUhK ul ul,.dWZUhK ol ul,.dWZUhK ul ol,.dWZUhK ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.dWZUhK table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.dWZUhK table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.dWZUhK table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.dWZUhK table th,.dWZUhK table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.dWZUhK table th{text-align:left;font-weight:bold;}/*!sc*/
.dWZUhK .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.dWZUhK .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.dWZUhK h1:hover>.share-link::before,.dWZUhK h2:hover>.share-link::before,.dWZUhK .share-link:hover::before{visibility:visible;}/*!sc*/
.dWZUhK a{text-decoration:auto;color:#32329f;}/*!sc*/
.dWZUhK a:visited{color:#32329f;}/*!sc*/
.dWZUhK a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
.ewnBNs{font-family:Roboto,sans-serif;font-weight:400;line-height:1.5em;}/*!sc*/
.ewnBNs p:last-child{margin-bottom:0;}/*!sc*/
.ewnBNs p:first-child{margin-top:0;}/*!sc*/
.ewnBNs p:last-child{margin-bottom:0;}/*!sc*/
.ewnBNs h1{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.85714em;line-height:1.6em;color:#32329f;margin-top:0;}/*!sc*/
.ewnBNs h2{font-family:Montserrat,sans-serif;font-weight:400;font-size:1.57143em;line-height:1.6em;color:#333333;}/*!sc*/
.ewnBNs code{color:#e53935;background-color:rgba(38, 50, 56, 0.05);font-family:Courier,monospace;border-radius:2px;border:1px solid rgba(38, 50, 56, 0.1);padding:0 5px;font-size:13px;font-weight:400;word-break:break-word;}/*!sc*/
.ewnBNs pre{font-family:Courier,monospace;white-space:pre;background-color:#11171a;color:white;padding:20px;overflow-x:auto;line-height:normal;border-radius:0;border:1px solid rgba(38, 50, 56, 0.1);}/*!sc*/
.ewnBNs pre code{background-color:transparent;color:white;padding:0;}/*!sc*/
.ewnBNs pre code:before,.ewnBNs pre code:after{content:none;}/*!sc*/
.ewnBNs blockquote{margin:0;margin-bottom:1em;padding:0 15px;color:#777;border-left:4px solid #ddd;}/*!sc*/
.ewnBNs img{max-width:100%;box-sizing:content-box;}/*!sc*/
.ewnBNs ul,.ewnBNs ol{padding-left:2em;margin:0;margin-bottom:1em;}/*!sc*/
.ewnBNs ul ul,.ewnBNs ol ul,.ewnBNs ul ol,.ewnBNs ol ol{margin-bottom:0;margin-top:0;}/*!sc*/
.ewnBNs table{display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all;border-collapse:collapse;border-spacing:0;margin-top:1.5em;margin-bottom:1.5em;}/*!sc*/
.ewnBNs table tr{background-color:#fff;border-top:1px solid #ccc;}/*!sc*/
.ewnBNs table tr:nth-child(2n){background-color:#fafafa;}/*!sc*/
.ewnBNs table th,.ewnBNs table td{padding:6px 13px;border:1px solid #ddd;}/*!sc*/
.ewnBNs table th{text-align:left;font-weight:bold;}/*!sc*/
.ewnBNs .share-link{cursor:pointer;margin-left:-20px;padding:0;line-height:1;width:20px;display:inline-block;outline:0;}/*!sc*/
.ewnBNs .share-link:before{content:'';width:15px;height:15px;background-size:contain;background-image:url('data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMSIgeD0iMCIgeT0iMCIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCA1MTIgNTEyIiB4bWw6c3BhY2U9InByZXNlcnZlIj48cGF0aCBmaWxsPSIjMDEwMTAxIiBkPSJNNDU5LjcgMjMzLjRsLTkwLjUgOTAuNWMtNTAgNTAtMTMxIDUwLTE4MSAwIC03LjktNy44LTE0LTE2LjctMTkuNC0yNS44bDQyLjEtNDIuMWMyLTIgNC41LTMuMiA2LjgtNC41IDIuOSA5LjkgOCAxOS4zIDE1LjggMjcuMiAyNSAyNSA2NS42IDI0LjkgOTAuNSAwbDkwLjUtOTAuNWMyNS0yNSAyNS02NS42IDAtOTAuNSAtMjQuOS0yNS02NS41LTI1LTkwLjUgMGwtMzIuMiAzMi4yYy0yNi4xLTEwLjItNTQuMi0xMi45LTgxLjYtOC45bDY4LjYtNjguNmM1MC01MCAxMzEtNTAgMTgxIDBDNTA5LjYgMTAyLjMgNTA5LjYgMTgzLjQgNDU5LjcgMjMzLjR6TTIyMC4zIDM4Mi4ybC0zMi4yIDMyLjJjLTI1IDI0LjktNjUuNiAyNC45LTkwLjUgMCAtMjUtMjUtMjUtNjUuNiAwLTkwLjVsOTAuNS05MC41YzI1LTI1IDY1LjUtMjUgOTAuNSAwIDcuOCA3LjggMTIuOSAxNy4yIDE1LjggMjcuMSAyLjQtMS40IDQuOC0yLjUgNi44LTQuNWw0Mi4xLTQyYy01LjQtOS4yLTExLjYtMTgtMTkuNC0yNS44IC01MC01MC0xMzEtNTAtMTgxIDBsLTkwLjUgOTAuNWMtNTAgNTAtNTAgMTMxIDAgMTgxIDUwIDUwIDEzMSA1MCAxODEgMGw2OC42LTY4LjZDMjc0LjYgMzk1LjEgMjQ2LjQgMzkyLjMgMjIwLjMgMzgyLjJ6Ii8+PC9zdmc+Cg==');opacity:0.5;visibility:hidden;display:inline-block;vertical-align:middle;}/*!sc*/
.ewnBNs h1:hover>.share-link::before,.ewnBNs h2:hover>.share-link::before,.ewnBNs .share-link:hover::before{visibility:visible;}/*!sc*/
.ewnBNs a{text-decoration:auto;color:#32329f;}/*!sc*/
.ewnBNs a:visited{color:#32329f;}/*!sc*/
.ewnBNs a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
data-styled.g42[id="sc-eMwmJz"]{content:"dWZUhK,ewnBNs,"}/*!sc*/
.jtjIAv{display:inline;}/*!sc*/
data-styled.g43[id="sc-drVZOg"]{content:"jtjIAv,"}/*!sc*/
.ezdXRP{position:relative;}/*!sc*/
data-styled.g44[id="sc-eWPXlR"]{content:"ezdXRP,"}/*!sc*/
.mMhCU:hover>.sc-uYFMi{opacity:1;}/*!sc*/
data-styled.g49[id="sc-eDHQDy"]{content:"mMhCU,"}/*!sc*/
.iyEpFV{font-family:Courier,monospace;font-size:13px;white-space:pre;contain:content;overflow-x:auto;}/*!sc*/
.iyEpFV .redoc-json code>.collapser{display:none;pointer-events:none;}/*!sc*/
.iyEpFV .callback-function{color:gray;}/*!sc*/
.iyEpFV .collapser:after{content:'-';cursor:pointer;}/*!sc*/
.iyEpFV .collapsed>.collapser:after{content:'+';cursor:pointer;}/*!sc*/
.iyEpFV .ellipsis:after{content:' … ';}/*!sc*/
.iyEpFV .collapsible{margin-left:2em;}/*!sc*/
.iyEpFV .hoverable{padding-top:1px;padding-bottom:1px;padding-left:2px;padding-right:2px;border-radius:2px;}/*!sc*/
.iyEpFV .hovered{background-color:rgba(235, 238, 249, 1);}/*!sc*/
.iyEpFV .collapser{background-color:transparent;border:0;color:#fff;font-family:Courier,monospace;font-size:13px;padding-right:6px;padding-left:6px;padding-top:0;padding-bottom:0;display:flex;align-items:center;justify-content:center;width:15px;height:15px;position:absolute;top:4px;left:-1.5em;cursor:default;user-select:none;-webkit-user-select:none;padding:2px;}/*!sc*/
.iyEpFV .collapser:focus{outline-color:#fff;outline-style:dotted;outline-width:1px;}/*!sc*/
.iyEpFV ul{list-style-type:none;padding:0px;margin:0px 0px 0px 26px;}/*!sc*/
.iyEpFV li{position:relative;display:block;}/*!sc*/
.iyEpFV .hoverable{display:inline-block;}/*!sc*/
.iyEpFV .selected{outline-style:solid;outline-width:1px;outline-style:dotted;}/*!sc*/
.iyEpFV .collapsed>.collapsible{display:none;}/*!sc*/
.iyEpFV .ellipsis{display:none;}/*!sc*/
.iyEpFV .collapsed>.ellipsis{display:inherit;}/*!sc*/
data-styled.g50[id="sc-giBObj"]{content:"iyEpFV,"}/*!sc*/
.kKXAng{padding:0.9em;background-color:rgba(38,50,56,0.4);margin:0 0 10px 0;display:block;font-family:Montserrat,sans-serif;font-size:0.929em;line-height:1.5em;}/*!sc*/
data-styled.g51[id="sc-UblHX"]{content:"kKXAng,"}/*!sc*/
.eqWzJe{font-family:Montserrat,sans-serif;font-size:12px;position:absolute;z-index:1;top:-11px;left:12px;font-weight:600;color:rgba(255,255,255,0.7);}/*!sc*/
data-styled.g52[id="sc-fufdwm"]{content:"eqWzJe,"}/*!sc*/
.dIDLbO{position:relative;}/*!sc*/
data-styled.g53[id="sc-Rjrgp"]{content:"dIDLbO,"}/*!sc*/
.esCYIP{margin:0 0 10px 0;display:block;background-color:rgba(38,50,56,0.4);border:none;padding:0.9em 1.6em 0.9em 0.9em;box-shadow:none;}/*!sc*/
.esCYIP label{color:#ffffff;text-overflow:ellipsis;white-space:nowrap;overflow:hidden;font-size:1em;text-transform:none;border:none;}/*!sc*/
.esCYIP:hover,.esCYIP:focus-within{border:none;box-shadow:none;background-color:rgba(38,50,56,0.7);}/*!sc*/
data-styled.g54[id="sc-frniUE"]{content:"esCYIP,"}/*!sc*/
.kqHNPM{margin-top:15px;}/*!sc*/
data-styled.g56[id="sc-FFETS"]{content:"kqHNPM,"}/*!sc*/
.buGHPE.deprecated span.property-name{text-decoration:line-through;color:#707070;}/*!sc*/
.buGHPE button{background-color:transparent;border:0;outline:0;font-size:13px;font-family:Courier,monospace;cursor:pointer;padding:0;color:#333333;}/*!sc*/
.buGHPE button:focus{font-weight:600;}/*!sc*/
.buGHPE .sc-cHqXqK{height:1.1em;width:1.1em;}/*!sc*/
.buGHPE .sc-cHqXqK polygon{fill:#666;}/*!sc*/
data-styled.g57[id="sc-hsfCcR"]{content:"buGHPE,"}/*!sc*/
.hPAOR{vertical-align:middle;font-size:13px;line-height:20px;}/*!sc*/
data-styled.g58[id="sc-CNKsk"]{content:"hPAOR,"}/*!sc*/
.dWKYKL{color:rgba(102,102,102,0.9);}/*!sc*/
data-styled.g59[id="sc-cqgMZH"]{content:"dWKYKL,"}/*!sc*/
.bIEFFi{color:#666;}/*!sc*/
data-styled.g60[id="sc-gQkENW"]{content:"bIEFFi,"}/*!sc*/
.dnQByT{color:#666;word-break:break-word;}/*!sc*/
data-styled.g61[id="sc-gcfzXs"]{content:"dnQByT,"}/*!sc*/
.feFoaC{color:#d41f1c;font-size:0.9em;font-weight:normal;margin-left:20px;line-height:1;}/*!sc*/
data-styled.g62[id="sc-hGZxvd"]{content:"feFoaC,"}/*!sc*/
.hCJxj{color:#0e7c86;}/*!sc*/
.hCJxj::before,.hCJxj::after{font-weight:bold;}/*!sc*/
data-styled.g65[id="sc-bnGbuY"]{content:"hCJxj,"}/*!sc*/
.YZnqP{border-radius:2px;word-break:break-word;background-color:rgba(51,51,51,0.05);color:rgba(51,51,51,0.9);padding:0 5px;border:1px solid rgba(51,51,51,0.1);font-family:Courier,monospace;}/*!sc*/
+{margin-left:0;}/*!sc*/
data-styled.g66[id="sc-cSzYSJ"]{content:"YZnqP,"}/*!sc*/
.diHVZf{border-radius:2px;background-color:rgba(104,104,207,0.05);color:rgba(50,50,159,0.9);margin:0 5px;padding:0 5px;border:1px solid rgba(50,50,159,0.1);}/*!sc*/
+{margin-left:0;}/*!sc*/
data-styled.g68[id="sc-fIfZzT"]{content:"diHVZf,"}/*!sc*/
.dwTuQQ{background-color:transparent;border:0;color:#666;margin-left:5px;border-radius:2px;cursor:pointer;outline-color:#666;font-size:12px;}/*!sc*/
data-styled.g69[id="sc-hylbpc"]{content:"dwTuQQ,"}/*!sc*/
.kpFoWb{margin:0 5px;vertical-align:text-top;}/*!sc*/
data-styled.g74[id="sc-cwJYja"]{content:"kpFoWb,"}/*!sc*/
.dIXVzO:after{content:' and ';font-weight:normal;}/*!sc*/
.dIXVzO:last-child:after{content:none;}/*!sc*/
.dIXVzO a{text-decoration:auto;color:#32329f;}/*!sc*/
.dIXVzO a:visited{color:#32329f;}/*!sc*/
.dIXVzO a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
data-styled.g80[id="sc-bqvdXA"]{content:"dIXVzO,"}/*!sc*/
.eqXCjK{white-space:nowrap;}/*!sc*/
.eqXCjK:after{content:' or ';white-space:pre;}/*!sc*/
.eqXCjK:last-child:after,.eqXCjK:only-child:after{content:none;}/*!sc*/
.eqXCjK a{text-decoration:auto;color:#32329f;}/*!sc*/
.eqXCjK a:visited{color:#32329f;}/*!sc*/
.eqXCjK a:hover{color:#6868cf;text-decoration:auto;}/*!sc*/
data-styled.g81[id="sc-irPVuy"]{content:"eqXCjK,"}/*!sc*/
.jXOga-d{flex:1 1 auto;cursor:pointer;}/*!sc*/
data-styled.g82[id="sc-jWJSSj"]{content:"jXOga-d,"}/*!sc*/
.gQOXJB{width:75%;text-overflow:ellipsis;border-radius:4px;overflow:hidden;}/*!sc*/
@media screen and (max-width: 50rem){.gQOXJB{margin-top:10px;}}/*!sc*/
data-styled.g83[id="sc-iCjFWQ"]{content:"gQOXJB,"}/*!sc*/
.ffSXYc{display:inline-block;margin:0;}/*!sc*/
data-styled.g84[id="sc-khdDuB"]{content:"ffSXYc,"}/*!sc*/
.dyzdIR{width:100%;display:flex;margin:1em 0;flex-direction:row;}/*!sc*/
@media screen and (max-width: 50rem){.dyzdIR{flex-direction:column;}}/*!sc*/
data-styled.g85[id="sc-hGNhLO"]{content:"dyzdIR,"}/*!sc*/
.dZsYqS{margin-top:0;margin-bottom:0.5em;}/*!sc*/
data-styled.g91[id="sc-geoRQH"]{content:"dZsYqS,"}/*!sc*/
.enkzRg{border:1px solid #32329f;color:#32329f;font-weight:normal;margin-left:0.5em;padding:4px 8px 4px;display:inline-block;text-decoration:none;cursor:pointer;}/*!sc*/
data-styled.g92[id="sc-kEsJEW"]{content:"enkzRg,"}/*!sc*/
.bbQame{width:9ex;display:inline-block;height:13px;line-height:13px;background-color:#333;border-radius:3px;background-repeat:no-repeat;background-position:6px 4px;font-size:7px;font-family:Verdana,sans-serif;color:white;text-transform:uppercase;text-align:center;font-weight:bold;vertical-align:middle;margin-right:6px;margin-top:2px;}/*!sc*/
.bbQame.get{background-color:#2F8132;}/*!sc*/
.bbQame.post{background-color:#186FAF;}/*!sc*/
.bbQame.put{background-color:#95507c;}/*!sc*/
.bbQame.options{background-color:#947014;}/*!sc*/
.bbQame.patch{background-color:#bf581d;}/*!sc*/
.bbQame.delete{background-color:#cc3333;}/*!sc*/
.bbQame.basic{background-color:#707070;}/*!sc*/
.bbQame.link{background-color:#07818F;}/*!sc*/
.bbQame.head{background-color:#A23DAD;}/*!sc*/
.bbQame.hook{background-color:#32329f;}/*!sc*/
.bbQame.schema{background-color:#707070;}/*!sc*/
data-styled.g99[id="sc-erSfwj"]{content:"bbQame,"}/*!sc*/
.dXwhdL{margin:0;padding:0;}/*!sc*/
.dXwhdL:first-child{padding-bottom:32px;}/*!sc*/
.sc-iRVXky .sc-iRVXky{font-size:0.929em;}/*!sc*/
.kUyAbS{margin:0;padding:0;display:none;}/*!sc*/
.kUyAbS:first-child{padding-bottom:32px;}/*!sc*/
.sc-iRVXky .sc-iRVXky{font-size:0.929em;}/*!sc*/
data-styled.g100[id="sc-iRVXky"]{content:"dXwhdL,kUyAbS,"}/*!sc*/
.gSwPLF{list-style:none inside none;overflow:hidden;text-overflow:ellipsis;padding:0;}/*!sc*/
data-styled.g101[id="sc-ljhlHD"]{content:"gSwPLF,"}/*!sc*/
.bgAbkd{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:flex;justify-content:space-between;font-family:Montserrat,sans-serif;font-size:0.929em;text-transform:none;background-color:#fafafa;}/*!sc*/
.bgAbkd:hover{color:#32329f;background-color:#e1e1e1;}/*!sc*/
.bgAbkd .sc-cHqXqK{height:1.5em;width:1.5em;}/*!sc*/
.bgAbkd .sc-cHqXqK polygon{fill:#333333;}/*!sc*/
.dnJKVb{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:flex;justify-content:space-between;font-family:Montserrat,sans-serif;background-color:#fafafa;}/*!sc*/
.dnJKVb:hover{color:#32329f;background-color:#ededed;}/*!sc*/
.dnJKVb .sc-cHqXqK{height:1.5em;width:1.5em;}/*!sc*/
.dnJKVb .sc-cHqXqK polygon{fill:#333333;}/*!sc*/
.hEJvGe{cursor:pointer;color:#333333;margin:0;padding:12.5px 20px;display:flex;justify-content:space-between;font-family:Montserrat,sans-serif;background-color:#fafafa;text-decoration:line-through;color:#707070;}/*!sc*/
.hEJvGe:hover{color:#32329f;background-color:#ededed;}/*!sc*/
.hEJvGe .sc-cHqXqK{height:1.5em;width:1.5em;}/*!sc*/
.hEJvGe .sc-cHqXqK polygon{fill:#333333;}/*!sc*/
data-styled.g102[id="sc-bAEjGW"]{content:"bgAbkd,dnJKVb,hEJvGe,"}/*!sc*/
.bBONey{display:inline-block;vertical-align:middle;width:calc(100% - 38px);overflow:hidden;text-overflow:ellipsis;}/*!sc*/
data-styled.g103[id="sc-enMaOJ"]{content:"bBONey,"}/*!sc*/
.fxirIR{font-size:0.8em;margin-top:10px;text-align:center;position:fixed;width:260px;bottom:0;background:#fafafa;}/*!sc*/
.fxirIR a,.fxirIR a:visited,.fxirIR a:hover{color:#333333!important;padding:5px 0;border-top:1px solid #e1e1e1;text-decoration:none;display:flex;align-items:center;justify-content:center;}/*!sc*/
.fxirIR img{width:15px;margin-right:5px;}/*!sc*/
@media screen and (max-width: 50rem){.fxirIR{width:100%;}}/*!sc*/
data-styled.g104[id="sc-fUEImY"]{content:"fxirIR,"}/*!sc*/
.dWZoid{cursor:pointer;position:relative;margin-bottom:5px;}/*!sc*/
data-styled.g110[id="sc-duWCru"]{content:"dWZoid,"}/*!sc*/
.iqHzp{font-family:Courier,monospace;margin-left:10px;flex:1;overflow-x:hidden;text-overflow:ellipsis;}/*!sc*/
data-styled.g111[id="sc-etPtWW"]{content:"iqHzp,"}/*!sc*/
.ebcgbH{outline:0;color:inherit;width:100%;text-align:left;cursor:pointer;padding:10px 30px 10px 20px;border-radius:4px 4px 0 0;background-color:#11171a;display:flex;white-space:nowrap;align-items:center;border:1px solid transparent;border-bottom:0;transition:border-color 0.25s ease;}/*!sc*/
.ebcgbH ..sc-etPtWW{color:#ffffff;}/*!sc*/
.ebcgbH:focus{box-shadow:inset 0 2px 2px rgba(0, 0, 0, 0.45),0 2px 0 rgba(128, 128, 128, 0.25);}/*!sc*/
data-styled.g112[id="sc-iPHsxv"]{content:"ebcgbH,"}/*!sc*/
.cpnVKx{font-size:0.929em;line-height:20px;background-color:#186FAF;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
.IVbnb{font-size:0.929em;line-height:20px;background-color:#2F8132;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
.fzqXJO{font-size:0.929em;line-height:20px;background-color:#95507c;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
.gtVIQH{font-size:0.929em;line-height:20px;background-color:#cc3333;color:#ffffff;padding:3px 10px;text-transform:uppercase;font-family:Montserrat,sans-serif;margin:0;}/*!sc*/
data-styled.g113[id="sc-txhaY"]{content:"cpnVKx,IVbnb,fzqXJO,gtVIQH,"}/*!sc*/
.ddApzj{position:absolute;width:100%;z-index:100;background:#fafafa;color:#263238;box-sizing:border-box;box-shadow:0 0 6px rgba(0, 0, 0, 0.33);overflow:hidden;border-bottom-left-radius:4px;border-bottom-right-radius:4px;transition:all 0.25s ease;visibility:hidden;transform:translateY(-50%) scaleY(0);}/*!sc*/
data-styled.g114[id="sc-ePpfBx"]{content:"ddApzj,"}/*!sc*/
.evaCJX{padding:10px;}/*!sc*/
data-styled.g115[id="sc-dwGkES"]{content:"evaCJX,"}/*!sc*/
.gufODt{padding:5px;border:1px solid #ccc;background:#fff;word-break:break-all;color:#32329f;}/*!sc*/
.gufODt >span{color:#333333;}/*!sc*/
data-styled.g116[id="sc-hSyjfr"]{content:"gufODt,"}/*!sc*/
.fRACBr{text-transform:lowercase;margin-left:0;line-height:1.5em;}/*!sc*/
data-styled.g117[id="sc-kLJHhQ"]{content:"fRACBr,"}/*!sc*/
.kQgYHQ{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);cursor:default;}/*!sc*/
.kQgYHQ:focus{outline:auto #1d8127;}/*!sc*/
.kQgYHQ::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/
.kQgYHQ:focus{outline:0;}/*!sc*/
.fhwTMk{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#d41f1c;background-color:rgba(212,31,28,0.07);}/*!sc*/
.fhwTMk:focus{outline:auto #d41f1c;}/*!sc*/
.cnBopK{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#1d8127;background-color:rgba(29,129,39,0.07);}/*!sc*/
.cnBopK:focus{outline:auto #1d8127;}/*!sc*/
.ktPKSm{display:block;border:0;width:100%;text-align:left;padding:10px;border-radius:2px;margin-bottom:4px;line-height:1.5em;cursor:pointer;color:#d41f1c;background-color:rgba(212,31,28,0.07);cursor:default;}/*!sc*/
.ktPKSm:focus{outline:auto #d41f1c;}/*!sc*/
.ktPKSm::before{content:"—";font-weight:bold;width:1.5em;text-align:center;display:inline-block;vertical-align:top;}/*!sc*/
.ktPKSm:focus{outline:0;}/*!sc*/
data-styled.g119[id="sc-gohMHu"]{content:"kQgYHQ,fhwTMk,cnBopK,ktPKSm,"}/*!sc*/
.beMorW{vertical-align:top;}/*!sc*/
data-styled.g122[id="sc-bKXUjo"]{content:"beMorW,"}/*!sc*/
.dheqgt{font-size:1.3em;padding:0.2em 0;margin:3em 0 1.1em;color:#333333;font-weight:normal;}/*!sc*/
data-styled.g123[id="sc-edsqmr"]{content:"dheqgt,"}/*!sc*/
.exRUVh{margin-bottom:30px;}/*!sc*/
data-styled.g128[id="sc-fantwC"]{content:"exRUVh,"}/*!sc*/
.isQMci{user-select:none;width:20px;height:20px;align-self:center;display:flex;flex-direction:column;color:#32329f;}/*!sc*/
data-styled.g129[id="sc-bLmarx"]{content:"isQMci,"}/*!sc*/
.jmYWik{width:260px;background-color:#fafafa;overflow:hidden;display:flex;flex-direction:column;backface-visibility:hidden;height:100vh;position:sticky;position:-webkit-sticky;top:0;}/*!sc*/
@media screen and (max-width: 50rem){.jmYWik{position:fixed;z-index:20;width:100%;background:#fafafa;display:none;}}/*!sc*/
@media print{.jmYWik{display:none;}}/*!sc*/
data-styled.g130[id="sc-dFqmTM"]{content:"jmYWik,"}/*!sc*/
.cZPhLc{outline:none;user-select:none;background-color:#f2f2f2;color:#32329f;display:none;cursor:pointer;position:fixed;right:20px;z-index:100;border-radius:50%;box-shadow:0 0 20px rgba(0, 0, 0, 0.3);bottom:44px;width:60px;height:60px;padding:0 20px;}/*!sc*/
@media screen and (max-width: 50rem){.cZPhLc{display:flex;}}/*!sc*/
.cZPhLc svg{color:#0065FB;}/*!sc*/
@media print{.cZPhLc{display:none;}}/*!sc*/
data-styled.g131[id="sc-eqXzvo"]{content:"cZPhLc,"}/*!sc*/
.beDZfq{font-family:Roboto,sans-serif;font-size:14px;font-weight:400;line-height:1.5em;color:#333333;display:flex;position:relative;text-align:left;-webkit-font-smoothing:antialiased;font-smoothing:antialiased;text-rendering:optimizeSpeed!important;tap-highlight-color:rgba(0, 0, 0, 0);text-size-adjust:100%;}/*!sc*/
.beDZfq *{box-sizing:border-box;-webkit-tap-highlight-color:rgba(255, 255, 255, 0);}/*!sc*/
data-styled.g132[id="sc-iMPxVN"]{content:"beDZfq,"}/*!sc*/
.knmTbM{z-index:1;position:relative;overflow:hidden;width:calc(100% - 260px);contain:layout;}/*!sc*/
@media print,screen and (max-width: 50rem){.knmTbM{width:100%;}}/*!sc*/
data-styled.g133[id="sc-jdwyG"]{content:"knmTbM,"}/*!sc*/
.ifLiBE{background:#263238;position:absolute;top:0;bottom:0;right:0;width:calc((100% - 260px) * 0.4);}/*!sc*/
@media print,screen and (max-width: 75rem){.ifLiBE{display:none;}}/*!sc*/
data-styled.g134[id="sc-eEVuZf"]{content:"ifLiBE,"}/*!sc*/
.cqdCbT{padding:5px 0;}/*!sc*/
data-styled.g135[id="sc-dtOqdk"]{content:"cqdCbT,"}/*!sc*/
.kAGYgE{width:calc(100% - 40px);box-sizing:border-box;margin:0 20px;padding:5px 10px 5px 20px;border:0;border-bottom:1px solid #e1e1e1;font-family:Roboto,sans-serif;font-weight:bold;font-size:13px;color:#333333;background-color:transparent;outline:none;}/*!sc*/
data-styled.g136[id="sc-hPGoDJ"]{content:"kAGYgE,"}/*!sc*/
.eDlXyu{position:absolute;left:20px;height:1.8em;width:0.9em;}/*!sc*/
.eDlXyu path{fill:#333333;}/*!sc*/
data-styled.g137[id="sc-kBpWFy"]{content:"eDlXyu,"}/*!sc*/
</style>
</head>
<body>
<div id="redoc"><div class="sc-iMPxVN beDZfq redoc-wrap"><div class="sc-dFqmTM jmYWik menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-dtOqdk cqdCbT"><svg class="sc-kBpWFy eDlXyu search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-hPGoDJ kAGYgE search-input" value=""/></div><div class="sc-dEkLRj cpBPUN scrollbar-container undefined"><ul role="menu" class="sc-iRVXky dXwhdL"><li tabindex="0" depth="1" data-item-id="tag/User" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW bgAbkd -depth1"><span width="calc(100% - 38px)" title="User" class="sc-enMaOJ bBONey">User</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/User/operation/createUser" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="post" class="sc-erSfwj bbQame operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Sign up</span></label></li><li tabindex="0" depth="2" data-item-id="tag/User/paths/~1auth~1login/post" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="post" class="sc-erSfwj bbQame operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">User login</span></label></li><li tabindex="0" depth="2" data-item-id="tag/User/operation/getUserByName" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="get" class="sc-erSfwj bbQame operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Get user by ID</span></label></li><li tabindex="0" depth="2" data-item-id="tag/User/operation/updateUser" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="put" class="sc-erSfwj bbQame operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update user data</span></label></li><li tabindex="0" depth="2" data-item-id="tag/User/paths/~1auth~1logout/post" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="post" class="sc-erSfwj bbQame operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">User logout</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Admin" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW bgAbkd -depth1"><span width="calc(100% - 38px)" title="Admin" class="sc-enMaOJ bBONey">Admin</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Admin/operation/userStatus" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW hEJvGe -depth2"><span type="get" class="sc-erSfwj bbQame operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">List users by status</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Admin/operation/deleteUser" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="delete" class="sc-erSfwj bbQame operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete a user</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Workspace" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW bgAbkd -depth1"><span width="calc(100% - 38px)" title="Workspace" class="sc-enMaOJ bBONey">Workspace</span><svg class="sc-cHqXqK gkUOTk" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-iRVXky kUyAbS"><li tabindex="0" depth="2" data-item-id="tag/Workspace/operation/getWorkspaceById" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="get" class="sc-erSfwj bbQame operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Get workspace by ID</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workspace/operation/updateWorkspace" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="put" class="sc-erSfwj bbQame operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Update an workspace</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Workspace/operation/deleteWorkspace" role="menuitem" class="sc-ljhlHD gSwPLF"><label class="sc-bAEjGW dnJKVb -depth2"><span type="delete" class="sc-erSfwj bbQame operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-enMaOJ bBONey">Delete an workspace</span></label></li></ul></li></ul><div class="sc-fUEImY fxirIR"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-eqXzvo cZPhLc"><div class="sc-bLmarx isQMci"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
-174.68583 0.6895,0 26.281,25.03215 56.8701,
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
-104.0616 -231.873,-231.248 z
" fill="currentColor"></path></g></svg><svg class="" style="transform:translate(2px, 4px);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
-174.6858 c 96.079,-96.07721 175.253196,-174.68583 175.942696,
-174.68583 0.6895,0 26.281,25.03215 56.8701,
55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
-231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
-104.0616 -231.873,-231.248 z
" fill="currentColor"></path></g></svg></div></div><div class="sc-jdwyG knmTbM api-content"><div class="sc-dntaoT bvhSud"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq api-info"><h1 class="sc-ixGGxD sc-geoRQH kHkxTT dZsYqS">CompylerZ Application API<!-- --> <span>(<!-- -->1.0.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kEsJEW enkzRg">Download</a></p><div class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"></div><div data-role="redoc-summary" html="" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"></div><div data-role="redoc-description" html="<p>This API enables application management functionality similar to a competitive programming platform.
It includes endpoints for authentication, member and workspace management, problem/testcase import/export, and class management.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>This API enables application management functionality similar to a competitive programming platform.
It includes endpoints for authentication, member and workspace management, problem/testcase import/export, and class management.</p>
</div></div></div></div><div id="tag/User" data-section-id="tag/User" class="sc-dntaoT bvhSud"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#tag/User" aria-label="tag/User"></a>User</h2></div></div></div><div id="tag/User/operation/createUser" data-section-id="tag/User/operation/createUser" class="sc-dntaoT aYCdu"><div data-section-id="operation/createUser" id="operation/createUser" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#tag/User/operation/createUser" aria-label="tag/User/operation/createUser"></a>Sign up<!-- --> </h2><div class="sc-fantwC exRUVh"><div html="<p>This operation creates a new user profile. Only administrators can create user profiles.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>This operation creates a new user profile. Only administrators can create user profiles.</p>
</div></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <div class="sc-diYFot sc-kEfuZE iHjPVQ dkmakt"><svg class="sc-kZrBCu bweot" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="application/xml">application/xml</option></select><label>application/json</label></div><div class="sc-CNKsk sc-hGZxvd sc-kLJHhQ hPAOR feFoaC fRACBr">required</div></h5><div html="<p>User profile to be added to the database.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>User profile to be added to the database.</p>
</div><table class="sc-dprtRQ eNFxPe"><tbody><tr class=""><td kind="field" title="firstName" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">firstName</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR diHVZf"> <!-- -->non-empty<!-- --> </span></span></div> <div><div html="<p>User&#39;s first name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>User's first name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="lastName" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">lastName</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR diHVZf"> <!-- -->non-empty<!-- --> </span></span></div> <div><div html="<p>User&#39;s last name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>User's last name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi"> <!-- --><<!-- -->email<!-- -->><!-- --> </span><span class="sc-CNKsk sc-gcfzXs hPAOR dnQByT"> (<!-- -->Email<!-- -->) </span></div> <div><div html="<p>User&#39;s email address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>User's email address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="exampleObject" class="sc-ovuCP sc-eauhAA sc-hsfCcR iyKqKI iQpMVv buGHPE"><span class="sc-gQaihK kPDxnK"></span><button aria-label="expand exampleObject"><span class="property-name">exampleObject</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">object</span></div> <div><div html="<p>Example object to show an expanded schema.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Example object to show an expanded schema.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="phone" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">phone</span></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR diHVZf"> <!-- --><= 32 characters<!-- --> </span></span><span class="sc-CNKsk sc-bnGbuY hPAOR hCJxj">/^\+(?:[0-9]-?){6,14}[0-9]$/</span></div> <div><div html="<p>User&#39;s phone number. Must be provided in international format.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>User's phone number. Must be provided in international format.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="profileUrls" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">profileUrls</span></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi"> <!-- --><<!-- -->url<!-- -->><!-- --> </span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR diHVZf"> <!-- --><= 10 items<!-- --> </span></span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR dWKYKL kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi"> <<!-- -->url<!-- --> ></span> ]</span></div> <div><div html="<p>The list of URLs to user&#39;s social media profiles. You must provide the URLs with the scheme (<code>http</code> or <code>https</code>).</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>The list of URLs to user's social media profiles. You must provide the URLs with the scheme (<code>http</code> or <code>https</code>).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="status" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">status</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">strings</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR diHVZf"> <!-- -->non-empty<!-- --> </span></span></div><div><span class="sc-CNKsk hPAOR">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"active"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"banned"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"inactive"</span> </div> <div><div html="<p>Status of the user account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Status of the user account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="role" class="sc-ovuCP sc-eauhAA sc-hsfCcR iyKqKI iQpMVv buGHPE"><span class="sc-gQaihK kPDxnK"></span><button aria-label="expand role"><span class="property-name">role</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">object</span><span class="sc-CNKsk sc-gcfzXs hPAOR dnQByT"> (<!-- -->Role<!-- -->) </span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"></div></div></div></td></tr><tr class=""><td kind="field" title="userType" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">userType</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"></div></div><div class="sc-diYFot iHjPVQ"><svg class="sc-kZrBCu bweot" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="admin" selected="">admin</option><option value="basic">basic</option></select><label>admin</label></div></div></td></tr><tr class="last "><td kind="field" title="employeeType" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">employeeType</span></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"all"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Enum<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"superadmin"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"admin"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"instructor"</span> </div> <div><div html="<p>One or more departments which the admin user controls.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>One or more departments which the admin user controls.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu kQgYHQ" disabled=""><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>Account created successfully</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Account created successfully</p>
</div></button></div><div><button class="sc-gohMHu fhwTMk"><svg class="sc-cHqXqK kVOWjS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">405<!-- --> </strong><div html="<p>Invalid input</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Invalid input</p>
</div></button></div></div></div><div class="sc-ivxoEo sc-ghWlax gOjFGl oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY cpnVKx http-verb post">post</span><span class="sc-etPtWW iqHzp">/signup/{org_id}</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>Main API server</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Main API server</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr gufODt"><span>https://api.example.com/v1</span>/signup/{org_id}</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ fbQvpV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riicq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riicq:0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riicq:0" aria-labelledby="tab:Riicq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm eqWzJe">Content type</span><div class="sc-diYFot sc-frniUE iHjPVQ esCYIP"><svg class="sc-kZrBCu JXohG" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="application/xml">application/xml</option></select><label>application/json</label></div></div><div class="sc-FFETS kqHNPM"><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm eqWzJe">Example</span><div class="sc-diYFot sc-frniUE iHjPVQ esCYIP"><svg class="sc-kZrBCu JXohG" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="admin" selected="">admin</option><option value="basic">basic</option></select><label>admin</label></div></div><div><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hhzNne"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"firstName"</span>: <span class="token string">"Bunny"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastName"</span>: <span class="token string">"Rabbit"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"be07724@st.habib.edu.pk"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exampleObject"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"BunnyRabbit"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"container"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"number"</span>: <span class="token number">22</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone"</span>: <span class="token string">"+4-0800-555-0110"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"profileUrls"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"</span><a href="https://twitter.com/example">https://twitter.com/example</a><span class="token string">"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"</span><a href="https://instagram.com/example">https://instagram.com/example</a><span class="token string">"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"active"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"roleId"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roleName"</span>: <span class="token string">"Student"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"A basic user with limited access."</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"userType"</span>: <span class="token string">"admin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"employeeType"</span>: <span class="token string">"superadmin"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ fbQvpV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-error react-tabs__tab--selected" role="tab" id="tab:Rjicq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjicq:0" tabindex="0" data-rttab="true">405</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjicq:0" aria-labelledby="tab:Rjicq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm eqWzJe">Content type</span><div class="sc-UblHX kKXAng">application/problem+json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hhzNne"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"type"</span>: <span class="token string">"</span><a href="http://example.com">http://example.com</a><span class="token string">"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">400</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"detail"</span>: <span class="token string">"string"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"instance"</span>: <span class="token string">"string"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/User/paths/~1auth~1login/post" data-section-id="tag/User/paths/~1auth~1login/post" class="sc-dntaoT aYCdu"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#tag/User/paths/~1auth~1login/post" aria-label="tag/User/paths/~1auth~1login/post"></a>User login<!-- --> </h2><div class="sc-fantwC exRUVh"><div html="<p>Authenticates the user and returns a token.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>Authenticates the user and returns a token.</p>
</div></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">application/json</span><div class="sc-CNKsk sc-hGZxvd sc-kLJHhQ hPAOR feFoaC fRACBr">required</div></h5><div html="" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"></div><table class="sc-dprtRQ eNFxPe"><tbody><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">email</span></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi"> <!-- --><<!-- -->email<!-- -->><!-- --> </span><span class="sc-CNKsk sc-gcfzXs hPAOR dnQByT"> (<!-- -->Email<!-- -->) </span></div> <div><div html="<p>User&#39;s email address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>User's email address.</p>
</div></div></div></td></tr><tr class="last "><td kind="field" title="password" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">password</span></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span><span class="sc-CNKsk sc-gcfzXs hPAOR dnQByT"> (<!-- -->Password<!-- -->) </span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR diHVZf"> <!-- -->>= 8 characters<!-- --> </span></span><span class="sc-CNKsk sc-bnGbuY hPAOR hCJxj">^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[@$!%*?&#...</span><button class="sc-hylbpc dwTuQQ">Show pattern</button></div> <div><div html="<p>A strong password with at least 8 characters, including uppercase, lowercase, number, and special character.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>A strong password with at least 8 characters, including uppercase, lowercase, number, and special character.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cnBopK"><svg class="sc-cHqXqK hmCwJW" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>Successfully authenticated</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Successfully authenticated</p>
</div></button></div><div><button class="sc-gohMHu ktPKSm" disabled=""><strong class="sc-bKXUjo beMorW">401<!-- --> </strong><div html="<p>Invalid credentials</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Invalid credentials</p>
</div></button></div></div></div><div class="sc-ivxoEo sc-ghWlax gOjFGl oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY cpnVKx http-verb post">post</span><span class="sc-etPtWW iqHzp">/auth/login</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>Main API server</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Main API server</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr gufODt"><span>https://api.example.com/v1</span>/auth/login</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ fbQvpV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Riikq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Riikq:0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Riikq:0" aria-labelledby="tab:Riikq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm eqWzJe">Content type</span><div class="sc-UblHX kKXAng">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hhzNne"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"be07724@st.habib.edu.pk"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"password"</span>: <span class="token string">"P@ssw0rd"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ fbQvpV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjikq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjikq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjikq:0" aria-labelledby="tab:Rjikq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm eqWzJe">Content type</span><div class="sc-UblHX kKXAng">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hhzNne"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"token"</span>: <span class="token string">"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/User/operation/getUserByName" data-section-id="tag/User/operation/getUserByName" class="sc-dntaoT aYCdu"><div data-section-id="operation/getUserByName" id="operation/getUserByName" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#tag/User/operation/getUserByName" aria-label="tag/User/operation/getUserByName"></a>Get user by ID<!-- --> </h2><div class="sc-fantwC exRUVh"><div html="<p>The determination of this.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>The determination of this.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy eqXCjK"><span class="sc-bqvdXA dIXVzO"><i>BearerAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">path<!-- --> Parameters</h5><table class="sc-dprtRQ eNFxPe"><tbody><tr class="last "><td kind="field" title="username" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">username</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">John78</span></div><div><div html="<p>The username for which you want to retrieve the data.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>The username for which you want to retrieve the data.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ eNFxPe"><tbody><tr class=""><td kind="field" title="pretty_print" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">pretty_print</span></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">boolean</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">false</span></div> <div><div html="<p>Choose whether to pretty print the response. This option is <strong>disabled</strong> by default.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Choose whether to pretty print the response. This option is <strong>disabled</strong> by default.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="with_email" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">with_email</span></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">boolean</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">true</span></div> <div><div html="<p>Use this parameter to filter users without email. By default, only users with email are displayed.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Use this parameter to filter users without email. By default, only users with email are displayed.</p>
</div></div></div></td></tr><tr class="last "><td class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv deprecated" kind="field" title="userid"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">userid</span></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">integer</span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi"> <!-- --><<!-- -->int64<!-- -->><!-- --> </span></div><div><span type="warning" class="sc-jtQUzJ jmDXKf"> <!-- -->Deprecated<!-- --> </span></div> <div><div html="<p>ID of the user. This is an example of a <strong>deprecated</strong> parameter.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>ID of the user. This is an example of a <strong>deprecated</strong> parameter.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cnBopK"><svg class="sc-cHqXqK hmCwJW" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>Success</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Success</p>
</div></button></div><div><button class="sc-gohMHu fhwTMk"><svg class="sc-cHqXqK kVOWjS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">403<!-- --> </strong><div html="<p>Forbidden</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Forbidden</p>
</div></button></div><div><button class="sc-gohMHu fhwTMk"><svg class="sc-cHqXqK kVOWjS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">404<!-- --> </strong><div html="<p>User not found</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>User not found</p>
</div></button></div></div></div><div class="sc-ivxoEo sc-ghWlax gOjFGl oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY IVbnb http-verb get">get</span><span class="sc-etPtWW iqHzp">/users/{user_id}</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>Main API server</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Main API server</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr gufODt"><span>https://api.example.com/v1</span>/users/{user_id}</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ fbQvpV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjisq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjisq:0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab:Rjisq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjisq:1" data-rttab="true">403</li><li class="tab-error" role="tab" id="tab:Rjisq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjisq:2" data-rttab="true">404</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjisq:0" aria-labelledby="tab:Rjisq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm eqWzJe">Content type</span><div class="sc-UblHX kKXAng">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hhzNne"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"username"</span>: <span class="token string">"user1"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"user@example.com"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjisq:1" aria-labelledby="tab:Rjisq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjisq:2" aria-labelledby="tab:Rjisq:2"></div></div></div></div></div></div><div id="tag/User/operation/updateUser" data-section-id="tag/User/operation/updateUser" class="sc-dntaoT aYCdu"><div data-section-id="operation/updateUser" id="operation/updateUser" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#tag/User/operation/updateUser" aria-label="tag/User/operation/updateUser"></a>Update user data<!-- --> </h2><div class="sc-fantwC exRUVh"><div html="<p>This operation allows users to update the information in their own profile. The update can only be performed by the logged in user.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>This operation allows users to update the information in their own profile. The update can only be performed by the logged in user.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy eqXCjK"><span class="sc-bqvdXA dIXVzO"><i>BearerAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">path<!-- --> Parameters</h5><table class="sc-dprtRQ eNFxPe"><tbody><tr class="last "><td kind="field" title="username" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">username</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span></div> <div><div html="<p>The name of the user profile to be <strong>updated</strong>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>The name of the user profile to be <strong>updated</strong>.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ eNFxPe"><tbody><tr class="last "><td kind="field" title="pretty_print" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">pretty_print</span></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">boolean</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">false</span></div> <div><div html="<p>Choose whether to pretty print the response. This option is <strong>disabled</strong> by default.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Choose whether to pretty print the response. This option is <strong>disabled</strong> by default.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <div class="sc-diYFot sc-kEfuZE iHjPVQ dkmakt"><svg class="sc-kZrBCu bweot" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="application/xml">application/xml</option></select><label>application/json</label></div><div class="sc-CNKsk sc-hGZxvd sc-kLJHhQ hPAOR feFoaC fRACBr">required</div></h5><div html="<p>Updated user object</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>Updated user object</p>
</div><table class="sc-dprtRQ eNFxPe"><tbody><tr class=""><td kind="field" title="firstName" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">firstName</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR diHVZf"> <!-- -->non-empty<!-- --> </span></span></div> <div><div html="<p>User&#39;s first name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>User's first name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="lastName" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">lastName</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR diHVZf"> <!-- -->non-empty<!-- --> </span></span></div> <div><div html="<p>User&#39;s last name.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>User's last name.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="email" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">email</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi"> <!-- --><<!-- -->email<!-- -->><!-- --> </span><span class="sc-CNKsk sc-gcfzXs hPAOR dnQByT"> (<!-- -->Email<!-- -->) </span></div> <div><div html="<p>User&#39;s email address.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>User's email address.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="exampleObject" class="sc-ovuCP sc-eauhAA sc-hsfCcR iyKqKI iQpMVv buGHPE"><span class="sc-gQaihK kPDxnK"></span><button aria-label="expand exampleObject"><span class="property-name">exampleObject</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">object</span></div> <div><div html="<p>Example object to show an expanded schema.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Example object to show an expanded schema.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="phone" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">phone</span></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR diHVZf"> <!-- --><= 32 characters<!-- --> </span></span><span class="sc-CNKsk sc-bnGbuY hPAOR hCJxj">/^\+(?:[0-9]-?){6,14}[0-9]$/</span></div> <div><div html="<p>User&#39;s phone number. Must be provided in international format.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>User's phone number. Must be provided in international format.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="profileUrls" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">profileUrls</span></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">strings</span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi"> <!-- --><<!-- -->url<!-- -->><!-- --> </span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR diHVZf"> <!-- --><= 10 items<!-- --> </span></span><span class="sc-CNKsk sc-cqgMZH sc-cwJYja hPAOR dWKYKL kpFoWb">[ items<span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi"> <<!-- -->url<!-- --> ></span> ]</span></div> <div><div html="<p>The list of URLs to user&#39;s social media profiles. You must provide the URLs with the scheme (<code>http</code> or <code>https</code>).</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>The list of URLs to user's social media profiles. You must provide the URLs with the scheme (<code>http</code> or <code>https</code>).</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="status" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">status</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">strings</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR diHVZf"> <!-- -->non-empty<!-- --> </span></span></div><div><span class="sc-CNKsk hPAOR">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"active"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"banned"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"inactive"</span> </div> <div><div html="<p>Status of the user account.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Status of the user account.</p>
</div></div></div></td></tr><tr class=""><td kind="field" title="role" class="sc-ovuCP sc-eauhAA sc-hsfCcR iyKqKI iQpMVv buGHPE"><span class="sc-gQaihK kPDxnK"></span><button aria-label="expand role"><span class="property-name">role</span><svg class="sc-cHqXqK ccTkAM" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">object</span><span class="sc-CNKsk sc-gcfzXs hPAOR dnQByT"> (<!-- -->Role<!-- -->) </span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"></div></div></div></td></tr><tr class=""><td kind="field" title="userType" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">userType</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"></div></div><div class="sc-diYFot iHjPVQ"><svg class="sc-kZrBCu bweot" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="admin" selected="">admin</option><option value="basic">basic</option></select><label>admin</label></div></div></td></tr><tr class="last "><td kind="field" title="employeeType" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">employeeType</span></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"all"</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Enum<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"superadmin"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"admin"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"instructor"</span> </div> <div><div html="<p>One or more departments which the admin user controls.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>One or more departments which the admin user controls.</p>
</div></div></div></td></tr></tbody></table><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu kQgYHQ" disabled=""><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>Successfully updated the user profile</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Successfully updated the user profile</p>
</div></button></div><div><button class="sc-gohMHu fhwTMk"><svg class="sc-cHqXqK kVOWjS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">400<!-- --> </strong><div html="<p>Invalid username supplied</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Invalid username supplied</p>
</div></button></div><div><button class="sc-gohMHu fhwTMk"><svg class="sc-cHqXqK kVOWjS" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">404<!-- --> </strong><div html="<p>User not found</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>User not found</p>
</div></button></div><div><button class="sc-gohMHu ktPKSm" disabled=""><strong class="sc-bKXUjo beMorW">405<!-- --> </strong><div html="<p>Method not allowed</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Method not allowed</p>
</div></button></div></div></div><div class="sc-ivxoEo sc-ghWlax gOjFGl oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="put" class="sc-txhaY fzqXJO http-verb put">put</span><span class="sc-etPtWW iqHzp">/users/{user_id}</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>Main API server</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Main API server</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr gufODt"><span>https://api.example.com/v1</span>/users/{user_id}</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ fbQvpV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:Rij4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rij4q:0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rij4q:0" aria-labelledby="tab:Rij4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm eqWzJe">Content type</span><div class="sc-diYFot sc-frniUE iHjPVQ esCYIP"><svg class="sc-kZrBCu JXohG" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="application/xml">application/xml</option></select><label>application/json</label></div></div><div class="sc-FFETS kqHNPM"><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm eqWzJe">Example</span><div class="sc-diYFot sc-frniUE iHjPVQ esCYIP"><svg class="sc-kZrBCu JXohG" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="admin" selected="">admin</option><option value="basic">basic</option></select><label>admin</label></div></div><div><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hhzNne"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"firstName"</span>: <span class="token string">"Bunny"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"lastName"</span>: <span class="token string">"Rabbit"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"email"</span>: <span class="token string">"be07724@st.habib.edu.pk"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"exampleObject"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"BunnyRabbit"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"container"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"number"</span>: <span class="token number">22</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"phone"</span>: <span class="token string">"+4-0800-555-0110"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"profileUrls"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"</span><a href="https://twitter.com/example">https://twitter.com/example</a><span class="token string">"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"</span><a href="https://instagram.com/example">https://instagram.com/example</a><span class="token string">"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"status"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"active"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"role"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"roleId"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roleName"</span>: <span class="token string">"Student"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"A basic user with limited access."</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"userType"</span>: <span class="token string">"admin"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"employeeType"</span>: <span class="token string">"superadmin"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ fbQvpV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:Rjj4q:0" aria-selected="true" aria-disabled="false" aria-controls="panel:Rjj4q:0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab:Rjj4q:1" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjj4q:1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab:Rjj4q:2" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjj4q:2" data-rttab="true">404</li><li class="tab-error" role="tab" id="tab:Rjj4q:3" aria-selected="false" aria-disabled="false" aria-controls="panel:Rjj4q:3" data-rttab="true">405</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:Rjj4q:0" aria-labelledby="tab:Rjj4q:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm eqWzJe">Content type</span><div class="sc-UblHX kKXAng">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hhzNne"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"status"</span>: <span class="token number">200</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">"OK"</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjj4q:1" aria-labelledby="tab:Rjj4q:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjj4q:2" aria-labelledby="tab:Rjj4q:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:Rjj4q:3" aria-labelledby="tab:Rjj4q:3"></div></div></div></div></div></div><div id="tag/User/paths/~1auth~1logout/post" data-section-id="tag/User/paths/~1auth~1logout/post" class="sc-dntaoT aYCdu"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#tag/User/paths/~1auth~1logout/post" aria-label="tag/User/paths/~1auth~1logout/post"></a>User logout<!-- --> </h2><div class="sc-fantwC exRUVh"><div html="<p>Logs the user out by invalidating the token.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>Logs the user out by invalidating the token.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy eqXCjK"><span class="sc-bqvdXA dIXVzO"><i>BearerAuth</i></span></span></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu kQgYHQ" disabled=""><strong class="sc-bKXUjo beMorW">204<!-- --> </strong><div html="<p>Successful logout</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Successful logout</p>
</div></button></div></div></div><div class="sc-ivxoEo sc-ghWlax gOjFGl oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="post" class="sc-txhaY cpnVKx http-verb post">post</span><span class="sc-etPtWW iqHzp">/auth/logout</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>Main API server</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Main API server</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr gufODt"><span>https://api.example.com/v1</span>/auth/logout</div></div></div></div></div></div></div></div><div id="tag/Admin" data-section-id="tag/Admin" class="sc-dntaoT bvhSud"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#tag/Admin" aria-label="tag/Admin"></a>Admin</h2></div></div></div><div id="tag/Admin/operation/userStatus" data-section-id="tag/Admin/operation/userStatus" class="sc-dntaoT aYCdu"><div data-section-id="operation/userStatus" id="operation/userStatus" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#tag/Admin/operation/userStatus" aria-label="tag/Admin/operation/userStatus"></a>List users by status<!-- --> <span type="warning" class="sc-jtQUzJ jmDXKf"> Deprecated </span></h2><div class="sc-fantwC exRUVh"><div html="<p>This operation lets you list users by their status. Multiple status values can be provided in a single request by using comma-separated strings. Only administrators can use this operation.</p>
<p><strong>This is an example of a deprecated operation.</strong></p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>This operation lets you list users by their status. Multiple status values can be provided in a single request by using comma-separated strings. Only administrators can use this operation.</p>
<p><strong>This is an example of a deprecated operation.</strong></p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy eqXCjK"><span class="sc-bqvdXA dIXVzO"><i>BearerAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ eNFxPe"><tbody><tr class="last "><td kind="field" title="status" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">status</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL">Array of </span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">strings</span><span> <span class="sc-CNKsk sc-fIfZzT hPAOR diHVZf"> <!-- -->[ 1 .. 3 ] items<!-- --> </span><span class="sc-CNKsk sc-fIfZzT hPAOR diHVZf"> <!-- -->unique<!-- --> </span></span></div><div><span class="sc-CNKsk hPAOR">Items<!-- --> <!-- -->Enum<!-- -->:</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"active"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"banned"</span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">"inactive"</span> </div> <div><div html="<p>One or more user status values by which to look up user accounts.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>One or more user status values by which to look up user accounts.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cnBopK"><svg class="sc-cHqXqK hmCwJW" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>Successful response example</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Successful response example</p>
</div></button></div><div><button class="sc-gohMHu ktPKSm" disabled=""><strong class="sc-bKXUjo beMorW">400<!-- --> </strong><div html="<p>Invalid status value was provided in the request</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Invalid status value was provided in the request</p>
</div></button></div></div></div><div class="sc-ivxoEo sc-ghWlax gOjFGl oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY IVbnb http-verb get">get</span><span class="sc-etPtWW iqHzp">/user/list</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>Main API server</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Main API server</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr gufODt"><span>https://api.example.com/v1</span>/user/list</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ fbQvpV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pda:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pda:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pda:0" aria-labelledby="tab:R9pda:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm eqWzJe">Content type</span><div class="sc-diYFot sc-frniUE iHjPVQ esCYIP"><svg class="sc-kZrBCu JXohG" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="6 9 12 15 18 9"></polyline></svg><select class="dropdown-select"><option value="application/json" selected="">application/json</option><option value="application/xml">application/xml</option><option value="text/plain">text/plain</option></select><label>application/json</label></div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hhzNne"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable "><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"firstName"</span>: <span class="token string">"Bunny"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"lastName"</span>: <span class="token string">"Rabbit"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">"be07724@st.habib.edu.pk"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"exampleObject"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token number">27</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"name"</span>: <span class="token string">"BunnyRabbit"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"container"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"number"</span>: <span class="token number">22</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"phone"</span>: <span class="token string">"+4-0800-555-0110"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"profileUrls"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"</span><a href="https://twitter.com/example">https://twitter.com/example</a><span class="token string">"</span>,</div></li><li><div class="hoverable collapsed"><span class="token string">"</span><a href="https://instagram.com/example">https://instagram.com/example</a><span class="token string">"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"status"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><span class="token string">"active"</span></div></li></ul><span class="token punctuation">]</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"userid"</span>: <span class="token number">27</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"role"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"roleId"</span>: <span class="token number">1</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"roleName"</span>: <span class="token string">"Student"</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"description"</span>: <span class="token string">"A basic user with limited access."</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Admin/operation/deleteUser" data-section-id="tag/Admin/operation/deleteUser" class="sc-dntaoT aYCdu"><div data-section-id="operation/deleteUser" id="operation/deleteUser" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#tag/Admin/operation/deleteUser" aria-label="tag/Admin/operation/deleteUser"></a>Delete a user<!-- --> </h2><div class="sc-fantwC exRUVh"><div html="<p>This operation deletes all data associated with the requested <code>username</code>. Only administrators can perform this operation.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>This operation deletes all data associated with the requested <code>username</code>. Only administrators can perform this operation.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy eqXCjK"><span class="sc-bqvdXA dIXVzO"><i>BearerAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">path<!-- --> Parameters</h5><table class="sc-dprtRQ eNFxPe"><tbody><tr class="last "><td kind="field" title="username" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">username</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">John78</span></div><div><div html="<p>The name of the user profile to be <strong>deleted</strong>.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>The name of the user profile to be <strong>deleted</strong>.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-dpBQxM eJAAZj">query<!-- --> Parameters</h5><table class="sc-dprtRQ eNFxPe"><tbody><tr class="last "><td kind="field" title="pretty_print" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">pretty_print</span></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">boolean</span></div><div><span class="sc-CNKsk hPAOR"> <!-- -->Default:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">false</span></div> <div><div html="<p>Choose whether to pretty print the response. This option is <strong>disabled</strong> by default.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Choose whether to pretty print the response. This option is <strong>disabled</strong> by default.</p>
</div></div></div></td></tr></tbody></table></div><div><h5 class="sc-dpBQxM eJAAZj">header<!-- --> Parameters</h5><table class="sc-dprtRQ eNFxPe"><tbody><tr class="last "><td kind="field" title="api_key" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">api_key</span></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span></div> <div><span class="sc-CNKsk hPAOR"> <!-- -->Example:<!-- --> </span> <span class="sc-CNKsk sc-cSzYSJ hPAOR YZnqP">Bearer <TOKEN></span></div><div><div html="" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"></div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu kQgYHQ" disabled=""><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>Successfully deleted a user</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Successfully deleted a user</p>
</div></button></div><div><button class="sc-gohMHu ktPKSm" disabled=""><strong class="sc-bKXUjo beMorW">400<!-- --> </strong><div html="<p>Invalid username provided</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Invalid username provided</p>
</div></button></div><div><button class="sc-gohMHu ktPKSm" disabled=""><strong class="sc-bKXUjo beMorW">404<!-- --> </strong><div html="<p>User not found</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>User not found</p>
</div></button></div></div></div><div class="sc-ivxoEo sc-ghWlax gOjFGl oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="delete" class="sc-txhaY gtVIQH http-verb delete">delete</span><span class="sc-etPtWW iqHzp">/users/{user_id}</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>Main API server</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Main API server</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr gufODt"><span>https://api.example.com/v1</span>/users/{user_id}</div></div></div></div></div></div></div></div><div id="tag/Workspace" data-section-id="tag/Workspace" class="sc-dntaoT bvhSud"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#tag/Workspace" aria-label="tag/Workspace"></a>Workspace</h2></div></div></div><div id="tag/Workspace/operation/getWorkspaceById" data-section-id="tag/Workspace/operation/getWorkspaceById" class="sc-dntaoT aYCdu"><div data-section-id="operation/getWorkspaceById" id="operation/getWorkspaceById" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#tag/Workspace/operation/getWorkspaceById" aria-label="tag/Workspace/operation/getWorkspaceById"></a>Get workspace by ID<!-- --> </h2><div class="sc-fantwC exRUVh"><div html="<p>Retrieve an workspace by its unique ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>Retrieve an workspace by its unique ID.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy eqXCjK"><span class="sc-bqvdXA dIXVzO"><i>BearerAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">path<!-- --> Parameters</h5><table class="sc-dprtRQ eNFxPe"><tbody><tr class="last "><td kind="field" title="workspace_id" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">workspace_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">integer</span></div> <div><div html="<p>ID of the workspace to retrieve.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>ID of the workspace to retrieve.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cnBopK"><svg class="sc-cHqXqK hmCwJW" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>Workspace details.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Workspace details.</p>
</div></button></div><div><button class="sc-gohMHu ktPKSm" disabled=""><strong class="sc-bKXUjo beMorW">404<!-- --> </strong><div html="<p>Workspace not found.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Workspace not found.</p>
</div></button></div></div></div><div class="sc-ivxoEo sc-ghWlax gOjFGl oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY IVbnb http-verb get">get</span><span class="sc-etPtWW iqHzp">/workspaces/{workspace_id}</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>Main API server</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Main API server</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr gufODt"><span>https://api.example.com/v1</span>/workspaces/{workspace_id}</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ fbQvpV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pdq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pdq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pdq:0" aria-labelledby="tab:R9pdq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm eqWzJe">Content type</span><div class="sc-UblHX kKXAng">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hhzNne"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><span class="token keyword">null</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Workspace/operation/updateWorkspace" data-section-id="tag/Workspace/operation/updateWorkspace" class="sc-dntaoT aYCdu"><div data-section-id="operation/updateWorkspace" id="operation/updateWorkspace" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#tag/Workspace/operation/updateWorkspace" aria-label="tag/Workspace/operation/updateWorkspace"></a>Update an workspace<!-- --> </h2><div class="sc-fantwC exRUVh"><div html="<p>Update the details of an existing workspace.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>Update the details of an existing workspace.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy eqXCjK"><span class="sc-bqvdXA dIXVzO"><i>BearerAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">path<!-- --> Parameters</h5><table class="sc-dprtRQ eNFxPe"><tbody><tr class="last "><td kind="field" title="workspace_id" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">workspace_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">integer</span></div> <div><div html="<p>ID of the workspace to update.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>ID of the workspace to update.</p>
</div></div></div></td></tr></tbody></table></div><h5 class="sc-dpBQxM eJAAZj">Request Body schema: <span class="sc-dhCplO khtVmz">application/json</span><div class="sc-CNKsk sc-hGZxvd sc-kLJHhQ hPAOR feFoaC fRACBr">required</div></h5><div html="" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"></div><div><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">any</span><span class="sc-CNKsk sc-gcfzXs hPAOR dnQByT"> (<!-- -->Workspace-2<!-- -->) </span></div> <div><div html="" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"></div></div></div></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu kQgYHQ" disabled=""><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="<p>Successfully updated the workspace.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Successfully updated the workspace.</p>
</div></button></div><div><button class="sc-gohMHu ktPKSm" disabled=""><strong class="sc-bKXUjo beMorW">400<!-- --> </strong><div html="<p>Invalid input.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Invalid input.</p>
</div></button></div><div><button class="sc-gohMHu ktPKSm" disabled=""><strong class="sc-bKXUjo beMorW">404<!-- --> </strong><div html="<p>Workspace not found.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Workspace not found.</p>
</div></button></div></div></div><div class="sc-ivxoEo sc-ghWlax gOjFGl oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="put" class="sc-txhaY fzqXJO http-verb put">put</span><span class="sc-etPtWW iqHzp">/workspaces/{workspace_id}</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>Main API server</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Main API server</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr gufODt"><span>https://api.example.com/v1</span>/workspaces/{workspace_id}</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Request samples<!-- --> </h3><div class="sc-bMTdWJ fbQvpV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="tab:R99lq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R99lq:0" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R99lq:0" aria-labelledby="tab:R99lq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm eqWzJe">Content type</span><div class="sc-UblHX kKXAng">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hhzNne"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><span class="token keyword">null</span></code></div></div></div></div></div></div></div></div></div></div></div><div id="tag/Workspace/operation/deleteWorkspace" data-section-id="tag/Workspace/operation/deleteWorkspace" class="sc-dntaoT aYCdu"><div data-section-id="operation/deleteWorkspace" id="operation/deleteWorkspace" class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#tag/Workspace/operation/deleteWorkspace" aria-label="tag/Workspace/operation/deleteWorkspace"></a>Delete an workspace<!-- --> </h2><div class="sc-fantwC exRUVh"><div html="<p>Remove an workspace from the database by its ID.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>Remove an workspace from the database by its ID.</p>
</div></div><div class="sc-hGNhLO dyzdIR"><div class="sc-jWJSSj jXOga-d"><h5 class="sc-dpBQxM sc-khdDuB eJAAZj ffSXYc">Authorizations:</h5><svg class="sc-cHqXqK bEpxpV" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></div><div class="sc-iCjFWQ gQOXJB"><span class="sc-irPVuy eqXCjK"><span class="sc-bqvdXA dIXVzO"><i>BearerAuth</i></span></span></div></div><div><h5 class="sc-dpBQxM eJAAZj">path<!-- --> Parameters</h5><table class="sc-dprtRQ eNFxPe"><tbody><tr class="last "><td kind="field" title="workspace_id" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">workspace_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">integer</span></div> <div><div html="<p>ID of the workspace to delete.</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>ID of the workspace to delete.</p>
</div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu kQgYHQ" disabled=""><strong class="sc-bKXUjo beMorW">204<!-- --> </strong><div html="<p>Successfully deleted the workspace.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Successfully deleted the workspace.</p>
</div></button></div><div><button class="sc-gohMHu ktPKSm" disabled=""><strong class="sc-bKXUjo beMorW">404<!-- --> </strong><div html="<p>Workspace not found.</p>
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Workspace not found.</p>
</div></button></div></div></div><div class="sc-ivxoEo sc-ghWlax gOjFGl oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="delete" class="sc-txhaY gtVIQH http-verb delete">delete</span><span class="sc-etPtWW iqHzp">/workspaces/{workspace_id}</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="<p>Main API server</p>
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>Main API server</p>
</div><div tabindex="0" role="button"><div class="sc-hSyjfr gufODt"><span>https://api.example.com/v1</span>/workspaces/{workspace_id}</div></div></div></div></div></div></div></div></div><div class="sc-eEVuZf ifLiBE"></div></div></div>
<script>
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.1.0","info":{"title":"CompylerZ Application API","version":"1.0.0","description":"This API enables application management functionality similar to a competitive programming platform.\nIt includes endpoints for authentication, member and workspace management, problem/testcase import/export, and class management.\n"},"servers":[{"url":"https://api.example.com/v1","description":"Main API server"}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Workspace":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":"string"},"description":{"type":"string"}}},"Class":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"students":{"type":"array","items":{"type":"string"}}}},"Employee":{"description":"Example of a user profile with admin permissions. This type of user is also referred to as an **administrator**.","allOf":[{"$ref":"#/components/schemas/User"},{"type":"object","properties":{"userType":{"type":"string","enum":["admin","basic"]},"employeeType":{"type":"string","description":"One or more departments which the admin user controls.","default":"all","example":"superadmin","enum":["superadmin","admin","instructor"]}},"required":["adminDept","userType"]}]},"User":{"type":"object","required":["email","firstName","lastName","status"],"discriminator":{"propertyName":"userType","mapping":{"admin":"#/components/schemas/Employee","basic":"#/components/schemas/Candidate"}},"properties":{"firstName":{"description":"User's first name.","type":"string","minLength":1,"example":"Bunny"},"lastName":{"description":"User's last name.","type":"string","minLength":1,"example":"Rabbit"},"email":{"$ref":"#/components/schemas/Email"},"exampleObject":{"description":"Example object to show an expanded schema.","allOf":[{"$ref":"#/components/schemas/ExampleObject"}]},"phone":{"description":"User's phone number. Must be provided in international format.","type":"string","pattern":"/^\\+(?:[0-9]-?){6,14}[0-9]$/","maxLength":32,"example":"+4-0800-555-0110"},"profileUrls":{"description":"The list of URLs to user's social media profiles. You must provide the URLs with the scheme (`http` or `https`).","type":"array","maxItems":10,"xml":{"name":"profileUrl","wrapped":true},"items":{"type":"string","format":"url"},"example":["https://twitter.com/example","https://instagram.com/example"]},"status":{"description":"Status of the user account.","type":"array","minItems":1,"items":{"type":"string","enum":["active","banned","inactive"]}},"userid":{"description":"Unique ID of the user.","externalDocs":{"description":"Example of external documentation link","url":"https://example.com"},"allOf":[{"$ref":"#/components/schemas/UserID"}]},"role":{"$ref":"#/components/schemas/Role"}},"xml":{"name":"User"}},"Candidate":{"description":"Example of a user with basic (restricted) permissions. In total, there are 5 permission levels, but basic users can only use the first three.","allOf":[{"$ref":"#/components/schemas/User"},{"type":"object","properties":{"userType":{"type":"string","enum":["admin","basic"]},"program":{"type":"string","description":"The academic program the candidate is enrolled in.","example":"Computer Science","enum":["Computer Science","Mathematics","Physics"]},"batch":{"type":"integer","format":"int32","description":"The graduation year of the candidate.","example":2023}},"required":["userType"]}]},"Email":{"description":"User's email address.","type":"string","format":"email","example":"be07724@st.habib.edu.pk"},"UserID":{"type":"integer","format":"int64","readOnly":true,"example":27},"ExampleObject":{"type":"object","properties":{"id":{"description":"User ID.","allOf":[{"$ref":"#/components/schemas/UserID"}]},"name":{"description":"Example name.","type":"string","minLength":1,"maxLength":64,"example":"BunnyRabbit"},"container":{"description":"Example object within an object.","type":"object","properties":{"number":{"type":"integer","description":"Example nullable value in a container object.","example":22}}}}},"Role":{"type":"object","properties":{"roleId":{"type":"integer","format":"int32","description":"Identifier of the role assigned to the user.","example":1},"roleName":{"type":"string","description":"Name of the role assigned to the user.","example":"Student"},"description":{"type":"string","description":"Description of the role.","example":"A basic user with limited access."}},"required":["roleId","roleName"]},"Problem":{"type":"object","additionalProperties":true,"minProperties":1,"description":"The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)].","properties":{"type":{"type":"string","description":"A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be \"about:blank\".","format":"uri"},"title":{"type":"string","description":"A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."},"status":{"type":"integer","description":"The HTTP status code.","minimum":400,"maximum":599},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced."}}},"Password":{"type":"string","description":"A strong password with at least 8 characters, including uppercase, lowercase, number, and special character.","minLength":8,"pattern":"^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[@$!%*?&#])[A-Za-z\\d@$!%*?&#]{8,}$","example":"P@ssw0rd"},"Workspace-2":{"components":{"schemas":{"Worksspace":{"type":"object","required":["org_id","org_name","org_type","org_code"],"properties":{"org_id":{"type":"integer","description":"Unique identifier for the organization.","example":1},"org_name":{"type":"string","description":"Name of the organization.","example":"Tech Solutions Inc."},"org_type":{"type":"string","description":"Type of organization (e.g., corporate, educational).","example":"corporate"},"org_code":{"type":"string","description":"Unique code assigned to the organization.","example":"TSI-123"},"new_field":{"type":"string","description":"A placeholder for any new field added in the future.","example":"Custom Data"},"contact_email":{"type":"string","format":"email","description":"Contact email for the organization.","example":"contact@techsolutions.com"},"contact_phone":{"type":"string","description":"Contact phone number.","example":"+1-800-555-0100"},"website_url":{"type":"string","format":"uri","description":"Website URL of the organization.","example":"https://www.techsolutions.com"},"country":{"type":"string","description":"Country where the organization is located.","example":"USA"},"local_address":{"type":"string","description":"Full local address of the organization.","example":"123 Main Street, Anytown, CA 90210"},"subscription_plan":{"type":"string","description":"Current subscription plan for the organization.","example":"Premium"},"created_at":{"type":"string","format":"date-time","description":"Date and time when the organization was created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time when the organization was last updated."},"status":{"type":"integer","description":"Status of the organization (e.g., active/inactive).","example":1},"preferences_json":{"type":"object","description":"Custom preferences stored as JSON.","example":{"key1":"value1","key2":"value2"}}}}}}}},"responses":{"Problem":{"description":"Problem","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"security":[{"BearerAuth":[]}],"paths":{"/signup/{org_id}":{"post":{"tags":["User"],"summary":"Sign up","description":"This operation creates a new user profile. Only administrators can create user profiles.","security":[],"operationId":"createUser","responses":{"200":{"description":"Account created successfully"},"405":{"description":"Invalid input","$ref":"#/components/responses/Problem"}},"requestBody":{"content":{"application/json":{"schema":{"discriminator":{"propertyName":"userType","mapping":{"admin":"#/components/schemas/Employee","basic":"#/components/schemas/Candidate"}},"anyOf":[{"$ref":"#/components/schemas/Employee"},{"$ref":"#/components/schemas/Candidate"}]}},"application/xml":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Example description"}}}}},"description":"User profile to be added to the database.","required":true}}},"/user/list":{"get":{"tags":["Admin"],"summary":"List users by status","description":"This operation lets you list users by their status. Multiple status values can be provided in a single request by using comma-separated strings. Only administrators can use this operation.\n \n**This is an example of a deprecated operation.**","operationId":"userStatus","deprecated":true,"parameters":[{"name":"status","in":"query","description":"One or more user status values by which to look up user accounts.","required":true,"style":"form","explode":false,"schema":{"type":"array","uniqueItems":true,"minItems":1,"maxItems":3,"items":{"type":"string","enum":["active","banned","inactive"],"default":"active"}}}],"responses":{"200":{"description":"Successful response example","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}},"application/xml":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User"}}},"text/plain":{"examples":{"response":{"value":"Success!"}}}}},"400":{"description":"Invalid status value was provided in the request"}},"security":[{"BearerAuth":[]}]}},"/auth/login":{"post":{"tags":["User"],"summary":"User login","description":"Authenticates the user and returns a token.","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/Email"},"password":{"$ref":"#/components/schemas/Password"}}}}}},"responses":{"200":{"description":"Successfully authenticated","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}}}}},"401":{"description":"Invalid credentials"}}}},"/users/{user_id}":{"parameters":[{"name":"pretty_print","in":"query","description":"Choose whether to pretty print the response. This option is **disabled** by default.","schema":{"type":"boolean","default":false}}],"get":{"tags":["User"],"summary":"Get user by ID","description":"The determination of this.\n","operationId":"getUserByName","parameters":[{"name":"username","in":"path","description":"The username for which you want to retrieve the data.","example":"John78","required":true,"schema":{"type":"string"}},{"name":"with_email","in":"query","description":"Use this parameter to filter users without email. By default, only users with email are displayed.","schema":{"type":"boolean","default":true}},{"name":"userid","in":"query","description":"ID of the user. This is an example of a **deprecated** parameter.","required":false,"deprecated":true,"schema":{"type":"integer","format":"int64"}}],"security":[{"BearerAuth":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":{"username":"user1","email":"user@example.com"}}}},"403":{"description":"Forbidden","$ref":"#/components/responses/Problem"},"404":{"description":"User not found","$ref":"#/components/responses/Problem"}}},"put":{"tags":["User"],"summary":"Update user data","description":"This operation allows users to update the information in their own profile. The update can only be performed by the logged in user.","operationId":"updateUser","parameters":[{"name":"username","in":"path","description":"The name of the user profile to be **updated**.","required":true,"schema":{"type":"string"}}],"security":[{"BearerAuth":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}},"application/xml":{"schema":{"$ref":"#/components/schemas/User"}}},"description":"Updated user object","required":true},"responses":{"200":{"description":"Successfully updated the user profile","content":{"application/json":{"example":{"status":200,"message":"OK"}}}},"400":{"description":"Invalid username supplied","$ref":"#/components/responses/Problem"},"404":{"description":"User not found","$ref":"#/components/responses/Problem"},"405":{"description":"Method not allowed","content":{"application/json":{"example":{"status":405,"message":"Not allowed"}}}}}},"delete":{"tags":["Admin"],"summary":"Delete a user","description":"This operation deletes all data associated with the requested `username`. Only administrators can perform this operation.","operationId":"deleteUser","parameters":[{"name":"api_key","in":"header","required":false,"schema":{"type":"string","example":"Bearer <TOKEN>"}},{"name":"username","in":"path","description":"The name of the user profile to be **deleted**.","example":"John78","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully deleted a user"},"400":{"description":"Invalid username provided"},"404":{"description":"User not found"}},"security":[{"BearerAuth":[]}]}},"/auth/logout":{"post":{"tags":["User"],"summary":"User logout","description":"Logs the user out by invalidating the token.","responses":{"204":{"description":"Successful logout"}}}},"/workspaces/{workspace_id}":{"get":{"tags":["Workspace"],"summary":"Get workspace by ID","description":"Retrieve an workspace by its unique ID.","operationId":"getWorkspaceById","parameters":[{"name":"workspace_id","in":"path","required":true,"description":"ID of the workspace to retrieve.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Workspace details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace-2"}}}},"404":{"description":"Workspace not found."}}},"put":{"tags":["Workspace"],"summary":"Update an workspace","description":"Update the details of an existing workspace.","operationId":"updateWorkspace","parameters":[{"name":"workspace_id","in":"path","required":true,"description":"ID of the workspace to update.","schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workspace-2"}}}},"responses":{"200":{"description":"Successfully updated the workspace."},"400":{"description":"Invalid input."},"404":{"description":"Workspace not found."}}},"delete":{"tags":["Workspace"],"summary":"Delete an workspace","description":"Remove an workspace from the database by its ID.","operationId":"deleteWorkspace","parameters":[{"name":"workspace_id","in":"path","required":true,"description":"ID of the workspace to delete.","schema":{"type":"integer"}}],"responses":{"204":{"description":"Successfully deleted the workspace."},"404":{"description":"Workspace not found."}}}}}}},"searchIndex":{"store":["tag/User","tag/User/operation/createUser","tag/User/paths/~1auth~1login/post","tag/User/operation/getUserByName","tag/User/operation/updateUser","tag/User/paths/~1auth~1logout/post","tag/Admin","tag/Admin/operation/userStatus","tag/Admin/operation/deleteUser","tag/Workspace","tag/Workspace/operation/getWorkspaceById","tag/Workspace/operation/updateWorkspace","tag/Workspace/operation/deleteWorkspace"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.141]],["description/0",[]],["title/1",[1,2.198,2,2.198]],["description/1",[0,0.133,3,0.904,4,2.612,5,1.779,6,2.015,7,1.104,8,1.779]],["title/2",[0,0.112,9,2.198]],["description/2",[0,0.123,10,2.419,11,2.419,12,1.866,13,2.419]],["title/3",[0,0.112,14,1.117]],["description/3",[15,3.086,16,1.915]],["title/4",[0,0.092,17,0.923,18,1.402]],["description/4",[0,0.128,3,0.858,6,1.303,16,1.049,17,1.278,19,1.689,20,1.689,21,1.303,22,1.303]],["title/5",[0,0.112,23,2.198]],["description/5",[0,0.114,12,1.741,22,1.741,24,2.257,25,2.257,26,2.257]],["title/6",[27,2.779]],["description/6",[]],["title/7",[0,0.092,28,1.402,29,1.402]],["description/7",[0,0.057,3,1.176,7,0.698,28,0.867,29,1.411,30,1.124,31,1.124,32,1.124,33,1.124,34,1.124,35,0.867,36,1.83,37,1.124,38,1.124,39,1.124,40,1.124,41,1.124]],["title/8",[0,0.112,42,1.364]],["description/8",[3,1.327,7,1.104,16,1.104,18,1.372,21,1.372,35,1.372,42,1.104,43,1.779,44,1.779]],["title/9",[45,0.777]],["description/9",[]],["title/10",[14,1.117,45,0.614]],["description/10",[14,1.229,45,0.676,46,2.419,47,2.419,48,1.501]],["title/11",[17,1.117,45,0.614]],["description/11",[17,1.229,45,0.676,48,1.501,49,2.419,50,2.419]],["title/12",[42,1.364,45,0.614]],["description/12",[14,1.229,45,0.676,48,1.501,51,2.419,52,2.419]]],"invertedIndex":[["admin",{"_index":27,"title":{"6":{}},"description":{}}],["administr",{"_index":7,"title":{},"description":{"1":{},"7":{},"8":{}}}],["allow",{"_index":19,"title":{},"description":{"4":{}}}],["associ",{"_index":43,"title":{},"description":{"8":{}}}],["auth/login",{"_index":13,"title":{},"description":{"2":{}}}],["auth/logout",{"_index":26,"title":{},"description":{"5":{}}}],["authent",{"_index":10,"title":{},"description":{"2":{}}}],["comma-separ",{"_index":37,"title":{},"description":{"7":{}}}],["creat",{"_index":4,"title":{},"description":{"1":{}}}],["data",{"_index":18,"title":{"4":{}},"description":{"8":{}}}],["databas",{"_index":52,"title":{},"description":{"12":{}}}],["delet",{"_index":42,"title":{"8":{},"12":{}},"description":{"8":{}}}],["deprec",{"_index":40,"title":{},"description":{"7":{}}}],["detail",{"_index":49,"title":{},"description":{"11":{}}}],["determin",{"_index":15,"title":{},"description":{"3":{}}}],["exampl",{"_index":39,"title":{},"description":{"7":{}}}],["exist",{"_index":50,"title":{},"description":{"11":{}}}],["id",{"_index":14,"title":{"3":{},"10":{}},"description":{"10":{},"12":{}}}],["inform",{"_index":20,"title":{},"description":{"4":{}}}],["invalid",{"_index":25,"title":{},"description":{"5":{}}}],["let",{"_index":30,"title":{},"description":{"7":{}}}],["list",{"_index":28,"title":{"7":{}},"description":{"7":{}}}],["log",{"_index":22,"title":{},"description":{"4":{},"5":{}}}],["login",{"_index":9,"title":{"2":{}},"description":{}}],["logout",{"_index":23,"title":{"5":{}},"description":{}}],["multipl",{"_index":31,"title":{},"description":{"7":{}}}],["new",{"_index":5,"title":{},"description":{"1":{}}}],["oper",{"_index":3,"title":{},"description":{"1":{},"4":{},"7":{},"8":{}}}],["out",{"_index":24,"title":{},"description":{"5":{}}}],["perform",{"_index":21,"title":{},"description":{"4":{},"8":{}}}],["profil",{"_index":6,"title":{},"description":{"1":{},"4":{}}}],["provid",{"_index":33,"title":{},"description":{"7":{}}}],["remov",{"_index":51,"title":{},"description":{"12":{}}}],["request",{"_index":35,"title":{},"description":{"7":{},"8":{}}}],["retriev",{"_index":46,"title":{},"description":{"10":{}}}],["return",{"_index":11,"title":{},"description":{"2":{}}}],["sign",{"_index":1,"title":{"1":{}},"description":{}}],["signup/{org_id",{"_index":8,"title":{},"description":{"1":{}}}],["singl",{"_index":34,"title":{},"description":{"7":{}}}],["statu",{"_index":29,"title":{"7":{}},"description":{"7":{}}}],["string",{"_index":38,"title":{},"description":{"7":{}}}],["token",{"_index":12,"title":{},"description":{"2":{},"5":{}}}],["uniqu",{"_index":47,"title":{},"description":{"10":{}}}],["up",{"_index":2,"title":{"1":{}},"description":{}}],["updat",{"_index":17,"title":{"4":{},"11":{}},"description":{"4":{},"11":{}}}],["us",{"_index":36,"title":{},"description":{"7":{}}}],["user",{"_index":0,"title":{"0":{},"2":{},"3":{},"4":{},"5":{},"7":{},"8":{}},"description":{"1":{},"2":{},"4":{},"5":{},"7":{}}}],["user/list",{"_index":41,"title":{},"description":{"7":{}}}],["usernam",{"_index":44,"title":{},"description":{"8":{}}}],["users/{user_id",{"_index":16,"title":{},"description":{"3":{},"4":{},"8":{}}}],["valu",{"_index":32,"title":{},"description":{"7":{}}}],["workspac",{"_index":45,"title":{"9":{},"10":{},"11":{},"12":{}},"description":{"10":{},"11":{},"12":{}}}],["workspaces/{workspace_id",{"_index":48,"title":{},"description":{"10":{},"11":{},"12":{}}}]],"pipeline":[]}},"options":{"htmlTemplate":"./docs/index.html","theme":{"colors":{"primary":{"main":"#32329f"}}},"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Node.js"},{"lang":"JavaScript"},{"lang":"PHP"},{"lang":"Python"}]}}};
var container = document.getElementById('redoc');
Redoc.hydrate(__redoc_state, container);
</script>
</body>
</html>