Skip to content
SHC Docs

shc user group

manage the groups of a tenant’s realm

Manage the groups of a tenant’s Keycloak realm.

SHC makes three groups itself, and these verbs neither make nor remove them: shc-app-access, which every new user joins and whose role mappings are the realm’s default access, and shc-admins and shc-users, which carry the realm roles tenant:manage and tenant. Users join and leave them like any other. SHC reads no meaning into any other name.

A group can carry roles, mapped in Keycloak. Joining one that does is a grant and goes through the gate a grant goes through. Leaving one, or removing it, is refused when it would leave the tenant with no manager.

Over the LDAP face a group is cn=,ou=groups,ou=,, and a member’s entry names it in memberOf.

shc user group add pfsense-admins -t corp
shc user join alice pfsense-admins -t corp
shc user group ls -t corp
-h, --help help for group
--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)