Skip to main content

HTTPBasicInternetAccount

Auto-generated @jbrowse/mobx-state-tree API for the current JBrowse release — see pluggable elements for concepts. Provided by the authentication plugin. View source.

Internet account that authenticates requests with an HTTP Basic username/password the user enters through a dialog, optionally validated with a HEAD request. See TokenEntryInternetAccount for the shared behavior.

The configuration slots for this model are documented on its config schema page.

Members a composed model contributes are listed here too, so these tables are the whole surface.

Properties

MemberDescriptionDefined by
type
type: types.literal(typeName)		TokenEntryInternetAccount
configuration
configuration: ConfigurationReference(configSchema)		TokenEntryInternetAccount

Getters

MemberDescriptionDefined by
showInFileSelector
boolean		There is nothing to pick: an HTTP Basic account matches by domain and prompts on its own. RpcManager also mints one of these per origin on a 401, so offering them would fill the picker with a toggle per server the session happened to touch.HTTPBasicInternetAccount
validateWithHEAD
boolean		validate the token with a HEAD request before it is usedTokenEntryInternetAccount

Actions

MemberDescriptionDefined by
getTokenFromUser
(resolve: (token: string) => void, reject: (error: Error) => void) => void
Prompt the user for a token via the account's dialog form, resolving with the entered token or rejecting if the user cancels.TokenEntryInternetAccount
validateToken
(token: string, location: UriLocation) => Promise<string>		Optionally validate the token with a HEAD request before use, per the validateWithHEAD config slot.TokenEntryInternetAccount