Security¶

Cmdlets for querying security role definitions in JIM. Roles define permissions that can be assigned to users or API keys.

Get-JIMRole¶

Retrieves security role definitions from JIM.

Get-JIMRole [-Name <string>]

Name	Type	Required	Default	Description
`Name`	`string`	No		Filter roles by name. Supports wildcards (e.g., `"Admin*"`).

Role objects with id, name, and description properties.

List all roles

Get-JIMRole

Get the Administrator role

Get-JIMRole -Name "Administrator"

Get role names and descriptions

Get-JIMRole | Select-Object name, description

Find the Administrator role ID for use with New-JIMApiKey

$adminRole = Get-JIMRole -Name "Administrator"
New-JIMApiKey -Name "Admin Key" -RoleIds @($adminRole.id) -PassThru

Role Management

Roles are currently read-only and defined by the system. Role assignment to metaverse objects is tracked in GitHub issue #467.