-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathkinde-mgmt-api-specs.yaml
1375 lines (1375 loc) · 42.8 KB
/
kinde-mgmt-api-specs.yaml
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.0
info:
version: '1.2.2'
title: Kinde Management API
description: Provides endpoints to manage your Kinde Businesses
termsOfService: https://kinde.com/docs/important-information/terms-of-service/
contact:
name: Kinde Support Team
email: [email protected]
url: https://kinde.com/docs/
servers:
- url: https://{businessName}.kinde.com/
variables:
businessName:
default: app
description: Business name created in the Kinde admin area.
security:
- kindeBearerAuth: []
tags:
- name: Users
description: Everything about your end-users.
paths:
/oauth2/user_profile:
get:
tags:
- OAuth
operationId: getUser
description: |
Contains the id, names and email of the currently logged in user.
summary: Returns the details of the currently logged in user
responses:
'200':
description: Details of logged in user V1.
content:
application/json:
schema:
$ref: '#/components/schemas/user_profile'
'403':
description: Invalid credentials.
/oauth2/v2/user_profile:
get:
tags:
- OAuth
operationId: getUserProfileV2
description: |
Contains the id, names, profile picture URL and email of the currently logged in user.
summary: Returns the details of the currently logged in user
responses:
'200':
description: Details of logged in user V2.
content:
application/json:
schema:
$ref: '#/components/schemas/user_profile_v2'
'403':
description: Invalid credentials.
/api/v1/users:
get:
tags:
- Users
operationId: getUsers
description: |
The returned list can be sorted by full name or email address
in ascending or descending order. The number of records to return at a time can also be controlled using the `page_size` query
string parameter.
summary: List Users
parameters:
- name: sort
in: query
description: Field and order to sort the result by.
schema:
type: string
nullable: true
enum: [name_asc, name_desc, email_asc, email_desc]
- name: page_size
in: query
description: Number of results per page. Defaults to 10 if parameter not sent.
schema:
type: integer
nullable: true
- name: user_id
in: query
description: ID of the user to filter by.
schema:
type: string
nullable: true
- name: next_token
in: query
description: A string to get the next page of results if there are more results.
schema:
type: string
nullable: true
responses:
'200':
description: Users successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/users_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/users_response'
'403':
description: Invalid credentials.
/api/v1/user:
get:
tags:
- Users
operationId: getUserData
description: |
Retrieve a user record.
summary: Get User
parameters:
- name: id
in: query
description: The user's id.
schema:
type: string
nullable: false
responses:
'200':
description: User successfully updated.
content:
application/json:
schema:
$ref: '#/components/schemas/user'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
post:
tags:
- Users
operationId: createUser
description: |
Creates a user record and optionally zero or more identities for the user. An example identity could be the email
address of the user.
summary: Create User
requestBody:
description: The details of the user to create.
required: false
content:
application/json:
schema:
type: object
properties:
profile:
description: Basic information required to create a user.
type: object
properties:
given_name:
type: string
description: User's first name.
family_name:
type: string
description: User's last name.
identities:
type: array
description: Array of identities to assign to the created user
items:
type: object
description: The result of the user creation operation.
properties:
'type':
type: string
description: The type of identity to create, for e.g. email.
details:
type: object
description: Additional details required to create the user.
properties:
email:
type: string
description: The email address of the user.
responses:
'200':
description: User successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/create_user_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/create_user_response'
'400':
description: Error creating user.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
patch:
tags:
- Users
operationId: updateUser
description: |
Update a user record.
summary: Update User
parameters:
- name: id
in: query
description: The user's id.
schema:
type: string
nullable: false
requestBody:
description: The user to update.
required: true
content:
application/json:
schema:
type: object
properties:
given_name:
type: string
description: User's first name.
family_name:
type: string
description: User's last name.
is_suspended:
type: boolean
description: Whether the user is currently suspended or not.
responses:
'200':
description: User successfully updated.
content:
application/json:
schema:
$ref: '#/components/schemas/user'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/user'
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
delete:
tags:
- Users
operationId: deleteuser
description: |
Delete a user record.
summary: Delete User
parameters:
- name: id
in: query
description: The user's id.
schema:
type: string
nullable: false
responses:
'200':
description: User successfully deleted.
content:
application/json:
schema:
$ref: '#/components/schemas/success_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/success_response'
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
/api/v1/organization:
get:
tags:
- Organizations
operationId: getOrganization
description: |
Gets an organization given the organization's code.
summary: Get Organization
parameters:
- name: code
in: query
description: The organization's code.
schema:
type: string
nullable: false
responses:
'200':
description: Organization successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/organization'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/organization'
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
post:
tags:
- Organizations
operationId: createOrganization
description: Create an organization.
summary: Create Organization
requestBody:
description: Organization details.
required: false
content:
application/json:
schema:
type: object
properties:
name:
description: The organization's name.
type: string
feature_flags:
type: object
description: The organization's feature flag settings.
additionalProperties:
type: string
enum: [str, int, bool]
description: Value of the feature flag.
responses:
'201':
description: Organization successfully created.
'403':
description: Invalid credentials.
'400':
description: Error creating user.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'500':
description: Could not create organization.
/api/v1/organizations:
get:
tags:
- Organizations
operationId: getOrganizations
description: |
Get a list of organizations.
summary: List Organizations
parameters:
- name: sort
in: query
description: Field and order to sort the result by.
schema:
type: string
nullable: true
enum: [name_asc, name_desc, email_asc, email_desc]
- name: page_size
in: query
description: Number of results per page. Defaults to 10 if parameter not sent.
schema:
type: integer
nullable: true
- name: next_token
in: query
description: A string to get the next page of results if there are more results.
schema:
type: string
nullable: true
responses:
'200':
description: A successful response with a list of organizations or an empty list.
content:
application/json:
schema:
$ref: '#/components/schemas/get_organizations_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/get_organizations_response'
'403':
description: Invalid credentials.
/api/v1/organization/users:
get:
tags:
- Organizations
- Users
operationId: GetOrganizationUsers
description: Get users in an organization.
summary: List Organization Users
parameters:
- name: sort
in: query
description: Field and order to sort the result by.
schema:
type: string
nullable: true
enum: [name_asc, name_desc, email_asc, email_desc]
- name: page_size
in: query
description: Number of results per page. Defaults to 10 if parameter not sent.
schema:
type: integer
nullable: true
- name: next_token
in: query
description: A string to get the next page of results if there are more results.
schema:
type: string
nullable: true
- name: code
in: query
description: The organization's code.
schema:
type: string
nullable: false
- name: permissions
in: query
description: Filter by user permissions
schema:
type: string
responses:
'200':
description: A successful response with a list of organization users or an empty list.
content:
application/json:
schema:
$ref: '#/components/schemas/get_organizations_users_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/get_organizations_users_response'
'400':
description: Error creating user
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
post:
tags:
- Organizations
- Users
operationId: AddOrganizationUsers
description: Add existing users to an organization.
summary: Assign Users to an Organization
parameters:
- name: code
in: query
description: The organization's code.
schema:
type: string
nullable: false
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
users:
description: List of user ids to be added to the organization.
type: array
items:
type: string
responses:
'200':
description: Users successfully added.
content:
application/json:
schema:
$ref: '#/components/schemas/add_organization_users_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/add_organization_users_response'
'204':
description: No users added.
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
patch:
tags:
- Organizations
- Users
operationId: RemoveOrganizationUsers
description: Remove existing users from an organization.
summary: Remove Users from an Organization
parameters:
- name: code
in: query
description: The organization's code.
schema:
type: string
nullable: false
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
users:
description: List of user ids to be removed from the organization.
type: array
items:
type: string
responses:
'200':
description: Users successfully removed.
content:
application/json:
schema:
$ref: '#/components/schemas/remove_organization_users_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/remove_organization_users_response'
'400':
description: Error creating user.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
/api/v1/connected_apps/auth_url:
get:
tags:
- Connected Apps
operationId: GetConnectedAppAuthUrl
description: Get a URL that authenticates and authorizes a user to a third-party connected app.
summary: Get Connected App URL
parameters:
- name: key_code_ref
in: query
description: The unique key code reference of the connected app to authenticate against.
schema:
type: string
nullable: false
required: true
- name: user_id
in: query
description: The id of the user that needs to authenticate to the third-party connected app.
schema:
type: string
nullable: false
required: true
responses:
'200':
description: A URL that can be used to authenticate and a session id to identify this authentication session.
content:
application/json:
schema:
$ref: '#/components/schemas/connected_apps_auth_url'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/connected_apps_auth_url'
'400':
description: Error retrieving connected app auth url.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'404':
description: Error retrieving connected app auth url.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
/api/v1/connected_apps/token:
get:
tags:
- Connected Apps
operationId: GetConnectedAppToken
description: Get an access token that can be used to call the third-party provider linked to the connected app.
summary: Get Connected App Token
parameters:
- name: session_id
in: query
description: The unique sesssion id reprensenting the login session of a user.
schema:
type: string
nullable: false
required: true
responses:
'200':
description: An access token that can be used to query a third-party provider, as well as the token's expiry time.
content:
application/json:
schema:
$ref: '#/components/schemas/connected_apps_access_token'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/connected_apps_access_token'
'400':
description: The session id provided points to an invalid session.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
/api/v1/connected_apps/revoke:
post:
tags:
- Connected Apps
operationId: RevokeConnectedAppToken
description: Revoke the tokens linked to the connected app session.
summary: Revoke Connected App Token
parameters:
- name: session_id
in: query
description: The unique sesssion id reprensenting the login session of a user.
schema:
type: string
nullable: false
required: true
responses:
'200':
description: An access token that can be used to query a third-party provider, as well as the token's expiry time.
content:
application/json:
schema:
$ref: '#/components/schemas/success_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/success_response'
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'405':
description: Invalid HTTP method used.
/api/v1/feature_flags:
post:
tags:
- Feature Flags
operationId: CreateFeatureFlag
description: Create feature flag.
summary: Create a new feature flag
parameters:
- name: name
in: query
description: The name of the flag.
schema:
type: string
nullable: false
required: true
- name: description
in: query
description: Description of the flag purpose.
schema:
type: string
nullable: false
required: true
- name: key
in: query
description: The flag identifier to use in code.
schema:
type: string
nullable: false
required: true
- name: type
in: query
description: The variable type.
schema:
type: string
enum: [str, int, bool]
nullable: false
required: true
- name: allow_override_level
in: query
description: Allow the flag to be overridden at a different level.
schema:
type: string
enum: [env, org]
nullable: false
required: true
- name: default_value
in: query
description: Default value for the flag used by environments and organizations.
schema:
type: string
nullable: false
required: true
responses:
'201':
description: Feature flag successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/success_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/success_response'
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
/api/v1/feature_flags/{feature_flag_key}:
delete:
tags:
- Feature Flags
operationId: DeleteFeatureFlag
description: Delete feature flag
summary: Delete a feature flag
parameters:
- name: feature_flag_key
in: path
description: The identifier for the feature flag.
required: true
schema:
type: string
responses:
'200':
description: Feature flag successfully updated.
content:
application/json:
schema:
$ref: '#/components/schemas/success_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/success_response'
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
put:
tags:
- Feature Flags
operationId: UpdateFeatureFlag
description: Update feature flag.
summary: Update a feature flag
parameters:
- name: feature_flag_key
in: path
description: The identifier for the feature flag.
required: true
schema:
type: string
- name: name
in: query
description: The name of the flag.
schema:
type: string
nullable: false
required: true
- name: description
in: query
description: Description of the flag purpose.
schema:
type: string
nullable: false
required: true
- name: key
in: query
description: The flag identifier to use in code.
schema:
type: string
nullable: false
required: true
- name: type
in: query
description: The variable type
schema:
type: string
enum: [str, int, bool]
nullable: false
required: true
- name: allow_override_level
in: query
description: Allow the flag to be overridden at a different level.
schema:
type: string
enum: [env, org]
nullable: false
required: true
- name: default_value
in: query
description: Default value for the flag used by environments and organizations.
schema:
type: string
nullable: false
required: true
responses:
'200':
description: Feature flag successfully updated.
content:
application/json:
schema:
$ref: '#/components/schemas/success_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/success_response'
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
/api/v1/organizations/{org_code}/feature_flags:
delete:
tags:
- Organizations
operationId: DeleteOrganizationFeatureFlagOverrides
description: Delete all organization feature flag overrides.
summary: Delete all organization feature flag overrides
parameters:
- name: org_code
in: path
description: The identifier for the organization.
required: true
schema:
type: string
responses:
'200':
description: Feature flag overrides successfully deleted.
content:
application/json:
schema:
$ref: '#/components/schemas/success_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/success_response'
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
/api/v1/organizations/{org_code}/feature_flags/{feature_flag_key}:
delete:
tags:
- Organizations
operationId: DeleteOrganizationFeatureFlagOverride
description: Delete organization feature flag override.
summary: Delete organization feature flag override
parameters:
- name: org_code
in: path
description: The identifier for the organization.
required: true
schema:
type: string
- name: feature_flag_key
in: path
description: The identifier for the feature flag.
required: true
schema:
type: string
responses:
'200':
description: Feature flag override successfully deleted.
content:
application/json:
schema:
$ref: '#/components/schemas/success_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/success_response'
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/error_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/error_response'
'403':
description: Invalid credentials.
patch:
tags:
- Organizations
operationId: UpdateOrganizationFeatureFlagOverride
description: Update organization feature flag override.
summary: Update organization feature flag override
parameters:
- name: org_code
in: path
description: The identifier for the organization
required: true
schema:
type: string
- name: feature_flag_key
in: path
description: The identifier for the feature flag
required: true
schema:
type: string
- name: value
in: query
description: Override value
required: true
schema:
type: string
responses:
'200':
description: Feature flag override successfully updated.
content:
application/json:
schema:
$ref: '#/components/schemas/success_response'
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/success_response'