.. SPDX-FileCopyrightText: 2025 Univention GmbH
..
.. SPDX-License-Identifier: AGPL-3.0-only

.. _nubus-user-management-create-wizard:

User creation wizard
====================

The user creation wizard streamlines account creation
for functional administrators
by requiring only essential user information.
After reading this page,
you know how to create user accounts quickly,
configure password options including email invitations,
and customize the wizard's behavior for your environment.
The user creation wizard is part of the
*Users* management module in the *Management UI*.

To create a user account through the user creation wizard,
use the following steps:

#. To open the wizard, open the
   :ref:`nubus-user-management-users`
   and click :guilabel:`Add`.
   Select a user template or keep the selection at *None*.
   Click :guilabel:`Next`.

#. Provide values for the mandatory fields *Last name* and *User name*.
   Fill in the optional fields as you like,
   and as shown in
   :numref:`nubus-user-management-create-wizard-figure`.
   Click :guilabel:`Next`.

   .. _nubus-user-management-create-wizard-figure:

   .. figure:: /images/users_user.*
      :alt: Add a user in the Users management module
      :width: 646px

      Add a user through the user creation wizard in the *Users* management module

#. Define a user password.

   Alternatively, you can also delegate the definition of the password to the user
   with an invitation through email.
   For more information,
   see :external+uv-ucs-operation:ref:`iam-user-create-wizard-require-primary-email`
   in :cite:t:`uv-ucs-operation`.

   For additional properties to control the user account setup,
   such as invite users or change password on next sign-in:

   .. tab-set::

      .. tab-item:: Nubus for UCS
         :sync: appliance

         :external+uv-ucs-operation:ref:`iam-user-create-wizard-account-properties`
         in :cite:t:`uv-ucs-operation`.

      .. tab-item:: Nubus for Kubernetes
         :sync: kubernetes

         :external+uv-nubus-kubernetes-operation:ref:`conf-users-creation-wizard-account-properties`
         in :cite:t:`uv-nubus-kubernetes-operation`.

#. To provide more attributes for the user account
   than the wizard requests,
   click :guilabel:`Advanced`
   and continue with
   :ref:`Advanced user account settings <nubus-user-management-users>`
   in the *Users* management module.

#. To save the user account, click :guilabel:`Create user`.

.. _nubus-user-management-create-wizard-deactivate:

Deactivate user creation wizard
-------------------------------

You can deactivate the user creation wizard.
Use the following steps depending on your installation.

.. tab-set::

   .. tab-item:: Nubus for UCS
      :sync: appliance

      To deactivate the user creation wizard
      in the *Users* management module
      on Nubus for UCS,
      apply the following steps to **every** Nubus for UCS system in your UCS domain:

      #. Set the UCR variable
         :external+uv-ucs-operation:envvar:`directory/manager/web/modules/users/user/wizard/disabled`
         to the value ``true``.

      #. Restart the :program:`univention-management-console-server`.

   .. tab-item:: Nubus for Kubernetes
      :sync: kubernetes

      To deactivate the user creation wizard in Nubus for Kubernetes,
      your cluster operator needs to update the configuration.
      For the steps,
      see :external+uv-nubus-kubernetes-operation:ref:`conf-users-creation-wizard-deactivate`
      in :cite:t:`uv-nubus-kubernetes-operation`.

.. _nubus-user-management-create-wizard-primary-email:

Primary email address in user creation wizard
---------------------------------------------

If you want to define the user's primary email address in the user creation wizard,
you can activate the proper field in the wizard.
Depending on your installation,
you need to use the following steps.

.. tab-set::

   .. tab-item:: Nubus for UCS
      :sync: appliance

      Apply the following steps to **every** Nubus for UCS system in your UCS domain:

      #. Activate the field by setting the UCR variable
         :external+uv-ucs-operation:envvar:`directory/manager/web/modules/users/user/properties/mailPrimaryAddress/required` to the value ``true``.

      #. Restart the :program:`univention-management-console-server`.

   .. tab-item:: Nubus for Kubernetes
      :sync: kubernetes

      To set up the primary email address as a required attribute in Nubus for Kubernetes,
      your cluster operator needs to activate the configuration.
      For the steps,
      see :external+uv-nubus-kubernetes-operation:ref:`conf-users-creation-wizard-require-primary-email`
      in :cite:t:`uv-nubus-kubernetes-operation`.

The user creation wizard then asks for the user's primary email address,
as shown in :numref:`nubus-user-management-create-wizard-advanced-user-settings-primary-email`.

.. _nubus-user-management-create-wizard-advanced-user-settings-primary-email:

.. figure:: /images/users_user_wizard_primary_mail.*
   :alt: Require setting the user's primary email address in the wizard
   :width: 661px

   Require setting the user's primary email address in the wizard