Interface OAuth2Config

Configuration options for OAuth2Manager

interface OAuth2Config {
    accessToken?: string;
    additionalHeaders?: Record<string, string>;
    authorizationEndpoint?: string;
    clientId: string;
    clientSecret: string;
    onTokenUpdate?: ((tokens) => void | Promise<void>);
    redirectUri?: string;
    refreshBufferMs?: number;
    refreshToken?: string;
    scopes?: string[];
    tokenEndpoint: string;
    tokenExpiresAt?: number;
    tokenRequestTransform?: ((params) => Record<string, string>);
    tokenResponseTransform?: ((response) => OAuth2TokenResponse);
}

Properties

accessToken? additionalHeaders? authorizationEndpoint? clientId clientSecret onTokenUpdate? redirectUri? refreshBufferMs? refreshToken? scopes? tokenEndpoint tokenExpiresAt? tokenRequestTransform? tokenResponseTransform?

Properties

Optional accessToken

accessToken?: string

Initial access token (if already obtained)

Optional additionalHeaders

additionalHeaders?: Record<string, string>

Additional headers to include in token requests

Optional authorizationEndpoint

authorizationEndpoint?: string

Authorization endpoint URL (e.g., 'https://api.example.com/oauth/authorize') Only needed for authorization_code flow

clientId

clientId: string

OAuth2 client ID

clientSecret

clientSecret: string

OAuth2 client secret

Optional onTokenUpdate

onTokenUpdate?: ((tokens) => void | Promise<void>)

Callback invoked when tokens are updated (for persistence)

Type declaration

    • (tokens): void | Promise<void>

    • Parameters

      Returns void | Promise<void>

Optional redirectUri

redirectUri?: string

Redirect URI for authorization_code flow

Optional refreshBufferMs

refreshBufferMs?: number

Buffer time in milliseconds before token expiration to trigger refresh (default: 60000 = 1 minute)

Optional refreshToken

refreshToken?: string

Initial refresh token (if available)

Optional scopes

scopes?: string[]

OAuth2 scopes to request

tokenEndpoint

tokenEndpoint: string

Token endpoint URL (e.g., 'https://api.example.com/oauth/token')

Optional tokenExpiresAt

tokenExpiresAt?: number

Initial token expiration timestamp (milliseconds since epoch)

Optional tokenRequestTransform

tokenRequestTransform?: ((params) => Record<string, string>)

Custom transformation for token request body (for provider-specific requirements)

Type declaration

    • (params): Record<string, string>

    • Parameters

      • params: Record<string, string>

      Returns Record<string, string>

Optional tokenResponseTransform

tokenResponseTransform?: ((response) => OAuth2TokenResponse)

Custom transformation for token response (for non-standard OAuth2 implementations)

Type declaration

Settings

Member Visibility

Theme

On This Page

accessTokenadditionalHeadersauthorizationEndpointclientIdclientSecretonTokenUpdateredirectUrirefreshBufferMsrefreshTokenscopestokenEndpointtokenExpiresAttokenRequestTransformtokenResponseTransform