Dex TypeScript SDK 1.29.0
    Preparing search index...

    Interface ApiKeyCredentialOptions

    Configures an API key exchange for a Dex server.

    interface ApiKeyCredentialOptions {
        apiKey: string;
        exchangeTimeoutMs?: number;
        fetch?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        serverId: string;
        tokenUrl: string;
    }
    Index

    Properties

    apiKey exchangeTimeoutMs? fetch? serverId tokenUrl

    Properties

    apiKey: string

    Long-lived API key sent only to the token endpoint.

    exchangeTimeoutMs?: number

    Maximum exchange duration, including connection and response, in milliseconds. Defaults to 10,000; at most 2,147,483,647.

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

    Fetch implementation for proxies and tests. Defaults to global fetch. The credential does not own it.

    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>

    serverId: string

    Server ID that the token endpoint uses to scope the access token.

    tokenUrl: string

    HTTPS token endpoint URL. HTTP is permitted only for localhost, 127.0.0.0/8, or ::1.

    Settings

    Member Visibility

    On This Page

    Properties