Skip to main content

GoogleDriveOAuthInternetAccount

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

Example usage

The Google endpoints and scopes are pre-filled, so an entry needs only your own OAuth app's clientId.

{
  type: 'GoogleDriveOAuthInternetAccount',
  internetAccountId: 'googleDriveOAuth',
  name: 'Google Drive',
  clientId: 'your-client-id.apps.googleusercontent.com',
}

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
authEndpoint
string = 'https://accounts.google.com/o/oauth2/v2/auth'		the authorization code endpoint of the internet account
scopes
string = 'https://www.googleapis.com/auth/drive.readonly'		optional scopes for the authorization call
domains
stringArray = ['drive.google.com']		array of valid domains the url can contain to use this account
responseType
string = 'token'		the type of response from the authorization endpoint
Inherited from OAuthInternetAccount5 slots
tokenType
string = 'Bearer'		a custom name for a token to include in the header
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
state
string = ''		optional state for the authorization call
Inherited from BaseInternetAccount3 slots
name
string = ''		descriptive name of the internet account
description
string = ''		a description of the internet account
authHeader
string = 'Authorization'		request header for credentials