.. _synchronize-or-purge-ldap-users:

Sync or purge LDAP users
-------------------------------

.. _24.1|EKB-18810:
.. _25.1|EKB-4265:


This procedure syncs or purges (deletes) users that were synced from an LDAP server.

.. tip:: 

   :ref:`use-action-search-to-navigate-automate`


1. In the Admin Portal, select the hierarchy where the LDAP server exists.
2. Go to **LDAP Users**.
3. Configure the following: 

   .. tabularcolumns:: |p{3cm}|p{12cm}|

   +----------------------+---------------------------------------------+
   | Setting              | Description                                 |
   +======================+=============================================+
   |                      | Defines whether to remove                   |
   | Remove Log Messages  | user management logs before syncing or      |
   |                      | purging.                                    |
   +----------------------+---------------------------------------------+
   |                      | Displays only when **Remove Log Messages**  |
   | Remove Log Direction | is enabled.                                 |
   |                      |                                             | 
   |                      | Choose an option:                           |
   |                      |                                             |
   |                      | * Local - removes logs at the hierarchy of  |
   |                      |   the LDAP server.                          |
   |                      | * Down - removes logs at and below the      |
   |                      |   hierarchy of the LDAP server.             |
   +----------------------+---------------------------------------------+
   | LDAP Server          | Mandatory. Choose the organization unit of  |
   |                      | the LDAP server from which you need to sync |
   |                      | or purge the users.                         |
   +----------------------+---------------------------------------------+
   | LDAP Action          | Mandatory. Select an option from the        |
   |                      | drop-down to run either a sync or purge:    |
   |                      |                                             |
   |                      | * Synchronize users from LDAP               |
   |                      | * Purge local LDAP device resources         | 
   +----------------------+---------------------------------------------+

   .. warning::

      If you're choosing to run a purge, a system message displays onscreen to warn you that purging will 
      result in the 
      loss of data. All LDAP users imported from the selected LDAP server will be removed. 
      
      It is recommended that you consider this warning carefully, and the consequences of a purge: 
      
      * If "purge" mode on the LDAP user sync configuration is set to *Manual*, any subscribers associated 
        with these LDAP users will be retained and converted to local subscribers.
      * If "purge" mode on the LDAP user sync configuration is set to *Automatic*, any subscribers 
        associated with these users, as well as their devices and services, will be deleted.

4. Save your changes. 

   The transaction is triggered. View transaction progress and details in the Transaction Logs. 



.. rubric:: Related Topics 

* 
  .. raw:: latex
  
     Transaction Logging and Audit in the Core Feature Guide.

  .. raw:: html

     <a href="concepts-transaction-logging-audit.html">Transaction Logging and Audit</a>