Uses of Interface
org.keycloak.models.ClientModel

Packages that use ClientModel

Package	Description
org.keycloak.authentication
org.keycloak.authentication.authenticators.client
org.keycloak.authorization.admin
org.keycloak.authorization.common
org.keycloak.authorization.jpa.store
org.keycloak.authorization.store	Provides classes and a SPI to plug different metadata storage implementations.
org.keycloak.broker.oidc
org.keycloak.broker.provider
org.keycloak.client.clienttype
org.keycloak.crypto
org.keycloak.events
org.keycloak.exportimport.util
org.keycloak.forms.login.freemarker
org.keycloak.forms.login.freemarker.model
org.keycloak.jose.jws
org.keycloak.keys.loader
org.keycloak.migration.migrators
org.keycloak.models
org.keycloak.models.cache.infinispan
org.keycloak.models.cache.infinispan.authorization
org.keycloak.models.cache.infinispan.entities
org.keycloak.models.cache.infinispan.events
org.keycloak.models.delegate
org.keycloak.models.jpa
org.keycloak.models.jpa.session
org.keycloak.models.session
org.keycloak.models.sessions.infinispan
org.keycloak.models.sessions.infinispan.changes
org.keycloak.models.sessions.infinispan.util
org.keycloak.models.utils
org.keycloak.protocol
org.keycloak.protocol.docker
org.keycloak.protocol.docker.installation
org.keycloak.protocol.oidc
org.keycloak.protocol.oidc.endpoints
org.keycloak.protocol.oidc.endpoints.request
org.keycloak.protocol.oidc.grants
org.keycloak.protocol.oidc.grants.ciba
org.keycloak.protocol.oidc.grants.ciba.channel
org.keycloak.protocol.oidc.grants.ciba.endpoints
org.keycloak.protocol.oidc.grants.ciba.endpoints.request
org.keycloak.protocol.oidc.grants.device
org.keycloak.protocol.oidc.grants.device.endpoints
org.keycloak.protocol.oidc.installation
org.keycloak.protocol.oidc.par.endpoints
org.keycloak.protocol.oidc.par.endpoints.request
org.keycloak.protocol.oidc.rar.parsers
org.keycloak.protocol.oidc.utils
org.keycloak.protocol.saml
org.keycloak.protocol.saml.installation
org.keycloak.services
org.keycloak.services.clientpolicy.context
org.keycloak.services.clientpolicy.executor
org.keycloak.services.clientregistration
org.keycloak.services.clientregistration.policy
org.keycloak.services.clientregistration.policy.impl
org.keycloak.services.clienttype
org.keycloak.services.clienttype.impl
org.keycloak.services.cors
org.keycloak.services.managers
org.keycloak.services.resources
org.keycloak.services.resources.account
org.keycloak.services.resources.admin
org.keycloak.services.resources.admin.permissions
org.keycloak.services.util
org.keycloak.sessions
org.keycloak.social.twitter
org.keycloak.storage
org.keycloak.storage.adapter
org.keycloak.storage.client
org.keycloak.storage.datastore
org.keycloak.storage.federated
org.keycloak.storage.jpa
org.keycloak.storage.ldap.mappers.membership.role
org.keycloak.storage.role
org.keycloak.validation

Uses of ClientModel in org.keycloak.authentication

Fields in org.keycloak.authentication declared as ClientModel

Modifier and Type	Field	Description
protected ClientModel	AuthenticationProcessor.client

Methods in org.keycloak.authentication that return ClientModel

Modifier and Type	Method	Description
ClientModel	AuthenticationProcessor.getClient()
ClientModel	AuthenticationProcessor.Result.getClient()
ClientModel	ClientAuthenticationFlowContext.getClient()	Current client attached to this flow.

Methods in org.keycloak.authentication with parameters of type ClientModel

Modifier and Type	Method	Description
Map<String,Object>	ClientAuthenticatorFactory.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 ClientModel

Modifier and Type	Method	Description
ClientModel	JWTClientValidator.getClient()

Methods in org.keycloak.authentication.authenticators.client with parameters of type ClientModel

Modifier and Type	Method	Description
Map<String,Object>	ClientIdAndSecretAuthenticator.getAdapterConfiguration(ClientModel client)
Map<String,Object>	JWTClientAuthenticator.getAdapterConfiguration(ClientModel client)
Map<String,Object>	JWTClientSecretAuthenticator.getAdapterConfiguration(ClientModel client)
Map<String,Object>	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 ClientModel

