Rally-User-Management

License

Warranty

The Rally User Management toolkit is available on an as-is basis.

Support

Rally Software does not actively maintain or support this toolkit. If you have a problem or question, we recommend filing a Github Issue or posting a question to Stack Overflow: http://stackoverflow.com/questions/ask?tags=rally

New Features in Version 0.5.6

grant_everyone_editor_access.rb: script to grant Editor-level to a project of interest, to all enabled Rally users that don't already have it.
grant_everyone_viewer_access.rb: script to grant Viewer-level to a project of interest, to all enabled Rally users that don't already have it.
summarize_project_permissions.rb: script to summarize Permissions for all Users within a Project of interest. Includes Admins - this is an audit-quality script, whereas user_permissions_summary.rb summarizes permissions only for Users that have access.
update_project_permissions.rb: script to update Permissions for all non-Admin users already existing in a Project, to an updated value of interest.
user_permissions_summary_selected.rb: script to summarize permissions only for a select list of users specified in an input CSV file.

Description

The Rally-User-Management kit is an enhanced toolset for Rally subscription administrators who want to bulk create/update users in their Rally subscription, enable/disable users, and assign permissions.

Rally-User-Management provides the following updates and enhancements from the original user_mgmt toolkit:

Updated to use rally_api gem instead of rally_rest_api
rally_api greatly improves speed and reliability.
Provides bulk permission management granular to Projects (original provisioned at Workspace level only)
Provides capability to bulk assign or update team membership

Rally-User-Management requires:

Ruby 1.9.3
rally_api 1.0.1 or higher
You can install rally_api and dependent gems by using:
gem install rally_api

The Rally user management toolkit takes a set of users formatted in a Tab-Delimited text file and performs the following functions:

Creates the users in your Rally subscription if they do not exist, and
Assigns and/or updates permissions to users across workspaces and projects.
Assigns and/or updates team memberships for users across projects
Enables or disables user in your Rally subscription

The contents of this Github repository include:

change_usernames_template.csv - Template file showing format for username/email bulk update mapping
change_usernames.rb - Script to bulk update usernames and email addresses
enable_or_disable_users.rb - Script to bulk enable or disable users
enable_or_disable_users_template.txt - Template file contain list of users to enable/disable
grant_everyone_editor_access.rb - Script to grant Editor-level to a project of interest, to all enabled Rally users that don't already have it.
grant_everyone_viewer_access.rb - Script to grant Viewer-level to a project of interest, to all enabled Rally users that don't already have it.
ldap_username_load.rb - Script to update Onprem Ldap Username field when enabling LDAP for Rally On-Premise
ldap_username_load_template.csv - Template file contain list of Username and OnpremLdapUsername values.
my_vars.rb - User configurable variables
new_user_list_template.txt - Template list of users/attributes you want to create
simple_user_loader.rb - A simplified user loader that creates users directly.
simple_user_loader_template.txt - START HERE! Template file for users, permissions, and attributes used as input to the simple_user_loader.rb script.
update_user_attributes.rb - A script to bulk update standard and extended User Attributes such as Department, CostCenter, Default Workspace/Project, TimeZone.
update_user_attributes_template.txt - Template file for user attribute updates, used as input to the update_user_attributes.rb script
user_loader_from_export.rb - Script to create users from a CSV input file generated by an export from Rally UI.
user_loader_from_export_template.txt - Template file for user attribute updates, used as input to the user_loader_from_export.rb script
user_permissions_loader.rb - Script to upload users and permissions
user_permissions_loader_template.txt - Template file showing what an upload file should look like
user_permissions_summary.rb - Script to output summary of user permissions AND Team Membership for all users
user_permissions_syncer.rb - Script to synchronize permissions and team memberships from a list of existing users in Rally to a list of target users needing updated permissions.
user_permissions_template_generator.rb - Script to generate template of WorkspacePermissions and ProjectPermissions for all users in the new_user_list file
user_sync_template.txt - Template/example file for input to user_permissions_syncer.rb
user_team_membership_summary.rb - Script that summarizes just team membership(s) for all users
README.docx - User guide Word document
README.md - This README
README.pdf - User guide PDF

Please clone the repo and save to a folder on your local drive.

To run the tests for the permissions utility, you will need to make a copy of the example_test_configuration_helper.rb file and update it with your own credentials to use for testing.