Uses of Interface
org.keycloak.models.ClientScopeModel

Packages that use ClientScopeModel

Package	Description
org.keycloak.migration
org.keycloak.models
org.keycloak.models.cache.infinispan
org.keycloak.models.cache.infinispan.entities
org.keycloak.models.delegate
org.keycloak.models.jpa
org.keycloak.models.utils
org.keycloak.protocol.oidc
org.keycloak.protocol.oidc.rar.model
org.keycloak.rar
org.keycloak.services.clienttype.client
org.keycloak.services.migration
org.keycloak.services.resources.admin
org.keycloak.services.resources.admin.permissions
org.keycloak.services.util
org.keycloak.storage
org.keycloak.storage.client
org.keycloak.storage.clientscope
org.keycloak.storage.federated
org.keycloak.storage.jpa

Uses of ClientScopeModel in org.keycloak.migration

Methods in org.keycloak.migration that return ClientScopeModel

Modifier and Type	Method	Description
ClientScopeModel	MigrationProvider.addOIDCBasicClientScope(RealmModel realm)	Add 'basic' client scope or return it if already exists
ClientScopeModel	MigrationProvider.addOIDCMicroprofileJWTClientScope(RealmModel realm)	Adds the microprofile-jwt optional client scope to the realm and returns the created scope.
ClientScopeModel	MigrationProvider.addOIDCRolesClientScope(RealmModel realm)	Add 'roles' client scope or return it if already exists
ClientScopeModel	MigrationProvider.addOIDCWebOriginsClientScope(RealmModel realm)	Add 'web-origins' client scope or return it if already exists

Uses of ClientScopeModel in org.keycloak.models

Subinterfaces of ClientScopeModel in org.keycloak.models

Modifier and Type	Interface	Description
interface	ClientModel

Methods in org.keycloak.models that return ClientScopeModel

Modifier and Type	Method	Description
default ClientScopeModel	ClientScopeProvider.addClientScope(RealmModel realm, String name)	Creates new client scope with given name to the given realm.
ClientScopeModel	ClientScopeProvider.addClientScope(RealmModel realm, String id, String name)	Creates new client scope with given internal ID and name to the given realm.
ClientScopeModel	RealmModel.addClientScope(String name)	Creates new client scope with the given name.
ClientScopeModel	RealmModel.addClientScope(String id, String name)	Creates new client scope with the given internal ID and name.
ClientScopeModel	ClientScopeModel.ClientScopeRemovedEvent.getClientScope()
ClientScopeModel	RealmModel.getClientScopeById(String id)
default ClientScopeModel	ClientModel.getDynamicClientScope(String scope)	Returns a ClientScopeModel associated with this client.

Methods in org.keycloak.models that return types with arguments of type ClientScopeModel

Modifier and Type	Method	Description
Map<String,ClientScopeModel>	ClientModel.getClientScopes(boolean defaultScope)	Return all default scopes (if 'defaultScope' is true) or all optional scopes (if 'defaultScope' is false) linked with this client
Stream<ClientScopeModel>	ClientScopeProvider.getClientScopesStream(RealmModel realm)	Returns all the client scopes of the given realm as a stream.
Stream<ClientScopeModel>	ClientSessionContext.getClientScopesStream()	Returns client scopes as a stream.
Stream<ClientScopeModel>	RealmModel.getClientScopesStream()	Returns all client scopes of this realm as a stream.
Stream<ClientScopeModel>	RealmModel.getDefaultClientScopesStream(boolean defaultScope)	Returns default client scopes of this realm either default ones or optional ones.
Set<ClientScopeModel>	UserConsentModel.getGrantedClientScopes()

Methods in org.keycloak.models with parameters of type ClientScopeModel

Modifier and Type	Method	Description
void	ClientModel.addClientScope(ClientScopeModel clientScope, boolean defaultScope)	Add clientScope with this client.
void	ClientProvider.addClientScopeToAllClients(RealmModel realm, ClientScopeModel clientScope, boolean defaultClientScope)	Add specified client scope to all non bearer-only clients in the realm, which have same protocol as specified client scope.
void	RealmModel.addDefaultClientScope(ClientScopeModel clientScope, boolean defaultScope)	Adds given client scope among default/optional client scopes of this realm.
void	UserConsentModel.addGrantedClientScope(ClientScopeModel clientScope)
boolean	UserConsentModel.isClientScopeGranted(ClientScopeModel clientScope)
void	UserProvider.preRemove(ClientScopeModel clientScope)	Called when a client scope is removed.
void	ClientModel.removeClientScope(ClientScopeModel clientScope)
void	ClientProvider.removeClientScope(RealmModel realm, ClientModel client, ClientScopeModel clientScope)	Unassign clientScope from the client.
void	RealmModel.removeDefaultClientScope(ClientScopeModel clientScope)	Removes given client scope from default or optional client scopes of this realm.

