ping-identity
    Preparing search index...

    Type Alias ProtectConfig

    Configuration for creating a Protect client.

    type ProtectConfig = {
        customHost?: string;
        deviceAttributesToIgnore?: string[];
        envId?: string;
        isBehavioralDataCollection?: boolean;
        isConsoleLogEnabled?: boolean;
        isLazyMetadata?: boolean;
        logger?: JourneyInstance;
        pauseBehavioralDataOnSuccess?: boolean;
        resumeBehavioralDataOnStart?: boolean;
    }
    Index

    Properties

    customHost? deviceAttributesToIgnore? envId? isBehavioralDataCollection? isConsoleLogEnabled? isLazyMetadata? logger? pauseBehavioralDataOnSuccess? resumeBehavioralDataOnStart?

    Properties

    customHost?: string

    Custom host URL for the Protect SDK.

    deviceAttributesToIgnore?: string[]

    Device attributes to exclude from signal collection.

    envId?: string

    PingOne environment ID for the Protect SDK.

    isBehavioralDataCollection?: boolean

    Whether to enable behavioral data collection.

    true

    isConsoleLogEnabled?: boolean

    Whether to enable console logging inside the Protect SDK.

    false

    isLazyMetadata?: boolean

    Whether to use lazy metadata loading.

    false

    logger?: JourneyInstance

    Optional logger instance for SDK debug output.

    When omitted, all logging is silently suppressed via a built-in no-op logger.

    pauseBehavioralDataOnSuccess?: boolean

    When true, start() automatically calls pauseBehavioralData() on flow success.

    The RN bridge does not have lifecycle hooks into the DaVinci workflow, so this flag is a documentation hint only. Call pauseBehavioralData() manually after the flow succeeds if you need this behavior.

    false

    resumeBehavioralDataOnStart?: boolean

    When true, start() automatically calls resumeBehavioralData() after initialization.

    false

    Settings

    Member Visibility

    On This Page

    Properties