Modifier	Constructor	Description
	AuthorizationService(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 ClientModel

Modifier and Type	Field	Description
protected ClientModel	ClientModelIdentity.client

Constructors in org.keycloak.authorization.common with parameters of type ClientModel

Modifier	Constructor	Description
	ClientModelIdentity(KeycloakSession session, ClientModel client)

Uses of ClientModel in org.keycloak.authorization.jpa.store

Methods in org.keycloak.authorization.jpa.store with parameters of type ClientModel

Modifier and Type	Method	Description
ResourceServer	JPAResourceServerStore.create(ClientModel client)
void	JPAResourceServerStore.delete(ClientModel client)
ResourceServer	JPAResourceServerStore.findByClient(ClientModel client)

Uses of ClientModel in org.keycloak.authorization.store

Methods in org.keycloak.authorization.store with parameters of type ClientModel

Modifier and Type	Method	Description
ResourceServer	ResourceServerStore.create(ClientModel client)	Creates a ResourceServer instance backed by this persistent storage implementation.
void	ResourceServerStore.delete(ClientModel client)	Removes a ResourceServer instance, with the given client from the persistent storage.
ResourceServer	ResourceServerStore.findByClient(ClientModel client)	Returns a ResourceServer instance based on a client.

Uses of ClientModel in org.keycloak.broker.oidc

Methods in org.keycloak.broker.oidc with parameters of type ClientModel

Modifier and Type	Method	Description
jakarta.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 ClientModel

Modifier and Type	Method	Description
protected 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.client.clienttype

Methods in org.keycloak.client.clienttype that return ClientModel

Modifier and Type	Method	Description
ClientModel	ClientTypeManager.augmentClient(ClientModel client)

Methods in org.keycloak.client.clienttype with parameters of type ClientModel

Modifier and Type	Method	Description
ClientModel	ClientTypeManager.augmentClient(ClientModel client)
void	ClientType.onUpdate(ClientModel currentClient, ClientRepresentation clientToUpdate)

Uses of ClientModel in org.keycloak.crypto

Methods in org.keycloak.crypto with parameters of type ClientModel

Modifier and Type	Method	Description
SignatureVerifierContext	AsymmetricClientSignatureVerifierProvider.verifier(ClientModel client, JWSInput input)
SignatureVerifierContext	ClientSignatureVerifierProvider.verifier(ClientModel client, JWSInput input)
SignatureVerifierContext	ECDSAClientSignatureVerifierProvider.verifier(ClientModel client, JWSInput input)
SignatureVerifierContext	EdDSAClientSignatureVerifierProvider.verifier(ClientModel client, JWSInput input)
SignatureVerifierContext	MacSecretClientSignatureVerifierProvider.verifier(ClientModel client, JWSInput input)

Constructors in org.keycloak.crypto with parameters of type ClientModel

Modifier	Constructor	Description
	ClientAsymmetricSignatureVerifierContext(KeycloakSession session, ClientModel client, JWSInput input)
	ClientECDSASignatureVerifierContext(KeycloakSession session, ClientModel client, JWSInput input)
	ClientEdDSASignatureVerifierContext(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

Modifier and Type	Method	Description
EventBuilder	EventBuilder.client(ClientModel client)

Uses of ClientModel in org.keycloak.exportimport.util

Methods in org.keycloak.exportimport.util with parameters of type ClientModel

Modifier and Type	Method	Description
static 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

Modifier and Type	Field	Description
protected ClientModel	FreeMarkerLoginFormsProvider.client

Uses of ClientModel in org.keycloak.forms.login.freemarker.model

Fields in org.keycloak.forms.login.freemarker.model declared as ClientModel

Modifier and Type	Field	Description
protected ClientModel	ClientBean.client

Constructors in org.keycloak.forms.login.freemarker.model with parameters of type ClientModel

Modifier	Constructor	Description
	ClientBean(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 ClientModel

Modifier and Type	Method	Description
<T> T	DefaultTokenManager.decodeClientJWT(String jwt, ClientModel client, BiConsumer<JOSE,ClientModel> jwtValidator, Class<T> clazz)
LogoutToken	DefaultTokenManager.initLogoutToken(ClientModel client, UserModel user, AuthenticatedClientSessionModel clientSession)

Method parameters in org.keycloak.jose.jws with type arguments of type ClientModel

Modifier and Type	Method	Description
<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 ClientModel

Modifier and Type	Method	Description
static 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 ClientModel

Modifier	Constructor	Description
	ClientPublicKeyLoader(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 ClientModel

Modifier and Type	Method	Description
void	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 ClientModel

Modifier and Type	Field	Description
protected ClientModel	ClientConfigResolver.client

Fields in org.keycloak.models with type parameters of type ClientModel

Modifier and Type	Field	Description
static final BiConsumer<JOSE,ClientModel>	TokenManager.DEFAULT_VALIDATOR

Methods in org.keycloak.models that return ClientModel

Modifier and Type	Method	Description
default ClientModel	ClientProvider.addClient(RealmModel realm, String clientId)	Adds a client with given clientId to the given realm.
ClientModel	ClientProvider.addClient(RealmModel realm, String id, String clientId)	Adds a client with given internal ID and clientId to the given realm.
ClientModel	RealmModel.addClient(String name)
ClientModel	RealmModel.addClient(String id, String clientId)
ClientModel	ClientModel.ClientProtocolUpdatedEvent.getClient()
ClientModel	ClientModel.ClientRemovedEvent.getClient()
ClientModel	KeycloakContext.getClient()
ClientModel	UserConsentModel.getClient()
ClientModel	RealmModel.getClientByClientId(String clientId)
ClientModel	RealmModel.getClientById(String id)
ClientModel	ClientModel.ClientCreationEvent.getCreatedClient()
ClientModel	RealmModel.getMasterAdminClient()
ClientModel	ClientModel.ClientIdChangeEvent.getUpdatedClient()
ClientModel	ClientModel.ClientUpdatedEvent.getUpdatedClient()

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

Modifier and Type	Method	Description
Map<ClientModel,Set<String>>	ClientProvider.getAllRedirectUrisOfEnabledClients(RealmModel realm)	Deprecated. Do not use, this is only to support a deprecated logout endpoint and will vanish with it's removal
Stream<ClientModel>	ClientProvider.getAlwaysDisplayInConsoleClientsStream(RealmModel realm)	Returns a stream of clients that are expected to always show up in account console.
Stream<ClientModel>	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.
Stream<ClientModel>	ClientProvider.getClientsStream(RealmModel realm, Integer firstResult, Integer maxResults)	Returns the clients of the given realm as a stream.
Stream<ClientModel>	RealmModel.getClientsStream()	Returns clients as a stream.
Stream<ClientModel>	RealmModel.getClientsStream(Integer firstResult, Integer maxResults)	Returns clients as a stream.
Stream<ClientModel>	RealmModel.searchClientByAttributes(Map<String,String> attributes, Integer firstResult, Integer maxResults)
Stream<ClientModel>	RealmModel.searchClientByAuthenticationFlowBindingOverrides(Map<String,String> overrides, Integer firstResult, Integer maxResults)
Stream<ClientModel>	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 ClientModel

Modifier and Type	Method	Description
default RoleModel	RoleProvider.addClientRole(ClientModel client, String name)	Adds a client role with given name to the given client.
RoleModel	RoleProvider.addClientRole(ClientModel client, String id, String name)	Adds a client role with given internal ID and name 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)
AuthenticatedClientSessionModel	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)
Algorithm	CibaConfig.getBackchannelAuthRequestSigningAlg(ClientModel client)
String	CibaConfig.getBackchannelClientNotificationEndpoint(ClientModel client)
String	CibaConfig.getBackchannelTokenDeliveryMode(ClientModel client)
Stream<RoleModel>	RoleMapperModel.getClientRoleMappingsStream(ClientModel app)	Returns stream of client roles that are directly set to this object for the given client.
default Stream<RoleModel>	RoleProvider.getClientRolesStream(ClientModel client)	Returns all the client roles of the given client.
Stream<RoleModel>	RoleProvider.getClientRolesStream(ClientModel client, Integer first, Integer max)	Returns the client roles of the given client.
AuthenticatedClientSessionModel	UserSessionProvider.getClientSession(UserSessionModel userSession, ClientModel client, String clientSessionId, boolean offline)
default AuthenticatedClientSessionModel	UserSessionProvider.getClientSession(UserSessionModel userSession, ClientModel client, UUID clientSessionId, boolean offline)	Deprecated. Use UserSessionProvider.getClientSession(UserSessionModel, ClientModel, String, boolean) instead.
int	OAuth2DeviceConfig.getLifespan(ClientModel client)
long	UserSessionProvider.getOfflineSessionsCount(RealmModel realm, ClientModel client)
Stream<UserSessionModel>	UserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)	Obtains the offline user sessions associated with the specified client, starting from the firstResult and containing at most maxResults.
int	OAuth2DeviceConfig.getPoolingInterval(ClientModel client)
UserModel	UserProvider.getServiceAccount(ClientModel client)	Return a UserModel representing service account of the client
Stream<UserSessionModel>	UserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client)	Obtains the online user sessions associated with the specified client.
Stream<UserSessionModel>	UserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)	Obtains the online user sessions associated with the specified client, starting from the firstResult and containing at most maxResults.
LogoutToken	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 ClientModel

