-
Notifications
You must be signed in to change notification settings - Fork 23
Expand file tree
/
Copy pathgroups.json
More file actions
1068 lines (1066 loc) · 36.9 KB
/
groups.json
File metadata and controls
1068 lines (1066 loc) · 36.9 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
{
"apiVersion": "1.0",
"swaggerVersion": "1.2",
"basePath": "https://canvas.instructure.com/api",
"resourcePath": "/groups",
"produces": [
"application/json"
],
"apis": [
{
"path": "/v1/users/self/groups",
"description": "Returns a paginated list of active groups for the current user.",
"operations": [
{
"method": "GET",
"summary": "List your groups",
"notes": "Returns a paginated list of active groups for the current user.",
"nickname": "list_your_groups",
"parameters": [
{
"paramType": "query",
"name": "context_type",
"description": "Only include groups that are in this type of context.",
"type": "string",
"format": null,
"required": false,
"enum": [
"Account",
"Course"
]
},
{
"paramType": "query",
"name": "include",
"description": "- \"tabs\": Include the list of tabs configured for each group. See the\n {api:TabsController#index List available tabs API} for more information.",
"type": "array",
"format": null,
"required": false,
"enum": [
"tabs"
],
"items": {
"type": "string"
}
}
],
"type": "array",
"items": {
"$ref": "Group"
}
}
]
},
{
"path": "/v1/accounts/{account_id}/groups",
"description": "Returns the paginated list of active groups in the given context that are visible to user.",
"operations": [
{
"method": "GET",
"summary": "List the groups available in a context.",
"notes": "Returns the paginated list of active groups in the given context that are visible to user.",
"nickname": "list_groups_available_in_context_accounts",
"parameters": [
{
"paramType": "path",
"name": "account_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "query",
"name": "only_own_groups",
"description": "Will only include groups that the user belongs to if this is set",
"type": "boolean",
"format": null,
"required": false
},
{
"paramType": "query",
"name": "include",
"description": "- \"tabs\": Include the list of tabs configured for each group. See the\n {api:TabsController#index List available tabs API} for more information.",
"type": "array",
"format": null,
"required": false,
"enum": [
"tabs"
],
"items": {
"type": "string"
}
}
],
"type": "array",
"items": {
"$ref": "Group"
}
}
]
},
{
"path": "/v1/courses/{course_id}/groups",
"description": "Returns the paginated list of active groups in the given context that are visible to user.",
"operations": [
{
"method": "GET",
"summary": "List the groups available in a context.",
"notes": "Returns the paginated list of active groups in the given context that are visible to user.",
"nickname": "list_groups_available_in_context_courses",
"parameters": [
{
"paramType": "path",
"name": "course_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "query",
"name": "only_own_groups",
"description": "Will only include groups that the user belongs to if this is set",
"type": "boolean",
"format": null,
"required": false
},
{
"paramType": "query",
"name": "include",
"description": "- \"tabs\": Include the list of tabs configured for each group. See the\n {api:TabsController#index List available tabs API} for more information.",
"type": "array",
"format": null,
"required": false,
"enum": [
"tabs"
],
"items": {
"type": "string"
}
}
],
"type": "array",
"items": {
"$ref": "Group"
}
}
]
},
{
"path": "/v1/groups/{group_id}",
"description": "Returns the data for a single group, or a 401 if the caller doesn't have\nthe rights to see it.",
"operations": [
{
"method": "GET",
"summary": "Get a single group",
"notes": "Returns the data for a single group, or a 401 if the caller doesn't have\nthe rights to see it.",
"nickname": "get_single_group",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "query",
"name": "include",
"description": "- \"permissions\": Include permissions the current user has\n for the group.\n- \"tabs\": Include the list of tabs configured for each group. See the\n {api:TabsController#index List available tabs API} for more information.",
"type": "array",
"format": null,
"required": false,
"enum": [
"permissions",
"tabs"
],
"items": {
"type": "string"
}
}
],
"type": "Group"
}
]
},
{
"path": "/v1/groups",
"description": "Creates a new group. Groups created using the \"/api/v1/groups/\"\nendpoint will be community groups.",
"operations": [
{
"method": "POST",
"summary": "Create a group",
"notes": "Creates a new group. Groups created using the \"/api/v1/groups/\"\nendpoint will be community groups.",
"nickname": "create_group_groups",
"parameters": [
{
"paramType": "form",
"name": "name",
"description": "The name of the group",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "description",
"description": "A description of the group",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "is_public",
"description": "whether the group is public (applies only to community groups)",
"type": "boolean",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "join_level",
"description": "no description",
"type": "string",
"format": null,
"required": false,
"enum": [
"parent_context_auto_join",
"parent_context_request",
"invitation_only"
]
},
{
"paramType": "form",
"name": "storage_quota_mb",
"description": "The allowed file storage for the group, in megabytes. This parameter is\nignored if the caller does not have the manage_storage_quotas permission.",
"type": "integer",
"format": "int64",
"required": false
}
],
"type": "Group"
}
]
},
{
"path": "/v1/group_categories/{group_category_id}/groups",
"description": "Creates a new group. Groups created using the \"/api/v1/groups/\"\nendpoint will be community groups.",
"operations": [
{
"method": "POST",
"summary": "Create a group",
"notes": "Creates a new group. Groups created using the \"/api/v1/groups/\"\nendpoint will be community groups.",
"nickname": "create_group_group_categories",
"parameters": [
{
"paramType": "path",
"name": "group_category_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "name",
"description": "The name of the group",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "description",
"description": "A description of the group",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "is_public",
"description": "whether the group is public (applies only to community groups)",
"type": "boolean",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "join_level",
"description": "no description",
"type": "string",
"format": null,
"required": false,
"enum": [
"parent_context_auto_join",
"parent_context_request",
"invitation_only"
]
},
{
"paramType": "form",
"name": "storage_quota_mb",
"description": "The allowed file storage for the group, in megabytes. This parameter is\nignored if the caller does not have the manage_storage_quotas permission.",
"type": "integer",
"format": "int64",
"required": false
}
],
"type": "Group"
}
]
},
{
"path": "/v1/groups/{group_id}",
"description": "Modifies an existing group. Note that to set an avatar image for the\ngroup, you must first upload the image file to the group, and the use the\nid in the response as the argument to this function. See the\n{file:file_uploads.html File Upload Documentation} for details on the file\nupload workflow.",
"operations": [
{
"method": "PUT",
"summary": "Edit a group",
"notes": "Modifies an existing group. Note that to set an avatar image for the\ngroup, you must first upload the image file to the group, and the use the\nid in the response as the argument to this function. See the\n{file:file_uploads.html File Upload Documentation} for details on the file\nupload workflow.",
"nickname": "edit_group",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "name",
"description": "The name of the group",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "description",
"description": "A description of the group",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "is_public",
"description": "Whether the group is public (applies only to community groups). Currently\nyou cannot set a group back to private once it has been made public.",
"type": "boolean",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "join_level",
"description": "no description",
"type": "string",
"format": null,
"required": false,
"enum": [
"parent_context_auto_join",
"parent_context_request",
"invitation_only"
]
},
{
"paramType": "form",
"name": "avatar_id",
"description": "The id of the attachment previously uploaded to the group that you would\nlike to use as the avatar image for this group.",
"type": "integer",
"format": "int64",
"required": false
},
{
"paramType": "form",
"name": "storage_quota_mb",
"description": "The allowed file storage for the group, in megabytes. This parameter is\nignored if the caller does not have the manage_storage_quotas permission.",
"type": "integer",
"format": "int64",
"required": false
},
{
"paramType": "form",
"name": "members",
"description": "An array of user ids for users you would like in the group.\nUsers not in the group will be sent invitations. Existing group\nmembers who aren't in the list will be removed from the group.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
}
],
"type": "Group"
}
]
},
{
"path": "/v1/groups/{group_id}",
"description": "Deletes a group and removes all members.",
"operations": [
{
"method": "DELETE",
"summary": "Delete a group",
"notes": "Deletes a group and removes all members.",
"nickname": "delete_group",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "Group"
}
]
},
{
"path": "/v1/groups/{group_id}/invite",
"description": "Sends an invitation to all supplied email addresses which will allow the\nreceivers to join the group.",
"operations": [
{
"method": "POST",
"summary": "Invite others to a group",
"notes": "Sends an invitation to all supplied email addresses which will allow the\nreceivers to join the group.",
"nickname": "invite_others_to_group",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "invitees",
"description": "An array of email addresses to be sent invitations.",
"type": "array",
"format": null,
"required": true,
"items": {
"type": "string"
}
}
],
"type": "void"
}
]
},
{
"path": "/v1/groups/{group_id}/users",
"description": "Returns a paginated list of users in the group.",
"operations": [
{
"method": "GET",
"summary": "List group's users",
"notes": "Returns a paginated list of users in the group.",
"nickname": "list_group_s_users",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "query",
"name": "search_term",
"description": "The partial name or full ID of the users to match and return in the\nresults list. Must be at least 3 characters.",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "query",
"name": "include",
"description": "- \"avatar_url\": Include users' avatar_urls.",
"type": "array",
"format": null,
"required": false,
"enum": [
"avatar_url"
],
"items": {
"type": "string"
}
}
],
"type": "array",
"items": {
"$ref": "User"
}
}
]
},
{
"path": "/v1/groups/{group_id}/files",
"description": "Upload a file to the group.\n\nThis API endpoint is the first step in uploading a file to a group.\nSee the {file:file_uploads.html File Upload Documentation} for details on\nthe file upload workflow.\n\nOnly those with the \"Manage Files\" permission on a group can upload files\nto the group. By default, this is anybody participating in the\ngroup, or any admin over the group.",
"operations": [
{
"method": "POST",
"summary": "Upload a file",
"notes": "Upload a file to the group.\n\nThis API endpoint is the first step in uploading a file to a group.\nSee the {file:file_uploads.html File Upload Documentation} for details on\nthe file upload workflow.\n\nOnly those with the \"Manage Files\" permission on a group can upload files\nto the group. By default, this is anybody participating in the\ngroup, or any admin over the group.",
"nickname": "upload_file",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "void"
}
]
},
{
"path": "/v1/groups/{group_id}/preview_html",
"description": "Preview html content processed for this group",
"operations": [
{
"method": "POST",
"summary": "Preview processed html",
"notes": "Preview html content processed for this group",
"nickname": "preview_processed_html",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "html",
"description": "The html content to process",
"type": "string",
"format": null,
"required": false
}
],
"type": "void"
}
]
},
{
"path": "/v1/groups/{group_id}/activity_stream",
"description": "Returns the current user's group-specific activity stream, paginated.\n\nFor full documentation, see the API documentation for the user activity\nstream, in the user api.",
"operations": [
{
"method": "GET",
"summary": "Group activity stream",
"notes": "Returns the current user's group-specific activity stream, paginated.\n\nFor full documentation, see the API documentation for the user activity\nstream, in the user api.",
"nickname": "group_activity_stream",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "void"
}
]
},
{
"path": "/v1/groups/{group_id}/activity_stream/summary",
"description": "Returns a summary of the current user's group-specific activity stream.\n\nFor full documentation, see the API documentation for the user activity\nstream summary, in the user api.",
"operations": [
{
"method": "GET",
"summary": "Group activity stream summary",
"notes": "Returns a summary of the current user's group-specific activity stream.\n\nFor full documentation, see the API documentation for the user activity\nstream summary, in the user api.",
"nickname": "group_activity_stream_summary",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "void"
}
]
},
{
"path": "/v1/groups/{group_id}/memberships",
"description": "A paginated list of the members of a group.",
"operations": [
{
"method": "GET",
"summary": "List group memberships",
"notes": "A paginated list of the members of a group.",
"nickname": "list_group_memberships",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "query",
"name": "filter_states",
"description": "Only list memberships with the given workflow_states. By default it will\nreturn all memberships.",
"type": "array",
"format": null,
"required": false,
"enum": [
"accepted",
"invited",
"requested"
],
"items": {
"type": "string"
}
}
],
"type": "array",
"items": {
"$ref": "GroupMembership"
}
}
]
},
{
"path": "/v1/groups/{group_id}/memberships/{membership_id}",
"description": "Returns the group membership with the given membership id or user id.",
"operations": [
{
"method": "GET",
"summary": "Get a single group membership",
"notes": "Returns the group membership with the given membership id or user id.",
"nickname": "get_single_group_membership_memberships",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "membership_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "GroupMembership"
}
]
},
{
"path": "/v1/groups/{group_id}/users/{user_id}",
"description": "Returns the group membership with the given membership id or user id.",
"operations": [
{
"method": "GET",
"summary": "Get a single group membership",
"notes": "Returns the group membership with the given membership id or user id.",
"nickname": "get_single_group_membership_users",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "user_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "GroupMembership"
}
]
},
{
"path": "/v1/groups/{group_id}/memberships",
"description": "Join, or request to join, a group, depending on the join_level of the\ngroup. If the membership or join request already exists, then it is simply\nreturned",
"operations": [
{
"method": "POST",
"summary": "Create a membership",
"notes": "Join, or request to join, a group, depending on the join_level of the\ngroup. If the membership or join request already exists, then it is simply\nreturned",
"nickname": "create_membership",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "user_id",
"description": "no description",
"type": "string",
"format": null,
"required": false
}
],
"type": "GroupMembership"
}
]
},
{
"path": "/v1/groups/{group_id}/memberships/{membership_id}",
"description": "Accept a membership request, or add/remove moderator rights.",
"operations": [
{
"method": "PUT",
"summary": "Update a membership",
"notes": "Accept a membership request, or add/remove moderator rights.",
"nickname": "update_membership_memberships",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "membership_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "workflow_state",
"description": "Currently, the only allowed value is \"accepted\"",
"type": "string",
"format": null,
"required": false,
"enum": [
"accepted"
]
},
{
"paramType": "form",
"name": "moderator",
"description": "no description",
"type": "string",
"format": null,
"required": false
}
],
"type": "GroupMembership"
}
]
},
{
"path": "/v1/groups/{group_id}/users/{user_id}",
"description": "Accept a membership request, or add/remove moderator rights.",
"operations": [
{
"method": "PUT",
"summary": "Update a membership",
"notes": "Accept a membership request, or add/remove moderator rights.",
"nickname": "update_membership_users",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "user_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "workflow_state",
"description": "Currently, the only allowed value is \"accepted\"",
"type": "string",
"format": null,
"required": false,
"enum": [
"accepted"
]
},
{
"paramType": "form",
"name": "moderator",
"description": "no description",
"type": "string",
"format": null,
"required": false
}
],
"type": "GroupMembership"
}
]
},
{
"path": "/v1/groups/{group_id}/memberships/{membership_id}",
"description": "Leave a group if you are allowed to leave (some groups, such as sets of\ncourse groups created by teachers, cannot be left). You may also use 'self'\nin place of a membership_id.",
"operations": [
{
"method": "DELETE",
"summary": "Leave a group",
"notes": "Leave a group if you are allowed to leave (some groups, such as sets of\ncourse groups created by teachers, cannot be left). You may also use 'self'\nin place of a membership_id.",
"nickname": "leave_group_memberships",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "membership_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "void"
}
]
},
{
"path": "/v1/groups/{group_id}/users/{user_id}",
"description": "Leave a group if you are allowed to leave (some groups, such as sets of\ncourse groups created by teachers, cannot be left). You may also use 'self'\nin place of a membership_id.",
"operations": [
{
"method": "DELETE",
"summary": "Leave a group",
"notes": "Leave a group if you are allowed to leave (some groups, such as sets of\ncourse groups created by teachers, cannot be left). You may also use 'self'\nin place of a membership_id.",
"nickname": "leave_group_users",
"parameters": [
{
"paramType": "path",
"name": "group_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "user_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "void"
}
]
}
],
"models": {
"Group": {
"id": "Group",
"description": "",
"required": [
],
"properties": {
"id": {
"description": "The ID of the group.",
"example": 17,
"type": "integer"
},
"name": {
"description": "The display name of the group.",
"example": "Math Group 1",
"type": "string"
},
"description": {
"description": "A description of the group. This is plain text.",
"type": "string"
},
"is_public": {
"description": "Whether or not the group is public. Currently only community groups can be made public. Also, once a group has been set to public, it cannot be changed back to private.",
"example": false,
"type": "boolean"
},
"followed_by_user": {
"description": "Whether or not the current user is following this group.",
"example": false,
"type": "boolean"
},
"join_level": {
"description": "How people are allowed to join the group. For all groups except for community groups, the user must share the group's parent course or account. For student organized or community groups, where a user can be a member of as many or few as they want, the applicable levels are 'parent_context_auto_join', 'parent_context_request', and 'invitation_only'. For class groups, where students are divided up and should only be part of one group of the category, this value will always be 'invitation_only', and is not relevant. * If 'parent_context_auto_join', anyone can join and will be automatically accepted. * If 'parent_context_request', anyone can request to join, which must be approved by a group moderator. * If 'invitation_only', only those how have received an invitation my join the group, by accepting that invitation.",
"example": "invitation_only",
"type": "string",
"allowableValues": {
"values": [
"parent_context_auto_join",
"parent_context_request",
"invitation_only"
]
}
},
"members_count": {
"description": "The number of members currently in the group",
"example": 0,
"type": "integer"
},
"avatar_url": {
"description": "The url of the group's avatar",
"example": "https://<canvas>/files/avatar_image.png",
"type": "string"
},
"context_type": {
"description": "The course or account that the group belongs to. The pattern here is that whatever the context_type is, there will be an _id field named after that type. So if instead context_type was 'account', the course_id field would be replaced by an account_id field.",
"example": "Course",
"type": "string"
},
"course_id": {
"example": 3,
"type": "integer"
},
"role": {
"description": "Certain types of groups have special role designations. Currently, these include: 'communities', 'student_organized', and 'imported'. Regular course/account groups have a role of null.",
"type": "string",
"allowableValues": {
"values": [
"communities",
"student_organized",
"imported"
]
}
},
"group_category_id": {
"description": "The ID of the group's category.",
"example": 4,
"type": "integer"
},
"sis_group_id": {
"description": "The SIS ID of the group. Only included if the user has permission to view SIS information.",
"example": "group4a",
"type": "string"
},
"sis_import_id": {
"description": "The id of the SIS import if created through SIS. Only included if the user has permission to manage SIS information.",
"example": 14,
"type": "integer"
},
"storage_quota_mb": {
"description": "the storage quota for the group, in megabytes",
"example": 50,
"type": "integer"
},
"permissions": {