-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmanagement.json
More file actions
8563 lines (8563 loc) · 361 KB
/
management.json
File metadata and controls
8563 lines (8563 loc) · 361 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",
"servers": [
{
"url": "https://{base_url}",
"description": "",
"variables": {
"base_url": {
"default": "api.contentstack.io"
}
}
}
],
"info": {
"version": "069fffc7-42a2-4421-ac05-1fd7c062ac46",
"title": "Content Management API - Contentstack",
"description": "The Content Management API (CMA) Requests can be used to manage the content of your Contentstack account. The CMA Requests help you create, update, delete, and fetch content of your account.\n\nThe Contentstack CMA Postman Collection is a set of preconfigured REST API requests that will make it easy for you to get started with the [Contentstack Management APIs](https://www.contentstack.com/docs/developers/apis/content-management-api/) and try out our API requests through the [Postman](https://www.getpostman.com/) REST client.\n\n**Postman Collection Details\n**\n\n- CMA Postman Collection Version: 2.1.0\n- Last Updated: July 23, 2020",
"termsOfService": "",
"contact": {},
"license": {
"name": ""
}
},
"paths": {
"/v3/user": {
"get": {
"summary": "Get user",
"description": "<p>The <code>Get user</code> call returns comprehensive information of an existing user account. The information returned includes details of the stacks owned by and shared with the specified user account.<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#get-user>Get User</a> API Reference document",
"operationId": "Getuser",
"parameters": [
{
"$ref": "#/components/parameters/authtoken"
},
{
"$ref": "#/components/parameters/Content-Type"
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"tags": [
"Users"
]
},
"put": {
"summary": "Update user",
"description": "<p>The <code>Update User</code> API Request updates the details of an existing user account. Only the information entered here will be updated, the existing data will remain unaffected.<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#update-user>Update User</a> API Reference document",
"operationId": "Updateuser",
"parameters": [
{
"name": "authtoken",
"in": "header",
"required": false,
"style": "simple",
"schema": {
"type": "string",
"example": "{{authtoken}}"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"requestBody": {
"description": "<p>The <code>Update User</code> API Request updates the details of an existing user account. Only the information entered here will be updated, the existing data will remain unaffected.<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#update-user>Update User</a> API Reference document",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "string",
"example": {
"user": {
"company": "company name inc."
}
}
},
"example": "{\n\t\"user\": {\n\t\t\"company\": \"company name inc.\"\n\t}\n}"
}
}
},
"tags": [
"Users"
]
}
},
"/v3/user/activate/{user_activation_token}": {
"post": {
"summary": "Activate a user account",
"description": "<p>The <code>Activate a user account</code> call activates the account of a user after signing up. For account activation, you will require the token received in the activation email.\n<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#activate-user>Activate User</a> API Reference document",
"operationId": "Activateauseraccount",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"$ref": "#/components/parameters/user_activation_token"
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"requestBody": {
"description": "<p>The <code>Activate a user account</code> call activates the account of a user after signing up. For account activation, you will require the token received in the activation email.\n<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#activate-user>Activate User</a> API Reference document",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "string",
"example": {
"user": {
"first_name": "your_first_name",
"last_name": "your_last_name",
"password": "your_password",
"password_confirmation": "confirm_your_password"
}
}
},
"example": "{\n\"user\": {\n\"first_name\": \"your_first_name\",\n\"last_name\": \"your_last_name\",\n\"password\": \"your_password\",\n\"password_confirmation\": \"confirm_your_password\"\n}\n}"
}
}
},
"tags": [
"Users"
]
}
},
"/v3/user/forgot_password": {
"post": {
"summary": "Request for a password",
"description": "<p>The <code>Request for a password</code> call sends a request for a temporary password to log in to an account in case a user has forgotten the login password.\n<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#request-password>Request Password</a> API Reference document",
"operationId": "Requestforapassword",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"requestBody": {
"description": "<p>The <code>Request for a password</code> call sends a request for a temporary password to log in to an account in case a user has forgotten the login password.\n<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#request-password>Request Password</a> API Reference document",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "string",
"example": {
"user": {
"email": "john.doe@contentstack.com"
}
}
},
"example": "{\n\t\"user\": {\n\t\t\"email\": \"john.doe@contentstack.com\"\n\t}\n}"
}
}
},
"tags": [
"Users"
]
}
},
"/v3/user/reset_password": {
"post": {
"summary": "Reset password",
"description": "<p>The <code>Reset password</code> call sends a request for resetting the password of your Contentstack account.\n<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#reset-password>Reset Password</a> API Reference document",
"operationId": "Resetpassword",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"requestBody": {
"description": "<p>The <code>Reset password</code> call sends a request for resetting the password of your Contentstack account.\n<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#reset-password>Reset Password</a> API Reference document",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "string",
"example": {
"user": {
"reset_password_token": "abcdefghijklmnop1234567890",
"password": "Simple@123",
"password_confirmation": "Simple@123"
}
}
},
"example": "{\n\t\"user\": {\n\t\t\"reset_password_token\": \"abcdefghijklmnop1234567890\",\n\t\t\"password\": \"Simple@123\",\n\t\t\"password_confirmation\": \"Simple@123\"\n\t}\n}"
}
}
},
"tags": [
"Users"
]
}
},
"/v3/user-session": {
"post": {
"summary": "Log in to your account",
"description": "<p>The <code>Log in to your account</code> request is used to sign in to your Contentstack account and obtain the authtoken.<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#logging-in/out>Logging in/out</a> API Reference document",
"operationId": "Logintoyouraccount",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"requestBody": {
"description": "<p>The <code>Log in to your account</code> request is used to sign in to your Contentstack account and obtain the authtoken.<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#logging-in/out>Logging in/out</a> API Reference document",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "string",
"example": {
"user": {
"email": "{{user_email}}",
"password": "{{password}}",
"tfa_token": "{{your_2FA_token}}"
}
}
},
"example": "{\n\t\"user\": {\n\t\t\"email\": \"{{user_email}}\",\n\t\t\"password\": \"{{password}}\",\n\t\t\"tfa_token\": \"{{your_2FA_token}}\"\n\t}\n}"
}
}
},
"tags": [
"User session"
]
},
"delete": {
"summary": "Log out of your account",
"description": "<p>The <code>Log out of your account</code> call is used to sign out the user of Contentstack account.<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#logging-in/out>Logging in/out</a> API Reference document",
"operationId": "Logoutofyouraccount",
"parameters": [
{
"name": "authtoken",
"in": "header",
"required": false,
"style": "simple",
"schema": {
"type": "string",
"example": "{{authtoken}}"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"tags": [
"User session"
]
}
},
"/v3/organizations": {
"get": {
"summary": "Get all Organizations",
"description": "<p>The <code>Get all organizations</code> call lists all organizations related to the system user in the order that they were created.<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#get-all-organizations>Get All Organizations</a> API Reference document",
"operationId": "GetallOrganizations",
"parameters": [
{
"$ref": "#/components/parameters/limit"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/asc"
},
{
"$ref": "#/components/parameters/desc"
},
{
"$ref": "#/components/parameters/include_count"
},
{
"$ref": "#/components/parameters/typeahead"
},
{
"name": "authtoken",
"in": "header",
"required": false,
"style": "simple",
"schema": {
"type": "string",
"example": "authtoken"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"tags": [
"Organizations"
]
}
},
"/v3/organizations/{organization_uid}": {
"get": {
"summary": "Get a single Organization",
"description": "<p>The <code>Get a single organization</code> call gets the comprehensive details of a specific organization related to the system user.<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#get-single-organization>Get Single Organization</a> API Reference document",
"operationId": "GetasingleOrganization",
"parameters": [
{
"$ref": "#/components/parameters/include_plan"
},
{
"name": "authtoken",
"in": "header",
"required": false,
"style": "simple",
"schema": {
"type": "string",
"example": "{{authtoken}}"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"$ref": "#/components/parameters/organization_uid"
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"tags": [
"Organizations"
]
}
},
"/v3/organizations/{organization_uid}/roles": {
"get": {
"summary": "Get all roles in an Organization",
"description": "<p>The <code>Get all roles in an organization</code> call gives the details of all the roles that are set to users in an Organization.<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#organization-roles>Organization Roles</a> API Reference document",
"operationId": "GetallrolesinanOrganization",
"parameters": [
{
"name": "limit",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "string",
"example": "limit_value"
},
"description": "The ‘limit’ parameter will return a specific number of Organization roles in the output. Example, if there are 10 organization roles and you wish to fetch only the first 2, you need to specify '2' as the value in this parameter."
},
{
"name": "skip",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "string",
"example": "skip_value"
},
"description": "The ‘skip’ parameter will skip a specific number of Organization roles in the output. For example, if there are 12 organization roles and you want to skip the first 2 to get only the last 10 in the response body, you need to specify ‘2’ here."
},
{
"name": "asc",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "string",
"example": "field_uid"
},
"description": "The ‘asc’ parameter allows you to sort the list of organization roles in an ascending order on the basis of a parameter."
},
{
"name": "desc",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "string",
"example": "field_uid"
},
"description": "The ‘desc’ parameter allows you to sort the list of organization roles in a descending order on the basis of a parameter."
},
{
"name": "include_count",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "string",
"example": "false"
},
"description": "The ‘include_count’ parameter returns the total number of roles in an organization. For example: If you want to know the total number of roles in an organization, you need to mention ‘true’."
},
{
"$ref": "#/components/parameters/include_stack_roles"
},
{
"name": "authtoken",
"in": "header",
"required": false,
"style": "simple",
"schema": {
"type": "string",
"example": "{{authtoken}}"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"name": "organization_uid",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "organization_uid"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"tags": [
"Organizations"
]
}
},
"/v3/organizations/{organization_uid}/share": {
"post": {
"summary": "Add users to Organization",
"description": "<p>The <code>Add users to organization</code> call allows you to send invitations to add users to your organization. Only the owner or the admin of the organization can add users.\n<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#organization-users>Organization Users</a> API Reference document",
"operationId": "AdduserstoOrganization",
"parameters": [
{
"name": "authtoken",
"in": "header",
"required": false,
"style": "simple",
"schema": {
"type": "string",
"example": "{{authtoken}}"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"name": "organization_uid",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "organization_uid"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"requestBody": {
"description": "<p>The <code>Add users to organization</code> call allows you to send invitations to add users to your organization. Only the owner or the admin of the organization can add users.\n<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#organization-users>Organization Users</a> API Reference document",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "string",
"example": {
"share": {
"users": {
"abc@sample.com": [
"{{orgAdminRoleUid}}"
],
"xyz@sample.com": [
"{{orgMemberRoleUid}}"
]
},
"stacks": {
"abc@sample.com": {
"{{apiKey}}": [
"{{stackRoleUid1}}"
]
},
"xyz@sample.com": {
"blta1ed1f11111c1eb1": [
"blt111d1b110111e1f1"
],
"bltf0c00caa0f0000f0": [
"bltcea22222d2222222",
"blt333f33cb3e33ffde"
]
}
},
"message": "Invitation message"
}
}
},
"example": "{\n\t\"share\": {\n\t\t\"users\": {\n\t\t\t\"abc@sample.com\": [\"{{orgAdminRoleUid}}\"],\n\t\t\t\"xyz@sample.com\": [\"{{orgMemberRoleUid}}\"]\n\t\t},\n\t\t\"stacks\": {\n\t\t\t\"abc@sample.com\": {\n\t\t\t\t\"{{apiKey}}\": [\"{{stackRoleUid1}}\"]\n\t\t\t},\n\t\t\t\"xyz@sample.com\": {\n\t\t\t\t\"blta1ed1f11111c1eb1\": [\"blt111d1b110111e1f1\"],\n\t\t\t\t\"bltf0c00caa0f0000f0\": [\"bltcea22222d2222222\", \"blt333f33cb3e33ffde\"]\n\t\t\t}\n\t\t},\n\t\t\"message\": \"Invitation message\"\n\t}\n}"
}
}
},
"tags": [
"Organizations"
]
},
"get": {
"summary": "Get all Organization invitations",
"description": "<p>The <code>Get all organization invitations</code> call gives you a list of all the Organization invitations. Only the owner or the admin of the Organization can resend the invitation to add users to an Organization.\n<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#organization-users>Organization Users</a> API Reference document",
"operationId": "GetallOrganizationinvitations",
"parameters": [
{
"name": "limit",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "number"
},
"description": "The ‘limit’ parameter will return a specific number of sent organization invitations in the output. Example, if 10 invitations were sent out and you wish to fetch only the first 8, you need to specify '2' as the value in this parameter."
},
{
"name": "skip",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "number"
},
"description": "The ‘skip’ parameter will skip a specific number of organization roles in the output. Example, if there are 12 organization roles and you want to skip the last 2 to get only the first 10 in the response body, you need to specify ‘2’ here."
},
{
"name": "asc",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "string",
"example": "created_at"
},
"description": "The ‘asc’ parameter allows you to sort the list of organization invitations in ascending order on the basis of a specific parameter."
},
{
"name": "desc",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "string",
"example": "update_at"
},
"description": "The ‘desc’ parameter allows you to sort the list of organization invitations in descending order on the basis of a specific parameter."
},
{
"name": "include_count",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "string",
"example": "true"
},
"description": "The ‘include_count’ parameter returns the total number of organization invitations sent out. Example: If you wish to know the total number of organization invitations, you need to mention ‘true’."
},
{
"$ref": "#/components/parameters/include_roles"
},
{
"$ref": "#/components/parameters/include_invited_by"
},
{
"$ref": "#/components/parameters/include_user_details"
},
{
"name": "typeahead",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "string",
"example": "Aravind"
},
"description": "The ‘typeahead’ parameter allows you to perform a name-based search on all the stacks on an organization based on the value provided. For example, it allows you to perform an email-ID-based search on all users based on the email ID provided."
},
{
"name": "authtoken",
"in": "header",
"required": false,
"style": "simple",
"schema": {
"type": "string",
"example": "{{authtoken}}"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"name": "organization_uid",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "organization_uid"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"tags": [
"Organizations"
]
}
},
"/v3/organizations/{organization_uid}/share/{share_uid}/resend_invitation": {
"get": {
"summary": "Resend pending Organization invitation",
"description": "<p>The <code>Resend pending organization invitation</code> call allows you to resend Organization invitations to users who have not yet accepted the earlier invitation. Only the owner or the admin of the Organization can resend the invitation to add users to an Organization.\n<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#organization-users>Organization Users</a> API Reference document",
"operationId": "ResendpendingOrganizationinvitation",
"parameters": [
{
"name": "authtoken",
"in": "header",
"required": false,
"style": "simple",
"schema": {
"type": "string",
"example": "{{authtoken}}"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"name": "organization_uid",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "organization_uid"
}
},
{
"$ref": "#/components/parameters/share_uid"
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"tags": [
"Organizations"
]
}
},
"/v3/organizations/{organization_uid}/transfer-ownership": {
"post": {
"summary": "Transfer Organization ownership",
"description": "<p>The <code>Transfer organization ownership</code> call transfers the ownership of an Organization to another user. When the call is executed, an email invitation for accepting the ownership of a particular Organization is sent to the specified user.\n<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#transfer-organization-ownership>Transfer Organization Ownership</a> API Reference document",
"operationId": "TransferOrganizationownership",
"parameters": [
{
"name": "authtoken",
"in": "header",
"required": false,
"style": "simple",
"schema": {
"type": "string",
"example": "authtoken"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"name": "organization_uid",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "organization_uid"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"requestBody": {
"description": "<p>The <code>Transfer organization ownership</code> call transfers the ownership of an Organization to another user. When the call is executed, an email invitation for accepting the ownership of a particular Organization is sent to the specified user.\n<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#transfer-organization-ownership>Transfer Organization Ownership</a> API Reference document",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "string",
"example": {
"transfer_to": "abc@sample.com"
}
},
"example": "{\n\t\"transfer_to\": \"abc@sample.com\"\n}"
}
}
},
"tags": [
"Organizations"
]
}
},
"/v3/organizations/{organization_uid}/stacks": {
"get": {
"summary": "Get all stacks in an Organization",
"description": "<p>The <code>Get all stacks in an organization</code> call fetches the list of all stacks in an Organization.\n<br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#organization-stacks>Organization Stacks</a> API Reference document",
"operationId": "GetallstacksinanOrganization",
"parameters": [
{
"name": "limit",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "string",
"example": "limit_value"
},
"description": "The ‘limit’ parameter will return a specific number of stacks in the output. Example, if there are 10 organization stacks and you wish to fetch only the first 2, you need to specify '2' as value in this parameter."
},
{
"name": "skip",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "string",
"example": "skip_value"
},
"description": "The ‘skip’ parameter will skip a specific number of organization stacks in the output. Example, if there are 12 stacks and you want to skip the last 2 to get only the first 10 in the response body, you need to specify ‘2’ here."
},
{
"name": "asc",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "string",
"example": "field_uid"
},
"description": "The ‘asc’ parameter allows you to sort the list of stacks in an organization in the ascending order."
},
{
"name": "desc",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "string",
"example": "field_uid"
},
"description": "The ‘desc’ parameter allows you to sort the list of stacks in an organization in the descending order."
},
{
"name": "include_count",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "string",
"example": "false"
},
"description": "The ‘include_count’ parameter returns the total number of stacks in an organization. Example: If you wish to know the total number of stacks in your organization, you need to mention ‘true’."
},
{
"name": "typeahead",
"in": "query",
"required": true,
"style": "form",
"schema": {
"type": "string",
"example": "Aravind"
},
"description": "The ‘typeahead’ parameter allows you to perform a name-based search on all the stacks on an organization based on the value provided."
},
{
"name": "authtoken",
"in": "header",
"required": false,
"style": "simple",
"schema": {
"type": "string",
"example": "{{authtoken}}"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"name": "organization_uid",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "organization_uid"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {}
}
},
"tags": [
"Organizations"
]
}
},
"/v3/organizations/{organization_uid}/logs": {
"get": {
"summary": "Get organization log details",
"description": "<p>The <span class=\"code\">Get organization log details</span> request is used to retrieve the audit log details of an organization. <br><p>To use the API Request, you will need to authenticate yourself either with a <a href=\"https://www.contentstack.com/docs/developers/create-tokens/about-management-tokens\">Management Token (highly recommended)</a> or an <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#how-to-get-authtoken\">Authtoken.</a> <br>Read more about it in <a href=\"https://www.contentstack.com/docs/developers/apis/content-management-api/#authentication\">Authentication.</a>\n</p><br>\n For more information, refer to the <a href=www.contentstack.com/docs/developers/apis/content-management-api/#organization-logs>Organization Logs</a> API Reference document",
"operationId": "Getorganizationlogdetails",
"parameters": [
{
"name": "authtoken",
"in": "header",
"required": false,
"style": "simple",
"schema": {
"type": "string",
"example": "{{authtoken}}"
}
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "application/json"
}
},
{
"name": "organization_uid",
"in": "path",
"required": true,
"style": "simple",