...
- If you want other examples (e.g. using SOAP, using JSON), refer to
- httphttps://anonsvngithub.internet2.educom/viewvcInternet2/viewvc.pygrouper/i2mitree/trunkmaster/grouper-ws/grouper-ws/doc/samples/
After navigating to the desired API, click on the most recent download link (or latest version compatible with 2.1our Grouper version)
- httphttps://anonsvngithub.internet2.educom/viewvcInternet2/viewvc.pygrouper/i2mitree/trunkmaster/grouper-ws/grouper-ws/doc/samples/
- If you want the full documentation about Grouper Web Services:
- https://spaces.internet2.edu/display/Grouper/Grouper+Web+Services
- This is good for a nice functional overview
Avoid getting lost in the REST and SOAP links that take you to Javadoc pages.- Use the Samples link. Click on the most recent download link (or latest version compatible with 2.1our Grouper version)
Substitute Grouper version in examples' URLs with the actual version of the UH Grouper services:
...
For example, to get all members of hawaii.edu:custom:uhm:example-group above, your request URL would be
No Format https://grouper.hawaii.edu/grouper-ws/servicesRest/xml/v2_2_002/groups/hawaii.edu%3Acustom%3Auhm%3Aexample-group/members/
...
Checking if UH Number(s) are members of a Grouper group
- httphttps://anonsvngithub.internet2.edu/cgi-bin/viewvc.cgi/i2mi/trunkcom/Internet2/grouper/blob/master/grouper-ws/grouper-ws/doc/samples/hasMember/WsSampleHasMemberRest_xml.txt?view=log
Listing all members of a Grouper group
- httphttps://anonsvngithub.internet2.edu/cgi-bin/viewvc.cgi/i2mi/trunkcom/Internet2/grouper/blob/master/grouper-ws/grouper-ws/doc/samples/getMembers/WsSampleGetMembersRest_xml.txt?view=log
- There is a lite version (faster, returns less information):
- httphttps://anonsvngithub.internet2.edu/cgi-bin/viewvc.cgi/i2mi/trunkcom/Internet2/grouper/blob/master/grouper-ws/grouper-ws/doc/samples/getMembers/WsSampleGetMembersRestLite_xml.txt?view=log
Adding members to a Grouper group
- httphttps://anonsvngithub.internet2.edu/cgi-bin/viewvc.cgi/i2mi/trunkcom/Internet2/grouper/blob/master/grouper-ws/grouper-ws/doc/samples/addMember/WsSampleAddMemberRest_xml.txt?view=log
- Be sure to use <actAsSubjectLookup> to preserve the actual user who performed the addition. This could be the group admin, or the member opting him/herself in (if allowed).
Deleting members from a Grouper group
- httphttps://anonsvngithub.internet2.edu/cgi-bin/viewvc.cgi/i2mi/trunkcom/Internet2/grouper/blob/master/grouper-ws/grouper-ws/doc/samples/deleteMember/WsSampleDeleteMemberRest_xml.txt?view=log
- Be sure to use <actAsSubjectLookup> to preserve the actual user who performed the deletion. This could be the group admin, or the member opting him/herself out (if allowed).
...
By default, a new folder only has the create-folder privilege granted to the person who created the folder. You need to explicity set the create-group permission for the folder creator:
- httphttps://anonsvngithub.internet2.edu/cgi-bin/viewvc.cgi/i2mi/trunkcom/Internet2/grouper/blob/master/grouper-ws/grouper-ws/doc/samples/assignGrouperPrivileges/WsSampleAssignGrouperPrivilegesRest_xml.txt?view=log
- The value for the create-folder permission is 'stem'
- The value for the create-group permission is 'create'
Getting groups where user has admin privileges
- httphttps://anonsvngithub.internet2.edu/cgi-bin/viewvc.cgi/i2mi/trunkcom/Internet2/grouper/blob/master/grouper-ws/grouper-ws/doc/samples/getGrouperPrivileges/WsSampleGetGrouperPrivilegesListRestLite_list_xml.txt?view=log
- 'privilegeName' => 'admin',
- 'subjectId' => '<uhUuid>',
- 'privilegeType' => 'access'
Getting all groups that a person is a member of
- httphttps://anonsvngithub.internet2.educom/viewvcInternet2/viewvc.pygrouper/i2miblob/trunkmaster/grouper-ws/grouper-ws/doc/samples/getGroups/WsSampleGetGroupsRest_xml.txt?view=log
- subjectId => '<uhUuid>'