Information
  • Author: Appian Corporation
  • Type: Plug-in (Function & Smart Service)
  • Support: This plug-in or utility is not supported by the author. The content is free to use with a licensed product, but it is made available as-is and Community supported.
  • Industry: All Industries
  • Compatible Version(s): 20.3+, 22.3
  • First Released:
  • Last Updated:
  • Cost: Free
Share
Home » AppMarket » LDAP Tools

LDAP Tools

Overview

This Plug-in provides the ability to update Appian user profiles from data retrieved from an LDAP server. The data that can be synchronized include all the default user profile fields except the username (e.g. first name, last name, address, phone, supervisor, title, etc…) as well as the custom fields.

Key Features & Functionality

  • LDAP User Profile Synchronization (Smart Service) - available in the Process Modeler under Integration Services > Connectivity Services
  • LDAP Sync Process Model (Sample Process Model) - will need to be tailored and tested based on identity management requirements
  • ldapSearch() Function - returns an array of LDAP attributes for a specific search query

See the instructions documentation (attached PDF) and https://community.appian.com/w/the-appian-playbook/520/ldap-synchronization for more information.

Anonymous

  • Hi everyone !
    Before January ends, I wish you all a happy new year : keep safe and stay healthy !

    I'd like to know if one of you have experienced a synchronization error while you retrieve the last user of a directory service group ?
    We got this error message sent :

    This case doesn't seem to be described in the Plugin's documentation, so is it a anomally or is it an expected behaviour ?
    How do you handle this error when it appears, and is there a workaround to bypass it ?

    This behaviour is quite embarrassing in our case, as some service/group can fused, so we need in some cases to move users from a group to another.

    Thanks for reading, and moreover, for responding !

    Jean-Jacques

  • in reply to Christina (Le) Hajost

    It may also be the case that their usernames are invalid Appian usernames (use invalid characters) so they aren't being created.

    A username can only contain letters, numbers, and the following special characters: @ . _ - .
    It must not match an existing username regardless of case. For example, if john.doe already exists, you cannot enter JOHN.doe

  • in reply to Ketan Patel

    It is compatible with newer versions

  • in reply to simonj3483

    Yes, the Customer Success team is working on addressing the deprecated APIs for this plugin and will release that version once the changes are made.

  • We are seeing a number of Health check alerts relating to deprecated api's used by this plug in (version 1.4).

    For example

    LDAP Tools (adusersynchronizationwithusernames) references deprecated Appian APIs [deprecated] com.appiancorp.suiteapi.common.ServiceLocator.getContentService(com.appiancorp.services.ServiceContext) [deprecated] com.appiancorp.suiteapi.common.ServiceLocator.getDiscussionMetadataCoreService(com.appiancorp.services.ServiceContext) [deprecated] com.appiancorp.suiteapi.common.ServiceLocator.getPortalAdministrationService(com.appiancorp.services.ServiceContext) [deprecated] com.appiancorp.suiteapi.common.ServiceLocator.getProcessAnalyticsService2(com.appiancorp.services.ServiceContext) [deprecated] com.appiancorp.suiteapi.common.ServiceLocator.getProcessDesignService(com.appiancorp.services.ServiceContext) [deprecated] com.appiancorp.suiteapi.content.ContentService.notifyUsersCreation(java.lang.String[]) [deprecated] com.appiancorp.suiteapi.forums.DiscussionMetadataCoreService.notifyUsersCreation(java.lang.String[]) [deprecated] com.appiancorp.suiteapi.personalization.UserRank.getId() [deprecated] com.appiancorp.suiteapi.personalization.UserRank.setId(java.lang.Long) [deprecated]

    Is there a new version of the plug in scheduled for release?

  • in reply to madhan84

    Hi @madhan84. Do your users have username, email address, first name, and last name? Appian requires those four profile fields for a valid user account. Another thought is to check the log files. If debugging is enabled for the LDAP plugin, the logs will capture the usernames that failed to synchronize.

  • We are on 17.2 On prem setup. We are using LDAP User Profile Synchronization smart service. We have a issue were some users are not able to access Appian. While debugging this, we found that these users are part of "usernamesFailed". How can i find the reason for failure?

  • in reply to errict

    You can try a few things:

    1. Disable paging control in your first parameter (getVLVControlSupported=false)
    2. Set your pagingInfo to with startIndex=0

  • We are running Appian 19.4 & ldaptools-1.4.0.jar
    When running ldapsearch the data returned is null with no errors.
    The same query when run with the same account bound in ldp.exe returns the expected values.
    Appian support was not able to provide assistance and recommended posting here.
    Please advise.

    PDFPDFPDF

  • in reply to robertl949

    Hi Robert,

    I am facing exactly this , the configuration page shows 2 users for a filter but the LDAP Synch With Usernames smart service in the process returns only 1 user. Were you able to solve this ?

    Thanks.

© 2025 Appian. All rights reserved.
We want to hear from you! Submit a review on Gartner or G2.