Forms is an application for digitizing administrative process flows. Typical use cases include creating users (e.g. employees, consultants, partners), editing user data, or listing “My Users” and “My Groups.”

Forms provides a powerful tool to build web-based flows that delegate administration to the individuals responsible for specific information—streamlining management and improving data accuracy.

You can also create self-service flows, including user self-registration. For example, a user can authenticate using BankID, where verified information is retrieved and used to allow the user to create their own account.

We offer several tutorial videos demonstrating how to work with Forms in various scenarios.

Note: All videos are in Swedish.

• External workforce

• Microsoft Entra ID accounts

• Self registration of accounts

• Forms and IAM overview

• All movies by Fortified ID

Fortified ID Automate

Automate enables integration with one or more systems to read, transform, and write data across connected platforms.

A common use case is reading data from an HR system to identify newly created users, then automatically provisioning these users in systems like Active Directory, Google Workspace, or Microsoft Entra ID—completely without manual intervention by administrators or end users.

Fortified ID Attest

Attest extends Forms and Automation with support for approval workflows. Instead of allowing users to be created or modified immediately, one or more designated approvers must first review and approve the request.

A typical use case is requesting access to a group that protects a resource—such as a system or service—where a group owner or administrator must approve access before it is granted.

The solution can be deployed on-premises, in the cloud, or as a hybrid. Moving between test and production environments is streamlined and straightforward.

Fortified ID Password Reset

Password Reset from Fortified ID simplifies the management of secure password reset for your organization.

Users can easily and securely create a new password through self-service without having to contact their employer's IT support.

Users with personnel responsibility (manager, teacher, partner/consultant manager) can reset passwords on behalf of another user.

Your organization becomes more efficient as the time that the end user does not have access can be greatly shortened. In addition, IT personnel can also devote themselves to more constructive and proactive work.

Forms is a comprehensive Identity and Access Management (IAM) solution designed to streamline and adapt to the specific workflows of your organisation.

The modern landscape of IAM requires a balance between automation and control, and Forms offers both in a way that aligns with your internal processes. IAM solutions today need to be flexible enough to manage the complexity of access control across an organisation, especially as digital environments become more intricate and regulated. Forms IAM addresses this by providing customisable workflows that can be fully automated or augmented with manual checkpoints, ensuring both efficiency and accuracy. This flexibility is crucial in industries with stringent compliance requirements, where every access decision needs to be carefully monitored and validated. Forms IAM is available both on-premises and in the cloud, giving you the flexibility to deploy the solution in the environment that best suits your infrastructure and security requirements. Whether you are looking to maintain full control over your data in an on-prem deployment or leverage the scalability and convenience of the cloud, Forms IAM adapts to your strategy.

Additionally, Forms IAM integrates seamlessly with a wide range of common identity providers and data sources, including Entra ID (formerly Azure Active Directory), Google Cloud Identity, Microsoft Azure, Active Directory, and other leading platforms. This ensures that you can easily manage and centralise access controls across your existing ecosystems, without the need for complex custom integrations. The system allows administrators to configure workflows to match existing processes within the company. Whether it’s handling new employee onboarding, access revocation, or ongoing entitlement reviews, each flow can be automated for speed or include manual approval steps for sensitive actions. This adaptability ensures that the solution integrates seamlessly with your organisation’s existing protocols, rather than forcing a rigid, predefined process onto your teams. With scalable operations, capable of managing identity and access across both small businesses and large enterprises, Forms IAM can evolve alongside your organisation as it grows or its requirements change. In today’s rapidly evolving security environment, having a robust yet flexible IAM system like Forms ensures that your organisation can handle access control efficiently while maintaining the level of precision and oversight necessary for security and compliance.

Control types

Two categories of controls are available:

• Basic

• Advanced.

Basic controls are comparable to simple HTML inputs, such as checkboxes.

Advanced controls are more like mini-applications with specific goals. For example, they could display a list of Entra-ID users or groups as the first step in a Flow.

Both types are implemented on the front-end using react-jsonschema-form.

Structure of control configuration

All controls follow the same structure:

