CINXE.COM

<!DOCTYPE html> <html class="writer-html5" lang="en" data-content_root="../../"> <head> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Administrate Groups and Users — OMERO guide latest documentation</title> <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" /> <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" /> <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" /> <link rel="stylesheet" type="text/css" href="../../_static/theme_overrides.css?v=10dd2d77" />  <script src="../../_static/jquery.js?v=5d32c60e"></script> <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="../../_static/documentation_options.js?v=c6e86fd7"></script> <script src="../../_static/doctools.js?v=888ff710"></script> <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../../_static/js/theme.js"></script> <link rel="index" title="Index" href="../../genindex.html" /> <link rel="search" title="Search" href="../../search.html" /> <link rel="next" title="Prepare data for publication using OMERO" href="data-publication.html" /> <link rel="prev" title="Search for Data" href="search-omero.html" /> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="omero-guides" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/introduction/docs/group-user-management.html" /><meta name="readthedocs-http-status" content="200" /></head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="../../index.html" class="icon icon-home"> OMERO guide </a> <div class="version"> latest </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul class="current"> <li class="toctree-l1 current"><a class="reference internal" href="../../core_features.html">General concepts</a><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="../../upload/docs/index.html">Upload data</a></li> <li class="toctree-l2 current"><a class="reference internal" href="index.html">General Introduction</a><ul class="current"> <li class="toctree-l3"><a class="reference internal" href="data-management.html">Data management and cooperation</a></li> <li class="toctree-l3"><a class="reference internal" href="annotate.html">Annotate Data and Filter using Annotations</a></li> <li class="toctree-l3"><a class="reference internal" href="search-omero.html">Search for Data</a></li> <li class="toctree-l3 current"><a class="current reference internal" href="#">Administrate Groups and Users</a></li> <li class="toctree-l3"><a class="reference internal" href="data-publication.html">Prepare data for publication using OMERO</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../../scripts/docs/index.html">Server-side script</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../../external_tools.html">External Software and OMERO</a></li> <li class="toctree-l1"><a class="reference internal" href="../../api_usage.html">OMERO Application Programming Interfaces</a></li> <li class="toctree-l1"><a class="reference internal" href="../../add_ons.html">Add-ons for OMERO</a></li> <li class="toctree-l1"><a class="reference internal" href="../../web_addons.html">OMERO.web extensions to view data</a></li> <li class="toctree-l1"><a class="reference internal" href="../../write_guide.html">How to write a guide</a></li> <li class="toctree-l1"><a class="reference internal" href="../../example.html">OMERO walkthrough example</a></li> <li class="toctree-l1"><a class="reference internal" href="../../example_facility_manager.html">OMERO walkthrough for facility managers</a></li> <li class="toctree-l1"><a class="reference internal" href="../../training.html">Prepare an OMERO server for training</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="../../index.html">OMERO guide</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item"><a href="../../core_features.html">General concepts</a></li> <li class="breadcrumb-item"><a href="index.html">General Introduction</a></li> <li class="breadcrumb-item active">Administrate Groups and Users</li> <li class="wy-breadcrumbs-aside"> <a href="../../_sources/introduction/docs/group-user-management.rst.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="administrate-groups-and-users"> <h1>Administrate Groups and Users<a class="headerlink" href="#administrate-groups-and-users" title="Link to this heading"></a></h1> <section id="description"> <h2>Description<a class="headerlink" href="#description" title="Link to this heading"></a></h2> <p>This chapter will show how to manage groups and users using the graphical interface in OMERO.web and the command-line interface. Most of the following tasks below can only be done by users with some administrator privileges. We will show:</p> <ul class="simple"> <li><p>How to manage groups, creating and editing a new/existing group.</p></li> <li><p>How to manage users, creating and editing a new/existing user.</p></li> <li><p>How to set up the OMERO server to be able to email all users.</p></li> </ul> </section> <section id="resources"> <h2>Resources<a class="headerlink" href="#resources" title="Link to this heading"></a></h2> <ul class="simple"> <li><p>Documentation:</p> <ul> <li><p><a class="reference external" href="https://docs.openmicroscopy.org/latest/omero/sysadmins/server-permissions.html">https://docs.openmicroscopy.org/latest/omero/sysadmins/server-permissions.html</a></p></li> <li><p><a class="reference external" href="https://docs.openmicroscopy.org/latest/omero/sysadmins/restricted-admins.html">https://docs.openmicroscopy.org/latest/omero/sysadmins/restricted-admins.html</a></p></li> <li><p><a class="reference external" href="https://docs.openmicroscopy.org/omero/latest/sysadmins/cli/usergroup.html">https://docs.openmicroscopy.org/omero/latest/sysadmins/cli/usergroup.html</a></p></li> </ul> </li> <li><p>Script for Command Line User/Group management</p> <ul> <li><p><a class="reference external" href="https://github.com/ome/training-scripts/blob/master/maintenance/scripts/create_groups_users.sh">create_groups_users.sh</a></p></li> </ul> </li> <li><p>File defining the User/Group setup used by the script</p> <ul> <li><p><a class="reference external" href="https://github.com/ome/training-scripts/blob/master/maintenance/scripts/create_groups_users_setup">create_groups_users_setup</a></p></li> </ul> </li> </ul> </section> <section id="setup"> <h2>Setup<a class="headerlink" href="#setup" title="Link to this heading"></a></h2> <p>No setup needed for OMERO.web administration panel (see Web Interface chapter below) except working OMERO.web.</p> <p><strong>Command Line interface installation</strong></p> <p>The installation instructions can be found at <a class="reference external" href="https://docs.openmicroscopy.org/latest/omero/users/cli/installation.html">CLI installation</a>.</p> </section> <section id="step-by-step"> <h2>Step-by-step<a class="headerlink" href="#step-by-step" title="Link to this heading"></a></h2> </section> <section id="administrate-using-the-web-interface"> <h2>Administrate using the Web Interface<a class="headerlink" href="#administrate-using-the-web-interface" title="Link to this heading"></a></h2> <ol class="arabic simple"> <li><p>In your web browser, go to the server address provided.</p></li> <li><p>Log in using the username and password provided.</p></li> <li><p>In the top toolbar, click the <code class="docutils literal notranslate"><span class="pre">Admin</span></code> button <a class="reference internal" href="../../_images/groupsusersadm1.png"><img alt="image0" src="../../_images/groupsusersadm1.png" style="width: 0.75in; height: 0.38542in;" /></a>. Note that the <code class="docutils literal notranslate"><span class="pre">Admin</span></code> button is only available for users with certain privileges: administrators and administrators with restricted privileges. If you are a user or a group owner, navigate to the section <code class="docutils literal notranslate"><span class="pre">Web</span> <span class="pre">Interface:</span> <span class="pre">Users</span> <span class="pre">change</span> <span class="pre">their</span> <span class="pre">own</span> <span class="pre">settings</span></code> below.</p></li> </ol> <section id="web-interface-managing-groups"> <h3><em>Web Interface: Managing Groups</em><a class="headerlink" href="#web-interface-managing-groups" title="Link to this heading"></a></h3> <ol class="arabic simple"> <li><p>Click on the <code class="docutils literal notranslate"><span class="pre">Groups</span></code> tab. You can search for groups if desired.</p></li> <li><p>To create a new Group, click on the <code class="docutils literal notranslate"><span class="pre">Add</span> <span class="pre">new</span> <span class="pre">Group</span></code> button. Note that the <code class="docutils literal notranslate"><span class="pre">Name</span></code> and <code class="docutils literal notranslate"><span class="pre">Permissions</span></code> fields are mandatory.</p></li> <li><p>Click <code class="docutils literal notranslate"><span class="pre">Save</span></code>.</p></li> <li><p>The new group will be shown in the list of Groups.</p></li> <li><p>To edit a Group, click on the <code class="docutils literal notranslate"><span class="pre">Pencil</span></code> button <a class="reference internal" href="../../_images/groupsusersadm2.png"><img alt="image1" src="../../_images/groupsusersadm2.png" style="height: 0.10417in;" /></a>.</p></li> <li><p>You can add or remove members or group’s owners or change group permissions.</p></li> <li><p>Before removing a user from a group, it is preferable to move their data to another group or transfer ownership of their data to another user. Having a data owned by someone who is not a member of the group is not desirable.</p></li> <li><p>Click <code class="docutils literal notranslate"><span class="pre">Save</span></code>.</p></li> </ol> </section> <section id="web-interface-managing-users"> <h3><em>Web Interface: Managing Users</em><a class="headerlink" href="#web-interface-managing-users" title="Link to this heading"></a></h3> <ol class="arabic simple"> <li><p>Click on the <code class="docutils literal notranslate"><span class="pre">Users</span></code> tab.</p></li> <li><p>You can search for users if you wish.</p></li> <li><p>OMERO.web denotes the user categories using small helpful icons:</p> <ul class="simple"> <li><p>Users with administrator privileges have a <code class="docutils literal notranslate"><span class="pre">tools</span></code> icon <a class="reference internal" href="../../_images/groupsusersadm3.png"><img alt="image2" src="../../_images/groupsusersadm3.png" style="width: 0.15625in; height: 0.15625in;" /></a>.</p></li> <li><p>Active users have an icon with <code class="docutils literal notranslate"><span class="pre">blue</span> <span class="pre">circle</span></code> <a class="reference internal" href="../../_images/groupsusersadm4.png"><img alt="image3" src="../../_images/groupsusersadm4.png" style="width: 0.15625in; height: 0.15625in;" /></a>.</p></li> <li><p>Inactive users have a <code class="docutils literal notranslate"><span class="pre">lock</span></code> icon <a class="reference internal" href="../../_images/groupsusersadm5.png"><img alt="image4" src="../../_images/groupsusersadm5.png" style="width: 0.16667in; height: 0.16667in;" /></a>.</p></li> <li><p>LDAP users have a <code class="docutils literal notranslate"><span class="pre">red</span> <span class="pre">hexagon</span></code> <a class="reference internal" href="../../_images/groupsusersadm6.png"><img alt="image5" src="../../_images/groupsusersadm6.png" style="width: 0.16667in; height: 0.1875in;" /></a>.</p></li> </ul> </li> <li><p>To create a new user, click on the <code class="docutils literal notranslate"><span class="pre">Add</span> <span class="pre">new</span> <span class="pre">User</span> <span class="pre">button</span></code>.</p></li> <li><p>Mandatory fields are highlighted in red.</p></li> <li><p>You can select the role of the user to be:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">User</span></code> (no special privileges).</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">Administrator</span></code> (this means full administrator).</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">Administrator</span> <span class="pre">with</span> <span class="pre">restricted</span> <span class="pre">privileges</span></code>.</p></li> </ul> </li> <li><p>If you choose the role to be <code class="docutils literal notranslate"><span class="pre">Administrator</span> <span class="pre">with</span> <span class="pre">restricted</span> <span class="pre">privileges</span></code>, you must also select the privileges in a subsequent menu. Hover with mouse over the checkboxes to see short descriptions of the privileges. Creating an administrator with restricted privileges allows to give some limited rights to some trusted users e.g. to allow a facility manager to import data for other users. It is currently preferable to create users with such roles via the OMERO.web Interface. More about <code class="docutils literal notranslate"><span class="pre">Administrator</span> <span class="pre">with</span> <span class="pre">restricted</span> <span class="pre">privileges</span></code> can be found in <a class="reference external" href="https://docs.openmicroscopy.org/omero/latest/sysadmins/restricted-admins.html">this OMERO documentation section</a>.</p></li> <li><p>Click <code class="docutils literal notranslate"><span class="pre">Save</span></code>.</p></li> <li><p>To edit a <code class="docutils literal notranslate"><span class="pre">User</span></code>, click on the <code class="docutils literal notranslate"><span class="pre">Pencil</span></code> button <a class="reference internal" href="../../_images/groupsusersadm2.png"><img alt="image6" src="../../_images/groupsusersadm2.png" style="height: 0.10417in;" /></a> to the right of the line with the name of the user. You can add/remove the <code class="docutils literal notranslate"><span class="pre">User</span></code> to/from a group or modify the roles.</p></li> <li><p>Click <code class="docutils literal notranslate"><span class="pre">Save</span></code>.</p></li> </ol> </section> <section id="web-interface-users-change-their-own-settings"> <h3><em>Web Interface: Users change their own settings</em><a class="headerlink" href="#web-interface-users-change-their-own-settings" title="Link to this heading"></a></h3> <ol class="arabic"> <li><p>Note that these features are not limited to administrators, <strong>any</strong> user can change their settings in the manner described here. Furthermore, this is the preferred way for Group Owners to manage their groups.</p></li> <li><p>In OMERO.web, click in the top-right corner of the webclient, click on your name, then, in the dropdown menu, click on <code class="docutils literal notranslate"><span class="pre">User</span> <span class="pre">settings</span></code>.</p> <p><a class="reference internal" href="../../_images/groupsusersadm7.png"><img alt="image7" src="../../_images/groupsusersadm7.png" style="width: 3in;" /></a></p> </li> <li><p>In the interface that appears, you can change your password and default group. Default group is the group you log in to by default when logging to OMERO. Your data in your default group is what you typically see immediately after loggging in for example to OMERO.web, whereas your data in your other (non-default) groups have to be explicitly navigated to.</p></li> <li><p><strong>For group owners only</strong>: You can now navigate to the group(s) you own by clicking onto <code class="docutils literal notranslate"><span class="pre">My</span> <span class="pre">Groups</span></code> tab.</p> <p><a class="reference internal" href="../../_images/groupsusersadm8.png"><img alt="image8" src="../../_images/groupsusersadm8.png" style="width: 7in;" /></a></p> </li> <li><p>Identify the group you want to edit in your group list and click on <code class="docutils literal notranslate"><span class="pre">Edit</span></code> button.</p></li> <li><p>You can now add or remove group members, add members as group owners (a group can have many owners, besides youself). When removing users from the group, make sure that the data owned by a user is moved or transferred to another user before removing the user from the group.</p></li> <li><p>You can also change the permissions level of your group. Note though that this is an action which needs careful thinking, especially if you are going from more permissive group types towards less permissive ones.</p></li> </ol> </section> </section> <section id="administrate-using-the-command-line-interface-cli"> <h2>Administrate using the Command Line Interface (CLI)<a class="headerlink" href="#administrate-using-the-command-line-interface-cli" title="Link to this heading"></a></h2> <p>Typically, the administration of Groups and Users in OMERO is done in OMERO.web (see section above), as it is more user friendly. The Command Line Interface (CLI) cannot offer the easy quick overview, filtering and searching and intuitively named buttons and tabs. For creation of administrators with restricted privileges, there are several key features missing from the CLI which are present in OMERO.web. Nevertheless, some features for handling LDAP users are implemented only in the CLI. Further, the CLI offers an environment in which custom bash scripts for user/group creation and maintenance can be executed. One example of such script can be taken from <a class="reference external" href="https://github.com/ome/training-scripts/blob/master/maintenance/scripts/create_groups_users.sh">create_groups_users.sh</a>. The script consumes a file <a class="reference external" href="https://github.com/ome/training-scripts/blob/master/maintenance/scripts/create_groups_users_setup">create_groups_users_setup</a> in which a certain user-group setup is defined.</p> <section id="command-line-managing-groups"> <h3><em>Command Line: Managing Groups</em><a class="headerlink" href="#command-line-managing-groups" title="Link to this heading"></a></h3> <ol class="arabic"> <li><p>By default when creating a group, its permissions level is set to <code class="docutils literal notranslate"><span class="pre">private</span></code>. To create a new read-annotate group <code class="docutils literal notranslate"><span class="pre">Lab1</span></code>, run:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero group add Lab1 --type=read-annotate </pre></div> </div> </li> <li><p>Or, you can define the permissions of the new group in a different way:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero group add Lab1 --perms='rwra--' </pre></div> </div> </li> <li><p>To list all the groups and save the output for example in a CSV file:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero group list --style csv > groups.csv </pre></div> </div> </li> <li><p>To add an existing user <code class="docutils literal notranslate"><span class="pre">user-1</span></code> to the <code class="docutils literal notranslate"><span class="pre">Lab1</span></code> group and make that user a group owner (the option <code class="docutils literal notranslate"><span class="pre">--as-owner</span></code> is not needed when adding a member), run:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero group adduser user-1 --name=Lab1 --as-owner </pre></div> </div> </li> <li><p>Let us add <code class="docutils literal notranslate"><span class="pre">trainer-1</span></code> as an owner of the group too:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero group adduser trainer-1 --name=Lab1 --as-owner </pre></div> </div> </li> <li><p>To remove <code class="docutils literal notranslate"><span class="pre">user-1</span></code> from the list of owners (<code class="docutils literal notranslate"><span class="pre">user-1</span></code> will still be a member of the <code class="docutils literal notranslate"><span class="pre">Lab1</span></code> group):</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero user leavegroup Lab1 --name=user-1 --as-owner </pre></div> </div> </li> <li><p>Note that the previous command when run without the <code class="docutils literal notranslate"><span class="pre">--as-owner</span></code> flag would remove the <code class="docutils literal notranslate"><span class="pre">user-1</span></code> from the group completely. Thus, it is an alternative to the following command.</p></li> <li><p>To remove <code class="docutils literal notranslate"><span class="pre">user-1</span></code> from the <code class="docutils literal notranslate"><span class="pre">Lab1</span></code> group, you can also run:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero group removeuser user-1 --name=Lab1 </pre></div> </div> </li> <li><p>To edit the <code class="docutils literal notranslate"><span class="pre">Lab1</span></code> group, first determine its ID:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero group info --group-name Lab1 id \| name \| perms \| ldap \| # of owners \| # of members -----+-------+--------+-------+-------------+-------------- 653 \| Lab1 \| rwra-- \| False \| 0 \| 0 </pre></div> </div> </li> <li><p>Change the group name to <code class="docutils literal notranslate"><span class="pre">LabN</span></code>:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero obj update ExperimenterGroup:653 name='LabN' </pre></div> </div> </li> <li><p>Let us reset the name back to <code class="docutils literal notranslate"><span class="pre">Lab1</span></code> to simplify the rest of the workflow.</p></li> <li><p>Change the group’s permissions to read-write:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero group perms --perms='rwrw--' --name='Lab1' </pre></div> </div> </li> </ol> </section> <section id="command-line-managing-users"> <h3><em>Command Line: Managing Users</em><a class="headerlink" href="#command-line-managing-users" title="Link to this heading"></a></h3> <ol class="arabic"> <li><p>Create a new user with login name <code class="docutils literal notranslate"><span class="pre">lpasteur</span></code> and at the same time add this user (with first and last name <code class="docutils literal notranslate"><span class="pre">Louis</span> <span class="pre">Pasteur</span></code>) to the <code class="docutils literal notranslate"><span class="pre">Lab1</span></code> group:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero user add lpasteur Louis Pasteur --group-name Lab1 </pre></div> </div> </li> <li><p>Let us now add the user to another group:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero user joingroup Lab2 --name=lpasteur </pre></div> </div> </li> <li><p>To edit the user and for example add an email address, first determine the user’s ID:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero user info --user-name lpasteur </pre></div> </div> </li> <li><p>Add an email address (supposing the ID of the user is <code class="docutils literal notranslate"><span class="pre">123</span></code>):</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero obj update Experimenter:123 email='lpasteur@demo.co.uk' </pre></div> </div> </li> <li><p>Make a user inactive. User <strong>cannot</strong> be deleted but it is possible to prevent a user from logging in. For that, we need to remove the user from the <code class="docutils literal notranslate"><span class="pre">user</span></code> group (an internal OMERO group):</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero user leavegroup user --name=lpasteur </pre></div> </div> </li> <li><p>To reactivate the user:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero user joingroup user --name=lpasteur </pre></div> </div> </li> </ol> </section> <section id="command-line-managing-ldap-users"> <h3><em>Command Line: Managing LDAP Users</em><a class="headerlink" href="#command-line-managing-ldap-users" title="Link to this heading"></a></h3> <p>If LDAP authentication is configured on your OMERO.server, the OMERO.server synchronizes the user list with an LDAP server, thus enabling an easy user creation and maintenance. It is possible to convert non-LDAP OMERO users to LDAP authentication using the command <code class="docutils literal notranslate"><span class="pre">omero</span> <span class="pre">ldap</span> <span class="pre">setdn</span></code>. See further information in the links under the Resources section of this guide. See <a class="reference external" href="https://docs.openmicroscopy.org/omero/latest/sysadmins/server-ldap.html">LDAP authentication</a> and <a class="reference external" href="https://docs.openmicroscopy.org/omero/5.6.1/developers/Server/Ldap.html">LDAP plugin design</a>.</p> <p>Typically, it is impractical to synchronize the OMERO groups with LDAP groups. In such case, the OMERO.server can be configured in such a way that LDAP users when they first log in to OMERO will be added to a specific private OMERO group (let us call this group <code class="docutils literal notranslate"><span class="pre">My</span> <span class="pre">Data</span></code>). This situation is further explored in the example below.</p> <p>The administrator or administrator with restricted privileges can add an LDAP user to OMERO even before the user have ever logged in to OMERO:</p> <ol class="arabic"> <li><p>First create the existing LDAP user as OMERO user. In the example below the user name is <code class="docutils literal notranslate"><span class="pre">enoether</span></code>:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero ldap create enoether </pre></div> </div> </li> <li><p>The user is now a member of the <code class="docutils literal notranslate"><span class="pre">My</span> <span class="pre">Data</span></code> group in OMERO. Then, if needed, add the user to the <code class="docutils literal notranslate"><span class="pre">Lab1</span></code> group:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ omero group adduser enoether --name=Lab1 </pre></div> </div> </li> <li><p>Note that it is advisable to clarify the OMERO group membership situation of the LDAP users soon after they joined OMERO. This can be done for example by adding the new user to their lab group (e.g. <code class="docutils literal notranslate"><span class="pre">Lab1</span></code>) in OMERO as well and by changing the default group of such user in OMERO to be their lab group. See above for how to change the default group of a user. Otherwise, the new LDAP&OMERO users might be importing their data into the <code class="docutils literal notranslate"><span class="pre">My</span> <span class="pre">Data</span></code> group for some period of time, without realizing the data are not accessible to their colleagues in the lab group for cooperative purposes because <code class="docutils literal notranslate"><span class="pre">My</span> <span class="pre">Data</span></code> is a private group.</p></li> </ol> </section> <section id="set-up-omero-server-to-email-users"> <h3><em>Set up OMERO server to email users</em><a class="headerlink" href="#set-up-omero-server-to-email-users" title="Link to this heading"></a></h3> <p>If you are a full administrator or an <a class="reference external" href="https://docs.openmicroscopy.org/omero/latest/sysadmins/restricted-admins.html">administrator with restricted privileges</a> with any or no privileges, you can email OMERO users. This can be helpful for example to inform users about downtimes, new features or imminent changes regarding OMERO.</p> <ol class="arabic"> <li><p>In cooperation with you OMERO.server system administrator, consult the <a class="reference external" href="https://docs.openmicroscopy.org/omero/latest/sysadmins/mail.html">documentation on email in OMERO</a>.</p></li> <li><p>Once the OMERO.server is configured, log in to OMERO.web and in the top toolbar, click the <code class="docutils literal notranslate"><span class="pre">Admin</span></code> button <a class="reference internal" href="../../_images/groupsusersadm1.png"><img alt="image0" src="../../_images/groupsusersadm1.png" style="width: 0.75in; height: 0.38542in;" /></a>.</p></li> <li><p>Click on the <code class="docutils literal notranslate"><span class="pre">Email</span></code> tab.</p></li> <li><p>Choose the appropriate options, enter the email subject and message. Note that depending on the number of users you are choosing to email, the action might take a long time to finish. You <strong>must</strong> keep the session of OMERO.web alive (i.e. doing actions still being logged in OMERO.web) until the <code class="docutils literal notranslate"><span class="pre">Activities</span></code> dropdown menu (icon to the left of the <code class="docutils literal notranslate"><span class="pre">Search</span></code> in the top bar of OMERO.web) reports that all emails were sent.</p> <p><a class="reference internal" href="../../_images/groupsusersadm9.png"><img alt="image9" src="../../_images/groupsusersadm9.png" style="width: 7in;" /></a></p> <p><a class="reference internal" href="../../_images/groupsusersadm10.png"><img alt="image10" src="../../_images/groupsusersadm10.png" style="width: 7in;" /></a></p> </li> <li><p>Click <code class="docutils literal notranslate"><span class="pre">Send</span></code> button.</p></li> </ol> </section> </section> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="search-omero.html" class="btn btn-neutral float-left" title="Search for Data" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="data-publication.html" class="btn btn-neutral float-right" title="Prepare data for publication using OMERO" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p>© Copyright 2019-2024, Open Microscopy Environment (License: <a href="https://github.com/ome/omero-guides?tab=BSD-2-Clause-1-ov-file#readme">BSD-2</a>).</p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>