Uses of Interface
org.keycloak.authorization.model.Scope
-
Packages that use Scope Package Description org.keycloak.authorization.admin org.keycloak.authorization.jpa.store org.keycloak.authorization.model Provides the domain model and any other type related with itorg.keycloak.authorization.permission org.keycloak.authorization.policy.evaluation Provides classes related with the evaluation of policies.org.keycloak.authorization.store Provides classes and a SPI to plug different metadata storage implementations.org.keycloak.forms.account.freemarker.model org.keycloak.models.cache.infinispan.authorization org.keycloak.models.cache.infinispan.authorization.entities org.keycloak.models.map.authorization org.keycloak.models.map.authorization.adapter org.keycloak.models.map.storage.chm org.keycloak.models.map.storage.jpa.authorization.scope org.keycloak.models.utils -
-
Uses of Scope in org.keycloak.authorization.admin
Method parameters in org.keycloak.authorization.admin with type arguments of type Scope Modifier and Type Method Description protected void
PolicyEvaluationService.EvaluationDecisionCollector. grantPermission(AuthorizationProvider authorizationProvider, Set<Permission> permissions, ResourcePermission permission, Collection<Scope> grantedScopes, ResourceServer resourceServer, AuthorizationRequest request, Result result)
-
Uses of Scope in org.keycloak.authorization.jpa.store
Classes in org.keycloak.authorization.jpa.store that implement Scope Modifier and Type Class Description class
ScopeAdapter
Methods in org.keycloak.authorization.jpa.store that return Scope Modifier and Type Method Description Scope
JPAScopeStore. create(ResourceServer resourceServer, String name)
Scope
JPAScopeStore. create(ResourceServer resourceServer, String id, String name)
Scope
JPAScopeStore. findById(RealmModel realm, ResourceServer resourceServer, String id)
Scope
JPAScopeStore. findByName(ResourceServer resourceServer, String name)
Scope
PermissionTicketAdapter. getScope()
Methods in org.keycloak.authorization.jpa.store that return types with arguments of type Scope Modifier and Type Method Description List<Scope>
JPAScopeStore. findByResourceServer(ResourceServer resourceServer)
List<Scope>
JPAScopeStore. findByResourceServer(ResourceServer resourceServer, Map<Scope.FilterOption,String[]> attributes, Integer firstResult, Integer maxResults)
Set<Scope>
PolicyAdapter. getScopes()
List<Scope>
ResourceAdapter. getScopes()
Methods in org.keycloak.authorization.jpa.store with parameters of type Scope Modifier and Type Method Description void
PolicyAdapter. addScope(Scope scope)
PermissionTicket
JPAPermissionTicketStore. create(ResourceServer resourceServer, Resource resource, Scope scope, String requester)
List<PermissionTicket>
JPAPermissionTicketStore. findByScope(ResourceServer resourceServer, Scope scope)
void
PolicyAdapter. removeScope(Scope scope)
static ScopeEntity
ScopeAdapter. toEntity(javax.persistence.EntityManager em, Scope scope)
Method parameters in org.keycloak.authorization.jpa.store with type arguments of type Scope Modifier and Type Method Description List<Policy>
JPAPolicyStore. findByScopes(ResourceServer resourceServer, List<Scope> scopes)
void
JPAPolicyStore. findByScopes(ResourceServer resourceServer, Resource resource, List<Scope> scopes, Consumer<Policy> consumer)
void
JPAResourceStore. findByScopes(ResourceServer resourceServer, Set<Scope> scopes, Consumer<Resource> consumer)
void
ResourceAdapter. updateScopes(Set<Scope> toUpdate)
-
Uses of Scope in org.keycloak.authorization.model
Fields in org.keycloak.authorization.model with type parameters of type Scope Modifier and Type Field Description static SearchableModelField<Scope>
Scope.SearchableFields. ID
static SearchableModelField<Scope>
Scope.SearchableFields. NAME
static SearchableModelField<Scope>
Scope.SearchableFields. REALM_ID
static SearchableModelField<Scope>
Scope.SearchableFields. RESOURCE_SERVER_ID
Methods in org.keycloak.authorization.model that return Scope Modifier and Type Method Description Scope
PermissionTicket. getScope()
Returns theScope
associated with this instanceMethods in org.keycloak.authorization.model that return types with arguments of type Scope Modifier and Type Method Description Set<Scope>
Policy. getScopes()
Returns theScope
instances where this policy applies.List<Scope>
Resource. getScopes()
SearchableModelField<Scope>
Scope.FilterOption. getSearchableModelField()
Methods in org.keycloak.authorization.model with parameters of type Scope Modifier and Type Method Description void
Policy. addScope(Scope scope)
void
Policy. removeScope(Scope scope)
Method parameters in org.keycloak.authorization.model with type arguments of type Scope Modifier and Type Method Description void
Resource. updateScopes(Set<Scope> scopes)
Update the set of scopes associated with this resource. -
Uses of Scope in org.keycloak.authorization.permission
Methods in org.keycloak.authorization.permission that return types with arguments of type Scope Modifier and Type Method Description Collection<Scope>
ResourcePermission. getScopes()
Returns a list of permitted scopes associated with the resourcestatic Set<Scope>
Permissions. resolveScopes(Resource resource, ResourceServer resourceServer, Collection<Scope> requestedScopes, AuthorizationProvider authorization)
Methods in org.keycloak.authorization.permission with parameters of type Scope Modifier and Type Method Description void
ResourcePermission. addScope(Scope scope)
static ResourcePermission
Permissions. permission(ResourceServer server, Resource resource, Scope scope)
Method parameters in org.keycloak.authorization.permission with type arguments of type Scope Modifier and Type Method Description static ResourcePermission
Permissions. createResourcePermissions(Resource resource, ResourceServer resourceServer, Collection<Scope> requestedScopes, AuthorizationProvider authorization, AuthorizationRequest request)
static Set<Scope>
Permissions. resolveScopes(Resource resource, ResourceServer resourceServer, Collection<Scope> requestedScopes, AuthorizationProvider authorization)
Constructor parameters in org.keycloak.authorization.permission with type arguments of type Scope Constructor Description ResourcePermission(Resource resource, Collection<Scope> scopes, ResourceServer resourceServer)
ResourcePermission(Resource resource, Collection<Scope> scopes, ResourceServer resourceServer, Map<String,? extends Collection<String>> claims)
-
Uses of Scope in org.keycloak.authorization.policy.evaluation
Method parameters in org.keycloak.authorization.policy.evaluation with type arguments of type Scope Modifier and Type Method Description protected void
DecisionPermissionCollector. grantPermission(AuthorizationProvider authorizationProvider, Set<Permission> permissions, ResourcePermission permission, Collection<Scope> grantedScopes, ResourceServer resourceServer, AuthorizationRequest request, Result result)
-
Uses of Scope in org.keycloak.authorization.store
Methods in org.keycloak.authorization.store that return Scope Modifier and Type Method Description default Scope
ScopeStore. create(ResourceServer resourceServer, String name)
Creates a newScope
instance.Scope
ScopeStore. create(ResourceServer resourceServer, String id, String name)
Creates a newScope
instance.Scope
ScopeStore. findById(RealmModel realm, ResourceServer resourceServer, String id)
Returns aScope
with the givenid
Scope
ScopeStore. findByName(ResourceServer resourceServer, String name)
Returns aScope
with the givenname
Methods in org.keycloak.authorization.store that return types with arguments of type Scope Modifier and Type Method Description List<Scope>
ScopeStore. findByResourceServer(ResourceServer resourceServer)
Returns a list ofScope
associated with theResourceServer
.List<Scope>
ScopeStore. findByResourceServer(ResourceServer resourceServer, Map<Scope.FilterOption,String[]> attributes, Integer firstResult, Integer maxResults)
Methods in org.keycloak.authorization.store with parameters of type Scope Modifier and Type Method Description PermissionTicket
PermissionTicketStore. create(ResourceServer resourceServer, Resource resource, Scope scope, String requester)
Creates a newPermissionTicket
instance.List<PermissionTicket>
PermissionTicketStore. findByScope(ResourceServer resourceServer, Scope scope)
Returns a list ofPermissionTicket
associated with thescope
.Method parameters in org.keycloak.authorization.store with type arguments of type Scope Modifier and Type Method Description List<Policy>
PolicyStore. findByScopes(ResourceServer resourceServer, List<Scope> scopes)
default List<Policy>
PolicyStore. findByScopes(ResourceServer resourceServer, Resource resource, List<Scope> scopes)
void
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.default List<Resource>
ResourceStore. findByScopes(ResourceServer resourceServer, Set<Scope> scopes)
Finds allResource
associated with a given scope.void
ResourceStore. findByScopes(ResourceServer resourceServer, Set<Scope> scopes, Consumer<Resource> consumer)
-
Uses of Scope in org.keycloak.forms.account.freemarker.model
Methods in org.keycloak.forms.account.freemarker.model that return Scope Modifier and Type Method Description Scope
AuthorizationBean.PermissionScopeBean. getScope()
-
Uses of Scope in org.keycloak.models.cache.infinispan.authorization
Classes in org.keycloak.models.cache.infinispan.authorization that implement Scope Modifier and Type Class Description class
ScopeAdapter
Fields in org.keycloak.models.cache.infinispan.authorization declared as Scope Modifier and Type Field Description protected Scope
ScopeAdapter. updated
Fields in org.keycloak.models.cache.infinispan.authorization with type parameters of type Scope Modifier and Type Field Description protected Set<Scope>
PolicyAdapter. scopes
protected List<Scope>
ResourceAdapter. scopes
Methods in org.keycloak.models.cache.infinispan.authorization that return Scope Modifier and Type Method Description Scope
StoreFactoryCacheSession.ScopeCache. create(ResourceServer resourceServer, String name)
Scope
StoreFactoryCacheSession.ScopeCache. create(ResourceServer resourceServer, String id, String name)
Scope
StoreFactoryCacheSession.ScopeCache. findById(RealmModel realm, ResourceServer resourceServer, String id)
Scope
StoreFactoryCacheSession.ScopeCache. findByName(ResourceServer resourceServer, String name)
Scope
ScopeAdapter. getDelegateForUpdate()
Scope
PermissionTicketAdapter. getScope()
Methods in org.keycloak.models.cache.infinispan.authorization that return types with arguments of type Scope Modifier and Type Method Description List<Scope>
StoreFactoryCacheSession.ScopeCache. findByResourceServer(ResourceServer resourceServer)
List<Scope>
StoreFactoryCacheSession.ScopeCache. findByResourceServer(ResourceServer resourceServer, Map<Scope.FilterOption,String[]> attributes, Integer firstResult, Integer maxResults)
Set<Scope>
PolicyAdapter. getScopes()
List<Scope>
ResourceAdapter. getScopes()
Methods in org.keycloak.models.cache.infinispan.authorization with parameters of type Scope Modifier and Type Method Description void
PolicyAdapter. addScope(Scope scope)
PermissionTicket
StoreFactoryCacheSession.PermissionTicketCache. create(ResourceServer resourceServer, Resource resource, Scope scope, String requester)
List<PermissionTicket>
StoreFactoryCacheSession.PermissionTicketCache. findByScope(ResourceServer resourceServer, Scope scope)
void
PolicyAdapter. removeScope(Scope scope)
Method parameters in org.keycloak.models.cache.infinispan.authorization with type arguments of type Scope Modifier and Type Method Description List<Policy>
StoreFactoryCacheSession.PolicyCache. findByScopes(ResourceServer resourceServer, List<Scope> scopes)
List<Policy>
StoreFactoryCacheSession.PolicyCache. findByScopes(ResourceServer resourceServer, Resource resource, List<Scope> scopes)
void
StoreFactoryCacheSession.PolicyCache. findByScopes(ResourceServer resourceServer, Resource resource, List<Scope> scopes, Consumer<Policy> consumer)
List<Resource>
StoreFactoryCacheSession.ResourceCache. findByScopes(ResourceServer resourceServer, Set<Scope> scopes)
void
StoreFactoryCacheSession.ResourceCache. findByScopes(ResourceServer resourceServer, Set<Scope> scopes, Consumer<Resource> consumer)
void
ResourceAdapter. updateScopes(Set<Scope> scopes)
-
Uses of Scope in org.keycloak.models.cache.infinispan.authorization.entities
Constructors in org.keycloak.models.cache.infinispan.authorization.entities with parameters of type Scope Constructor Description CachedScope(Long revision, Scope scope)
-
Uses of Scope in org.keycloak.models.map.authorization
Methods in org.keycloak.models.map.authorization that return Scope Modifier and Type Method Description Scope
MapScopeStore. create(ResourceServer resourceServer, String id, String name)
Scope
MapScopeStore. findById(RealmModel realm, ResourceServer resourceServer, String id)
Scope
MapScopeStore. findByName(ResourceServer resourceServer, String name)
Methods in org.keycloak.models.map.authorization that return types with arguments of type Scope Modifier and Type Method Description List<Scope>
MapScopeStore. findByResourceServer(ResourceServer resourceServer)
List<Scope>
MapScopeStore. findByResourceServer(ResourceServer resourceServer, Map<Scope.FilterOption,String[]> attributes, Integer firstResult, Integer maxResults)
Methods in org.keycloak.models.map.authorization with parameters of type Scope Modifier and Type Method Description PermissionTicket
MapPermissionTicketStore. create(ResourceServer resourceServer, Resource resource, Scope scope, String requester)
List<PermissionTicket>
MapPermissionTicketStore. findByScope(ResourceServer resourceServer, Scope scope)
Method parameters in org.keycloak.models.map.authorization with type arguments of type Scope Modifier and Type Method Description List<Policy>
MapPolicyStore. findByScopes(ResourceServer resourceServer, List<Scope> scopes)
void
MapPolicyStore. findByScopes(ResourceServer resourceServer, Resource resource, List<Scope> scopes, Consumer<Policy> consumer)
void
MapResourceStore. findByScopes(ResourceServer resourceServer, Set<Scope> scopes, Consumer<Resource> consumer)
Constructor parameters in org.keycloak.models.map.authorization with type arguments of type Scope Constructor Description MapScopeStore(KeycloakSession session, MapStorage<MapScopeEntity,Scope> scopeStore, AuthorizationProvider provider)
-
Uses of Scope in org.keycloak.models.map.authorization.adapter
Classes in org.keycloak.models.map.authorization.adapter that implement Scope Modifier and Type Class Description class
AbstractScopeModel<E extends AbstractEntity>
class
MapScopeAdapter
Methods in org.keycloak.models.map.authorization.adapter that return Scope Modifier and Type Method Description Scope
MapPermissionTicketAdapter. getScope()
Methods in org.keycloak.models.map.authorization.adapter that return types with arguments of type Scope Modifier and Type Method Description Set<Scope>
MapPolicyAdapter. getScopes()
List<Scope>
MapResourceAdapter. getScopes()
Methods in org.keycloak.models.map.authorization.adapter with parameters of type Scope Modifier and Type Method Description void
MapPolicyAdapter. addScope(Scope scope)
void
MapPolicyAdapter. removeScope(Scope scope)
Method parameters in org.keycloak.models.map.authorization.adapter with type arguments of type Scope Modifier and Type Method Description void
MapResourceAdapter. updateScopes(Set<Scope> scopes)
-
Uses of Scope in org.keycloak.models.map.storage.chm
Fields in org.keycloak.models.map.storage.chm with type parameters of type Scope Modifier and Type Field Description static Map<SearchableModelField<Scope>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapScopeEntity,Scope>>
MapFieldPredicates. AUTHZ_SCOPE_PREDICATES
static Map<SearchableModelField<Scope>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapScopeEntity,Scope>>
MapFieldPredicates. AUTHZ_SCOPE_PREDICATES
-
Uses of Scope in org.keycloak.models.map.storage.jpa.authorization.scope
Method parameters in org.keycloak.models.map.storage.jpa.authorization.scope with type arguments of type Scope Modifier and Type Method Description JpaScopeModelCriteriaBuilder
JpaScopeModelCriteriaBuilder. compare(SearchableModelField<? super Scope> modelField, ModelCriteriaBuilder.Operator op, Object... value)
-
Uses of Scope in org.keycloak.models.utils
Methods in org.keycloak.models.utils that return Scope Modifier and Type Method Description static Scope
RepresentationToModel. toModel(ScopeRepresentation scope, ResourceServer resourceServer, AuthorizationProvider authorization)
static Scope
RepresentationToModel. toModel(ScopeRepresentation scope, ResourceServer resourceServer, AuthorizationProvider authorization, boolean updateIfExists)
Methods in org.keycloak.models.utils with parameters of type Scope Modifier and Type Method Description static ScopeRepresentation
ModelToRepresentation. toRepresentation(Scope model)
-