Modifier and Type	Method	Description
<T> T	TokenManager.decodeClientJWT(String token, ClientModel client, BiConsumer<JOSE,ClientModel> jwtValidator, Class<T> clazz)

Constructors in org.keycloak.models with parameters of type ClientModel

Modifier	Constructor	Description
	ClientConfigResolver(ClientModel client)
	UserConsentModel(ClientModel client)

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

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

Modifier and Type	Class	Description
class	ClientAdapter

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

Modifier and Type	Field	Description
protected ClientModel	ClientAdapter.updated

Fields in org.keycloak.models.cache.infinispan with type parameters of type ClientModel

Modifier and Type	Field	Description
protected Map<String,ClientModel>	RealmCacheSession.managedApplications

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

Modifier and Type	Method	Description
ClientModel	RealmAdapter.addClient(String name)
ClientModel	RealmAdapter.addClient(String id, String clientId)
ClientModel	RealmCacheSession.addClient(RealmModel realm, String clientId)
ClientModel	RealmCacheSession.addClient(RealmModel realm, String id, String clientId)
protected ClientModel	RealmCacheSession.cacheClient(RealmModel realm, ClientModel delegate, Long revision)
ClientModel	RealmAdapter.getClientByClientId(String clientId)
ClientModel	RealmCacheSession.getClientByClientId(RealmModel realm, String clientId)
ClientModel	RealmAdapter.getClientById(String id)
ClientModel	RealmCacheSession.getClientById(RealmModel realm, String id)
ClientModel	RealmAdapter.getMasterAdminClient()
protected ClientModel	RealmCacheSession.validateCache(RealmModel realm, CachedClient cached)

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

Modifier and Type	Method	Description
Map<ClientModel,Set<String>>	RealmCacheSession.getAllRedirectUrisOfEnabledClients(RealmModel realm)
Stream<ClientModel>	RealmAdapter.getAlwaysDisplayInConsoleClientsStream()
Stream<ClientModel>	RealmCacheSession.getAlwaysDisplayInConsoleClientsStream(RealmModel realm)
Stream<ClientModel>	RealmAdapter.getClientsStream()
Stream<ClientModel>	RealmAdapter.getClientsStream(Integer firstResult, Integer maxResults)
Stream<ClientModel>	RealmCacheSession.getClientsStream(RealmModel realm)
Stream<ClientModel>	RealmCacheSession.getClientsStream(RealmModel realm, Integer firstResult, Integer maxResults)
Stream<ClientModel>	RealmAdapter.searchClientByAttributes(Map<String,String> attributes, Integer firstResult, Integer maxResults)
Stream<ClientModel>	RealmAdapter.searchClientByAuthenticationFlowBindingOverrides(Map<String,String> overrides, Integer firstResult, Integer maxResults)
Stream<ClientModel>	RealmAdapter.searchClientByClientIdStream(String clientId, Integer firstResult, Integer maxResults)
Stream<ClientModel>	RealmCacheSession.searchClientsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
Stream<ClientModel>	RealmCacheSession.searchClientsByAuthenticationFlowBindingOverrides(RealmModel realm, Map<String,String> overrides, Integer firstResult, Integer maxResults)
Stream<ClientModel>	RealmCacheSession.searchClientsByClientIdStream(RealmModel realm, String clientId, Integer firstResult, Integer maxResults)

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

Modifier and Type	Method	Description
RoleModel	RealmCacheSession.addClientRole(ClientModel client, String name)
RoleModel	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)
UserModel	UserCacheSession.findServiceAccount(ClientModel client)
RoleModel	RealmCacheSession.getClientRole(ClientModel client, String name)
Stream<RoleModel>	GroupAdapter.getClientRoleMappingsStream(ClientModel app)
Stream<RoleModel>	UserAdapter.getClientRoleMappingsStream(ClientModel app)
Stream<RoleModel>	RealmCacheSession.getClientRolesStream(ClientModel client)
Stream<RoleModel>	RealmCacheSession.getClientRolesStream(ClientModel client, Integer first, Integer max)
Map<String,ClientScopeModel>	RealmCacheSession.getClientScopes(RealmModel realm, ClientModel client, boolean defaultScopes)
UserModel	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)
Stream<RoleModel>	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 ClientModel

