Uses of Interface
org.keycloak.models.ClientModel
Packages that use ClientModel
Package
Description
Provides classes and a SPI to plug different metadata storage implementations.
-
Uses of ClientModel in org.keycloak.authentication
Fields in org.keycloak.authentication declared as ClientModelMethods in org.keycloak.authentication that return ClientModelModifier and TypeMethodDescriptionAuthenticationProcessor.getClient()
AuthenticationProcessor.Result.getClient()
ClientAuthenticationFlowContext.getClient()
Current client attached to this flow.Methods in org.keycloak.authentication with parameters of type ClientModelModifier and TypeMethodDescriptionClientAuthenticatorFactory.getAdapterConfiguration
(ClientModel client) Get configuration, which needs to be used for adapter ( keycloak.json ) of particular client.void
AuthenticationProcessor.Result.setClient
(ClientModel client) void
AuthenticationProcessor.setClient
(ClientModel client) void
ClientAuthenticationFlowContext.setClient
(ClientModel client) Attach a specific client to this flow. -
Uses of ClientModel in org.keycloak.authentication.authenticators.client
Methods in org.keycloak.authentication.authenticators.client that return ClientModelMethods in org.keycloak.authentication.authenticators.client with parameters of type ClientModelModifier and TypeMethodDescriptionClientIdAndSecretAuthenticator.getAdapterConfiguration
(ClientModel client) JWTClientAuthenticator.getAdapterConfiguration
(ClientModel client) JWTClientSecretAuthenticator.getAdapterConfiguration
(ClientModel client) X509ClientAuthenticator.getAdapterConfiguration
(ClientModel client) protected PublicKey
JWTClientAuthenticator.getSignatureValidationKey
(ClientModel client, ClientAuthenticationFlowContext context, JWSInput jws) -
Uses of ClientModel in org.keycloak.authorization.admin
Constructors in org.keycloak.authorization.admin with parameters of type ClientModelModifierConstructorDescriptionAuthorizationService
(KeycloakSession session, ClientModel client, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) ResourceServerService
(AuthorizationProvider authorization, ResourceServer resourceServer, ClientModel client, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent) -
Uses of ClientModel in org.keycloak.authorization.common
Fields in org.keycloak.authorization.common declared as ClientModelConstructors in org.keycloak.authorization.common with parameters of type ClientModel -
Uses of ClientModel in org.keycloak.authorization.jpa.store
Methods in org.keycloak.authorization.jpa.store with parameters of type ClientModelModifier and TypeMethodDescriptionJPAResourceServerStore.create
(ClientModel client) void
JPAResourceServerStore.delete
(ClientModel client) JPAResourceServerStore.findByClient
(ClientModel client) -
Uses of ClientModel in org.keycloak.authorization.store
Methods in org.keycloak.authorization.store with parameters of type ClientModelModifier and TypeMethodDescriptionResourceServerStore.create
(ClientModel client) Creates aResourceServer
instance backed by this persistent storage implementation.void
ResourceServerStore.delete
(ClientModel client) Removes aResourceServer
instance, with the given client from the persistent storage.ResourceServerStore.findByClient
(ClientModel client) Returns aResourceServer
instance based on a client. -
Uses of ClientModel in org.keycloak.broker.oidc
Methods in org.keycloak.broker.oidc with parameters of type ClientModelModifier and TypeMethodDescriptionjakarta.ws.rs.core.Response
AbstractOAuth2IdentityProvider.exchangeFromToken
(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject, jakarta.ws.rs.core.MultivaluedMap<String, String> params) protected jakarta.ws.rs.core.Response
AbstractOAuth2IdentityProvider.exchangeSessionToken
(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) protected jakarta.ws.rs.core.Response
OIDCIdentityProvider.exchangeSessionToken
(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) protected jakarta.ws.rs.core.Response
AbstractOAuth2IdentityProvider.exchangeStoredToken
(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) protected jakarta.ws.rs.core.Response
OIDCIdentityProvider.exchangeStoredToken
(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) -
Uses of ClientModel in org.keycloak.broker.provider
Methods in org.keycloak.broker.provider with parameters of type ClientModelModifier and TypeMethodDescriptionprotected jakarta.ws.rs.core.Response
AbstractIdentityProvider.exchangeErrorResponse
(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, String errorCode, String reason) jakarta.ws.rs.core.Response
ExchangeTokenToIdentityProviderToken.exchangeFromToken
(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject, jakarta.ws.rs.core.MultivaluedMap<String, String> params) jakarta.ws.rs.core.Response
AbstractIdentityProvider.exchangeNotLinked
(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) jakarta.ws.rs.core.Response
AbstractIdentityProvider.exchangeNotLinkedNoStore
(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) jakarta.ws.rs.core.Response
AbstractIdentityProvider.exchangeTokenExpired
(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) protected String
AbstractIdentityProvider.getLinkingUrl
(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession) -
Uses of ClientModel in org.keycloak.crypto
Methods in org.keycloak.crypto with parameters of type ClientModelModifier and TypeMethodDescriptionAsymmetricClientSignatureVerifierProvider.verifier
(ClientModel client, JWSInput input) ClientSignatureVerifierProvider.verifier
(ClientModel client, JWSInput input) ECDSAClientSignatureVerifierProvider.verifier
(ClientModel client, JWSInput input) MacSecretClientSignatureVerifierProvider.verifier
(ClientModel client, JWSInput input) Constructors in org.keycloak.crypto with parameters of type ClientModelModifierConstructorDescriptionClientAsymmetricSignatureVerifierContext
(KeycloakSession session, ClientModel client, JWSInput input) ClientECDSASignatureVerifierContext
(KeycloakSession session, ClientModel client, JWSInput input) ClientMacSignatureVerifierContext
(KeycloakSession session, ClientModel client, String algorithm) -
Uses of ClientModel in org.keycloak.events
Methods in org.keycloak.events with parameters of type ClientModel -
Uses of ClientModel in org.keycloak.exportimport.util
Methods in org.keycloak.exportimport.util with parameters of type ClientModelModifier and TypeMethodDescriptionstatic ClientRepresentation
ExportUtils.exportClient
(KeycloakSession session, ClientModel client) Full export of application including claims and secret -
Uses of ClientModel in org.keycloak.forms.login.freemarker
Fields in org.keycloak.forms.login.freemarker declared as ClientModel -
Uses of ClientModel in org.keycloak.forms.login.freemarker.model
Fields in org.keycloak.forms.login.freemarker.model declared as ClientModelConstructors in org.keycloak.forms.login.freemarker.model with parameters of type ClientModelModifierConstructorDescriptionClientBean
(KeycloakSession session, ClientModel client) OAuthGrantBean
(String code, ClientModel client, List<AuthorizationDetails> clientScopesRequested) -
Uses of ClientModel in org.keycloak.jose.jws
Methods in org.keycloak.jose.jws with parameters of type ClientModelModifier and TypeMethodDescription<T> T
DefaultTokenManager.decodeClientJWT
(String jwt, ClientModel client, BiConsumer<JOSE, ClientModel> jwtValidator, Class<T> clazz) DefaultTokenManager.initLogoutToken
(ClientModel client, UserModel user, AuthenticatedClientSessionModel clientSession) Method parameters in org.keycloak.jose.jws with type arguments of type ClientModelModifier and TypeMethodDescription<T> T
DefaultTokenManager.decodeClientJWT
(String jwt, ClientModel client, BiConsumer<JOSE, ClientModel> jwtValidator, Class<T> clazz) -
Uses of ClientModel in org.keycloak.keys.loader
Methods in org.keycloak.keys.loader with parameters of type ClientModelModifier and TypeMethodDescriptionstatic PublicKey
PublicKeyStorageManager.getClientPublicKey
(KeycloakSession session, ClientModel client, JWSInput input) static KeyWrapper
PublicKeyStorageManager.getClientPublicKeyWrapper
(KeycloakSession session, ClientModel client, JWK.Use keyUse, String algAlgorithm) static KeyWrapper
PublicKeyStorageManager.getClientPublicKeyWrapper
(KeycloakSession session, ClientModel client, JWSInput input) Constructors in org.keycloak.keys.loader with parameters of type ClientModelModifierConstructorDescriptionClientPublicKeyLoader
(KeycloakSession session, ClientModel client) ClientPublicKeyLoader
(KeycloakSession session, ClientModel client, JWK.Use keyUse) -
Uses of ClientModel in org.keycloak.migration.migrators
Methods in org.keycloak.migration.migrators with parameters of type ClientModelModifier and TypeMethodDescriptionvoid
MigrateTo3_2_0.addRoles
(ClientModel realmAccess) static boolean
MigrationUtils.isOIDCNonBearerOnlyClient
(ClientModel c) static void
MigrationUtils.migrateOldOfflineToken
(KeycloakSession session, RealmModel realm, ClientModel client, UserModel user) static void
MigrationUtils.setDefaultClientAuthenticatorType
(ClientModel s) -
Uses of ClientModel in org.keycloak.models
Fields in org.keycloak.models declared as ClientModelFields in org.keycloak.models with type parameters of type ClientModelModifier and TypeFieldDescriptionstatic final BiConsumer<JOSE,
ClientModel> TokenManager.DEFAULT_VALIDATOR
Methods in org.keycloak.models that return ClientModelModifier and TypeMethodDescriptiondefault ClientModel
ClientProvider.addClient
(RealmModel realm, String clientId) Adds a client with givenclientId
to the given realm.ClientProvider.addClient
(RealmModel realm, String id, String clientId) Adds a client with given internal ID andclientId
to the given realm.ClientModel.ClientProtocolUpdatedEvent.getClient()
ClientModel.ClientRemovedEvent.getClient()
KeycloakContext.getClient()
UserConsentModel.getClient()
RealmModel.getClientByClientId
(String clientId) RealmModel.getClientById
(String id) ClientModel.ClientCreationEvent.getCreatedClient()
RealmModel.getMasterAdminClient()
ClientModel.ClientIdChangeEvent.getUpdatedClient()
ClientModel.ClientUpdatedEvent.getUpdatedClient()
Methods in org.keycloak.models that return types with arguments of type ClientModelModifier and TypeMethodDescriptionClientProvider.getAllRedirectUrisOfEnabledClients
(RealmModel realm) Deprecated.Do not use, this is only to support a deprecated logout endpoint and will vanish with it's removalClientProvider.getAlwaysDisplayInConsoleClientsStream
(RealmModel realm) Returns a stream of clients that are expected to always show up in account console.RealmModel.getAlwaysDisplayInConsoleClientsStream()
Returns clients which are always displayed in the admin console as a stream.default Stream<ClientModel>
ClientProvider.getClientsStream
(RealmModel realm) Returns all the clients of the given realm as a stream.ClientProvider.getClientsStream
(RealmModel realm, Integer firstResult, Integer maxResults) Returns the clients of the given realm as a stream.RealmModel.getClientsStream()
Returns clients as a stream.RealmModel.getClientsStream
(Integer firstResult, Integer maxResults) Returns clients as a stream.RealmModel.searchClientByAttributes
(Map<String, String> attributes, Integer firstResult, Integer maxResults) RealmModel.searchClientByAuthenticationFlowBindingOverrides
(Map<String, String> overrides, Integer firstResult, Integer maxResults) RealmModel.searchClientByClientIdStream
(String clientId, Integer firstResult, Integer maxResults) Search for clients by provided client's id.Methods in org.keycloak.models with parameters of type ClientModelModifier and TypeMethodDescriptiondefault RoleModel
RoleProvider.addClientRole
(ClientModel client, String name) Adds a client role with givenname
to the given client.RoleProvider.addClientRole
(ClientModel client, String id, String name) Adds a client role with given internal ID andname
to the given client.void
ClientProvider.addClientScopes
(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope) Assign clientScopes to the client.static OAuth2DeviceCodeModel
OAuth2DeviceCodeModel.create
(RealmModel realm, ClientModel client, String deviceCode, String scope, String nonce, int expiresIn, int pollingInterval, String clientNotificationToken, String authReqId, Map<String, String> additionalParams, String codeChallenge, String codeChallengeMethod) UserSessionProvider.createClientSession
(RealmModel realm, ClientModel client, UserSessionModel userSession) default <T> T
TokenManager.decodeClientJWT
(String token, ClientModel client, Class<T> clazz) <T> T
TokenManager.decodeClientJWT
(String token, ClientModel client, BiConsumer<JOSE, ClientModel> jwtValidator, Class<T> clazz) long
UserSessionProvider.getActiveUserSessions
(RealmModel realm, ClientModel client) CibaConfig.getBackchannelAuthRequestSigningAlg
(ClientModel client) CibaConfig.getBackchannelClientNotificationEndpoint
(ClientModel client) CibaConfig.getBackchannelTokenDeliveryMode
(ClientModel client) RoleMapperModel.getClientRoleMappingsStream
(ClientModel app) Returns stream of client roles that are directly set to this object for the given client.RoleProvider.getClientRolesStream
(ClientModel client) Returns all the client roles of the given client.RoleProvider.getClientRolesStream
(ClientModel client, Integer first, Integer max) Returns the client roles of the given client.UserSessionProvider.getClientSession
(UserSessionModel userSession, ClientModel client, String clientSessionId, boolean offline) default AuthenticatedClientSessionModel
UserSessionProvider.getClientSession
(UserSessionModel userSession, ClientModel client, UUID clientSessionId, boolean offline) Deprecated.int
OAuth2DeviceConfig.getLifespan
(ClientModel client) long
UserSessionProvider.getOfflineSessionsCount
(RealmModel realm, ClientModel client) UserSessionProvider.getOfflineUserSessionsStream
(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults) Obtains the offline user sessions associated with the specified client, starting from thefirstResult
and containing at mostmaxResults
.int
OAuth2DeviceConfig.getPoolingInterval
(ClientModel client) UserProvider.getServiceAccount
(ClientModel client) Return a UserModel representing service account of the clientUserSessionProvider.getUserSessionsStream
(RealmModel realm, ClientModel client) Obtains the online user sessions associated with the specified client.UserSessionProvider.getUserSessionsStream
(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults) Obtains the online user sessions associated with the specified client, starting from thefirstResult
and containing at mostmaxResults
.TokenManager.initLogoutToken
(ClientModel client, UserModel user, AuthenticatedClientSessionModel clientSessionModel) boolean
OAuth2DeviceConfig.isOAuth2DeviceAuthorizationGrantEnabled
(ClientModel client) boolean
CibaConfig.isOIDCCIBAGrantEnabled
(ClientModel client) boolean
ParConfig.isRequirePushedAuthorizationRequests
(ClientModel client) void
UserSessionProvider.onClientRemoved
(RealmModel realm, ClientModel client) void
UserProvider.preRemove
(RealmModel realm, ClientModel client) Called when a client is removed.void
ClientProvider.removeClientScope
(RealmModel realm, ClientModel client, ClientScopeModel clientScope) Unassign clientScope from the client.void
RoleProvider.removeRoles
(ClientModel client) Removes all roles from the given client.void
KeycloakContext.setClient
(ClientModel client) void
RealmModel.setMasterAdminClient
(ClientModel client) Method parameters in org.keycloak.models with type arguments of type ClientModelModifier and TypeMethodDescription<T> T
TokenManager.decodeClientJWT
(String token, ClientModel client, BiConsumer<JOSE, ClientModel> jwtValidator, Class<T> clazz) Constructors in org.keycloak.models with parameters of type ClientModelModifierConstructorDescriptionClientConfigResolver
(ClientModel client) UserConsentModel
(ClientModel client) -
Uses of ClientModel in org.keycloak.models.cache.infinispan
Classes in org.keycloak.models.cache.infinispan that implement ClientModelFields in org.keycloak.models.cache.infinispan declared as ClientModelFields in org.keycloak.models.cache.infinispan with type parameters of type ClientModelModifier and TypeFieldDescriptionprotected Map<String,
ClientModel> RealmCacheSession.managedApplications
Methods in org.keycloak.models.cache.infinispan that return ClientModelModifier and TypeMethodDescriptionRealmCacheSession.addClient
(RealmModel realm, String clientId) RealmCacheSession.addClient
(RealmModel realm, String id, String clientId) protected ClientModel
RealmCacheSession.cacheClient
(RealmModel realm, ClientModel delegate, Long revision) RealmAdapter.getClientByClientId
(String clientId) RealmCacheSession.getClientByClientId
(RealmModel realm, String clientId) RealmAdapter.getClientById
(String id) RealmCacheSession.getClientById
(RealmModel realm, String id) RealmAdapter.getMasterAdminClient()
protected ClientModel
RealmCacheSession.validateCache
(RealmModel realm, CachedClient cached) Methods in org.keycloak.models.cache.infinispan that return types with arguments of type ClientModelModifier and TypeMethodDescriptionRealmCacheSession.getAllRedirectUrisOfEnabledClients
(RealmModel realm) RealmAdapter.getAlwaysDisplayInConsoleClientsStream()
RealmCacheSession.getAlwaysDisplayInConsoleClientsStream
(RealmModel realm) RealmAdapter.getClientsStream()
RealmAdapter.getClientsStream
(Integer firstResult, Integer maxResults) RealmCacheSession.getClientsStream
(RealmModel realm) RealmCacheSession.getClientsStream
(RealmModel realm, Integer firstResult, Integer maxResults) RealmAdapter.searchClientByAttributes
(Map<String, String> attributes, Integer firstResult, Integer maxResults) RealmAdapter.searchClientByAuthenticationFlowBindingOverrides
(Map<String, String> overrides, Integer firstResult, Integer maxResults) RealmAdapter.searchClientByClientIdStream
(String clientId, Integer firstResult, Integer maxResults) RealmCacheSession.searchClientsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) RealmCacheSession.searchClientsByAuthenticationFlowBindingOverrides
(RealmModel realm, Map<String, String> overrides, Integer firstResult, Integer maxResults) RealmCacheSession.searchClientsByClientIdStream
(RealmModel realm, String clientId, Integer firstResult, Integer maxResults) Methods in org.keycloak.models.cache.infinispan with parameters of type ClientModelModifier and TypeMethodDescriptionRealmCacheSession.addClientRole
(ClientModel client, String name) RealmCacheSession.addClientRole
(ClientModel client, String id, String name) void
RealmCacheSession.addClientScopes
(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope) protected ClientModel
RealmCacheSession.cacheClient
(RealmModel realm, ClientModel delegate, Long revision) UserCacheSession.findServiceAccount
(ClientModel client) RealmCacheSession.getClientRole
(ClientModel client, String name) GroupAdapter.getClientRoleMappingsStream
(ClientModel app) UserAdapter.getClientRoleMappingsStream
(ClientModel app) RealmCacheSession.getClientRolesStream
(ClientModel client) RealmCacheSession.getClientRolesStream
(ClientModel client, Integer first, Integer max) RealmCacheSession.getClientScopes
(RealmModel realm, ClientModel client, boolean defaultScopes) UserCacheSession.getServiceAccount
(ClientModel client) void
UserCacheSession.preRemove
(RealmModel realm, ClientModel client) void
RealmCacheSession.removeClientScope
(RealmModel realm, ClientModel client, ClientScopeModel clientScope) void
RealmCacheSession.removeRoles
(ClientModel client) RealmCacheSession.searchForClientRolesStream
(ClientModel client, String search, Integer first, Integer max) void
RealmAdapter.setMasterAdminClient
(ClientModel client) -
Uses of ClientModel in org.keycloak.models.cache.infinispan.authorization
Methods in org.keycloak.models.cache.infinispan.authorization with parameters of type ClientModelModifier and TypeMethodDescriptionStoreFactoryCacheSession.ResourceServerCache.create
(ClientModel client) void
StoreFactoryCacheSession.ResourceServerCache.delete
(ClientModel client) StoreFactoryCacheSession.ResourceServerCache.findByClient
(ClientModel client) -
Uses of ClientModel in org.keycloak.models.cache.infinispan.entities
Constructors in org.keycloak.models.cache.infinispan.entities with parameters of type ClientModel -
Uses of ClientModel in org.keycloak.models.cache.infinispan.events
Methods in org.keycloak.models.cache.infinispan.events with parameters of type ClientModelModifier and TypeMethodDescriptionstatic ClientRemovedEvent
ClientRemovedEvent.create
(ClientModel client) -
Uses of ClientModel in org.keycloak.models.delegate
Classes in org.keycloak.models.delegate that implement ClientModelModifier and TypeClassDescriptionclass
static class
Constructor parameters in org.keycloak.models.delegate with type arguments of type ClientModelModifierConstructorDescriptionClientModelLazyDelegate
(Supplier<ClientModel> delegateSupplier) WithId
(String id, Supplier<ClientModel> delegateSupplier) -
Uses of ClientModel in org.keycloak.models.jpa
Classes in org.keycloak.models.jpa that implement ClientModelMethods in org.keycloak.models.jpa that return ClientModelModifier and TypeMethodDescriptionJpaRealmProvider.addClient
(RealmModel realm, String clientId) JpaRealmProvider.addClient
(RealmModel realm, String id, String clientId) JpaRealmProvider.getClientByClientId
(RealmModel realm, String clientId) RealmAdapter.getClientByClientId
(String clientId) JpaRealmProvider.getClientById
(RealmModel realm, String id) RealmAdapter.getClientById
(String id) RealmAdapter.getMasterAdminClient()
Methods in org.keycloak.models.jpa that return types with arguments of type ClientModelModifier and TypeMethodDescriptionJpaRealmProvider.getAllRedirectUrisOfEnabledClients
(RealmModel realm) JpaRealmProvider.getAlwaysDisplayInConsoleClientsStream
(RealmModel realm) RealmAdapter.getAlwaysDisplayInConsoleClientsStream()
JpaRealmProvider.getClientsStream
(RealmModel realm) JpaRealmProvider.getClientsStream
(RealmModel realm, Integer firstResult, Integer maxResults) RealmAdapter.getClientsStream()
RealmAdapter.getClientsStream
(Integer firstResult, Integer maxResults) RealmAdapter.searchClientByAttributes
(Map<String, String> attributes, Integer firstResult, Integer maxResults) RealmAdapter.searchClientByAuthenticationFlowBindingOverrides
(Map<String, String> overrides, Integer firstResult, Integer maxResults) RealmAdapter.searchClientByClientIdStream
(String clientId, Integer firstResult, Integer maxResults) JpaRealmProvider.searchClientsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) JpaRealmProvider.searchClientsByAuthenticationFlowBindingOverrides
(RealmModel realm, Map<String, String> overrides, Integer firstResult, Integer maxResults) JpaRealmProvider.searchClientsByClientIdStream
(RealmModel realm, String clientId, Integer firstResult, Integer maxResults) Methods in org.keycloak.models.jpa with parameters of type ClientModelModifier and TypeMethodDescriptionJpaRealmProvider.addClientRole
(ClientModel client, String name) JpaRealmProvider.addClientRole
(ClientModel client, String id, String name) void
JpaRealmProvider.addClientScopes
(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope) JpaRealmProvider.getClientRole
(ClientModel client, String name) GroupAdapter.getClientRoleMappingsStream
(ClientModel app) UserAdapter.getClientRoleMappingsStream
(ClientModel app) JpaRealmProvider.getClientRolesStream
(ClientModel client, Integer first, Integer max) JpaRealmProvider.getClientScopes
(RealmModel realm, ClientModel client, boolean defaultScope) JpaUserProvider.getServiceAccount
(ClientModel client) void
JpaUserProvider.preRemove
(RealmModel realm, ClientModel client) void
JpaRealmProvider.removeClientScope
(RealmModel realm, ClientModel client, ClientScopeModel clientScope) void
JpaRealmProvider.removeRoles
(ClientModel client) JpaRealmProvider.searchForClientRolesStream
(ClientModel client, String search, Integer first, Integer max) void
RealmAdapter.setMasterAdminClient
(ClientModel client) -
Uses of ClientModel in org.keycloak.models.jpa.session
Methods in org.keycloak.models.jpa.session with parameters of type ClientModelModifier and TypeMethodDescriptionint
JpaUserSessionPersisterProvider.getUserSessionsCount
(RealmModel realm, ClientModel clientModel, boolean offline) JpaUserSessionPersisterProvider.loadClientSession
(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline) JpaUserSessionPersisterProvider.loadUserSessionsStream
(RealmModel realm, ClientModel client, boolean offline, Integer firstResult, Integer maxResults) void
JpaUserSessionPersisterProvider.onClientRemoved
(RealmModel realm, ClientModel client) -
Uses of ClientModel in org.keycloak.models.session
Methods in org.keycloak.models.session that return ClientModelMethods in org.keycloak.models.session with parameters of type ClientModelModifier and TypeMethodDescriptionint
DisabledUserSessionPersisterProvider.getUserSessionsCount
(RealmModel realm, ClientModel clientModel, boolean offline) int
UserSessionPersisterProvider.getUserSessionsCount
(RealmModel realm, ClientModel clientModel, boolean offline) Retrieves the count of user client-sessions for the given clientDisabledUserSessionPersisterProvider.loadClientSession
(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline) UserSessionPersisterProvider.loadClientSession
(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline) Loads client session from the db by provided user session and client.DisabledUserSessionPersisterProvider.loadUserSessionsStream
(RealmModel realm, ClientModel client, boolean offline, Integer firstResult, Integer maxResults) UserSessionPersisterProvider.loadUserSessionsStream
(RealmModel realm, ClientModel client, boolean offline, Integer firstResult, Integer maxResults) Loads the user sessions for the givenClientModel
in the givenRealmModel
if present.void
DisabledUserSessionPersisterProvider.onClientRemoved
(RealmModel realm, ClientModel client) void
UserSessionPersisterProvider.onClientRemoved
(RealmModel realm, ClientModel client) Constructors in org.keycloak.models.session with parameters of type ClientModelModifierConstructorDescriptionPersistentAuthenticatedClientSessionAdapter
(KeycloakSession session, PersistentClientSessionModel model, RealmModel realm, ClientModel client, UserSessionModel userSession) -
Uses of ClientModel in org.keycloak.models.sessions.infinispan
Methods in org.keycloak.models.sessions.infinispan that return ClientModelModifier and TypeMethodDescriptionAuthenticatedClientSessionAdapter.getClient()
AuthenticationSessionAdapter.getClient()
Methods in org.keycloak.models.sessions.infinispan with parameters of type ClientModelModifier and TypeMethodDescriptionSessionFunction.apply
(RealmModel realm, ClientModel client, V entity) RootAuthenticationSessionAdapter.createAuthenticationSession
(ClientModel client) InfinispanUserSessionProvider.createClientSession
(RealmModel realm, ClientModel client, UserSessionModel userSession) long
InfinispanUserSessionProvider.getActiveUserSessions
(RealmModel realm, ClientModel client) RootAuthenticationSessionAdapter.getAuthenticationSession
(ClientModel client, String tabId) InfinispanUserSessionProvider.getClientSession
(UserSessionModel userSession, ClientModel client, String clientSessionId, boolean offline) long
InfinispanUserSessionProvider.getOfflineSessionsCount
(RealmModel realm, ClientModel client) InfinispanUserSessionProvider.getOfflineUserSessionsStream
(RealmModel realm, ClientModel client, Integer first, Integer max) protected long
InfinispanUserSessionProvider.getUserSessionsCount
(RealmModel realm, ClientModel client, boolean offline) InfinispanUserSessionProvider.getUserSessionsStream
(RealmModel realm, ClientModel client) InfinispanUserSessionProvider.getUserSessionsStream
(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults) protected Stream<UserSessionModel>
InfinispanUserSessionProvider.getUserSessionsStream
(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults, boolean offline) void
InfinispanAuthenticationSessionProvider.onClientRemoved
(RealmModel realm, ClientModel client) void
InfinispanUserSessionProvider.onClientRemoved
(RealmModel realm, ClientModel client) Constructors in org.keycloak.models.sessions.infinispan with parameters of type ClientModelModifierConstructorDescriptionAuthenticatedClientSessionAdapter
(KeycloakSession kcSession, InfinispanUserSessionProvider provider, AuthenticatedClientSessionEntity entity, ClientModel client, UserSessionModel userSession, InfinispanChangelogBasedTransaction<UUID, AuthenticatedClientSessionEntity> clientSessionUpdateTx, boolean offline) -
Uses of ClientModel in org.keycloak.models.sessions.infinispan.changes
Methods in org.keycloak.models.sessions.infinispan.changes that return ClientModel -
Uses of ClientModel in org.keycloak.models.sessions.infinispan.util
Methods in org.keycloak.models.sessions.infinispan.util with parameters of type ClientModelModifier and TypeMethodDescriptionstatic long
SessionTimeouts.getClientSessionLifespanMs
(RealmModel realm, ClientModel client, AuthenticatedClientSessionEntity clientSessionEntity) Get the maximum lifespan, which this clientSession can remain in the infinispan cache.static long
SessionTimeouts.getClientSessionMaxIdleMs
(RealmModel realm, ClientModel client, AuthenticatedClientSessionEntity clientSessionEntity) Get the maxIdle, which this clientSession will use.static long
SessionTimeouts.getLoginFailuresLifespanMs
(RealmModel realm, ClientModel client, LoginFailureEntity loginFailureEntity) Not using lifespan for detached login failure (backwards compatibility with the background cleaner threads, which were used for cleanup of detached login failures)static long
SessionTimeouts.getLoginFailuresMaxIdleMs
(RealmModel realm, ClientModel client, LoginFailureEntity loginFailureEntity) Not using maxIdle for detached login failure (backwards compatibility with the background cleaner threads, which were used for cleanup of detached login failures)static long
SessionTimeouts.getOfflineClientSessionLifespanMs
(RealmModel realm, ClientModel client, AuthenticatedClientSessionEntity authenticatedClientSessionEntity) Get the maximum lifespan, which this offline clientSession can remain in the infinispan cache.static long
SessionTimeouts.getOfflineClientSessionMaxIdleMs
(RealmModel realm, ClientModel client, AuthenticatedClientSessionEntity authenticatedClientSessionEntity) Get the maxIdle, which this offline clientSession will use.static long
SessionTimeouts.getOfflineSessionLifespanMs
(RealmModel realm, ClientModel client, UserSessionEntity userSessionEntity) Get the maximum lifespan, which this offline userSession can remain in the infinispan cache.static long
SessionTimeouts.getOfflineSessionMaxIdleMs
(RealmModel realm, ClientModel client, UserSessionEntity userSessionEntity) Get the maximum idle time for this offline userSession.static long
SessionTimeouts.getUserSessionLifespanMs
(RealmModel realm, ClientModel client, UserSessionEntity userSessionEntity) Get the maximum lifespan, which this userSession can remain in the infinispan cache.static long
SessionTimeouts.getUserSessionMaxIdleMs
(RealmModel realm, ClientModel client, UserSessionEntity userSessionEntity) Get the maximum idle time for this userSession. -
Uses of ClientModel in org.keycloak.models.utils
Methods in org.keycloak.models.utils that return ClientModelModifier and TypeMethodDescriptionstatic ClientModel
RepresentationToModel.createClient
(KeycloakSession session, RealmModel realm, ClientRepresentation resourceRep) Does not create scope or role mappings!static ClientModel
RepresentationToModel.createClient
(KeycloakSession session, RealmModel realm, ClientRepresentation resourceRep, Map<String, String> mappedFlows) static ClientModel
KeycloakModelUtils.createManagementClient
(RealmModel realm, String name) static ClientModel
KeycloakModelUtils.createPublicClient
(RealmModel realm, String name) static ClientModel
SystemClientUtil.getSystemClient
(RealmModel realm) Methods in org.keycloak.models.utils with parameters of type ClientModelModifier and TypeMethodDescriptionstatic long
SessionExpirationUtils.calculateClientSessionIdleTimestamp
(boolean offline, boolean isRememberMe, long lastRefreshed, RealmModel realm, ClientModel client) Calculates the time in which the user session is expired via the idle configuration in the realm and client.static long
SessionExpirationUtils.calculateClientSessionMaxLifespanTimestamp
(boolean offline, boolean isRememberMe, long clientSessionCreated, long userSessionCreated, RealmModel realm, ClientModel client) Calculates the time in which the client session is expired via lifespan configuration in the realm and client.static ResourceServer
RepresentationToModel.createResourceServer
(ClientModel client, KeycloakSession session, boolean addDefaultRoles) static ClientScopeModel
KeycloakModelUtils.findClientScopeById
(RealmModel realm, ClientModel client, String clientScopeId) Lookup clientScope OR client by id.static String
KeycloakModelUtils.generateSecret
(ClientModel client) UserModelDelegate.getClientRoleMappingsStream
(ClientModel app) KeycloakModelUtils.getClientScopeMappingsStream
(ClientModel client, ScopeContainerModel container) static void
RepresentationToModel.importAuthorizationSettings
(ClientRepresentation clientRepresentation, ClientModel client, KeycloakSession session) static boolean
RoleUtils.isClientRole
(RoleModel r, ClientModel c) static void
KeycloakModelUtils.setupDeleteAccount
(ClientModel accountClient) static ResourceServer
RepresentationToModel.toModel
(ResourceServerRepresentation rep, AuthorizationProvider authorization, ClientModel client) static ResourceServerRepresentation
ModelToRepresentation.toRepresentation
(ResourceServer model, ClientModel client) static ClientRepresentation
ModelToRepresentation.toRepresentation
(ClientModel clientModel, KeycloakSession session) static ResourceServerRepresentation
ModelToRepresentation.toResourceServerRepresentation
(KeycloakSession session, ClientModel client) static void
RepresentationToModel.updateClient
(ClientRepresentation rep, ClientModel resource, KeycloakSession session) static void
RepresentationToModel.updateClientProtocolMappers
(ClientRepresentation rep, ClientModel resource) -
Uses of ClientModel in org.keycloak.protocol
Methods in org.keycloak.protocol with parameters of type ClientModelModifier and TypeMethodDescriptionprotected void
AbstractLoginProtocolFactory.addDefaultClientScopes
(RealmModel realm, ClientModel newClient) protected abstract void
AbstractLoginProtocolFactory.addDefaults
(ClientModel realm) protected AuthenticationSessionModel
AuthorizationEndpointBase.createAuthenticationSession
(ClientModel client, String requestState) jakarta.ws.rs.core.Response
ClientInstallationProvider.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) default boolean
LoginProtocol.sendPushRevocationPolicyRequest
(RealmModel realm, ClientModel resource, int notBefore, String managementUrl) Send not-before revocation policy to the given client.void
LoginProtocolFactory.setupClientDefaults
(ClientRepresentation rep, ClientModel newClient) Setup default values for new clients.Method parameters in org.keycloak.protocol with type arguments of type ClientModelModifier and TypeMethodDescriptionprotected void
AbstractLoginProtocolFactory.addDefaultClientScopes
(RealmModel realm, Stream<ClientModel> newClients) -
Uses of ClientModel in org.keycloak.protocol.docker
Methods in org.keycloak.protocol.docker with parameters of type ClientModelModifier and TypeMethodDescriptionprotected void
DockerAuthV2ProtocolFactory.addDefaults
(ClientModel client) void
DockerAuthV2ProtocolFactory.setupClientDefaults
(ClientRepresentation rep, ClientModel newClient) -
Uses of ClientModel in org.keycloak.protocol.docker.installation
Methods in org.keycloak.protocol.docker.installation with parameters of type ClientModelModifier and TypeMethodDescriptionjakarta.ws.rs.core.Response
DockerComposeYamlInstallationProvider.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) jakarta.ws.rs.core.Response
DockerRegistryConfigFileInstallationProvider.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) jakarta.ws.rs.core.Response
DockerVariableOverrideInstallationProvider.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) -
Uses of ClientModel in org.keycloak.protocol.oidc
Classes in org.keycloak.protocol.oidc that implement ClientModelModifier and TypeClassDescriptionclass
Representation of a client model that passes information from a rotated secret.Fields in org.keycloak.protocol.oidc declared as ClientModelModifier and TypeFieldDescriptionprotected final ClientModel
AbstractClientConfigWrapper.clientModel
Methods in org.keycloak.protocol.oidc that return ClientModelMethods in org.keycloak.protocol.oidc with parameters of type ClientModelModifier and TypeMethodDescriptionvoid
FrontChannelLogoutHandler.addClient
(ClientModel client) protected void
OIDCLoginProtocolFactory.addDefaults
(ClientModel client) TokenManager.createClientAccessToken
(KeycloakSession session, RealmModel realm, ClientModel client, UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx) protected jakarta.ws.rs.core.Response
DefaultTokenExchangeProvider.exchangeClientToOIDCClient
(UserModel targetUser, UserSessionModel targetUserSession, String requestedTokenType, ClientModel targetClient, String audience, String scope) protected jakarta.ws.rs.core.Response
DefaultTokenExchangeProvider.exchangeClientToSAML2Client
(UserModel targetUser, UserSessionModel targetUserSession, String requestedTokenType, ClientModel targetClient) static TokenManager.NotBeforeCheck
TokenManager.NotBeforeCheck.forModel
(ClientModel clientModel) static OIDCAdvancedConfigWrapper
OIDCAdvancedConfigWrapper.fromClientModel
(ClientModel client) OIDCClientSecretConfigWrapper.fromClientModel
(ClientModel client) TokenManager.getAccess
(UserModel user, ClientModel client, Stream<ClientScopeModel> clientScopes) static Stream<ClientScopeModel>
TokenManager.getRequestedClientScopes
(String scopeParam, ClientModel client) Return client itself + all default client scopes of client + optional client scopes requested by scope parameterprotected AccessToken
TokenManager.initToken
(RealmModel realm, ClientModel client, UserModel user, UserSessionModel session, ClientSessionContext clientSessionCtx, jakarta.ws.rs.core.UriInfo uriInfo) static boolean
TokenManager.isValidScope
(String scopes, ClientModel client) static boolean
TokenManager.isValidScope
(String scopes, AuthorizationRequestContext authorizationRequestContext, ClientModel client) Check that all the ClientScopes that have been parsed into authorization_resources are actually in the requested scopes otherwise, the scope wasn't parsed correctlyTokenManager.refreshAccessToken
(KeycloakSession session, jakarta.ws.rs.core.UriInfo uriInfo, ClientConnection connection, RealmModel realm, ClientModel authorizedClient, String encodedRefreshToken, EventBuilder event, jakarta.ws.rs.core.HttpHeaders headers, HttpRequest request) TokenManager.responseBuilder
(RealmModel realm, ClientModel client, EventBuilder event, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx) boolean
OIDCLoginProtocol.sendPushRevocationPolicyRequest
(RealmModel realm, ClientModel resource, int notBefore, String managementUrl) void
OIDCLoginProtocolFactory.setupClientDefaults
(ClientRepresentation rep, ClientModel newClient) static boolean
TokenManager.verifyConsentStillAvailable
(KeycloakSession session, UserModel user, ClientModel client, Stream<ClientScopeModel> requestedClientScopes) TokenManager.verifyRefreshToken
(KeycloakSession session, RealmModel realm, ClientModel client, HttpRequest request, String encodedRefreshToken, boolean checkExpiration) Constructors in org.keycloak.protocol.oidc with parameters of type ClientModelModifierConstructorDescriptionprotected
AbstractClientConfigWrapper
(ClientModel clientModel, ClientRepresentation clientRep) AccessTokenResponseBuilder
(RealmModel realm, ClientModel client, EventBuilder event, KeycloakSession session, UserSessionModel userSession, ClientSessionContext clientSessionCtx) ClientInfo
(ClientModel client) TokenExchangeContext
(KeycloakSession session, jakarta.ws.rs.core.MultivaluedMap<String, String> formParams, Object cors, RealmModel realm, EventBuilder event, ClientModel client, ClientConnection clientConnection, jakarta.ws.rs.core.HttpHeaders headers, Object tokenManager, Map<String, String> clientAuthAttributes) -
Uses of ClientModel in org.keycloak.protocol.oidc.endpoints
Methods in org.keycloak.protocol.oidc.endpoints with parameters of type ClientModel -
Uses of ClientModel in org.keycloak.protocol.oidc.endpoints.request
Methods in org.keycloak.protocol.oidc.endpoints.request with parameters of type ClientModelModifier and TypeMethodDescriptionstatic AuthorizationEndpointRequest
AuthorizationEndpointRequestParserProcessor.parseRequest
(EventBuilder event, KeycloakSession session, ClientModel client, jakarta.ws.rs.core.MultivaluedMap<String, String> requestParams, AuthorizationEndpointRequestParserProcessor.EndpointType endpointType) Constructors in org.keycloak.protocol.oidc.endpoints.request with parameters of type ClientModelModifierConstructorDescriptionAuthzEndpointRequestObjectParser
(KeycloakSession session, String requestObject, ClientModel client) -
Uses of ClientModel in org.keycloak.protocol.oidc.grants.ciba
Constructors in org.keycloak.protocol.oidc.grants.ciba with parameters of type ClientModelModifierConstructorDescriptionCibaGrantType
(jakarta.ws.rs.core.MultivaluedMap<String, String> formParams, ClientModel client, KeycloakSession session, TokenEndpoint tokenEndpoint, RealmModel realm, EventBuilder event, Cors cors) Constructor parameters in org.keycloak.protocol.oidc.grants.ciba with type arguments of type ClientModel -
Uses of ClientModel in org.keycloak.protocol.oidc.grants.ciba.channel
Fields in org.keycloak.protocol.oidc.grants.ciba.channel declared as ClientModelMethods in org.keycloak.protocol.oidc.grants.ciba.channel that return ClientModelMethods in org.keycloak.protocol.oidc.grants.ciba.channel with parameters of type ClientModelConstructors in org.keycloak.protocol.oidc.grants.ciba.channel with parameters of type ClientModelModifierConstructorDescriptionCIBAAuthenticationRequest
(KeycloakSession session, UserModel user, ClientModel client) -
Uses of ClientModel in org.keycloak.protocol.oidc.grants.ciba.endpoints
Methods in org.keycloak.protocol.oidc.grants.ciba.endpoints that return ClientModelModifier and TypeMethodDescriptionprotected ClientModel
AbstractCibaEndpoint.authenticateClient()
Methods in org.keycloak.protocol.oidc.grants.ciba.endpoints with parameters of type ClientModelModifier and TypeMethodDescriptionprotected void
BackchannelAuthenticationCallbackEndpoint.sendClientNotificationRequest
(ClientModel client, CibaConfig cibaConfig, OAuth2DeviceCodeModel deviceModel) -
Uses of ClientModel in org.keycloak.protocol.oidc.grants.ciba.endpoints.request
Methods in org.keycloak.protocol.oidc.grants.ciba.endpoints.request with parameters of type ClientModelModifier and TypeMethodDescriptionBackchannelAuthenticationEndpointRequestParserProcessor.parseRequest
(EventBuilder event, KeycloakSession session, ClientModel client, jakarta.ws.rs.core.MultivaluedMap<String, String> requestParams, CibaConfig config) -
Uses of ClientModel in org.keycloak.protocol.oidc.grants.device
Methods in org.keycloak.protocol.oidc.grants.device with parameters of type ClientModelModifier and TypeMethodDescriptionstatic OAuth2DeviceCodeModel
DeviceGrantType.getDeviceByDeviceCode
(KeycloakSession session, RealmModel realm, ClientModel client, EventBuilder event, String deviceCode) Constructors in org.keycloak.protocol.oidc.grants.device with parameters of type ClientModelModifierConstructorDescriptionDeviceGrantType
(jakarta.ws.rs.core.MultivaluedMap<String, String> formParams, ClientModel client, KeycloakSession session, TokenEndpoint tokenEndpoint, RealmModel realm, EventBuilder event, Cors cors) -
Uses of ClientModel in org.keycloak.protocol.oidc.grants.device.endpoints
Methods in org.keycloak.protocol.oidc.grants.device.endpoints with parameters of type ClientModelModifier and TypeMethodDescriptionprotected AuthenticationSessionModel
DeviceEndpoint.createAuthenticationSession
(ClientModel client, String scope) -
Uses of ClientModel in org.keycloak.protocol.oidc.installation
Methods in org.keycloak.protocol.oidc.installation with parameters of type ClientModelModifier and TypeMethodDescriptionjakarta.ws.rs.core.Response
KeycloakOIDCClientInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) jakarta.ws.rs.core.Response
KeycloakOIDCJbossSubsystemClientCliInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) jakarta.ws.rs.core.Response
KeycloakOIDCJbossSubsystemClientInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) KeycloakOIDCClientInstallation.getClientCredentialsAdapterConfig
(KeycloakSession session, ClientModel client) static boolean
KeycloakOIDCClientInstallation.showClientCredentialsAdapterConfig
(ClientModel client) -
Uses of ClientModel in org.keycloak.protocol.oidc.par.endpoints
Fields in org.keycloak.protocol.oidc.par.endpoints declared as ClientModel -
Uses of ClientModel in org.keycloak.protocol.oidc.par.endpoints.request
Methods in org.keycloak.protocol.oidc.par.endpoints.request with parameters of type ClientModelModifier and TypeMethodDescriptionstatic AuthorizationEndpointRequest
ParEndpointRequestParserProcessor.parseRequest
(EventBuilder event, KeycloakSession session, ClientModel client, jakarta.ws.rs.core.MultivaluedMap<String, String> requestParams) Constructors in org.keycloak.protocol.oidc.par.endpoints.request with parameters of type ClientModelModifierConstructorDescriptionAuthzEndpointParParser
(KeycloakSession session, ClientModel client, String requestUri) ParEndpointRequestObjectParser
(KeycloakSession session, String requestObject, ClientModel client) -
Uses of ClientModel in org.keycloak.protocol.oidc.rar.parsers
Constructors in org.keycloak.protocol.oidc.rar.parsers with parameters of type ClientModel -
Uses of ClientModel in org.keycloak.protocol.oidc.utils
Methods in org.keycloak.protocol.oidc.utils that return ClientModelMethods in org.keycloak.protocol.oidc.utils with parameters of type ClientModelModifier and TypeMethodDescriptionAcrUtils.getAcrLoaMap
(ClientModel client) AcrUtils.getAcrValues
(String claimsParam, String acrValuesParam, ClientModel client) AcrUtils.getDefaultAcrValues
(ClientModel client) WebOriginsUtils.resolveValidWebOrigins
(KeycloakSession session, ClientModel client) static void
PairwiseSubMapperValidator.validate
(KeycloakSession session, ClientModel client, ProtocolMapperModel mapperModel) static String
RedirectUtils.verifyRedirectUri
(KeycloakSession session, String redirectUri, ClientModel client) static String
RedirectUtils.verifyRedirectUri
(KeycloakSession session, String redirectUri, ClientModel client, boolean requireRedirectUri) -
Uses of ClientModel in org.keycloak.protocol.saml
Methods in org.keycloak.protocol.saml that return ClientModelModifier and TypeMethodDescriptionArtifactResolver.selectSourceClient
(KeycloakSession session, String artifact) Returns client model that issued artifactDefaultSamlArtifactResolver.selectSourceClient
(KeycloakSession session, String artifact) Methods in org.keycloak.protocol.saml with parameters of type ClientModelModifier and TypeMethodDescriptionprotected void
SamlProtocolFactory.addDefaults
(ClientModel client) protected LogoutRequestType
SamlProtocol.createLogoutRequest
(String logoutUrl, AuthenticatedClientSessionModel clientSession, ClientModel client, SamlProtocolExtensionsAwareBuilder.NodeGenerator... extensions) static PublicKey
SamlProtocolUtils.getEncryptionKey
(ClientModel client) Returns public part of SAML encryption key from the client settings.static String
SamlProtocol.getLogoutServiceUrl
(KeycloakSession session, ClientModel client, String bindingType, boolean backChannelLogout) SamlService.getOrCreateLoginSessionForIdpInitiatedSso
(KeycloakSession session, RealmModel realm, ClientModel client, String relayState) Creates a client session object for SAML IdP-initiated SSO session.static PublicKey
SamlProtocolUtils.getPublicKey
(ClientModel client, String attribute) static PublicKey
SamlProtocolUtils.getSignatureValidationKey
(ClientModel client) Returns public part of SAML signing key from the client settings.protected jakarta.ws.rs.core.Response
SamlService.BindingProtocol.loginRequest
(String relayState, AuthnRequestType requestAbstractType, ClientModel client) protected jakarta.ws.rs.core.Response
SamlService.BindingProtocol.logoutRequest
(LogoutRequestType logoutRequest, ClientModel client, String relayState) void
SamlProtocolFactory.setupClientDefaults
(ClientRepresentation clientRep, ClientModel newClient) static boolean
SamlProtocol.useArtifactForLogout
(ClientModel client) static void
SamlProtocolUtils.verifyDocumentSignature
(ClientModel client, Document document) Verifies a signature of the given SAML document using settings for the given client.protected abstract void
SamlService.BindingProtocol.verifySignature
(SAMLDocumentHolder documentHolder, ClientModel client) protected void
SamlService.PostBindingProtocol.verifySignature
(SAMLDocumentHolder documentHolder, ClientModel client) protected void
SamlService.RedirectBindingProtocol.verifySignature
(SAMLDocumentHolder documentHolder, ClientModel client) Constructors in org.keycloak.protocol.saml with parameters of type ClientModel -
Uses of ClientModel in org.keycloak.protocol.saml.installation
Methods in org.keycloak.protocol.saml.installation with parameters of type ClientModelModifier and TypeMethodDescriptionstatic void
KeycloakSamlClientInstallation.baseXml
(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri, SamlClient samlClient, StringBuilder buffer) jakarta.ws.rs.core.Response
KeycloakSamlClientInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) jakarta.ws.rs.core.Response
KeycloakSamlSubsystemCliInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) jakarta.ws.rs.core.Response
KeycloakSamlSubsystemInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri) jakarta.ws.rs.core.Response
ModAuthMellonClientInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) jakarta.ws.rs.core.Response
SamlSPDescriptorClientInstallation.generateInstallation
(KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri) static String
SamlSPDescriptorClientInstallation.getSPDescriptorForClient
(ClientModel client) -
Uses of ClientModel in org.keycloak.services
Methods in org.keycloak.services that return ClientModelMethods in org.keycloak.services with parameters of type ClientModel -
Uses of ClientModel in org.keycloak.services.clientpolicy.context
Methods in org.keycloak.services.clientpolicy.context that return ClientModelModifier and TypeMethodDescriptiondefault ClientModel
ClientCRUDContext.getAuthenticatedClient()
returnsUserModel
of the authenticated client.AdminClientRegisteredContext.getTargetClient()
AdminClientUnregisterContext.getTargetClient()
AdminClientUpdateContext.getTargetClient()
AdminClientUpdatedContext.getTargetClient()
AdminClientViewContext.getTargetClient()
default ClientModel
ClientCRUDContext.getTargetClient()
returnsClientModel
of the existing client to be updated/read/updated/deleted.DynamicClientRegisteredContext.getTargetClient()
DynamicClientUnregisterContext.getTargetClient()
DynamicClientUpdateContext.getTargetClient()
DynamicClientUpdatedContext.getTargetClient()
DynamicClientViewContext.getTargetClient()
Constructors in org.keycloak.services.clientpolicy.context with parameters of type ClientModelModifierConstructorDescriptionAdminClientRegisteredContext
(ClientModel registeredClient, AdminAuth adminAuth) AdminClientUnregisterContext
(ClientModel targetClient, AdminAuth adminAuth) AdminClientUpdateContext
(ClientRepresentation proposedClientRepresentation, ClientModel targetClient, AdminAuth adminAuth) AdminClientUpdatedContext
(ClientRepresentation roposedClientRepresentation, ClientModel updatedClient, AdminAuth adminAuth) AdminClientViewContext
(ClientModel targetClient, AdminAuth adminAuth) ClientSecretRotationContext
(ClientRepresentation proposedClientRepresentation, ClientModel targetClient, String currentSecret) DynamicClientRegisteredContext
(ClientRegistrationContext context, ClientModel registeredClient, JsonWebToken token, RealmModel realm) DynamicClientUnregisterContext
(KeycloakSession session, ClientModel targetClient, JsonWebToken token, RealmModel realm) DynamicClientUpdateContext
(ClientRegistrationContext context, ClientModel proposedClientRepresentation, JsonWebToken token, RealmModel realm) DynamicClientUpdatedContext
(KeycloakSession session, ClientModel updatedClient, JsonWebToken token, RealmModel realm) DynamicClientViewContext
(KeycloakSession session, ClientModel targetClient, JsonWebToken token, RealmModel realm) -
Uses of ClientModel in org.keycloak.services.clientpolicy.executor
Methods in org.keycloak.services.clientpolicy.executor with parameters of type ClientModelModifier and TypeMethodDescriptionvoid
ConsentRequiredExecutor.beforeUpdate
(ClientModel clientToBeUpdated, ClientRepresentation proposedClient) -
Uses of ClientModel in org.keycloak.services.clientregistration
Methods in org.keycloak.services.clientregistration with parameters of type ClientModelModifier and TypeMethodDescriptionAbstractClientRegistrationProvider.get
(ClientModel client) void
ClientRegistrationAuth.requireDelete
(ClientModel client) ClientRegistrationAuth.requireUpdate
(ClientRegistrationContext context, ClientModel client) void
ClientRegistrationAuth.requireView
(ClientModel client) void
ClientRegistrationAuth.requireView
(ClientModel client, boolean allowPublicClient) static String
ClientRegistrationTokenUtils.updateRegistrationAccessToken
(KeycloakSession session, ClientModel client, RegistrationAuth registrationAuth) static String
ClientRegistrationTokenUtils.updateRegistrationAccessToken
(KeycloakSession session, RealmModel realm, ClientModel client, RegistrationAuth registrationAuth) void
AbstractClientRegistrationProvider.validateClient
(ClientModel clientModel, OIDCClientRepresentation oidcClient, boolean create) -
Uses of ClientModel in org.keycloak.services.clientregistration.policy
Methods in org.keycloak.services.clientregistration.policy with parameters of type ClientModelModifier and TypeMethodDescriptionvoid
ClientRegistrationPolicy.afterRegister
(ClientRegistrationContext context, ClientModel clientModel) void
ClientRegistrationPolicy.afterUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
ClientRegistrationPolicy.beforeDelete
(ClientRegistrationProvider provider, ClientModel clientModel) void
ClientRegistrationPolicy.beforeUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
ClientRegistrationPolicy.beforeView
(ClientRegistrationProvider provider, ClientModel clientModel) static void
ClientRegistrationPolicyManager.triggerAfterRegister
(ClientRegistrationContext context, RegistrationAuth authType, ClientModel client) static void
ClientRegistrationPolicyManager.triggerAfterUpdate
(ClientRegistrationContext context, RegistrationAuth authType, ClientModel client) static void
ClientRegistrationPolicyManager.triggerBeforeRemove
(KeycloakSession session, ClientRegistrationProvider provider, RegistrationAuth authType, ClientModel client) static void
ClientRegistrationPolicyManager.triggerBeforeUpdate
(ClientRegistrationContext context, RegistrationAuth authType, ClientModel client) static void
ClientRegistrationPolicyManager.triggerBeforeView
(KeycloakSession session, ClientRegistrationProvider provider, RegistrationAuth authType, ClientModel client) -
Uses of ClientModel in org.keycloak.services.clientregistration.policy.impl
Methods in org.keycloak.services.clientregistration.policy.impl with parameters of type ClientModelModifier and TypeMethodDescriptionvoid
ClientDisabledClientRegistrationPolicy.afterRegister
(ClientRegistrationContext context, ClientModel clientModel) void
ClientScopesClientRegistrationPolicy.afterRegister
(ClientRegistrationContext context, ClientModel clientModel) void
ConsentRequiredClientRegistrationPolicy.afterRegister
(ClientRegistrationContext context, ClientModel clientModel) void
MaxClientsClientRegistrationPolicy.afterRegister
(ClientRegistrationContext context, ClientModel clientModel) void
ProtocolMappersClientRegistrationPolicy.afterRegister
(ClientRegistrationContext context, ClientModel clientModel) void
ScopeClientRegistrationPolicy.afterRegister
(ClientRegistrationContext context, ClientModel clientModel) void
TrustedHostClientRegistrationPolicy.afterRegister
(ClientRegistrationContext context, ClientModel clientModel) void
ClientDisabledClientRegistrationPolicy.afterUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
ClientScopesClientRegistrationPolicy.afterUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
ConsentRequiredClientRegistrationPolicy.afterUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
MaxClientsClientRegistrationPolicy.afterUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
ProtocolMappersClientRegistrationPolicy.afterUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
ScopeClientRegistrationPolicy.afterUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
TrustedHostClientRegistrationPolicy.afterUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
ClientDisabledClientRegistrationPolicy.beforeDelete
(ClientRegistrationProvider provider, ClientModel clientModel) void
ClientScopesClientRegistrationPolicy.beforeDelete
(ClientRegistrationProvider provider, ClientModel clientModel) void
ConsentRequiredClientRegistrationPolicy.beforeDelete
(ClientRegistrationProvider provider, ClientModel clientModel) void
MaxClientsClientRegistrationPolicy.beforeDelete
(ClientRegistrationProvider provider, ClientModel clientModel) void
ProtocolMappersClientRegistrationPolicy.beforeDelete
(ClientRegistrationProvider provider, ClientModel clientModel) void
ScopeClientRegistrationPolicy.beforeDelete
(ClientRegistrationProvider provider, ClientModel clientModel) void
TrustedHostClientRegistrationPolicy.beforeDelete
(ClientRegistrationProvider provider, ClientModel clientModel) void
ClientDisabledClientRegistrationPolicy.beforeUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
ClientScopesClientRegistrationPolicy.beforeUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
ConsentRequiredClientRegistrationPolicy.beforeUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
MaxClientsClientRegistrationPolicy.beforeUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
ProtocolMappersClientRegistrationPolicy.beforeUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
ScopeClientRegistrationPolicy.beforeUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
TrustedHostClientRegistrationPolicy.beforeUpdate
(ClientRegistrationContext context, ClientModel clientModel) void
ClientDisabledClientRegistrationPolicy.beforeView
(ClientRegistrationProvider provider, ClientModel clientModel) void
ClientScopesClientRegistrationPolicy.beforeView
(ClientRegistrationProvider provider, ClientModel clientModel) void
ConsentRequiredClientRegistrationPolicy.beforeView
(ClientRegistrationProvider provider, ClientModel clientModel) void
MaxClientsClientRegistrationPolicy.beforeView
(ClientRegistrationProvider provider, ClientModel clientModel) void
ProtocolMappersClientRegistrationPolicy.beforeView
(ClientRegistrationProvider provider, ClientModel clientModel) void
ScopeClientRegistrationPolicy.beforeView
(ClientRegistrationProvider provider, ClientModel clientModel) void
TrustedHostClientRegistrationPolicy.beforeView
(ClientRegistrationProvider provider, ClientModel clientModel) -
Uses of ClientModel in org.keycloak.services.managers
Methods in org.keycloak.services.managers that return ClientModelModifier and TypeMethodDescriptionstatic ClientModel
ClientManager.createClient
(KeycloakSession session, RealmModel realm, ClientRepresentation rep) Should not be called from an import.Auth.getClient()
AuthenticationManager.AuthResult.getClient()
Methods in org.keycloak.services.managers that return types with arguments of type ClientModelModifier and TypeMethodDescriptionUserSessionManager.findClientsWithOfflineToken
(RealmModel realm, UserModel user) Methods in org.keycloak.services.managers with parameters of type ClientModelModifier and TypeMethodDescriptionvoid
RealmManager.addQueryCompositeRoles
(ClientModel realmAccess) static void
AuthenticationManager.backchannelLogoutUserFromClient
(KeycloakSession session, RealmModel realm, UserModel user, ClientModel client, jakarta.ws.rs.core.UriInfo uriInfo, jakarta.ws.rs.core.HttpHeaders headers) Logout all clientSessions of this user and clientvoid
ClientManager.clientIdChanged
(ClientModel client, ClientRepresentation newClientRepresentation) void
ClientManager.enableServiceAccount
(ClientModel client) AuthenticationSessionManager.getAuthenticationSessionByIdAndClient
(RealmModel realm, String authSessionId, ClientModel client, String tabId) static String
ResourceAdminManager.getBackchannelLogoutUrl
(KeycloakSession session, ClientModel client) static <CLIENT_SESSION extends CommonClientSessionModel>
CLIENT_SESSIONClientSessionCode.getClientSession
(String code, String tabId, KeycloakSession session, RealmModel realm, ClientModel client, EventBuilder event, Class<CLIENT_SESSION> sessionClass) AuthenticationSessionManager.getCurrentAuthenticationSession
(RealmModel realm, ClientModel client, String tabId) Returns current authentication session if it exists, otherwise returnsnull
.static String
ResourceAdminManager.getManagementUrl
(KeycloakSession session, ClientModel client) boolean
Auth.hasClientRole
(ClientModel app, String role) boolean
Auth.hasOneOfAppRole
(ClientModel app, String... roles) ResourceAdminManager.logoutClient
(RealmModel realm, ClientModel resource) protected GlobalRequestResult
ResourceAdminManager.logoutClient
(RealmModel realm, ClientModel resource, int notBefore) jakarta.ws.rs.core.Response
ResourceAdminManager.logoutClientSession
(RealmModel realm, ClientModel resource, AuthenticatedClientSessionModel clientSession) protected jakarta.ws.rs.core.Response
ResourceAdminManager.logoutClientSessions
(RealmModel realm, ClientModel resource, List<AuthenticatedClientSessionModel> clientSessions) jakarta.ws.rs.core.Response
ResourceAdminManager.logoutClientSessionWithBackchannelLogoutUrl
(ClientModel resource, AuthenticatedClientSessionModel clientSession) static <CLIENT_SESSION extends CommonClientSessionModel>
ClientSessionCode.ParseResult<CLIENT_SESSION>ClientSessionCode.parseResult
(String code, String tabId, KeycloakSession session, RealmModel realm, ClientModel client, EventBuilder event, CLIENT_SESSION clientSession) static <CLIENT_SESSION extends CommonClientSessionModel>
ClientSessionCode.ParseResult<CLIENT_SESSION>ClientSessionCode.parseResult
(String code, String tabId, KeycloakSession session, RealmModel realm, ClientModel client, EventBuilder event, Class<CLIENT_SESSION> sessionClass) ResourceAdminManager.pushClientRevocationPolicy
(RealmModel realm, ClientModel client) protected GlobalRequestResult
ResourceAdminManager.pushRevocationPolicy
(RealmModel realm, ClientModel resource, int notBefore) boolean
ClientManager.removeClient
(RealmModel realm, ClientModel client) static boolean
UserConsentManager.revokeConsentToClient
(KeycloakSession session, ClientModel client, UserModel user) Revoke consent of given user to given clientboolean
UserSessionManager.revokeOfflineToken
(UserModel user, ClientModel client) protected jakarta.ws.rs.core.Response
ResourceAdminManager.sendBackChannelLogoutRequestToClientUri
(ClientModel resource, AuthenticatedClientSessionModel clientSessionModel, String managementUrl) protected jakarta.ws.rs.core.Response
ResourceAdminManager.sendLogoutRequest
(RealmModel realm, ClientModel resource, List<String> adapterSessionIds, List<String> userSessions, int notBefore, String managementUrl) protected boolean
ResourceAdminManager.sendPushRevocationPolicyRequest
(RealmModel realm, ClientModel resource, int notBefore, String managementUrl) protected boolean
ResourceAdminManager.sendTestNodeAvailabilityRequest
(RealmModel realm, ClientModel client, String managementUrl) ResourceAdminManager.testNodesAvailability
(RealmModel realm, ClientModel client) ClientManager.toInstallationRepresentation
(RealmModel realmModel, ClientModel clientModel, URI baseUri) ClientManager.toJBossSubsystemConfig
(RealmModel realmModel, ClientModel clientModel, URI baseUri) ClientManager.validateRegisteredNodes
(ClientModel client) Constructors in org.keycloak.services.managers with parameters of type ClientModelModifierConstructorDescriptionAuth
(RealmModel realm, AccessToken token, UserModel user, ClientModel client, UserSessionModel session, boolean cookie) AuthResult
(UserModel user, UserSessionModel session, AccessToken token, ClientModel client) -
Uses of ClientModel in org.keycloak.services.resources
Fields in org.keycloak.services.resources declared as ClientModelMethods in org.keycloak.services.resources that return ClientModelModifier and TypeMethodDescriptionprotected ClientModel
ClientsManagementService.authorizeClient()
Methods in org.keycloak.services.resources with parameters of type ClientModelModifier and TypeMethodDescriptionCors.allowedOrigins
(KeycloakSession session, ClientModel client) protected boolean
LogoutSessionCodeChecks.checkClientDisabled
(ClientModel client) protected boolean
SessionCodeChecks.checkClientDisabled
(ClientModel client) static void
LoginActionsServiceChecks.checkIsClientValid
(KeycloakSession session, ClientModel client) Verifies whether the client denoted by client ID in token'siss
(issuedFor
) field both exists and is enabled.protected void
LogoutSessionCodeChecks.setClientToEvent
(ClientModel client) protected void
SessionCodeChecks.setClientToEvent
(ClientModel client) Constructors in org.keycloak.services.resources with parameters of type ClientModelModifierConstructorDescriptionAbstractSecuredLocalService
(KeycloakSession session, ClientModel client) -
Uses of ClientModel in org.keycloak.services.resources.account
Constructors in org.keycloak.services.resources.account with parameters of type ClientModelModifierConstructorDescriptionAccountConsole
(KeycloakSession session, ClientModel client, Theme theme) -
Uses of ClientModel in org.keycloak.services.resources.admin
Fields in org.keycloak.services.resources.admin declared as ClientModelModifier and TypeFieldDescriptionprotected final ClientModel
ClientAttributeCertificateResource.client
protected ClientModel
ClientResource.client
protected ClientModel
ClientRoleMappingsResource.client
protected ClientModel
ScopeMappedClientResource.scopedClient
Methods in org.keycloak.services.resources.admin that return ClientModelMethods in org.keycloak.services.resources.admin with parameters of type ClientModelModifier and TypeMethodDescriptionAdminEventBuilder.authClient
(ClientModel client) protected Stream<RoleRepresentation>
RoleResource.getClientRoleComposites
(ClientModel app, RoleModel role) boolean
AdminAuth.hasAppRole
(ClientModel app, String role) boolean
AdminAuth.hasOneOfAppRole
(ClientModel app, String... roles) ClientResource.toMgmtRef
(ClientModel client, AdminPermissionManagement permissions) Constructors in org.keycloak.services.resources.admin with parameters of type ClientModelModifierConstructorDescriptionAdminAuth
(RealmModel realm, AccessToken token, UserModel user, ClientModel client) ClientAttributeCertificateResource
(AdminPermissionEvaluator auth, ClientModel client, KeycloakSession session, String attributePrefix, AdminEventBuilder adminEvent) ClientResource
(RealmModel realm, AdminPermissionEvaluator auth, ClientModel clientModel, KeycloakSession session, AdminEventBuilder adminEvent) ClientRoleMappingsResource
(jakarta.ws.rs.core.UriInfo uriInfo, KeycloakSession session, RealmModel realm, AdminPermissionEvaluator auth, RoleMapperModel user, ClientModel client, AdminEventBuilder adminEvent, AdminPermissionEvaluator.RequirePermissionCheck manageCheck, AdminPermissionEvaluator.RequirePermissionCheck viewCheck) ClientScopeEvaluateResource
(KeycloakSession session, jakarta.ws.rs.core.UriInfo uriInfo, RealmModel realm, AdminPermissionEvaluator auth, ClientModel client, ClientConnection clientConnection) ClientScopeEvaluateScopeMappingsResource
(RoleContainerModel roleContainer, AdminPermissionEvaluator auth, ClientModel client, String scopeParam) ScopeMappedClientResource
(RealmModel realm, AdminPermissionEvaluator auth, ScopeContainerModel scopeContainer, KeycloakSession session, ClientModel scopedClient, AdminEventBuilder adminEvent, AdminPermissionEvaluator.RequirePermissionCheck managePermission, AdminPermissionEvaluator.RequirePermissionCheck viewPermission) -
Uses of ClientModel in org.keycloak.services.resources.admin.permissions
Methods in org.keycloak.services.resources.admin.permissions that return ClientModelMethods in org.keycloak.services.resources.admin.permissions with parameters of type ClientModelModifier and TypeMethodDescriptionboolean
UserPermissionManagement.canClientImpersonate
(ClientModel client, UserModel user) boolean
ClientPermissionEvaluator.canConfigure
(ClientModel client) boolean
ClientPermissionManagement.canExchangeTo
(ClientModel authorizedClient, ClientModel to) boolean
IdentityProviderPermissionManagement.canExchangeTo
(ClientModel authorizedClient, IdentityProviderModel to) boolean
UserPermissionEvaluator.canImpersonate
(UserModel user, ClientModel requester) boolean
ClientPermissionEvaluator.canManage
(ClientModel client) boolean
ClientPermissionEvaluator.canMapClientScopeRoles
(ClientModel client) boolean
ClientPermissionEvaluator.canMapCompositeRoles
(ClientModel client) boolean
ClientPermissionEvaluator.canMapRoles
(ClientModel client) boolean
ClientPermissionEvaluator.canView
(ClientModel client) ClientPermissionManagement.configurePermission
(ClientModel client) ClientPermissionManagement.exchangeToPermission
(ClientModel client) ClientPermissionEvaluator.getAccess
(ClientModel client) ClientPermissionManagement.getPermissions
(ClientModel client) boolean
UserPermissionEvaluator.isImpersonatable
(UserModel user, ClientModel requester) boolean
ClientPermissionEvaluator.isPermissionsEnabled
(ClientModel client) boolean
ClientPermissionManagement.isPermissionsEnabled
(ClientModel client) ClientPermissionManagement.managePermission
(ClientModel client) ClientPermissionManagement.mapRolesClientScopePermission
(ClientModel client) ClientPermissionManagement.mapRolesCompositePermission
(ClientModel client) ClientPermissionManagement.mapRolesPermission
(ClientModel client) void
ClientPermissionEvaluator.requireConfigure
(ClientModel client) void
ClientPermissionEvaluator.requireManage
(ClientModel client) void
ClientPermissionEvaluator.requireView
(ClientModel client) ClientPermissionManagement.resource
(ClientModel client) ClientPermissionManagement.resourceServer
(ClientModel client) void
ClientPermissionEvaluator.setPermissionsEnabled
(ClientModel client, boolean enable) void
ClientPermissionManagement.setPermissionsEnabled
(ClientModel client, boolean enable) ClientPermissionManagement.viewPermission
(ClientModel client) -
Uses of ClientModel in org.keycloak.services.util
Methods in org.keycloak.services.util with parameters of type ClientModelModifier and TypeMethodDescriptionstatic UserSessionModel
UserSessionUtil.findValidSession
(KeycloakSession session, RealmModel realm, AccessToken token, EventBuilder event, ClientModel client) static CertificateRepresentation
CertificateInfoHelper.getCertificateFromClient
(ClientModel client, String attributePrefix) static ClientMappingsRepresentation
ScopeMappedUtil.toClientMappingsRepresentation
(ClientModel client, ScopeContainerModel scopeContainer) static void
CertificateInfoHelper.updateClientModelCertificateInfo
(ClientModel client, CertificateRepresentation rep, String attributePrefix) -
Uses of ClientModel in org.keycloak.sessions
Methods in org.keycloak.sessions that return ClientModelMethods in org.keycloak.sessions with parameters of type ClientModelModifier and TypeMethodDescriptionRootAuthenticationSessionModel.createAuthenticationSession
(ClientModel client) Create a new authentication session and returns it.RootAuthenticationSessionModel.getAuthenticationSession
(ClientModel client, String tabId) Returns an authentication session for the particular client and tab or null if it doesn't yet exists.void
AuthenticationSessionProvider.onClientRemoved
(RealmModel realm, ClientModel client) Removes all associated root authentication sessions to the given realm and client which was removed. -
Uses of ClientModel in org.keycloak.social.twitter
Methods in org.keycloak.social.twitter with parameters of type ClientModelModifier and TypeMethodDescriptionjakarta.ws.rs.core.Response
TwitterIdentityProvider.exchangeFromToken
(jakarta.ws.rs.core.UriInfo uriInfo, EventBuilder builder, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject, jakarta.ws.rs.core.MultivaluedMap<String, String> params) protected jakarta.ws.rs.core.Response
TwitterIdentityProvider.exchangeSessionToken
(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) protected jakarta.ws.rs.core.Response
TwitterIdentityProvider.exchangeStoredToken
(jakarta.ws.rs.core.UriInfo uriInfo, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) -
Uses of ClientModel in org.keycloak.storage
Methods in org.keycloak.storage that return ClientModelModifier and TypeMethodDescriptionClientStorageManager.addClient
(RealmModel realm, String clientId) ClientStorageManager.addClient
(RealmModel realm, String id, String clientId) ClientStorageManager.getClientByClientId
(RealmModel realm, String clientId) ClientStorageManager.getClientById
(RealmModel realm, String id) Methods in org.keycloak.storage that return types with arguments of type ClientModelModifier and TypeMethodDescriptionClientStorageManager.getAllRedirectUrisOfEnabledClients
(RealmModel realm) ClientStorageManager.getAlwaysDisplayInConsoleClientsStream
(RealmModel realm) ClientStorageManager.getClientsStream
(RealmModel realm) ClientStorageManager.getClientsStream
(RealmModel realm, Integer firstResult, Integer maxResults) protected Stream<ClientModel>
ClientStorageManager.query
(org.keycloak.storage.ClientStorageManager.PaginatedQuery paginatedQuery, RealmModel realm, Integer firstResult, Integer maxResults) ClientStorageManager.searchClientsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) ClientStorageManager.searchClientsByAuthenticationFlowBindingOverrides
(RealmModel realm, Map<String, String> overrides, Integer firstResult, Integer maxResults) ClientStorageManager.searchClientsByClientIdStream
(RealmModel realm, String clientId, Integer firstResult, Integer maxResults) Methods in org.keycloak.storage with parameters of type ClientModelModifier and TypeMethodDescriptionRoleStorageManager.addClientRole
(ClientModel client, String name) RoleStorageManager.addClientRole
(ClientModel client, String id, String name) void
ClientStorageManager.addClientScopes
(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope) RoleStorageManager.getClientRole
(ClientModel client, String name) RoleStorageManager.getClientRolesStream
(ClientModel client) RoleStorageManager.getClientRolesStream
(ClientModel client, Integer first, Integer max) ClientStorageManager.getClientScopes
(RealmModel realm, ClientModel client, boolean defaultScopes) UserStorageManager.getServiceAccount
(ClientModel client) static boolean
StorageId.isLocalStorage
(ClientModel client) Deprecated.UseStorageId.isLocalStorage(String)
instead.void
UserStorageManager.preRemove
(RealmModel realm, ClientModel client) void
ClientStorageManager.removeClientScope
(RealmModel realm, ClientModel client, ClientScopeModel clientScope) void
RoleStorageManager.removeRoles
(ClientModel client) static String
StorageId.resolveProviderId
(ClientModel client) Deprecated.UseStorageId.providerId(String)
instead.RoleStorageManager.searchForClientRolesStream
(ClientModel client, String search, Integer first, Integer max) Obtaining roles from an external role storage is time-bounded. -
Uses of ClientModel in org.keycloak.storage.adapter
Methods in org.keycloak.storage.adapter with parameters of type ClientModelModifier and TypeMethodDescriptionAbstractUserAdapter.getClientRoleMappings
(ClientModel app) Deprecated.AbstractUserAdapter.Streams.getClientRoleMappings
(ClientModel app) AbstractInMemoryUserAdapter.getClientRoleMappingsStream
(ClientModel app) AbstractUserAdapter.getClientRoleMappingsStream
(ClientModel app) AbstractUserAdapter.Streams.getClientRoleMappingsStream
(ClientModel app) AbstractUserAdapterFederatedStorage.getClientRoleMappingsStream
(ClientModel app) Gets role mappings from federated storage and automatically appends default roles. -
Uses of ClientModel in org.keycloak.storage.client
Classes in org.keycloak.storage.client that implement ClientModelModifier and TypeClassDescriptionclass
Helper base class for ClientModel implementations for ClientStorageProvider implementations.class
class
Base helper class.Methods in org.keycloak.storage.client that return ClientModelModifier and TypeMethodDescriptionClientLookupProvider.getClientByClientId
(RealmModel realm, String clientId) Exact search for a client by its public client identifier.ClientLookupProvider.getClientById
(RealmModel realm, String id) Exact search for a client by its internal ID.Methods in org.keycloak.storage.client that return types with arguments of type ClientModelModifier and TypeMethodDescriptionClientLookupProvider.searchClientsByAttributes
(RealmModel realm, Map<String, String> attributes, Integer firstResult, Integer maxResults) default Stream<ClientModel>
ClientLookupProvider.searchClientsByAuthenticationFlowBindingOverrides
(RealmModel realm, Map<String, String> overrides, Integer firstResult, Integer maxResults) ClientLookupProvider.searchClientsByClientIdStream
(RealmModel realm, String clientId, Integer firstResult, Integer maxResults) Case-insensitive search for clients that contain the given string in their public client identifier.Methods in org.keycloak.storage.client with parameters of type ClientModelModifier and TypeMethodDescriptionClientLookupProvider.getClientScopes
(RealmModel realm, ClientModel client, boolean defaultScopes) Return all default scopes (ifdefaultScope
istrue
) or all optional scopes (ifdefaultScope
isfalse
) linked with the client -
Uses of ClientModel in org.keycloak.storage.datastore
Methods in org.keycloak.storage.datastore with parameters of type ClientModelModifier and TypeMethodDescriptionstatic void
LegacyExportImportManager.createClientScopeMappings
(RealmModel realm, ClientModel clientModel, List<ScopeMappingRepresentation> mappings) -
Uses of ClientModel in org.keycloak.storage.federated
Methods in org.keycloak.storage.federated with parameters of type ClientModelModifier and TypeMethodDescriptionvoid
UserFederatedStorageProvider.preRemove
(RealmModel realm, ClientModel client) -
Uses of ClientModel in org.keycloak.storage.jpa
Methods in org.keycloak.storage.jpa with parameters of type ClientModelModifier and TypeMethodDescriptionvoid
JpaUserFederatedStorageProvider.preRemove
(RealmModel realm, ClientModel client) -
Uses of ClientModel in org.keycloak.storage.ldap.mappers.membership.role
Methods in org.keycloak.storage.ldap.mappers.membership.role with parameters of type ClientModelModifier and TypeMethodDescriptionRoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate.getClientRoleMappingsStream
(ClientModel client) -
Uses of ClientModel in org.keycloak.storage.role
Methods in org.keycloak.storage.role with parameters of type ClientModelModifier and TypeMethodDescriptionRoleLookupProvider.getClientRole
(ClientModel client, String name) Exact search for a client role by given name.RoleLookupProvider.searchForClientRolesStream
(ClientModel client, String search, Integer first, Integer max) Case-insensitive search for client roles that contain the given string in their name or description. -
Uses of ClientModel in org.keycloak.validation
Methods in org.keycloak.validation with parameters of type ClientModelModifier and TypeMethodDescriptionstatic void
ValidationUtil.validateClient
(KeycloakSession session, ClientModel client, boolean create, ValidationUtil.ErrorHandler errorHandler) static void
ValidationUtil.validateClient
(KeycloakSession session, ClientModel client, OIDCClientRepresentation oidcClient, boolean create, ValidationUtil.ErrorHandler errorHandler) Method parameters in org.keycloak.validation with type arguments of type ClientModelModifier and TypeMethodDescriptionDefaultClientValidationProvider.validate
(ValidationContext<ClientModel> context) Constructors in org.keycloak.validation with parameters of type ClientModelModifierConstructorDescriptionClientValidationContext
(ValidationContext.Event event, KeycloakSession session, ClientModel objectToValidate) OIDCContext
(ValidationContext.Event event, KeycloakSession session, ClientModel objectToValidate, OIDCClientRepresentation oidcClient)