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.adapter
org.keycloak.storage.client
org.keycloak.storage.federated

Uses of ClientModel in org.keycloak.models

Methods in org.keycloak.models that return ClientModel

Modifier and Type	Method and Description
default ClientModel	RealmProvider.addClient(RealmModel realm, String clientId) Deprecated. Use the corresponding method from ClientProvider.
default ClientModel	ClientProvider.addClient(RealmModel realm, String clientId) Adds a client with given clientId to the given realm.
ClientModel	RealmProvider.addClient(RealmModel realm, String id, String clientId) Deprecated. Use the corresponding method from ClientProvider.
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	KeycloakContext.getClient()
ClientModel	RealmModel.ClientRemovedEvent.getClient()
ClientModel	UserConsentModel.getClient()
ClientModel	RealmProvider.getClientByClientId(RealmModel realm, String clientId) Deprecated. Use the corresponding method from ClientProvider.
ClientModel	RealmModel.getClientByClientId(String clientId)
default ClientModel	RealmProvider.getClientByClientId(String clientId, RealmModel realm) Deprecated. Use the corresponding method from ClientProvider.
ClientModel	RealmProvider.getClientById(RealmModel realm, String id) Deprecated. Use the corresponding method from ClientProvider.
ClientModel	RealmModel.getClientById(String id)
default ClientModel	RealmProvider.getClientById(String id, RealmModel realm) Deprecated. Use the corresponding method from ClientProvider.
ClientModel	RealmModel.ClientCreationEvent.getCreatedClient()
ClientModel	RealmModel.getMasterAdminClient()
ClientModel	RealmModel.ClientUpdatedEvent.getUpdatedClient()

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

Modifier and Type	Method and Description
List<ClientModel>	RealmModel.getAlwaysDisplayInConsoleClients()
List<ClientModel>	RealmProvider.getAlwaysDisplayInConsoleClients(RealmModel realm) Deprecated. Use the corresponding method from ClientProvider.
List<ClientModel>	ClientProvider.getAlwaysDisplayInConsoleClients(RealmModel realm) Returns a list of clients that are expected to always show up in account console.
List<ClientModel>	RealmModel.getClients()
List<ClientModel>	RealmModel.getClients(Integer firstResult, Integer maxResults)
default List<ClientModel>	RealmProvider.getClients(RealmModel realm) Deprecated. Use the corresponding method from ClientProvider.
default List<ClientModel>	ClientProvider.getClients(RealmModel realm) Returns all the clients of the given realm.
List<ClientModel>	RealmProvider.getClients(RealmModel realm, Integer firstResult, Integer maxResults) Deprecated. Use the corresponding method from ClientProvider.
List<ClientModel>	ClientProvider.getClients(RealmModel realm, Integer firstResult, Integer maxResults) Returns the clients of the given realm.
List<ClientModel>	RealmModel.searchClientByClientId(String clientId, Integer firstResult, Integer maxResults)
List<ClientModel>	RealmProvider.searchClientsByClientId(RealmModel realm, String clientId, Integer firstResult, Integer maxResults) Deprecated. Use the corresponding method from ClientProvider.
default List<ClientModel>	RealmProvider.searchClientsByClientId(String clientId, Integer firstResult, Integer maxResults, RealmModel realm) Deprecated. Use the corresponding method from ClientProvider.

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

Modifier and Type	Method and Description
RoleModel	RealmProvider.addClientRole(RealmModel realm, ClientModel client, String name) TODO: To be @deprecated Use the corresponding method from ??RoleProvider.
RoleModel	RealmProvider.addClientRole(RealmModel realm, ClientModel client, String id, String name) TODO: To be @deprecated Use the corresponding method from ??RoleProvider.
AuthenticatedClientSessionModel	UserSessionProvider.createClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession)
<T> T	TokenManager.decodeClientJWT(String token, ClientModel client, Class<T> clazz)
long	UserSessionProvider.getActiveUserSessions(RealmModel realm, ClientModel client)
RoleModel	RealmProvider.getClientRole(RealmModel realm, ClientModel client, String name) TODO: To be @deprecated Use the corresponding method from ??RoleProvider.
Set<RoleModel>	RoleMapperModel.getClientRoleMappings(ClientModel app) Returns set of client roles that are directly set to this object for the given client.
Set<RoleModel>	RealmProvider.getClientRoles(RealmModel realm, ClientModel client) TODO: To be @deprecated Use the corresponding method from ??RoleProvider.
Set<RoleModel>	RealmProvider.getClientRoles(RealmModel realm, ClientModel client, Integer first, Integer max)
AuthenticatedClientSessionModel	UserSessionProvider.getClientSession(UserSessionModel userSession, ClientModel client, UUID clientSessionId, boolean offline)
long	UserSessionProvider.getOfflineSessionsCount(RealmModel realm, ClientModel client)
List<UserSessionModel>	UserSessionProvider.getOfflineUserSessions(RealmModel realm, ClientModel client, int first, int max)
UserModel	UserProvider.getServiceAccount(ClientModel client)
List<UserSessionModel>	UserSessionProvider.getUserSessions(RealmModel realm, ClientModel client)
List<UserSessionModel>	UserSessionProvider.getUserSessions(RealmModel realm, ClientModel client, int firstResult, int maxResults)
void	UserSessionProvider.onClientRemoved(RealmModel realm, ClientModel client)
void	UserProvider.preRemove(RealmModel realm, ClientModel client)
Set<RoleModel>	RealmProvider.searchForClientRoles(RealmModel realm, ClientModel client, String search, Integer first, Integer max)
void	KeycloakContext.setClient(ClientModel client)
void	RealmModel.setMasterAdminClient(ClientModel client)

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

Constructor and 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 and Description
Set<RoleModel>	UserModelDelegate.getClientRoleMappings(ClientModel app)

Uses of ClientModel in org.keycloak.sessions

Methods in org.keycloak.sessions that return ClientModel

Modifier and Type	Method and Description
ClientModel	CommonClientSessionModel.getClient()

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

Modifier and Type	Method and Description
AuthenticationSessionModel	RootAuthenticationSessionModel.createAuthenticationSession(ClientModel client) Create new authentication session and returns it.
AuthenticationSessionModel	RootAuthenticationSessionModel.getAuthenticationSession(ClientModel client, String tabId)
void	AuthenticationSessionProvider.onClientRemoved(RealmModel realm, ClientModel client)

Uses of ClientModel in org.keycloak.storage

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

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

Uses of ClientModel in org.keycloak.storage.adapter

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

Modifier and Type	Method and Description
Set<RoleModel>	AbstractUserAdapterFederatedStorage.getClientRoleMappings(ClientModel app) Gets role mappings from federated storage and automatically appends default roles.
Set<RoleModel>	AbstractUserAdapter.getClientRoleMappings(ClientModel app)

Uses of ClientModel in org.keycloak.storage.client

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

Modifier and Type	Method and Description
ClientModel	ClientLookupProvider.getClientByClientId(RealmModel realm, String clientId) Exact search for a client by its public client identifier.
default ClientModel	ClientLookupProvider.getClientByClientId(String clientId, RealmModel realm) Deprecated. Use ClientLookupProvider.getClientByClientId(org.keycloak.models.RealmModel, java.lang.String) instead.
ClientModel	ClientLookupProvider.getClientById(RealmModel realm, String id) Exact search for a client by its internal ID.
default ClientModel	ClientLookupProvider.getClientById(String id, RealmModel realm) Deprecated. Use ClientLookupProvider.getClientById(org.keycloak.models.RealmModel, java.lang.String) instead.

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

Modifier and Type	Method and Description
List<ClientModel>	ClientLookupProvider.searchClientsByClientId(RealmModel realm, String clientId, Integer firstResult, Integer maxResults) Case-insensitive search for clients that contain the given string in their public client identifier.
default List<ClientModel>	ClientLookupProvider.searchClientsByClientId(String clientId, Integer firstResult, Integer maxResults, RealmModel realm) Deprecated. Use ClientLookupProvider.searchClientsByClientId(org.keycloak.models.RealmModel, java.lang.String, java.lang.Integer, java.lang.Integer) instead.

Uses of ClientModel in org.keycloak.storage.federated

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

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