Skip to content
SHC Docs

shc tenant role set

change a realm role of a tenant’s realm

Change a realm role’s description, or whether every user of the realm holds it (--default=false takes it back).

shc tenant role set <tenant> <role> [flags]
--default hand the role to every user of the realm, or with =false take it back
--description string what the role means to the app that reads it
-h, --help help for set
--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)