Skip to main content

DropboxOAuthInternetAccount

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

Signs requests for Dropbox files with an OAuth 2.0 token, with the Dropbox endpoints and domains filled in.

Example usage

The Dropbox endpoints are pre-filled, so an entry needs only your own OAuth app's clientId. Leave domains off and the account is still selectable by hand in the Add Track form.

{
  type: 'DropboxOAuthInternetAccount',
  internetAccountId: 'dropboxOAuth',
  name: 'Dropbox',
  clientId: 'your-dropbox-app-key',
}

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.

SlotDescription
authEndpoint
string = 'https://www.dropbox.com/oauth2/authorize'		the authorization code endpoint of the internet account
tokenEndpoint
string = 'https://api.dropbox.com/oauth2/token'		the token endpoint of the internet account
needsPKCE
boolean = true		boolean to indicate if the endpoint needs a PKCE code
domains
stringArray = []		array of valid domains the url can contain to use this account
Inherited from OAuthInternetAccount5 slots
tokenType
string = 'Bearer'		a custom name for a token to include in the header
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 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