Getting started with IO

This section describes how to access Identity Orchestrator, create a basic authentication flow, and test it.

Prerequisites

Before you begin, ensure you have:

• Access to the OneWelcome Identity Platform
• Administrative privileges for your tenant
• A basic understanding of user authentication workflows
• Familiarity with identity management concepts

Access Identity Orchestrator

To access Identity Orchestrator:

1. Log in to the OneWelcome Identity Platform console.

2. In the left pane, navigate to Identity Orchestrator.

   A list of flow categories displays.

   

Create a login flow

This section demonstrates how to use the core concepts of Identity Orchestrator to create a simple login flow.

To create a login flow, complete the five procedures which follow.

Create an empty flow

To create an empty flow:

1. In the left pane, select Identity Orchestrator.

2. Select the Authentication category.

3. In the top-right corner, select Add.

4. In the configuration dialog box:

   1. Select Flow Type > Login.

   2. In the Name field, enter My First Login Flow.

   3. In the Description field, enter Simple username/password login.

   4. Select Initialize > Creates an empty flow.

5. Select Add.

   The flow designer opens with an empty canvas.

Add a start node

Every flow begins with a Start node. The Start node is the entry point for your flow. To add a Start node:

1. In the top-left corner, select Add Node.

2. Locate Start in the node list.

3. Drag the Start node onto the canvas.

Add user input collection

To add a form to collect the username and password:

1. Open the node palette.

2. Drag the Frontend - Form node onto the canvas.

3. Connect the Not authenticated output of the Start node to the input of the Form node.

4. Select the Form node to open its configuration.

   The form includes Username and Password fields by default.

5. Create a Success output connector:

   • In the Variable Output Table tab, add an element with the following settings:

     • Submit Element ID: login

     • Output: Success

6. Store the form data in a variable titled user:

   • In the Save in the flow store tab:

     • Select Select all to save both the username and password.

     • In the Variable name field, enter user.

7. Select Done to save the node configuration.

Add authentication logic

To add a node to authenticate the user:

1. Add an Authenticate User node to the canvas.

   The Authenticate User node validates the credentials against your identity store and provides a Success or Failure output.

2. Connect the Success output of the Form node to the input of the Authenticate User node.

3. Open the Authenticate User node configuration.

4. Configure the authentication:

   • In the Username field, enter {{user.username}}.

   • In the Password field, enter {{user.password}}.

   These {{variable}} expressions retrieve values from the session.

5. Leave the other settings at their default values.

6. Select Done.

Add end nodes to complete the flow

Every flow must end with either a success or failure end node. To add an end node:

1. Add a Flow - End Success node to the canvas.

2. Connect the Success output of the Authenticate User node to the End Success node.

3. Add a Flow - End Failure node to the canvas.

4. Connect all Failure outputs (from Form and Authenticate User) to the End Failure node. The flow should look similar to the following illustration:

   

5. At the bottom-right, select the Settings gear icon.

6. Select Save Flow.

Description of the flow

When a user triggers the flow described in Create a login flow:

1. The user's login attempt prompts the Start node to check if the user is already authenticated.

2. If the user is not already authenticated: The flow proceeds to the Form node.

3. The Form node prompts the user for their username and password.

4. The user enters their username and password: The form data is stored in the user variable.

5. The Authenticate User node validates the credentials.

6. If the user's credentials are valid, the flow proceeds to the End Success node and the user is logged in.

7. If the user's credentials are not valid, the flow proceeds to the End Failure node and an error message displays.

Test the flow

To test the login flow before you activate it for production:

1. Select Settings.

2. Select Copy Flow URL.

3. Open the URL in a browser (or use your API client).

4. Test the login process by entering valid and invalid credentials as well as leaving empty fields, using special characters, and so on.

Activate the flow

To activate the flow after you have tested it:

1. In the flow list, next to your flow, select the Edit pencil icon.

   

2. Select the Active check box.

3. If this is the primary login flow, select Default flow.

4. Click Save.

   Your flow is now active and ready for users.