Interface OAuthAuthenticator<TContext, TProfile>

interface OAuthAuthenticator<TContext, TProfile> {
    defaultProfileTransform: ProfileTransform<
        OAuthAuthenticatorResult<TProfile>,
    >;
    scopes?: OAuthAuthenticatorScopeOptions;
    shouldPersistScopes?: boolean;
    authenticate(
        input: OAuthAuthenticatorAuthenticateInput,
        ctx: TContext,
    ): Promise<OAuthAuthenticatorResult<TProfile>>;
    initialize(ctx: { callbackUrl: string; config: Config }): TContext;
    logout?(input: OAuthAuthenticatorLogoutInput, ctx: TContext): Promise<void>;
    refresh(
        input: OAuthAuthenticatorRefreshInput,
        ctx: TContext,
    ): Promise<OAuthAuthenticatorResult<TProfile>>;
    start(
        input: OAuthAuthenticatorStartInput,
        ctx: TContext,
    ): Promise<{ status?: number; url: string }>;
}

Type Parameters

TContext
TProfile

Index

Properties

defaultProfileTransform scopes? shouldPersistScopes?

Methods

authenticate initialize logout? refresh start

Properties

defaultProfileTransform

defaultProfileTransform: ProfileTransform<OAuthAuthenticatorResult<TProfile>>

`Optional`scopes

scopes?: OAuthAuthenticatorScopeOptions

`Optional`shouldPersistScopes

shouldPersistScopes?: boolean

Deprecated

use scopes.persist instead

Methods

authenticate

authenticate(
input: OAuthAuthenticatorAuthenticateInput,
ctx: TContext,
): Promise<OAuthAuthenticatorResult<TProfile>>
Parameters
- input: OAuthAuthenticatorAuthenticateInput
- ctx: TContext
Returns Promise<OAuthAuthenticatorResult<TProfile>>
- Defined in plugins/auth-node/src/oauth/types.ts:96

initialize

initialize(ctx: { callbackUrl: string; config: Config }): TContext
Parameters
- ctx: { callbackUrl: string; config: Config }
Returns TContext
- Defined in plugins/auth-node/src/oauth/types.ts:91

`Optional`logout

logout?(input: OAuthAuthenticatorLogoutInput, ctx: TContext): Promise<void>
Parameters
- input: OAuthAuthenticatorLogoutInput
- ctx: TContext
Returns Promise<void>
- Defined in plugins/auth-node/src/oauth/types.ts:104

refresh

refresh(
input: OAuthAuthenticatorRefreshInput,
ctx: TContext,
): Promise<OAuthAuthenticatorResult<TProfile>>
Parameters
- input: OAuthAuthenticatorRefreshInput
- ctx: TContext
Returns Promise<OAuthAuthenticatorResult<TProfile>>
- Defined in plugins/auth-node/src/oauth/types.ts:100

start

start(
input: OAuthAuthenticatorStartInput,
ctx: TContext,
): Promise<{ status?: number; url: string }>
Parameters
- input: OAuthAuthenticatorStartInput
- ctx: TContext
Returns Promise<{ status?: number; url: string }>
- Defined in plugins/auth-node/src/oauth/types.ts:92