This is intended as a reference data point for questions relating to the "most common" or "most heavily used" components of a group service. It represents UW's group service activity from Jan 1 through Jan 27, 2016.
The service's API is mostly described in the swagger doc: UW group service.
A couple of points regrading the usage and resources:
- Everything into or out of the group service goes through the API. There is no behind-the-scenes marshaling of groups or members.
- Group membership is of two types: direct and effective. Effective being all direct members plus all effective members of member groups. The difference is important.
- Direct membership is generally the concern when the group is managed.
- Effective membership is generally the concern when the group is referenced--for authorization, mailing lists, etc.
We use PUT to either create or update a group or its membership.
There was an interesting email thread on the TIER-API list about this data. See subject "group service api usage statistics", January 29, 2016.
Usage statistics for January
this is a test if an entity is an effective member of a group
I suspect some downstream caching of group membership
some of this is automatic updates of course groups and other institutional groups
mostly courses and other automatic, institutional group maintenance
search by effective member
gets all groups by an effective member. Our IdP uses this to populate group membership attributes.
search by stem
one way for people to find all their groups
search by direct member
adds one or more members to a group
test if an entity is a direct member of a group
search by name
a way to find groups, allows wildcard characters
some people apparently clean up after themselves
starting over I suppose