Skip to main content

OAuthInternetAccount

Note: this document is automatically generated from configuration objects in our source code. See Config guide for more info

Also note: this document represents the config API for the current released version of jbrowse. If you are not using the current version, please cross reference the markdown files in our repo of the checked out git tag

Source code

GitHub page

Docs​

OAuthInternetAccount - Slots​

slot: tokenType​

tokenType: {
      description: 'a custom name for a token to include in the header',
      type: 'string',
      defaultValue: 'Bearer',
    }

slot: authEndpoint​

authEndpoint: {
      description: 'the authorization code endpoint of the internet account',
      type: 'string',
      defaultValue: '',
    }

slot: tokenEndpoint​

tokenEndpoint: {
      description: 'the token endpoint of the internet account',
      type: 'string',
      defaultValue: '',
    }

slot: needsPKCE​

needsPKCE: {
      description: 'boolean to indicate if the endpoint needs a PKCE code',
      type: 'boolean',
      defaultValue: false,
    }

slot: clientId​

clientId: {
      description: 'id for the OAuth application',
      type: 'string',
      defaultValue: '',
    }

slot: scopes​

scopes: {
      description: 'optional scopes for the authorization call',
      type: 'string',
      defaultValue: '',
    }

slot: state​

state: {
      description: 'optional state for the authorization call',
      type: 'string',
      defaultValue: '',
    }

slot: responseType​

responseType: {
      description:
        "the type of response from the authorization endpoint. can be 'token' or 'code'",
      type: 'string',
      defaultValue: 'code',
    }

OAuthInternetAccount - Derives from​

baseConfiguration: BaseInternetAccountConfig