Uses of Interface
org.keycloak.authorization.model.Policy

Packages that use Policy

Package	Description
org.keycloak.authorization.model	Provides the domain model and any other type related with it
org.keycloak.authorization.policy.evaluation	Provides classes related with the evaluation of policies.
org.keycloak.authorization.policy.provider	Provides classes and a SPI to plug different policy providers.
org.keycloak.authorization.store	Provides classes and a SPI to plug different metadata storage implementations.
org.keycloak.models.utils

Uses of Policy in org.keycloak.authorization.model

Fields in org.keycloak.authorization.model with type parameters of type Policy

Modifier and Type	Field	Description
static SearchableModelField<Policy>	Policy.SearchableFields.ASSOCIATED_POLICY_ID
static SearchableModelField<Policy>	Policy.SearchableFields.CONFIG
static SearchableModelField<Policy>	Policy.SearchableFields.ID
static SearchableModelField<Policy>	Policy.SearchableFields.NAME
static SearchableModelField<Policy>	Policy.SearchableFields.OWNER
static SearchableModelField<Policy>	Policy.SearchableFields.RESOURCE_ID
static SearchableModelField<Policy>	Policy.SearchableFields.RESOURCE_SERVER_ID
static SearchableModelField<Policy>	Policy.SearchableFields.SCOPE_ID
static SearchableModelField<Policy>	Policy.SearchableFields.TYPE

Methods in org.keycloak.authorization.model that return Policy

Modifier and Type	Method	Description
Policy	PermissionTicket.getPolicy()

Methods in org.keycloak.authorization.model that return types with arguments of type Policy

Modifier and Type	Method	Description
Set<Policy>	Policy.getAssociatedPolicies()	Returns the Policy instances associated with this policy and used to evaluate authorization decisions when this policy applies.
SearchableModelField<Policy>	Policy.FilterOption.getSearchableModelField()

Methods in org.keycloak.authorization.model with parameters of type Policy

Modifier and Type	Method	Description
void	Policy.addAssociatedPolicy(Policy associatedPolicy)
void	Policy.removeAssociatedPolicy(Policy associatedPolicy)
void	PermissionTicket.setPolicy(Policy policy)

Uses of Policy in org.keycloak.authorization.policy.evaluation

Methods in org.keycloak.authorization.policy.evaluation that return Policy

Modifier and Type	Method	Description
Policy	DefaultEvaluation.getParentPolicy()
Policy	DefaultEvaluation.getPolicy()
Policy	Evaluation.getPolicy()	Returns the Policy.
Policy	Result.PolicyResult.getPolicy()

Methods in org.keycloak.authorization.policy.evaluation that return types with arguments of type Policy

Modifier and Type	Method	Description
Map<Policy,Map<Object,Decision.Effect>>	DefaultEvaluation.getDecisionCache()

Methods in org.keycloak.authorization.policy.evaluation with parameters of type Policy

Modifier and Type	Method	Description
Result.PolicyResult	Result.getPolicy(Policy policy)
Result.PolicyResult	Result.policy(Policy policy)
Result.PolicyResult	Result.PolicyResult.policy(Policy policy, Decision.Effect effect)
void	DefaultEvaluation.setPolicy(Policy policy)

Method parameters in org.keycloak.authorization.policy.evaluation with type arguments of type Policy

Modifier and Type	Method	Description
void	DefaultPolicyEvaluator.evaluate(ResourcePermission permission, AuthorizationProvider authorizationProvider, EvaluationContext executionContext, Decision decision, Map<Policy,Map<Object,Decision.Effect>> decisionCache)
void	PolicyEvaluator.evaluate(ResourcePermission permission, AuthorizationProvider authorizationProvider, EvaluationContext executionContext, Decision decision, Map<Policy,Map<Object,Decision.Effect>> decisionCache)	Starts the evaluation of the configured authorization policies.

Constructors in org.keycloak.authorization.policy.evaluation with parameters of type Policy

Constructor	Description
DefaultEvaluation(ResourcePermission permission, EvaluationContext executionContext, Policy parentPolicy, Decision decision, AuthorizationProvider authorizationProvider, Map<Policy,Map<Object,Decision.Effect>> decisionCache)
DefaultEvaluation(ResourcePermission permission, EvaluationContext executionContext, Policy parentPolicy, Policy policy, Decision decision, AuthorizationProvider authorizationProvider, Map<Policy,Map<Object,Decision.Effect>> decisionCache)
PolicyResult(Policy policy)
PolicyResult(Policy policy, Decision.Effect status)

Constructor parameters in org.keycloak.authorization.policy.evaluation with type arguments of type Policy

