-
Notifications
You must be signed in to change notification settings - Fork 14
Expand file tree
/
Copy pathkinde-management-api.yaml
More file actions
11366 lines (11168 loc) · 346 KB
/
kinde-management-api.yaml
File metadata and controls
11366 lines (11168 loc) · 346 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.0
info:
version: '1'
title: Kinde Management API
description: >
Provides endpoints to manage your Kinde Businesses.
## Intro
## How to use
1. [Set up and authorize a machine-to-machine (M2M)
application](https://docs.kinde.com/developer-tools/kinde-api/connect-to-kinde-api/).
2. [Generate a test access
token](https://docs.kinde.com/developer-tools/kinde-api/access-token-for-api/)
3. Test request any endpoint using the test token
termsOfService: https://docs.kinde.com/trust-center/agreements/terms-of-service/
contact:
name: Kinde Support Team
email: support@kinde.com
url: https://docs.kinde.com
servers:
- url: https://{subdomain}.kinde.com
variables:
subdomain:
default: your_kinde_subdomain
description: The subdomain generated for your business on Kinde.
tags:
- name: APIs
x-displayName: APIs
- name: Applications
x-displayName: Applications
- name: Billing Entitlements
x-displayName: Billing Entitlements
- name: Billing Agreements
x-displayName: Billing Agreements
- name: Billing Meter Usage
x-displayName: Billing Meter Usage
- name: Business
x-displayName: Business
- name: Industries
x-displayName: Industries
- name: Timezones
x-displayName: Timezones
- name: Callbacks
x-displayName: Callbacks
- name: Connected Apps
x-displayName: Connected Apps
- name: Connections
x-displayName: Connections
- name: Environments
x-displayName: Environments
- name: Environment variables
x-displayName: Environment variables
- name: Feature Flags
x-displayName: Feature Flags
- name: Identities
x-displayName: Identities
- name: MFA
x-displayName: MFA
- name: Organizations
x-displayName: Organizations
- name: Permissions
x-displayName: Permissions
- name: Properties
x-displayName: Properties
- name: Property Categories
x-displayName: Property Categories
- name: Roles
x-displayName: Roles
- name: Search
x-displayName: Search
- name: Subscribers
x-displayName: Subscribers
- name: Users
x-displayName: Users
- name: Webhooks
x-displayName: Webhooks
paths:
/api/v1/apis:
get:
tags:
- APIs
operationId: getAPIs
summary: Get APIs
description: |
Returns a list of your APIs. The APIs are returned sorted by name.
<div>
<code>read:apis</code>
</div>
parameters:
- name: expand
in: query
description: Specify additional data to retrieve. Use "scopes".
required: false
schema:
type: string
nullable: true
enum:
- scopes
responses:
'200':
description: A list of APIs.
content:
application/json:
schema:
$ref: '#/components/schemas/get_apis_response'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
post:
tags:
- APIs
operationId: addAPIs
summary: Create API
description: >
Register a new API. For more information read [Register and manage
APIs](https://docs.kinde.com/developer-tools/your-apis/register-manage-apis/).
<div>
<code>create:apis</code>
</div>
externalDocs:
url: https://docs.kinde.com/developer-tools/your-apis/register-manage-apis
description: Register and manage APIs
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the API. (1-64 characters).
example: Example API
audience:
type: string
description: >-
A unique identifier for the API - commonly the URL. This
value will be used as the `audience` parameter in
authorization claims. (1-64 characters)
example: https://api.example.com
required:
- name
- audience
responses:
'200':
description: APIs successfully updated
content:
application/json:
schema:
$ref: '#/components/schemas/create_apis_response'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
/api/v1/apis/{api_id}:
parameters:
- $ref: '#/components/parameters/api_id'
get:
tags:
- APIs
operationId: getAPI
summary: Get API
description: |
Retrieve API details by ID.
<div>
<code>read:apis</code>
</div>
responses:
'200':
description: API successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/get_api_response'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
delete:
tags:
- APIs
operationId: deleteAPI
summary: Delete API
description: |
Delete an API you previously created.
<div>
<code>delete:apis</code>
</div>
responses:
'200':
description: API successfully deleted.
content:
application/json:
schema:
$ref: '#/components/schemas/delete_api_response'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
/api/v1/apis/{api_id}/scopes:
get:
tags:
- APIs
operationId: getAPIScopes
summary: Get API scopes
parameters:
- name: api_id
in: path
description: API ID
required: true
schema:
type: string
nullable: false
example: 838f208d006a482dbd8cdb79a9889f68
description: |
Retrieve API scopes by API ID.
<div>
<code>read:api_scopes</code>
</div>
responses:
'200':
description: API scopes successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/get_api_scopes_response'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
post:
tags:
- APIs
operationId: addAPIScope
summary: Create API scope
parameters:
- name: api_id
in: path
description: API ID
required: true
schema:
type: string
nullable: false
example: 838f208d006a482dbd8cdb79a9889f68
description: |
Create a new API scope.
<div>
<code>create:api_scopes</code>
</div>
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
key:
type: string
description: >-
The key reference for the scope (1-64 characters, no white
space).
example: read:logs
description:
type: string
description: Description of the api scope purpose.
example: Scope for reading logs.
required:
- key
responses:
'200':
description: API scopes successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/create_api_scopes_response'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
/api/v1/apis/{api_id}/scopes/{scope_id}:
get:
tags:
- APIs
operationId: getAPIScope
summary: Get API scope
parameters:
- name: api_id
in: path
description: API ID
required: true
schema:
type: string
nullable: false
example: 838f208d006a482dbd8cdb79a9889f68
- name: scope_id
in: path
description: Scope ID
required: true
schema:
type: string
nullable: false
example: api_scope_019391daf58d87d8a7213419c016ac95
description: |
Retrieve API scope by API ID.
<div>
<code>read:api_scopes</code>
</div>
responses:
'200':
description: API scope successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/get_api_scope_response'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
patch:
tags:
- APIs
operationId: updateAPIScope
summary: Update API scope
parameters:
- name: api_id
in: path
description: API ID
required: true
schema:
type: string
nullable: false
example: 838f208d006a482dbd8cdb79a9889f68
- name: scope_id
in: path
description: Scope ID
required: true
schema:
type: string
nullable: false
example: api_scope_019391daf58d87d8a7213419c016ac95
description: |
Update an API scope.
<div>
<code>update:api_scopes</code>
</div>
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
type: string
description: Description of the api scope purpose.
example: Scope for reading logs.
responses:
'200':
description: API scope successfully updated
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
delete:
tags:
- APIs
operationId: deleteAPIScope
summary: Delete API scope
parameters:
- name: api_id
in: path
description: API ID
required: true
schema:
type: string
nullable: false
example: 838f208d006a482dbd8cdb79a9889f68
- name: scope_id
in: path
description: Scope ID
required: true
schema:
type: string
nullable: false
example: api_scope_019391daf58d87d8a7213419c016ac95
description: |
Delete an API scope you previously created.
<div>
<code>delete:apis_scopes</code>
</div>
responses:
'200':
description: API scope successfully deleted.
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
/api/v1/apis/{api_id}/applications:
parameters:
- $ref: '#/components/parameters/api_id'
patch:
tags:
- APIs
operationId: updateAPIApplications
summary: Authorize API applications
description: |
Authorize applications to be allowed to request access tokens for an API
<div>
<code>update:apis</code>
</div>
requestBody:
description: The applications you want to authorize.
required: true
content:
application/json:
schema:
type: object
required:
- applications
properties:
applications:
type: array
items:
type: object
required:
- id
properties:
id:
description: The application's Client ID.
type: string
example: d2db282d6214242b3b145c123f0c123
operation:
description: >-
Optional operation, set to 'delete' to revoke
authorization for the application. If not set, the
application will be authorized.
type: string
example: delete
responses:
'200':
description: Authorized applications updated.
content:
application/json:
schema:
$ref: '#/components/schemas/authorize_app_api_response'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
/api/v1/apis/{api_id}/applications/{application_id}/scopes/{scope_id}:
post:
tags:
- APIs
operationId: addAPIApplicationScope
summary: Add scope to API application
parameters:
- name: api_id
in: path
description: API ID
required: true
schema:
type: string
nullable: false
example: 838f208d006a482dbd8cdb79a9889f68
- name: application_id
in: path
description: Application ID
required: true
schema:
type: string
nullable: false
example: 7643b487c97545aab79257fd13a1085a
- name: scope_id
in: path
description: Scope ID
required: true
schema:
type: string
nullable: false
example: api_scope_019391daf58d87d8a7213419c016ac95
description: |
Add a scope to an API application.
<div>
<code>create:api_application_scopes</code>
</div>
responses:
'200':
description: API scope successfully added to API application
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
delete:
tags:
- APIs
operationId: deleteAPIAppliationScope
summary: Delete API application scope
parameters:
- name: api_id
in: path
description: API ID
required: true
schema:
type: string
nullable: false
example: 838f208d006a482dbd8cdb79a9889f68
- name: application_id
in: path
description: Application ID
required: true
schema:
type: string
nullable: false
example: 7643b487c97545aab79257fd13a1085a
- name: scope_id
in: path
description: Scope ID
required: true
schema:
type: string
nullable: false
example: api_scope_019391daf58d87d8a7213419c016ac95
description: |
Delete an API application scope you previously created.
<div>
<code>delete:apis_application_scopes</code>
</div>
responses:
'200':
description: API scope successfully deleted.
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
/api/v1/applications:
get:
tags:
- Applications
operationId: getApplications
summary: Get applications
description: |
Get a list of applications / clients.
<div>
<code>read:applications</code>
</div>
parameters:
- name: sort
in: query
description: Field and order to sort the result by.
schema:
type: string
nullable: true
enum:
- name_asc
- name_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 applications or an empty list.
content:
application/json:
schema:
$ref: '#/components/schemas/get_applications_response'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
post:
tags:
- Applications
operationId: createApplication
summary: Create application
description: |
Create a new client.
<div>
<code>create:applications</code>
</div>
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
description: The application's name.
type: string
example: React Native app
type:
description: >-
The application's type. Use `reg` for regular server
rendered applications, `spa` for single-page applications,
and `m2m` for machine-to-machine applications.
type: string
enum:
- reg
- spa
- m2m
org_code:
description: Scope an M2M application to an org (Plus plan required).
type: string
example: org_1234567890abcdef
nullable: true
required:
- name
- type
responses:
'201':
description: Application successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/create_application_response'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
/api/v1/applications/{application_id}:
get:
tags:
- Applications
operationId: getApplication
summary: Get application
description: |
Gets an application given the application's ID.
<div>
<code>read:applications</code>
</div>
parameters:
- name: application_id
in: path
description: The identifier for the application.
required: true
schema:
type: string
nullable: false
example: 20bbffaa4c5e492a962273039d4ae18b
responses:
'200':
description: Application successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/get_application_response'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
patch:
tags:
- Applications
operationId: updateApplication
summary: Update Application
description: >
Updates a client's settings. For more information, read [Applications in
Kinde](https://docs.kinde.com/build/applications/about-applications)
<div>
<code>update:applications</code>
</div>
parameters:
- name: application_id
in: path
description: The identifier for the application.
required: true
schema:
type: string
example: 20bbffaa4c5e492a962273039d4ae18b
requestBody:
description: Application details.
required: false
content:
application/json:
schema:
type: object
properties:
name:
description: The application's name.
type: string
language_key:
description: The application's language key.
type: string
logout_uris:
description: The application's logout uris.
type: array
items:
type: string
redirect_uris:
description: The application's redirect uris.
type: array
items:
type: string
login_uri:
description: The default login route for resolving session issues.
type: string
homepage_uri:
description: The homepage link to your application.
type: string
responses:
'200':
description: Application successfully updated.
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
delete:
tags:
- Applications
operationId: deleteApplication
summary: Delete application
description: |
Delete a client / application.
<div>
<code>delete:applications</code>
</div>
parameters:
- name: application_id
in: path
description: The identifier for the application.
required: true
schema:
type: string
example: 20bbffaa4c5e492a962273039d4ae18b
responses:
'200':
description: Application successfully deleted.
content:
application/json:
schema:
$ref: '#/components/schemas/success_response'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
/api/v1/applications/{application_id}/connections:
get:
tags:
- Applications
operationId: GetApplicationConnections
description: |
Gets all connections for an application.
<div>
<code>read:application_connections</code>
</div>
summary: Get connections
parameters:
- name: application_id
in: path
description: The identifier/client ID for the application.
required: true
schema:
type: string
nullable: false
example: 20bbffaa4c5e492a962273039d4ae18b
responses:
'200':
description: Application connections successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/get_connections_response'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
/api/v1/applications/{application_id}/connections/{connection_id}:
post:
tags:
- Applications
operationId: EnableConnection
summary: Enable connection
description: |
Enable an auth connection for an application.
<div>
<code>create:application_connections</code>
</div>
parameters:
- name: application_id
in: path
description: The identifier/client ID for the application.
required: true
schema:
type: string
example: 20bbffaa4c5e492a962273039d4ae18b
- name: connection_id
in: path
description: The identifier for the connection.
required: true
schema:
type: string
example: conn_0192c16abb53b44277e597d31877ba5b
responses:
'200':
description: Connection successfully enabled.
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
delete:
tags:
- Applications
operationId: RemoveConnection
summary: Remove connection
description: |
Turn off an auth connection for an application
<div>
<code>delete:application_connections</code>
</div>
parameters:
- name: application_id
in: path
description: The identifier/client ID for the application.
required: true
schema:
type: string
example: 20bbffaa4c5e492a962273039d4ae18b
- name: connection_id
in: path
description: The identifier for the connection.
required: true
schema:
type: string
example: conn_0192c16abb53b44277e597d31877ba5b
responses:
'200':
description: Connection successfully removed.
content:
application/json:
schema:
$ref: '#/components/schemas/success_response'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
/api/v1/applications/{application_id}/properties:
parameters:
- $ref: '#/components/parameters/application_id'
get:
tags:
- Applications
operationId: getApplicationPropertyValues
summary: Get property values
description: |
Gets properties for an application by client ID.
<div>
<code>read:application_properties</code>
</div>
responses:
'200':
description: Properties successfully retrieved.
content:
application/json:
schema:
$ref: '#/components/schemas/get_property_values_response'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'429':
$ref: '#/components/responses/too_many_requests'
security:
- kindeBearerAuth: []
/api/v1/applications/{application_id}/properties/{property_key}:
parameters:
- $ref: '#/components/parameters/application_id'
- $ref: '#/components/parameters/property_key'
put:
tags:
- Applications
operationId: updateApplicationsProperty
summary: Update property
description: |
Update application property value.
<div>
<code>update:application_properties</code>