Modifier and Type	Method	Description
ResourceServer	StoreFactoryCacheSession.ResourceServerCache.create(ClientModel client)
void	StoreFactoryCacheSession.ResourceServerCache.delete(ClientModel client)
ResourceServer	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

Modifier	Constructor	Description
	CachedClient(Long revision, RealmModel realm, ClientModel model)

Uses of ClientModel in org.keycloak.models.cache.infinispan.events

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

Modifier and Type	Method	Description
static ClientRemovedEvent	ClientRemovedEvent.create(ClientModel client)

Uses of ClientModel in org.keycloak.models.delegate

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

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

Constructor parameters in org.keycloak.models.delegate with type arguments of type ClientModel

Modifier	Constructor	Description
	ClientModelLazyDelegate(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 ClientModel

Modifier and Type	Class	Description
class	ClientAdapter

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

Modifier and Type	Method	Description
ClientModel	JpaRealmProvider.addClient(RealmModel realm, String clientId)
ClientModel	JpaRealmProvider.addClient(RealmModel realm, String id, String clientId)
ClientModel	RealmAdapter.addClient(String name)
ClientModel	RealmAdapter.addClient(String id, String clientId)
ClientModel	JpaRealmProvider.getClientByClientId(RealmModel realm, String clientId)
ClientModel	RealmAdapter.getClientByClientId(String clientId)
ClientModel	JpaRealmProvider.getClientById(RealmModel realm, String id)
ClientModel	RealmAdapter.getClientById(String id)
ClientModel	RealmAdapter.getMasterAdminClient()

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

Modifier and Type	Method	Description
Map<ClientModel,Set<String>>	JpaRealmProvider.getAllRedirectUrisOfEnabledClients(RealmModel realm)
Stream<ClientModel>	JpaRealmProvider.getAlwaysDisplayInConsoleClientsStream(RealmModel realm)
Stream<ClientModel>	RealmAdapter.getAlwaysDisplayInConsoleClientsStream()
Stream<ClientModel>	JpaRealmProvider.getClientsStream(RealmModel realm)
Stream<ClientModel>	JpaRealmProvider.getClientsStream(RealmModel realm, Integer firstResult, Integer maxResults)
Stream<ClientModel>	RealmAdapter.getClientsStream()
Stream<ClientModel>	RealmAdapter.getClientsStream(Integer firstResult, Integer maxResults)
Stream<ClientModel>	RealmAdapter.searchClientByAttributes(Map<String,String> attributes, Integer firstResult, Integer maxResults)
Stream<ClientModel>	RealmAdapter.searchClientByAuthenticationFlowBindingOverrides(Map<String,String> overrides, Integer firstResult, Integer maxResults)
Stream<ClientModel>	RealmAdapter.searchClientByClientIdStream(String clientId, Integer firstResult, Integer maxResults)
Stream<ClientModel>	JpaRealmProvider.searchClientsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
Stream<ClientModel>	JpaRealmProvider.searchClientsByAuthenticationFlowBindingOverrides(RealmModel realm, Map<String,String> overrides, Integer firstResult, Integer maxResults)
Stream<ClientModel>	JpaRealmProvider.searchClientsByClientIdStream(RealmModel realm, String clientId, Integer firstResult, Integer maxResults)

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

Modifier and Type	Method	Description
RoleModel	JpaRealmProvider.addClientRole(ClientModel client, String name)
RoleModel	JpaRealmProvider.addClientRole(ClientModel client, String id, String name)
void	JpaRealmProvider.addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope)
RoleModel	JpaRealmProvider.getClientRole(ClientModel client, String name)
Stream<RoleModel>	GroupAdapter.getClientRoleMappingsStream(ClientModel app)
Stream<RoleModel>	UserAdapter.getClientRoleMappingsStream(ClientModel app)
Stream<RoleModel>	JpaRealmProvider.getClientRolesStream(ClientModel client, Integer first, Integer max)
Map<String,ClientScopeModel>	JpaRealmProvider.getClientScopes(RealmModel realm, ClientModel client, boolean defaultScope)
UserModel	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)
Stream<RoleModel>	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 ClientModel

Modifier and Type	Method	Description
int	JpaUserSessionPersisterProvider.getUserSessionsCount(RealmModel realm, ClientModel clientModel, boolean offline)
AuthenticatedClientSessionModel	JpaUserSessionPersisterProvider.loadClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline)
Stream<UserSessionModel>	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 ClientModel

Modifier and Type	Method	Description
ClientModel	PersistentAuthenticatedClientSessionAdapter.getClient()

Methods in org.keycloak.models.session with parameters of type ClientModel

Modifier and Type	Method	Description
int	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 client
AuthenticatedClientSessionModel	DisabledUserSessionPersisterProvider.loadClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline)
AuthenticatedClientSessionModel	UserSessionPersisterProvider.loadClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline)	Loads client session from the db by provided user session and client.
Stream<UserSessionModel>	DisabledUserSessionPersisterProvider.loadUserSessionsStream(RealmModel realm, ClientModel client, boolean offline, Integer firstResult, Integer maxResults)
Stream<UserSessionModel>	UserSessionPersisterProvider.loadUserSessionsStream(RealmModel realm, ClientModel client, boolean offline, Integer firstResult, Integer maxResults)	Loads the user sessions for the given ClientModel in the given RealmModel 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 ClientModel

