User Manager
Overview
The Users Manager is a simple GUI app to allow Syndeia Cloud administrators to manager users in Syndeia Cloud. Specifically it will allow you to:
- List (get) users,
- Create (add) users,
- Delete users,
- Update permissions,
- Reset user passwords
Minimum Requirements
You must have Java JRE or JDK v1.8.0 or > installed
Configuration & Running
Mac OSX
1. Extract the tool to the default application folder, ie: /Applications/Syndeia
Note, this should be bundled with the Syndeia client and extracted already
2. Edit SyndeiaAdmin.sh
and ensure the javaExe
environment variable is set to the correct location where your Java binary is located, ie: /Library/Java/JavaVirtualMachines/jdk1.8.0_161.jdk/Contents/Home/bin/java
/ /Library/Internet Plug-Ins/JavaAppletPlugin.plugin/Contents/Home/bin/java
on OSX.
3. Run SyndeiaAdmin.sh
to launch the tool.
Note, any settings created will be saved in ~/.syndeia/syndeia.settings
Windows
1. Extract the tool to the default application location, ie: %ProgramFiles%\Syndeia
on Windows.
Note, this should be bundled with the Syndeia client and extracted already
2. Edit SyndeiaAdmin.bat
and ensure the java64
environment variable is set to the correct location where your Java binary is located, ie: %ProgramData%\Oracle\Java\javapath\java
.
3. Run SyndeiaAdmin.bat
to launch the tool.
Note, any settings created will be saved in %UserProfile%\.syndeia\syndeia.settings
Usage
When you launch the Users Manager you will see a window similar to the following:
4. Edit the Cloud Store Host and Admin Password fields (and any other fields as appropriate for your configuration) and specify a Syndeia Cloud administrator.
Note, a Syndeia Cloud administrator is user that has (at a minimum) the following permissions:
USER_CREATE
USER_READ
USER_MODIFY
USER_REMOVE
To list the current users
5. Click the Get Users button. You should see a list of users returned similar to the following:
To create (add) a new user
6. Click the Add User button
7. Fill out the form as required.
Note, currently this form will always default to showing the READ permission checked, despite letting you check/uncheck it to add/remove it respectively. While this is a cosmetic UI bug which will be fixed in a subsequent release, we do not recommend removing this permission if any others are enabled.
The following is a description of the permissions that are currently available:
| Create user permission |
| User read permission |
| User modification permission |
| User remove permission |
| Create repository permission |
| Repository modification permission |
| Repository deletion permission |
| Create Syndeia Project container permission |
| Syndeia Project container modification permission |
CONTAINER_DELETE | Syndeia Project container deletion permission |
| Artifact & relation write permission |
| Read permission for artifacts, relations, containers, and repositories |
(for definitions of the concepts repository, container, artifact, and relation, see the conceptual model)
8. Click OK to create (add) a new user (or Cancel to cancel).
To delete a user
9. R-click on the specified user and select Delete. You should get a modal dialog popup asking for confirmation:
10. Click Yes to delete (or No to cancel).
Note, when you delete a user you will still see them listed, this is currently as designed as deleting a user currently just removes all permissions for that user in the database (this is necessary to maintain referential integrity for any historical actions that specific user did, ex: creation/modification of entities).
To Update permissions
11. R-click on the specified user and select Update. You should get a form window with a set of attributes you can update for that user:
12. Update the desired attributes.
To see a description of each permission, see how To create (add) a new user
13. Click OK to update or (or Cancel to cancel).
To reset user passwords
14. R-click on the specified user and select Reset Password. You should get a popup window with a prompt for the new password:
Note, Reset Password is considered an admin-level operation that requires the USER_READ
& USER_MODIFY
permissions. This is distinct from the Change Password operation which does not require any permission and only applies to one's own password.
15. In the Reset Password field, enter the new password.
16. Click OK to update or (or Cancel to cancel).