Method parameters in org.keycloak.models with type arguments of type ClientScopeModel

Modifier and Type	Method	Description
void	ClientModel.addClientScopes(Set<ClientScopeModel> clientScopes, boolean defaultScope)	Add clientScopes with this client.
void	ClientProvider.addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope)	Assign clientScopes to the client.

Uses of ClientScopeModel in org.keycloak.models.cache.infinispan

Classes in org.keycloak.models.cache.infinispan that implement ClientScopeModel

Modifier and Type	Class	Description
class	ClientAdapter
class	ClientScopeAdapter

Fields in org.keycloak.models.cache.infinispan declared as ClientScopeModel

Modifier and Type	Field	Description
protected ClientScopeModel	ClientScopeAdapter.updated

Methods in org.keycloak.models.cache.infinispan that return ClientScopeModel

Modifier and Type	Method	Description
ClientScopeModel	RealmAdapter.addClientScope(String name)
ClientScopeModel	RealmAdapter.addClientScope(String id, String name)
ClientScopeModel	RealmCacheSession.addClientScope(RealmModel realm, String name)
ClientScopeModel	RealmCacheSession.addClientScope(RealmModel realm, String id, String name)
ClientScopeModel	RealmAdapter.getClientScopeById(String id)
ClientScopeModel	RealmCacheSession.getClientScopeById(RealmModel realm, String id)

Methods in org.keycloak.models.cache.infinispan that return types with arguments of type ClientScopeModel

Modifier and Type	Method	Description
Map<String,ClientScopeModel>	ClientAdapter.getClientScopes(boolean defaultScope)
Map<String,ClientScopeModel>	RealmCacheSession.getClientScopes(RealmModel realm, ClientModel client, boolean defaultScopes)
Stream<ClientScopeModel>	RealmAdapter.getClientScopesStream()
Stream<ClientScopeModel>	RealmCacheSession.getClientScopesStream(RealmModel realm)
Stream<ClientScopeModel>	RealmAdapter.getDefaultClientScopesStream(boolean defaultScope)

Methods in org.keycloak.models.cache.infinispan with parameters of type ClientScopeModel

Modifier and Type	Method	Description
void	ClientAdapter.addClientScope(ClientScopeModel clientScope, boolean defaultScope)
void	RealmCacheSession.addClientScopeToAllClients(RealmModel realm, ClientScopeModel clientScope, boolean defaultClientScope)
void	RealmAdapter.addDefaultClientScope(ClientScopeModel clientScope, boolean defaultScope)
void	UserCacheSession.preRemove(ClientScopeModel clientScope)
void	ClientAdapter.removeClientScope(ClientScopeModel clientScope)
void	RealmCacheSession.removeClientScope(RealmModel realm, ClientModel client, ClientScopeModel clientScope)
void	RealmAdapter.removeDefaultClientScope(ClientScopeModel clientScope)

Method parameters in org.keycloak.models.cache.infinispan with type arguments of type ClientScopeModel

Modifier and Type	Method	Description
void	ClientAdapter.addClientScopes(Set<ClientScopeModel> clientScopes, boolean defaultScope)
void	RealmCacheSession.addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope)

Uses of ClientScopeModel in org.keycloak.models.cache.infinispan.entities

Constructors in org.keycloak.models.cache.infinispan.entities with parameters of type ClientScopeModel

Modifier	Constructor	Description
	CachedClientScope(Long revision, RealmModel realm, ClientScopeModel model)

Uses of ClientScopeModel in org.keycloak.models.delegate

Classes in org.keycloak.models.delegate that implement ClientScopeModel

Modifier and Type	Class	Description
class	ClientModelLazyDelegate
static class	ClientModelLazyDelegate.WithId

Methods in org.keycloak.models.delegate that return ClientScopeModel

Modifier and Type	Method	Description
ClientScopeModel	ClientModelLazyDelegate.getDynamicClientScope(String scope)

Methods in org.keycloak.models.delegate that return types with arguments of type ClientScopeModel

Modifier and Type	Method	Description
Map<String,ClientScopeModel>	ClientModelLazyDelegate.getClientScopes(boolean defaultScope)

Methods in org.keycloak.models.delegate with parameters of type ClientScopeModel

