Libraries
    Preparing search index...

    Interface ClientCredentialsSchemeOptions<T>

    Configuration for clientCredentialsScheme.

    interface ClientCredentialsSchemeOptions<T> {
        authenticate: (
            context: AuthenticationContext,
        ) => Promise<AuthenticationResult<T>>;
        name?: string;
        refreshUrl?: string;
        scopes?: Record<string, string>;
        tokenUrl: string;
    }

    Type Parameters

    • T

      The type of the principal value produced by authenticate.

    Index

    Properties

    authenticate name? refreshUrl? scopes? tokenUrl

    Properties

    authenticate: (
        context: AuthenticationContext,
    ) => Promise<AuthenticationResult<T>>

    Validate the incoming request and return the principal or a failure.

    name?: string

    Custom scheme name (default: 'oauth2').

    refreshUrl?: string

    Optional token refresh URL.

    scopes?: Record<string, string>

    Available scopes with descriptions (default: {}).

    tokenUrl: string

    OAuth token endpoint URL.

    Settings

    Member Visibility

    On This Page

    Properties