NexCommand AINexCom Knowledge Base
Field reference

LDAP Settings

How to use LDAP Settings in Integrations & API Docs: access, working steps, fields, related records and troubleshooting.

System AdminUpdated 12 October 2026Configuration-aware guidance
Open LDAP Settings ↗Module guide

Purpose and access

Use the API documentation at api.nexcommand.ai, obtain the required authorized credentials and use the deployment-specific service URLs. SaaS tenants and on-premises installations must retain their own endpoints and access boundaries.

This page is a settings page in System Admin → Integrations & API Docs. Use the link above to open the configured destination; permissions are checked by the destination service.

ERP links open in a new tab. Sign in with your own account; record visibility, actions and approval authority follow your assigned permissions. Screens can differ by company and configuration.

Before you start

Prepare the required information: Directory Server, LDAP Server Url, Base Distinguished Name (DN), LDAP search path for Users, LDAP Search String, LDAP search path for Groups, LDAP Email Field, LDAP Username Field, LDAP First Name Field, Require Trusted Certificate, Default User Type.

Confirm the company, party, dates, units and source references that apply. Select existing links carefully and check for an existing record before creating a duplicate.

Working steps

  1. Open LDAP Settings from System Admin → Integrations & API Docs, or use ERP Search.
  2. Review the existing configuration before editing.
  3. Complete the editable fields described below. Required fields and validation conditions must be satisfied; read-only values are set by the system or their source records.
  4. Add the required child rows. Review each row’s identifiers, linked records and values, using the child-table field reference below.
  5. Save the record and address validation messages. Reload and verify the saved values and relationships.
  6. Use any additional workflow actions only when the record and your role provide them. Saving this record does not automatically complete a related transaction or external action.

Field reference

These fields come from the installed ERP definition. Hidden fields and password inputs are omitted. Additional conditions, custom scripts and workflow rules can make a field required or read-only in a particular context.

FieldType / behaviorHow to use it
EnabledenabledCheck
Optional		Enable or disable the named option only when it matches the intended record behavior.
Directory Serverldap_directory_serverSelect
Required		Please select the LDAP Directory being used
Available choices
  • Active Directory
  • OpenLDAP
  • Custom
LDAP Server Urlldap_server_urlData
Required		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Base Distinguished Name (DN)base_dnData
Required		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
LDAP search path for Usersldap_search_path_userData
Required		Requires any valid fdn path. i.e. ou=users,dc=example,dc=com
LDAP Search Stringldap_search_stringData
Required		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
LDAP search path for Groupsldap_search_path_groupData
Required		Requires any valid fdn path. i.e. ou=groups,dc=example,dc=com
LDAP Email Fieldldap_email_fieldData
Required		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
LDAP Username Fieldldap_username_fieldData
Required		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
LDAP First Name Fieldldap_first_name_fieldData
Required		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Do Not Create New Userdo_not_create_new_userCheck
Optional		Do not create new user if user with email does not exist in the system
LDAP Middle Name Fieldldap_middle_name_fieldData
Optional		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
LDAP Last Name Fieldldap_last_name_fieldData
Optional		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
LDAP Phone Fieldldap_phone_fieldData
Optional		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
LDAP Mobile Fieldldap_mobile_fieldData
Optional		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
SSL/TLS Modessl_tls_modeSelect
Optional		Choose one of the configured list values. Status fields may be controlled by the record workflow.
Available choices
  • Off
  • StartTLS
Require Trusted Certificaterequire_trusted_certificateSelect
Required		Choose one of the configured list values. Status fields may be controlled by the record workflow.
Available choices
  • No
  • Yes
Path to private Key Filelocal_private_key_fileData
Optional		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Path to Server Certificatelocal_server_certificate_fileData
Optional		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Path to CA Certs Filelocal_ca_certs_fileData
Optional		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
Group Object Classldap_group_objectclassData
Optional		string value, i.e. group
Custom Group Searchldap_custom_group_searchData
Optional		string value, i.e. {0} or uid={0},ou=users,dc=example,dc=com
LDAP Group Member attributeldap_group_member_attributeData
Optional		string value, i.e. member
Default User Typedefault_user_typeLink
Required		Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship.

Linked record: User Type

Default User Roledefault_roleLink
Optional		Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship.

Linked record: Role

LDAP Group Mappingsldap_groupsTable
Optional		Add the relevant child rows and review required columns, quantities and references before saving.

Linked record: LDAP Group Mapping

LDAP Group Fieldldap_group_fieldData
Optional		NOTE: This box is due for depreciation. Please re-setup LDAP to work with the newer settings

Child tables

LDAP Group Mappings — child-row fields
FieldType / behaviorHow to use it
LDAP Groupldap_groupData
Required		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.
User Roleerpnext_roleLink
Required		Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship.

Linked record: Role

Troubleshooting

  • Not permitted: verify the account, role and source-document permission. Do not share an administrator login.
  • Missing record or address: inspect the relevant Link or Dynamic Link fields; a matching title alone does not establish a relationship.
  • Cannot save or change status: review required fields, read-only values, document status and the configured approval transition.
  • Unexpected report or portal result: review company/date filters, source-document submission and the approved party or Employee link.
Was this useful?