This is a design document for deprovisioning support in Grouper. Comments welcome.
Deprovisioning in Grouper allows a deprovisioning administrator to see someone's access and instantly remove it. It would also help notify application administrators where grouper is not the system of record.
The Grouper UI has screens for deprovisioning.
Configuration in grouper.base.properties
Identify the deprovisioning managers and add them to the "deprovisioning.managers.must.be.in.group", aka: <yourEtcPrefixHere>:deprovisioning:managersWhoCanDeprovision
See the users who have been deprovisioned
Use the menu to deprovision a user
Search for a user to deprovision
Search results show the right subject sources
See the user's access, add some notes, and deprovision them
- Users of this screen would need to be in a certain group. Grouper admins would also be allowed to use this page
- Note: users of this screen would effectively have a lot of access in grouper. They can pull up any subjects and see what they have. They can remove most things. But they do not have to be Grouper admins. This screen could be used by an HR person.
- This screen could be disabled if an institution does not want it.
- The screen would have a subject lookup for someone to be deprovisioned
- When submitting that combobox, all the assignments in grouper would display, as well as deprovisioned status
- A button "Deprovision user and remove access" adds the user to a built-in group for people who will be deprovisioned.
- This group has a membership expiry for a certain configured amount of time (2 weeks is the default)
- This group can be used in "exclude" groups or rules in grouper for lockouts
- Note, some institutions might already have this "lockout" group
- Assignments on screen will include direct memberships, privileges, and attribute assignments
- Note, permissions are assigned on roles or memebrships in roles so those would not be shown but they would be removed
- The screen will have checkbox about assignments to deprovision
- There could be a way to see effective as well as immediate assignments, though it will default to immediate (ones you can deprovision)
- There is a "check all" and "uncheck all" button
- An "unassign" button will remove all those assignments
- Assignments are in point in time so they can be restored later or migrated to another user
- Groups and folders have attributes related to deprovisioning
- Mark a group or folder as ineligible for deprovisioning (e.g. the lockout group)
- If Grouper is not the system of record for a group, mark a group or folder with attributes so that emails are sent out to application owners to deprovision that user. This would not remove the assignment in grouper because in this case grouper is not the source of the assignment but instead reflects it in another system. The receiver of the email would need to unassign the user and that data would flow back to grouper ater the next load
- e.g. an attribute to say "deprovision_notify_app_owner", an attribute "deprovision_notify_app_owner_email", attribute "deprovision_notify_app_owner_email_subject", "deprovision_notify_app_owner_email_body"
- Attribute keep track of when last emailed so users dont get emailed more than once a day
- There is feature in loader jobs to not load deprovisioned users (without having to adjust the query). Of course loader jobs could be exempt from this if they need deprovisioned users inside. The default would be to not include them
- There is an overall audit and then keep individual audits
- There is a report of deprovisioned users and assignments they still have access to so that followups can be made after a week or two to make sure everything is removed for that user that should be
- There could be a report of inactive users and things they are still assigned to to clean out users who left the institution long ago
- If messaging queues are configured, messages will be sent to deprovision a user
- If someone adds a deprovioned (for 2 weeks) user to a group or privilege or permission, then they will get a warning that the user has been deprovisioned...