Python Sample Code for Accessing the Grouper API

The IAM group at CUIT has created sample code that can be used to access the Grouper application at Columbia University using Python. A Grouper service account is required to use the API. Contact the Identity and Access Management group if you want a Grouper service account. In order to use these scripts you must have Python 2.7 (or later) installed on your computer. Follow these steps to run one of the sample scripts.

Download the Python script to your local disk: right-click and select "Save Link As"
Remove the ".txt" at the end of the file name. For example download grouper_add_member.py.txt as grouper_add_member.py
Use a file editor to insert your Grouper service account credentials
- In the grouperWSParameter function near the end of the script insert your service account username and password.
- In the grouperWSParameter function near the end of the script use "return devGrouperURI" to access the development Grouper application or use "return prodGrouperURI" to access the production Grouper application.

Execute the script without command line options to see the usage, for example:

$ python2.7 grouper_add_member.py 
usage: grouper_add_member -m <uni or group> -g <group>
-m   the UNI or group that will be added as a member
-g   the member will be added to this group

Execute the script with command line options, for example:

$ python2.7 grouper_add_member.py -m abc1234 -g cu:app:maillist:basketball_team
abc1234 is now a member of cu:app:maillist:basketball_team

Online documentation for the Grouper Web Service is available here https://spaces.internet2.edu/display/Grouper/Grouper+Web+Services

Python Script	Description
grouper_create_group.py	Create a regular group.
grouper_create_composite_group.py	Create a composite group which can be defined as [group A intersect group B] or [group A minus group B].
grouper_create_folder.py	Create a folder.
grouper_add_member.py	Add group member. The new member can be a UNI or a group.
grouper_add_members.py	Add group members. Add multiple UNIs to a group with one API call.
grouper_add_member_with_expiration.py	Add group member with expiration date and time. The new member can be a UNI or a group. The membership will expire at the specified date and time.
grouper_remove_member.py	Remove group member. The member can be a UNI or a group.
grouper_grant_privilege.py	Grant the specified privilege (admin, read, or update) to the specified group. The privilege can be assigned to a UNI or a group.
grouper_revoke_privilege.py	Revoke the specified privilege (admin, read, or update) for the specified group. The privilege can be revoked for a UNI or a group.
grouper_find_members.py	Display members of the specified group. Each member can be a UNI, group, or external user. Use the member filter to select direct members, indirect members, or all members.
grouper_find_memberships.py	Display members of the specified group. Each member can be a UNI, group, or external user. Use the member filter to select direct members, indirect members, or all members. Member enable flag (T or F) will be displayed for each membership. Membership enable date and disable date will be displayed for each membership.