Authentication interface used to identify the user. Provides the login and logout lifecycle.

  • Plugin category = Authentication

Hierarchy

Properties

logoutSupported: boolean

If true the user may logout from the application.

name: string
user: null | User

The currently logged in user.

userSettingsStorage?: UserSettingsStorage

Optional settings storage which is used to store the user settings.

Methods

  • Will be called once after the plugin was loaded.

    Parameters

    • pDescriptor: PluginDescriptor

      Plugin descriptor for this plugin.

    • pSettings: unknown

      Optional plugin specific settings which may be defined as part of the application settings.

    Returns Promise<void>

  • Returns Promise<void>

  • Returns Promise<void>

Generated using TypeDoc