Config2_LDAPAuthenticator

LDAP authentication configuration. Allows CompleteFTP users to authenticate against an LDAP server.

Instances of this class are obtained from:

Properties

PropertyTypeDescription
enabled Boolean

Whether this authenticator is enabled.

logInAsUser String

User to log in as when this authenticator succeeds.

port Number

LDAP server port number (default: 389 for non-SSL, 636 for SSL).

query String

LDAP query string to find the user (e.

server String

LDAP server hostname or IP address.

ssl Boolean

Whether to use SSL/TLS for the LDAP connection.

userMatching Boolean

Whether to match users by their LDAP username.

validate Boolean

Whether to validate the LDAP server's SSL certificate.

version Number

LDAP protocol version (2 or 3).

Property Details

enabled :Boolean

Description:
  • Whether this authenticator is enabled.

Whether this authenticator is enabled.

Type:
  • Boolean

logInAsUser :String

Description:
  • User to log in as when this authenticator succeeds. If empty, the authenticated user's own account is used.

User to log in as when this authenticator succeeds. If empty, the authenticated user's own account is used.

Type:
  • String

port :Number

Description:
  • LDAP server port number (default: 389 for non-SSL, 636 for SSL).

LDAP server port number (default: 389 for non-SSL, 636 for SSL).

Type:
  • Number

query :String

Description:
  • LDAP query string to find the user (e.g., 'uid={0}' or 'cn={0}'). Use {0} as a placeholder for the username.

LDAP query string to find the user (e.g., 'uid={0}' or 'cn={0}'). Use {0} as a placeholder for the username.

Type:
  • String

server :String

Description:
  • LDAP server hostname or IP address.

LDAP server hostname or IP address.

Type:
  • String

ssl :Boolean

Description:
  • Whether to use SSL/TLS for the LDAP connection.

Whether to use SSL/TLS for the LDAP connection.

Type:
  • Boolean

userMatching :Boolean

Description:
  • Whether to match users by their LDAP username.

Whether to match users by their LDAP username.

Type:
  • Boolean

validate :Boolean

Description:
  • Whether to validate the LDAP server's SSL certificate.

Whether to validate the LDAP server's SSL certificate.

Type:
  • Boolean

version :Number

Description:
  • LDAP protocol version (2 or 3).

LDAP protocol version (2 or 3).

Type:
  • Number