Constructor	Description
DefaultEvaluation(ResourcePermission permission, EvaluationContext executionContext, Policy parentPolicy, Decision decision, AuthorizationProvider authorizationProvider, Map<Policy,Map<Object,Decision.Effect>> decisionCache)
DefaultEvaluation(ResourcePermission permission, EvaluationContext executionContext, Policy parentPolicy, Policy policy, Decision decision, AuthorizationProvider authorizationProvider, Map<Policy,Map<Object,Decision.Effect>> decisionCache)

Uses of Policy in org.keycloak.authorization.policy.provider

Methods in org.keycloak.authorization.policy.provider with parameters of type Policy

Modifier and Type	Method	Description
default void	PolicyProviderFactory.onCreate(Policy policy, R representation, AuthorizationProvider authorization)
default void	PolicyProviderFactory.onExport(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorizationProvider)
default void	PolicyProviderFactory.onImport(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization)
default void	PolicyProviderFactory.onRemove(Policy policy, AuthorizationProvider authorization)
default void	PolicyProviderFactory.onUpdate(Policy policy, R representation, AuthorizationProvider authorization)
R	PolicyProviderFactory.toRepresentation(Policy policy, AuthorizationProvider authorization)

Uses of Policy in org.keycloak.authorization.store

Methods in org.keycloak.authorization.store that return Policy

Modifier and Type	Method	Description
Policy	PolicyStore.create(AbstractPolicyRepresentation representation, ResourceServer resourceServer)	Creates a new Policy instance.
Policy	PolicyStore.findById(String id, String resourceServerId)	Returns a Policy with the given id
Policy	PolicyStore.findByName(String name, String resourceServerId)	Returns a Policy with the given name

Methods in org.keycloak.authorization.store that return types with arguments of type Policy

Modifier and Type	Method	Description
default List<Policy>	PolicyStore.findByResource(String resourceId, String resourceServerId)	Returns a list of Policy associated with a org.keycloak.authorization.core.model.Resource with the given resourceId.
List<Policy>	PolicyStore.findByResourceServer(String resourceServerId)	Returns a list of Policy associated with a ResourceServer with the given resourceServerId.
List<Policy>	PolicyStore.findByResourceServer(Map<Policy.FilterOption,String[]> attributes, String resourceServerId, int firstResult, int maxResult)	Returns a list of Policy associated with a ResourceServer with the given resourceServerId.
default List<Policy>	PolicyStore.findByResourceType(String resourceType, String resourceServerId)	Returns a list of Policy associated with a org.keycloak.authorization.core.model.Resource with the given type.
List<Policy>	PolicyStore.findByScopeIds(List<String> scopeIds, String resourceServerId)	Returns a list of Policy associated with a org.keycloak.authorization.core.model.Scope with the given scopeIds.
default List<Policy>	PolicyStore.findByScopeIds(List<String> scopeIds, String resourceId, String resourceServerId)	Returns a list of Policy associated with a org.keycloak.authorization.core.model.Scope with the given resourceId and scopeIds.
List<Policy>	PolicyStore.findByType(String type, String resourceServerId)	Returns a list of Policy with the given type.
List<Policy>	PolicyStore.findDependentPolicies(String id, String resourceServerId)	Returns a list of Policy that depends on another policy with the given id.

Method parameters in org.keycloak.authorization.store with type arguments of type Policy

Modifier and Type	Method	Description
void	PolicyStore.findByResource(String resourceId, String resourceServerId, Consumer<Policy> consumer)
void	PolicyStore.findByResourceType(String type, String resourceServerId, Consumer<Policy> policyConsumer)
void	PolicyStore.findByScopeIds(List<String> scopeIds, String resourceId, String resourceServerId, Consumer<Policy> consumer)	Effectively the same method as PolicyStore.findByScopeIds(List, String, String), however in the end the consumer is fed with the result.

Uses of Policy in org.keycloak.models.utils

Methods in org.keycloak.models.utils that return Policy

Modifier and Type	Method	Description
static Policy	RepresentationToModel.toModel(AbstractPolicyRepresentation representation, AuthorizationProvider authorization, Policy model)

Methods in org.keycloak.models.utils with parameters of type Policy

Modifier and Type	Method	Description
static Policy	RepresentationToModel.toModel(AbstractPolicyRepresentation representation, AuthorizationProvider authorization, Policy model)
static <R extends AbstractPolicyRepresentation> R	ModelToRepresentation.toRepresentation(Policy policy, AuthorizationProvider authorization)
static <R extends AbstractPolicyRepresentation> R	ModelToRepresentation.toRepresentation(Policy policy, AuthorizationProvider authorization, boolean genericRepresentation, boolean export)
static <R extends AbstractPolicyRepresentation> R	ModelToRepresentation.toRepresentation(Policy policy, AuthorizationProvider authorization, boolean genericRepresentation, boolean export, boolean allFields)