aloux-iam 0.0.4 → 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitattributes +2 -2
- package/CONTRIBUTING.md +1 -1
- package/LICENSE +21 -21
- package/README.md +136 -136
- package/index.js +33 -33
- package/lib/config/utils.js +13 -13
- package/lib/controllers/auth.js +147 -147
- package/lib/controllers/functions.js +86 -86
- package/lib/controllers/menu.js +101 -101
- package/lib/controllers/operationsAWS.js +218 -218
- package/lib/controllers/permission.js +90 -90
- package/lib/controllers/user.js +734 -734
- package/lib/middleware.js +90 -90
- package/lib/models/Functions.js +13 -13
- package/lib/models/Menu.js +15 -15
- package/lib/models/Permission.js +14 -14
- package/lib/models/User.js +91 -91
- package/lib/router.js +72 -72
- package/lib/services/auth.js +484 -484
- package/lib/services/s3.js +71 -71
- package/lib/services/ses.js +97 -97
- package/lib/services/sns.js +21 -21
- package/lib/services/user.js +98 -98
- package/lib/swagger.yaml +1176 -1108
- package/package.json +38 -38
package/lib/swagger.yaml
CHANGED
|
@@ -1,1109 +1,1177 @@
|
|
|
1
|
-
openapi: 3.0.0
|
|
2
|
-
info:
|
|
3
|
-
title: aloux-sdk
|
|
4
|
-
description: APIs para Aloux SDK
|
|
5
|
-
version: 1.0.0
|
|
6
|
-
contact:
|
|
7
|
-
name: API Aloux
|
|
8
|
-
url: https://aloux.mx
|
|
9
|
-
email: developer@aloux.mx
|
|
10
|
-
components:
|
|
11
|
-
securitySchemes:
|
|
12
|
-
bearerAuth: # arbitrary name for the security scheme
|
|
13
|
-
type: http
|
|
14
|
-
scheme: bearer
|
|
15
|
-
bearerFormat: JWT
|
|
16
|
-
paths:
|
|
17
|
-
/iam/auth/email:
|
|
18
|
-
post:
|
|
19
|
-
summary: Validar que el correo exista
|
|
20
|
-
tags:
|
|
21
|
-
- users - self
|
|
22
|
-
description: Validar que el correo exista
|
|
23
|
-
requestBody:
|
|
24
|
-
content:
|
|
25
|
-
'application/json':
|
|
26
|
-
schema:
|
|
27
|
-
properties:
|
|
28
|
-
email:
|
|
29
|
-
description: email
|
|
30
|
-
type: string
|
|
31
|
-
example: developer@aloux.mx
|
|
32
|
-
required:
|
|
33
|
-
- email
|
|
34
|
-
responses:
|
|
35
|
-
'200': # status code
|
|
36
|
-
description: Ok
|
|
37
|
-
content:
|
|
38
|
-
application/json:
|
|
39
|
-
schema:
|
|
40
|
-
type: object
|
|
41
|
-
items:
|
|
42
|
-
type: string
|
|
43
|
-
/iam/auth/login:
|
|
44
|
-
post:
|
|
45
|
-
summary: Iniciar sesión
|
|
46
|
-
tags:
|
|
47
|
-
- users - self
|
|
48
|
-
description: Iniciar sesión
|
|
49
|
-
requestBody:
|
|
50
|
-
content:
|
|
51
|
-
'application/json':
|
|
52
|
-
schema:
|
|
53
|
-
properties:
|
|
54
|
-
email:
|
|
55
|
-
description: email
|
|
56
|
-
type: string
|
|
57
|
-
example: developer@aloux.mx
|
|
58
|
-
pwd:
|
|
59
|
-
description: password
|
|
60
|
-
type: string
|
|
61
|
-
example: Cc123456
|
|
62
|
-
required:
|
|
63
|
-
- email
|
|
64
|
-
- pwd
|
|
65
|
-
responses:
|
|
66
|
-
'200': # status code
|
|
67
|
-
description: Return token
|
|
68
|
-
content:
|
|
69
|
-
application/json:
|
|
70
|
-
schema:
|
|
71
|
-
type: object
|
|
72
|
-
items:
|
|
73
|
-
type: string
|
|
74
|
-
/iam/
|
|
75
|
-
post:
|
|
76
|
-
tags:
|
|
77
|
-
- users - self
|
|
78
|
-
summary: Enviar correo para verificar correo de la cuenta
|
|
79
|
-
description: Enviar correo para verificar correo de la cuenta
|
|
80
|
-
requestBody:
|
|
81
|
-
content:
|
|
82
|
-
'application/json':
|
|
83
|
-
schema:
|
|
84
|
-
properties:
|
|
85
|
-
email:
|
|
86
|
-
description: email
|
|
87
|
-
type: string
|
|
88
|
-
example: developer@aloux.mx
|
|
89
|
-
required:
|
|
90
|
-
- email
|
|
91
|
-
responses:
|
|
92
|
-
'200':
|
|
93
|
-
description: ok
|
|
94
|
-
content:
|
|
95
|
-
application/json:
|
|
96
|
-
schema:
|
|
97
|
-
type: object
|
|
98
|
-
items:
|
|
99
|
-
type: string
|
|
100
|
-
/iam/auth/verify/mail/token/{token}:
|
|
101
|
-
get:
|
|
102
|
-
parameters:
|
|
103
|
-
- name: token
|
|
104
|
-
in: path
|
|
105
|
-
description: token de verificación de cuenta
|
|
106
|
-
required: true
|
|
107
|
-
schema:
|
|
108
|
-
type: string
|
|
109
|
-
summary: Valida correo de la cuenta (Manda coreo de bienvenida)
|
|
110
|
-
tags:
|
|
111
|
-
- users - self
|
|
112
|
-
description: Valida correo de la cuenta (Manda coreo de bienvenida)
|
|
113
|
-
responses:
|
|
114
|
-
'200': # status code
|
|
115
|
-
description: Return token
|
|
116
|
-
content:
|
|
117
|
-
application/json:
|
|
118
|
-
schema:
|
|
119
|
-
type: object
|
|
120
|
-
items:
|
|
121
|
-
type: string
|
|
122
|
-
/iam/auth/forgot/password:
|
|
123
|
-
post:
|
|
124
|
-
summary: Enviar código a correo
|
|
125
|
-
tags:
|
|
126
|
-
- users - self
|
|
127
|
-
description: Enviar código a correo
|
|
128
|
-
requestBody:
|
|
129
|
-
content:
|
|
130
|
-
'application/json':
|
|
131
|
-
schema:
|
|
132
|
-
properties:
|
|
133
|
-
email:
|
|
134
|
-
description: email
|
|
135
|
-
type: string
|
|
136
|
-
example: developer@aloux.mx
|
|
137
|
-
required:
|
|
138
|
-
- email
|
|
139
|
-
responses:
|
|
140
|
-
'200': # status code
|
|
141
|
-
description: Ok
|
|
142
|
-
content:
|
|
143
|
-
application/json:
|
|
144
|
-
schema:
|
|
145
|
-
type: object
|
|
146
|
-
items:
|
|
147
|
-
type: string
|
|
148
|
-
/iam/auth/
|
|
149
|
-
post:
|
|
150
|
-
summary:
|
|
151
|
-
tags:
|
|
152
|
-
- users - self
|
|
153
|
-
description:
|
|
154
|
-
requestBody:
|
|
155
|
-
content:
|
|
156
|
-
'application/json':
|
|
157
|
-
schema:
|
|
158
|
-
properties:
|
|
159
|
-
|
|
160
|
-
description:
|
|
161
|
-
type: string
|
|
162
|
-
example:
|
|
163
|
-
|
|
164
|
-
description:
|
|
165
|
-
type:
|
|
166
|
-
example:
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
-
|
|
203
|
-
-
|
|
204
|
-
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
responses:
|
|
639
|
-
'200': # status code
|
|
640
|
-
description: Retorna
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
example:
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
|
|
1
|
+
openapi: 3.0.0
|
|
2
|
+
info:
|
|
3
|
+
title: aloux-sdk
|
|
4
|
+
description: APIs para Aloux SDK
|
|
5
|
+
version: 1.0.0
|
|
6
|
+
contact:
|
|
7
|
+
name: API Aloux
|
|
8
|
+
url: https://aloux.mx
|
|
9
|
+
email: developer@aloux.mx
|
|
10
|
+
components:
|
|
11
|
+
securitySchemes:
|
|
12
|
+
bearerAuth: # arbitrary name for the security scheme
|
|
13
|
+
type: http
|
|
14
|
+
scheme: bearer
|
|
15
|
+
bearerFormat: JWT
|
|
16
|
+
paths:
|
|
17
|
+
/iam/auth/email:
|
|
18
|
+
post:
|
|
19
|
+
summary: Validar que el correo exista
|
|
20
|
+
tags:
|
|
21
|
+
- users - self
|
|
22
|
+
description: Validar que el correo exista
|
|
23
|
+
requestBody:
|
|
24
|
+
content:
|
|
25
|
+
'application/json':
|
|
26
|
+
schema:
|
|
27
|
+
properties:
|
|
28
|
+
email:
|
|
29
|
+
description: email
|
|
30
|
+
type: string
|
|
31
|
+
example: developer@aloux.mx
|
|
32
|
+
required:
|
|
33
|
+
- email
|
|
34
|
+
responses:
|
|
35
|
+
'200': # status code
|
|
36
|
+
description: Ok
|
|
37
|
+
content:
|
|
38
|
+
application/json:
|
|
39
|
+
schema:
|
|
40
|
+
type: object
|
|
41
|
+
items:
|
|
42
|
+
type: string
|
|
43
|
+
/iam/auth/login:
|
|
44
|
+
post:
|
|
45
|
+
summary: Iniciar sesión
|
|
46
|
+
tags:
|
|
47
|
+
- users - self
|
|
48
|
+
description: Iniciar sesión
|
|
49
|
+
requestBody:
|
|
50
|
+
content:
|
|
51
|
+
'application/json':
|
|
52
|
+
schema:
|
|
53
|
+
properties:
|
|
54
|
+
email:
|
|
55
|
+
description: email
|
|
56
|
+
type: string
|
|
57
|
+
example: developer@aloux.mx
|
|
58
|
+
pwd:
|
|
59
|
+
description: password
|
|
60
|
+
type: string
|
|
61
|
+
example: Cc123456
|
|
62
|
+
required:
|
|
63
|
+
- email
|
|
64
|
+
- pwd
|
|
65
|
+
responses:
|
|
66
|
+
'200': # status code
|
|
67
|
+
description: Return token
|
|
68
|
+
content:
|
|
69
|
+
application/json:
|
|
70
|
+
schema:
|
|
71
|
+
type: object
|
|
72
|
+
items:
|
|
73
|
+
type: string
|
|
74
|
+
/iam/auth/send/verify/mail:
|
|
75
|
+
post:
|
|
76
|
+
tags:
|
|
77
|
+
- users - self
|
|
78
|
+
summary: Enviar correo para verificar correo de la cuenta
|
|
79
|
+
description: Enviar correo para verificar correo de la cuenta
|
|
80
|
+
requestBody:
|
|
81
|
+
content:
|
|
82
|
+
'application/json':
|
|
83
|
+
schema:
|
|
84
|
+
properties:
|
|
85
|
+
email:
|
|
86
|
+
description: email
|
|
87
|
+
type: string
|
|
88
|
+
example: developer@aloux.mx
|
|
89
|
+
required:
|
|
90
|
+
- email
|
|
91
|
+
responses:
|
|
92
|
+
'200':
|
|
93
|
+
description: ok
|
|
94
|
+
content:
|
|
95
|
+
application/json:
|
|
96
|
+
schema:
|
|
97
|
+
type: object
|
|
98
|
+
items:
|
|
99
|
+
type: string
|
|
100
|
+
/iam/auth/verify/mail/token/{token}:
|
|
101
|
+
get:
|
|
102
|
+
parameters:
|
|
103
|
+
- name: token
|
|
104
|
+
in: path
|
|
105
|
+
description: token de verificación de cuenta
|
|
106
|
+
required: true
|
|
107
|
+
schema:
|
|
108
|
+
type: string
|
|
109
|
+
summary: Valida correo de la cuenta (Manda coreo de bienvenida)
|
|
110
|
+
tags:
|
|
111
|
+
- users - self
|
|
112
|
+
description: Valida correo de la cuenta (Manda coreo de bienvenida)
|
|
113
|
+
responses:
|
|
114
|
+
'200': # status code
|
|
115
|
+
description: Return token
|
|
116
|
+
content:
|
|
117
|
+
application/json:
|
|
118
|
+
schema:
|
|
119
|
+
type: object
|
|
120
|
+
items:
|
|
121
|
+
type: string
|
|
122
|
+
/iam/auth/forgot/password:
|
|
123
|
+
post:
|
|
124
|
+
summary: Enviar código a correo
|
|
125
|
+
tags:
|
|
126
|
+
- users - self
|
|
127
|
+
description: Enviar código a correo
|
|
128
|
+
requestBody:
|
|
129
|
+
content:
|
|
130
|
+
'application/json':
|
|
131
|
+
schema:
|
|
132
|
+
properties:
|
|
133
|
+
email:
|
|
134
|
+
description: email
|
|
135
|
+
type: string
|
|
136
|
+
example: developer@aloux.mx
|
|
137
|
+
required:
|
|
138
|
+
- email
|
|
139
|
+
responses:
|
|
140
|
+
'200': # status code
|
|
141
|
+
description: Ok
|
|
142
|
+
content:
|
|
143
|
+
application/json:
|
|
144
|
+
schema:
|
|
145
|
+
type: object
|
|
146
|
+
items:
|
|
147
|
+
type: string
|
|
148
|
+
/iam/auth/signup:
|
|
149
|
+
post:
|
|
150
|
+
summary: Registrarse
|
|
151
|
+
tags:
|
|
152
|
+
- users - self
|
|
153
|
+
description: Crea una cuenta
|
|
154
|
+
requestBody:
|
|
155
|
+
content:
|
|
156
|
+
'application/json':
|
|
157
|
+
schema:
|
|
158
|
+
properties:
|
|
159
|
+
name:
|
|
160
|
+
description: Name
|
|
161
|
+
type: string
|
|
162
|
+
example: Arturo
|
|
163
|
+
lastName:
|
|
164
|
+
description: Last name
|
|
165
|
+
type: string
|
|
166
|
+
example: Vázquez
|
|
167
|
+
phone:
|
|
168
|
+
description: Phone
|
|
169
|
+
type: string
|
|
170
|
+
example: 1234567891011
|
|
171
|
+
maxLength: 13
|
|
172
|
+
email:
|
|
173
|
+
description: email
|
|
174
|
+
type: string
|
|
175
|
+
example: developer@aloux.mx
|
|
176
|
+
pwd:
|
|
177
|
+
description: password
|
|
178
|
+
type: string
|
|
179
|
+
example: password
|
|
180
|
+
minLength: 8
|
|
181
|
+
data:
|
|
182
|
+
type: object
|
|
183
|
+
properties:
|
|
184
|
+
age:
|
|
185
|
+
description: Age
|
|
186
|
+
type: integer
|
|
187
|
+
example: 26
|
|
188
|
+
gender:
|
|
189
|
+
description: Gender
|
|
190
|
+
type: string
|
|
191
|
+
enum: ["male","female"]
|
|
192
|
+
scholarship:
|
|
193
|
+
description: Scholarship
|
|
194
|
+
type: string
|
|
195
|
+
example: university
|
|
196
|
+
Entity:
|
|
197
|
+
description: Entity
|
|
198
|
+
type: string
|
|
199
|
+
example: Puebla
|
|
200
|
+
required:
|
|
201
|
+
- name
|
|
202
|
+
- lastName
|
|
203
|
+
- phone
|
|
204
|
+
- email
|
|
205
|
+
- pwd
|
|
206
|
+
- data
|
|
207
|
+
responses:
|
|
208
|
+
'200': # status code
|
|
209
|
+
description: Ok
|
|
210
|
+
content:
|
|
211
|
+
application/json:
|
|
212
|
+
schema:
|
|
213
|
+
type: object
|
|
214
|
+
items:
|
|
215
|
+
type: string
|
|
216
|
+
/iam/auth/validate/code:
|
|
217
|
+
post:
|
|
218
|
+
summary: Verificar código
|
|
219
|
+
tags:
|
|
220
|
+
- users - self
|
|
221
|
+
description: Verificar código
|
|
222
|
+
requestBody:
|
|
223
|
+
content:
|
|
224
|
+
'application/json':
|
|
225
|
+
schema:
|
|
226
|
+
properties:
|
|
227
|
+
email:
|
|
228
|
+
description: email
|
|
229
|
+
type: string
|
|
230
|
+
example: developer@aloux.mx
|
|
231
|
+
resetCode:
|
|
232
|
+
description: código de verificación
|
|
233
|
+
type: number
|
|
234
|
+
example: 2137
|
|
235
|
+
required:
|
|
236
|
+
- email
|
|
237
|
+
responses:
|
|
238
|
+
'200': # status code
|
|
239
|
+
description: ok
|
|
240
|
+
content:
|
|
241
|
+
application/json:
|
|
242
|
+
schema:
|
|
243
|
+
type: object
|
|
244
|
+
items:
|
|
245
|
+
type: string
|
|
246
|
+
/iam/auth/reset/password:
|
|
247
|
+
post:
|
|
248
|
+
summary: Reestablecer contraseña
|
|
249
|
+
tags:
|
|
250
|
+
- users - self
|
|
251
|
+
description: Reestablecer contraseña
|
|
252
|
+
requestBody:
|
|
253
|
+
content:
|
|
254
|
+
'application/json':
|
|
255
|
+
schema:
|
|
256
|
+
properties:
|
|
257
|
+
email:
|
|
258
|
+
description: email
|
|
259
|
+
type: string
|
|
260
|
+
example: developer@aloux.mx
|
|
261
|
+
pwd:
|
|
262
|
+
description: contraseña nueva
|
|
263
|
+
type: string
|
|
264
|
+
example: "Cc123456"
|
|
265
|
+
resetCode:
|
|
266
|
+
description: código de verificación
|
|
267
|
+
type: string
|
|
268
|
+
example: 2137
|
|
269
|
+
required:
|
|
270
|
+
- email
|
|
271
|
+
- pwd
|
|
272
|
+
- resetCode
|
|
273
|
+
responses:
|
|
274
|
+
'200': # status code
|
|
275
|
+
description: Return token
|
|
276
|
+
content:
|
|
277
|
+
application/json:
|
|
278
|
+
schema:
|
|
279
|
+
type: object
|
|
280
|
+
items:
|
|
281
|
+
type: string
|
|
282
|
+
/iam/auth/me:
|
|
283
|
+
get:
|
|
284
|
+
summary: Obtener información de usuario autenticado
|
|
285
|
+
tags:
|
|
286
|
+
- users - self
|
|
287
|
+
description: Obtener información de usuario autenticado
|
|
288
|
+
security:
|
|
289
|
+
- bearerAuth: []
|
|
290
|
+
responses:
|
|
291
|
+
'200': # status code
|
|
292
|
+
description: A JSON object of a client
|
|
293
|
+
content:
|
|
294
|
+
application/json:
|
|
295
|
+
schema:
|
|
296
|
+
type: object
|
|
297
|
+
items:
|
|
298
|
+
type: string
|
|
299
|
+
/iam/auth/profile:
|
|
300
|
+
put:
|
|
301
|
+
summary: Actualizar perfil
|
|
302
|
+
tags:
|
|
303
|
+
- users - self
|
|
304
|
+
description: Actualizar perfil
|
|
305
|
+
security:
|
|
306
|
+
- bearerAuth: []
|
|
307
|
+
requestBody:
|
|
308
|
+
content:
|
|
309
|
+
application/json:
|
|
310
|
+
schema:
|
|
311
|
+
properties:
|
|
312
|
+
name:
|
|
313
|
+
type: string
|
|
314
|
+
example: Martín
|
|
315
|
+
lastName:
|
|
316
|
+
type: string
|
|
317
|
+
example: Martínez
|
|
318
|
+
email:
|
|
319
|
+
description: email
|
|
320
|
+
type: string
|
|
321
|
+
example: developer@aloux.mx
|
|
322
|
+
pwd:
|
|
323
|
+
description: password
|
|
324
|
+
type: string
|
|
325
|
+
example: Cc12345
|
|
326
|
+
phone:
|
|
327
|
+
type: string
|
|
328
|
+
example: +525567087001
|
|
329
|
+
_functions:
|
|
330
|
+
type: array
|
|
331
|
+
items:
|
|
332
|
+
type: string
|
|
333
|
+
format: ObjectId
|
|
334
|
+
example: "61b06de713a90b4d6dce7224"
|
|
335
|
+
_client:
|
|
336
|
+
type: array
|
|
337
|
+
items:
|
|
338
|
+
type: string
|
|
339
|
+
format: ObjectId
|
|
340
|
+
example: "64371ab1b6dc1417c9c0b812"
|
|
341
|
+
required:
|
|
342
|
+
- email
|
|
343
|
+
- pwd
|
|
344
|
+
responses:
|
|
345
|
+
'202': # status code
|
|
346
|
+
description: A JSON object of a client
|
|
347
|
+
content:
|
|
348
|
+
application/json:
|
|
349
|
+
schema:
|
|
350
|
+
type: object
|
|
351
|
+
items:
|
|
352
|
+
type: string
|
|
353
|
+
/iam/auth/profile/pictura:
|
|
354
|
+
put:
|
|
355
|
+
summary: Actualizar solo la foto de perfil
|
|
356
|
+
tags:
|
|
357
|
+
- users - self
|
|
358
|
+
description: Actualizar solo la foto de perfil
|
|
359
|
+
security:
|
|
360
|
+
- bearerAuth: []
|
|
361
|
+
requestBody:
|
|
362
|
+
content:
|
|
363
|
+
multipart/form-data:
|
|
364
|
+
schema:
|
|
365
|
+
type: object
|
|
366
|
+
properties:
|
|
367
|
+
urlImg:
|
|
368
|
+
description: Variable en donde se carga la imagen seleccionada del usuario
|
|
369
|
+
type: string
|
|
370
|
+
format: binary
|
|
371
|
+
responses:
|
|
372
|
+
'202': # status code
|
|
373
|
+
description: Retorna el estado de actualización de la imagen de perfil del usuario
|
|
374
|
+
content:
|
|
375
|
+
application/json:
|
|
376
|
+
schema:
|
|
377
|
+
type: object
|
|
378
|
+
items:
|
|
379
|
+
type: string
|
|
380
|
+
/iam/auth/send/verify/phone:
|
|
381
|
+
post:
|
|
382
|
+
summary: Enviar código al teléfono de la cuenta para verificarla
|
|
383
|
+
tags:
|
|
384
|
+
- users - self
|
|
385
|
+
description: Enviar código al teléfono de la cuenta para verificarla
|
|
386
|
+
security:
|
|
387
|
+
- bearerAuth: []
|
|
388
|
+
requestBody:
|
|
389
|
+
content:
|
|
390
|
+
application/json:
|
|
391
|
+
schema:
|
|
392
|
+
properties:
|
|
393
|
+
phone:
|
|
394
|
+
description: Teléfono de la cuenta del usuario
|
|
395
|
+
type: string
|
|
396
|
+
example: "+522491609423"
|
|
397
|
+
responses:
|
|
398
|
+
'200': # status code
|
|
399
|
+
description: ok
|
|
400
|
+
content:
|
|
401
|
+
application/json:
|
|
402
|
+
schema:
|
|
403
|
+
type: object
|
|
404
|
+
items:
|
|
405
|
+
type: string
|
|
406
|
+
/iam/auth/verify/phone:
|
|
407
|
+
post:
|
|
408
|
+
summary: Valida teléfono del usuario de la cuenta
|
|
409
|
+
tags:
|
|
410
|
+
- users - self
|
|
411
|
+
description: Valida teléfono del usuario de la cuenta
|
|
412
|
+
security:
|
|
413
|
+
- bearerAuth: []
|
|
414
|
+
requestBody:
|
|
415
|
+
content:
|
|
416
|
+
application/json:
|
|
417
|
+
schema:
|
|
418
|
+
properties:
|
|
419
|
+
codeVerifyPhone:
|
|
420
|
+
description: Código de verificación
|
|
421
|
+
type: number
|
|
422
|
+
example: 2137
|
|
423
|
+
responses:
|
|
424
|
+
'200': # status code
|
|
425
|
+
description: ok
|
|
426
|
+
content:
|
|
427
|
+
application/json:
|
|
428
|
+
schema:
|
|
429
|
+
type: object
|
|
430
|
+
items:
|
|
431
|
+
type: string
|
|
432
|
+
/iam/auth/logout:
|
|
433
|
+
post:
|
|
434
|
+
summary: Cerrar sesión
|
|
435
|
+
tags:
|
|
436
|
+
- users - self
|
|
437
|
+
description: Cierra la sesión de mi usuario
|
|
438
|
+
security:
|
|
439
|
+
- bearerAuth: []
|
|
440
|
+
responses:
|
|
441
|
+
'200': # status code
|
|
442
|
+
description: Ok
|
|
443
|
+
content:
|
|
444
|
+
application/json:
|
|
445
|
+
schema:
|
|
446
|
+
type: object
|
|
447
|
+
items:
|
|
448
|
+
type: string
|
|
449
|
+
/iam/user:
|
|
450
|
+
post:
|
|
451
|
+
summary: Crear un usuario
|
|
452
|
+
tags:
|
|
453
|
+
- users
|
|
454
|
+
description: Crea un nuevo usuario
|
|
455
|
+
security:
|
|
456
|
+
- bearerAuth: []
|
|
457
|
+
requestBody:
|
|
458
|
+
content:
|
|
459
|
+
application/json:
|
|
460
|
+
schema:
|
|
461
|
+
properties:
|
|
462
|
+
name:
|
|
463
|
+
type: string
|
|
464
|
+
example: Martín
|
|
465
|
+
lastName:
|
|
466
|
+
type: string
|
|
467
|
+
example: Martínez
|
|
468
|
+
email:
|
|
469
|
+
description: email
|
|
470
|
+
type: string
|
|
471
|
+
example: developer@aloux.mx
|
|
472
|
+
pwd:
|
|
473
|
+
description: password
|
|
474
|
+
type: string
|
|
475
|
+
example: Cc12345
|
|
476
|
+
phone:
|
|
477
|
+
type: string
|
|
478
|
+
example: +525567087001
|
|
479
|
+
_functions:
|
|
480
|
+
type: array
|
|
481
|
+
items:
|
|
482
|
+
type: string
|
|
483
|
+
format: ObjectId
|
|
484
|
+
example: "61b06de713a90b4d6dce7224"
|
|
485
|
+
_client:
|
|
486
|
+
type: array
|
|
487
|
+
items:
|
|
488
|
+
type: string
|
|
489
|
+
format: ObjectId
|
|
490
|
+
example: "64371ab1b6dc1417c9c0b812"
|
|
491
|
+
required:
|
|
492
|
+
- email
|
|
493
|
+
- pwd
|
|
494
|
+
responses:
|
|
495
|
+
'200': # status code
|
|
496
|
+
description: Ok
|
|
497
|
+
get:
|
|
498
|
+
summary: Obtener todos los usuario
|
|
499
|
+
tags:
|
|
500
|
+
- users
|
|
501
|
+
description: Obtener todos los usuario
|
|
502
|
+
security:
|
|
503
|
+
- bearerAuth: []
|
|
504
|
+
responses:
|
|
505
|
+
'200': # status code
|
|
506
|
+
description: Retorna una lista de objetos de los usuarios registrados
|
|
507
|
+
/iam/user/{USER_ID}:
|
|
508
|
+
get:
|
|
509
|
+
parameters:
|
|
510
|
+
- name: USER_ID
|
|
511
|
+
in: path
|
|
512
|
+
description: Obtener detalle de usuario
|
|
513
|
+
required: true
|
|
514
|
+
schema:
|
|
515
|
+
type: string
|
|
516
|
+
format: ObjectId
|
|
517
|
+
summary: Obtener detalle de usuario
|
|
518
|
+
tags:
|
|
519
|
+
- users
|
|
520
|
+
description: Obtener detalle de usuario
|
|
521
|
+
security:
|
|
522
|
+
- bearerAuth: []
|
|
523
|
+
responses:
|
|
524
|
+
'200': # status code
|
|
525
|
+
description: Retorna un objeto JSON de un usuario
|
|
526
|
+
patch:
|
|
527
|
+
parameters:
|
|
528
|
+
- name: USER_ID
|
|
529
|
+
in: path
|
|
530
|
+
description: ID de un usuario que este registrado
|
|
531
|
+
required: true
|
|
532
|
+
schema:
|
|
533
|
+
type: string
|
|
534
|
+
format: ObjectId
|
|
535
|
+
summary: Actualizar usuario
|
|
536
|
+
tags:
|
|
537
|
+
- users
|
|
538
|
+
description: Actualizar usuario
|
|
539
|
+
security:
|
|
540
|
+
- bearerAuth: []
|
|
541
|
+
requestBody:
|
|
542
|
+
content:
|
|
543
|
+
'application/json':
|
|
544
|
+
schema:
|
|
545
|
+
properties:
|
|
546
|
+
name:
|
|
547
|
+
type: string
|
|
548
|
+
example: Martín
|
|
549
|
+
lastName:
|
|
550
|
+
type: string
|
|
551
|
+
example: Martínez
|
|
552
|
+
phone:
|
|
553
|
+
type: string
|
|
554
|
+
example: +525567087001
|
|
555
|
+
email:
|
|
556
|
+
description: email
|
|
557
|
+
type: string
|
|
558
|
+
example: developer@aloux.mx
|
|
559
|
+
pwd:
|
|
560
|
+
description: password
|
|
561
|
+
type: string
|
|
562
|
+
example: Cc12345
|
|
563
|
+
required:
|
|
564
|
+
- email
|
|
565
|
+
- pwd
|
|
566
|
+
responses:
|
|
567
|
+
'200': # status code
|
|
568
|
+
description: Retorna un objeto JSON de un usuario
|
|
569
|
+
delete:
|
|
570
|
+
parameters:
|
|
571
|
+
- name: USER_ID
|
|
572
|
+
in: path
|
|
573
|
+
description: ID de un usuario que este registrado
|
|
574
|
+
required: true
|
|
575
|
+
schema:
|
|
576
|
+
type: string
|
|
577
|
+
format: ObjectId
|
|
578
|
+
summary: Eliminar usuario
|
|
579
|
+
tags:
|
|
580
|
+
- users
|
|
581
|
+
description: Eliminar usuario
|
|
582
|
+
security:
|
|
583
|
+
- bearerAuth: []
|
|
584
|
+
responses:
|
|
585
|
+
'200': # status code
|
|
586
|
+
description: Ok
|
|
587
|
+
/iam/user/{USER_ID}/status:
|
|
588
|
+
put:
|
|
589
|
+
parameters:
|
|
590
|
+
- name: USER_ID
|
|
591
|
+
in: path
|
|
592
|
+
description: ID de un usuario que este registrado
|
|
593
|
+
required: true
|
|
594
|
+
schema:
|
|
595
|
+
type: string
|
|
596
|
+
format: ObjectId
|
|
597
|
+
summary: Activar o desactivar usuario
|
|
598
|
+
tags:
|
|
599
|
+
- users
|
|
600
|
+
description: Activar o desactivar usuario
|
|
601
|
+
security:
|
|
602
|
+
- bearerAuth: []
|
|
603
|
+
requestBody:
|
|
604
|
+
content:
|
|
605
|
+
'application/json':
|
|
606
|
+
schema:
|
|
607
|
+
properties:
|
|
608
|
+
status:
|
|
609
|
+
type: string
|
|
610
|
+
example: Activo
|
|
611
|
+
responses:
|
|
612
|
+
'200': # status code
|
|
613
|
+
description: Retorna result from response
|
|
614
|
+
/iam/user/password/{USER_ID}:
|
|
615
|
+
put:
|
|
616
|
+
parameters:
|
|
617
|
+
- name: USER_ID
|
|
618
|
+
in: path
|
|
619
|
+
description: ID de un usuario que este registrado
|
|
620
|
+
required: true
|
|
621
|
+
schema:
|
|
622
|
+
type: string
|
|
623
|
+
format: ObjectId
|
|
624
|
+
summary: Actualizar la constraseña de un usuario
|
|
625
|
+
tags:
|
|
626
|
+
- users
|
|
627
|
+
description: Actualizar la constraseña de un usuario
|
|
628
|
+
security:
|
|
629
|
+
- bearerAuth: []
|
|
630
|
+
requestBody:
|
|
631
|
+
content:
|
|
632
|
+
'application/json':
|
|
633
|
+
schema:
|
|
634
|
+
properties:
|
|
635
|
+
pwd:
|
|
636
|
+
type: string
|
|
637
|
+
example: Cc12345
|
|
638
|
+
responses:
|
|
639
|
+
'200': # status code
|
|
640
|
+
description: Retorna result from response
|
|
641
|
+
/iam/user/count/all:
|
|
642
|
+
get:
|
|
643
|
+
summary: Obtiene el número de usuarios
|
|
644
|
+
tags:
|
|
645
|
+
- users
|
|
646
|
+
description: Obtiene el número de usuarios
|
|
647
|
+
security:
|
|
648
|
+
- bearerAuth: []
|
|
649
|
+
responses:
|
|
650
|
+
'200': # status code
|
|
651
|
+
description: Retorna el resultado de la respuesta
|
|
652
|
+
/iam/functions:
|
|
653
|
+
post:
|
|
654
|
+
summary: Crea una función
|
|
655
|
+
tags:
|
|
656
|
+
- functions
|
|
657
|
+
description: Crea una función
|
|
658
|
+
security:
|
|
659
|
+
- bearerAuth: []
|
|
660
|
+
requestBody:
|
|
661
|
+
content:
|
|
662
|
+
'application/json':
|
|
663
|
+
schema:
|
|
664
|
+
properties:
|
|
665
|
+
name:
|
|
666
|
+
type: string
|
|
667
|
+
example: Propietario
|
|
668
|
+
description:
|
|
669
|
+
type: string
|
|
670
|
+
example: Acceso a todas las funcionalidades de la plataforma
|
|
671
|
+
_permissions:
|
|
672
|
+
type: string
|
|
673
|
+
format: ObjectId
|
|
674
|
+
example: "61b06de713a90b4d6dce5141"
|
|
675
|
+
required:
|
|
676
|
+
- name
|
|
677
|
+
responses:
|
|
678
|
+
'201': # status code
|
|
679
|
+
description: ok
|
|
680
|
+
get:
|
|
681
|
+
summary: Obtener todas las funciones
|
|
682
|
+
tags:
|
|
683
|
+
- functions
|
|
684
|
+
description: Obtener todas las funciones
|
|
685
|
+
security:
|
|
686
|
+
- bearerAuth: []
|
|
687
|
+
responses:
|
|
688
|
+
'200': # status code
|
|
689
|
+
description: Retorna el resultado de la respuesta
|
|
690
|
+
/iam/functions/{FUNCTION_ID}:
|
|
691
|
+
get:
|
|
692
|
+
parameters:
|
|
693
|
+
- name: FUNCTION_ID
|
|
694
|
+
in: path
|
|
695
|
+
description: ID de un funcion que este registrada
|
|
696
|
+
required: true
|
|
697
|
+
schema:
|
|
698
|
+
type: string
|
|
699
|
+
format: ObjectId
|
|
700
|
+
summary: Obtener detalle de la función
|
|
701
|
+
tags:
|
|
702
|
+
- functions
|
|
703
|
+
description: Obtener detalle de la función
|
|
704
|
+
security:
|
|
705
|
+
- bearerAuth: []
|
|
706
|
+
responses:
|
|
707
|
+
'200': # status code
|
|
708
|
+
description: Retorna el resultado de la respuesta
|
|
709
|
+
patch:
|
|
710
|
+
parameters:
|
|
711
|
+
- name: FUNCTION_ID
|
|
712
|
+
in: path
|
|
713
|
+
description: ID de una función que este registrada
|
|
714
|
+
required: true
|
|
715
|
+
schema:
|
|
716
|
+
type: string
|
|
717
|
+
format: ObjectId
|
|
718
|
+
summary: Actualizar función
|
|
719
|
+
tags:
|
|
720
|
+
- functions
|
|
721
|
+
description: Actualizar función
|
|
722
|
+
security:
|
|
723
|
+
- bearerAuth: []
|
|
724
|
+
requestBody:
|
|
725
|
+
content:
|
|
726
|
+
'application/json':
|
|
727
|
+
schema:
|
|
728
|
+
properties:
|
|
729
|
+
name:
|
|
730
|
+
type: string
|
|
731
|
+
example: Propietario
|
|
732
|
+
description:
|
|
733
|
+
type: string
|
|
734
|
+
example: Acceso a todas las funcionalidades de la plataforma
|
|
735
|
+
_permissions:
|
|
736
|
+
type: string
|
|
737
|
+
format: ObjectId
|
|
738
|
+
example: "61b06de713a90b4d6dce5141"
|
|
739
|
+
required:
|
|
740
|
+
- name
|
|
741
|
+
responses:
|
|
742
|
+
'200': # status code
|
|
743
|
+
description: Retorna un objeto JSON de una función
|
|
744
|
+
delete:
|
|
745
|
+
parameters:
|
|
746
|
+
- name: FUNCTION_ID
|
|
747
|
+
in: path
|
|
748
|
+
description: ID de una función que este registrado
|
|
749
|
+
required: true
|
|
750
|
+
schema:
|
|
751
|
+
type: string
|
|
752
|
+
format: ObjectId
|
|
753
|
+
summary: Eliminar función
|
|
754
|
+
tags:
|
|
755
|
+
- functions
|
|
756
|
+
description: Eliminar función
|
|
757
|
+
security:
|
|
758
|
+
- bearerAuth: []
|
|
759
|
+
responses:
|
|
760
|
+
'200': # status code
|
|
761
|
+
description: Ok
|
|
762
|
+
/iam/functions/{FUNCTION_ID}/status:
|
|
763
|
+
put:
|
|
764
|
+
parameters:
|
|
765
|
+
- name: FUNCTION_ID
|
|
766
|
+
in: path
|
|
767
|
+
description: ID de una función que este registrada
|
|
768
|
+
required: true
|
|
769
|
+
schema:
|
|
770
|
+
type: string
|
|
771
|
+
format: ObjectId
|
|
772
|
+
summary: Activar o desactivar función
|
|
773
|
+
tags:
|
|
774
|
+
- functions
|
|
775
|
+
description: Activar o desactivar función
|
|
776
|
+
security:
|
|
777
|
+
- bearerAuth: []
|
|
778
|
+
requestBody:
|
|
779
|
+
content:
|
|
780
|
+
'application/json':
|
|
781
|
+
schema:
|
|
782
|
+
properties:
|
|
783
|
+
status:
|
|
784
|
+
type: string
|
|
785
|
+
example: Activo
|
|
786
|
+
responses:
|
|
787
|
+
'200': # status code
|
|
788
|
+
description: Retorna el resultado de la respuesta
|
|
789
|
+
/iam/functions/count/all:
|
|
790
|
+
get:
|
|
791
|
+
summary: Obtiene el número de funciones
|
|
792
|
+
tags:
|
|
793
|
+
- functions
|
|
794
|
+
description: Obtiene el número de funciones
|
|
795
|
+
security:
|
|
796
|
+
- bearerAuth: []
|
|
797
|
+
responses:
|
|
798
|
+
'200': # status code
|
|
799
|
+
description: Retorna el resultado de la respuesta
|
|
800
|
+
/iam/permission:
|
|
801
|
+
post:
|
|
802
|
+
summary: Crea un permiso
|
|
803
|
+
tags:
|
|
804
|
+
- permissions
|
|
805
|
+
description: Crea un permiso
|
|
806
|
+
security:
|
|
807
|
+
- bearerAuth: []
|
|
808
|
+
requestBody:
|
|
809
|
+
content:
|
|
810
|
+
'application/json':
|
|
811
|
+
schema:
|
|
812
|
+
properties:
|
|
813
|
+
description:
|
|
814
|
+
description: Describe la funcionalidad del permiso
|
|
815
|
+
type: string
|
|
816
|
+
method:
|
|
817
|
+
description: Tipo de HTTP REQUEST del permiso
|
|
818
|
+
type: string
|
|
819
|
+
example: GET
|
|
820
|
+
api:
|
|
821
|
+
description: ruta que accede a la función que utilice el permiso
|
|
822
|
+
type: string
|
|
823
|
+
example: "api.create"
|
|
824
|
+
endpoint:
|
|
825
|
+
description: path del permiso
|
|
826
|
+
type: string
|
|
827
|
+
example: "/api/permissions"
|
|
828
|
+
auth:
|
|
829
|
+
description: Identifica si para acceder al permiso necesita un token o es público
|
|
830
|
+
type: number
|
|
831
|
+
example: 1
|
|
832
|
+
_menu:
|
|
833
|
+
description: hace referencia a si el permiso pertenece a un menú en especifíco
|
|
834
|
+
type: string
|
|
835
|
+
format: ObjectId
|
|
836
|
+
example: "61b06de713a90b4d6dce7171"
|
|
837
|
+
required:
|
|
838
|
+
- description
|
|
839
|
+
- method
|
|
840
|
+
- api
|
|
841
|
+
- endpoint
|
|
842
|
+
- _menu
|
|
843
|
+
responses:
|
|
844
|
+
'201': # status code
|
|
845
|
+
description: retorna el resultado de la respuesta
|
|
846
|
+
get:
|
|
847
|
+
summary: Obtener todos los permisos
|
|
848
|
+
tags:
|
|
849
|
+
- permissions
|
|
850
|
+
description: Obtener todos los permisos
|
|
851
|
+
security:
|
|
852
|
+
- bearerAuth: []
|
|
853
|
+
responses:
|
|
854
|
+
'200': # status code
|
|
855
|
+
description: Retorna una lista de objetos JSON
|
|
856
|
+
/iam/permission/{PERMISSION_ID}:
|
|
857
|
+
get:
|
|
858
|
+
parameters:
|
|
859
|
+
- name: PERMISSION_ID
|
|
860
|
+
in: path
|
|
861
|
+
description: ID de un permiso que este registrado
|
|
862
|
+
required: true
|
|
863
|
+
schema:
|
|
864
|
+
type: string
|
|
865
|
+
format: ObjectId
|
|
866
|
+
summary: Obtener detalle del permiso
|
|
867
|
+
tags:
|
|
868
|
+
- permissions
|
|
869
|
+
description: Obtener detalle del permiso
|
|
870
|
+
security:
|
|
871
|
+
- bearerAuth: []
|
|
872
|
+
responses:
|
|
873
|
+
'200': # status code
|
|
874
|
+
description: Retorna un objeto JSON
|
|
875
|
+
patch:
|
|
876
|
+
parameters:
|
|
877
|
+
- name: PERMISSION_ID
|
|
878
|
+
in: path
|
|
879
|
+
description: ID de un permiso que este registrado
|
|
880
|
+
required: true
|
|
881
|
+
schema:
|
|
882
|
+
type: string
|
|
883
|
+
format: ObjectId
|
|
884
|
+
summary: Actualizar permiso
|
|
885
|
+
tags:
|
|
886
|
+
- permissions
|
|
887
|
+
description: Actualizar permiso
|
|
888
|
+
security:
|
|
889
|
+
- bearerAuth: []
|
|
890
|
+
requestBody:
|
|
891
|
+
content:
|
|
892
|
+
'application/json':
|
|
893
|
+
schema:
|
|
894
|
+
properties:
|
|
895
|
+
description:
|
|
896
|
+
description: Describe la funcionalidad del permiso
|
|
897
|
+
type: string
|
|
898
|
+
method:
|
|
899
|
+
description: Tipo de HTTP REQUEST del permiso
|
|
900
|
+
type: string
|
|
901
|
+
example: GET
|
|
902
|
+
api:
|
|
903
|
+
description: ruta que accede a la función que utilice el permiso
|
|
904
|
+
type: string
|
|
905
|
+
example: "api.create"
|
|
906
|
+
endpoint:
|
|
907
|
+
description: path del permiso
|
|
908
|
+
type: string
|
|
909
|
+
example: "/api/permissions"
|
|
910
|
+
auth:
|
|
911
|
+
description: Identifica si para acceder al permiso necesita un token o es público
|
|
912
|
+
type: number
|
|
913
|
+
example: 1
|
|
914
|
+
_menu:
|
|
915
|
+
description: hace referencia a si el permiso pertenece a un menú en especifíco
|
|
916
|
+
type: string
|
|
917
|
+
format: ObjectId
|
|
918
|
+
example: "61b06de713a90b4d6dce7171"
|
|
919
|
+
responses:
|
|
920
|
+
'200': # status code
|
|
921
|
+
description: Retorna un objeto JSON de un permiso
|
|
922
|
+
delete:
|
|
923
|
+
parameters:
|
|
924
|
+
- name: PERMISSION_ID
|
|
925
|
+
in: path
|
|
926
|
+
description: ID de un permiso que este registrado
|
|
927
|
+
required: true
|
|
928
|
+
schema:
|
|
929
|
+
type: string
|
|
930
|
+
format: ObjectId
|
|
931
|
+
summary: Eliminar permiso
|
|
932
|
+
tags:
|
|
933
|
+
- permissions
|
|
934
|
+
description: Eliminar permiso
|
|
935
|
+
security:
|
|
936
|
+
- bearerAuth: []
|
|
937
|
+
responses:
|
|
938
|
+
'200': # status code
|
|
939
|
+
description: Ok
|
|
940
|
+
/iam/permission/{PERMISSION_ID}/status:
|
|
941
|
+
put:
|
|
942
|
+
parameters:
|
|
943
|
+
- name: PERMISSION_ID
|
|
944
|
+
in: path
|
|
945
|
+
description: ID de un permiso que este registrado
|
|
946
|
+
required: true
|
|
947
|
+
schema:
|
|
948
|
+
type: string
|
|
949
|
+
format: ObjectId
|
|
950
|
+
summary: Activar o desactivar permiso
|
|
951
|
+
tags:
|
|
952
|
+
- permissions
|
|
953
|
+
description: Activar o desactivar permiso
|
|
954
|
+
security:
|
|
955
|
+
- bearerAuth: []
|
|
956
|
+
requestBody:
|
|
957
|
+
content:
|
|
958
|
+
'application/json':
|
|
959
|
+
schema:
|
|
960
|
+
properties:
|
|
961
|
+
status:
|
|
962
|
+
type: string
|
|
963
|
+
example: Activo
|
|
964
|
+
responses:
|
|
965
|
+
'200': # status code
|
|
966
|
+
description: Retorna el resultado de la respuesta
|
|
967
|
+
/iam/permission/count/all:
|
|
968
|
+
get:
|
|
969
|
+
summary: Obtiene el número de permisos
|
|
970
|
+
tags:
|
|
971
|
+
- permissions
|
|
972
|
+
description: Obtiene el número de permisos
|
|
973
|
+
security:
|
|
974
|
+
- bearerAuth: []
|
|
975
|
+
responses:
|
|
976
|
+
'200': # status code
|
|
977
|
+
description: Retorna el resultado de la respuesta
|
|
978
|
+
/iam/menu:
|
|
979
|
+
post:
|
|
980
|
+
summary: Crea un menú
|
|
981
|
+
tags:
|
|
982
|
+
- menús
|
|
983
|
+
description: Crea un menú
|
|
984
|
+
security:
|
|
985
|
+
- bearerAuth: []
|
|
986
|
+
requestBody:
|
|
987
|
+
content:
|
|
988
|
+
application/json:
|
|
989
|
+
schema:
|
|
990
|
+
properties:
|
|
991
|
+
label:
|
|
992
|
+
description: Nombre del Menú
|
|
993
|
+
type: string
|
|
994
|
+
example: "IAM"
|
|
995
|
+
path:
|
|
996
|
+
description: Ruta de acceso al menú
|
|
997
|
+
type: string
|
|
998
|
+
example: "/dashboard/iam"
|
|
999
|
+
icon:
|
|
1000
|
+
description: icono del menú
|
|
1001
|
+
type: string
|
|
1002
|
+
example: "mdi-shield-account"
|
|
1003
|
+
index:
|
|
1004
|
+
description: path del permiso
|
|
1005
|
+
type: number
|
|
1006
|
+
example: 1
|
|
1007
|
+
_menu:
|
|
1008
|
+
description: hace referencia a si el menú que se va a crear es un submenú de un menú ya registrado
|
|
1009
|
+
type: string
|
|
1010
|
+
format: ObjectId
|
|
1011
|
+
example: "61b06de713a90b4d6dce7171"
|
|
1012
|
+
required:
|
|
1013
|
+
- label
|
|
1014
|
+
- path
|
|
1015
|
+
- icon
|
|
1016
|
+
responses:
|
|
1017
|
+
'201': # status code
|
|
1018
|
+
description: retorna un objeto JSON
|
|
1019
|
+
get:
|
|
1020
|
+
summary: Obtiene todos los elementos de menú
|
|
1021
|
+
tags:
|
|
1022
|
+
- menús
|
|
1023
|
+
description: Obtiene todos los elementos de menú
|
|
1024
|
+
security:
|
|
1025
|
+
- bearerAuth: []
|
|
1026
|
+
responses:
|
|
1027
|
+
'200': # status code
|
|
1028
|
+
description: Retorna una lista de objetos JSON
|
|
1029
|
+
/iam/menu/{MENU_ID}:
|
|
1030
|
+
get:
|
|
1031
|
+
parameters:
|
|
1032
|
+
- name: MENU_ID
|
|
1033
|
+
in: path
|
|
1034
|
+
description: ID de un menú que este registrado
|
|
1035
|
+
required: true
|
|
1036
|
+
schema:
|
|
1037
|
+
type: string
|
|
1038
|
+
format: ObjectId
|
|
1039
|
+
summary: Obtiene el detalle de un elemento de menú
|
|
1040
|
+
tags:
|
|
1041
|
+
- menús
|
|
1042
|
+
description: Obtiene el detalle de un elemento de menú
|
|
1043
|
+
security:
|
|
1044
|
+
- bearerAuth: []
|
|
1045
|
+
responses:
|
|
1046
|
+
'200': # status code
|
|
1047
|
+
description: Retorna un objeto JSON
|
|
1048
|
+
patch:
|
|
1049
|
+
parameters:
|
|
1050
|
+
- name: MENU_ID
|
|
1051
|
+
in: path
|
|
1052
|
+
description: ID de un menú que este registrado
|
|
1053
|
+
required: true
|
|
1054
|
+
schema:
|
|
1055
|
+
type: string
|
|
1056
|
+
format: ObjectId
|
|
1057
|
+
summary: Actualiza un elemento de menú
|
|
1058
|
+
tags:
|
|
1059
|
+
- menús
|
|
1060
|
+
description: Actualiza un elemento de menú
|
|
1061
|
+
security:
|
|
1062
|
+
- bearerAuth: []
|
|
1063
|
+
requestBody:
|
|
1064
|
+
content:
|
|
1065
|
+
'application/json':
|
|
1066
|
+
schema:
|
|
1067
|
+
properties:
|
|
1068
|
+
label:
|
|
1069
|
+
description: Nombre del Menú
|
|
1070
|
+
type: string
|
|
1071
|
+
example: "IAM"
|
|
1072
|
+
path:
|
|
1073
|
+
description: Ruta de acceso al menú
|
|
1074
|
+
type: string
|
|
1075
|
+
example: "/dashboard/iam"
|
|
1076
|
+
icon:
|
|
1077
|
+
description: icono del menú
|
|
1078
|
+
type: string
|
|
1079
|
+
example: "mdi-shield-account"
|
|
1080
|
+
index:
|
|
1081
|
+
description: path del permiso
|
|
1082
|
+
type: number
|
|
1083
|
+
example: 1
|
|
1084
|
+
_menu:
|
|
1085
|
+
description: hace referencia a si el menú que se va a crear es un submenú de un menú ya registrado
|
|
1086
|
+
type: string
|
|
1087
|
+
format: ObjectId
|
|
1088
|
+
example: "61b06de713a90b4d6dce7171"
|
|
1089
|
+
required:
|
|
1090
|
+
- label
|
|
1091
|
+
- path
|
|
1092
|
+
- icon
|
|
1093
|
+
responses:
|
|
1094
|
+
'200': # status code
|
|
1095
|
+
description: Retorna un objeto JSON
|
|
1096
|
+
delete:
|
|
1097
|
+
parameters:
|
|
1098
|
+
- name: MENU_ID
|
|
1099
|
+
in: path
|
|
1100
|
+
description: ID de un menú que este registrado
|
|
1101
|
+
required: true
|
|
1102
|
+
schema:
|
|
1103
|
+
type: string
|
|
1104
|
+
format: ObjectId
|
|
1105
|
+
summary: Elimina un elemento de menú
|
|
1106
|
+
tags:
|
|
1107
|
+
- menús
|
|
1108
|
+
description: Elimina un elemento de menú
|
|
1109
|
+
security:
|
|
1110
|
+
- bearerAuth: []
|
|
1111
|
+
responses:
|
|
1112
|
+
'200': # status code
|
|
1113
|
+
description: Ok
|
|
1114
|
+
/iam/menu/{MENU_ID}/status:
|
|
1115
|
+
put:
|
|
1116
|
+
parameters:
|
|
1117
|
+
- name: MENU_ID
|
|
1118
|
+
in: path
|
|
1119
|
+
description: ID de un menú que este registrado
|
|
1120
|
+
required: true
|
|
1121
|
+
schema:
|
|
1122
|
+
type: string
|
|
1123
|
+
format: ObjectId
|
|
1124
|
+
summary: Activa o desactiva un menú
|
|
1125
|
+
tags:
|
|
1126
|
+
- menús
|
|
1127
|
+
description: Activa o desactiva un menú
|
|
1128
|
+
security:
|
|
1129
|
+
- bearerAuth: []
|
|
1130
|
+
requestBody:
|
|
1131
|
+
content:
|
|
1132
|
+
application/json:
|
|
1133
|
+
schema:
|
|
1134
|
+
properties:
|
|
1135
|
+
status:
|
|
1136
|
+
type: string
|
|
1137
|
+
example: Activo
|
|
1138
|
+
responses:
|
|
1139
|
+
'200': # status code
|
|
1140
|
+
description: Retorna el resultado de la respuesta
|
|
1141
|
+
/iam/menu/count/all:
|
|
1142
|
+
get:
|
|
1143
|
+
summary: Obtiene el número de menús
|
|
1144
|
+
tags:
|
|
1145
|
+
- menús
|
|
1146
|
+
description: Obtiene el número de menús
|
|
1147
|
+
security:
|
|
1148
|
+
- bearerAuth: []
|
|
1149
|
+
responses:
|
|
1150
|
+
'200': # status code
|
|
1151
|
+
description: Retorna el resultado de la respuesta
|
|
1152
|
+
/iam/menu/order:
|
|
1153
|
+
post:
|
|
1154
|
+
summary: Ordena los elementos de menú
|
|
1155
|
+
tags:
|
|
1156
|
+
- menús
|
|
1157
|
+
description: Ordena los elementos de menú
|
|
1158
|
+
security:
|
|
1159
|
+
- bearerAuth: []
|
|
1160
|
+
requestBody:
|
|
1161
|
+
content:
|
|
1162
|
+
'application/json':
|
|
1163
|
+
schema:
|
|
1164
|
+
properties:
|
|
1165
|
+
length:
|
|
1166
|
+
type: object
|
|
1167
|
+
properties:
|
|
1168
|
+
_id:
|
|
1169
|
+
type: string
|
|
1170
|
+
format: ObjectId
|
|
1171
|
+
example: 64bab1c64b2bce1394cc6491
|
|
1172
|
+
index:
|
|
1173
|
+
type: number
|
|
1174
|
+
example: 54
|
|
1175
|
+
responses:
|
|
1176
|
+
'200': # status code
|
|
1109
1177
|
description: Retorna el resultado de la respuesta
|