Modifier	Constructor	Description
	PersistentAuthenticatedClientSessionAdapter(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 ClientModel

Modifier and Type	Method	Description
ClientModel	AuthenticatedClientSessionAdapter.getClient()
ClientModel	AuthenticationSessionAdapter.getClient()

Methods in org.keycloak.models.sessions.infinispan with parameters of type ClientModel

Modifier and Type	Method	Description
Long	SessionFunction.apply(RealmModel realm, ClientModel client, V entity)
AuthenticationSessionModel	RootAuthenticationSessionAdapter.createAuthenticationSession(ClientModel client)
AuthenticatedClientSessionModel	InfinispanUserSessionProvider.createClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession)
protected Long	InfinispanUserSessionProviderFactory.deriveOfflineClientSessionCacheEntryLifespanOverrideMs(RealmModel realm, ClientModel client, AuthenticatedClientSessionEntity entity)
protected Long	InfinispanUserSessionProviderFactory.deriveOfflineSessionCacheEntryLifespanMs(RealmModel realm, ClientModel client, UserSessionEntity entity)
long	InfinispanUserSessionProvider.getActiveUserSessions(RealmModel realm, ClientModel client)
AuthenticationSessionModel	RootAuthenticationSessionAdapter.getAuthenticationSession(ClientModel client, String tabId)
AuthenticatedClientSessionAdapter	InfinispanUserSessionProvider.getClientSession(UserSessionModel userSession, ClientModel client, String clientSessionId, boolean offline)
long	InfinispanUserSessionProvider.getOfflineSessionsCount(RealmModel realm, ClientModel client)
Stream<UserSessionModel>	InfinispanUserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, ClientModel client, Integer first, Integer max)
protected long	InfinispanUserSessionProvider.getUserSessionsCount(RealmModel realm, ClientModel client, boolean offline)
Stream<UserSessionModel>	InfinispanUserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client)
Stream<UserSessionModel>	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 ClientModel

Modifier	Constructor	Description
	AuthenticatedClientSessionAdapter(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

Modifier and Type	Method	Description
ClientModel	SessionEntityWrapper.getClientIfNeeded(RealmModel realm)

Uses of ClientModel in org.keycloak.models.sessions.infinispan.util

Methods in org.keycloak.models.sessions.infinispan.util with parameters of type ClientModel

Modifier and Type	Method	Description
static 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 ClientModel

Modifier and Type	Method	Description
static 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 ClientModel

Modifier and Type	Method	Description
static 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)
Stream<RoleModel>	UserModelDelegate.getClientRoleMappingsStream(ClientModel app)
static Stream<RoleModel>	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)
static void	RepresentationToModel.updateClientScopes(ClientRepresentation resourceRep, ClientModel client)

Uses of ClientModel in org.keycloak.protocol

Methods in org.keycloak.protocol with parameters of type ClientModel

Modifier and Type	Method	Description
protected 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 ClientModel

Modifier and Type	Method	Description
protected 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 ClientModel

Modifier and Type	Method	Description
protected 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 ClientModel

Modifier and Type	Method	Description
jakarta.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 ClientModel

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

Fields in org.keycloak.protocol.oidc declared as ClientModel

Modifier and Type	Field	Description
protected final ClientModel	AbstractClientConfigWrapper.clientModel

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

Modifier and Type	Method	Description
ClientModel	TokenExchangeContext.getClient()

Methods in org.keycloak.protocol.oidc with parameters of type ClientModel

Modifier and Type	Method	Description
void	FrontChannelLogoutHandler.addClient(ClientModel client)
protected void	OIDCLoginProtocolFactory.addDefaults(ClientModel client)
AccessToken	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)
static OIDCClientSecretConfigWrapper	OIDCClientSecretConfigWrapper.fromClientModel(ClientModel client)
static Set<RoleModel>	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 parameter
protected 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 correctly
TokenManager.AccessTokenResponseBuilder	TokenManager.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, String scopeParameter)
TokenManager.AccessTokenResponseBuilder	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)
RefreshToken	TokenManager.verifyRefreshToken(KeycloakSession session, RealmModel realm, ClientModel client, HttpRequest request, String encodedRefreshToken, boolean checkExpiration)

Constructors in org.keycloak.protocol.oidc with parameters of type ClientModel

Modifier	Constructor	Description
protected	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, Cors 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

Modifier and Type	Method	Description
AuthorizationEndpointChecker	AuthorizationEndpointChecker.client(ClientModel client)

Uses of ClientModel in org.keycloak.protocol.oidc.endpoints.request

Methods in org.keycloak.protocol.oidc.endpoints.request with parameters of type ClientModel

Modifier and Type	Method	Description
static 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 ClientModel

Modifier	Constructor	Description
	AuthzEndpointRequestObjectParser(KeycloakSession session, String requestObject, ClientModel client)

Uses of ClientModel in org.keycloak.protocol.oidc.grants

Fields in org.keycloak.protocol.oidc.grants declared as ClientModel

Modifier and Type	Field	Description
protected ClientModel	OAuth2GrantType.Context.client
protected ClientModel	OAuth2GrantTypeBase.client

Methods in org.keycloak.protocol.oidc.grants with parameters of type ClientModel

Modifier and Type	Method	Description
void	OAuth2GrantType.Context.setClient(ClientModel client)

Uses of ClientModel in org.keycloak.protocol.oidc.grants.ciba

Constructor parameters in org.keycloak.protocol.oidc.grants.ciba with type arguments of type ClientModel

Modifier	Constructor	Description
	CibaClientValidation(ValidationContext<ClientModel> context)

Uses of ClientModel in org.keycloak.protocol.oidc.grants.ciba.channel

Fields in org.keycloak.protocol.oidc.grants.ciba.channel declared as ClientModel

Modifier and Type	Field	Description
protected ClientModel	CIBAAuthenticationRequest.client

Methods in org.keycloak.protocol.oidc.grants.ciba.channel that return ClientModel

Modifier and Type	Method	Description
ClientModel	CIBAAuthenticationRequest.getClient()

Methods in org.keycloak.protocol.oidc.grants.ciba.channel with parameters of type ClientModel

Modifier and Type	Method	Description
void	CIBAAuthenticationRequest.setClient(ClientModel client)

