Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SubUser

Hierarchy

  • SubUser

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

client

client: PteroClient

Readonly createdAt

createdAt: Date

The date the subuser account was created.

Readonly createdTimestamp

createdTimestamp: number

email

email: string

The email of the subuser.

enabled

enabled: boolean

Whether the subuser has two-factor authentication enabled.

image

image: string

The URL of the subuser account image.

permissions

permissions: Permissions

The permissions the subuser has.

Readonly serverId

serverId: string

The identifier of the server the subuser belongs to.

username

username: string

The username of the subuser.

Readonly uuid

uuid: string

The UUID of the user.

Accessors

panelURL

  • get panelURL(): string

Methods

_patch

  • _patch(data: any): void

setPermissions

  • setPermissions(...permissions: string[]): Promise<SubUser>

  • Updates the permissions of the subuser.

    Parameters

    • Rest ...permissions: string[]

      The permissions to set.

    Returns Promise<SubUser>

    The updated subuser instance.

Generated using TypeDoc