hubcli role get¶

Returns the properties of a specified role.

The command has the following format:

hubcli role get [flags] rolename

flags: One or more flags for the command that provide additional control over execution.
rolename: The name of the role for which information is returned.

The following flags are available:

-c string or --connection string: Specifies the name of the connection to use. If you do not specify this option, then the default connection is used. If there is no default connection, then you must specify a connection. The first connection created for the Altair SLC Hub instance is set by default as the default Altair SLC Hub instance, but a different default connection can be set using the hubcli connection use command.
--debug: Enables debug logging.
-h or --help: Returns help information for this command.
--json: Returns the properties of the role in JSON format.
--yaml: Returns the properties of the role in yaml format.

Examples¶

Running hubcli role get Admin returns the role details including its permissions:

 Role Details
 Name         Admin
 Description  The Admin role has full permissions in Hub.
 ID           c31f644a-331e-4e0a-b17f-5fa0a7769846
 Created      2026-09-09 06:16:41 UTC
 Permissions   OBJECT  OBJECT MATCHER  ACTIONS  EFFECT
               *       simple          *        Allow

Running hubcli role get Admin --json returns the same information in JSON format:

{"id":"c31f644a-331e-4e0a-b17f-5fa0a7769846","name":"Admin","description":"The Admin role has full permissions in Hub.","created":"2026-09-09T06:16:41.024531Z","modified":"2026-09-09T06:16:41.024531Z","permissions":[{"object":"*","objectMatcher":"","actions":["*"],"effect":"Allow"}],"system":false}

Running hubcli role get Admin --yaml returns the same information in YAML format:

created: "2026-09-09T06:16:41.024531Z"
description: The Admin role has full permissions in Hub.
id: c31f644a-331e-4e0a-b17f-5fa0a7769846
modified: "2026-09-09T06:16:41.024531Z"
name: Admin
permissions:
- actions:
  - '*'
  effect: Allow
  object: '*'
  objectMatcher: ""
system: false