Modifier and Type	Method	Description
void	ClientModelLazyDelegate.addClientScope(ClientScopeModel clientScope, boolean defaultScope)
void	ClientModelLazyDelegate.removeClientScope(ClientScopeModel clientScope)

Method parameters in org.keycloak.models.delegate with type arguments of type ClientScopeModel

Modifier and Type	Method	Description
void	ClientModelLazyDelegate.addClientScopes(Set<ClientScopeModel> clientScopes, boolean defaultScope)

Uses of ClientScopeModel in org.keycloak.models.jpa

Classes in org.keycloak.models.jpa that implement ClientScopeModel

Modifier and Type	Class	Description
class	ClientAdapter
class	ClientScopeAdapter

Methods in org.keycloak.models.jpa that return ClientScopeModel

Modifier and Type	Method	Description
ClientScopeModel	JpaRealmProvider.addClientScope(RealmModel realm, String id, String name)
ClientScopeModel	RealmAdapter.addClientScope(String name)
ClientScopeModel	RealmAdapter.addClientScope(String id, String name)
ClientScopeModel	JpaRealmProvider.getClientScopeById(RealmModel realm, String id)
ClientScopeModel	RealmAdapter.getClientScopeById(String id)

Methods in org.keycloak.models.jpa that return types with arguments of type ClientScopeModel

Modifier and Type	Method	Description
Map<String,ClientScopeModel>	ClientAdapter.getClientScopes(boolean defaultScope)
Map<String,ClientScopeModel>	JpaRealmProvider.getClientScopes(RealmModel realm, ClientModel client, boolean defaultScope)
Stream<ClientScopeModel>	JpaRealmProvider.getClientScopesStream(RealmModel realm)
Stream<ClientScopeModel>	RealmAdapter.getClientScopesStream()
Stream<ClientScopeModel>	RealmAdapter.getDefaultClientScopesStream(boolean defaultScope)

Methods in org.keycloak.models.jpa with parameters of type ClientScopeModel

Modifier and Type	Method	Description
void	ClientAdapter.addClientScope(ClientScopeModel clientScope, boolean defaultScope)
void	JpaRealmProvider.addClientScopeToAllClients(RealmModel realm, ClientScopeModel clientScope, boolean defaultClientScope)
void	RealmAdapter.addDefaultClientScope(ClientScopeModel clientScope, boolean defaultScope)
void	JpaUserProvider.preRemove(ClientScopeModel clientScope)
void	ClientAdapter.removeClientScope(ClientScopeModel clientScope)
void	JpaRealmProvider.removeClientScope(RealmModel realm, ClientModel client, ClientScopeModel clientScope)
void	RealmAdapter.removeDefaultClientScope(ClientScopeModel clientScope)
static ClientScopeEntity	ClientScopeAdapter.toClientScopeEntity(ClientScopeModel model, jakarta.persistence.EntityManager em)

Method parameters in org.keycloak.models.jpa with type arguments of type ClientScopeModel

Modifier and Type	Method	Description
void	ClientAdapter.addClientScopes(Set<ClientScopeModel> clientScopes, boolean defaultScope)
void	JpaRealmProvider.addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope)

Uses of ClientScopeModel in org.keycloak.models.utils

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

Modifier and Type	Method	Description
ClientScopeModel	RealmModelDelegate.addClientScope(String name)
ClientScopeModel	RealmModelDelegate.addClientScope(String id, String name)
static ClientScopeModel	RepresentationToModel.createClientScope(KeycloakSession session, RealmModel realm, ClientScopeRepresentation resourceRep)
static ClientScopeModel	KeycloakModelUtils.findClientScopeById(RealmModel realm, ClientModel client, String clientScopeId)	Lookup clientScope OR client by id.
ClientScopeModel	RealmModelDelegate.getClientScopeById(String id)
static ClientScopeModel	KeycloakModelUtils.getClientScopeByName(RealmModel realm, String clientScopeName)

Methods in org.keycloak.models.utils that return types with arguments of type ClientScopeModel

Modifier and Type	Method	Description
Stream<ClientScopeModel>	RealmModelDelegate.getClientScopesStream()
Stream<ClientScopeModel>	RealmModelDelegate.getDefaultClientScopesStream(boolean defaultScope)

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

Modifier and Type	Method	Description
void	RealmModelDelegate.addDefaultClientScope(ClientScopeModel clientScope, boolean defaultScope)
void	RealmModelDelegate.removeDefaultClientScope(ClientScopeModel clientScope)
static ClientScopeRepresentation	ModelToRepresentation.toRepresentation(ClientScopeModel clientScopeModel)
static void	RepresentationToModel.updateClientScope(ClientScopeRepresentation rep, ClientScopeModel resource)

