Skip to content

doc: write about second method (ui) of ldap enabling #5397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 3, 2025
Merged

doc: write about second method (ui) of ldap enabling #5397

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f593015
doc: write about second method (ui) of ldap enabling
Oct 2, 2025
9622321
doc: write about second method (ui) of ldap enabling
Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions doc/tooling/tcm/tcm_access_control/tcm_ldap_auth.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,22 @@ of LDAP users in |tcm| are defined by LDAP group mapping.

Both LDAP and secure LDAPS (LDAP over TLS) protocols are supported.


.. _tcm_ldap_auth_enable:

Enabling LDAP authentication
----------------------------

LDAP authentication can be enabled using either of two configuration methods:

- :ref:`Enabling via CLI <tcm_ldap_auth_enable_cli>` -- set the ``security.auth`` option to include ldap in the TCM YAML config or as a CLI flag.
- :ref:`Enabling via web interface <tcm_ldap_auth_enable_ui>` -- starting from version 1.4.0, you can enable LDAP authentication interactively in the TCM UI.

.. _tcm_ldap_auth_enable_cli:

Via CLI
~~~~~~~

To allow LDAP user authentication in |tcm|, enable the ``ldap`` authentication method
in the :ref:`security.auth <tcm_configuration_reference_security_auth>` configuration option before startup:

Expand All @@ -45,6 +56,19 @@ in the :ref:`security.auth <tcm_configuration_reference_security_auth>` configur
If both authentication methods -- LDAP and local -- are enabled, |tcm| tries them
for each login attempt in the order they are specified in the configuration.

.. _tcm_ldap_auth_enable_ui:

Via web interface
~~~~~~~~~~~~~~~~~

To enable LDAP authentication using the TCM web interface:

1. Click the user icon in the top-right corner of the screen.
2. Select **Settings** from the dropdown menu.
3. Navigate to the **Authentication methods** tab.
4. Check the box next to **LDAP**.
5. Save the changes.

.. _tcm_ldap_auth_config:

LDAP configuration
Expand Down