lightyear.oauthconnector

Home > @runlightyear/lightyear > OAuthConnector

OAuthConnector class

OAuth2 Connector

Creates the input to the 3 essential OAuth tasks:

1. Generates a url to request an access token 2. Converts the oauth callback parameters into the https call to request an access token 3. Provides the https params to refresh an access token

Signature:

declare abstract class OAuthConnector 

Constructors

Constructor	Modifiers	Description
(constructor)(props)		Constructs a new instance of the OAuthConnector class

Properties

Property	Modifiers	Type	Description
appName?		string	(Optional)
authData?		AuthData	(Optional)
customAppName?		string	(Optional)
inDevelopment?		boolean	(Optional)
oauthConfigData		OAuthConfigData
proxied?		boolean	(Optional)

Methods

Method	Modifiers	Description
buildUrl(url, params)
getAccessTokenUrl()	abstract	Get the url of the access token endpoint.
getAuthRequestUrl()
getAuthRequestUrlBase()	abstract
getAuthRequestUrlParams()
getRedirectUri()
getRefreshAccessTokenBody()
getRefreshAccessTokenHeaders()
getRefreshAccessTokenRedactKeys()
getRefreshTokenUrl()		Get the url of the refresh token endpoint By default, returns the same url as the access token endpoint
getRequestAccessTokenBody(code)
getRequestAccessTokenHeaders()
getRequestAccessTokenParams(code)
getRequestAccessTokenRedactKeys()
post(props)
processRefreshAccessTokenResponse(props)
processRequestAccessTokenResponse(props)
redirectUri()
refreshAccessToken()
request(props)		Make a proxied http request
requestAccessToken(code)