Skip to content
SHC Docs

shc auth create-ldap-bind

make an LDAP bind for a consumer SHC does not run

Make the identity something outside the catalog binds to the system Keycloak’s LDAP face as: a firewall, a NAS, a host’s SSSD. It is made by the ldap socket itself, as an installed app’s ldap plug is, so it reads the tenant’s own users and groups and nothing of another tenant.

The answer is the bind DN, its password, and the DNs to search under. The password is shown when the bind is made and is not read back afterwards: running it again answers state exists and no password. --rotate-secret regenerates the secret of a bind that is there and shows the new password; the old one is then refused for a new bind. --fields password -o text prints the password alone, and fails for a bind that is there unless --rotate-secret is given.

The LDAP face must be on (modules.keycloak.vars.enableLdap), and a new bind is an ldap edge, which the sso entitlement covers. A user binds with their own password, so an account with a one-time code or a pending required action cannot. Requires platform:manage (local socket, or a logged-in platform admin).

shc auth create-ldap-bind <name> [flags]
shc auth create-ldap-bind pfsense -t corp
shc auth create-ldap-bind pfsense -t corp --rotate-secret --fields password -o text
-h, --help help for create-ldap-bind
--rotate-secret regenerate the secret of a bind that is there and show the new password
-t, --tenant string tenant whose realm holds the bind
--config stringArray extra YAML config file to layer on top of auto-discovered config; repeatable, later files win
-d, --debug enable debug mode (default: $SHC_DEBUG)
-e, --environment string environment name (default: "prod", or "default" on an estate with no licence and no trial; $SHC_ENVIRONMENT and shc ctx -e override it, and the "master" tenant is always "default")
--exclude string comma-separated dotted paths to drop
--fields string comma-separated columns/keys to show (and their order)
--filter string comma-separated dotted paths to keep (drops everything else)
-o, --output string output format: tty|text|json|yaml (default: $SHC_OUTPUT)
-s, --stack string stack name (default: $SHC_STACK)
-v, --verbose verbose output (default: $SHC_VERBOSE)
  • shc auth - authenticate the CLI against a cluster