@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Interface EnsureClientCredentialsOptions

    Options for ensureClientCredentialsTokens.

    interface EnsureClientCredentialsOptions {
        fetch?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        timeoutMs?: number;
        allowPrivateIp?: boolean;
        storage?: OAuthConfigStorage;
        force?: boolean;
        expirationSkewMs?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    fetch? timeoutMs? allowPrivateIp? storage? force? expirationSkewMs?

    Properties

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

    Custom fetch implementation (default: global fetch). Primarily a testing hook — lets unit tests stub the authorization server without intercepting the global.

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

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

        Returns Promise<Response>

    timeoutMs?: number

    Request timeout in milliseconds (default: 30_000). Guards against a silently hung authorization server blocking the caller indefinitely.

    allowPrivateIp?: boolean

    Allow token_endpoint to resolve to a private / loopback IP address. Default: false (SSRF guard). The CLI opts in because the operator is explicitly configuring the endpoint; hosted consumers accepting user-supplied configs should leave this off.

    storage?: OAuthConfigStorage

    Storage backend used to persist refreshed tokens. Optional — if omitted, tokens are only mutated on the in-memory agent object and the caller is responsible for persisting.

    force?: boolean

    Force a re-exchange even if the cached token looks valid. Useful after a 401 in case the authorization server rotated something out-of-band.

    expirationSkewMs?: number

    Expiration skew (ms). Treat the token as expired this many milliseconds before its nominal expires_at — protects against clock skew and in-flight requests. Default: 60_000 (1 minute). The interactive auth code flow uses 5 minutes; client credentials refresh is cheap (single POST) so the shorter window is fine here.

    Settings

    Member Visibility

    On This Page

    Properties