Interface Role

Represents a custom user role that grants permissions.

interface Role {
    color: string;
    createdAt: string;
    highlighted: boolean;
    id: number;
    name: string;
    permissions: number;
    position: number;
    updatedAt: string;
}

Properties

color: string

The hex code assigned to this role. If no hex code is assigned, the string will be empty

createdAt: string

The date that the role was created.

highlighted: boolean

Whether the role is publicly visible as a badge on user profiles.

id: number

The ID of the Role in the database.

name: string

The name of the role.

permissions: number

A bitmask that represents the sum of all permissions granted to the role.

position: number

An index for the role’s position. The higher the position, the more priority the role has over other roles.

updatedAt: string

The date that the role was updated.