@deephaven/auth-plugin

@deephaven/auth-plugin

A library for using types related to AuthPlugins. Authentication plugins are used to provide custom authentication to the Web UI, and can log the user in using custom authentication handlers in deephaven-core.

Install

npm install --save @deephaven/auth-plugin

Usage

To create your own authentication plugin, you must build and export your own module. You can start with the deephaven-js-plugin-template to get started, and export an AuthPlugin property conforming to the AuthPlugin interface. In your AuthPlugin, you must specify a Component which will display when the plugin is loaded, and the isAvailable method for specifying whether the plugin is available given the current server configuration. Login plugins installed on the server will take priority in the order specified, falling back to the core plugins if none of the login plugins are available for the current server configuration. If you wish to create your own plugin that always takes priority, just return true from your isAvailable method.

For an example of a basic authentication plugin, take a look at AuthPluginAnonymous which just displays a loading spinner and tries to login anonymously. You can display your own UI instead of a loading spinner with input fields and then attempt to login.