Skip to content

Commit

Permalink
Minor updates to README.md for multi-user option #52
Browse files Browse the repository at this point in the history
  • Loading branch information
astrochun committed Sep 23, 2020
1 parent 0b5d3e4 commit 1699ebb
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,16 +170,16 @@ While the primary use of this software is automated updates through Grouper,
there are additional scripts for handling. One of those pertains to overriding
default changes (e.g., a user's quota, involvement with a specific portal).
To this end, the `user_update` script should be used. It has several features:
1. It can add a given user to a specific group and also remove it from its
previous group assignment
1. It can add a number of users to a specific group and also remove them from
its previous group assignment(s)
2. It will update the appropriate CSV files. This ensures that the changes
stay when the automated script `script_run` is executed.
3. It has the ability to move a user to the "main" or "root" portal
4. It has a number of built-in error handling to identify possible input error.
This includes:
a. A username that is not valid
b. A Grouper group that does not exist
c. Prevent any action if the user belongs to the specified group
- A username that is not valid
- A Grouper group that does not exist
- Prevent any action if the user belongs to the specified group

Execution can be done as follows:

Expand All @@ -193,7 +193,7 @@ Execution can be done as follows:
Here, the script will update the specified `<username>` to be associated with
the `123456` quota and the `testportal` portal. Much like `script_run`,
execution requires the `--sync` flag. Otherwise, a list of changes will be
provided. Note that `<username>` can be a list of comma-separated users
provided. Note: `<username>` can be a list of comma-separated users
(e.g., `user1,user2,user3`) or a .txt file with each username on a new line.
```
user1
Expand Down

0 comments on commit 1699ebb

Please sign in to comment.