IO Workflow Guide
Identity Orchestration Workflows provide a powerful no-code solution to design and manage identity processes using an intuitive drag-and-drop interface. You can:
- Use pre-built templates.
- Build workflows from scratch.
- Customize existing workflows.
This flexibility empowers you to create workflows tailored to your business needs effortlessly.
Configuration
This configuration guides you through creating identity workflows for customer registration, authentication forgot passwords, and more. You can design workflows for different brands or deploy separate workflows for custom use cases.
- Navigate to Admin Console > Orchestration > Workflows.
- Click the New Workflow button.
- Choose the Workflow Type
Start with a Template: This allows you to choose a prebuilt template for common identity workflows, such as Login/Registration.
Start in the Editor: Create a workflow based on your custom requirements.
Start with a JSON File.
- Once you select the Workflow type, a popup will appear asking for workflow details; the following are the details you need to add.
- Workflow Name, a unique identifier for your workflow
- Workflow Description (Optional): Additional details about the workflow.
- Brand (Optional): This field allows you to associate the workflow with a specific brand, as defined in the Theme Customization Guide. Select a brand based on your branding requirements and the Theme Customization Guide.
- Upload Workflow JSON: Upload workflow JSON if you select the workflow type Upload your JSON.
- Debug Mode: This feature allows you to turn on or off debugging for the workflow. Enabling debugging can help identify and resolve issues during the workflow creation and testing process. For example, if your workflow is not behaving as expected, enabling debugging can help you trace the problem and make necessary adjustments.
Once the configuration is completed, you will be redirected to the Workflow Editor.
Workflow Editor
The Workflow Editor is a powerful, user-friendly live editor that allows you to design and customize identity workflows without writing code. Its intuitive drag-and-drop interface simplifies workflow creation, making it easy to confidently build, modify, and test solutions.
IO Workflow Nodes
Nodes are the core building blocks of your workflow. Each node represents a specific identity management function in the left sidebar of the Workflow Editor.
Key Features of Workflow Nodes:
- Modularity: Each node performs a distinct function, allowing you to combine them for complex workflows.
- Customizability: Nodes can be configured with parameters to tailor them to your specific requirements.
- Reusability: Save frequently used configurations for future workflows to save time.
Customizing and Testing Workflows
The drag-and-drop interface allows you to arrange nodes into a logical sequence, visually representing your workflow. You can test your workflows within the editor to ensure they function as expected before deployment.
Refer to the Supported IO Workflow Nodes Guide for comprehensive information on each node type and its capabilities.
Deployment
Once all configurations and the workflow are ready to deploy, click the Update button to apply the changes. This will make the updated workflow available for use. To preview the workflow, click the Preview button and select the OIDC/OAuth App and Brands.
Here are additional technical details for understanding and utilizing the preview URLs generated during workflow deployment:
URL Format
The format of the URLs generated for workflows is as follows:
https://<API_Domain>/workflow?workflowName=<workflow_name>&client_id=<client_id>&brand=<brand>&debugMode=<debug_mode>
- API Domain: The domain of the LoginRadius Hub, e.g.,
lrdemo2.hub.loginradius.com
.
Options and Query Parameters
The URL can include various parameters to control workflow behavior. Below is a list of key parameters:
Parameter | Description |
---|---|
workflowName | The workflow name to be triggered can be found under Admin Console > Orchestration > Workflows. |
client_id | Client ID of the OIDC/OAuth application Note: To know more about OIDC/Oauth App creation, navigate to this document |
brand | The brand under which the workflow is to be executed. The name of the brand that is created under the Admin Console > Orchestration > Theme Customization |
debugMode | To see the debug log during the workflow execution, use the flag true |
Preview URL
The Preview URL is the live URL used to see the orchestration workflow. It allows you to run the existing workflow directly. To access and utilize the Preview URL, follow these steps:
-
Navigate to Admin Console > Orchestration > Workflows in the LoginRadius Console:
-
Select the workflow from the list.
-
A popup will appear to provide the deployed workflow.
-
Select the OIDC/OAuth App and theme in the popup to preview the workflow.
-
Click on Preview, and it will redirect you to the Preview URL.
Triggering Workflows via URLs
You can trigger workflows using URLs in different scenarios:
Standard Login Workflow (Webpage as Entry Point)
- Use Case: Workflows with a login or entry form are displayed as a web page.
- Create the web page workflow in the Workflow Builder; see the Orchestration Login Workflow Example Use-Cases.
- How to Trigger:
- Navigate to the Preview URL corresponding to the workflow.
https://api_domain/workflow?workflowName=<workflow_name>&client_id=<client_id>&brand=<brand>
- Add the
api_domain
,workflowname
,client_id
andbrand
.
Using the above guidelines, you can deploy, preview, and interact with workflows efficiently, tailoring them to specific application and business requirements.
Related Resources
Enhance your understanding with these additional references: