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

    Interface KeyBasedParams

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

    interface KeyBasedParams {
        authProfileId?: string;
        authType?: AuthType | ConnectorAuthType;
        connectionId?: string;
        payload?: Record<string, string>;
        preRequisiteFields?: Record<string, unknown>;
        slug: string;
        userDefinedFields?: Record<string, unknown>;
    }

    Hierarchy (View Summary)

    Index
    authProfileId? authType? connectionId? payload? preRequisiteFields? slug userDefinedFields?
    authProfileId?: string

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

    authType?: AuthType | ConnectorAuthType

    The auth type being submitted, as named by the application's Application.auth_type_options. Universal connectors distinguish api_key / basic_auth / bearer_token, so a connector offering more than one cannot be resolved from the credentials alone.

    connectionId?: string

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

    payload?: Record<string, string>

    The key value pairs of auth data.

    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.

    slug: string

    The application slug.

    userDefinedFields?: Record<string, unknown>

    Caller metadata to store against the connection.

    Settings
    Member Visibility

    On This Page
    Properties