Interface Role

A role in the Archon policy engine. This will not include the permissions associated with the role. These permissions can only be managed via the Archon policy service or editing archon.yaml.

interface Role {
    description?: string;
    name: RoleName;
    parent?: Role;
    privileged: boolean;
}

Properties

description? name parent? privileged

Properties

Optionaldescription

description?: string

A human-readable description of the role, defined in the archon.yaml file.

name

name: RoleName

The name of the role, defined in the archon.yaml file.

Optionalparent

parent?: Role

The parent role of this role, if any. If this role has no parent, this field will be omitted.

privileged

privileged: boolean

Whether the role is privileged. Privileged roles require reauthentication to switch to.

Settings

Member Visibility

On This Page

Properties