Function buildLdapIdentityStore

buildLdapIdentityStore(
    options: BuildLdapIdentityStoreOptions,
): {
    kind: "ldap";
    name: string;
    params: {
        bind_password?: string;
        bind_username?: string;
        groups?: { dn: string; roles?: string[] }[];
        realm?: string;
        search_base_dn?: string;
        search_user_filter?: string;
        servers?: { address: string; port?: number }[];
    } & { [k: string]: unknown };
}
Build an LDAP identity store configuration

Creates an LDAP-based identity store for user authentication. Uses the authcrunch wrapper structure: name, kind, params
Parameters
- options: BuildLdapIdentityStoreOptions
  Store options
Returns {
    kind: "ldap";
    name: string;
    params: {
        bind_password?: string;
        bind_username?: string;
        groups?: { dn: string; roles?: string[] }[];
        realm?: string;
        search_base_dn?: string;
        search_user_filter?: string;
        servers?: { address: string; port?: number }[];
    } & { [k: string]: unknown };
}
Validated LDAP identity store configuration
Example
```
import { buildLdapIdentityStore } from "@.../caddy-api-client/plugins/caddy-security";

const store = buildLdapIdentityStore({
  name: "ldapdb",
  servers: [{ address: "ldap.example.com", port: 389 }],
  bindUsername: "cn=admin,dc=example,dc=com",
  bindPassword: "secret",
  searchBaseDn: "ou=users,dc=example,dc=com",
  searchUserFilter: "(uid={username})",
});
```
- Defined in src/plugins/caddy-security/builders.ts:191

Function buildLdapIdentityStore

Parameters

Returns { kind: "ldap"; name: string; params: { bind_password?: string; bind_username?: string; groups?: { dn: string; roles?: string[] }[]; realm?: string; search_base_dn?: string; search_user_filter?: string; servers?: { address: string; port?: number }[]; } & { [k: string]: unknown };}

Example

Settings

Returns {
kind: "ldap";
name: string;
params: {
bind_password?: string;
bind_username?: string;
groups?: { dn: string; roles?: string[] }[];
realm?: string;
search_base_dn?: string;
search_user_filter?: string;
servers?: { address: string; port?: number }[];
} & { [k: string]: unknown };
}