ping-identity
    Preparing search index...

    Type Alias JourneyStartOptions

    Optional flags when starting a Journey.

    type JourneyStartOptions = {
        forceAuth?: boolean;
        noSession?: boolean;
        verificationUri?: string;
    }
    Index

    Properties

    forceAuth? noSession? verificationUri?

    Properties

    forceAuth?: boolean

    Force authentication even if an SSO session exists.

    noSession?: boolean

    Ignore existing session state and start a fresh flow.

    verificationUri?: string

    The RFC 8628 verification_uri_complete URL from a device authorization response. Set this when the current device is acting as the approving device: the Journey flow extracts the user_code from this URL and approves the requesting device after successful authentication.

    Supported on both platforms; the native SDK forwards the URL to the authorization server after the Journey succeeds.

    Settings

    Member Visibility

    On This Page

    Properties