Constructors in org.keycloak.protocol.oidc.grants.ciba.channel with parameters of type ClientModel

Modifier	Constructor	Description
	CIBAAuthenticationRequest(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 ClientModel

Modifier and Type	Method	Description
protected ClientModel	AbstractCibaEndpoint.authenticateClient()

Methods in org.keycloak.protocol.oidc.grants.ciba.endpoints with parameters of type ClientModel

Modifier and Type	Method	Description
protected 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 ClientModel

Modifier and Type	Method	Description
static BackchannelAuthenticationEndpointRequest	BackchannelAuthenticationEndpointRequestParserProcessor.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 ClientModel

Modifier and Type	Method	Description
static OAuth2DeviceCodeModel	DeviceGrantType.getDeviceByDeviceCode(KeycloakSession session, RealmModel realm, ClientModel client, EventBuilder event, String deviceCode)

Uses of ClientModel in org.keycloak.protocol.oidc.grants.device.endpoints

Methods in org.keycloak.protocol.oidc.grants.device.endpoints with parameters of type ClientModel

Modifier and Type	Method	Description
protected 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 ClientModel

Modifier and Type	Method	Description
jakarta.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)
static Map<String,Object>	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

Modifier and Type	Field	Description
protected ClientModel	AbstractParEndpoint.client

Uses of ClientModel in org.keycloak.protocol.oidc.par.endpoints.request

Methods in org.keycloak.protocol.oidc.par.endpoints.request with parameters of type ClientModel

Modifier and Type	Method	Description
static 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 ClientModel

Modifier	Constructor	Description
	AuthzEndpointParParser(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

Modifier	Constructor	Description
	ClientScopeAuthorizationRequestParser(ClientModel client)

Uses of ClientModel in org.keycloak.protocol.oidc.utils

Methods in org.keycloak.protocol.oidc.utils that return ClientModel

Modifier and Type	Method	Description
ClientModel	AuthorizeClientUtil.ClientAuthResult.getClient()

Methods in org.keycloak.protocol.oidc.utils with parameters of type ClientModel

Modifier and Type	Method	Description
static Map<String,Integer>	AcrUtils.getAcrLoaMap(ClientModel client)
static List<String>	AcrUtils.getAcrValues(String claimsParam, String acrValuesParam, ClientModel client)
static List<String>	AcrUtils.getDefaultAcrValues(ClientModel client)
static Set<String>	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 ClientModel

Modifier and Type	Method	Description
ClientModel	ArtifactResolver.selectSourceClient(KeycloakSession session, String artifact)	Returns client model that issued artifact
ClientModel	DefaultSamlArtifactResolver.selectSourceClient(KeycloakSession session, String artifact)

Methods in org.keycloak.protocol.saml with parameters of type ClientModel

Modifier and Type	Method	Description
protected 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)
AuthenticationSessionModel	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

Modifier	Constructor	Description
	SamlClient(ClientModel client)

Uses of ClientModel in org.keycloak.protocol.saml.installation

Methods in org.keycloak.protocol.saml.installation with parameters of type ClientModel

Modifier and Type	Method	Description
static 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 ClientModel

Modifier and Type	Method	Description
ClientModel	DefaultKeycloakContext.getClient()

Methods in org.keycloak.services with parameters of type ClientModel

Modifier and Type	Method	Description
void	DefaultKeycloakContext.setClient(ClientModel client)

Uses of ClientModel in org.keycloak.services.clientpolicy.context

Methods in org.keycloak.services.clientpolicy.context that return ClientModel

Modifier and Type	Method	Description
default ClientModel	ClientCRUDContext.getAuthenticatedClient()	returns UserModel of the authenticated client.
ClientModel	AdminClientRegisteredContext.getTargetClient()
ClientModel	AdminClientUnregisterContext.getTargetClient()
ClientModel	AdminClientUpdateContext.getTargetClient()
ClientModel	AdminClientUpdatedContext.getTargetClient()
ClientModel	AdminClientViewContext.getTargetClient()
default ClientModel	ClientCRUDContext.getTargetClient()	returns ClientModel of the existing client to be updated/read/updated/deleted.
ClientModel	DynamicClientRegisteredContext.getTargetClient()
ClientModel	DynamicClientUnregisterContext.getTargetClient()
ClientModel	DynamicClientUpdateContext.getTargetClient()
ClientModel	DynamicClientUpdatedContext.getTargetClient()
ClientModel	DynamicClientViewContext.getTargetClient()

Constructors in org.keycloak.services.clientpolicy.context with parameters of type ClientModel

