Skip to main content

ExternalTokenInternetAccount

Auto-generated config schema for the current JBrowse release — see the config guide for concepts. Provided by the authentication plugin. View source.

Example usage

For a token the user pastes in, or that an embedding portal hands over. JBrowse does not obtain the token itself — it prompts for one, then sends it on every request to a matching domain.

{
  type: 'ExternalTokenInternetAccount',
  internetAccountId: 'portalToken',
  name: 'Data portal token',
  domains: ['api.myportal.org'],
}

See the Config slots section below for all available configuration fields.

Config slots

These slots are top-level fields of the account's entry in internetAccounts. Slot types (fileLocation, frozen, ...) are explained in the config slot types reference. Slots a base configuration contributes are listed here too, so this table is the whole surface.

SlotDescription
validateWithHEAD
boolean = true		validate the token with a HEAD request before using it
Inherited from BaseInternetAccount5 slots
name
string = ''		descriptive name of the internet account
description
string = ''		a description of the internet account
authHeader
string = 'Authorization'		request header for credentials
tokenType
string = ''		a custom name for a token to include in the header
domains
stringArray = []		array of valid domains the url can contain to use this account