Uses of Interface
org.keycloak.models.ClientScopeModel
Package
Description
-
Uses of ClientScopeModel in org.keycloak.migration
Modifier and TypeMethodDescriptionMigrationProvider.addOIDCAcrClientScope
(RealmModel realm) Add 'acr' client scope or return it if already existsMigrationProvider.addOIDCBasicClientScope
(RealmModel realm) Add 'basic' client scope or return it if already existsMigrationProvider.addOIDCMicroprofileJWTClientScope
(RealmModel realm) Adds themicroprofile-jwt
optional client scope to the realm and returns the created scope.MigrationProvider.addOIDCRolesClientScope
(RealmModel realm) Add 'roles' client scope or return it if already existsMigrationProvider.addOIDCWebOriginsClientScope
(RealmModel realm) Add 'web-origins' client scope or return it if already exists -
Uses of ClientScopeModel in org.keycloak.models
Modifier and TypeMethodDescriptiondefault ClientScopeModel
ClientScopeProvider.addClientScope
(RealmModel realm, String name) Creates new client scope with givenname
to the given realm.ClientScopeProvider.addClientScope
(RealmModel realm, String id, String name) Creates new client scope with given internal ID andname
to the given realm.RealmModel.addClientScope
(String name) Creates new client scope with the given name.RealmModel.addClientScope
(String id, String name) Creates new client scope with the given internal ID and name.ClientScopeModel.ClientScopeCreatedEvent.getClientScope()
ClientScopeModel.ClientScopeRemovedEvent.getClientScope()
RealmModel.getClientScopeById
(String id) default ClientScopeModel
ClientModel.getDynamicClientScope
(String scope) Returns aClientScopeModel
associated with this client.Modifier and TypeMethodDescriptionClientModel.getClientScopes
(boolean defaultScope) Return all default scopes (if 'defaultScope' is true) or all optional scopes (if 'defaultScope' is false) linked with this clientClientScopeProvider.getClientScopesStream
(RealmModel realm) Returns all the client scopes of the given realm as a stream.ClientSessionContext.getClientScopesStream()
Returns client scopes as a stream.RealmModel.getClientScopesStream()
Returns all client scopes of this realm as a stream.RealmModel.getDefaultClientScopesStream
(boolean defaultScope) Returns default client scopes of this realm either default ones or optional ones.UserConsentModel.getGrantedClientScopes()
Modifier and TypeMethodDescriptionvoid
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.Modifier and TypeMethodDescriptionvoid
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
Modifier and TypeMethodDescriptionRealmAdapter.addClientScope
(String name) RealmAdapter.addClientScope
(String id, String name) RealmCacheSession.addClientScope
(RealmModel realm, String name) RealmCacheSession.addClientScope
(RealmModel realm, String id, String name) RealmAdapter.getClientScopeById
(String id) RealmCacheSession.getClientScopeById
(RealmModel realm, String id) Modifier and TypeMethodDescriptionClientAdapter.getClientScopes
(boolean defaultScope) RealmCacheSession.getClientScopes
(RealmModel realm, ClientModel client, boolean defaultScopes) RealmAdapter.getClientScopesStream()
RealmCacheSession.getClientScopesStream
(RealmModel realm) RealmAdapter.getDefaultClientScopesStream
(boolean defaultScope) Modifier and TypeMethodDescriptionvoid
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) Modifier and TypeMethodDescriptionvoid
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
ModifierConstructorDescriptionCachedClientScope
(Long revision, RealmModel realm, ClientScopeModel model) -
Uses of ClientScopeModel in org.keycloak.models.delegate
Modifier and TypeClassDescriptionclass
static class
Modifier and TypeMethodDescriptionvoid
ClientModelLazyDelegate.addClientScope
(ClientScopeModel clientScope, boolean defaultScope) void
ClientModelLazyDelegate.removeClientScope
(ClientScopeModel clientScope) Modifier and TypeMethodDescriptionvoid
ClientModelLazyDelegate.addClientScopes
(Set<ClientScopeModel> clientScopes, boolean defaultScope) -
Uses of ClientScopeModel in org.keycloak.models.jpa
Modifier and TypeMethodDescriptionJpaRealmProvider.addClientScope
(RealmModel realm, String id, String name) RealmAdapter.addClientScope
(String name) RealmAdapter.addClientScope
(String id, String name) JpaRealmProvider.getClientScopeById
(RealmModel realm, String id) RealmAdapter.getClientScopeById
(String id) Modifier and TypeMethodDescriptionClientAdapter.getClientScopes
(boolean defaultScope) JpaRealmProvider.getClientScopes
(RealmModel realm, ClientModel client, boolean defaultScope) JpaRealmProvider.getClientScopesStream
(RealmModel realm) RealmAdapter.getClientScopesStream()
RealmAdapter.getDefaultClientScopesStream
(boolean defaultScope) Modifier and TypeMethodDescriptionvoid
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) Modifier and TypeMethodDescriptionvoid
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
Modifier and TypeMethodDescriptionRealmModelDelegate.addClientScope
(String name) 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.RealmModelDelegate.getClientScopeById
(String id) static ClientScopeModel
KeycloakModelUtils.getClientScopeByName
(RealmModel realm, String clientScopeName) Modifier and TypeMethodDescriptionRealmModelDelegate.getClientScopesStream()
RealmModelDelegate.getDefaultClientScopesStream
(boolean defaultScope) Modifier and TypeMethodDescriptionvoid
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.organization.protocol.mappers.oidc
Modifier and TypeMethodDescriptionOrganizationScope.toClientScope
(String name, UserModel user, KeycloakSession session) Returns aClientScopeModel
with the givenname
for this scope. -
Uses of ClientScopeModel in org.keycloak.protocol.oidc
Modifier and TypeClassDescriptionclass
Representation of a client model that passes information from a rotated secret.Modifier and TypeMethodDescriptionOIDCLoginProtocolFactory.addAcrClientScope
(RealmModel newRealm) OIDCLoginProtocolFactory.addBasicClientScope
(RealmModel newRealm) OIDCLoginProtocolFactory.addMicroprofileJWTClientScope
(RealmModel newRealm) Adds themicroprofile-jwt
optional client scope to the specified realm.OIDCLoginProtocolFactory.addRolesClientScope
(RealmModel newRealm) OIDCLoginProtocolFactory.addWebOriginsClientScope
(RealmModel newRealm) Modifier and TypeMethodDescriptionstatic Stream<ClientScopeModel>
TokenManager.getRequestedClientScopes
(KeycloakSession session, String scopeParam, ClientModel client, UserModel user) Return client itself + all default client scopes of client + optional client scopes requested by scope parameterModifier and TypeMethodDescriptionTokenManager.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
ModifierConstructorDescriptionIntermediaryScopeRepresentation
(ClientScopeModel scope, String parameter, String requestedScopeString) -
Uses of ClientScopeModel in org.keycloak.rar
Modifier and TypeMethodDescriptionvoid
AuthorizationDetails.setClientScope
(ClientScopeModel clientScope) ModifierConstructorDescriptionAuthorizationDetails
(ClientScopeModel clientScope) AuthorizationDetails
(ClientScopeModel clientScope, AuthorizationRequestSource source, AuthorizationDetailsJSONRepresentation authorizationDetails) -
Uses of ClientScopeModel in org.keycloak.services.clienttype.client
Modifier and TypeClassDescriptionclass
Delegates to client-type and underlying delegate -
Uses of ClientScopeModel in org.keycloak.services.migration
Modifier and TypeMethodDescriptionDefaultMigrationProvider.addOIDCAcrClientScope
(RealmModel realm) DefaultMigrationProvider.addOIDCBasicClientScope
(RealmModel realm) DefaultMigrationProvider.addOIDCMicroprofileJWTClientScope
(RealmModel realm) DefaultMigrationProvider.addOIDCRolesClientScope
(RealmModel realm) DefaultMigrationProvider.addOIDCWebOriginsClientScope
(RealmModel realm) -
Uses of ClientScopeModel in org.keycloak.services.resources.admin
ModifierConstructorDescriptionClientScopeResource
(RealmModel realm, AdminPermissionEvaluator auth, ClientScopeModel clientScope, KeycloakSession session, AdminEventBuilder adminEvent) -
Uses of ClientScopeModel in org.keycloak.services.resources.admin.permissions
Modifier and TypeMethodDescriptionboolean
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
Modifier and TypeMethodDescriptionDefaultClientSessionContext.getClientScopesStream()
static Stream<ClientScopeModel>
AuthorizationContextUtil.getClientScopesStreamFromAuthorizationRequestContextWithClient
(KeycloakSession session, String scope) Helper method to return a Stream of all theClientScopeModel
in the currentAuthorizationRequestContext
Modifier and TypeMethodDescriptionstatic DefaultClientSessionContext
DefaultClientSessionContext.fromClientSessionAndClientScopes
(AuthenticatedClientSessionModel clientSession, Set<ClientScopeModel> requestedScopes, KeycloakSession session) -
Uses of ClientScopeModel in org.keycloak.storage
Modifier and TypeMethodDescriptionClientScopeStorageManager.addClientScope
(RealmModel realm, String id, String name) ClientScopeStorageManager.getClientScopeById
(RealmModel realm, String id) Modifier and TypeMethodDescriptionClientStorageManager.getClientScopes
(RealmModel realm, ClientModel client, boolean defaultScopes) ClientScopeStorageManager.getClientScopesStream
(RealmModel realm) Modifier and TypeMethodDescriptionvoid
ClientStorageManager.addClientScopeToAllClients
(RealmModel realm, ClientScopeModel clientScope, boolean defaultClientScope) void
UserStorageManager.preRemove
(ClientScopeModel clientScope) void
ClientStorageManager.removeClientScope
(RealmModel realm, ClientModel client, ClientScopeModel clientScope) Modifier and TypeMethodDescriptionvoid
ClientStorageManager.addClientScopes
(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope) -
Uses of ClientScopeModel in org.keycloak.storage.client
Modifier and TypeClassDescriptionclass
Helper base class for ClientModel implementations for ClientStorageProvider implementations.class
class
class
Base helper class.Modifier and TypeMethodDescriptionClientLookupProvider.getClientScopes
(RealmModel realm, ClientModel client, boolean defaultScopes) Return all default scopes (ifdefaultScope
istrue
) or all optional scopes (ifdefaultScope
isfalse
) linked with the clientModifier and TypeMethodDescriptionvoid
AbstractReadOnlyClientStorageAdapter.addClientScope
(ClientScopeModel clientScope, boolean defaultScope) void
AbstractReadOnlyClientStorageAdapter.removeClientScope
(ClientScopeModel clientScope) Modifier and TypeMethodDescriptionvoid
AbstractReadOnlyClientStorageAdapter.addClientScopes
(Set<ClientScopeModel> clientScopes, boolean defaultScope) -
Uses of ClientScopeModel in org.keycloak.storage.clientscope
Modifier and TypeMethodDescriptionClientScopeLookupProvider.getClientScopeById
(RealmModel realm, String id) Exact search for a client scope by its internal ID.. -
Uses of ClientScopeModel in org.keycloak.storage.federated
Modifier and TypeMethodDescriptionvoid
UserFederatedStorageProvider.preRemove
(ClientScopeModel clientScope) -
Uses of ClientScopeModel in org.keycloak.storage.jpa
Modifier and TypeMethodDescriptionvoid
JpaUserFederatedStorageProvider.preRemove
(ClientScopeModel clientScope)