Modifier	Constructor	Description
	AdminClientRegisteredContext(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 ClientModel

Modifier and Type	Method	Description
void	ConsentRequiredExecutor.beforeUpdate(ClientModel clientToBeUpdated, ClientRepresentation proposedClient)

Uses of ClientModel in org.keycloak.services.clientregistration

Methods in org.keycloak.services.clientregistration with parameters of type ClientModel

Modifier and Type	Method	Description
ClientRepresentation	AbstractClientRegistrationProvider.get(ClientModel client)
void	ClientRegistrationAuth.requireDelete(ClientModel client)
RegistrationAuth	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 ClientModel

Modifier and Type	Method	Description
void	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 ClientModel

Modifier and Type	Method	Description
void	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.clienttype

Methods in org.keycloak.services.clienttype that return ClientModel

Modifier and Type	Method	Description
ClientModel	DefaultClientTypeManager.augmentClient(ClientModel client)

Methods in org.keycloak.services.clienttype with parameters of type ClientModel

Modifier and Type	Method	Description
ClientModel	DefaultClientTypeManager.augmentClient(ClientModel client)

Uses of ClientModel in org.keycloak.services.clienttype.impl

Methods in org.keycloak.services.clienttype.impl with parameters of type ClientModel

Modifier and Type	Method	Description
void	DefaultClientType.onUpdate(ClientModel currentClient, ClientRepresentation newClient)

Uses of ClientModel in org.keycloak.services.cors

Methods in org.keycloak.services.cors with parameters of type ClientModel

Modifier and Type	Method	Description
Cors	Cors.allowedOrigins(KeycloakSession session, ClientModel client)
Cors	DefaultCors.allowedOrigins(KeycloakSession session, ClientModel client)

Uses of ClientModel in org.keycloak.services.managers

Methods in org.keycloak.services.managers that return ClientModel

Modifier and Type	Method	Description
static ClientModel	ClientManager.createClient(KeycloakSession session, RealmModel realm, ClientRepresentation rep)	Should not be called from an import.
ClientModel	Auth.getClient()
ClientModel	AuthenticationManager.AuthResult.getClient()

Methods in org.keycloak.services.managers that return types with arguments of type ClientModel

Modifier and Type	Method	Description
Set<ClientModel>	UserSessionManager.findClientsWithOfflineToken(RealmModel realm, UserModel user)

Methods in org.keycloak.services.managers with parameters of type ClientModel

Modifier and Type	Method	Description
void	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 client
void	ClientManager.clientIdChanged(ClientModel client, ClientRepresentation newClientRepresentation)
void	ClientManager.enableServiceAccount(ClientModel client)
AuthenticationSessionModel	AuthenticationSessionManager.getAuthenticationSessionByIdAndClient(RealmModel realm, String authSessionId, ClientModel client, String tabId)
static String	ResourceAdminManager.getBackchannelLogoutUrl(KeycloakSession session, ClientModel client)
static <CLIENT_SESSION extends CommonClientSessionModel> CLIENT_SESSION	ClientSessionCode.getClientSession(String code, String tabId, KeycloakSession session, RealmModel realm, ClientModel client, EventBuilder event, Class<CLIENT_SESSION> sessionClass)
AuthenticationSessionModel	AuthenticationSessionManager.getCurrentAuthenticationSession(RealmModel realm, ClientModel client, String tabId)	Returns current authentication session if it exists, otherwise returns null.
static String	ResourceAdminManager.getManagementUrl(KeycloakSession session, ClientModel client)
boolean	Auth.hasClientRole(ClientModel app, String role)
boolean	Auth.hasOneOfAppRole(ClientModel app, String... roles)
GlobalRequestResult	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)
GlobalRequestResult	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 client
boolean	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)
GlobalRequestResult	ResourceAdminManager.testNodesAvailability(RealmModel realm, ClientModel client)
ClientManager.InstallationAdapterConfig	ClientManager.toInstallationRepresentation(RealmModel realmModel, ClientModel clientModel, URI baseUri)
String	ClientManager.toJBossSubsystemConfig(RealmModel realmModel, ClientModel clientModel, URI baseUri)
Set<String>	ClientManager.validateRegisteredNodes(ClientModel client)

Constructors in org.keycloak.services.managers with parameters of type ClientModel

Modifier	Constructor	Description
	Auth(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 ClientModel

Modifier and Type	Field	Description
protected final ClientModel	AbstractSecuredLocalService.client

Methods in org.keycloak.services.resources that return ClientModel

Modifier and Type	Method	Description
protected ClientModel	ClientsManagementService.authorizeClient()

Methods in org.keycloak.services.resources with parameters of type ClientModel

Modifier and Type	Method	Description
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's iss (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 ClientModel

Modifier	Constructor	Description
	AbstractSecuredLocalService(KeycloakSession session, ClientModel client)

Uses of ClientModel in org.keycloak.services.resources.account

Constructors in org.keycloak.services.resources.account with parameters of type ClientModel

Modifier	Constructor	Description
	AccountConsole(KeycloakSession session, ClientModel client, Theme theme)

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

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

Modifier and Type	Field	Description
protected 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 ClientModel

Modifier and Type	Method	Description
ClientModel	AdminAuth.getClient()

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

Modifier and Type	Method	Description
AdminEventBuilder	AdminEventBuilder.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)
static ManagementPermissionReference	ClientResource.toMgmtRef(ClientModel client, AdminPermissionManagement permissions)

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

Modifier	Constructor	Description
	AdminAuth(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 ClientModel

Modifier and Type	Method	Description
ClientModel	AdminPermissionManagement.getRealmManagementClient()

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

Modifier and Type	Method	Description
boolean	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)
Policy	ClientPermissionManagement.configurePermission(ClientModel client)
Policy	ClientPermissionManagement.exchangeToPermission(ClientModel client)
Map<String,Boolean>	ClientPermissionEvaluator.getAccess(ClientModel client)
Map<String,String>	ClientPermissionManagement.getPermissions(ClientModel client)
boolean	UserPermissionEvaluator.isImpersonatable(UserModel user, ClientModel requester)
boolean	ClientPermissionEvaluator.isPermissionsEnabled(ClientModel client)
boolean	ClientPermissionManagement.isPermissionsEnabled(ClientModel client)
Policy	ClientPermissionManagement.managePermission(ClientModel client)
Policy	ClientPermissionManagement.mapRolesClientScopePermission(ClientModel client)
Policy	ClientPermissionManagement.mapRolesCompositePermission(ClientModel client)
Policy	ClientPermissionManagement.mapRolesPermission(ClientModel client)
void	ClientPermissionEvaluator.requireConfigure(ClientModel client)
void	ClientPermissionEvaluator.requireManage(ClientModel client)
void	ClientPermissionEvaluator.requireView(ClientModel client)
Resource	ClientPermissionManagement.resource(ClientModel client)
ResourceServer	ClientPermissionManagement.resourceServer(ClientModel client)
void	ClientPermissionEvaluator.setPermissionsEnabled(ClientModel client, boolean enable)
void	ClientPermissionManagement.setPermissionsEnabled(ClientModel client, boolean enable)
Policy	ClientPermissionManagement.viewPermission(ClientModel client)

Uses of ClientModel in org.keycloak.services.util

Methods in org.keycloak.services.util with parameters of type ClientModel

