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 3 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.
Execute the script with the -h option to see the usage, for example:
```
$ python3 grouper_add_member.py -h
```

Execute the script with command line options, for example:

$ python3 grouper_add_member.py -m prod -u abc1234 -g the:target:group
abc1234 is now a member of the:target:group

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

Python Script	Description
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_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_find_groups_direct_members_of.py	Find all groups this user or group is a direct member of.
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_members_with_expiration.py	Display members of the specified group with enable time and disable time. 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_privileges.py	Find all groups for which this user or group has admin, read, or update privileges which are revokable (direct privileges).
grouper_grant_privilege.py	Grant a group privilege to a user or group.
grouper_remove_member.py	Remove group member. The member can be a user or a group.
grouper_revoke_privilege.py	Revoke a group privilege from a user or group.
grouper_uni_exists.py	Find out whether a UNI exists and is valid on dev or prod Grouper.