GitHubOAuthProvider
Defined in: packages/auth/src/oauth/github.provider.ts:37
An OAuth 2.0 authorization-code provider that can build a login redirect and
turn a returned code into a normalised OAuthUserProfile.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new GitHubOAuthProvider(
credentials,http):GitHubOAuthProvider
Defined in: packages/auth/src/oauth/github.provider.ts:40
Parameters
Section titled “Parameters”credentials
Section titled “credentials”Returns
Section titled “Returns”GitHubOAuthProvider
Properties
Section titled “Properties”
readonlyname:"github"
Defined in: packages/auth/src/oauth/github.provider.ts:38
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”exchangeCodeForProfile()
Section titled “exchangeCodeForProfile()”exchangeCodeForProfile(
params):Promise<OAuthUserProfile>
Defined in: packages/auth/src/oauth/github.provider.ts:56
Exchange an authorization code for the authenticated user’s profile.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<OAuthUserProfile>
Implementation of
Section titled “Implementation of”OAuthProvider.exchangeCodeForProfile
getAuthorizationUrl()
Section titled “getAuthorizationUrl()”getAuthorizationUrl(
params):string
Defined in: packages/auth/src/oauth/github.provider.ts:45
Build the URL to redirect the user-agent to for consent.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”string