Skip to content
SHC Docs

shc user ls

list users in a tenant realm

List the users in a tenant’s Keycloak realm with the SHC access roles each one holds.

Two role columns, because the difference decides what you can do about a grant:

roles the effective set: direct mappings plus everything inherited from a group membership or a composite role. This is what the user’s token carries and what the app gate actually evaluates. direct_roles the subset mapped on the user itself. shc user grant writes here and shc user revoke can only remove from here.

A role in roles but not in direct_roles came from a group. To take it away, change the group’s mappings or the user’s membership; revoking it per-user will not work.

shc user ls [flags]
-h, --help help for ls
-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