-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.json
5891 lines (5891 loc) · 221 KB
/
swagger.json
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
{
"swagger": "2.0",
"info": {
"version": "0.1.0",
"title": "agol-swagger"
},
"host": "www.arcgis.com",
"basePath": "/",
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"securityDefinitions": {
"agol_oauth_implicit": {
"type": "oauth2",
"authorizationUrl": "/sharing/rest/oauth2/authorize?client_id=YOUR_APPLICATIONS_CLIENT_ID&response_type=token&expiration=20160&redirect_uri=A_REDIRECT_URI_FOR_YOUR_APPLICATION",
"flow": "implicit",
"description": "AGOL OAuth Implicit Authentication - Browser-based User Logins https://developers.arcgis.com/authentication/browser-based-user-logins/",
"scopes": {
"read:getPortalSelf": "reads getPortalSelf",
"read:getPortalResources": "reads getPortalResources",
"read:getPortalServers": "reads getPortalServers",
"read:getPortalUsers": "reads getPortalUsers",
"read:getPortalServer": "reads getPortalServer",
"read:getItemComments": "reads getItemComments",
"read:getItemComment": "reads getItemComment",
"read:getItem": "reads getItem",
"read:getRelatedItems": "reads getRelatedItems",
"read:getItemRating": "reads getItemRating",
"read:getGroup": "reads getGroup",
"read:getGroupApplications": "reads getGroupApplications",
"read:getGroupContent": "reads getGroupContent",
"read:getGroupUsers": "reads getGroupUsers",
"read:getGroupApplication": "reads getGroupApplication",
"read:getUserInvitation": "reads getUserInvitation",
"read:getItemGroups": "reads getItemGroups",
"read:getNotification": "reads getNotification",
"read:getNotifications": "reads getNotifications",
"read:getUserSelf": "reads getUserSelf",
"read:getUser": "reads getUser",
"read:getUserContent": "reads getUserContent",
"read:getUserInvitations": "reads getUserInvitations",
"read:getUserTags": "reads getUserTags",
"post:updateUser": "posts updateUser",
"post:acceptGroupApplication": "posts acceptGroupApplication",
"post:acceptInvitation": "posts acceptInvitation",
"post:addComment": "posts addComment",
"post:addItem": "posts addItem",
"post:addItemPart": "posts addItemPart",
"post:addRating": "posts addRating",
"post:addRelationship": "posts addRelationship",
"post:addUsersToGroup": "posts addUsersToGroup",
"post:createFolder": "posts createFolder",
"post:createGroup": "posts createGroup",
"post:createService": "posts createService",
"post:declineGroupApplication": "posts declineGroupApplication",
"post:declineInvitation": "posts declineInvitation",
"post:deleteComment": "posts deleteComment",
"post:deleteFolder": "posts deleteFolder",
"post:deleteGroup": "posts deleteGroup",
"post:deleteNotification": "posts deleteNotification",
"post:deleteUser": "posts deleteUser",
"post:disableUser": "posts disableUser",
"post:enableUser": "posts enableUser",
"read:groupSearch": "reads groupSearch",
"post:inviteToGroup": "posts inviteToGroup",
"post:joinGroup": "posts joinGroup",
"post:leaveGroup": "posts leaveGroup",
"post:reassignGroup": "posts reassignGroup",
"post:removeUsersFromGroup": "posts removeUsersFromGroup",
"read:search": "reads search",
"read:searchUsers": "reads searchUsers",
"post:updateGroup": "posts updateGroup"
}
}
},
"parameters": {
"f": {
"type": "string",
"description": "The output format can be HTML, JSON, or PJSON. The default is HTML. Search and item comments support RSS as an output format. Values: html, json, pjson",
"default": "pjson",
"name": "f",
"in": "query",
"required": true
},
"token": {
"type": "string",
"description": "Generated by the generateToken call, an access token that identifies the authenticated user and controls access to restricted resources and operations.",
"name": "token",
"in": "query",
"required": true
},
"start": {
"type": "number",
"description": "The number of the first entry in the result set response. The index number is 1-based. The default value of start is 1 (that is, the first search result). The start parameter, along with the num parameter, can be used to paginate the search results. Example: start=11 (return result #11 as the first entry in the response)",
"name": "start",
"in": "query",
"default": 1,
"minimum": 1,
"required": false
},
"num": {
"type": "number",
"description": "The maximum number of results to be included in the result set response. The default value is 10, and the maximum allowed value is 100. The start parameter, along with the num parameter, can be used to paginate the search results. ",
"name": "num",
"in": "query",
"default": 10,
"maximum": 100,
"minimum": 0,
"required": false
},
"q": {
"name": "q",
"type": "string",
"description": "The query string to search the groups against. See Search reference for advanced options. Example: q=arcgis+online. Search reference http://resources.arcgis.com/en/help/arcgis-rest-api/#/Search_reference/02r3000000mn000000/",
"in": "query"
},
"sortField": {
"name": "sortField",
"type": "string",
"description": "Field to sort by. The allowed field names are title, owner, and created.",
"in": "query",
"enum": [
"title",
"owner",
"created"
]
},
"sortOrder": {
"name": "sortOrder",
"type": "string",
"description": "Describes whether order returns in ascending or descending order. Default is ascending.",
"in": "query",
"enum": [
"asc",
"desc"
]
},
"bbox": {
"type": "string",
"description": "The bounding box for a spatial search defined as minx, miny, maxx, or maxy. Search requires q, bbox, or both. Spatial search is an overlaps/intersects function of the query bbox and the extent of the document. Documents that have no extent (e.g., mxds, 3dds, lyr) will not be found when doing a bbox search. Document extent is assumed to be in the WGS84 geographic coordinate system. Example: bbox=-118,32,-116,34",
"name": "bbox",
"in": "query",
"required": false
},
"portalId": {
"name": "portalId",
"in": "path",
"description": "Id of the portal",
"required": true,
"type": "string"
},
"serverId": {
"name": "serverId",
"in": "path",
"description": "Id of the server",
"required": true,
"type": "string"
},
"itemId": {
"name": "itemId",
"in": "path",
"description": "Id of the item",
"required": true,
"type": "string"
},
"groupId": {
"name": "groupId",
"in": "path",
"description": "Id of the group",
"required": true,
"type": "string"
},
"userName": {
"name": "userName",
"in": "path",
"description": "Name of the user",
"required": true,
"type": "string"
},
"applicationUsername": {
"name": "applicationUsername",
"in": "path",
"description": "Name of the user applying to join the group",
"required": true,
"type": "string"
},
"invitationId": {
"name": "invitationId",
"in": "path",
"description": "The ID of the invitation",
"required": true,
"type": "string"
},
"commentId": {
"name": "commentId",
"in": "path",
"description": "Id of the comment",
"required": true,
"type": "string"
},
"folderId": {
"name": "folderId",
"in": "path",
"description": "Id of the folder",
"required": true,
"type": "string"
},
"notificationId": {
"name": "notificationId",
"in": "path",
"description": "Id of the notification",
"required": true,
"type": "string"
},
"groupCommonParameters": {
"description": "Common parameters for creating and updating group information",
"in": "body",
"name": "groupCommonParameters",
"required": true,
"schema": {
"$ref": "#/definitions/groupCommonParameters"
}
},
"inviteDetails": {
"description": "Details for inviting users to a group",
"in": "body",
"name": "inviteDetails",
"required": true,
"schema": {
"$ref": "#/definitions/inviteDetails"
}
},
"partDetails": {
"description": "Details for adding an item part",
"in": "body",
"name": "partDetails",
"required": true,
"schema": {
"$ref": "#/definitions/partDetails"
}
},
"itemDetails": {
"description": "Details for adding an item",
"in": "body",
"name": "itemDetails",
"required": true,
"schema": {
"$ref": "#/definitions/itemDetails"
}
},
"serviceDetails": {
"description": "Details for creating a service",
"in": "body",
"name": "serviceDetails",
"required": true,
"schema": {
"$ref": "#/definitions/serviceDetails"
}
},
"tokenDetails": {
"description": "Details for generating a token",
"in": "body",
"name": "tokenDetails",
"required": true,
"schema": {
"$ref": "#/definitions/tokenDetails"
}
}
},
"paths": {
"/sharing/rest": {
"x-swagger-router-controller": "getOrgRoot",
"get": {
"summary": "Root",
"externalDocs": {
"description": "Managing your organization > Portals > Root",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Root/02r30000009t000000/"
},
"description": "The Root resource only returns the version of the containing portal. It acts as a root to its child resources and operations. To obtain descriptive information about this portal including its name, logo, featured items, and supported protocols (HTTP vs HTTPS), access the Self resource under Portals.",
"operationId": "getOrgRoot",
"security": [ ],
"parameters": [
{
"$ref": "#/parameters/f"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/getOrgRoot"
}
}
}
}
},
"/sharing/rest/community/createGroup": {
"x-swagger-router-controller": "createGroup",
"post": {
"summary": "Create Group",
"externalDocs": {
"description": "Managing your organization > Community > Create Group",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Create_Group/02r30000009w000000/"
},
"description": "The Create Group operation (POST only) creates a new group in the Portal community. Only authenticated users can create groups. The user who creates the group automatically becomes the owner of the group. The owner of the group is automatically an administrator of the group. The calling user provides the title for the group, while the group ID is generated by the system.",
"operationId": "createGroup",
"security": [
{
"agol_oauth_implicit": [
"post:createGroup"
]
}
],
"parameters": [
{
"$ref": "#/parameters/groupCommonParameters"
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/createFolder"
}
}
}
}
},
"/sharing/rest/community/groups": {
"x-swagger-router-controller": "groupSearch",
"get": {
"summary": "Group Search",
"externalDocs": {
"description": "Managing your organization > Community > Group Search",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Group_Search/02r3000000m1000000/"
},
"description": "The Group Search operation searches for groups in the portal. The search index is updated whenever groups and organizations are created, updated, or deleted. There can be a lag between the time that a group is updated and the time when it's reflected in the search results. The results only contain groups that the user has permission to access. Care should be taken when using ArcGIS REST API search operations (search, user search, group search) to find items, groups, and users programmatically. The Portal uses a powerful search engine to index information and to allow full text searching on it. This search engine uses many different inputs to find the appropriate results and rank them. This often makes search 'fuzzy', making it ideal for human interaction, but not necessarily ideal for looking for specific records programmatically. Developers should avoid using search to find specific items (e.g. by title) as the results of these types of queries might change as the search engine evolves.",
"operationId": "groupSearch",
"security": [
{
"agol_oauth_implicit": [
"read:groupSearch"
]
}
],
"parameters": [
{
"$ref": "#/parameters/q"
},
{
"$ref": "#/parameters/start"
},
{
"$ref": "#/parameters/num"
},
{
"$ref": "#/parameters/sortField"
},
{
"$ref": "#/parameters/sortOrder"
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/groupSearch"
}
}
}
}
},
"/sharing/rest/community/groups/{groupId}": {
"x-swagger-router-controller": "getGroup",
"get": {
"summary": "Group",
"externalDocs": {
"description": "Managing your organization > Community > Group",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Group/02r30000006m000000/"
},
"description": " The Group resource represents a group (for example, San Bernardino Fires) within the portal. The owner is automatically an administrator and is returned in the list of admins. Administrators can invite, add to, or remove members from a group as well as update or delete the group. The administrator for an organization can also reassign the group to another member of the organization. Group members can leave the group. Authenticated users can apply to join a group unless the group is by invitation only. The visibility of the group by other users is determined by the access property. If the group is private, no one other than the administrators and members of the group will be able to see it. If the group is shared with an organization, all members of the organization will be able to find it",
"operationId": "getGroup",
"security": [
{
"agol_oauth_implicit": [
"read:getGroup"
]
}
],
"parameters": [
{
"$ref": "#/parameters/groupId"
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/getGroup"
}
}
}
}
},
"/sharing/rest/community/groups/{groupId}/invite": {
"x-swagger-router-controller": "inviteToGroup",
"post": {
"summary": "Invite to Group",
"externalDocs": {
"description": "Managing your organization > Community > Invite to Group",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Invite_to_Group/02r30000006v000000/"
},
"description": "A group administrator can invite users to join their group using the Invite to Group operation. This creates a new user invitation, which the users accept or decline. The role of the user and the invitation expiration date can be set in the invitation. A notification is created for the user indicating that they were invited to join the group. Available only to authenticated users. ",
"operationId": "inviteToGroup",
"security": [
{
"agol_oauth_implicit": [
"post:inviteToGroup"
]
}
],
"parameters": [
{
"$ref": "#/parameters/groupId"
},
{
"$ref": "#/parameters/inviteDetails"
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/inviteToGroup"
}
}
}
}
},
"/sharing/rest/community/groups/{groupId}/addUsers": {
"x-swagger-router-controller": "addUsersToGroup",
"post": {
"summary": "Add Users to Group",
"externalDocs": {
"description": "Managing your organization > Community > Add Users to Group",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Add_Users_to_Group/02r3000002mr000000/"
},
"description": "The operation to Add Users to Group (POST only) is available only to the group administrators, including the owner, and to the administrator of the organization if the user is a member. Both users and admins can be added using this operation. This is useful if you wish to add users directly within an organization without requiring them to accept an invitation. For example, a member of an organization can add only other organization members but not public users",
"operationId": "addUsersToGroup",
"security": [
{
"agol_oauth_implicit": [
"post:addUsersToGroup"
]
}
],
"parameters": [
{
"$ref": "#/parameters/groupId"
},
{
"name": "users",
"in": "body",
"description": "A comma-separated list of usernames (both admins and regular users) to be added to the group. Example: users=regularusername1,adminusername1,adminusername2,regularusername2",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/addUsersToGroup"
}
}
}
}
},
"/sharing/rest/community/groups/{groupId}/applications": {
"x-swagger-router-controller": "getGroupApplications",
"get": {
"summary": "Group Applications",
"externalDocs": {
"description": "Managing your organization > Community > Group Applications",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Group_Applications/02r300000068000000/"
},
"description": "Lists the group applications for the given group. Available to administrators of the group or administrators of an organization if the group is part of one",
"operationId": "getGroupApplications",
"security": [
{
"agol_oauth_implicit": [
"read:getGroupApplications"
]
}
],
"parameters": [
{
"$ref": "#/parameters/groupId"
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/getGroupApplications"
}
}
}
}
},
"/sharing/rest/community/groups/{groupId}/applications/{applicationUsername}": {
"x-swagger-router-controller": "getGroupApplication",
"get": {
"summary": "Group Application",
"externalDocs": {
"description": "Managing your organization > Community > Group Application",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Group_Application/02r30000006r000000/"
},
"description": "When an individual user applies to join a group, a group application is created. The group administrators can accept or decline the application. Available only to the group administrators and the administrator of the organization if the group belongs to an organization",
"operationId": "getGroupApplication",
"security": [
{
"agol_oauth_implicit": [
"read:getGroupApplication"
]
}
],
"parameters": [
{
"$ref": "#/parameters/groupId"
},
{
"$ref": "#/parameters/applicationUsername"
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/getGroupApplication"
}
}
}
}
},
"/sharing/rest/community/groups/{groupId}/applications/{applicationUsername}/accept": {
"x-swagger-router-controller": "acceptGroupApplication",
"post": {
"summary": "Accept Group Application",
"externalDocs": {
"description": "Managing your organization > Community > Accept Group Application",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Accept_Group_Application/02r300000069000000/"
},
"description": "When a user applies to join a group, a group application is created. Group administrators choose to accept this application using the Accept Group Application operation (POST only). This operation adds the applying user to the group then deletes the application. This operation also creates a notification for the user indicating that the user's group application was accepted. Available only to group owners and admins",
"operationId": "acceptGroupApplication",
"security": [
{
"agol_oauth_implicit": [
"post:acceptGroupApplication"
]
}
],
"parameters": [
{
"$ref": "#/parameters/groupId"
},
{
"$ref": "#/parameters/applicationUsername"
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/acceptGroupApplication"
}
}
}
}
},
"/sharing/rest/community/groups/{groupId}/applications/{applicationUsername}/decline": {
"x-swagger-router-controller": "declineGroupApplication",
"post": {
"summary": "Decline Group Application",
"externalDocs": {
"description": "Managing your organization > Community > Decline Group Application",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Decline_Group_Application/02r30000006q000000/"
},
"description": "When a user applies to join a group, a group application is created. Group administrators can decline this application using the Decline Group Application operation (POST only). This operation deletes the application and creates a notification for the user indicating that the user's group application was declined. The applying user will not be added to the group. Available only to group owners and admins",
"operationId": "declineGroupApplication",
"security": [
{
"agol_oauth_implicit": [
"post:declineGroupApplication"
]
}
],
"parameters": [
{
"$ref": "#/parameters/groupId"
},
{
"$ref": "#/parameters/applicationUsername"
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/declineGroupApplication"
}
}
}
}
},
"/sharing/rest/community/groups/{groupId}/delete": {
"x-swagger-router-controller": "deleteGroup",
"post": {
"summary": "Delete Group",
"externalDocs": {
"description": "Managing your organization > Community > Delete Group",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Delete_Group/02r300000070000000/"
},
"description": "The Delete Group operation (POST only) is available only to the group administrators or to the administrator of the organization to which the owner belongs",
"operationId": "deleteGroup",
"security": [
{
"agol_oauth_implicit": [
"post:deleteGroup"
]
}
],
"parameters": [
{
"$ref": "#/parameters/groupId"
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/deleteGroup"
}
}
}
}
},
"/sharing/rest/community/groups/{groupId}/join": {
"x-swagger-router-controller": "joinGroup",
"post": {
"summary": "Join Group",
"externalDocs": {
"description": "Managing your organization > Community > Join Group",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Join_Group/02r30000006n000000/"
},
"description": "Users apply to join a group using the Join Group operation (POST only). This creates a new group application, which the group administrators accept or decline. This operation also creates a notification for the user indicating that they have applied to join this group. Available only to authenticated users. Users can only apply to join groups to which they have access. If the group is private, users will not be able to find it to ask to join it. Information pertaining to the applying user, such as their full name and username, can be sent as part of the group application. ",
"operationId": "joinGroup",
"security": [
{
"agol_oauth_implicit": [
"post:joinGroup"
]
}
],
"parameters": [
{
"$ref": "#/parameters/groupId"
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/joinGroup"
}
}
}
}
},
"/sharing/rest/community/groups/{groupId}/leave": {
"x-swagger-router-controller": "leaveGroup",
"post": {
"summary": "Leave Group",
"externalDocs": {
"description": "Managing your organization > Community > Leave Group",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Leave_Group/02r30000006z000000/"
},
"description": "The Leave Group operation (POST only) is available to all group members other than the group owner. Leaving a group automatically results in the unsharing of all items the user has shared with the group.",
"operationId": "leaveGroup",
"security": [
{
"agol_oauth_implicit": [
"post:leaveGroup"
]
}
],
"parameters": [
{
"$ref": "#/parameters/groupId"
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/leaveGroup"
}
}
}
}
},
"/sharing/rest/community/groups/{groupId}/reassign": {
"x-swagger-router-controller": "reassignGroup",
"post": {
"summary": "Reassign Group",
"externalDocs": {
"description": "Managing your organization > Community > Reassign Group",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Reassign_Group/02r300000067000000/"
},
"description": "The Reassign Group operation (POST only) allows the administrator of an organization to reassign a group to another member of the organization.",
"operationId": "reassignGroup",
"security": [
{
"agol_oauth_implicit": [
"post:reassignGroup"
]
}
],
"parameters": [
{
"$ref": "#/parameters/groupId"
},
{
"name": "targetUsername",
"in": "body",
"description": "The target username of the new owner of the group. Example: organization_username1",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/reassignGroup"
}
}
}
}
},
"/sharing/rest/community/groups/{groupId}/removeUsers": {
"x-swagger-router-controller": "removeUsersFromGroup",
"post": {
"summary": "Remove Users from Group",
"externalDocs": {
"description": "Managing your organization > Community > Remove Users from Group",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Remove_Users_From_Group/02r300000066000000/"
},
"description": "The operation to Remove Users From Group (POST only) is available only to the group administrators, including the owner, and to the administrator of the organization if the user is a member. Both users and admins can be removed using this operation. Group owners cannot be removed from the group.",
"operationId": "removeUsersFromGroup",
"security": [
{
"agol_oauth_implicit": [
"post:removeUsersFromGroup"
]
}
],
"parameters": [
{
"$ref": "#/parameters/groupId"
},
{
"name": "users",
"in": "body",
"description": "A comma-separated list of usernames (both admins and regular users) to be removed from the group. Example: users=regularusername1,adminusername1,adminusername2, regularusername2",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/removeUsersFromGroup"
}
}
}
}
},
"/sharing/rest/community/groups/{groupId}/update": {
"x-swagger-router-controller": "updateGroup",
"post": {
"summary": "Update Group",
"externalDocs": {
"description": "Managing your organization > Community > Update Group",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Update_Group/02r30000006w000000/"
},
"description": "The Update Group operation (POST only) modifies properties such as the group title, tags, description, sort field and order, and member sharing capabilities. Available only to the group administrators or to the administrator of the organization if the user is a member. Only the properties that are to be updated need to be specified in the request. Properties not specified will not be affected. The group ID cannot be modified.",
"operationId": "updateGroup",
"security": [
{
"agol_oauth_implicit": [
"post:updateGroup"
]
}
],
"parameters": [
{
"$ref": "#/parameters/groupId"
},
{
"$ref": "#/parameters/groupCommonParameters"
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/updateGroup"
}
}
}
}
},
"/sharing/rest/community/groups/{groupId}/users": {
"x-swagger-router-controller": "getGroupUsers",
"get": {
"summary": "Group Users",
"externalDocs": {
"description": "Managing your organization > Community > Group Users",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Group_Users/02r30000006p000000/"
},
"description": "Lists the users, owner, and administrators of a given group. Only available to members or administrators of the group",
"operationId": "getGroupUsers",
"security": [
{
"agol_oauth_implicit": [
"read:getGroupUsers"
]
}
],
"parameters": [
{
"$ref": "#/parameters/groupId"
},
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/getGroupUsers"
}
}
}
}
},
"/sharing/rest/community/self": {
"x-swagger-router-controller": "getUserSelf",
"get": {
"summary": "Self",
"externalDocs": {
"description": "Managing your organization > Community > Self",
"url": "http://resources.arcgis.com/en/help/arcgis-rest-api/#/Self/02r300000079000000/"
},
"description": "This resource allows discovery of the current authenticated user identified by the token",
"operationId": "getUserSelf",
"security": [
{
"agol_oauth_implicit": [
"read:getUserSelf"
]
}
],
"parameters": [
{
"$ref": "#/parameters/f"
},
{
"$ref": "#/parameters/token"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/getUser"
}
}
}
}
},