Skip to main content

HTTPBasicInternetAccount

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

Example usage

An entry in the config's internetAccounts. JBrowse prompts for the username and password the first time a file under one of domains is opened, and sends them as an Authorization: Basic … header from then on.

{
  type: 'HTTPBasicInternetAccount',
  internetAccountId: 'myLabServer',
  name: 'My lab server',
  description: 'Sequencing data behind the lab htaccess',
  domains: ['data.mylab.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
tokenType
string = 'Basic'		a custom name for a token to include in the header
validateWithHEAD
boolean = true		validate the token with a HEAD request before using it
Inherited from BaseInternetAccount4 slots
name
string = ''		descriptive name of the internet account
description
string = ''		a description of the internet account
authHeader
string = 'Authorization'		request header for credentials
domains
stringArray = []		array of valid domains the url can contain to use this account