Security Trimming Stage

Configuration

The Security Trimming query pipeline stage restricts query results according to the user ID. While indexing the content, the Fusion connectors service stores security ACL metadata associated with the crawled items and indexes them as fields. The Security Trimming stage matches this information against the ID of the user running the search query.

This stage supports asynchronous processing.

Configuration

Tip	When entering configuration values in the UI, use unescaped characters, such as `\t` for the tab character. When entering configuration values in the API, use escaped characters, such as `\\t` for the tab character.

When using Fusion's REST API, the type for this stage is: security-trimming.

Property Description, Type

asyncConfig

Asynchronous Execution Config

type: object

object attributes: {
  asyncId : {
    display name: Async ID
    type: string
    description : A unique value to use as reference in downstream "Merge Async Results" stages.
    }
  enabled : {
    display name: Enable Async Execution
    type: boolean
    default value: 'false'
    description : Run the expensive data loading or processing part of this stage in a separate thread allowing the pipeline to continue executing. The results of this asynchronous execution can be merged into the pipeline request using a downstream "Merge Async Results" stage.
    }
  }

datasources

Restrict filter to Datasource(s)

A list of Fusion datasources to which security-trimming should be restricted, allowing content from other datasources to pass through un-filtered; if empty, all matching content is subject to filtering.

type: array of string

overrideUserIdentityHandling

Override Default User Identity Handling?

Default handling first attempts to take the user identity from a 'fusion-user-id' http-header, which is the logged-in user ID from the Fusion proxy service. If that value is empty, a 'username' query parameter is tried instead. When this DataSource property is enabled, the specified source and key properties are used explicitly, without any fallback behavior.

type: boolean

default value: 'false'

userIdentityKey

User ID key

e.g. username, userID, etc.

type: string

default value: 'username'

userIdentitySource

User ID source

Specify whether the value comes from an http header or query parameter.

type: string

default value: 'query_param'

enum: { query_param header }