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

    Interface ConnectParams

    interface ConnectParams {
        autoClose?: boolean;
        grantType?: GrantType;
        payload?: Record<string, string>;
        slug: string;
        timeout?: number;
        type?: AuthType | ConnectorAuthType;
    }

    Hierarchy (View Summary)

    Index
    autoClose? grantType? payload? slug timeout? type?
    autoClose?: boolean

    Whether to close the authentication window automatically.

    grantType?: GrantType

    The application's OAuth grant (from the app object). Pass GrantType.ClientCredentials for machine-to-machine connectors so their fields are submitted to the server and no browser window is opened. Omit for redirect grants (authorization_code / PKCE), the default.

    payload?: Record<string, string>

    The key value pairs of auth data.

    slug: string

    The application slug.

    timeout?: number

    Maximum time in milliseconds to wait for authentication before giving up. Set to 0 to wait indefinitely. Defaults to 5 minutes.

    type?: AuthType | ConnectorAuthType

    The authentication type to use — an AuthType for native applications, or one of a universal connector's own types (a key of Application.auth_type_options). If not provided, it defaults to keybased when a payload is given, otherwise oauth2.

    Settings
    Member Visibility

    On This Page
    Properties