ping-identity
    Preparing search index...

    Type Alias JourneyClient

    Native-backed Journey client contract.

    type JourneyClient = {
        dispose: () => Promise<void>;
        getId: () => Promise<string>;
        init: () => Promise<string>;
        logoutUser: () => Promise<boolean>;
        next: (input?: JourneyNextInput) => Promise<JourneyNode>;
        refresh: () => Promise<JourneyUserSession | null>;
        resume: (uri: string) => Promise<JourneyNode>;
        revoke: () => Promise<boolean>;
        ssoToken: () => Promise<JourneySSOToken | null>;
        start: (
            journeyName: string,
            options?: JourneyStartOptions,
        ) => Promise<JourneyNode>;
        startBackchannel: (
            uri: string,
            options?: JourneyBackchannelOptions,
        ) => Promise<JourneyNode>;
        user: () => Promise<JourneyUserSession | null>;
        userinfo: () => Promise<JourneyUserInfo | null>;
    }
    Index

    Properties

    dispose getId init logoutUser next refresh resume revoke ssoToken start startBackchannel user userinfo

    Properties

    dispose: () => Promise<void>

    Dispose the native Journey instance and release runtime state.

    Type Declaration

      • (): Promise<void>

      • Returns Promise<void>

        Promise resolved when disposal completes.

    When disposal fails.

    getId: () => Promise<string>

    Returns the native Journey instance identifier.

    Type Declaration

      • (): Promise<string>

      • Returns Promise<string>

        Native Journey instance identifier.

    When the Journey is not configured.

    init: () => Promise<string>

    Explicitly initialize the native Journey instance.

    Type Declaration

      • (): Promise<string>

      • Returns Promise<string>

        Native Journey instance identifier.

    When the Journey cannot be configured.

    logoutUser: () => Promise<boolean>

    Logout active Journey user/session.

    Type Declaration

      • (): Promise<boolean>

      • Returns Promise<boolean>

        true when logout succeeds.

    When logout fails.

    next: (input?: JourneyNextInput) => Promise<JourneyNode>

    Advance an active Journey by applying callback input.

    Type Declaration

    When callback application or progression fails.

    refresh: () => Promise<JourneyUserSession | null>

    Refresh active Journey user access token.

    Type Declaration

    When refresh fails.

    resume: (uri: string) => Promise<JourneyNode>

    Resume a suspended Journey flow from a deep link URL.

    Type Declaration

      • (uri: string): Promise<JourneyNode>

      • Parameters

        • uri: string

          Resume URI provided by native/server.

        Returns Promise<JourneyNode>

        Resumed Journey node.

    When resume fails.

    revoke: () => Promise<boolean>

    Revoke active Journey user access/refresh tokens.

    Type Declaration

      • (): Promise<boolean>

      • Returns Promise<boolean>

        true when revoke completes.

    When revoke fails.

    ssoToken: () => Promise<JourneySSOToken | null>

    Resolve active Journey SSO token payload.

    Type Declaration

    When SSO token retrieval fails.

    start: (
        journeyName: string,
        options?: JourneyStartOptions,
    ) => Promise<JourneyNode>

    Start a Journey by name.

    Type Declaration

    When start fails.

    startBackchannel: (
        uri: string,
        options?: JourneyBackchannelOptions,
    ) => Promise<JourneyNode>

    Start a Journey from an AM/AIC backchannel (transactional) redirect URI.

    The gateway federation service initializes the transaction via AM's /authenticate/backchannel/initialize endpoint and delivers the returned redirectUri to the app through its own channel (push notification, QR code, deep link). This method extracts the authIndexType and authIndexValue query parameters from the URI and drives the standard Journey authenticate flow — the URI itself is never opened as a browser URL, and the authenticate endpoint is always reconstructed from the Journey config (serverUrl + realm).

    Type Declaration

      • (uri: string, options?: JourneyBackchannelOptions): Promise<JourneyNode>

      • Parameters

        • uri: string

          Gateway-provided redirectUri value.

        • Optionaloptions: JourneyBackchannelOptions

          Optional backchannel flags. Both default to false, matching native behavior.

        Returns Promise<JourneyNode>

        The first Journey node, using the same node contract as start/resume. URI validation failures (missing config, malformed URI, missing or whitespace-only authIndexType/authIndexValue, URI host not matching the configured serverUrl) resolve as FailureNode payloads without a network call; expired/not-found/completed transactions surface AM's message on an ErrorNode.

    With argument_error when the URI is empty or whitespace-only, and for bridge-level failures.

    // Gateway payload: { transaction, redirectUri }
    const node = await client.startBackchannel(payload.redirectUri);
    if (node.type === 'ContinueNode') {
      // render step-up callbacks, then: client.next(...)
    }

    Mirrors the native start(backchannelUri:) capability (SDKS-5156 iOS / SDKS-5157 Android). authIndexType is parsed from the URI rather than hardcoded to transaction. URI validation runs natively before any network call on both platforms with identical outcomes. Host validation only establishes that the URI names the configured server; it does not establish that the transaction belongs to the current user — confirm transaction details with the user before completing the flow.

    user: () => Promise<JourneyUserSession | null>

    Resolve active user session details.

    Type Declaration

    When session retrieval fails.

    userinfo: () => Promise<JourneyUserInfo | null>

    Resolve active Journey userinfo claims.

    Type Declaration

    When userinfo retrieval fails.

    Settings

    Member Visibility

    On This Page

    Properties