@refoldai/refold-js
    Preparing search index...

    Interface ConnectionTarget

    Which credentials a connect uses, and what to store against the connection.

    interface ConnectionTarget {
        authProfileId?: string;
        connectionId?: string;
        preRequisiteFields?: Record<string, unknown>;
        userDefinedFields?: Record<string, unknown>;
    }

    Hierarchy (View Summary)

    Index
    authProfileId? connectionId? preRequisiteFields? userDefinedFields?
    authProfileId?: string

    The credential set to connect with, from an application's auth profiles. Omitted, the application's default profile is used.

    connectionId?: string

    An existing connection to re-authenticate instead of opening a new one.

    preRequisiteFields?: Record<string, unknown>

    Values the application requires before it can be connected. Read by applications on auth profiles and by connectors; other native applications take theirs as flat keys in payload.

    userDefinedFields?: Record<string, unknown>

    Caller metadata to store against the connection.

    Settings
    Member Visibility

    On This Page
    Properties