Skip to content

Headers Reference

Both the parallel and daily load iFlows accept headers prefixed with roiam_. Headers are passed either via the HTTPS request or set in the JMS message properties.

Initial load headers

HeaderRequiredDefaultDescription
roiam_customer_system_nameYesThe registered name of the source system in ROI iAM. Used to resolve the destination, credentials, and variable keys.
roiam_scim_bulk_parallel_page_sizeNoConfigured in iFlowThe number of records each parallel thread processes. Automatically aligned to a multiple of the internal paging size.
roiam_api_paging_sizeNoExtracted automatically from a property of the repository that is loadedThe page size used when calling the source system API within each thread's loop.
roiam_testrun_sizeNoLimits the total number of records to process. Overrides the totalResults returned by the source system. When set, variables are not persisted.
roiam_src_filterNoAn additional filter expression appended to the source system API query string (e.g., &MX_DEPARTMENT eq 'IT').

Daily load headers

HeaderRequiredDefaultDescription
roiam_customer_system_nameYesThe registered name of the source system in ROI iAM. Used to resolve the destination, credentials, and variable keys.
roiam_testrun_sizeNoLimits the total number of records to process. Overrides the totalResults returned by the source system.
roiam_src_filterNoAn additional filter expression appended to the source system API query string.
roiam_scim_skip_writeNoWhen set to true, skips the SCIM write step.

Header propagation

Both iFlows use the allowed header pattern roiam_\S+, which means any header starting with roiam_ followed by one or more non-whitespace characters is propagated into the integration process. Internal headers (e.g., Authorization, Accept) are managed by the flow and should not be set by the caller.

See also