Skip to content
SHC Docs

shc user leave

take a user out of a group

Take a user out of a group of their tenant’s realm. A user who is not in the group, or a group that is not there, changes nothing. The user loses the roles the group carried, so a leave that would take the tenant’s last manager is refused.

shc user leave <username> <group> [flags]
--force-last-admin leave even when it leaves the tenant with no manager or the platform with no admin (platform admins only)
-h, --help help for leave
-t, --tenant string target tenant (required for platform admins)
--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 user - manage users and access roles