Skip to content

DOCS-9076: Add LDAP auth/authz parameters #2774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 148 additions & 0 deletions source/includes/options-conf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1761,4 +1761,152 @@ inherit:
file: options-mongod.yaml
replacement:
program: :program:`mongod`
---
program: conf
name: security.ldap.servers
type: string
directive: setting
inherit:
name: ldapServers
program: mongod
file: options-mongod.yaml
replacement:
program: ":program:`mongod` or :program:`mongos`"
---
program: conf
name: security.ldap.bind.queryUser
type: string
directive: setting
inherit:
name: ldapQueryUser
program: mongod
file: options-mongod.yaml
replacement:
program: ":program:`mongod` or :program:`mongos`"
queryPassword: ":setting:`~security.ldap.bind.queryPassword`"
bindWithOSDefaults: ":setting:`~security.ldap.bindWithOSDefaults`"
role: ":setting:`~security.ldap.bind.queryUser`"
transform: :setting:`security.ldap.userToDNMapping`
---
program: conf
name: security.ldap.bind.queryPassword
type: string
directive: setting
inherit:
name: ldapQueryPassword
program: mongod
file: options-mongod.yaml
replacement:
program: ":program:`mongod` or :program:`mongos`"
queryUser: ":setting:`~security.ldap.bind.queryUser`"
role: ":setting:`~security.ldap.bind.queryPassword`"
---
program: conf
name: security.ldap.bind.useOSDefaults
type: boolean
directive: setting
inherit:
name: ldapBindWithOSDefaults
program: mongod
file: options-mongod.yaml
replacement:
program: ":program:`mongod` or :program:`mongos`"
queryUser: ":setting:`~security.ldap.bind.queryUser`"
queryPassword: ":setting:`~security.ldap.bind.queryPassword`"
role: ":setting:`~security.ldap.bind.useOSDefaults`"
---
program: conf
name: security.ldap.bind.method
type: string
directive: setting
inherit:
name: ldapBindMethod
program: mongod
file: options-mongod.yaml
replacement:
program: ":program:`mongod` or :program:`mongos`"
queryUser: ":setting:`~security.ldap.queryUser`"
queryPassword: ":setting:`~security.ldap.queryPassword`"
role: ":setting:`~security.ldap.bind.method`"
---
program: conf
name: security.ldap.bind.saslMechanisms
type: string
directive: setting
inherit:
name: ldapBindSASLMechanisms
program: mongod
file: options-mongod.yaml
replacement:
program: ":program:`mongod` or :program:`mongos`"
bindMethod: :setting:`~security.ldap.bind.method`
---
program: conf
name: security.ldap.transportSecurity
type: string
directive: setting
inherit:
name: ldapTransportSecurity
program: mongod
file: options-mongod.yaml
replacement:
program: ":program:`mongod` or :program:`mongos`"
role: ":setting:`~security.ldap.transportSecurity`"
---
program: conf
name: security.ldap.timeoutMS
type: int
directive: setting
inherit:
name: ldapTimeoutMS
program: mongod
file: options-mongod.yaml
replacement:
program: ":program:`mongod` or :program:`mongos`"
role: ":setting:`~security.ldap.timeoutMS`"
---
program: conf
name: security.ldap.userToDNMapping
type: string
directive: setting
inherit:
name: ldapUserToDNMapping
program: mongod
file: options-mongod.yaml
replacement:
program: ":program:`mongod` or :program:`mongos`"
role: ":setting:`~security.ldap.userToDNMapping`"
---
program: conf
name: security.ldap.authz.queryTemplate
type: string
directive: setting
inherit:
name: ldapAuthzQueryTemplate
program: mongod
file: options-mongod.yaml
replacement:
program: ":program:`mongod`"
mapping: :setting:`~security.ldap.userToDNMapping`
---
program: conf
name: setParameter.ldapUserCacheInvalidationInterval
type: int
directive: setting
default: 30
pre: |
For use with {{program}} servers using :ref:`security-ldap-external`.

The interval (in seconds) {{program}} waits
between external user cache flushes. After {{program}} flushes the external
user cache, the next operation an LDAP-authorized user, MongoDB
reacquires authorization data from the LDAP server.

Increasing the value specified increases the amount of time
{{program}} and the LDAP server can be out of sync, but reduces the load on
the LDAP server. Conversely, decreasing the value specified
decreases the time {{program}} and the LDAP server can be out of sync while
increasing the load on the LDAP server.
replacement:
program: ":program:`mongod` or :program:`mongos`"
...
Loading