Skip to content

Role🔗

Definition🔗

class Role:
    # The role identifier `managed:builtins:editor:permissions`
    name: str
    # Optional display
    display_name: typing.Optional[str]
    # Name of the team.
    group_name: typing.Optional[str]
    # Role description
    description: typing.Optional[str]
    # Do not show this role
    hidden: bool

Methods🔗

to_json🔗

Converts this object into a representation that can easily be encoded to JSON.

def to_json() -> dict[str, object]

from_json🔗

Builds this object from a JSON-decoded dict.

@classmethod
def from_json(data: dict[str, typing.Any]) -> typing.Self

See also🔗

Role