aloux-iam 0.0.2 → 0.0.4

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