-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
abx_plugin_ldap_auth.config
Nick Sweeting edited this page Nov 13, 2024
·
2 revisions
:allowtitles:
:class: autosummary longtable
:align: left
* - {py:obj}`LdapConfig <abx_plugin_ldap_auth.config.LdapConfig>`
- ```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig
:summary:
```
:class: autosummary longtable
:align: left
* - {py:obj}`get_ldap_lib <abx_plugin_ldap_auth.config.get_ldap_lib>`
- ```{autodoc2-docstring} abx_plugin_ldap_auth.config.get_ldap_lib
:summary:
```
:class: autosummary longtable
:align: left
* - {py:obj}`LDAP_LIB <abx_plugin_ldap_auth.config.LDAP_LIB>`
- ```{autodoc2-docstring} abx_plugin_ldap_auth.config.LDAP_LIB
:summary:
```
* - {py:obj}`LDAP_SEARCH <abx_plugin_ldap_auth.config.LDAP_SEARCH>`
- ```{autodoc2-docstring} abx_plugin_ldap_auth.config.LDAP_SEARCH
:summary:
```
* - {py:obj}`LDAP_CONFIG <abx_plugin_ldap_auth.config.LDAP_CONFIG>`
- ```{autodoc2-docstring} abx_plugin_ldap_auth.config.LDAP_CONFIG
:summary:
```
:canonical: abx_plugin_ldap_auth.config.LDAP_LIB
:value: >
None
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LDAP_LIB
```
:canonical: abx_plugin_ldap_auth.config.LDAP_SEARCH
:value: >
None
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LDAP_SEARCH
```
:canonical: abx_plugin_ldap_auth.config.get_ldap_lib
```{autodoc2-docstring} abx_plugin_ldap_auth.config.get_ldap_lib
```
:canonical: abx_plugin_ldap_auth.config.LdapConfig
Bases: {py:obj}`abx_spec_config.base_configset.BaseConfigSet`
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig
```
```{rubric} Initialization
```
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.__init__
```
````{py:attribute} LDAP_ENABLED
:canonical: abx_plugin_ldap_auth.config.LdapConfig.LDAP_ENABLED
:type: bool
:value: >
'Field(...)'
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.LDAP_ENABLED
```
````
````{py:attribute} LDAP_SERVER_URI
:canonical: abx_plugin_ldap_auth.config.LdapConfig.LDAP_SERVER_URI
:type: str
:value: >
'Field(...)'
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.LDAP_SERVER_URI
```
````
````{py:attribute} LDAP_BIND_DN
:canonical: abx_plugin_ldap_auth.config.LdapConfig.LDAP_BIND_DN
:type: str
:value: >
'Field(...)'
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.LDAP_BIND_DN
```
````
````{py:attribute} LDAP_BIND_PASSWORD
:canonical: abx_plugin_ldap_auth.config.LdapConfig.LDAP_BIND_PASSWORD
:type: str
:value: >
'Field(...)'
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.LDAP_BIND_PASSWORD
```
````
````{py:attribute} LDAP_USER_BASE
:canonical: abx_plugin_ldap_auth.config.LdapConfig.LDAP_USER_BASE
:type: str
:value: >
'Field(...)'
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.LDAP_USER_BASE
```
````
````{py:attribute} LDAP_USER_FILTER
:canonical: abx_plugin_ldap_auth.config.LdapConfig.LDAP_USER_FILTER
:type: str
:value: >
'Field(...)'
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.LDAP_USER_FILTER
```
````
````{py:attribute} LDAP_CREATE_SUPERUSER
:canonical: abx_plugin_ldap_auth.config.LdapConfig.LDAP_CREATE_SUPERUSER
:type: bool
:value: >
'Field(...)'
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.LDAP_CREATE_SUPERUSER
```
````
````{py:attribute} LDAP_USERNAME_ATTR
:canonical: abx_plugin_ldap_auth.config.LdapConfig.LDAP_USERNAME_ATTR
:type: str
:value: >
'Field(...)'
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.LDAP_USERNAME_ATTR
```
````
````{py:attribute} LDAP_FIRSTNAME_ATTR
:canonical: abx_plugin_ldap_auth.config.LdapConfig.LDAP_FIRSTNAME_ATTR
:type: str
:value: >
'Field(...)'
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.LDAP_FIRSTNAME_ATTR
```
````
````{py:attribute} LDAP_LASTNAME_ATTR
:canonical: abx_plugin_ldap_auth.config.LdapConfig.LDAP_LASTNAME_ATTR
:type: str
:value: >
'Field(...)'
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.LDAP_LASTNAME_ATTR
```
````
````{py:attribute} LDAP_EMAIL_ATTR
:canonical: abx_plugin_ldap_auth.config.LdapConfig.LDAP_EMAIL_ATTR
:type: str
:value: >
'Field(...)'
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.LDAP_EMAIL_ATTR
```
````
````{py:method} validate()
:canonical: abx_plugin_ldap_auth.config.LdapConfig.validate
````
````{py:property} LDAP_CONFIG_IS_SET
:canonical: abx_plugin_ldap_auth.config.LdapConfig.LDAP_CONFIG_IS_SET
:type: bool
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.LDAP_CONFIG_IS_SET
```
````
````{py:property} LDAP_USER_ATTR_MAP
:canonical: abx_plugin_ldap_auth.config.LdapConfig.LDAP_USER_ATTR_MAP
:type: typing.Dict[str, str]
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.LDAP_USER_ATTR_MAP
```
````
````{py:property} AUTHENTICATION_BACKENDS
:canonical: abx_plugin_ldap_auth.config.LdapConfig.AUTHENTICATION_BACKENDS
:type: typing.List[str]
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.AUTHENTICATION_BACKENDS
```
````
````{py:property} AUTH_LDAP_USER_SEARCH
:canonical: abx_plugin_ldap_auth.config.LdapConfig.AUTH_LDAP_USER_SEARCH
:type: typing.Optional[object]
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LdapConfig.AUTH_LDAP_USER_SEARCH
```
````
:canonical: abx_plugin_ldap_auth.config.LDAP_CONFIG
:value: >
'LdapConfig(...)'
```{autodoc2-docstring} abx_plugin_ldap_auth.config.LDAP_CONFIG
```
- π’ Quickstart
- π₯οΈ Install
- π³ Docker
- β‘οΈ Supported Sources
- β¬ οΈ Supported Outputs
- οΉ©Command Line
- π Web UI
- π§© Browser Extension
- πΎ REST API / Webhooks
- π Python API / REPL / SQL API
- βοΈ Configuration
- π¦ Dependencies
- πΏ Disk Layout
- π Security Overview
- π Developer Documentation
- Upgrading
- Setting up Storage (NFS/SMB/S3/etc)
- Setting up Authentication (SSO/LDAP/etc)
- Setting up Search (rg/sonic/etc)
- Scheduled Archiving
- Publishing Your Archive
- Chromium Install
- Cookies & Sessions Setup
- Merging Collections
- Troubleshooting
- βοΈ Web Archiving Community
- Background & Motivation
- Comparison to Other Tools
- Architecture Diagram
- Changelog & Roadmap