Modifier and Type | Field and Description |
---|---|
static SearchableModelField<ClientModel> |
ClientModel.SearchableFields.ATTRIBUTE
Search for attribute value.
|
static SearchableModelField<ClientModel> |
ClientModel.SearchableFields.CLIENT_ID |
static BiConsumer<JOSE,ClientModel> |
TokenManager.DEFAULT_VALIDATOR |
static SearchableModelField<ClientModel> |
ClientModel.SearchableFields.ENABLED |
static SearchableModelField<ClientModel> |
ClientModel.SearchableFields.ID |
static SearchableModelField<ClientModel> |
ClientModel.SearchableFields.REALM_ID |
static SearchableModelField<ClientModel> |
ClientModel.SearchableFields.SCOPE_MAPPING_ROLE |
Modifier and Type | Method and Description |
---|---|
default ClientModel |
ClientProvider.addClient(RealmModel realm,
String clientId)
Adds a client with given
clientId to the given realm. |
default ClientModel |
RealmProvider.addClient(RealmModel realm,
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 |
RealmProvider.addClient(RealmModel realm,
String id,
String clientId)
Deprecated.
Use the corresponding method from
ClientProvider . |
ClientModel |
RealmModel.addClient(String name) |
ClientModel |
RealmModel.addClient(String id,
String clientId) |
ClientModel |
ClientModel.ClientRemovedEvent.getClient() |
ClientModel |
ClientModel.ClientProtocolUpdatedEvent.getClient() |
ClientModel |
UserConsentModel.getClient() |
ClientModel |
KeycloakContext.getClient() |
ClientModel |
RealmModel.getClientByClientId(String clientId) |
default ClientModel |
RealmProvider.getClientByClientId(String clientId,
RealmModel realm)
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 |
ClientModel.ClientCreationEvent.getCreatedClient() |
ClientModel |
RealmModel.getMasterAdminClient() |
ClientModel |
ClientModel.ClientUpdatedEvent.getUpdatedClient() |
Modifier and Type | Method and 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
|
default List<ClientModel> |
RealmModel.getAlwaysDisplayInConsoleClients()
Deprecated.
Use
getAlwaysDisplayInConsoleClientsStream instead. |
default List<ClientModel> |
ClientProvider.getAlwaysDisplayInConsoleClients(RealmModel realm)
Deprecated.
use the stream variant instead
|
default List<ClientModel> |
RealmProvider.getAlwaysDisplayInConsoleClients(RealmModel realm)
Deprecated.
Use the corresponding method from
ClientProvider . |
Stream<ClientModel> |
RealmModel.getAlwaysDisplayInConsoleClientsStream()
Returns clients which are always displayed in the admin console as a stream.
|
Stream<ClientModel> |
ClientProvider.getAlwaysDisplayInConsoleClientsStream(RealmModel realm)
Returns a stream of clients that are expected to always show up in account console.
|
default List<ClientModel> |
RealmModel.getClients()
Deprecated.
Use
getClientsStream instead. |
default List<ClientModel> |
RealmModel.getClients(Integer firstResult,
Integer maxResults)
Deprecated.
Use
getClientsStream instead. |
default List<ClientModel> |
ClientProvider.getClients(RealmModel realm)
Deprecated.
use the stream variant instead
Effectively the same as the call
getClients(realm, null, null) . |
default List<ClientModel> |
RealmProvider.getClients(RealmModel realm)
Deprecated.
Use the corresponding method from
ClientProvider . |
default List<ClientModel> |
ClientProvider.getClients(RealmModel realm,
Integer firstResult,
Integer maxResults)
Deprecated.
use the stream variant instead
|
default List<ClientModel> |
RealmProvider.getClients(RealmModel realm,
Integer firstResult,
Integer maxResults)
Deprecated.
Use the corresponding method from
ClientProvider . |
Stream<ClientModel> |
RealmModel.getClientsStream()
Returns clients as a stream.
|
Stream<ClientModel> |
RealmModel.getClientsStream(Integer firstResult,
Integer maxResults)
Returns clients 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.searchClientByAttributes(Map<String,String> attributes,
Integer firstResult,
Integer maxResults) |
default List<ClientModel> |
RealmModel.searchClientByClientId(String clientId,
Integer firstResult,
Integer maxResults)
Deprecated.
Use
searchClientByClientId instead. |
Stream<ClientModel> |
RealmModel.searchClientByClientIdStream(String clientId,
Integer firstResult,
Integer maxResults)
Search for clients by provided client's id.
|
default List<ClientModel> |
RealmProvider.searchClientsByClientId(String clientId,
Integer firstResult,
Integer maxResults,
RealmModel realm)
Deprecated.
Use the corresponding method from
ClientProvider . |
Modifier and Type | Method and 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. |
default RoleModel |
RealmProvider.addClientRole(RealmModel realm,
ClientModel client,
String name)
Deprecated.
Use the corresponding method from
RoleProvider . |
default RoleModel |
RealmProvider.addClientRole(RealmModel realm,
ClientModel client,
String id,
String name)
Deprecated.
Use the corresponding method from
RoleProvider . |
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) |
<T> T |
TokenManager.decodeClientJWT(String token,
ClientModel client,
BiConsumer<JOSE,ClientModel> jwtValidator,
Class<T> clazz) |
default <T> T |
TokenManager.decodeClientJWT(String token,
ClientModel client,
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) |
default RoleModel |
RealmProvider.getClientRole(RealmModel realm,
ClientModel client,
String name)
Deprecated.
Use the corresponding method from
RoleProvider . |
Set<RoleModel> |
RoleMapperModel.getClientRoleMappings(ClientModel app)
Deprecated.
Use
getClientRoleMappingsStream instead. |
default Set<RoleModel> |
RoleMapperModel.Streams.getClientRoleMappings(ClientModel app) |
default Stream<RoleModel> |
RoleMapperModel.getClientRoleMappingsStream(ClientModel app)
Returns stream of client roles that are directly set to this object for the given client.
|
Stream<RoleModel> |
RoleMapperModel.Streams.getClientRoleMappingsStream(ClientModel app) |
default Set<RoleModel> |
RealmProvider.getClientRoles(RealmModel realm,
ClientModel client)
Deprecated.
Use the corresponding method from
RoleProvider . |
default Set<RoleModel> |
RealmProvider.getClientRoles(RealmModel realm,
ClientModel client,
Integer first,
Integer max)
Deprecated.
Use the corresponding method from
RoleProvider . |
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.
|
int |
OAuth2DeviceConfig.getLifespan(ClientModel client) |
long |
UserSessionProvider.getOfflineSessionsCount(RealmModel realm,
ClientModel client) |
default List<UserSessionModel> |
UserSessionProvider.getOfflineUserSessions(RealmModel realm,
ClientModel client,
int first,
int max)
Deprecated.
use
getOfflineUserSessionsStream
instead. |
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
|
default List<UserSessionModel> |
UserSessionProvider.getUserSessions(RealmModel realm,
ClientModel client)
Deprecated.
Use
getUserSessionsStream instead. |
default List<UserSessionModel> |
UserSessionProvider.getUserSessions(RealmModel realm,
ClientModel client,
int firstResult,
int maxResults)
Deprecated.
Use
getUserSessionsStream instead. |
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.
|
default Set<RoleModel> |
RealmProvider.searchForClientRoles(RealmModel realm,
ClientModel client,
String search,
Integer first,
Integer max)
Deprecated.
Use the corresponding method from
RoleProvider . |
void |
KeycloakContext.setClient(ClientModel client) |
void |
RealmModel.setMasterAdminClient(ClientModel client) |
Modifier and Type | Method and Description |
---|---|
<T> T |
TokenManager.decodeClientJWT(String token,
ClientModel client,
BiConsumer<JOSE,ClientModel> jwtValidator,
Class<T> clazz) |
Constructor and Description |
---|
UserConsentModel(ClientModel client) |
Modifier and Type | Method and Description |
---|---|
Stream<RoleModel> |
UserModelDelegate.getClientRoleMappingsStream(ClientModel app) |
static boolean |
RoleUtils.isClientRole(RoleModel r,
ClientModel c) |
Modifier and Type | Method and Description |
---|---|
ClientModel |
CommonClientSessionModel.getClient() |
Modifier and Type | Method and 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.
|
Modifier and Type | Method and Description |
---|---|
static boolean |
StorageId.isLocalStorage(ClientModel client) |
static String |
StorageId.resolveProviderId(ClientModel client) |
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> |
AbstractUserAdapterFederatedStorage.Streams.getClientRoleMappings(ClientModel app) |
Set<RoleModel> |
AbstractUserAdapter.getClientRoleMappings(ClientModel app) |
Set<RoleModel> |
AbstractUserAdapter.Streams.getClientRoleMappings(ClientModel app) |
Stream<RoleModel> |
AbstractUserAdapterFederatedStorage.Streams.getClientRoleMappingsStream(ClientModel app) |
Stream<RoleModel> |
AbstractUserAdapter.Streams.getClientRoleMappingsStream(ClientModel app) |
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.
|
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.
|
Modifier and Type | Method and Description |
---|---|
Stream<ClientModel> |
ClientLookupProvider.searchClientsByAttributes(RealmModel realm,
Map<String,String> attributes,
Integer firstResult,
Integer maxResults) |
default List<ClientModel> |
ClientLookupProvider.searchClientsByClientId(String clientId,
Integer firstResult,
Integer maxResults,
RealmModel realm)
|
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.
|
Modifier and Type | Method and 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 |
Modifier and Type | Method and Description |
---|---|
void |
UserFederatedStorageProvider.preRemove(RealmModel realm,
ClientModel client) |
Modifier and Type | Method and 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.
|
Copyright © 2021 JBoss by Red Hat. All rights reserved.