`archivebox.config.ldap`

Module Contents

Classes

LDAP authentication configuration.

API

class archivebox.config.ldap.LDAPConfig[source]

Bases: archivebox.config.configset.BaseConfigSet

LDAP authentication configuration.

Only loads and validates if django-auth-ldap is installed. These settings integrate with Django’s LDAP authentication backend.

toml_section_header: str[source]: ‘LDAP_CONFIG’

_scope: str[source]: ‘PrivateAttr(…)’

LDAP_ENABLED: bool[source]: ‘Field(…)’

LDAP_SERVER_URI: str | None[source]: ‘Field(…)’

LDAP_BIND_DN: str | None[source]: ‘Field(…)’

LDAP_BIND_PASSWORD: str | None[source]: ‘Field(…)’

LDAP_USER_BASE: str | None[source]: ‘Field(…)’

LDAP_USER_FILTER: str[source]: ‘Field(…)’

LDAP_USERNAME_ATTR: str[source]: ‘Field(…)’

LDAP_FIRSTNAME_ATTR: str[source]: ‘Field(…)’

LDAP_LASTNAME_ATTR: str[source]: ‘Field(…)’

LDAP_EMAIL_ATTR: str[source]: ‘Field(…)’

LDAP_CREATE_SUPERUSER: bool[source]: ‘Field(…)’

validate_ldap_config() → tuple[bool, str][source]

Validate that all required LDAP settings are configured.

Returns: Tuple of (is_valid, error_message)