Uses of ClientScopeModel in org.keycloak.protocol.oidc

Classes in org.keycloak.protocol.oidc that implement ClientScopeModel

Modifier and Type	Class	Description
class	OIDCClientSecretConfigWrapper.ReadOnlyRotatedSecretClientModel	Representation of a client model that passes information from a rotated secret.

Methods in org.keycloak.protocol.oidc that return ClientScopeModel

Modifier and Type	Method	Description
ClientScopeModel	OIDCLoginProtocolFactory.addBasicClientScope(RealmModel newRealm)
ClientScopeModel	OIDCLoginProtocolFactory.addMicroprofileJWTClientScope(RealmModel newRealm)	Adds the microprofile-jwt optional client scope to the specified realm.
ClientScopeModel	OIDCLoginProtocolFactory.addRolesClientScope(RealmModel newRealm)
ClientScopeModel	OIDCLoginProtocolFactory.addWebOriginsClientScope(RealmModel newRealm)

Methods in org.keycloak.protocol.oidc that return types with arguments of type ClientScopeModel

Modifier and Type	Method	Description
static Stream<ClientScopeModel>	TokenManager.getRequestedClientScopes(String scopeParam, ClientModel client)	Return client itself + all default client scopes of client + optional client scopes requested by scope parameter

Method parameters in org.keycloak.protocol.oidc with type arguments of type ClientScopeModel

Modifier and Type	Method	Description
static Set<RoleModel>	TokenManager.getAccess(UserModel user, ClientModel client, Stream<ClientScopeModel> clientScopes)
static boolean	TokenManager.verifyConsentStillAvailable(KeycloakSession session, UserModel user, ClientModel client, Stream<ClientScopeModel> requestedClientScopes)

Uses of ClientScopeModel in org.keycloak.protocol.oidc.rar.model

Methods in org.keycloak.protocol.oidc.rar.model that return ClientScopeModel

Modifier and Type	Method	Description
ClientScopeModel	IntermediaryScopeRepresentation.getScope()

Constructors in org.keycloak.protocol.oidc.rar.model with parameters of type ClientScopeModel

Modifier	Constructor	Description
	IntermediaryScopeRepresentation(ClientScopeModel scope)
	IntermediaryScopeRepresentation(ClientScopeModel scope, String parameter, String requestedScopeString)

Uses of ClientScopeModel in org.keycloak.rar

Methods in org.keycloak.rar that return ClientScopeModel

Modifier and Type	Method	Description
ClientScopeModel	AuthorizationDetails.getClientScope()

Methods in org.keycloak.rar with parameters of type ClientScopeModel

Modifier and Type	Method	Description
void	AuthorizationDetails.setClientScope(ClientScopeModel clientScope)

Constructors in org.keycloak.rar with parameters of type ClientScopeModel

Modifier	Constructor	Description
	AuthorizationDetails(ClientScopeModel clientScope)
	AuthorizationDetails(ClientScopeModel clientScope, AuthorizationRequestSource source, AuthorizationDetailsJSONRepresentation authorizationDetails)

Uses of ClientScopeModel in org.keycloak.services.clienttype.client

Classes in org.keycloak.services.clienttype.client that implement ClientScopeModel

Modifier and Type	Class	Description
class	TypeAwareClientModelDelegate	Delegates to client-type and underlying delegate

Uses of ClientScopeModel in org.keycloak.services.migration

Methods in org.keycloak.services.migration that return ClientScopeModel

Modifier and Type	Method	Description
ClientScopeModel	DefaultMigrationProvider.addOIDCBasicClientScope(RealmModel realm)
ClientScopeModel	DefaultMigrationProvider.addOIDCMicroprofileJWTClientScope(RealmModel realm)
ClientScopeModel	DefaultMigrationProvider.addOIDCRolesClientScope(RealmModel realm)
ClientScopeModel	DefaultMigrationProvider.addOIDCWebOriginsClientScope(RealmModel realm)

Uses of ClientScopeModel in org.keycloak.services.resources.admin

Fields in org.keycloak.services.resources.admin declared as ClientScopeModel

Modifier and Type	Field	Description
protected ClientScopeModel	ClientScopeResource.clientScope

Constructors in org.keycloak.services.resources.admin with parameters of type ClientScopeModel

Modifier	Constructor	Description
	ClientScopeResource(RealmModel realm, AdminPermissionEvaluator auth, ClientScopeModel clientScope, KeycloakSession session, AdminEventBuilder adminEvent)

Uses of ClientScopeModel in org.keycloak.services.resources.admin.permissions

