Skip to content

Latest commit

 

History

History
58 lines (36 loc) · 1.69 KB

README.md

File metadata and controls

58 lines (36 loc) · 1.69 KB
Raw

LDAP Authentication Plugin for The Fascinator

This plugin allows authentication against an LDAP server for The fascinator platform.

Configuration

"authentication": {
	"type": "ldap",
	"ldap": {
		"baseURL": "ldap://localhost:389",
		"baseDN": "ou=people,o=Sample org,c=AU",
		"ldapSecurityPrincipal": "cn=JohnDoe,ou=Some Account,dc=sample,dc=edu,dc=au"
		"ldapSecurityCredentials": "******"
		"idAttribute": "uid"
	}
}

baseURL

The URL of the LDAP server.

baseDN

The base Distinguished Name to search under.

idAttribute

The name of the attribute for which the username will be searched under. This will be appended to the end of the baseDN when querying the LDAP server. Using the example configuration above the query string will be:

ou=people,o=Sample org,c=AU,uid=specifiedUsername

ldapSecurityPrincipal

The Security Principal of the service account used to bind to the LDAP server. (Leave empty to bind anonymously.)

ldapSecurityCredentials

Credentials for the service account used to bind to the LDAP server. (Leave empty to bind anonymously.)

** userAttributes **

Optional list of attributes that will be retrieved and added to the User object upon login. Leave unspecified if not needed.

** displayNameAttributes **

Optional list of attributes that will compose the display name, order matters. Leave unspecified if not needed.

** displayNameDelimiter **

Optional delimiter that will be used when composing the display name. Defaults to ' '. Leave unspecified if not needed.

** useSystemCredForAttributes **

Optional flag indicating the intention to use of system credential when retrieving user attributes. Defaults to false. Leave unspecified if not needed.