Skip to main content

OAuthInternetAccount

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

Config slots

OAuthInternetAccount is a shared base schema, not a type you name in a config. Set these slots on one of the configs under Extended by above, each of which lists them as inherited and shows the shape in its own example. 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 = 'Bearer'		a custom name for a token to include in the header
authEndpoint
string = ''		the authorization code endpoint of the internet account
tokenEndpoint
string = ''		the token endpoint of the internet account
needsPKCE
boolean = false		boolean to indicate if the endpoint needs a PKCE code
clientId
string = ''		id for the OAuth application
scopes
string = ''		optional scopes for the authorization call
state
string = ''		optional state for the authorization call
responseType
string = 'code'		the type of response from the authorization endpoint. can be 'token' or 'code'
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