Skip to content

The whole section User Setup has been updated#56

Closed
srz11d wants to merge 7 commits intodevelopfrom
feature/UpdatedUserGuide1
Closed

The whole section User Setup has been updated#56
srz11d wants to merge 7 commits intodevelopfrom
feature/UpdatedUserGuide1

Conversation

@srz11d
Copy link
Contributor

@srz11d srz11d commented Oct 18, 2024

This updated version includes new sections and screenshots

@srz11d srz11d requested review from a team as code owners October 18, 2024 15:52
@srz11d srz11d requested a review from a team October 18, 2024 15:52
@srz11d srz11d requested review from MikhailAf and eeliane October 18, 2024 15:55
Copy link
Contributor

@eeliane eeliane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've left some comments, but could you please also remove from the repo unused images that you've replaced?

@srz11d srz11d requested a review from eeliane November 4, 2024 13:28
@srz11d
Copy link
Contributor Author

srz11d commented Nov 4, 2024

The section has been updated according to the comments, and the unused images have been deleted.

If a user is not a member of the “Curator” group they are considered as researchers and are able to browse available studies and retrieve data, but not contribute to it.
3. **Adding or Removing Members from a Group:**
* **With Manage Groups Permission:** Users can add or remove members from any group.
* **Without Manage Groups Permission:** Users can add or remove members and edit roles only within groups they belong to.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users can add or remove members and edit roles only within groups they belong to !! only if they are group admins

* **With Manage Groups Permission:** Users can add or remove members from any group.
* **Without Manage Groups Permission:** Users can add or remove members and edit roles only within groups they belong to.
![27Users.png](doc-odm-user-guide/images/27Users.png)
<figcaption>User can add or remove users from groups. Users without Manage groups permission can only remove and add members of groups which they belong to</figcaption>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users without Manage groups permission can only remove and add members of groups which they belong to !! only if they are group admins

![image](doc-odm-user-guide/images/groups.png)
4. **Deleting a Group:**
* **With Manage Groups Permission:** Any user can delete any group through the interface.
* **Without Manage Groups Permission:** Users can only delete groups they are a part of.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users can only delete groups they are a part of !! only if they are group admins

Regardless of your role in your organisation, if you have no groups yet, you can create one by clicking **+ New group**.
In the pop-up window that appears you’ll be asked to give the group a name.
![28Delete.png](doc-odm-user-guide/images/28Delete.png)
<figcaption>Users can delete groups. Users without Manage Groups permission can only delete groups to which they belong.</figcaption>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users without Manage Groups permission can only delete groups to which they belong !! only if they are group admins

1. **Access the SCIM Groups Endpoint:**
* Familiarize yourself with the API endpoints and ensure you have an active token. Refer to the section [Getting an Genestack Token](https://odm.demo.genestack.com/user-docs/user-guide/doc-odm-user-guide/getting-a-genestack-api-token/) to learn more about API tokens and authorization.
* Select the **scimGroups** definition to manage groups.
* To create a new group, choose the endpoint "**Add a new user group**" (/api/v1/scim/Groups).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/api/v1/scim/Groups -> POST /api/v1/scim/Groups

* Select the **scimGroups** definition to manage groups.
* To create a new group, choose the endpoint "**Add a new user group**" (/api/v1/scim/Groups).
![14NewUserGroup.png](doc-odm-user-guide/images/14NewUserGroup.png)
<figcaption>To create a new group, navigate to the endpoint <strong>Add a new user group</strong> (/api/v1/scim/Groups)</figcaption>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/api/v1/scim/Groups -> POST /api/v1/scim/Groups

![40Curator.png](doc-odm-user-guide/images/40Curator.png)
<figcaption>Curators with Manage Group permissions can edit the Curator groups. Users can add and remove users, edit permissions and even delete groups</figcaption>

* **Curators without Manage Groups permissions**: Curators without the permission to manage groups, can still explore and edit data. However, adding or removing users within groups (including the Curator Group) is unavailable
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

However, adding or removing users within groups (including the Curator Group) is unavailable

it's actual only for users from the Curators group who has "group member" role, users with the group admin role can edit user list, change roles and remove group.

* **Curators without Manage Groups permissions**: Curators without the permission to manage groups, can still explore and edit data. However, adding or removing users within groups (including the Curator Group) is unavailable

![31CuratorLim.png](doc-odm-user-guide/images/31CuratorLim.png)
<figcaption>Member of the curator groups but without Manage Groups permissions can still have access to data and curation options, however, users cannot add or remove members</figcaption>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

however, users cannot add or remove members

it's actual only for users from the Curators group who has "group member" role, users with the group admin role can edit user list, change roles and remove group.

![41Share.png](doc-odm-user-guide/images/41Share.png){width=600}
<figcaption>To share a study, open the study of interest and click on the top bar menu. Select Share. A window will open with the available groups to share the study with</figcaption>

**Only owners can share the study**. If a user is a member of the curator group, the user can still access the study and curate data, however, the study cannot be shared with other groups.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the user can still access the study and curate data

only if this study has been shared with any group this user belongs to

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we use this file anywhere here or it can be removed?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we use this file anywhere here or it can be removed?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we use this file anywhere here or it can be removed?

<figcaption>View of the users' profile. This window contains detailed information about the groups you are part of, the capabilities (admin and curator), and the active API tokens</figcaption>

On the opening page you’ll find the following sections:
4. View Existing Tokens and **Create a New Token**. In the new window, you will see any previously created tokens that you can rename or delete if needed. Click on **Create a New Token** to create a new one. Refer to the section [Getting a Genestack API token](https://odm.demo.genestack.com/user-docs/user-guide/doc-odm-user-guide/getting-a-genestack-api-token/) for more information
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to Demo must not be used

@MikhailAf MikhailAf closed this Mar 11, 2025
@MikhailAf MikhailAf deleted the feature/UpdatedUserGuide1 branch March 11, 2025 16:08
@MikhailAf
Copy link
Contributor

All the updates were transfer to PR #101

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants