Uses of Interface
org.keycloak.models.ClientModel

Packages that use ClientModel

Package	Description
org.keycloak.models
org.keycloak.models.utils
org.keycloak.sessions
org.keycloak.storage
org.keycloak.storage.client
org.keycloak.storage.role

Uses of ClientModel in org.keycloak.models

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

Modifier and Type	Field	Description
static final SearchableModelField<ClientModel>	ClientModel.SearchableFields.ALWAYS_DISPLAY_IN_CONSOLE
static final SearchableModelField<ClientModel>	ClientModel.SearchableFields.ATTRIBUTE	Search for attribute value.
static final SearchableModelField<ClientModel>	ClientModel.SearchableFields.CLIENT_ID
static final BiConsumer<JOSE,ClientModel>	TokenManager.DEFAULT_VALIDATOR
static final SearchableModelField<ClientModel>	ClientModel.SearchableFields.ENABLED
static final SearchableModelField<ClientModel>	ClientModel.SearchableFields.ID
static final SearchableModelField<ClientModel>	ClientModel.SearchableFields.REALM_ID
static final SearchableModelField<ClientModel>	ClientModel.SearchableFields.SCOPE_MAPPING_ROLE

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.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.
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
	UserConsentModel(ClientModel client)

Uses of ClientModel in org.keycloak.models.utils

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

Modifier and Type	Method	Description
Stream<RoleModel>	UserModelDelegate.getClientRoleMappingsStream(ClientModel app)
static boolean	RoleUtils.isClientRole(RoleModel r, ClientModel c)

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.storage

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

Modifier and Type	Method	Description
static boolean	StorageId.isLocalStorage(ClientModel client)	Deprecated. Use StorageId.isLocalStorage(String) instead.
static String	StorageId.resolveProviderId(ClientModel client)	Deprecated. Use StorageId.providerId(String) instead.

Uses of ClientModel in org.keycloak.storage.client

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)
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.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.