## 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 it
  org.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 |
  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 and 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 and Description
    --- | ---
    `class` | `ScopeAdapter`

    Methods in org.keycloak.authorization.jpa.store that return Scope
    Modifier and Type | Method and Description
    --- | ---
    `Scope` | JPAScopeStore.`create(String name, ResourceServer resourceServer)`
    `Scope` | JPAScopeStore.`create(String id, String name, ResourceServer resourceServer)`
    `Scope` | JPAScopeStore.`findById(String id, String resourceServerId)`
    `Scope` | JPAScopeStore.`findByName(String name, String resourceServerId)`
    `Scope` | PermissionTicketAdapter.`getScope()`

    Methods in org.keycloak.authorization.jpa.store that return types with arguments of type Scope
    Modifier and Type | Method and Description
    --- | ---
    `List<Scope>` | JPAScopeStore.`findByResourceServer(Map<Scope.FilterOption,String[]> attributes, String resourceServerId, int firstResult, int maxResult)`
    `List<Scope>` | JPAScopeStore.`findByResourceServer(String serverId)`
    `List<Scope>` | ResourceAdapter.`getScopes()`
    `Set<Scope>` | PolicyAdapter.`getScopes()`

    Methods in org.keycloak.authorization.jpa.store with parameters of type Scope
    Modifier and Type | Method and Description
    --- | ---
    `void` | PolicyAdapter.`addScope(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 and Description
    --- | ---
    `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 and Description
    --- | ---
    `static SearchableModelField<Scope>` | Scope.SearchableFields.`ID`
    `static SearchableModelField<Scope>` | Scope.SearchableFields.`NAME`
    `static SearchableModelField<Scope>` | Scope.SearchableFields.`RESOURCE_SERVER_ID`

    Methods in org.keycloak.authorization.model that return Scope
    Modifier and Type | Method and Description
    --- | ---
    `Scope` | PermissionTicket.`getScope()` Returns the `Scope` associated with this instance

    Methods in org.keycloak.authorization.model that return types with arguments of type Scope
    Modifier and Type | Method and Description
    --- | ---
    `List<Scope>` | Resource.`getScopes()` Returns a `List` containing all the `Scope` associated with this resource.
    `Set<Scope>` | Policy.`getScopes()` Returns the `Scope` instances where this policy applies.
    `SearchableModelField<Scope>` | Scope.FilterOption.`getSearchableModelField()`

    Methods in org.keycloak.authorization.model with parameters of type Scope
    Modifier and Type | Method and 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 and 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 and Description
    --- | ---
    `Collection<Scope>` | ResourcePermission.`getScopes()` Returns a list of permitted scopes associated with the resource
    `static 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 and 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 and 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 and 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 and 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 and Description
    --- | ---
    `default Scope` | ScopeStore.`create(String name, ResourceServer resourceServer)` Creates a new `Scope` instance.
    `Scope` | ScopeStore.`create(String id, String name, ResourceServer resourceServer)` Creates a new `Scope` instance.
    `Scope` | ScopeStore.`findById(String id, String resourceServerId)` Returns a `Scope` with the given `id`
    `Scope` | ScopeStore.`findByName(String name, String resourceServerId)` Returns a `Scope` with the given `name`

    Methods in org.keycloak.authorization.store that return types with arguments of type Scope
    Modifier and Type | Method and Description
    --- | ---
    `List<Scope>` | ScopeStore.`findByResourceServer(Map<Scope.FilterOption,String[]> attributes, String resourceServerId, int firstResult, int maxResult)` Returns a list of `Scope` associated with a `ResourceServer` with the given `resourceServerId`.
    `List<Scope>` | ScopeStore.`findByResourceServer(String id)` Returns a list of `Scope` associated with a `ResourceServer` with the given `resourceServerId`.

  - ### 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 and Description
    --- | ---
    `Scope` | AuthorizationBean.PermissionScopeBean.`getScope()`

  - ### Uses of Scope in org.keycloak.models.cache.infinispan.authorization

    Fields in org.keycloak.models.cache.infinispan.authorization declared as Scope
    Modifier and Type | Field and Description
    --- | ---
    `protected Scope` | ScopeAdapter.`updated`

    Fields in org.keycloak.models.cache.infinispan.authorization with type parameters of type Scope
    Modifier and Type | Field and Description
    --- | ---
    `protected List<Scope>` | ResourceAdapter.`scopes`
    `protected Set<Scope>` | PolicyAdapter.`scopes`

    Methods in org.keycloak.models.cache.infinispan.authorization that return Scope
    Modifier and Type | Method and Description
    --- | ---
    `Scope` | StoreFactoryCacheSession.ScopeCache.`create(String name, ResourceServer resourceServer)`
    `Scope` | StoreFactoryCacheSession.ScopeCache.`create(String id, String name, ResourceServer resourceServer)`
    `Scope` | StoreFactoryCacheSession.ScopeCache.`findById(String id, String resourceServerId)`
    `Scope` | StoreFactoryCacheSession.ScopeCache.`findByName(String name, String resourceServerId)`
    `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 and Description
    --- | ---
    `List<Scope>` | StoreFactoryCacheSession.ScopeCache.`findByResourceServer(Map<Scope.FilterOption,String[]> attributes, String resourceServerId, int firstResult, int maxResult)`
    `List<Scope>` | StoreFactoryCacheSession.ScopeCache.`findByResourceServer(String id)`
    `List<Scope>` | ResourceAdapter.`getScopes()`
    `Set<Scope>` | PolicyAdapter.`getScopes()`

    Methods in org.keycloak.models.cache.infinispan.authorization with parameters of type Scope
    Modifier and Type | Method and Description
    --- | ---
    `void` | PolicyAdapter.`addScope(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 and Description
    --- | ---
    `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 and 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 and Description
    --- | ---
    `Scope` | MapScopeStore.`create(String id, String name, ResourceServer resourceServer)`
    `Scope` | MapScopeStore.`findById(String id, String resourceServerId)`
    `Scope` | MapScopeStore.`findByName(String name, String resourceServerId)`

    Methods in org.keycloak.models.map.authorization that return types with arguments of type Scope
    Modifier and Type | Method and Description
    --- | ---
    `List<Scope>` | MapScopeStore.`findByResourceServer(Map<Scope.FilterOption,String[]> attributes, String resourceServerId, int firstResult, int maxResult)`
    `List<Scope>` | MapScopeStore.`findByResourceServer(String id)`

    Constructor parameters in org.keycloak.models.map.authorization with type arguments of type Scope
    Constructor and Description
    `MapScopeStore(KeycloakSession session, MapStorage<K,MapScopeEntity<K>,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 and Description
    --- | ---
    `class` | `AbstractScopeModel<E extends AbstractEntity>`
    `class` | `MapScopeAdapter<K>`

    Methods in org.keycloak.models.map.authorization.adapter that return Scope
    Modifier and Type | Method and Description
    --- | ---
    `Scope` | MapPermissionTicketAdapter.`getScope()`

    Methods in org.keycloak.models.map.authorization.adapter that return types with arguments of type Scope
    Modifier and Type | Method and Description
    --- | ---
    `List<Scope>` | MapResourceAdapter.`getScopes()`
    `Set<Scope>` | MapPolicyAdapter.`getScopes()`

    Methods in org.keycloak.models.map.authorization.adapter with parameters of type Scope
    Modifier and Type | Method and 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 and Description
    --- | ---
    `void` | MapResourceAdapter.`updateScopes(Set<Scope> scopes)`

  - ### Uses of Scope in org.keycloak.models.map.storage

    Fields in org.keycloak.models.map.storage with type parameters of type Scope
    Modifier and Type | Field and Description
    --- | ---
    `static Map<SearchableModelField<Scope>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapScopeEntity<Object>,Scope>>` | MapFieldPredicates.`AUTHZ_SCOPE_PREDICATES`
    `static Map<SearchableModelField<Scope>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapScopeEntity<Object>,Scope>>` | MapFieldPredicates.`AUTHZ_SCOPE_PREDICATES`

  - ### Uses of Scope in org.keycloak.models.utils

    Methods in org.keycloak.models.utils that return Scope
    Modifier and Type | Method and 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 and Description
    --- | ---
    `static ScopeRepresentation` | ModelToRepresentation.`toRepresentation(Scope model)`

Copyright © 2021 JBoss by Red Hat. All rights reserved.