Uses of Interface
org.keycloak.authorization.model.Policy
Package
Description
Provides the domain model and any other type related with it
Provides classes related with the evaluation of policies.
Provides classes and a SPI to plug different policy providers.
Provides classes and a SPI to plug different metadata storage implementations.
-
Uses of Policy in org.keycloak.authorization.admin
Modifier and TypeMethodDescriptionPolicyService.create
(AbstractPolicyRepresentation representation) protected Policy
PolicyResourceService.getPolicy()
Modifier and TypeMethodDescriptionprotected PolicyResourceService
PermissionService.doCreatePolicyResource
(Policy policy) protected Object
PolicyService.doCreatePolicyResource
(Policy policy) protected Object
PolicyTypeService.doCreatePolicyResource
(Policy policy) protected AbstractPolicyRepresentation
PermissionService.toRepresentation
(Policy policy, String fields, AuthorizationProvider authorization) protected AbstractPolicyRepresentation
PolicyResourceService.toRepresentation
(Policy policy, String fields, AuthorizationProvider authorization) protected AbstractPolicyRepresentation
PolicyService.toRepresentation
(Policy model, String fields, AuthorizationProvider authorization) protected AbstractPolicyRepresentation
PolicyTypeResourceService.toRepresentation
(Policy policy, String fields, AuthorizationProvider authorization) protected AbstractPolicyRepresentation
PolicyTypeService.toRepresentation
(Policy policy, String fields, AuthorizationProvider authorization) ModifierConstructorDescriptionPolicyResourceService
(Policy policy, ResourceServer resourceServer, AuthorizationProvider authorization, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) PolicyTypeResourceService
(Policy policy, ResourceServer resourceServer, AuthorizationProvider authorization, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) -
Uses of Policy in org.keycloak.authorization.jpa.store
Modifier and TypeMethodDescriptionJPAPolicyStore.create
(ResourceServer resourceServer, AbstractPolicyRepresentation representation) JPAPolicyStore.findById
(RealmModel realm, ResourceServer resourceServer, String id) JPAPolicyStore.findByName
(ResourceServer resourceServer, String name) PermissionTicketAdapter.getPolicy()
Modifier and TypeMethodDescriptionJPAPolicyStore.find
(RealmModel realm, ResourceServer resourceServer, Map<Policy.FilterOption, String[]> attributes, Integer firstResult, Integer maxResults) JPAPolicyStore.findByResourceServer
(ResourceServer resourceServer) JPAPolicyStore.findByScopes
(ResourceServer resourceServer, List<Scope> scopes) JPAPolicyStore.findByType
(ResourceServer resourceServer, String type) JPAPolicyStore.findDependentPolicies
(ResourceServer resourceServer, String policyId) PolicyAdapter.getAssociatedPolicies()
Modifier and TypeMethodDescriptionvoid
PolicyAdapter.addAssociatedPolicy
(Policy associatedPolicy) void
PolicyAdapter.removeAssociatedPolicy
(Policy associatedPolicy) void
static PolicyEntity
Modifier and TypeMethodDescriptionvoid
JPAPolicyStore.findByResource
(ResourceServer resourceServer, Resource resource, Consumer<Policy> consumer) void
JPAPolicyStore.findByResourceType
(ResourceServer resourceServer, String resourceType, Consumer<Policy> consumer) void
JPAPolicyStore.findByScopes
(ResourceServer resourceServer, Resource resource, List<Scope> scopes, Consumer<Policy> consumer) -
Uses of Policy in org.keycloak.authorization.model
Modifier and TypeMethodDescriptionPolicy.getAssociatedPolicies()
Returns thePolicy
instances associated with this policy and used to evaluate authorization decisions when this policy applies.Modifier and TypeMethodDescriptionvoid
Policy.addAssociatedPolicy
(Policy associatedPolicy) void
Policy.removeAssociatedPolicy
(Policy associatedPolicy) void
-
Uses of Policy in org.keycloak.authorization.policy.evaluation
Modifier and TypeMethodDescriptionDefaultEvaluation.getParentPolicy()
DefaultEvaluation.getPolicy()
Evaluation.getPolicy()
Returns thePolicy
.Result.PolicyResult.getPolicy()
Modifier and TypeMethodDescriptionResult.PolicyResult.policy
(Policy policy, Decision.Effect effect) void
Modifier and TypeMethodDescriptionvoid
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.ModifierConstructorDescriptionDefaultEvaluation
(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) ModifierConstructorDescriptionDefaultEvaluation
(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
Modifier and TypeMethodDescriptiondefault 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) PolicyProviderFactory.toRepresentation
(Policy policy, AuthorizationProvider authorization) -
Uses of Policy in org.keycloak.authorization.policy.provider.aggregated
Modifier and TypeMethodDescriptionvoid
AggregatePolicyProviderFactory.onCreate
(Policy policy, AggregatePolicyRepresentation representation, AuthorizationProvider authorization) void
AggregatePolicyProviderFactory.onImport
(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization) void
AggregatePolicyProviderFactory.onRemove
(Policy policy, AuthorizationProvider authorization) void
AggregatePolicyProviderFactory.onUpdate
(Policy policy, AggregatePolicyRepresentation representation, AuthorizationProvider authorization) AggregatePolicyProviderFactory.toRepresentation
(Policy policy, AuthorizationProvider authorization) -
Uses of Policy in org.keycloak.authorization.policy.provider.client
Modifier and TypeMethodDescriptionvoid
ClientPolicyProviderFactory.onCreate
(Policy policy, ClientPolicyRepresentation representation, AuthorizationProvider authorization) void
ClientPolicyProviderFactory.onExport
(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization) void
ClientPolicyProviderFactory.onImport
(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization) void
ClientPolicyProviderFactory.onUpdate
(Policy policy, ClientPolicyRepresentation representation, AuthorizationProvider authorization) ClientPolicyProviderFactory.toRepresentation
(Policy policy, AuthorizationProvider authorization) ModifierConstructorDescriptionClientPolicyProvider
(BiFunction<Policy, AuthorizationProvider, ClientPolicyRepresentation> representationFunction) -
Uses of Policy in org.keycloak.authorization.policy.provider.clientscope
Modifier and TypeMethodDescriptionvoid
ClientScopePolicyProviderFactory.onCreate
(Policy policy, ClientScopePolicyRepresentation representation, AuthorizationProvider authorization) void
ClientScopePolicyProviderFactory.onExport
(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorizationProvider) void
ClientScopePolicyProviderFactory.onImport
(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization) void
ClientScopePolicyProviderFactory.onUpdate
(Policy policy, ClientScopePolicyRepresentation representation, AuthorizationProvider authorization) ClientScopePolicyProviderFactory.toRepresentation
(Policy policy, AuthorizationProvider authorization) ModifierConstructorDescriptionClientScopePolicyProvider
(BiFunction<Policy, AuthorizationProvider, ClientScopePolicyRepresentation> representationFunction) -
Uses of Policy in org.keycloak.authorization.policy.provider.group
Modifier and TypeMethodDescriptionvoid
GroupPolicyProviderFactory.onCreate
(Policy policy, GroupPolicyRepresentation representation, AuthorizationProvider authorization) void
GroupPolicyProviderFactory.onExport
(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization) void
GroupPolicyProviderFactory.onImport
(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization) void
GroupPolicyProviderFactory.onUpdate
(Policy policy, GroupPolicyRepresentation representation, AuthorizationProvider authorization) GroupPolicyProviderFactory.toRepresentation
(Policy policy, AuthorizationProvider authorization) ModifierConstructorDescriptionGroupPolicyProvider
(BiFunction<Policy, AuthorizationProvider, GroupPolicyRepresentation> representationFunction) -
Uses of Policy in org.keycloak.authorization.policy.provider.js
Modifier and TypeMethodDescriptionprotected ScriptModel
DeployedScriptPolicyFactory.getScriptModel
(Policy policy, RealmModel realm, ScriptingProvider scripting) protected ScriptModel
JSPolicyProviderFactory.getScriptModel
(Policy policy, RealmModel realm, ScriptingProvider scripting) void
DeployedScriptPolicyFactory.onCreate
(Policy policy, JSPolicyRepresentation representation, AuthorizationProvider authorization) void
JSPolicyProviderFactory.onCreate
(Policy policy, JSPolicyRepresentation representation, AuthorizationProvider authorization) void
JSPolicyProviderFactory.onImport
(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization) void
JSPolicyProviderFactory.onRemove
(Policy policy, AuthorizationProvider authorization) void
JSPolicyProviderFactory.onUpdate
(Policy policy, JSPolicyRepresentation representation, AuthorizationProvider authorization) DeployedScriptPolicyFactory.toRepresentation
(Policy policy, AuthorizationProvider authorization) JSPolicyProviderFactory.toRepresentation
(Policy policy, AuthorizationProvider authorization) -
Uses of Policy in org.keycloak.authorization.policy.provider.permission
Modifier and TypeMethodDescriptionvoid
ResourcePolicyProviderFactory.onCreate
(Policy policy, ResourcePermissionRepresentation representation, AuthorizationProvider authorization) void
ScopePolicyProviderFactory.onCreate
(Policy policy, ScopePermissionRepresentation representation, AuthorizationProvider authorization) void
UMAPolicyProviderFactory.onCreate
(Policy policy, UmaPermissionRepresentation representation, AuthorizationProvider authorization) void
UMAPolicyProviderFactory.onImport
(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization) void
ResourcePolicyProviderFactory.onRemove
(Policy policy, AuthorizationProvider authorization) void
UMAPolicyProviderFactory.onRemove
(Policy policy, AuthorizationProvider authorization) void
ResourcePolicyProviderFactory.onUpdate
(Policy policy, ResourcePermissionRepresentation representation, AuthorizationProvider authorization) void
ScopePolicyProviderFactory.onUpdate
(Policy policy, ScopePermissionRepresentation representation, AuthorizationProvider authorization) void
UMAPolicyProviderFactory.onUpdate
(Policy policy, UmaPermissionRepresentation representation, AuthorizationProvider authorization) ResourcePolicyProviderFactory.toRepresentation
(Policy policy, AuthorizationProvider authorization) ScopePolicyProviderFactory.toRepresentation
(Policy policy, AuthorizationProvider authorization) UMAPolicyProviderFactory.toRepresentation
(Policy policy, AuthorizationProvider authorization) -
Uses of Policy in org.keycloak.authorization.policy.provider.regex
Modifier and TypeMethodDescriptionvoid
RegexPolicyProviderFactory.onCreate
(Policy policy, RegexPolicyRepresentation representation, AuthorizationProvider authorization) void
RegexPolicyProviderFactory.onImport
(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization) void
RegexPolicyProviderFactory.onUpdate
(Policy policy, RegexPolicyRepresentation representation, AuthorizationProvider authorization) RegexPolicyProviderFactory.toRepresentation
(Policy policy, AuthorizationProvider authorization) ModifierConstructorDescriptionRegexPolicyProvider
(BiFunction<Policy, AuthorizationProvider, RegexPolicyRepresentation> representationFunction) -
Uses of Policy in org.keycloak.authorization.policy.provider.role
Modifier and TypeMethodDescriptionvoid
RolePolicyProviderFactory.onCreate
(Policy policy, RolePolicyRepresentation representation, AuthorizationProvider authorization) void
RolePolicyProviderFactory.onExport
(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorizationProvider) void
RolePolicyProviderFactory.onImport
(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization) void
RolePolicyProviderFactory.onUpdate
(Policy policy, RolePolicyRepresentation representation, AuthorizationProvider authorization) RolePolicyProviderFactory.toRepresentation
(Policy policy, AuthorizationProvider authorization) ModifierConstructorDescriptionRolePolicyProvider
(BiFunction<Policy, AuthorizationProvider, RolePolicyRepresentation> representationFunction) -
Uses of Policy in org.keycloak.authorization.policy.provider.time
Modifier and TypeMethodDescriptionvoid
TimePolicyProviderFactory.onCreate
(Policy policy, TimePolicyRepresentation representation, AuthorizationProvider authorization) void
TimePolicyProviderFactory.onImport
(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization) void
TimePolicyProviderFactory.onRemove
(Policy policy, AuthorizationProvider authorization) void
TimePolicyProviderFactory.onUpdate
(Policy policy, TimePolicyRepresentation representation, AuthorizationProvider authorization) TimePolicyProviderFactory.toRepresentation
(Policy policy, AuthorizationProvider authorization) -
Uses of Policy in org.keycloak.authorization.policy.provider.user
Modifier and TypeMethodDescriptionvoid
UserPolicyProviderFactory.onCreate
(Policy policy, UserPolicyRepresentation representation, AuthorizationProvider authorization) void
UserPolicyProviderFactory.onExport
(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorizationProvider) void
UserPolicyProviderFactory.onImport
(Policy policy, PolicyRepresentation representation, AuthorizationProvider authorization) void
UserPolicyProviderFactory.onUpdate
(Policy policy, UserPolicyRepresentation representation, AuthorizationProvider authorization) UserPolicyProviderFactory.toRepresentation
(Policy policy, AuthorizationProvider authorization) ModifierConstructorDescriptionUserPolicyProvider
(BiFunction<Policy, AuthorizationProvider, UserPolicyRepresentation> representationFunction) -
Uses of Policy in org.keycloak.authorization.store
Modifier and TypeMethodDescriptionPolicyStore.create
(ResourceServer resourceServer, AbstractPolicyRepresentation representation) Creates a newPolicy
instance.PolicyStore.findById
(RealmModel realm, ResourceServer resourceServer, String id) Returns aPolicy
with the givenid
PolicyStore.findByName
(ResourceServer resourceServer, String name) Returns aPolicy
with the givenname
Modifier and TypeMethodDescriptionPolicyStore.find
(RealmModel realm, ResourceServer resourceServer, Map<Policy.FilterOption, String[]> attributes, Integer firstResult, Integer maxResults) PolicyStore.findByResource
(ResourceServer resourceServer, Resource resource) PolicyStore.findByResourceServer
(ResourceServer resourceServer) Returns a list ofPolicy
associated with theResourceServer
PolicyStore.findByResourceType
(ResourceServer resourceServer, String resourceType) PolicyStore.findByScopes
(ResourceServer resourceServer, List<Scope> scopes) PolicyStore.findByScopes
(ResourceServer resourceServer, Resource resource, List<Scope> scopes) PolicyStore.findByType
(ResourceServer resourceServer, String type) Returns a list ofPolicy
with the giventype
.PolicyStore.findDependentPolicies
(ResourceServer resourceServer, String id) Returns a list ofPolicy
that depends on another policy with the givenid
.Modifier and TypeMethodDescriptionvoid
PolicyStore.findByResource
(ResourceServer resourceServer, Resource resource, Consumer<Policy> consumer) Searches for all policies associated with theResource
and passes the result to theconsumer
void
PolicyStore.findByResourceType
(ResourceServer resourceServer, String type, Consumer<Policy> policyConsumer) Searches for policies associated with aResourceServer
and passes the result to the consumervoid
PolicyStore.findByScopes
(ResourceServer resourceServer, Resource resource, List<Scope> scopes, Consumer<Policy> consumer) Effectively the same method asPolicyStore.findByScopes(ResourceServer, Resource, List)
, however in the end theconsumer
is fed with the result. -
Uses of Policy in org.keycloak.models.cache.infinispan.authorization
Modifier and TypeMethodDescriptionStoreFactoryCacheSession.PolicyCache.create
(ResourceServer resourceServer, AbstractPolicyRepresentation representation) StoreFactoryCacheSession.PolicyCache.findById
(RealmModel realm, ResourceServer resourceServer, String id) StoreFactoryCacheSession.PolicyCache.findByName
(ResourceServer resourceServer, String name) PolicyAdapter.getDelegateForUpdate()
PermissionTicketAdapter.getPolicy()
Modifier and TypeMethodDescriptionStoreFactoryCacheSession.PolicyCache.find
(RealmModel realm, ResourceServer resourceServer, Map<Policy.FilterOption, String[]> attributes, Integer firstResult, Integer maxResults) StoreFactoryCacheSession.PolicyCache.findByResource
(ResourceServer resourceServer, Resource resource) StoreFactoryCacheSession.PolicyCache.findByResourceServer
(ResourceServer resourceServer) StoreFactoryCacheSession.PolicyCache.findByResourceType
(ResourceServer resourceServer, String resourceType) StoreFactoryCacheSession.PolicyCache.findByScopes
(ResourceServer resourceServer, List<Scope> scopes) StoreFactoryCacheSession.PolicyCache.findByScopes
(ResourceServer resourceServer, Resource resource, List<Scope> scopes) StoreFactoryCacheSession.PolicyCache.findByType
(ResourceServer resourceServer, String type) StoreFactoryCacheSession.PolicyCache.findDependentPolicies
(ResourceServer resourceServer, String id) PolicyAdapter.getAssociatedPolicies()
Modifier and TypeMethodDescriptionvoid
PolicyAdapter.addAssociatedPolicy
(Policy associatedPolicy) void
PolicyAdapter.removeAssociatedPolicy
(Policy associatedPolicy) void
Modifier and TypeMethodDescriptionvoid
StoreFactoryCacheSession.PolicyCache.findByResource
(ResourceServer resourceServer, Resource resource, Consumer<Policy> consumer) void
StoreFactoryCacheSession.PolicyCache.findByResourceType
(ResourceServer resourceServer, String resourceType, Consumer<Policy> consumer) void
StoreFactoryCacheSession.PolicyCache.findByScopes
(ResourceServer resourceServer, Resource resource, List<Scope> scopes, Consumer<Policy> consumer) -
Uses of Policy in org.keycloak.models.cache.infinispan.authorization.entities
Modifier and TypeMethodDescriptionCachedPolicy.getAssociatedPoliciesIds
(Supplier<Policy> policy) CachedPolicy.getResourcesIds
(Supplier<Policy> policy) CachedPolicy.getScopesIds
(Supplier<Policy> policy) -
Uses of Policy in org.keycloak.models.utils
Modifier and TypeMethodDescriptionstatic Policy
RepresentationToModel.toModel
(AbstractPolicyRepresentation representation, AuthorizationProvider authorization, Policy model) Modifier and TypeMethodDescriptionstatic Policy
RepresentationToModel.toModel
(AbstractPolicyRepresentation representation, AuthorizationProvider authorization, Policy model) static <R extends AbstractPolicyRepresentation>
RModelToRepresentation.toRepresentation
(Policy policy, AuthorizationProvider authorization) static <R extends AbstractPolicyRepresentation>
RModelToRepresentation.toRepresentation
(Policy policy, AuthorizationProvider authorization, boolean genericRepresentation, boolean export) static <R extends AbstractPolicyRepresentation>
RModelToRepresentation.toRepresentation
(Policy policy, AuthorizationProvider authorization, boolean genericRepresentation, boolean export, boolean allFields) -
Uses of Policy in org.keycloak.services.resources.admin.permissions
Modifier and TypeMethodDescriptionUserPermissionManagement.adminImpersonatingPermission()
ClientPermissionManagement.configurePermission
(ClientModel client) ClientPermissionManagement.exchangeToPermission
(ClientModel client) IdentityProviderPermissionManagement.exchangeToPermission
(IdentityProviderModel idp) UserPermissionManagement.manageGroupMembershipPermission()
GroupPermissionManagement.manageMembershipPermission
(GroupModel group) GroupPermissionManagement.manageMembersPermission
(GroupModel group) ClientPermissionManagement.managePermission
(ClientModel client) GroupPermissionManagement.managePermission
(GroupModel group) UserPermissionManagement.managePermission()
RolePermissionManagement.manageUsersPolicy
(ResourceServer server) RolePermissionManagement.mapClientScopePermission
(RoleModel role) RolePermissionManagement.mapCompositePermission
(RoleModel role) RolePermissionManagement.mapRolePermission
(RoleModel role) ClientPermissionManagement.mapRolesClientScopePermission
(ClientModel client) ClientPermissionManagement.mapRolesCompositePermission
(ClientModel client) ClientPermissionManagement.mapRolesPermission
(ClientModel client) UserPermissionManagement.mapRolesPermission()
RolePermissionManagement.rolePolicy
(ResourceServer server, RoleModel role) UserPermissionManagement.userImpersonatedPermission()
GroupPermissionManagement.viewMembersPermission
(GroupModel group) ClientPermissionManagement.viewPermission
(ClientModel client) GroupPermissionManagement.viewPermission
(GroupModel group) UserPermissionManagement.viewPermission()
RolePermissionManagement.viewUsersPolicy
(ResourceServer server)