static/jsvm/interfaces/auth.Provider.html
Provider defines a common interface for an OAuth2 client.
authURLbuildAuthURLclientclientIdclientSecretcontextdisplayNameextrafetchAuthUserfetchRawUserInfofetchTokenpkceredirectURLscopessetAuthURLsetClientIdsetClientSecretsetContextsetDisplayNamesetExtrasetPKCEsetRedirectURLsetScopessetTokenURLsetUserInfoURLtokenURLuserInfoURL
AuthURL returns the provider's authorization service url.
BuildAuthURL returns a URL to the provider's consent page that asks for permissions for the required scopes explicitly.
Rest ...opts: AuthCodeOption[]Client returns an http client using the provided token.
ClientId returns the provider client's app ID.
ClientSecret returns the provider client's app secret.
Context returns the context associated with the provider (if any).
DisplayName usually returns provider name as it is officially written and it could be used directly in the UI.
Extra returns a shallow copy of any custom config data that the provider may be need.
FetchAuthUser is similar to FetchRawUserInfo, but normalizes and marshalizes the user api response into a standardized AuthUser struct.
FetchRawUserInfo requests and marshalizes into result the the OAuth user api response.
FetchToken converts an authorization code to token.
Rest ...opts: AuthCodeOption[]PKCE indicates whether the provider can use the PKCE flow.
RedirectURL returns the end address to redirect the user going through the OAuth flow.
Scopes returns the provider access permissions that will be requested.
SetAuthURL sets the provider's AuthURL.
SetClientId sets the provider client's ID.
SetClientSecret sets the provider client's app secret.
SetContext assigns the specified context to the current provider.
SetDisplayName sets the provider's display name.
SetExtra updates the provider's custom config data.
SetPKCE toggles the state whether the provider can use the PKCE flow or not.
SetRedirectURL sets the provider's RedirectURL.
SetScopes sets the provider access permissions that will be requested later.
SetTokenURL sets the provider's TokenURL.
SetUserInfoURL sets the provider's UserInfoURL.
TokenURL returns the provider's token exchange service url.
UserInfoURL returns the provider's user info api url.
OSLightDark
Generated using TypeDoc