LDAP Account Manager

WhitePagesProfile
in package

White pages profile.

Table of Contents

$authenticationLdapAdditionalSearchFilter  : string
$authenticationLdapSearchAttribute  : string
$authenticationLdapSuffix  : string
$authenticationType  : string
$backgroundColor  : string
$backgroundImage  : string
$captchaProvider  : string
provider for captcha (-/google/hCaptcha/friendlyCaptcha)
$captchaSecretKey  : string
secret key
$captchaSiteKey  : string
site key
$customCss  : string
$displayMode  : string
$followReferrals  : bool
$footer  : string
$header  : string
$language  : string
$ldapConnectionPassword  : string
$ldapConnectionUser  : string
$loginAttributeText  : string
describing text for search attribute
$loginCaption  : string
describing text for user login
$loginFooter  : string
describing text for user login
$loginHeader  : string
header HTML for login
$passwordLabel  : string
label for password input
$primaryColor  : string
$serverUrl  : string
$tabs  : array<string|int, mixed>
$twoFactorAllowToRememberDevice  : bool
$twoFactorAuthenticationAttribute  : string
$twoFactorAuthenticationCaption  : string
$twoFactorAuthenticationClientId  : string
$twoFactorAuthenticationDomain  : string
$twoFactorAuthenticationInsecure  : bool
$twoFactorAuthenticationLabel  : string
$twoFactorAuthenticationSecretKey  : string
$twoFactorAuthenticationType  : string
$twoFactorAuthenticationURL  : string
$twoFactorRememberDeviceDuration  : int
$twoFactorRememberDevicePassword  : string
$useForAllOperations  : bool
$useTLS  : bool
export()  : array<string|int, mixed>
Exports the profile as an array.
getLoginHandler()  : WhitePagesLoginHandler
Returns the login handler.
import()  : WhitePagesProfile
Imports data to a new profile.

Properties

$authenticationLdapAdditionalSearchFilter

public string $authenticationLdapAdditionalSearchFilter = ''

additional LDAP search filter for user search

$authenticationLdapSearchAttribute

public string $authenticationLdapSearchAttribute = 'uid'

LDAP search attribute to find the user for authentication

$authenticationLdapSuffix

public string $authenticationLdapSuffix = 'ou=people,dc=example,dc=com'

LDAP suffix for users

$authenticationType

public string $authenticationType = 'AUTH_ANONYMOUS'

authentication type

$backgroundColor

public string $backgroundColor = ''

background color

$backgroundImage

public string $backgroundImage = ''

background image

$captchaProvider

provider for captcha (-/google/hCaptcha/friendlyCaptcha)

public string $captchaProvider = '-'

$captchaSecretKey

secret key

public string $captchaSecretKey = ''

$captchaSiteKey

site key

public string $captchaSiteKey = ''

$customCss

public string $customCss = ''

custom CSS

$displayMode

public string $displayMode = 'LIST_GALLERY'

display mode

$followReferrals

public bool $followReferrals = true

follow referrals

public string $footer = '<p style="text-align: left;"><span style="color: rgb(255, 255, 255);">Powered by LDAP Account Manager</span></p>'

footer HTML

$header

public string $header = '<p><a href="https://www.ldap-account-manager.org/" target="new_window"><img alt="help" class="align-middle" src="../../graphics/logo24.png" style="height:24px; width:24px"> <span style="color: rgb(255, 255, 255);">LDAP Account Manager </span></a></p><p>&nbsp;<br></p>'

header HTML

$language

public string $language = 'en_gb'

language

$ldapConnectionPassword

public string $ldapConnectionPassword = ''

password of technical user

$ldapConnectionUser

public string $ldapConnectionUser = ''

LDAP technical user for connection

$loginAttributeText

describing text for search attribute

public string $loginAttributeText = ''

$loginCaption

describing text for user login

public string $loginCaption = '<p><strong>Welcome to LAM white pages. Please enter your user name and password.</strong></p>'

$loginFooter

describing text for user login

public string $loginFooter = '<p style="text-align: left;"><span style="color: rgb(255, 255, 255);">Powered by LDAP Account Manager</span></p>'

$loginHeader

header HTML for login

public string $loginHeader = '<p><a href="https://www.ldap-account-manager.org/" target="new_window"><img alt="help" class="align-middle" src="../../graphics/logo24.png" style="height:24px; width:24px"> <span style="color: rgb(255, 255, 255);">LDAP Account Manager </span></a></p><p>&nbsp;<br></p>'

$passwordLabel

label for password input

public string $passwordLabel = ''

$primaryColor

public string $primaryColor = ''

primary color

$serverUrl

public string $serverUrl = 'ldap://example.com'

LDAP server URL

$tabs

public array<string|int, mixed> $tabs = []

tabs for white pages

$twoFactorAllowToRememberDevice

public bool $twoFactorAllowToRememberDevice = false

allow remembering the device

$twoFactorAuthenticationAttribute

public string $twoFactorAuthenticationAttribute = 'uid'

attribute that contains 2FA username

$twoFactorAuthenticationCaption

public string $twoFactorAuthenticationCaption = ''

caption

$twoFactorAuthenticationClientId

public string $twoFactorAuthenticationClientId = ''

client ID

$twoFactorAuthenticationDomain

public string $twoFactorAuthenticationDomain = ''

2FA domain

$twoFactorAuthenticationInsecure

public bool $twoFactorAuthenticationInsecure = false

allow insecure connection

$twoFactorAuthenticationLabel

public string $twoFactorAuthenticationLabel = ''

label

$twoFactorAuthenticationSecretKey

public string $twoFactorAuthenticationSecretKey = ''

secret key

$twoFactorAuthenticationType

public string $twoFactorAuthenticationType = \LAM\LIB\TWO_FACTOR\TwoFactorProviderService::TWO_FACTOR_NONE

provider type

$twoFactorAuthenticationURL

public string $twoFactorAuthenticationURL = 'https://localhost'

authentication URL

$twoFactorRememberDeviceDuration

public int $twoFactorRememberDeviceDuration = 28800

timeout for remembering the device

$twoFactorRememberDevicePassword

public string $twoFactorRememberDevicePassword = ''

password to reset remembered devices

$useForAllOperations

public bool $useForAllOperations = false

use technical user for all operations

$useTLS

public bool $useTLS = false

activate TLS

Methods

export()

Exports the profile as an array.

public export() : array<string|int, mixed>
Return values
array<string|int, mixed>

data

Search results