Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview

The User Management page is a section in the Syndeia Cloud web admin portal app to allow Syndeia Cloud administrators to manager users in Syndeia Cloud. Specifically it will allow you to:

  • List (get) users,
  • Create (add) users,
  • Update permissions,
  • Update permissions in bulk,
  • Disable/Enable users,
  • Reset user passwords

Minimum Requirements

You must have a web browser capable of running Ecmascript ("Javascript") v6+ , ex:  Chrome v76+, Firefox v77+, or Edge v77+ installed


Usage

1. To access the User Management page, launch a web browser and navigate to http(s)://<your_syndeia_cloud_FQDN>:<port>/user-management , where <your_syndeia_cloud_FQDN> = your admin portal URL, ex: mycompany.domain.com and <port> = 9000 | 9443 (for HTTPS).  

(info) Note, you can also navigate to the root URL and once logged in, click on the Users icon on the left sidebar.   

2. Login with a Syndeia Cloud user that has an Admin Role, ex: super.user.  You should see a list of users enumerated, or a page similar to the following:

(info) Note, a Syndeia Cloud administrator is user that has Role = Admin and should (at a minimum) have the one or more of the following permissions:  

  • USER_CREATE
  • USER_READ
  • USER_MODIFY
  • USER_REMOVE

  


To create (add) a new user

3. Click the Add a user button 

4. Fill out the form as required.  

(info) The following is a description of the Permissions that are currently available:

Permission ValueDescription

CONTAINER_CREATE

Create Syndeia Project container permission

CONTAINER_MODIFY

Syndeia Project container modification permission

CONTAINER_DELETESyndeia Project container deletion permission

REPOSITORY_CREATE

Create repository permission

REPOSITORY_MODIFY

Repository modification permission

REPOSITORY_DELETE

Repository deletion permission

TYPE_CREATE

Create (repository, container, artifact or relation) type permission

TYPE_MODIFY

(Repository, container, artifact or relation) Type modification permission

TYPE_DELETE

(Repository, container, artifact or relation) Type deletion permission

USER_CREATE

Create user permission

USER_READ

User read permission

USER_MODIFY

User modification permission

USER_REMOVE

User remove permission

ARTIFACT_RELATION_WRITE

Artifact & relation write permission

READ

Read permission for artifacts, relations, containers, and repositories

(warning) Note, currently this form does not show the READ permission, we do not recommend removing this permission directly via the API if any others are enabled.  

(for definitions of the concepts repository, container, artifact, and relation, see the conceptual model)

(info) The following is a description of the possible Role value combinations:

Role ValueDescription
AdminAdmin Role- allows access to the User Management page
UserUser Role- doesn't have access to the User Management page
Admin, UserAdmin & User Role - Allows access to User Management page

5. Click Save to create (add) a new user (or Cancel to cancel).


To Update permissions

6. Click on the specified username and you should get a form window with a set of attributes / fields you can update for that user:

7. Update the desired attributes / fields.

(info) To see a description of each permission, see how To create (add) a new user

8. Click Save to update or (or Cancel to cancel).


To Update permissions in bulk

9. Click on the checkboxes next to each username you wish to update.  

10. Click the button, you should get a form window with a set of permissions you can update in bulk for those users:  

(warning) Note, this form (currently) does not indicate the current resultant boolean permission state for all users for each checkbox.

11. Update the desired attributes / fields.

(info) To see a description of each permission, see how To create (add) a new user

12. Click OK to update or (or Cancel to cancel).


To disable a user

13. Click on the specified username and you should get the Update user page.  


14. Click the Disable user button  on the left.  You should get another page asking for confirmation:  

15. Click Disable User to disable the user (or Cancel to cancel).


To enable a user

16. Click on the specified username and you should get the Update user page.  

17. Click the Enable user button  on the left.  You should get another page asking for confirmation and to set the new password:  

18. Type the new password then click Enable User to enable the user (or Cancel to cancel).


To reset user passwords

19. Click on the specified username and you should get the Update user page.  

20. Click on the Reset Password button   You should get a another page with a prompt for the new password:  

(info) 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 (see REST API for more details).  

21. In the New Password field, enter the new password.
22. Click Submit to reset to the new password (or Cancel to cancel).

  • No labels