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

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

 
Example

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>.authentication.password.username
  • Using flow ID and step ID:
    custom.flow-step.<FLOW_ID>.<STEP_ID>.authentication.password.username
  • Using flow ID and tenant ID:
    custom.flow-tenant.<FLOW_ID>.<TENANT_ID>.authentication.password.username
  • Using step ID and tenant ID:
    custom.step-tenant.<STEP_ID>.<TENANT_ID>.authentication.password.username
  • Using only flow ID:
    custom.flow.<FLOW_ID>.authentication.password.username
  • Using only step ID:
    custom.step.<STEP_ID>.authentication.password.username
  • Using only tenant ID:
    custom.tenant.<TENANT_ID>.authentication.password.username
  • Using neither:
    authentication.password.username
 
Notice

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

To see pages with the specific flow, step or tenant IDs in the Loginapp Design Kit, either the default flow ID must be configured in custom.sdk.config.js, and/or the Navigation menu configuration.

Field-specific validation error messages

It is also possible to combine the customizations per flow, step or tenant with field-specific error messages. To achieve this, prepend the flow, step, and/or tenant IDs to the field-specific translation keys.

For example, you have the following translation key for a field-specific error message:

error.validation-failed._field.email._type.invalid-value
  • To apply it to a specific step, prepend the step ID as follows: 
  • custom.step.<STEP_ID>.error.validation-failed._field.email._type.invalid-value
  • To apply it to a specific step in a specific flow, add flow and step ID, as follows: 
  • custom.flow-step.<FLOW_ID>.<STEP_ID>.error.validation-failed._field.email._type.invalid-value
  • And so on.
 
Notice

For details on specifying field-specific error messages, see Adding field-specific error messages.