Interface ClientCredentialsConfig

Configuration for the OAuth2 client-credentials provider produced by clientCredentials. Intended for confidential Node clients — the client secret must never ship to a browser.

interface ClientCredentialsConfig {
    clientId: string;
    clientSecret: string;
    clockSkewMs?: number;
    extraTokenParams?: Record<string, string>;
    fetchFn?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    };
    onEvent?: HonuaAuthEventListener;
    scopes?: readonly string[];
    serviceKey?: string;
    store?: CredentialStore;
    tokenEndpoint: string;
}

Properties

clientId clientSecret clockSkewMs? extraTokenParams? fetchFn? onEvent? scopes? serviceKey? store? tokenEndpoint

Properties

clientId

clientId: string

clientSecret

clientSecret: string

OptionalclockSkewMs

clockSkewMs?: number

OptionalextraTokenParams

extraTokenParams?: Record<string, string>

OptionalfetchFn

fetchFn?: {
    (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
    (input: string | URL | Request, init?: RequestInit): Promise<Response>;
}

Type declaration

    • (input, init?): Promise<Response>

    • MDN Reference

      Parameters

      • input: URL | RequestInfo
      • Optionalinit: RequestInit

      Returns Promise<Response>

    • (input, init?): Promise<Response>

    • Parameters

      • input: string | URL | Request
      • Optionalinit: RequestInit

      Returns Promise<Response>

OptionalonEvent

onEvent?: HonuaAuthEventListener

Optionalscopes

scopes?: readonly string[]

OptionalserviceKey

serviceKey?: string

Optionalstore

store?: CredentialStore

tokenEndpoint

tokenEndpoint: string

Settings

Member Visibility

On This Page

Properties