Methods in org.keycloak.services.resources.admin.permissions with parameters of type ClientScopeModel

Modifier and Type	Method	Description
boolean	ClientPermissionEvaluator.canManage(ClientScopeModel clientScope)
boolean	ClientPermissionEvaluator.canView(ClientScopeModel clientScope)
void	ClientPermissionEvaluator.requireManage(ClientScopeModel clientScope)
void	ClientPermissionEvaluator.requireView(ClientScopeModel clientScope)

Uses of ClientScopeModel in org.keycloak.services.util

Methods in org.keycloak.services.util that return types with arguments of type ClientScopeModel

Modifier and Type	Method	Description
Stream<ClientScopeModel>	DefaultClientSessionContext.getClientScopesStream()
static Stream<ClientScopeModel>	AuthorizationContextUtil.getClientScopesStreamFromAuthorizationRequestContextWithClient(KeycloakSession session, String scope)	Helper method to return a Stream of all the ClientScopeModel in the current AuthorizationRequestContext

Uses of ClientScopeModel in org.keycloak.storage

Methods in org.keycloak.storage that return ClientScopeModel

Modifier and Type	Method	Description
ClientScopeModel	ClientScopeStorageManager.addClientScope(RealmModel realm, String id, String name)
ClientScopeModel	ClientScopeStorageManager.getClientScopeById(RealmModel realm, String id)

Methods in org.keycloak.storage that return types with arguments of type ClientScopeModel

Modifier and Type	Method	Description
Map<String,ClientScopeModel>	ClientStorageManager.getClientScopes(RealmModel realm, ClientModel client, boolean defaultScopes)
Stream<ClientScopeModel>	ClientScopeStorageManager.getClientScopesStream(RealmModel realm)

Methods in org.keycloak.storage with parameters of type ClientScopeModel

Modifier and Type	Method	Description
void	ClientStorageManager.addClientScopeToAllClients(RealmModel realm, ClientScopeModel clientScope, boolean defaultClientScope)
void	UserStorageManager.preRemove(ClientScopeModel clientScope)
void	ClientStorageManager.removeClientScope(RealmModel realm, ClientModel client, ClientScopeModel clientScope)

Method parameters in org.keycloak.storage with type arguments of type ClientScopeModel

Modifier and Type	Method	Description
void	ClientStorageManager.addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope)

Uses of ClientScopeModel in org.keycloak.storage.client

Classes in org.keycloak.storage.client that implement ClientScopeModel

Modifier and Type	Class	Description
class	AbstractClientStorageAdapter	Helper base class for ClientModel implementations for ClientStorageProvider implementations.
class	AbstractReadOnlyClientScopeAdapter
class	AbstractReadOnlyClientStorageAdapter
class	UnsupportedOperationsClientStorageAdapter	Base helper class.

Methods in org.keycloak.storage.client that return types with arguments of type ClientScopeModel

Modifier and Type	Method	Description
Map<String,ClientScopeModel>	ClientLookupProvider.getClientScopes(RealmModel realm, ClientModel client, boolean defaultScopes)	Return all default scopes (if defaultScope is true) or all optional scopes (if defaultScope is false) linked with the client

Methods in org.keycloak.storage.client with parameters of type ClientScopeModel

Modifier and Type	Method	Description
void	AbstractReadOnlyClientStorageAdapter.addClientScope(ClientScopeModel clientScope, boolean defaultScope)
void	AbstractReadOnlyClientStorageAdapter.removeClientScope(ClientScopeModel clientScope)

Method parameters in org.keycloak.storage.client with type arguments of type ClientScopeModel

Modifier and Type	Method	Description
void	AbstractReadOnlyClientStorageAdapter.addClientScopes(Set<ClientScopeModel> clientScopes, boolean defaultScope)

Uses of ClientScopeModel in org.keycloak.storage.clientscope

Methods in org.keycloak.storage.clientscope that return ClientScopeModel

Modifier and Type	Method	Description
ClientScopeModel	ClientScopeLookupProvider.getClientScopeById(RealmModel realm, String id)	Exact search for a client scope by its internal ID..

Uses of ClientScopeModel in org.keycloak.storage.federated

Methods in org.keycloak.storage.federated with parameters of type ClientScopeModel

Modifier and Type	Method	Description
void	UserFederatedStorageProvider.preRemove(ClientScopeModel clientScope)

Uses of ClientScopeModel in org.keycloak.storage.jpa

Methods in org.keycloak.storage.jpa with parameters of type ClientScopeModel

Modifier and Type	Method	Description
void	JpaUserFederatedStorageProvider.preRemove(ClientScopeModel clientScope)