Skip to content
SHC Docs

shc tenant role

manage the realm roles of a tenant’s realm

Manage the realm roles of a tenant’s Keycloak realm: roles an app reads from the token, which SHC gives no meaning. A default role is held by every user of the realm, new and existing.

SHC’s own access roles are granted with shc user grant, and these verbs neither make, change nor remove them, nor Keycloak’s own realm roles: a name with a colon or a slash is refused, and so are tenant, offline_access, uma_authorization, admin, create-realm, realm-admin and default-roles-. Master’s realm is refused.

shc tenant role add cloud "Portal Learner" --description "holds the learning grant"
shc tenant role set cloud "Portal Learner" --default
shc tenant role ls cloud
-h, --help help for role
--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)