@rosschiu/kiban-sdk
    Preparing search index...

    Interface ServiceCredentialsConfig

    Configuration for createServiceCredentials: the app's confidential service client (one of KIBAN_SERVICE_CLIENTS) and the gateway it authenticates against.

    interface ServiceCredentialsConfig {
        clientId: string;
        clientSecret: string;
        fetchFn?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        gatewayOrigin: string;
        realm?: string;
    }
    Index
    clientId clientSecret fetchFn? gatewayOrigin realm?
    clientId: string

    The service client id.

    clientSecret: string

    The service client secret (from the Keycloak admin console).

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

    Override for fetch (tests).

    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>

    gatewayOrigin: string

    Gateway origin, e.g. https://kiban.example.

    realm?: string

    Realm name; defaults to kiban.

    Settings
    Member Visibility

    On This Page
    Properties