Skip to main content

ExternalTokenInternetAccount

Auto-generated from the config schema in the source. See the config guide for concepts. Provided by the authentication plugin. View source.

Sends a token that the user pastes in, or that an embedding portal supplies, with every request to a matching domain.

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'],
}

Config slots

Account 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.

Slot Description
validateWithHEAD
boolean = true		 validate the token with a HEAD request before using it
Inherited from BaseInternetAccount 5 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