-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopen-api.yml
More file actions
1099 lines (1037 loc) · 35.8 KB
/
Copy pathopen-api.yml
File metadata and controls
1099 lines (1037 loc) · 35.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Conductor API
description: |
A REST API with multi-tenant architecture and row-level security, supporting
isolated event workflows for multiple organizations. Implemented ticketing,
registration, ticket application workflow, enabling secure, scalable event hosting.
version: 1.0.0
contact:
name: Conductor API Support
email: support@conductor.com
license:
name: MIT
url: https://opensource.org/licenses/MIT
security:
- bearerAuth: []
paths:
/auth/login:
post:
summary: User login
description: Authenticates a user and returns a JWT access token.
tags:
- Authentication
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LoginRequest'
responses:
'200':
description: Successful login
content:
application/json:
schema:
type: object
properties:
access_token:
type: string
description: JWT token
token_type:
type: string
example: Bearer
expires_in:
type: string
example: "3600000"
'401':
description: Invalid username or password
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/auth/signup:
post:
summary: User signup
description: Registers a new user account.
tags:
- Authentication
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SignupRequest'
responses:
'201':
description: User created successfully
'409':
description: Username already taken
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/organizations/apply:
post:
summary: Submit organization application
description: |
Submit a new organization registration application. This endpoint creates
a new application and grants the submitting user permission to access it.
**Required Permissions:** Authenticated user (any role)
**Business Rules:**
- Organization name must be unique
- Email format must be valid
- All required fields must be provided
operationId: submitOrganizationApplication
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationApplicationRequest'
examples:
complete_application:
summary: Complete application example
value:
name: "TechCorp Solutions"
description: "Leading AI and cloud orchestration company"
email: "contact@techcorp.com"
tags: ["AI", "Orchestration", "Cloud"]
website_url: "https://www.techcorp.com"
locations: "San Francisco, CA"
minimal_application:
summary: Minimal required fields
value:
name: "StartupCo"
email: "hello@startupco.com"
locations: "New York, NY"
responses:
'200':
description: Application submitted successfully
content:
application/json:
schema:
type: object
properties:
application_id:
type: string
format: uuid
description: External ID of the created application
example: "123e4567-e89b-12d3-a456-426614174000"
required:
- application_id
examples:
success_response:
summary: Successful application submission
value:
application_id: "123e4567-e89b-12d3-a456-426614174000"
'400':
$ref: '#/components/responses/ValidationError'
'401':
$ref: '#/components/responses/Unauthorized'
'409':
$ref: '#/components/responses/OrganizationNameConflict'
'500':
$ref: '#/components/responses/InternalServerError'
tags:
- Organization Applications
/organizations/applications/{application-id}/approve:
put:
summary: Approve organization application
description: |
Approve a pending organization application and initiate the onboarding process.
This creates the organization, sets up permissions, and creates default operator credentials.
**Required Permissions:**
- Role: ADMIN
**Business Rules:**
- Application must be in PENDING status
- Only administrators can approve applications
- Approval triggers automatic onboarding process
operationId: approveOrganizationApplication
security:
- bearerAuth: []
parameters:
- name: application-id
in: path
required: true
description: External ID of the application to approve
schema:
type: string
minLength: 1
maxLength: 100
example: "123e4567-e89b-12d3-a456-426614174000"
responses:
'200':
description: Application approved successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: "Application approved successfully"
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/ApplicationNotFound'
'409':
$ref: '#/components/responses/ApplicationAlreadyProcessed'
'500':
$ref: '#/components/responses/InternalServerError'
tags:
- Organization Applications
/organizations/applications/{application-id}/reject:
put:
summary: Reject organization application
description: |
Reject a pending organization application with a specified reason.
The rejection reason is added as a comment to the application.
**Required Permissions:**
- Role: ADMIN
**Business Rules:**
- Application must be in PENDING status
- Rejection reason is required and must be provided
- Reason must not exceed 200 characters
operationId: rejectOrganizationApplication
security:
- bearerAuth: []
parameters:
- name: application-id
in: path
required: true
description: External ID of the application to reject
schema:
type: string
minLength: 36
maxLength: 36
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
example: "123e4567-e89b-12d3-a456-426614174000"
- name: reason
in: query
required: true
description: Reason for rejecting the application
schema:
type: string
minLength: 1
maxLength: 200
example: "Incomplete documentation provided"
responses:
'200':
description: Application rejected successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: "Application rejected successfully"
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/ApplicationNotFound'
'409':
$ref: '#/components/responses/ApplicationAlreadyProcessed'
'500':
$ref: '#/components/responses/InternalServerError'
tags:
- Organization Applications
/organizations/applications/{application-id}:
delete:
summary: Cancel organization application
description: |
Cancel a pending organization application. This sets the application
status to CANCELLED and can typically only be performed by the user
who submitted the application.
**Required Permissions:**
- Resource permission: ACCESS on the specific application
**Business Rules:**
- Application must be in PENDING status
- Only the submitter or users with application access can cancel
- Cancellation is permanent and cannot be undone
operationId: cancelOrganizationApplication
security:
- bearerAuth: []
parameters:
- name: application-id
in: path
required: true
description: External ID of the application to cancel
schema:
type: string
minLength: 36
maxLength: 36
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
example: "123e4567-e89b-12d3-a456-426614174000"
responses:
'200':
description: Application cancelled successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: "Application cancelled successfully"
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/ApplicationNotFound'
'409':
$ref: '#/components/responses/ApplicationAlreadyProcessed'
'500':
$ref: '#/components/responses/InternalServerError'
tags:
- Organization Applications
/organizations/applications/pending:
get:
summary: Get all pending organization applications
description: |
Retrieve all organization applications that are waiting for approval.
Returns applications with PENDING status.
**Required Permissions:**
- Role: ADMIN (or equivalent administrative role)
**Business Rules:**
- Only administrators can view all pending applications
- Returns applications in PENDING status only
- Includes application details and metadata
operationId: getAllPendingApplications
security:
- bearerAuth: []
responses:
'200':
description: List of pending applications retrieved successfully
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApplicationDTO'
examples:
pending_applications:
summary: List of pending applications
value:
- id: "123e4567-e89b-12d3-a456-426614174000"
submitted_at: "2024-01-15T10:30:00Z"
application_status: "pending"
application_form_response: "{\"name\":\"TechCorp\",\"email\":\"contact@techcorp.com\"}"
- id: "456e7890-e12b-34c5-d678-901234567890"
submitted_at: "2024-01-16T14:22:00Z"
application_status: "pending"
application_form_response: "{\"name\":\"StartupCo\",\"email\":\"hello@startupco.com\"}"
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'500':
$ref: '#/components/responses/InternalServerError'
tags:
- Organization Applications
/organizations/{organization-id}/modify:
post:
tags:
- Organization Management
summary: Modify organization details
description: |
Updates organization information including description, email, website URL, and tags.
Only non-null fields in the request will be updated.
operationId: modifyOrganization
parameters:
- name: organization-id
in: path
required: true
description: External ID of the organization to modify
schema:
type: string
maxLength: 100
minLength: 1
example: "org-12345"
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationModificationRequest'
examples:
update_all:
summary: Update all fields
value:
description: "Updated organization description"
email: "contact@example.com"
website-url: "https://www.example.com"
tags: ["technology", "startup", "ai"]
partial_update:
summary: Partial update
value:
description: "New description only"
responses:
'200':
description: Organization modified successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
'400':
description: Bad Request - Validation errors or constraint violations
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
validation_error:
summary: Validation failed
value:
error: "Bad Request"
success: false
message: "Validation failed"
timestamp: "2025-01-15T10:30:00Z"
details:
validation_errors:
organization-id: "Organization Id is required"
constraint_violation:
summary: Constraint violation
value:
error: "Bad Request"
success: false
message: "Constraint violation: Organization Id is required"
timestamp: "2025-01-15T10:30:00Z"
'401':
description: Unauthorized - Invalid or missing authentication token
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
token_invalid:
summary: Invalid token
value:
error: "401 UNAUTHORIZED"
success: false
message: "Token not valid: Token has expired"
timestamp: "2025-01-15T10:30:00Z"
unauthorized_access:
summary: Unauthorized access
value:
error: "401 UNAUTHORIZED"
success: false
message: "Access Denied"
timestamp: "2025-01-15T10:30:00Z"
'403':
description: Forbidden - Insufficient permissions
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: "Forbidden"
success: false
message: "Insufficient permissions to modify this organization"
timestamp: "2025-01-15T10:30:00Z"
'404':
description: Not Found - Organization not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: "404 NOT_FOUND"
success: false
message: "Organization not found"
timestamp: "2025-01-15T10:30:00Z"
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: "Internal Server Error"
success: false
message: "An unexpected error occurred. Please try again later."
timestamp: "2025-01-15T10:30:00Z"
security:
- BearerAuth: []
x-permissions:
description: "Required permissions to access this endpoint"
required_roles:
- "OPERATOR"
required_permissions:
- resource_type: "ORGANIZATION"
resource_id: "{organization-id}"
permission: "OWNER"
access_level: "WRITE"
/organizations/operators/register/events/manager:
put:
tags:
- Organization Operators
summary: Register an event manager
description: |
Registers a user as a manager for a specific event. The user will be granted
owner permissions for the event. If the user already has some permissions for
the event, they will be promoted to owner level.
operationId: registerEventManager
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterEventManagerRequest'
example:
event-id: "event-67890"
user-id: "user-12345"
responses:
'200':
description: Event manager registered successfully
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
'400':
description: Bad Request - Validation errors, malformed JSON, or invalid request data
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
validation_error:
summary: Validation failed
value:
error: "Bad Request"
success: false
message: "Validation failed"
timestamp: "2025-01-15T10:30:00Z"
details:
validation_errors:
event-id: "Event id is required"
user-id: "User id is required"
malformed_json:
summary: Malformed JSON
value:
error: "Bad Request"
success: false
message: "Malformed JSON request"
timestamp: "2025-01-15T10:30:00Z"
details:
cause: "Unexpected character at position 15"
invalid_data:
summary: Invalid request data
value:
error: "400 BAD_REQUEST"
success: false
message: "Invalid request data"
timestamp: "2025-01-15T10:30:00Z"
'401':
description: Unauthorized - Invalid or missing authentication token
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
token_invalid:
summary: Invalid token
value:
error: "401 UNAUTHORIZED"
success: false
message: "Token not valid: Token has expired"
timestamp: "2025-01-15T10:30:00Z"
access_denied:
summary: Access denied
value:
error: "401 UNAUTHORIZED"
success: false
message: "Access Denied"
timestamp: "2025-01-15T10:30:00Z"
'403':
description: Forbidden - Insufficient permissions
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: "Forbidden"
success: false
message: "Insufficient permissions to register event managers"
timestamp: "2025-01-15T10:30:00Z"
'404':
description: Not Found - Event or user not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
event_not_found:
summary: Event not found
value:
error: "Not Found"
success: false
message: "The requested event could not be found"
timestamp: "2025-01-15T10:30:00Z"
user_not_found:
summary: User not found
value:
error: "Not Found"
success: false
message: "The requested user could not be found"
timestamp: "2025-01-15T10:30:00Z"
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: "Internal Server Error"
success: false
message: "An unexpected error occurred. Please try again later."
timestamp: "2025-01-15T10:30:00Z"
security:
- BearerAuth: []
x-permissions:
description: "Required permissions to access this endpoint"
required_roles:
- "OPERATOR"
alternative_permissions:
- resource_type: "ORGANIZATION"
resource_id: "{organization-id-from-event}"
permission: "OPERATOR"
access_level: "WRITE"
components:
schemas:
LoginRequest:
type: object
required:
- username
- password
properties:
username:
type: string
maxLength: 50
description: Username of the user
password:
type: string
maxLength: 100
description: Password of the user
SignupRequest:
type: object
required:
- username
- password
- email
- first_name
- last_name
properties:
username:
type: string
maxLength: 50
password:
type: string
maxLength: 100
email:
type: string
format: email
maxLength: 100
first_name:
type: string
maxLength: 50
last_name:
type: string
maxLength: 50
OrganizationApplicationRequest:
type: object
required:
- name
- email
- locations
properties:
name:
type: string
minLength: 1
maxLength: 100
description: Name of the organization
example: "TechCorp Solutions"
description:
type: string
maxLength: 500
description: Brief description of the organization
example: "Leading AI and cloud orchestration company providing innovative solutions"
email:
type: string
format: email
maxLength: 200
description: Primary contact email for the organization
example: "contact@techcorp.com"
tags:
type: array
items:
type: string
description: |
Tags related to the organization. If approved, these tags are shown
on the organization's public profile. Can be added later as well.
example: ["AI", "Orchestration", "Cloud"]
website_url:
type: string
maxLength: 200
format: uri
description: Organization's website URL
example: "https://www.techcorp.com"
locations:
type: string
minLength: 1
maxLength: 100
description: Primary location(s) of the organization
example: "San Francisco, CA"
ApplicationDTO:
type: object
properties:
id:
type: string
format: uuid
description: External ID of the application
example: "123e4567-e89b-12d3-a456-426614174000"
submitted_at:
type: string
format: date-time
description: Timestamp when the application was submitted
example: "2024-01-15T10:30:00Z"
application_status:
$ref: '#/components/schemas/ApplicationStatus'
processed_by_user_id:
type: string
format: uuid
description: External ID of the user who processed the application
example: "456e7890-e12b-34c5-d678-901234567890"
nullable: true
processed_at:
type: string
format: date-time
description: Timestamp when the application was processed
example: "2024-01-16T15:45:00Z"
nullable: true
application_form_response:
type: string
description: JSON string containing the original application form data
example: "{\"name\":\"TechCorp\",\"email\":\"contact@techcorp.com\",\"description\":\"AI company\"}"
ApplicationStatus:
type: string
enum:
- pending
- approved
- rejected
- cancelled
description: |
Application status indicating the lifecycle state:
- `pending`: Submitted but not yet reviewed
- `approved`: Application has been approved by an administrator
- `rejected`: Application has been rejected
- `cancelled`: Application was cancelled by the user
example: "pending"
Error:
type: object
required:
- error
- message
- timestamp
properties:
error:
type: string
description: Error type or category
example: "Bad Request"
message:
type: string
description: Human-readable error message
example: "Invalid request parameter: name is required"
timestamp:
type: string
format: date-time
description: Timestamp when the error occurred
example: "2024-01-15T10:30:00Z"
success:
type: boolean
description: Indicates if the operation was successful
example: false
details:
type: object
description: Additional error details
additionalProperties: true
example:
validation_errors:
name: "Organization name is required"
email: "Invalid email format"
OrganizationModificationRequest:
type: object
description: Request object for modifying organization details
properties:
description:
type: string
description: Organization description
example: "A technology company focused on AI solutions"
maxLength: 1000
email:
type: string
format: email
description: Organization contact email
example: "contact@example.com"
maxLength: 255
website-url:
type: string
format: uri
description: Organization website URL
example: "https://www.example.com"
maxLength: 500
tags:
type: array
description: List of tags associated with the organization
items:
type: string
maxLength: 50
example: ["technology", "startup", "ai"]
maxItems: 20
additionalProperties: false
RegisterEventManagerRequest:
type: object
required:
- event-id
- user-id
description: Request object for registering an event manager
properties:
event-id:
type: string
description: External ID of the event
example: "event-67890"
minLength: 1
maxLength: 100
user-id:
type: string
description: External ID of the user to be registered as manager
example: "user-12345"
minLength: 1
maxLength: 100
additionalProperties: false
responses:
BadRequest:
description: Bad request - Invalid input parameters
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
invalid_parameter:
summary: Invalid parameter
value:
error: "Bad Request"
message: "Invalid request parameter: application-id is required"
timestamp: "2024-01-15T10:30:00Z"
success: false
constraint_violation:
summary: Constraint violation
value:
error: "Bad Request"
message: "Constraint violation: Rejection reason cannot be blank"
timestamp: "2024-01-15T10:30:00Z"
success: false
ValidationError:
description: Validation error - Request body validation failed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
validation_failed:
summary: Validation errors
value:
error: "Bad Request"
message: "Validation failed"
timestamp: "2024-01-15T10:30:00Z"
success: false
details:
validation_errors:
name: "Organization name is required"
email: "Invalid email format"
locations: "Organization location is required"
Unauthorized:
description: Unauthorized - Authentication required or token invalid
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
token_invalid:
summary: Invalid token
value:
error: "Unauthorized"
message: "Token not valid: JWT token has expired"
timestamp: "2024-01-15T10:30:00Z"
success: false
missing_auth:
summary: Missing authentication
value:
error: "Unauthorized"
message: "Authentication required"
timestamp: "2024-01-15T10:30:00Z"
success: false
Forbidden:
description: Forbidden - Insufficient permissions
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
insufficient_permissions:
summary: Access denied
value:
error: "Forbidden"
message: "Access Denied: ADMIN role required"
timestamp: "2024-01-15T10:30:00Z"
success: false
resource_access_denied:
summary: Resource access denied
value:
error: "Forbidden"
message: "Access Denied: No permission to access this application"
timestamp: "2024-01-15T10:30:00Z"
success: false
ApplicationNotFound:
description: Application not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
examples:
not_found:
summary: Application not found
value:
error: "Not Found"
message: "The requested application could not be found"
timestamp: "2024-01-15T10:30:00Z"
success: false
OrganizationNameConflict:
description: Organization name already exists
content:
application/json:
schema:
$ref: '#/components/schemas/Error'