@bluelibs/runner - v6.3.3
    Preparing search index...

    Type Alias IdentityScopeConfig

    IdentityScopeConfig:
        | { required?: boolean; tenant: false; user?: false }
        | { required?: boolean; tenant: true; user?: boolean }

    Controls whether identity-aware middleware partitions its internal state by the active identity payload.

    Omit the option to use default automatic tenant partitioning when identity exists. Provide { tenant: true } to require tenant partitioning explicitly. Provide { tenant: false } to disable identity-based partitioning entirely. Add user: true for <tenantId>:<userId>:... partitioning. Set required: false when identity should refine the key only when present.

    Type Declaration

    • { required?: boolean; tenant: false; user?: false }
      • Optionalrequired?: boolean

        Accepted for config-shape consistency, but ignored because identity is not read when tenant partitioning is disabled.

      • tenant: false

        Disable identity-based partitioning entirely.

      • Optionaluser?: false

        User partitioning is not available when tenant partitioning is off.

    • { required?: boolean; tenant: true; user?: boolean }
      • Optionalrequired?: boolean

        Require the scoped identity fields to exist.

        Defaults to true. Set to false when identity should only refine the key when available.

      • tenant: true

        Enable tenant partitioning for middleware-managed state.

      • Optionaluser?: boolean

        Append userId after tenantId when it exists.

        When required is not set to false, userId becomes mandatory.

    Settings

    Member Visibility