{
    "type": "<controlType>",
    "id": "<controlId>",
    "config": {
        "required": true,
        "read_only": false
    },
    "data": "<data>",
    "ui": {},
    "schema": {}
}

type: Defines what control to be used.

id: Unique identifier to the current flow. In subsequent pipe calls the id is sent to the pipe along with value(s) from the control and accessed in the piped using {{request.<id>}}

config: Block of control-specific configuration. Se each control for appropriate values.

data: Value to be injected in control.

ui: Any additional ui-related data sent to frontend, unfiltered. See https://rjsf-team.github.io/react-jsonschema-form/ UISchema for more information. Typically this is used for layout management.

schema: Any additional control-related data not available in current control implementation.

Binding data to a control

Data binding is typically done using "data" configuration for a control. Most likely date is set by using some template {{flow.givenName}}.

Configuration

{
    "id": "attestor",
    "type": "Attestor"
}

Install product

To install on Windows, click the following link: https://docs.fortifiedid.se/installation/windows

Verify installation

When installation is completed, verify the following:

• In Windows Services, verify that Fortified ID <product name> service exists

• In file system, verify that drive:\..\FortifiedID\<product name> exits

Note. Starting, stopping, and restarting the service are handled by Windows Services.

Overview

Certain operations or flows may be considered sensitive or require additional oversight before execution. This is where attestation becomes valuable.

Attestation enables manual review by one or more designated approvers before any automated actions are carried out. It is implemented as a configurable flow using built-in functionality.

Approvers are notified via email and receive a PDF document containing the relevant data for verification. Each PDF is tailored to the specific flow, ensuring that the information is clear, accessible, and easy to review.

Once a flow has been successfully attested, the PDF can be forwarded to an external archiving system for secure, long-term storage—ensuring traceability, auditability, and compliance.

Generic HTTP module configuration is found here https://docs.fortifiedid.se/modules/configuration

Forms module handles loading of multiple Flow. Multiple instances of Forms module can be deployed.

Only updated values are sent to pipe

Data changed by user will be sent to pipe.

Updated default encryption

As of 3.1.1 default encryption has been changed. This will only affect systems where encryption is enabled.

To keep previous implementation ensure environment setting:

FORTIFIED_SECRETS_IMPL = local

Release notes

Check the release notes to discover the latest updates and improvements in this version.

Breaking changes

If there are any breaking changes included in this release, carefully review them before upgrading to understand how they may impact your installation and to prepare for any necessary adjustments before or after the upgrade.

Use this control to manage group members for a selected groups. Note. To select the group, which often is done in a previous step, use the control Selector.

Use this control to manage groups for a selected user. Note. To select the user, which often is done in a previous step, use the control Selector.

User mapping

The logged-in user is identified by some user ID, most likely the SAML NameID attribute from SP login. This ID is used for filtering on order originator.

Below is a screenshot of the control. This is from a create step where an admin like to choose a manager for a user to be created.

Use this control to find and selected a Microsoft Entra ID user. Note. When user is selected you might like to manage groups for the user. Use the control EntraUserEditUserMember.

Requirements

An Entra ID module deployed with matching name as defined in "namespace".

The ValuePicker is often used as a drop-down list for admins to select predefined values from. See example below.

Receive input

Forms receives a JWT containing data using post. The JWT is verified using the trust_store and the payload is put into the flow state. This can later be accessed using flow.my_param1 in forms, and using request.my_param1 in pipes.

Send output

Forms sends a JWT to an external service using post. The payload is defined in the payload json structure and is expanded.

External_flow_id

Note! If Forms is used together with the ExternalFlow authenticator, the incoming external_flow_id must be added to the payload of the output JWT.

Overview of Flow, Step, Control and Pipes

Flow

On a high level, Forms delivers well defined "apps" with the soul purpose simplifying a process related to an "IAM-problem". Each app is called a Flow. A Flow have a set of basic properties. For example who may access, is it public, how do it consume authentication.

Step

Flow consists of a number of Steps. Each Step aims to guide the end user through the process. A simple Step could just consists of read only data about a user or a group.

Control

Every Step includes a number of Controls. A Control is some kind graphical entity used to let users read or write data. Just like a Flow or a Step a Control has a number of properties that will define it's behaviour.

By combining Flow, Step & Control small well-defined IAM apps can be built fast with instant added value.

Pipes

When a user wants to do something in the UI, such as retrieve or write data to a data source or process data, a pipe can be used. A pipe consists of a number of valves that can retrieve, write or process data. Pipes and valves are something that is found in all Fortified ID products and are shared between the products, so if you have knowledge of this from one of our other products, it works the same in Forms.

Data management

A flow starts by initialising two state objects: the Accumulated Flow State, and the Accumulated Flow Delta. If an initialising pipe is configured, that pipe is executed and the result, which must be a single, flat key/value object, is added to the Accumulated Flow State.

During the progression of a Flow, data from each step is accumulated in both state objects according to certain rules.

The data in the Accumulated Flow State can be referenced using the prefix flow, combined with the ID of the Control that provided the data.

Example:

The data in the Accumulated Flow Delta is sent to the pipes configured to run throughout the flow.

Example:

The next section describes this process in detail.

Control data and accumulated state

As the flow transitions from one step to the next, a number of things happen:

1. Each Control in the current step contributes its data to the Accumulated Flow State. For read only Controls, no change is accepted.

2. Each Control in the current step is inspected to see if it has data to contribute to the Accumulated Flow Delta. A Control only contributes data to the Delta if at least one of the following conditions holds true:

   • The data that the Control holds has changed since the Step was loaded.

   • The Control property always_include is set to true.

3. If a pipe function is associated with the current step, that pipe is called with the Accumulated Flow Delta, i.e. accumulated changed data from all steps up to and including the current one.

4. The data in the response from the pipe function, which must be a single, flat key/value object, is added to the Accumulated Flow State.

Data flow

Each Control contributes data to the Accumulated Delta according to a set of rules. The flowchart below visualises these rules. At the end of each step, before transitioning to the next or ending the flow, each Control is checked according to the flowchart, and when all Controls have been processed, the associated pipe is executed with the Accumulated Delta as parameter. The pipe returns a single, flat key/value object, which is added to the Accumulated Flow State.

Configuration

Configuration

Link to basic syntax supported using Markdown

Click following link for a number of examples on how to use markdown in a step.

Example markdown:

Use this control to find and selected a Microsoft Entra ID group. Note. When group is selected you might like to mange members for the group. Use the control EntraGroupEditGroupMember.

Requirements

An Entra ID module deployed with matching name as defined in "namespace".

Use this control to manage users for a selected group. Note. To select the user, which often is done in a previous step, use the control EntraGroupSelect.

Requirements

An Entra ID module deployed with matching name as defined in "namespace".

An Entra ID identifier, "selected_entra_id", located in either session or flow. Data is taken from session first and flow second. selected_entra_id must reference a Entra ID group.

Use this control to manage groups for a selected user. Note. To select the user, which often is done in a previous step, use the control EntraUserSelect.

Requirements

An Entra ID module deployed with matching name as defined in "namespace".

An Entra ID identifier, "selected_entra_id", located in either session or flow. Data is taken from session first and flow second. selected_entra_id must reference a Entra ID user.

Below is a screenshot of the control. This is from a create step where an admin has added Clarke and Kent in two input controls. Email and Mobile number has no value yet.

Scenarions when the control can be used:

• Like above when an admin creates a new object and needs to add data about the object. You can add data controllers to an inout control to verify correct syntax, an @ for email adress, no characters for an mobile number.

• You like to display data about an object. You search an LDAP directory and display a user with data about the user. The input control can be in edit or read-only mode.

Install product

To install on Linux, click the following link:

Verify installation

When installation is completed, verify the following:

1. Start the service by running <installation_path>/FortifiedID/forms/customer/bin/start.sh

2. Verify by accessing http://localhost:8080/forms/demo1 or http://localhost:8080/forms/demo2

3. Stop the service by running <installation_path>/FortifiedID/forms/customer/bin/stop.sh

User mapping

The logged-in user is identified by some user ID, most likely the SAML NameID attribute from SP login. This ID is used for filtering on order attestors.

Configuration

  {
    "id": "entraGroupSelect",
    "type": "EntraGroupSelect",
    "config": {
        "namespace": "tenant1",
        "columns": [
            "displayName",
            "description"
        ]
    },
    "ui": {
        "ui:search": false
    }
}

Only showing groups by end user

Set owned_groups_only_attribute will cause control match the data from owned_groups_only_attribute. Matching is done using data from owned_groups_only_attribute and entra_identifier.

entra_identifier is read from session or flow. Session read first then flow.

Settings "owned_groups_only_attribute":"owners", will match value from entra_identifier with id in "owners". Only showing groups where user is set to owner.

Exposed data to flow

"selected_entra_id" - id of selected group

"selected_entra_displayName" - display name of selected group.

  {
    "id": "entraGroupSelector",
    "type": "EntraGroupSelector",
    "config": {
        "namespace": "tenant1",
        "columns": [
            "displayName",
            "description"
        ]
    }
}

Exposed data to flow

Object array, "entra_pending_remove" - contains data on what groups to remove from user.

Object array, "entra_pending_add" - contains data on what groups add to user.

Array data will ha the syntax:

[{"id":"1234567","displayName":"Group 1"}]

• AuthN, version 2025.38 - details is found here https://docs.fortifiedid.se/authn

• Pipes, version 2024.115 - details are found here https://docs.fortifiedid.se/pipes/

• Http client, version 2025.29 - details is found here https://docs.fortifiedid.se/httpclient/

• JDBC client, version 2025.29 - details are found here https://docs.fortifiedid.se/jdbcclient/

• Ldap client, version 2025.29 - details are found here https://docs.fortifiedid.se/ldapclient/

• CEF module, version 2025.29 - details is found here https://docs.fortifiedid.se/cef/

• Node module, version 2025.29 - details is found here https://docs.fortifiedid.se/node/

• SMTP module, version 2025.29 - details are found here https://docs.fortifiedid.se/smtp/

• Entra ID module, version 2025.5 - details are found here https://docs.fortifiedid.se/entraid

• Workflow module, version 2025.3- details are found here https://docs.fortifiedid.se/workorders

Modules are started by default

Only Node is started by default. Modules have to be added in the configuration in order to be started.

Prerequisites

WorkOrder module deployed.

Create a flow used for attestation (accept/reject) using Attestor control.

Flow description

Configure last PIPE sending data to work order database and possible notifying user.

Configure one accept pipe to be executed once the work order is attested

Configure one reject pipe to be executed if order is rejected

Sending data to work order

Instead of performing updates directly, data used must be send to work-order database. Two thing are required for this:

• A PDF file used to visualise what is about to happen if accepted. Either use Html2Pdf valve for dynamic creation or use a static PDF file.

• In the last PIPE in the flow use

Accepting a work order

Once all attesters accepted the work order, accept pipe will be executed. Any flow data from order creation is present along with additional static data.

Accessing data sent from "work flow accept" is done using pattern {{request.xxx}}

Note that the accept pipe is executed in system context. No session with user data will be present.

Rejecting a work order

It only takes one attester to reject for the order to be rejected. Once rejected the reject pipe is executed. Here you can configure notification if desired.

Only showing used by end user

Set owned_users_only_attribute will cause control match the data from owned_users_only_attribute. Matching is done using data from owned_users_only_attribute and entra_identifier.

entra_identifier is read from session or flow. Session read first then flow.

Settings "owned_users_only_attribute":"manager", will match value from entra_identifier with id in "manager". Only showing users where user is set to owner.

Exposed data to flow

"selected_entra_id" - id of selected group

"selected_entra_displayName" - display name of selected group.

Configuration

Search filter

The search filter is a template that has access to all data that is available in the flow. Additionally, the template can use the parameter search_query, that contains the user input.

The attributes defined by display_key and value_key are always queried.

Exposed data to flow

Object array, "entra_pending_remove" - contains data on what groups to remove from user.

Object array, "entra_pending_add" - contains data on what groups add to user.

Array data will ha the syntax:

[{"id":"1234567","displayName":"Group 1"}]

Searching for object to show

To populate list of items in UI a pipe must be executed. List of items returned should at least contain properties defined in columns.

Data sent to pipe is:

• search - containing user input if config -> search is set to true

• columns - comma separated string of defined columns

Return data must be in a form of a list of items.

Data exposed to flow

When pressing Select, data exposed to flow is found using key if control id. Value is item id returned from pipe

Ui

For row ordering according to columns use the following type of configuration. In this example the rows will be sorted first by email, then name, phone and lastly date_of_birth. You can also see the configuration example in the example above in the properties table examples.

Install product

To install on Container/Docker, click the following link:

Verify installation

When installation is completed, verify the following:

Replace <container_display_name> with the container name and replace <product_name>:<version> with the image product name and version.

Parameter explanation:

Check the log to ensure that the server was successfully bootstrapped:

Finally, check that the server is up and running by pointing your browser at http://localhost:8080/forms/demo1 or

http://localhost:8080/forms/demo2

Note. Starting, stopping, and restarting the service are handled by Docker commands.

Requirements

An LdapClient module deployed with matching name as defined in "namespace".

Configuration

  {
    "id": "adGroupMember",
    "type": "ActiveDirectoryGroupEditGroupMember",
    "config": {
        "namespace": "ldap_client_1",
        "base_dn": "DC=company,DC=local",
        "scope": "SUB",
        "current_filter": "memberOf={{{flow.findMyActiveDirectoryGroups}}}",
        "available_filter": "(&(|(objectClass=user)(objectClass=group))(!(memberOf={{{flow.findMyActiveDirectoryGroups}}})))",
        "columns": [
            "displayName",
            "mail",
            "sAMAccountName",
            "mobile"
        ]
    }
}

Exposed data to flow

Object array, "ad_pending_remove" - contains data on what members to remove from group.

Object array, "ad_pending_add" - contains data on what members to add to group.

Example data in finalize pipe:

...
"ad_pending_add" : [ 
    { 
        "id" : "CN=Felix Andreasson,OU=Demo,DC=company,DC=local", 
        "displayName" : "Felix Andreasson" 
    }, 
    { 
        "id" : "CN=Eva Ek,OU=Demo,DC=company,DC=local", 
        "displayName" : "Eva Ek" 
    } 
],
"ad_pending_remove" : [ 
    { 
        "id" : "CN=Lance Armsson,OU=Demo,DC=company,DC=local", 
        "displayName" : "Lance Armsson" 
    }, 
    { 
        "id" : "CN=Britt Thomasson,OU=Demo,DC=company,DC=local", 
        "displayName" : "Britt Thomasson" 
    } 
]
...

Valves used in finalize pipe

ActiveDirectoryAddGroupToMembers

Used to add group members to a specified group

ActiveDirectoryRemoveGroupFromMembers

Used to remove group members from a specified group

Creating a step

A step is represented by a json object. Steps can be loaded from one json file or multiple files. Recommended setup is to keep each step in a single file. This will simplify configuration and overview.

{
    "controls": [
        {
            "id": "top_text_label",
            "type": "Markdown",
            "data": "# Create an Active Directory user \nEnter information about the user you want to create."
        },
        {
            "id": "givenName",
            "type": "Input",
            "ui": {
                "ui:size": {
                    "md": 6
                }
            },
            "schema": {
                "format": "strict"
            },
            "config": {
                "type": "string",
                "required": true
            }
        },
        {
            "id": "sn",
            "type": "Input",
            "ui": {
                "ui:size": {
                    "md": 6
                }
            },
            "schema": {
                "format": "strict"
            },
            "config": {
                "type": "string",
                "required": true
            }
        },
        {
            "id": "mail",
            "type": "Input",
            "ui": {
                "ui:size": {
                    "md": 6
                }
            },
            "schema": {
                "format": "email"
            },
            "config": {
                "type": "string",
                "required": true
            }
        },
        {
            "id": "mobile",
            "type": "Input",
            "ui": {
                "ui:size": {
                    "md": 6
                }
            },
            "schema": {
                "format": "phone"
            },
            "config": {
                "type": "string"
            }
        },
        {
            "id": "chooseRole",
            "type": "ValuePicker",
            "ui": {
                "ui:size": {
                    "md": 6
                }
            },
            "config": {
                "required": false,
                "options": [
                    {
                        "title": "Human Resources",
                        "value": "hr"
                    },
                    {
                        "title": "Sale",
                        "value": "sale"
                    },
                    {
                        "title": "IT",
                        "value": "it"
                    },
                    {
                        "title": "Engineering",
                        "value": "engineering"
                    }
                ]
            }
        },
        {
            "id": "adUserFindManager",
            "type": "ActiveDirectorySingleSelect",
            "ui": {
                "ui:size": {
                    "md": 6
                }
            },
            "config": {
                "attributes": [
                    "cn"
                ],
                "namespace": "${globals.ldap1_name}",
                "base_dn": "${globals.ldap1_flows_search_user_dn}",
                "scope": "SUB",
                "pre_filter": "(distinguishedName={{flow.manager}})",
                "filter": "(cn={{search_query}})",
                "value_key": "distinguishedName",
                "display_key": "cn"
            }
        }
    ]
}

{
    "controls": [
        {
            "id": "top_text_label",
            "type": "Markdown",
            "data": "# Change user\nSelect the user you want to modify"
        },
        {
            "id": "findActiveDirectoryUser",
            "type": "Selector",
            "config": {
                "columns": ["displayName","sAMAccountName","url","manager"],
                "pipe_id": "active_directory_edit_user_step01_widget"
            }
        }
    ],
    "pipe": "active_directory_edit_user_step01"
}

{
    "document_title": "flow00.step01.document_title",
    "favicon": "favicon.ico",
    "order": 1,
    "verbose_logs": [
        "flow",
        "session"
    ],
    "time_lock": "PT3S",
    "controls": [],
    "pipe": "forms.flow00.step01",
    "buttons": {
        "next_button": {
            "enabled": true,
            "text": "flow00.step01.next_button"
        },
        "save_button": {
            "enabled": true,
            "text": "flow00.step01.create_button"
        },
        "restart_button": {
            "enabled": true,
            "text": "flow00.step01.restart_button"
        }
    }
}

Pipe execution

If configured, execution of a pipe is done with all data available to the step. This means data will vary depending on what step is executed.

Data from all previous executed steps will be sent to pipe and accessed in pipes using {{request. pattern.

Returning from pipe execution

In order to be able to access any data returned from a pipe, return a single item in a pipe.

Data will available using {{flow.xxx}} pattern.

Skipping execution

A step can be enabled/disabled using the "enabled" flag. Both the page user interface and the pipe-execution is disabled if this flag is false.

Skipping execution conditionally

You can also enable/disable a step conditionally using the "include_expr"-expression (an expression that returns true or false). If the expression is evaluated to true, the step is included, otherwise skipped.

The actual filter is an ECMA-script (JavaScript) that MUST evaluate to true, false or to a boolean function returning true or false.

// Not included 
"include_expr": "false"

// Only included if session contains a username property
"include_expr": "session.username != null"

// Only included if a control from a previous step (findMyActiveDirectoryExtendAccountExpires) has a value
"include_expr": "str.isNotNullOrEmpty(flow.findMyActiveDirectoryExtendAccountExpires)",

This release

Crash when selecting search and then go back in ActiveDirectorySingleSelect

Improved error handling when selecting users.

Random sort order in frontend component, selectorwidget, when showing list.

Consistent sorting added.

UI improvements, selectorwidget

Updated alignment for improved ux

Control ActiveDirectoryRemoveGroupFromMembers update

Now can be configured reading list of members from custom attribute.

Datepicker control added

Find details here

Checkbox control added

Find details here

Information endpoint update

Templates now can be read from custom location

Step logic added

Steps now can excluded statically or dynamically based on context. See more here

Radio button control added

Find details here

Fixed bug in markdown

TextArea control update for improved markdown handling

Attestor control UI improvements

Details now supports markdown

Attestor roles updated

2 new roles added, auditor & requestor.

Start from external application

A form can be preloaded with data sent via HTTP POST from an external application. Once the flow is completed, the user is redirected back to the calling application.

Widget rendering on summary step

Summary now supports advanced controls

LDAPSearch valve update

Search result may now be merged with existing item making configuration simpler.

Now supports expansion on search base

LDAPMove valve - static bound to default ldap client

Now supports other ldap client than default

3.1.1

Force a control sending data to pipe

It is now possible forcing a control sending data to pipe even if not changed by user.

Done by setting:

"always_include":true

CVE updates

Updating underlying building blocks, both front and backend, in order to keep CVE risks at a minimum.

Supported target plattforms are:

• Container (docker, kubernetes etc.)

• Linux 64-bit

• Windows 64-bit

General information

Access to media is provided by Fortified ID support. Credentials consist of a username and an access token which are used when downloading the artefacts.

After successful installation, verify access to http://<installation_host>:8080.

A simple welcome page should be displayed.

Please refer to the common configuration of for information on how to change the look and feel of Forms.

How it is connected

In order for authentication to work, a SAML SP authenticator needs to be configured. Also, SAML SP need to share first part of URI in with Forms module.

Example

Forms module has "http_context" configured to "/forms". The SAML must have it's "http_context" set to "/forms/xxx" ("/forms/auth" is a good pattern).

Typically the properties regarding authentication in Forms module will look something like this:

"http_context": "/forms",
"http_auth_redirect_url": "/forms/authn/login",

On the SAML SP side configuration will look like this:

"http_context": "/forms/authn",
"success_location": "/forms/",

Once the user is authenticated data from incoming assertion vill be transfered to the session.

NameID vill be the users login identifier. Other attributes will be put in the session where multivalued attributes is merged into a comma separated list.

Filtering access to a Flow

Once authenticated all users by default can access a Flow. Restricting is based on roles attribute in the incoming assertion. By using the "requires_role" configuration parameter on the Flow restriction control is performed comparing the incoming "roles" in the assertion and data in "requires_role" for the Flow.

One value of "role" must match "requires_role" in order for user getting access.

Setting up a flow

The Flow is defined by a JSON file. Name of the file can be anything, but flow.json is a recommended name. Format of the data inside must be either JSON or JSONC. The flow.json file will be picked up, loaded and exposed by the Forms module.

{
    "name": "demo",
    "public": false,
    "require_roles": [
        "role00"
    ],
    "enable_progressbar": false,
    "show_user_menu": true,
    "verbose_logs": [
        "flow",
        "session"
    ],
    "buttons": {
        "next_button": {
            "enabled": true,
            "text": "flow00.next_button"
        },
        "save_button": {
            "enabled": true,
            "text": "flow00.create_button"
        },
        "restart_button": {
            "enabled": true,
            "text": "flow00.restart_button"
        }
    },
    "steps": "@include:steps/*.json",
    "pre_pipe": "forms.flow00.pre_pipe",
    "pipe": "forms.flow00.finalize",
    "incomplete": "@include:incomplete.json",
    "summary": "@include:steps/summary.json"
}

Before step 1

Sometimes it is necessary to perform some kind of logic before first step is rendered. Typically used for validation and or collecting data reqired in step 1.

For case like this use pre_pipe.

In order to consume data in subsequent steps, make sure the pipe returns one item. Data in this item will be accessible using {{flow.xxx}}

Requirements

An LdapClient module deployed with matching name as defined in "namespace".

Configuration

{
    "id": "adUserGroupMember",
    "type": "ActiveDirectoryUserEditGroupMember",
    "config": {
        "namespace": "ldap_client_1",
        "base_dn": "DC=company,DC=local",
        "current_filter": "(&(objectClass=group)(member={{{flow.findMyActiveDirectoryUsers}}}))",
        "available_filter": "(&(objectClass=group)(!(member={{{flow.findMyActiveDirectoryUsers}}})))",
        "columns": [
            "cn",
            "sAMAccountName"
        ]
    }
}

Exposed data to flow

Object array, "ad_pending_remove" - contains data on what groups to remove from user.

Object array, "ad_pending_add" - contains data on what groups to add to user.

Array data will have the syntax:

"ad_pending_add": [
    {
        "id": "CN=AWS administrator,OU=access_review,OU=Governance,OU=IdM_demo,OU=Product_Testing,DC=company,DC=local",
        "description": "Test",
        "cn": "AWS administrator",
        "sAMAccountName": "AWS administrator"
    },
    {
        "id": "CN=Cert Publishers,CN=Users,DC=company,DC=local",
        "description": "Members of this group are permitted to publish certificates to the directory",
        "cn": "Cert Publishers",
        "sAMAccountName": "Cert Publishers"
    }
],
"ad_pending_remove": [
    {
        "id": "CN=Access Control Assistance Operators,CN=Builtin,DC=company,DC=local",
        "cn": "Access Control Assistance Operators",
        "sAMAccountName": "Access Control Assistance Operators",
        "description": "Members of this group can remotely query authorization attributes and permissions for resources on this computer."
    }
]

Valves used in finalize pipe

ActiveDirectoryAddMemberToGroups

Used to add a single group member to groups

ActiveDirectoryRemoveMemberFromGroups

Used to remove a single group member from groups

The summary step has some additional properties.

{
  "auto_redirect": {
    "reset": true,
    "url": "/portal"
  },
}

{
    "id": "fullName",
    "type": "Input",
    "data": "${flow.givenName} ${flow.sn}",
    "config": {
        "required": true,
        "readonly": false,
        "always_include": true,
        "pattern": "^[A-Za-z ]{2,50}$"
    }
}

Frontend format validation.

By setting config.format, it guides the user entering value following a defined ruleset. A predefined set is available:

• date: full-date according to RFC3339.

• time: time (time-zone is mandatory).

• date-time: date-time (time-zone is mandatory).

• iso-time: time with optional time-zone.

• iso-date-time: date-time with optional time-zone.

• duration: duration from RFC3339

• uri: full URI.

• uri-reference: URI reference, including full and relative URIs.

• uri-template: URI template according to RFC6570

• email: email address.

• hostname: host name according to RFC1034.

• ipv4: IP address v4.

• ipv6: IP address v6.

• uuid: Universally Unique IDentifier according to RFC4122.

• float: float according to the openApi 3.0.0 specification

• double: double according to the openApi 3.0.0 specification

• password: password string according to the openApi 3.0.0 specification

• postal: /^[A-Za-z0-9 -]{3,10}$/,

• phone: /^[+]?[(]?[0-9]{1,4}[)]?([-s./0-9])$/,

• strict: /^[^";`<>\()[]{}%|!^]+$/u,

Setting a custom regex is done using config.pattern to regex

Example:

"pattern":"^[A-Za-z -]{3,30}$"

• Start (^) and end ($) exactly with

• Only contain uppercase letters (A–Z), lowercase letters (a–z), spaces, or hyphens (-)

• Have a length between 3 and 30 characters

Once set, custom error message needs to be put in for displaing a functional error message:

In this case "phone.error.format".

Add one or several labels and/or descriptions text elements to a step. Example below shows a markdowns example, one label and one description.

The example can be added as one markdown or two separate markdowns.

Configuration when one markdown

{
   "id": "top_text_label_description",
   "type": "Markdown",
   "data": "# Create an Active Directory user  \nEnter information about the user you want to create."
}

Configuration when one markdown

Note. When using several markdowns in one step, make sure the id is unique.

{
   "id": "top_text_label",
   "type": "Markdown",
   "data": "# Create an Active Directory user"
},
{
   "id": "top_text_description",
   "type": "Markdown",
   "data": "Enter information about the user you want to create."
}

Link to basic syntax supported using Markdown

Click following link for a number of examples on how to use markdown in a step. https://www.markdownguide.org/cheat-sheet/

The available dates can be limited with min_date and max_date.

The input fields min_date, max_date and data represents dates. Use input_formats to specify date format handlers. Two special format handlers are available:

• duration: Handles ISO 8601 durations e.g. P10D, -P5Y. Evaluates to todays date plus the duration.

• windows_filetime: Windows FILETIME format