Skip to content
SHC Docs

shc tenant realm

show or set a tenant realm’s login settings

Show or set the login settings of a tenant’s Keycloak realm.

display-name is the name the login page and the realm’s mail show, in place of the realm’s own name. registration is whether the login page lets a visitor make their own account, and reset-password whether it offers a forgotten-password link. verify-email requires an account to confirm its email before sign-in. The mail-* settings state the realm’s outgoing mail; a left-out mail key keeps what the realm has. mail-password accepts only - and reads stdin. With no key=value arguments the realm’s settings are shown; a setting left out is left as the realm has it. Master’s realm is the platform’s own and is refused.

Which other tenants’ deployments may place clients in this realm is the tenant’s keycloak.realm_clients config key.

shc tenant realm <tenant> [display-name=<name>] [registration=true|false] [reset-password=true|false] [verify-email=true|false] [mail-key=value...] [flags]
shc tenant realm cloud
shc tenant realm cloud registration=true reset-password=true
shc tenant realm cloud "display-name=Self Hosted Cloud"
printf '%s' "$PW" | shc tenant realm cloud verify-email=true mail-host=mail.example.com [email protected] [email protected] mail-password=-
-h, --help help for realm
--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)
-t, --tenant string tenant name (default: $SHC_TENANT)
-v, --verbose verbose output (default: $SHC_VERBOSE)