ART Framework API Docs
    Preparing search index...

    Interface OAuthConfig

    Configuration for OAuth 2.0 authentication strategy

    interface OAuthConfig {
        clientId: string;
        clientSecret: string;
        grantType?: "refresh_token" | "authorization_code" | "client_credentials";
        scopes?: string;
        tokenEndpoint: string;
        tokenRefreshBufferMs?: number;
        tokenRequestHeaders?: Record<string, string>;
        tokenTimeoutMs?: number;
    }
    Index

    Properties

    clientId clientSecret grantType? scopes? tokenEndpoint tokenRefreshBufferMs? tokenRequestHeaders? tokenTimeoutMs?

    Properties

    clientId: string

    Client ID for OAuth authentication

    clientSecret: string

    Client secret for OAuth authentication

    grantType?: "refresh_token" | "authorization_code" | "client_credentials"

    Grant type to use (defaults to 'client_credentials')

    scopes?: string

    OAuth scopes to request (space-separated)

    tokenEndpoint: string

    OAuth token endpoint URL

    tokenRefreshBufferMs?: number

    Buffer time before token expiry to trigger refresh (default: 300000 = 5 minutes)

    tokenRequestHeaders?: Record<string, string>

    Additional headers to send with token requests

    tokenTimeoutMs?: number

    Custom timeout for token requests in milliseconds (default: 30000)

    Settings

    Member Visibility

    On This Page

    Properties