Bitwarden directory connector cli
services.bitwarden-directory-connector-cli.domain
The domain the Bitwarden/Vaultwarden is accessible on.
Type: string
Example
"https://vaultwarden.example.com"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.enable
Whether to enable Bitwarden Directory Connector.
Type: boolean
Default
false
Example
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.interval
The interval when to run the connector. This uses systemd's OnCalendar syntax.
Type: string
Default
"*:0,15,30,45"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.ldap
Options to configure the LDAP connection.
If you used the desktop application to test the configuration you can find the settings by searching for ldap in ~/.config/Bitwarden\ Directory\ Connector/data.json.
Type: attribute set of (JSON value)
Default
{ }
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.ldap.ad
Whether the LDAP Server is an Active Directory.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.ldap.hostname
The host the LDAP is accessible on.
Type: string
Example
"ldap.example.com"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.ldap.pagedSearch
Whether the LDAP server paginates search results.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.ldap.port
Port LDAP is accessible on.
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default
389
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.ldap.rootPath
Root path for LDAP.
Type: string
Example
"dc=example,dc=com"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.ldap.ssl
Whether to use TLS.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.ldap.startTls
Whether to use STARTTLS.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.ldap.username
The user to authenticate as.
Type: string
Example
"cn=admin,dc=example,dc=com"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.package
The bitwarden-directory-connector-cli package to use.
Type: package
Default
pkgs.bitwarden-directory-connector-cli
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.secrets.bitwarden.client_path_id
Path to file that contains Client ID.
Type: string
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.secrets.bitwarden.client_path_secret
Path to file that contains Client Secret.
Type: string
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.secrets.ldap
Path to file that contains LDAP password for user in {option}ldap.username
**Type:**string`
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync
Options to configure what gets synced.
If you used the desktop application to test the configuration you can find the settings by searching for sync in ~/.config/Bitwarden\ Directory\ Connector/data.json.
Type: attribute set of (JSON value)
Default
{ }
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.creationDateAttribute
Attribute that lists a user's creation date.
Type: string
Example
"whenCreated"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.emailPrefixAttribute
The attribute that contains the users username.
Type: string
Example
"accountName"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.emailSuffix
Suffix for the email, normally @example.com.
Type: string
Example
"@example.com"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.groupFilter
LDAP filter for groups.
Type: string
Default
""
Example
"(cn=sales)"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.groupNameAttribute
Attribute for a name of group.
Type: string
Default
"cn"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.groupObjectClass
A class that groups will have.
Type: string
Default
"groupOfNames"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.groupPath
Group directory, relative to root.
Type: string
Default
"ou=groups"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.groups
Whether to sync ldap groups into BitWarden.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.largeImport
Enable if you are syncing more than 2000 users/groups.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.memberAttribute
Attribute that lists members in a LDAP group.
Type: string
Example
"uniqueMember"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.overwriteExisting
Remove and re-add users/groups, See https://bitwarden.com/help/user-group-filters/#overwriting-syncs for more details.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.removeDisabled
Remove users from bitwarden groups if no longer in the ldap group.
Type: boolean
Default
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.useEmailPrefixSuffix
If a user has no email address, combine a username prefix with a suffix value to form an email.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.userEmailAttribute
Attribute for a users email.
Type: string
Default
"mail"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.userFilter
LDAP filter for users.
Type: string
Default
""
Example
"(memberOf=cn=sales,ou=groups,dc=example,dc=com)"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.userObjectClass
Class that users must have.
Type: string
Default
"inetOrgPerson"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.userPath
User directory, relative to root.
Type: string
Default
"ou=users"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.sync.users
Sync users.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix
services.bitwarden-directory-connector-cli.user
User to run the program.
Type: string
Default
"bwdc"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/bitwarden-directory-connector-cli.nix