Package org.keycloak.authorization.policy.provider

Interface PartialEvaluationStorageProvider

All Known Subinterfaces:
JpaUserPartialEvaluationProvider
All Known Implementing Classes:
JpaUserProvider
public interface PartialEvaluationStorageProvider
If a realm has the Profile.Feature.ADMIN_FINE_GRAINED_AUTHZ feature enabled, realm resources storage providers can implement this interface if they want to apply custom predicates to queries to filter their results based on the permissions available from the realm.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<jakarta.persistence.criteria.Predicate>
    getFilters(PartialEvaluationContext evaluationContext)
    A callback method that will be called when building queries for realm resources to grant access to resources.
    List<jakarta.persistence.criteria.Predicate>
    getNegateFilters(PartialEvaluationContext context)
    A callback method that will be called when building queries for realm resources to deny access to resources.

  • Method Details

    • getFilters

      List<jakarta.persistence.criteria.Predicate> getFilters(PartialEvaluationContext evaluationContext)
      A callback method that will be called when building queries for realm resources to grant access to resources. It returns a list of Predicate instances representing the filters that should be applied to queries when querying realm resources.
      Parameters:
      evaluationContext - the evaluation context.
      Returns:
      the list of predicates

    • getNegateFilters

      List<jakarta.persistence.criteria.Predicate> getNegateFilters(PartialEvaluationContext context)
      A callback method that will be called when building queries for realm resources to deny access to resources. It returns a list of Predicate instances representing the filters that should be applied to queries when querying realm resources.
      Parameters:
      context - the evaluation context.
      Returns:
      the list of predicates