vertx / io.vertx.kotlin.ext.auth.ldap / ldapAuthenticationOptionsOf

ldapAuthenticationOptionsOf

fun ldapAuthenticationOptionsOf(authenticationMechanism: String? = null, authenticationQuery: String? = null, referral: String? = null, url: String? = null): LdapAuthenticationOptions

A function providing a DSL for building io.vertx.ext.auth.ldap.LdapAuthenticationOptions objects.

Ldap auth configuration options

Parameters

authenticationMechanism - sets the authentication mechanism. default to 'simple' if not set

authenticationQuery - Set the query to use to authenticate a user. This is used to determine the actual lookup to use when looking up a user with a particular id. An example is uid={0},ou=users,dc=foo,dc=com - Note that the element {0} is substituted with the user id to create the actual lookup.

referral - Set the referral property. Default to 'follow' if not set

url - Set the url to the LDAP server. The url must start with ldap:// and a port must be specified.