Interface OAuth2ProviderConfig

Hierarchy

  • OAuth2ProviderConfig

Methods

initProvider validate

Properties

authURL clientId clientSecret displayName extra name pkce? tokenURL userInfoURL

Methods

initProvider

  • InitProvider returns a new auth.Provider instance loaded with the current OAuth2ProviderConfig options.

    Returns Provider

validate

  • Validate makes OAuth2ProviderConfig validatable by implementing [validation.Validatable] interface.

    Returns void

Properties

authURL

authURL: string

clientId

clientId: string

clientSecret

clientSecret: string

displayName

displayName: string

extra

extra: _TygojaDict

name

name: string

Optional pkce

pkce?: boolean

PKCE overwrites the default provider PKCE config option.

This usually shouldn't be needed but some OAuth2 vendors, like the LinkedIn OIDC, may require manual adjustment due to returning error if extra parameters are added to the request (https://github.com/pocketbase/pocketbase/discussions/3799#discussioncomment-7640312)

tokenURL

tokenURL: string

userInfoURL

userInfoURL: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc