Fine-grained customization using tenant ID, flow ID and/or step ID

When using IAM with multiple tenants, multiple flows or having multiple instances of the same step in one flow, it may be required to have different customizations per tenant, flow or even per step. Tenant, flow and/or step IDs can be prepended to the key names to achieve this.

Example:

Using authentication.password.username as the example key will result in the below key lookup strategy.

  • Using flow ID, step ID and tenant ID:
    custom.flow-step-tenant.<FLOW_ID>.<STEP_ID>.<TENANT_ID>.<KEY>.authentication.password.username
  • Using step ID and tenant ID:
    custom.step-tenant.<STEP_ID>.<TENANT_ID>.<KEY>.authentication.password.username
  • Using flow ID and tenant ID:
    custom.flow-tenant.<FLOW_ID>.<TENANT_ID>.<KEY>.authentication.password.username
  • Using tenant ID:
    custom.tenant.<TENANT_ID>.authentication.password.username
  • Using flow ID and step ID:
    custom.flow-step.<FLOW_ID>.<STEP_ID>.authentication.password.username
  • Using only step ID:
    custom.step.<STEP_ID>.authentication.password.username
  • Using only flow ID:
    custom.flow.<FLOW_ID>.authentication.password.username
  • Using neither:
    authentication.password.username

Lookups are performed in this order and terminate on the first match.

Note that in order to see pages with the specific tenant, flow or step IDs in the SDK, either the default flow ID must be configured in custom.sdk.config.js and/or the Loginapp REST UI SDK navigation menu configuration accordingly.