Skip to content

Commit b15c69d

Browse files
authored
doc: write about second method (ui) of ldap enabling (#5397)
* doc: write about second method (ui) of ldap enabling
1 parent 18d4efd commit b15c69d

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

doc/tooling/tcm/tcm_access_control/tcm_ldap_auth.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,22 @@ of LDAP users in |tcm| are defined by LDAP group mapping.
1818

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

21+
2122
.. _tcm_ldap_auth_enable:
2223

2324
Enabling LDAP authentication
2425
----------------------------
2526

27+
LDAP authentication can be enabled using either of two configuration methods:
28+
29+
- :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.
30+
- :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.
31+
32+
.. _tcm_ldap_auth_enable_cli:
33+
34+
Via CLI
35+
~~~~~~~
36+
2637
To allow LDAP user authentication in |tcm|, enable the ``ldap`` authentication method
2738
in the :ref:`security.auth <tcm_configuration_reference_security_auth>` configuration option before startup:
2839

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

59+
.. _tcm_ldap_auth_enable_ui:
60+
61+
Via web interface
62+
~~~~~~~~~~~~~~~~~
63+
64+
To enable LDAP authentication using the TCM web interface:
65+
66+
1. Click the user icon in the top-right corner of the screen.
67+
2. Select **Settings** from the dropdown menu.
68+
3. Navigate to the **Authentication methods** tab.
69+
4. Check the box next to **LDAP**.
70+
5. Save the changes.
71+
4872
.. _tcm_ldap_auth_config:
4973

5074
LDAP configuration

0 commit comments

Comments
 (0)