LDAP Domain

To use Active Directory or Oracle for identity management within your organization, LDAP domain set up is required to enable certain functionality, like email printing, Mobile App printing, and secure release printing. It is also required if you'd like to authenticate access to the Admin Console using Active Directory and / or LDAP accounts.

When using LDAP, and using real-time authentication for things like the Admin Console, the Control Panel Application (CPA), or the Mobile App, the instance must be allowed to communicate with an LDAP server.

LDAP Configuration

Set up the Connection

  1. In the Admin Console, select Tools then Settings then General.
  2. Scroll down to the Identity Provider Settings section and select LDAP.

  3. Select Add..

    IdP Settings - LDAP options

  4. In the LDAP Settings modal, fill in the required fields. Any time the instance requires LDAP authentication the LDAP settings apply. For example, if logging into the Admin Console using LDAP credentials,the Self-service Portal with LDAP credentials, and any advanced features like CPA, the Mobile App, or Email Printing.
    1. Domain Name — enter your LDAP Domain Name. The NETBIOS Domain Name and Base DN fields should fill in automatically.
    2. Primary LDAP Server — enter the external (public) IP address or FQDN that is port-forwarded to your primary LDAP server.
    3. Secondary LDAP Server — enter the external (public) IP address or FQDN that is port-forwarded to your secondary LDAP server. It's not required but may be used, if needed.
    4. LDAP Port — port 389 for LDAP. If you check the box for LDAP Server Requires Secure Sockets, the port number will automatically change to 636.
    5. Domain Alias — enter an alias only if you are using multiple domains so you can identify this configuration.
    6. Bind User and Bind Password — enter the username and password of a user account (preferably a service account with Read-Only access) that is used for LDAP queries.
    7. LDAP Email Attributes — contains the Active Directory attribute where the user's email address is stored. This is used in conjunction with the Email Printing module.
    8. SSO Email Attribute — optional, enter the attribute to use for MFP user functionality such as scan to email.

    9. SSO Home Directory Attribute — optional, enter the attribute to use for MFP user functionality such as scan to home directory.

      Not all manufacturers support this functionality. Contact Customer Support at support@printerlogic.com for a list of supported manufacturers.

    10. Server Type — select the server type you are using.

LDAP Settings modal

Test the LDAP Connection

When you finish completing the LDAP Settings fields, select the Test Settings button. Once the test completes, the results display in a table format with the following details:

  • Status indicator — successful tests display a green check mark, failed tests display a red "X" and skipped tests display a caution triangle.

  • Status — complete or Skipped.

    The Skipped status appears if a settings is left without a value or if the value in the field cannot be found.
    LDAP Test results with a skipped result

  • Test — a description of the test.

  • Result — displays the result of the test. If the test is skipped or it failed, it displays the reason.

    LDAP test results window

When the tests are successful, select Apply.

In the LDAP Settings section of the General settings, you can optionally configure the following:

  • Default domain when logging in — use the drop-down to select the new LDAP domain. This is the domain the system uses when an end user attempts to log in with only a username and does not specify a domain.

    For example, the user only needs to enter john.smith, for the system to attempt to log them in as mydomain\john.smith. If multiple domains are configured, the end user would still have to type in the non-default domain followed by the username. For example, xyzcorp\john.smith.

  • Enable Advanced LDAP Administrative Authentication — with this option checked, you can add users or groups without the Windows Active Directory interface. For example, Mac, Linux workstations, or when multiple domains are configured.

    LDAP Settings - Default domain and admin authentication options selected

When you finish configuring the LDAP settings, select Save at the top-right corner of the page.

Delete Provisioned LDAP Data

For legal reasons, Product Support cannot remove provisioned LDAP users and groups from the database, and leaves this action to the discretion of the IT Admin. This process requires obvious interaction to remove the user and groups to ensure deletion is the desired outcome.

  1. In the Admin Console, navigate to Tools then Settings then General.
  2. In the Identity Provider Settings section select the LDAP option.
  3. In the LDAP Sync section select the Delete Provisioned LDAP Data option.
  4. Type DELETE into the text field.

  5. Select Delete.

    This action deletes all LDAP users and groups from the database for all configured AD domains and requires you to provision them again. You cannot undo this action.

The RBAC, Portal Security, and Printer Deployment rules associated with these users and groups will continue to function unless the admin manually deletes them.

Delete LDAP Provisioning Data modal