Orchestration guide: Web SDK

This guide describes how to quickly integrate Identity Orchestration journeys into your web application.

See SDK reference

Introduction

The Orchestration SDK enables client-side developers to build user experiences that interact with Client SDK journeys.

Each journey contains a business workflow, such as login or secure user onboarding. It consists of backend steps, such as data processing or invoking external systems, and client-facing steps, such as a login form or document verification. The SDK allows the client application to present screens and prompt for user input, and then send this information back to the journey for further processing.

Whenever the client-side interaction requires additional Mosaic platform capabilities, such as passkeys or risk detection, the developer needs to activate the appropriate SDK module to perform the step and collect the required input. This allows separation of concerns between the journey workflow handling, and the specific capability used.

SDK lifecycle

Regardless of journey logic, the SDK lifecycle consists of the following:

The above is reflected in the following workflow diagram:

Before you start

Before the SDK can start running journeys, make sure to:

☐   Coordinate with the journey developer (regarding journey ID, steps, expected data, etc).
☐   Obtain the Client ID that identifies the app, from the app settings in the Admin Portal
☐   Allow Mosaic IPs and domains on your network
☐   Extend the Content-Security-Policy header, if CSP is enabled on your web server

Step 1: Load SDK

Load the SDK by adding the following HTML script tag in all relevant pages:

<!--Loads the latest SDK version. See changelog for details and update version if necessary -->
<script src="https://platform-websdk.transmitsecurity.io/platform-websdk/latest/ts-platform-websdk.js" id="platform-sdk" defer="true"></script>

Step 2: Initialize SDK

Initializing the SDK configures it to work with your client ID, which is the context under which the entire journey is executed. It also allows setting the base URL for the SDK to use, whether a Mosaic-provided path or your own proxy.

// Initialize an instance of the Platform SDK
await window.tsPlatform.initialize({
  clientId: 'my-client-id',  // Client ID from app settings in the Admin Portal
  ido: {
    serverPath: 'https://api.transmitsecurity.io/ido' // Base URL, default is for US region
    }
});

Step 3: Start journey

Starting a journey is usually a response to some user interaction, such as clicking a login or sign-up button. The start parameters indicate which journey to start, and optionally pass additional parameters if the journey expects them.

For example, if the client app uses email as the user identifier and caches it locally after sign-up, it can pass it to the journey as userEmail. The journey can reference it using this expression @policy.request().params.userEmail

// Start a journey with the id 'login'
try {
  const idoResponse = await window.tsPlatform.ido.startJourney(
      'login',   // Journey ID
      {
        'additionalParams': { userEmail: <locally-stored-email> }
      }
  );
  // Handle service response below
  ...
} catch(error) {
  switch(sdkError.errorCode) ...
}

Step 4: Handle service response

After starting the journey, the client app waits for the IdoServiceResponse. It will contains all the information the client needs in order to determine what to do next.

To handle the service response, the client app needs to:

1. Select a handler based on the step
2. Use the data provided by the journey
3. Respond to the journey with requested input

1. Select handler

Upon receiving the IdoServiceResponse, launch a handler that executes the relevant step by switching/selecting on the IdoServiceResponse.journeyStepId parameter. It will either contain one of these enums, or the Step ID configured in the Login Form or Get Information from Client step. Each handler should process the data, display whatever UI is needed, and call submitClientResponse() when the interaction is concluded.

This is how the app code would dispatch handlers based on this property:

switch (idoServiceResponse.journeyStepId) {
    case IdoJourneyActionType.Information:
        handleInformationStep(idoServiceResponse);
        break;
    case IdoJourneyActionType.EmailOTPAuthentication:
        handleEmailOTP(idoServiceResponse);
        break;
    case 'main_login_form': // custom identifier for main Login Form step
        handleMainLoginForm(idoServiceResponse);
        break;
    case 'user_info_form': // custom identifier for a collect information step
        handleUserInfoForm(idoServiceResponse);
        break;
    case etc ...
}

2. Use data sent from journey

Inside the handler function, the app code should render a UI that fits the specific step, and use information from the data property if it was provided in the idoServiceResponse object. This data is described in each step guide.

Let's see an example for a Register Passkeys step. IdoServiceResponse will include journeyStepId set to WebAuthnRegistration and a data object containing the user identifier and other WebAuthn configuration. This data can be used for calling the webauthn (passkey) registration module, as shown below:

let data = idoServiceResponse.data;
// Registers passkey credentials on the device using data provided by the journey
let registrationResult = window.tsPlatform.webauthn.register(
    data.username,
    {
        allowCrossPlatformAuthenticators: data.allow_cross_platform_authenticators,
        registerAsDiscoverable: data.register_as_discoverable,
        displayName: data.display_name
    }
);

3. Respond with collected data

Once the user interaction is concluded, the handler should collect the response data and submit it using submitClientResponse(). This call yields control back to the journey, and returns with a new IdoServiceResponse once the journey reaches the next client-facing step.

The call parameters are the collected data, and a response option identifier. We’ll talk more about these below. For now, let's follow the Register Passkeys example of making this call from each SDK.

let data = { "webauthn_encoded_result": encodedRegistrationResult };

let idoResponse = window.tsPlatform.ido.submitClientResponse(
    ClientResponseOptionType.ClientInput,
    data
);

let data = { "webauthn_encoded_result": encodedAuthenticationResult };

let idoResponse = window.tsPlatform.ido.submitClientResponse(
    'passkey',
    data
);

Step 5: Complete journey

The orchestration service signals journey completion by setting the journeyStepId property to Rejection or Success. The specific enum for each SDK is described in the Step 3.1 above. If successful, the token property contains a token as a proof of journey completion.

Next steps

The SDK also supports the features below. For more info, talk to your Transmit Security representative.

• Generating a debug pin for the journey debugger
• State management - allows saving and restoring the SDK state. This allow handling refreshes, as well as page redirects as part of the Document Verification step and Invoke External IDP.
• Local console logs
• Resources URIs as part of SDK initialization (see SDK reference )