Interface Provider

Provider defines a common interface for an OAuth2 client.

Hierarchy

Provider

Indexable

[key: string]: any

Methods

authURL

authURL(): string
AuthURL returns the provider's authorization service url.

Returns string
- Defined in types.d.ts:20473

buildAuthURL

buildAuthURL(state, ...opts): string
BuildAuthURL returns a URL to the provider's consent page that asks for permissions for the required scopes explicitly.
Parameters
- state: string
- Rest ...opts: AuthCodeOption[]
Returns string
- Defined in types.d.ts:20511

client

client(token): any
Client returns an http client using the provided token.
Parameters
- token: Token
Returns any
- Defined in types.d.ts:20506

clientId

clientId(): string
ClientId returns the provider client's app ID.

Returns string
- Defined in types.d.ts:20448

clientSecret

clientSecret(): string
ClientSecret returns the provider client's app secret.

Returns string
- Defined in types.d.ts:20456

context

context(): context.Context
Context returns the context associated with the provider (if any).

Returns context.Context
- Defined in types.d.ts:20415

displayName

displayName(): string
DisplayName usually returns provider name as it is officially written and it could be used directly in the UI.

Returns string
- Defined in types.d.ts:20432

extra

extra(): _TygojaDict
Extra returns a shallow copy of any custom config data that the provider may be need.

Returns _TygojaDict
- Defined in types.d.ts:20498

fetchAuthUser

fetchAuthUser(token): AuthUser
FetchAuthUser is similar to FetchRawUserInfo, but normalizes and marshalizes the user api response into a standardized AuthUser struct.
Parameters
- token: Token
Returns AuthUser
- Defined in types.d.ts:20525

fetchRawUserInfo

fetchRawUserInfo(token): string | number[]
FetchRawUserInfo requests and marshalizes into result the the OAuth user api response.
Parameters
- token: Token
Returns string | number[]
- Defined in types.d.ts:20520

fetchToken

fetchToken(code, ...opts): Token
FetchToken converts an authorization code to token.
Parameters
- code: string
- Rest ...opts: AuthCodeOption[]
Returns Token
- Defined in types.d.ts:20515

pkce

pkce(): boolean
PKCE indicates whether the provider can use the PKCE flow.

Returns boolean
- Defined in types.d.ts:20423

redirectURL

redirectURL(): string
RedirectURL returns the end address to redirect the user going through the OAuth flow.

Returns string
- Defined in types.d.ts:20465

scopes

scopes(): string[]
Scopes returns the provider access permissions that will be requested.

Returns string[]
- Defined in types.d.ts:20440

setAuthURL

setAuthURL(url): void
SetAuthURL sets the provider's AuthURL.
Parameters
- url: string
Returns void
- Defined in types.d.ts:20477

setClientId

setClientId(clientId): void
SetClientId sets the provider client's ID.
Parameters
- clientId: string
Returns void
- Defined in types.d.ts:20452

setClientSecret

setClientSecret(secret): void
SetClientSecret sets the provider client's app secret.
Parameters
- secret: string
Returns void
- Defined in types.d.ts:20460

setContext

setContext(ctx): void
SetContext assigns the specified context to the current provider.
Parameters
- ctx: context.Context
Returns void
- Defined in types.d.ts:20419

setDisplayName

setDisplayName(displayName): void
SetDisplayName sets the provider's display name.
Parameters
- displayName: string
Returns void
- Defined in types.d.ts:20436

setExtra

setExtra(data): void
SetExtra updates the provider's custom config data.
Parameters
- data: _TygojaDict
Returns void
- Defined in types.d.ts:20502

setPKCE

setPKCE(enable): void
SetPKCE toggles the state whether the provider can use the PKCE flow or not.
Parameters
- enable: boolean
Returns void
- Defined in types.d.ts:20427

setRedirectURL

setRedirectURL(url): void
SetRedirectURL sets the provider's RedirectURL.
Parameters
- url: string
Returns void
- Defined in types.d.ts:20469

setScopes

setScopes(scopes): void
SetScopes sets the provider access permissions that will be requested later.
Parameters
- scopes: string[]
Returns void
- Defined in types.d.ts:20444

setTokenURL

setTokenURL(url): void
SetTokenURL sets the provider's TokenURL.
Parameters
- url: string
Returns void
- Defined in types.d.ts:20485

setUserInfoURL

setUserInfoURL(url): void
SetUserInfoURL sets the provider's UserInfoURL.
Parameters
- url: string
Returns void
- Defined in types.d.ts:20493

tokenURL

tokenURL(): string
TokenURL returns the provider's token exchange service url.

Returns string
- Defined in types.d.ts:20481

userInfoURL

userInfoURL(): string
UserInfoURL returns the provider's user info api url.

Returns string
- Defined in types.d.ts:20489

Generated using TypeDoc