Skip to main content

Get-ZrRole

Lists the security roles defined in the cluster, including the permissions each role confers.

Syntax

Get-ZrRole
[-Managers <string[]>] [-Port <int>] [-Token <string>] [-TimeoutSec <int>]

Description

Get-ZrRole queries the first available manager and emits a SecurityRoleInfo object for each role known to the cluster, including the permissions each role confers. Requires a connected manager (an active workspace or explicit -Managers) and an admin token. Use it to discover the role names you pass to Grant-ZrRole and Revoke-ZrRole. See Authorization & RBAC for the role model.

Parameters

ParameterTypeRequiredDescription
-Managersstring[]NoManagement Service endpoints to target; when omitted the active workspace's managers are used.
-PortintNoManagement Service port for bare-host managers. Default 7801.
-TokenstringNoAdmin bearer token for authenticated control-plane calls.
-TimeoutSecintNoPer-request timeout in seconds. Default 30.

Examples

List all defined security roles and their permissions.

Get-ZrRole