Modifier and Type	Method	Description
static UserSessionModel	UserSessionUtil.findValidSession(KeycloakSession session, RealmModel realm, AccessToken token, EventBuilder event, ClientModel client)
static UserSessionModel	UserSessionUtil.findValidSession(KeycloakSession session, RealmModel realm, AccessToken token, EventBuilder event, ClientModel client, OAuth2Error error)
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 ClientModel

Modifier and Type	Method	Description
ClientModel	CommonClientSessionModel.getClient()

Methods in org.keycloak.sessions with parameters of type ClientModel

Modifier and Type	Method	Description
AuthenticationSessionModel	RootAuthenticationSessionModel.createAuthenticationSession(ClientModel client)	Create a new authentication session and returns it.
AuthenticationSessionModel	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 ClientModel

Modifier and Type	Method	Description
jakarta.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 ClientModel

Modifier and Type	Method	Description
ClientModel	ClientStorageManager.addClient(RealmModel realm, String clientId)
ClientModel	ClientStorageManager.addClient(RealmModel realm, String id, String clientId)
ClientModel	ClientStorageManager.getClientByClientId(RealmModel realm, String clientId)
ClientModel	ClientStorageManager.getClientById(RealmModel realm, String id)

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

Modifier and Type	Method	Description
Map<ClientModel,Set<String>>	ClientStorageManager.getAllRedirectUrisOfEnabledClients(RealmModel realm)
Stream<ClientModel>	ClientStorageManager.getAlwaysDisplayInConsoleClientsStream(RealmModel realm)
Stream<ClientModel>	ClientStorageManager.getClientsStream(RealmModel realm)
Stream<ClientModel>	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)
Stream<ClientModel>	ClientStorageManager.searchClientsByAttributes(RealmModel realm, Map<String,String> attributes, Integer firstResult, Integer maxResults)
Stream<ClientModel>	ClientStorageManager.searchClientsByAuthenticationFlowBindingOverrides(RealmModel realm, Map<String,String> overrides, Integer firstResult, Integer maxResults)
Stream<ClientModel>	ClientStorageManager.searchClientsByClientIdStream(RealmModel realm, String clientId, Integer firstResult, Integer maxResults)

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

Modifier and Type	Method	Description
RoleModel	RoleStorageManager.addClientRole(ClientModel client, String name)
RoleModel	RoleStorageManager.addClientRole(ClientModel client, String id, String name)
void	ClientStorageManager.addClientScopes(RealmModel realm, ClientModel client, Set<ClientScopeModel> clientScopes, boolean defaultScope)
RoleModel	RoleStorageManager.getClientRole(ClientModel client, String name)
Stream<RoleModel>	RoleStorageManager.getClientRolesStream(ClientModel client)
Stream<RoleModel>	RoleStorageManager.getClientRolesStream(ClientModel client, Integer first, Integer max)
Map<String,ClientScopeModel>	ClientStorageManager.getClientScopes(RealmModel realm, ClientModel client, boolean defaultScopes)
UserModel	UserStorageManager.getServiceAccount(ClientModel client)
static boolean	StorageId.isLocalStorage(ClientModel client)	Deprecated. Use StorageId.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. Use StorageId.providerId(String) instead.
Stream<RoleModel>	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 ClientModel

Modifier and Type	Method	Description
Set<RoleModel>	AbstractUserAdapter.getClientRoleMappings(ClientModel app)	Deprecated. Use AbstractUserAdapter.getClientRoleMappingsStream(ClientModel) instead
Set<RoleModel>	AbstractUserAdapter.Streams.getClientRoleMappings(ClientModel app)
Stream<RoleModel>	AbstractInMemoryUserAdapter.getClientRoleMappingsStream(ClientModel app)
Stream<RoleModel>	AbstractUserAdapter.getClientRoleMappingsStream(ClientModel app)
Stream<RoleModel>	AbstractUserAdapter.Streams.getClientRoleMappingsStream(ClientModel app)
Stream<RoleModel>	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 ClientModel

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

Methods in org.keycloak.storage.client that return ClientModel

Modifier and Type	Method	Description
ClientModel	ClientLookupProvider.getClientByClientId(RealmModel realm, String clientId)	Exact search for a client by its public client identifier.
ClientModel	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 ClientModel

Modifier and Type	Method	Description
Stream<ClientModel>	ClientLookupProvider.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)
Stream<ClientModel>	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 ClientModel

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

Uses of ClientModel in org.keycloak.storage.datastore

Methods in org.keycloak.storage.datastore with parameters of type ClientModel

Modifier and Type	Method	Description
static void	DefaultExportImportManager.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 ClientModel

Modifier and Type	Method	Description
void	UserFederatedStorageProvider.preRemove(RealmModel realm, ClientModel client)

Uses of ClientModel in org.keycloak.storage.jpa

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

Modifier and Type	Method	Description
void	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 ClientModel

Modifier and Type	Method	Description
Stream<RoleModel>	RoleLDAPStorageMapper.LDAPRoleMappingsUserDelegate.getClientRoleMappingsStream(ClientModel client)

Uses of ClientModel in org.keycloak.storage.role

Methods in org.keycloak.storage.role with parameters of type ClientModel

Modifier and Type	Method	Description
RoleModel	RoleLookupProvider.getClientRole(ClientModel client, String name)	Exact search for a client role by given name.
Stream<RoleModel>	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 ClientModel

Modifier and Type	Method	Description
static 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 ClientModel

Modifier and Type	Method	Description
ValidationResult	DefaultClientValidationProvider.validate(ValidationContext<ClientModel> context)

Constructors in org.keycloak.validation with parameters of type ClientModel

Modifier	Constructor	Description
	ClientValidationContext(ValidationContext.Event event, KeycloakSession session, ClientModel objectToValidate)
	OIDCContext(ValidationContext.Event event, KeycloakSession session, ClientModel objectToValidate, OIDCClientRepresentation oidcClient)