.. _om-tenant-settings:

Tenant settings
===============

In this view you can see information about your tenant, and also:

* :ref:`change tenant's name <om-change-tenant-name>`,
* :ref:`change brand color <om-change-brand-color>`,
* :ref:`change header logo <om-change-header-logo>`,
* :ref:`see and copy Workspace ID <om-copy-workspace-id>`,
* :ref:`change square logo <om-change-square-logo>`,
* :ref:`delete tenant <om-delete-tenant>`.

.. note:: After each change, a **Changes made** pop-up appears. Click **Save** to keep the changes or **Cancel** to discard them.

.. figure:: ../images/tenant-settings-view.png
   :alt: Tenant settings view
   :width: 100%
   :align: center

   Tenant settings

.. _om-change-tenant-name:

Change tenant's name
--------------------

1. In **Tenant settings**, type the new name in the **Tenant name** field.
2. Click **Save** in the **Changes made** pop-up.
3. A **Tenant settings saved** message appears in the top left of the page.

.. figure:: ../images/change-tenant-name.png
   :alt: Tenant settings saved message
   :width: 80%
   :align: center

   Tenant name changed

.. _om-change-brand-color:

Change brand color
------------------

1. In **Tenant settings**, click the box with the color.
2. Select the new color by:

   a. moving the color bar to the side, or
   b. clicking the eyedropper icon.

3. Click **Save** in the **Changes made** pop-up.

.. tip:: Use a dark color for better contrast between elements.

.. figure:: ../images/change-brand-color.png
   :alt: Brand color picker
   :width: 70%
   :align: center

   Brand color picker

.. _om-change-header-logo:

Change header logo
------------------

1. In **Tenant settings**, click **Change** in the **Header logo (full)** section.
2. Choose the logo from your device.
3. Click **Save** in the **Changes made** pop-up.

.. note:: The header logo must be a PNG or SVG file with a transparent background, no larger than 1 MB.

.. figure:: ../images/change-header-logo.png
   :alt: Header logo change
   :width: 80%
   :align: center

   Header logo change

.. _om-copy-workspace-id:

See and copy Workspace ID
-------------------------

The **Workspace ID** field in **Tenant settings** shows your tenant's ID. To copy it:

1. Move your cursor to the **Workspace ID** field.
2. Click the copy icon.
3. A **Copied to clipboard** message appears in the top left of the page.

.. figure:: ../images/copy-workspace-id.png
   :alt: Copied to clipboard message
   :width: 100%
   :align: center

   Workspace ID copied

.. _om-change-square-logo:

Change square logo
------------------

The square logo is shown in tenant lists.

1. In **Tenant settings**, click **Change** in the **Square logo** section.
2. Choose the logo from your device.
3. Click **Save** in the **Changes made** pop-up.

.. note:: The square logo must be a JPG, PNG or SVG file, no larger than 1 MB.

.. figure:: ../images/change-square-logo.png
   :alt: Square logo change
   :width: 80%
   :align: center

   Square logo change

.. _om-delete-tenant:

Delete tenant
-------------

.. warning:: Deleting a tenant deletes all data inside of it. This cannot be undone.

1. In **Tenant settings**, go to the **Delete tenant** section.
2. Click the red **Delete tenant** button.
3. Confirm by clicking the red **Delete** button.

.. figure:: ../images/delete-tenant.png
   :alt: Delete tenant confirmation
   :width: 100%
   :align: center

   Delete tenant confirmation