Modifier and Type | Method and Description |
---|---|
default List<ProviderConfigProperty> |
SubComponentFactory.getConfigProperties(RealmModel realm,
ComponentModel parent) |
default Map<String,Object> |
SubComponentFactory.getTypeMetadata(RealmModel realm,
ComponentModel parent)
This is metadata about this component type.
|
default void |
ComponentFactory.onCreate(KeycloakSession session,
RealmModel realm,
ComponentModel model)
Called after a component is created
|
default void |
ComponentFactory.onUpdate(KeycloakSession session,
RealmModel realm,
ComponentModel oldModel,
ComponentModel newModel)
Called after the component is updated.
|
default void |
ComponentFactory.preRemove(KeycloakSession session,
RealmModel realm,
ComponentModel model)
Called before the component is removed.
|
default void |
ComponentFactory.validateConfiguration(KeycloakSession session,
RealmModel realm,
ComponentModel model)
Called before a component is created or updated.
|
Modifier and Type | Method and Description |
---|---|
CredentialValidationOutput |
CredentialAuthentication.authenticate(RealmModel realm,
CredentialInput input) |
CredentialModel |
UserCredentialStore.createCredential(RealmModel realm,
UserModel user,
CredentialModel cred) |
CredentialModel |
CredentialProvider.createCredential(RealmModel realm,
UserModel user,
T credentialModel) |
boolean |
CredentialProvider.deleteCredential(RealmModel realm,
UserModel user,
String credentialId) |
void |
CredentialInputUpdater.disableCredentialType(RealmModel realm,
UserModel user,
String credentialType) |
default T |
CredentialProvider.getDefaultCredential(KeycloakSession session,
RealmModel realm,
UserModel user) |
Set<String> |
CredentialInputUpdater.getDisableableCredentialTypes(RealmModel realm,
UserModel user)
Deprecated.
Use
getDisableableCredentialTypesStream
instead. |
default Set<String> |
CredentialInputUpdater.Streams.getDisableableCredentialTypes(RealmModel realm,
UserModel user) |
default Stream<String> |
CredentialInputUpdater.getDisableableCredentialTypesStream(RealmModel realm,
UserModel user)
Obtains the set of credential types that can be disabled via
disableCredentialType . |
Stream<String> |
CredentialInputUpdater.Streams.getDisableableCredentialTypesStream(RealmModel realm,
UserModel user) |
CredentialModel |
UserCredentialStore.getStoredCredentialById(RealmModel realm,
UserModel user,
String id) |
CredentialModel |
UserCredentialStore.getStoredCredentialByNameAndType(RealmModel realm,
UserModel user,
String name,
String type) |
List<CredentialModel> |
UserCredentialStore.getStoredCredentials(RealmModel realm,
UserModel user)
Deprecated.
Use
getStoredCredentialsStream instead. |
default List<CredentialModel> |
UserCredentialStore.Streams.getStoredCredentials(RealmModel realm,
UserModel user) |
List<CredentialModel> |
UserCredentialStore.getStoredCredentialsByType(RealmModel realm,
UserModel user,
String type)
Deprecated.
Use
getStoredCredentialsByTypeStream
instead. |
default List<CredentialModel> |
UserCredentialStore.Streams.getStoredCredentialsByType(RealmModel realm,
UserModel user,
String type) |
default Stream<CredentialModel> |
UserCredentialStore.getStoredCredentialsByTypeStream(RealmModel realm,
UserModel user,
String type)
Obtains the stored credentials associated with the specified user that match the specified type.
|
Stream<CredentialModel> |
UserCredentialStore.Streams.getStoredCredentialsByTypeStream(RealmModel realm,
UserModel user,
String type) |
default Stream<CredentialModel> |
UserCredentialStore.getStoredCredentialsStream(RealmModel realm,
UserModel user)
Obtains the stored credentials associated with the specified user.
|
Stream<CredentialModel> |
UserCredentialStore.Streams.getStoredCredentialsStream(RealmModel realm,
UserModel user) |
boolean |
CredentialInputValidator.isConfiguredFor(RealmModel realm,
UserModel user,
String credentialType) |
boolean |
CredentialInputValidator.isValid(RealmModel realm,
UserModel user,
CredentialInput credentialInput)
Tests whether a credential is valid
|
boolean |
UserCredentialStore.moveCredentialTo(RealmModel realm,
UserModel user,
String id,
String newPreviousCredentialId) |
boolean |
UserCredentialStore.removeStoredCredential(RealmModel realm,
UserModel user,
String id) |
boolean |
CredentialInputUpdater.updateCredential(RealmModel realm,
UserModel user,
CredentialInput input) |
void |
UserCredentialStore.updateCredential(RealmModel realm,
UserModel user,
CredentialModel cred) |
Modifier and Type | Method and Description |
---|---|
Locale |
LocaleSelectorProvider.resolveLocale(RealmModel realm,
UserModel user)
Resolve the locale which should be used for the request
|
Modifier and Type | Field and Description |
---|---|
static SearchableModelField<RealmModel> |
RealmModel.SearchableFields.CLIENT_INITIAL_ACCESS
Search for realms that have some client initial access set.
|
static Comparator<RealmModel> |
RealmModel.COMPARE_BY_NAME |
static SearchableModelField<RealmModel> |
RealmModel.SearchableFields.COMPONENT_PROVIDER_TYPE
Search for realms that have some component with
|
static SearchableModelField<RealmModel> |
RealmModel.SearchableFields.ID |
static SearchableModelField<RealmModel> |
RealmModel.SearchableFields.NAME |
protected Supplier<RealmModel> |
AbstractConfig.realm |
protected Supplier<RealmModel> |
AbstractConfig.realmForWrite |
Modifier and Type | Method and Description |
---|---|
RealmModel |
RealmProvider.createRealm(String name)
Creates new realm with the given name.
|
RealmModel |
RealmProvider.createRealm(String id,
String name)
Created new realm with given ID and name.
|
RealmModel |
RealmModel.RealmCreationEvent.getCreatedRealm() |
RealmModel |
RealmModel.RealmPostCreateEvent.getCreatedRealm() |
RealmModel |
UserModel.UserRemovedEvent.getRealm() |
RealmModel |
RealmModel.RealmRemovedEvent.getRealm() |
RealmModel |
RealmModel.IdentityProviderUpdatedEvent.getRealm() |
RealmModel |
RealmModel.IdentityProviderRemovedEvent.getRealm() |
RealmModel |
ClientModel.getRealm() |
RealmModel |
UserSessionModel.getRealm() |
RealmModel |
KeycloakContext.getRealm() |
RealmModel |
GroupModel.GroupRemovedEvent.getRealm() |
RealmModel |
ClientScopeModel.getRealm() |
RealmModel |
RealmProvider.getRealm(String id)
Exact search for a realm by its internal ID.
|
RealmModel |
RealmProvider.getRealmByName(String name)
Exact search for a realm by its name.
|
Modifier and Type | Method and Description |
---|---|
default List<RealmModel> |
RealmProvider.getRealms()
Deprecated.
Use
getRealmsStream instead. |
Stream<RealmModel> |
RealmProvider.getRealmsStream()
Returns realms as a stream.
|
default List<RealmModel> |
RealmProvider.getRealmsWithProviderType(Class<?> type)
Deprecated.
Use
getRealmsWithProviderTypeStream instead. |
Stream<RealmModel> |
RealmProvider.getRealmsWithProviderTypeStream(Class<?> type)
Returns stream of realms which has component with the given provider type.
|
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 . |
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 . |
default ClientScopeModel |
ClientScopeProvider.addClientScope(RealmModel realm,
String name)
Creates new client scope with given
name to the given realm. |
ClientScopeModel |
ClientScopeProvider.addClientScope(RealmModel realm,
String id,
String name)
Creates new client scope with given internal ID and
name to the given realm. |
void |
ClientProvider.addClientScopes(RealmModel realm,
ClientModel client,
Set<ClientScopeModel> clientScopes,
boolean defaultScope)
Assign clientScopes to the client.
|
void |
UserProvider.addConsent(RealmModel realm,
String userId,
UserConsentModel consent)
Add user consent for the user.
|
void |
UserProvider.addFederatedIdentity(RealmModel realm,
UserModel user,
FederatedIdentityModel socialLink)
Adds a federated identity link for the user within the realm
|
default RoleModel |
RoleProvider.addRealmRole(RealmModel realm,
String name)
Adds a realm role with given
name to the given realm. |
default RoleModel |
RealmProvider.addRealmRole(RealmModel realm,
String name)
Deprecated.
Use the corresponding method from
RoleProvider . |
RoleModel |
RoleProvider.addRealmRole(RealmModel realm,
String id,
String name)
Adds a realm role with given internal ID and
name to the given realm. |
RoleModel |
RealmProvider.addRealmRole(RealmModel realm,
String id,
String name)
Deprecated.
Use the corresponding method from
RoleProvider . |
void |
RealmProvider.addTopLevelGroup(RealmModel realm,
GroupModel subGroup)
Deprecated.
Use the corresponding method from
GroupProvider . |
void |
GroupProvider.addTopLevelGroup(RealmModel realm,
GroupModel subGroup)
Removes parent group for the given group in the given realm.
|
UserModel |
UserProvider.addUser(RealmModel realm,
String id,
String username,
boolean addDefaultRoles,
boolean addDefaultRequiredActions)
Adds a new user into the storage.
|
default UserLoginFailureModel |
UserSessionProvider.addUserLoginFailure(RealmModel realm,
String userId)
Deprecated.
Use
addUserLoginFailure instead. |
UserLoginFailureModel |
UserLoginFailureProvider.addUserLoginFailure(RealmModel realm,
String userId)
Adds a
UserLoginFailureModel for the given realm and user id. |
CredentialValidationOutput |
UserCredentialManager.authenticate(KeycloakSession session,
RealmModel realm,
CredentialInput input)
Given a CredentialInput, authenticate the user.
|
default ClientInitialAccessModel |
RealmProvider.createClientInitialAccessModel(RealmModel realm,
int expiration,
int count) |
AuthenticatedClientSessionModel |
UserSessionProvider.createClientSession(RealmModel realm,
ClientModel client,
UserSessionModel userSession) |
CredentialModel |
UserCredentialManager.createCredentialThroughProvider(RealmModel realm,
UserModel user,
CredentialModel model)
Creates a credential from the credentialModel, by looping through the providers to find a match for the type
|
default GroupModel |
RealmProvider.createGroup(RealmModel realm,
String name)
Deprecated.
Use the corresponding method from
GroupProvider . |
default GroupModel |
GroupProvider.createGroup(RealmModel realm,
String name)
Creates a new group with the given name in the given realm.
|
default GroupModel |
RealmProvider.createGroup(RealmModel realm,
String name,
GroupModel toParent)
Deprecated.
Use the corresponding method from
GroupProvider . |
default GroupModel |
GroupProvider.createGroup(RealmModel realm,
String name,
GroupModel toParent)
Creates a new group with the given name and parent to the given realm.
|
default GroupModel |
RealmProvider.createGroup(RealmModel realm,
String id,
String name)
Deprecated.
Use the corresponding method from
GroupProvider . |
default GroupModel |
GroupProvider.createGroup(RealmModel realm,
String id,
String name)
Creates a new group with the given id and name in the given realm.
|
GroupModel |
RealmProvider.createGroup(RealmModel realm,
String id,
String name,
GroupModel toParent)
Deprecated.
Use the corresponding method from
GroupProvider . |
GroupModel |
GroupProvider.createGroup(RealmModel realm,
String id,
String name,
GroupModel toParent)
Creates a new group with the given name, id, name and parent to the given realm.
|
UserSessionModel |
UserSessionProvider.createUserSession(RealmModel realm,
UserModel user,
String loginUsername,
String ipAddress,
String authMethod,
boolean rememberMe,
String brokerSessionId,
String brokerUserId) |
UserSessionModel |
UserSessionProvider.createUserSession(String id,
RealmModel realm,
UserModel user,
String loginUsername,
String ipAddress,
String authMethod,
boolean rememberMe,
String brokerSessionId,
String brokerUserId,
UserSessionModel.SessionPersistenceState persistenceState) |
default void |
RealmProvider.decreaseRemainingCount(RealmModel realm,
ClientInitialAccessModel clientInitialAccess) |
boolean |
RealmProvider.deleteLocalizationText(RealmModel realm,
String locale,
String key) |
boolean |
RealmProvider.deleteLocalizationTextsByLocale(RealmModel realm,
String locale) |
void |
UserCredentialManager.disableCredentialType(RealmModel realm,
UserModel user,
String credentialType)
Calls disableCredential on UserStorageProvider and UserFederationProviders first, then loop through
each CredentialProvider.
|
KeyManager.ActiveAesKey |
KeyManager.getActiveAesKey(RealmModel realm)
Deprecated.
|
Map<String,Long> |
UserSessionProvider.getActiveClientSessionStats(RealmModel realm,
boolean offline)
Returns a summary of client sessions key is client.getId()
|
KeyManager.ActiveHmacKey |
KeyManager.getActiveHmacKey(RealmModel realm)
Deprecated.
|
KeyWrapper |
KeyManager.getActiveKey(RealmModel realm,
KeyUse use,
String algorithm) |
KeyManager.ActiveRsaKey |
KeyManager.getActiveRsaKey(RealmModel realm)
Deprecated.
|
long |
UserSessionProvider.getActiveUserSessions(RealmModel realm,
ClientModel client) |
List<SecretKeyMetadata> |
KeyManager.getAesKeys(RealmModel realm)
Deprecated.
|
SecretKey |
KeyManager.getAesSecretKey(RealmModel realm,
String kid)
Deprecated.
|
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> |
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> |
ClientProvider.getAlwaysDisplayInConsoleClientsStream(RealmModel realm)
Returns a stream of clients that are expected to always show up in account console.
|
default ClientModel |
RealmProvider.getClientByClientId(String clientId,
RealmModel realm)
Deprecated.
Use the corresponding method from
ClientProvider . |
default ClientModel |
RealmProvider.getClientById(String id,
RealmModel realm)
Deprecated.
Use the corresponding method from
ClientProvider . |
default ClientInitialAccessModel |
RealmProvider.getClientInitialAccessModel(RealmModel realm,
String id) |
default RoleModel |
RealmProvider.getClientRole(RealmModel realm,
ClientModel client,
String name)
Deprecated.
Use the corresponding method from
RoleProvider . |
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 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 . |
ClientScopeModel |
RealmProvider.getClientScopeById(RealmModel realm,
String id)
Deprecated.
Use the corresponding method from
ClientScopeProvider . |
default ClientScopeModel |
RealmProvider.getClientScopeById(String id,
RealmModel realm)
Deprecated.
Use the corresponding method from
ClientScopeProvider . |
Stream<ClientScopeModel> |
ClientScopeProvider.getClientScopesStream(RealmModel realm)
Returns all the client scopes of the given realm as a stream.
|
long |
ClientProvider.getClientsCount(RealmModel realm)
Returns number of clients in the given realm
|
long |
RealmProvider.getClientsCount(RealmModel realm)
Deprecated.
Use the corresponding method from
ClientProvider . |
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.
|
List<String> |
UserCredentialManager.getConfiguredUserStorageCredentialTypes(RealmModel realm,
UserModel user)
Deprecated.
Use
getConfiguredUserStorageCredentialTypesStream
instead. |
default List<String> |
UserCredentialManager.Streams.getConfiguredUserStorageCredentialTypes(RealmModel realm,
UserModel user) |
default Stream<String> |
UserCredentialManager.getConfiguredUserStorageCredentialTypesStream(RealmModel realm,
UserModel user)
Obtains the credential types provided by the user storage where the specified user is stored.
|
Stream<String> |
UserCredentialManager.Streams.getConfiguredUserStorageCredentialTypesStream(RealmModel realm,
UserModel user) |
UserConsentModel |
UserProvider.getConsentByClient(RealmModel realm,
String userId,
String clientInternalId)
Returns UserConsentModel given by a user with the userId for the client with clientInternalId
|
List<UserConsentModel> |
UserProvider.getConsents(RealmModel realm,
String userId)
Deprecated.
Use
getConsentsStream instead. |
default List<UserConsentModel> |
UserProvider.Streams.getConsents(RealmModel realm,
String userId) |
default Stream<UserConsentModel> |
UserProvider.getConsentsStream(RealmModel realm,
String userId)
Obtains the consents associated with the user identified by the specified
userId . |
Stream<UserConsentModel> |
UserProvider.Streams.getConsentsStream(RealmModel realm,
String userId) |
Set<String> |
UserCredentialManager.getDisableableCredentialTypes(RealmModel realm,
UserModel user)
Deprecated.
Use
getDisableableCredentialTypesStream
instead. |
default Set<String> |
UserCredentialManager.Streams.getDisableableCredentialTypes(RealmModel realm,
UserModel user) |
default Stream<String> |
UserCredentialManager.getDisableableCredentialTypesStream(RealmModel realm,
UserModel user)
Obtains the credential types that can be disabled by means of the
UserCredentialManager.disableCredentialType(RealmModel, UserModel, String)
method. |
Stream<String> |
UserCredentialManager.Streams.getDisableableCredentialTypesStream(RealmModel realm,
UserModel user) |
Set<FederatedIdentityModel> |
UserProvider.getFederatedIdentities(UserModel user,
RealmModel realm)
Deprecated.
Use
getFederatedIdentitiesStream instead. |
default Set<FederatedIdentityModel> |
UserProvider.Streams.getFederatedIdentities(UserModel user,
RealmModel realm) |
default Stream<FederatedIdentityModel> |
UserProvider.getFederatedIdentitiesStream(RealmModel realm,
UserModel user)
Obtains the federated identities of the specified user.
|
Stream<FederatedIdentityModel> |
UserProvider.Streams.getFederatedIdentitiesStream(RealmModel realm,
UserModel user) |
default FederatedIdentityModel |
UserProvider.getFederatedIdentity(RealmModel realm,
UserModel user,
String socialProvider)
Returns details of the association between the user and the socialProvider.
|
FederatedIdentityModel |
UserProvider.Streams.getFederatedIdentity(RealmModel realm,
UserModel user,
String socialProvider) |
FederatedIdentityModel |
UserProvider.getFederatedIdentity(UserModel user,
String socialProvider,
RealmModel realm)
Deprecated.
Use
getFederatedIdentity instead. |
default FederatedIdentityModel |
UserProvider.Streams.getFederatedIdentity(UserModel user,
String socialProvider,
RealmModel realm) |
GroupModel |
RealmProvider.getGroupById(RealmModel realm,
String id)
Deprecated.
Use the corresponding method from
GroupProvider . |
default GroupModel |
RealmProvider.getGroupById(String id,
RealmModel realm)
Deprecated.
Use the corresponding method from
GroupProvider . |
default GroupModel |
GroupProvider.getGroupById(String id,
RealmModel realm)
Deprecated.
Use method
getGroupById |
default List<GroupModel> |
RealmProvider.getGroups(RealmModel realm)
Deprecated.
Use the corresponding method from
GroupProvider . |
default List<GroupModel> |
GroupProvider.getGroups(RealmModel realm)
Deprecated.
Use
getGroupsStream instead. |
default List<GroupModel> |
RealmProvider.getGroupsByRole(RealmModel realm,
RoleModel role,
int firstResult,
int maxResults)
Deprecated.
Use the corresponding method from
GroupProvider . |
default List<GroupModel> |
GroupProvider.getGroupsByRole(RealmModel realm,
RoleModel role,
int firstResult,
int maxResults)
Deprecated.
Use
getGroupsByRoleStream instead. |
Stream<GroupModel> |
GroupProvider.getGroupsByRoleStream(RealmModel realm,
RoleModel role,
Integer firstResult,
Integer maxResults)
Returns groups with the given role in the given realm.
|
Long |
RealmProvider.getGroupsCount(RealmModel realm,
Boolean onlyTopGroups)
Deprecated.
Use the corresponding method from
GroupProvider . |
Long |
GroupProvider.getGroupsCount(RealmModel realm,
Boolean onlyTopGroups)
Returns a number of groups/top level groups (i.e.
|
default Long |
GroupProvider.getGroupsCount(RealmModel realm,
Stream<String> ids,
String search)
Returns a number of groups that contains the search string in the name
|
Long |
RealmProvider.getGroupsCountByNameContaining(RealmModel realm,
String search)
Deprecated.
Use the corresponding method from
GroupProvider . |
Long |
GroupProvider.getGroupsCountByNameContaining(RealmModel realm,
String search)
Returns number of groups with the given string in name for the given realm.
|
Stream<GroupModel> |
GroupProvider.getGroupsStream(RealmModel realm)
Returns groups for the given realm.
|
default Stream<GroupModel> |
GroupProvider.getGroupsStream(RealmModel realm,
Stream<String> ids)
Returns a stream of groups with given ids.
|
default Stream<GroupModel> |
GroupProvider.getGroupsStream(RealmModel realm,
Stream<String> ids,
Integer first,
Integer max)
Returns a paginated stream of groups with given ids.
|
Stream<GroupModel> |
GroupProvider.getGroupsStream(RealmModel realm,
Stream<String> ids,
String search,
Integer first,
Integer max)
Returns a paginated stream of groups with given ids and given search value in group names.
|
List<SecretKeyMetadata> |
KeyManager.getHmacKeys(RealmModel realm)
Deprecated.
|
SecretKey |
KeyManager.getHmacSecretKey(RealmModel realm,
String kid)
Deprecated.
|
KeyWrapper |
KeyManager.getKey(RealmModel realm,
String kid,
KeyUse use,
String algorithm) |
default List<KeyWrapper> |
KeyManager.getKeys(RealmModel realm)
Deprecated.
Use
getKeysStream instead. |
default List<KeyWrapper> |
KeyManager.getKeys(RealmModel realm,
KeyUse use,
String algorithm)
Deprecated.
Use
getKeysStream instead. |
Stream<KeyWrapper> |
KeyManager.getKeysStream(RealmModel realm)
Returns all
KeyWrapper for the given realm. |
Stream<KeyWrapper> |
KeyManager.getKeysStream(RealmModel realm,
KeyUse use,
String algorithm)
Returns all
KeyWrapper for the given realm that match given criteria. |
String |
OTPPolicy.getKeyURI(RealmModel realm,
UserModel user,
String secret)
Constructs the
otpauth:// URI based on the Key-Uri-Format. |
String |
RealmProvider.getLocalizationTextsById(RealmModel realm,
String locale,
String key) |
int |
UserProvider.getNotBeforeOfUser(RealmModel realm,
UserModel user)
Gets the notBefore value for the given user
|
long |
UserSessionProvider.getOfflineSessionsCount(RealmModel realm,
ClientModel client) |
UserSessionModel |
UserSessionProvider.getOfflineUserSession(RealmModel realm,
String userSessionId) |
UserSessionModel |
UserSessionProvider.getOfflineUserSessionByBrokerSessionId(RealmModel realm,
String brokerSessionId) |
default List<UserSessionModel> |
UserSessionProvider.getOfflineUserSessionByBrokerUserId(RealmModel realm,
String brokerUserId)
Deprecated.
Use
getOfflineUserSessionByBrokerUserIdStream
instead. |
Stream<UserSessionModel> |
UserSessionProvider.getOfflineUserSessionByBrokerUserIdStream(RealmModel realm,
String brokerUserId)
Obtains the offline user sessions associated with the user that matches the specified
brokerUserId . |
default List<UserSessionModel> |
UserSessionProvider.getOfflineUserSessions(RealmModel realm,
ClientModel client,
int first,
int max)
Deprecated.
use
getOfflineUserSessionsStream
instead. |
default List<UserSessionModel> |
UserSessionProvider.getOfflineUserSessions(RealmModel realm,
UserModel user)
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 . |
Stream<UserSessionModel> |
UserSessionProvider.getOfflineUserSessionsStream(RealmModel realm,
UserModel user)
Obtains the offline user sessions associated with the specified user.
|
RoleModel |
RealmProvider.getRealmRole(RealmModel realm,
String name)
Deprecated.
Use the corresponding method from
RoleProvider . |
default Set<RoleModel> |
RoleProvider.getRealmRoles(RealmModel realm)
Deprecated.
use the stream variant instead
|
default Set<RoleModel> |
RealmProvider.getRealmRoles(RealmModel realm)
Deprecated.
Use the corresponding method from
RoleProvider . |
default Set<RoleModel> |
RealmProvider.getRealmRoles(RealmModel realm,
Integer first,
Integer max)
Deprecated.
Use the corresponding method from
RoleProvider . |
default Stream<RoleModel> |
RoleProvider.getRealmRolesStream(RealmModel realm)
Returns all the realm roles of the given realm as a stream.
|
Stream<RoleModel> |
RoleProvider.getRealmRolesStream(RealmModel realm,
Integer first,
Integer max)
Returns the realm roles of the given realm as a stream.
|
default RoleModel |
RealmProvider.getRoleById(String id,
RealmModel realm)
Deprecated.
Use the corresponding method from
RoleProvider . |
Certificate |
KeyManager.getRsaCertificate(RealmModel realm,
String kid)
Deprecated.
|
List<RsaKeyMetadata> |
KeyManager.getRsaKeys(RealmModel realm)
Deprecated.
|
PublicKey |
KeyManager.getRsaPublicKey(RealmModel realm,
String kid)
Deprecated.
|
default List<GroupModel> |
RealmProvider.getTopLevelGroups(RealmModel realm)
Deprecated.
Use the corresponding method from
GroupProvider . |
default List<GroupModel> |
GroupProvider.getTopLevelGroups(RealmModel realm)
Deprecated.
Use
getTopLevelGroupsStream instead. |
default List<GroupModel> |
RealmProvider.getTopLevelGroups(RealmModel realm,
Integer first,
Integer max)
Deprecated.
Use the corresponding method from
GroupProvider . |
default List<GroupModel> |
GroupProvider.getTopLevelGroups(RealmModel realm,
Integer firstResult,
Integer maxResults)
Deprecated.
Use
getTopLevelGroupsStream instead. |
Stream<GroupModel> |
GroupProvider.getTopLevelGroupsStream(RealmModel realm)
Returns all top level groups (i.e.
|
Stream<GroupModel> |
GroupProvider.getTopLevelGroupsStream(RealmModel realm,
Integer firstResult,
Integer maxResults)
Returns top level groups (i.e.
|
UserModel |
UserProvider.getUserByFederatedIdentity(FederatedIdentityModel socialLink,
RealmModel realm)
Deprecated.
Use
getUserByFederatedIdentity instead. |
default UserModel |
UserProvider.Streams.getUserByFederatedIdentity(FederatedIdentityModel socialLink,
RealmModel realm) |
default UserModel |
UserProvider.getUserByFederatedIdentity(RealmModel realm,
FederatedIdentityModel socialLink)
Returns a userModel that corresponds to the given socialLink.
|
UserModel |
UserProvider.Streams.getUserByFederatedIdentity(RealmModel realm,
FederatedIdentityModel socialLink) |
default UserLoginFailureModel |
UserSessionProvider.getUserLoginFailure(RealmModel realm,
String userId)
Deprecated.
Use
getUserLoginFailure instead. |
UserLoginFailureModel |
UserLoginFailureProvider.getUserLoginFailure(RealmModel realm,
String userId)
Returns the
UserLoginFailureModel for the given realm and user id. |
List<UserModel> |
UserProvider.getUsers(RealmModel realm,
boolean includeServiceAccounts)
Deprecated.
Use
getUsersStream instead. |
default List<UserModel> |
UserProvider.Streams.getUsers(RealmModel realm,
boolean includeServiceAccounts) |
List<UserModel> |
UserProvider.getUsers(RealmModel realm,
int firstResult,
int maxResults,
boolean includeServiceAccounts)
Deprecated.
Use
getUsersStream instead. |
default List<UserModel> |
UserProvider.Streams.getUsers(RealmModel realm,
int firstResult,
int maxResults,
boolean includeServiceAccounts) |
UserSessionModel |
UserSessionProvider.getUserSession(RealmModel realm,
String id) |
UserSessionModel |
UserSessionProvider.getUserSessionByBrokerSessionId(RealmModel realm,
String brokerSessionId) |
default List<UserSessionModel> |
UserSessionProvider.getUserSessionByBrokerUserId(RealmModel realm,
String brokerUserId)
Deprecated.
Use
getUserSessionByBrokerUserIdStream
instead. |
Stream<UserSessionModel> |
UserSessionProvider.getUserSessionByBrokerUserIdStream(RealmModel realm,
String brokerUserId)
Obtains the online user sessions associated with the user that matches the specified
brokerUserId . |
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. |
default List<UserSessionModel> |
UserSessionProvider.getUserSessions(RealmModel realm,
UserModel user)
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 . |
Stream<UserSessionModel> |
UserSessionProvider.getUserSessionsStream(RealmModel realm,
UserModel user)
Obtains the online user sessions associated with the specified user.
|
UserSessionModel |
UserSessionProvider.getUserSessionWithPredicate(RealmModel realm,
String id,
boolean offline,
Predicate<UserSessionModel> predicate)
Return userSession of specified ID as long as the predicate passes.
|
default Stream<UserModel> |
UserProvider.getUsersStream(RealmModel realm,
boolean includeServiceAccounts)
Obtains the users associated with the specified realm.
|
default Stream<UserModel> |
UserProvider.Streams.getUsersStream(RealmModel realm,
boolean includeServiceAccounts) |
default Stream<UserModel> |
UserProvider.getUsersStream(RealmModel realm,
Integer firstResult,
Integer maxResults,
boolean includeServiceAccounts)
Obtains the users associated with the specified realm.
|
Stream<UserModel> |
UserProvider.Streams.getUsersStream(RealmModel realm,
Integer firstResult,
Integer maxResults,
boolean includeServiceAccounts) |
boolean |
UserCredentialManager.isConfiguredFor(RealmModel realm,
UserModel user,
String type)
Checks to see if user has credential type configured.
|
boolean |
UserCredentialManager.isConfiguredLocally(RealmModel realm,
UserModel user,
String type)
Only loops through each CredentialProvider to see if credential type is configured for the user.
|
boolean |
UserCredentialManager.isValid(RealmModel realm,
UserModel user,
CredentialInput... inputs)
Validates list of credentials.
|
boolean |
UserCredentialManager.isValid(RealmModel realm,
UserModel user,
List<CredentialInput> inputs)
Validates list of credentials.
|
default List<ClientInitialAccessModel> |
RealmProvider.listClientInitialAccess(RealmModel realm)
Deprecated.
Use
listClientInitialAccessStream instead. |
default Stream<ClientInitialAccessModel> |
RealmProvider.listClientInitialAccessStream(RealmModel realm)
Returns client's initial access as a stream.
|
void |
RealmProvider.moveGroup(RealmModel realm,
GroupModel group,
GroupModel toParent)
Deprecated.
Use the corresponding method from
GroupProvider . |
void |
GroupProvider.moveGroup(RealmModel realm,
GroupModel group,
GroupModel toParent)
This method is used for moving groups in group structure, for example:
making an existing child group child group of some other group,
setting a top level group (i.e.
|
void |
UserSessionProvider.onClientRemoved(RealmModel realm,
ClientModel client) |
void |
UserSessionProvider.onRealmRemoved(RealmModel realm) |
void |
UserProvider.preRemove(RealmModel realm)
Called when a realm is removed.
|
void |
UserProvider.preRemove(RealmModel realm,
ClientModel client)
Called when a client is removed.
|
void |
UserProvider.preRemove(RealmModel realm,
ComponentModel component)
Called when a component is removed.
|
void |
UserProvider.preRemove(RealmModel realm,
GroupModel group)
Called when a group is removed.
|
void |
UserProvider.preRemove(RealmModel realm,
IdentityProviderModel provider)
Called when an identity provider is removed.
|
void |
UserProvider.preRemove(RealmModel realm,
RoleModel role)
Called when a role is removed.
|
default void |
UserSessionProvider.removeAllUserLoginFailures(RealmModel realm)
Deprecated.
Use
removeAllUserLoginFailures instead. |
void |
UserLoginFailureProvider.removeAllUserLoginFailures(RealmModel realm)
Removes all the
UserLoginFailureModel for the given realm. |
boolean |
ClientProvider.removeClient(RealmModel realm,
String id)
Removes given client from the given realm.
|
default boolean |
ClientProvider.removeClient(String id,
RealmModel realm)
Deprecated.
Use
ClientProvider.removeClient(RealmModel, String) instead. |
default boolean |
RealmProvider.removeClient(String id,
RealmModel realm)
Deprecated.
Use the corresponding method from
ClientProvider . |
default void |
RealmProvider.removeClientInitialAccessModel(RealmModel realm,
String id) |
void |
ClientProvider.removeClients(RealmModel realm)
Removes all clients from the given realm.
|
void |
ClientProvider.removeClientScope(RealmModel realm,
ClientModel client,
ClientScopeModel clientScope)
Unassign clientScope from the client.
|
boolean |
ClientScopeProvider.removeClientScope(RealmModel realm,
String id)
Removes client scope from the given realm.
|
void |
ClientScopeProvider.removeClientScopes(RealmModel realm)
Removes all client scopes from the given realm.
|
void |
UserSessionProvider.removeExpired(RealmModel realm)
Removes expired user sessions owned by this realm from this provider.
|
boolean |
UserProvider.removeFederatedIdentity(RealmModel realm,
UserModel user,
String socialProvider)
Removes federation link between the user and the identity provider given by its id
|
boolean |
RealmProvider.removeGroup(RealmModel realm,
GroupModel group)
Deprecated.
Use the corresponding method from
GroupProvider . |
boolean |
GroupProvider.removeGroup(RealmModel realm,
GroupModel group)
Removes the given group for the given realm.
|
void |
UserProvider.removeImportedUsers(RealmModel realm,
String storageProviderId)
Removes any imported users from a specific User Storage Provider.
|
void |
UserSessionProvider.removeOfflineUserSession(RealmModel realm,
UserSessionModel userSession)
Removes the attached clientSessions as well
|
default boolean |
RealmProvider.removeRole(RealmModel realm,
RoleModel role)
Deprecated.
Use the corresponding method from
RoleProvider . |
void |
RoleProvider.removeRoles(RealmModel realm)
Removes all roles from the given realm.
|
boolean |
UserManager.removeUser(RealmModel realm,
UserModel user) |
boolean |
UserManager.removeUser(RealmModel realm,
UserModel user,
UserProvider userProvider) |
default void |
UserSessionProvider.removeUserLoginFailure(RealmModel realm,
String userId)
Deprecated.
Use
removeUserLoginFailure instead. |
void |
UserLoginFailureProvider.removeUserLoginFailure(RealmModel realm,
String userId)
Removes a
UserLoginFailureModel for the given realm and user id. |
void |
UserSessionProvider.removeUserSession(RealmModel realm,
UserSessionModel session)
This will remove attached ClientLoginSessionModels too
|
void |
UserSessionProvider.removeUserSessions(RealmModel realm) |
void |
UserSessionProvider.removeUserSessions(RealmModel realm,
UserModel user) |
void |
UserSessionModel.restartSession(RealmModel realm,
UserModel user,
String loginUsername,
String ipAddress,
String authMethod,
boolean rememberMe,
String brokerSessionId,
String brokerUserId) |
boolean |
UserProvider.revokeConsentForClient(RealmModel realm,
String userId,
String clientInternalId)
Remove a user consent given by the user id and client id
|
void |
RealmProvider.saveLocalizationText(RealmModel realm,
String locale,
String key,
String text) |
void |
RealmProvider.saveLocalizationTexts(RealmModel realm,
String locale,
Map<String,String> localizationTexts) |
default List<ClientModel> |
RealmProvider.searchClientsByClientId(String clientId,
Integer firstResult,
Integer maxResults,
RealmModel realm)
Deprecated.
Use the corresponding method from
ClientProvider . |
default Set<RoleModel> |
RealmProvider.searchForClientRoles(RealmModel realm,
ClientModel client,
String search,
Integer first,
Integer max)
Deprecated.
Use the corresponding method from
RoleProvider . |
default List<GroupModel> |
RealmProvider.searchForGroupByName(RealmModel realm,
String search,
Integer first,
Integer max)
Deprecated.
Use the corresponding method from
GroupProvider . |
default Set<RoleModel> |
RealmProvider.searchForRoles(RealmModel realm,
String search,
Integer first,
Integer max)
Deprecated.
Use the corresponding method from
RoleProvider . |
void |
UserProvider.setNotBeforeForUser(RealmModel realm,
UserModel user,
int notBefore)
Sets the notBefore value for the given user
|
void |
KeycloakContext.setRealm(RealmModel realm) |
void |
UserProvider.unlinkUsers(RealmModel realm,
String storageProviderId)
Set federation link to
null to imported users of a specific User Storage Provider |
void |
UserProvider.updateConsent(RealmModel realm,
String userId,
UserConsentModel consent)
Update client scopes in the stored user consent
|
boolean |
UserCredentialManager.updateCredential(RealmModel realm,
UserModel user,
CredentialInput input)
Updates a credential.
|
void |
UserCredentialManager.updateCredentialLabel(RealmModel realm,
UserModel user,
String credentialId,
String userLabel)
Updates the credential label and invalidates the cache for the user.
|
void |
UserProvider.updateFederatedIdentity(RealmModel realm,
UserModel federatedUser,
FederatedIdentityModel federatedIdentityModel)
Update details of association between the federatedUser and the idp given by the federatedIdentityModel
|
boolean |
RealmProvider.updateLocalizationText(RealmModel realm,
String locale,
String key,
String text) |
void |
IdentityProviderModel.validate(RealmModel realm)
Validates this configuration.
|
Constructor and Description |
---|
CibaConfig(RealmModel realm) |
OAuth2DeviceConfig(RealmModel realm) |
ParConfig(RealmModel realm) |
Modifier and Type | Method and Description |
---|---|
void |
UserCache.evict(RealmModel realm)
Evict users of a specific realm
|
void |
UserCache.evict(RealmModel realm,
UserModel user)
Evict user from cache.
|
void |
OnUserCache.onCache(RealmModel realm,
CachedUserModel user,
UserModel delegate) |
Modifier and Type | Method and Description |
---|---|
static OTPCredentialModel |
OTPCredentialModel.createFromPolicy(RealmModel realm,
String secretValue) |
static OTPCredentialModel |
OTPCredentialModel.createFromPolicy(RealmModel realm,
String secretValue,
String userLabel) |
Modifier and Type | Method and Description |
---|---|
static boolean |
RoleUtils.isRealmRole(RoleModel r,
RealmModel realm) |
Modifier and Type | Method and Description |
---|---|
PolicyError |
PasswordPolicyProvider.validate(RealmModel realm,
UserModel user,
String password) |
Modifier and Type | Method and Description |
---|---|
ClientPoliciesRepresentation |
ClientPolicyManager.getClientPolicies(RealmModel realm)
when getting client policies via Admin REST API, returns the existing client policies set on the realm.
|
ClientProfilesRepresentation |
ClientPolicyManager.getClientProfiles(RealmModel realm,
boolean includeGlobalProfiles)
when getting client profiles via Admin REST API, returns the existing client profiles set on the realm.
|
void |
ClientPolicyManager.setupClientPoliciesOnCreatedRealm(RealmModel realm)
when creating a realm, adds the default client policies, which should be available on the realm and put them onto the realm as its attribute.
|
void |
ClientPolicyManager.updateClientPolicies(RealmModel realm,
ClientPoliciesRepresentation clientPolicies)
when updating client policies via Admin REST API, reads the json representation of the client policies
and overrides the existing client policies set on the realm with them.
|
void |
ClientPolicyManager.updateClientProfiles(RealmModel realm,
ClientProfilesRepresentation clientProfiles)
when updating client profiles via Admin REST API, reads the json representation of the client profiles
and overrides the existing client profiles set on the realm with them.
|
void |
ClientPolicyManager.updateRealmModelFromRepresentation(RealmModel realm,
RealmRepresentation rep)
when importing a realm, or updating a realm, update model from the representation object
|
void |
ClientPolicyManager.updateRealmRepresentationFromModel(RealmModel realm,
RealmRepresentation rep)
when exporting realm, or retrieve the realm for admin REST API, prepares the exported representation of the client profiles and policies.
|
Modifier and Type | Method and Description |
---|---|
RealmModel |
RootAuthenticationSessionModel.getRealm()
Returns realm associated to the root authentication session.
|
RealmModel |
CommonClientSessionModel.getRealm() |
Modifier and Type | Method and Description |
---|---|
RootAuthenticationSessionModel |
AuthenticationSessionProvider.createRootAuthenticationSession(RealmModel realm)
Creates and registers a new authentication session with random ID.
|
RootAuthenticationSessionModel |
AuthenticationSessionProvider.createRootAuthenticationSession(RealmModel realm,
String id)
Creates a new root authentication session specified by the provided realm and id.
|
default RootAuthenticationSessionModel |
AuthenticationSessionProvider.createRootAuthenticationSession(String id,
RealmModel realm)
Deprecated.
Use
AuthenticationSessionProvider.createRootAuthenticationSession(RealmModel, String) createRootAuthenticationSession} instead. |
RootAuthenticationSessionModel |
AuthenticationSessionProvider.getRootAuthenticationSession(RealmModel realm,
String authenticationSessionId)
Returns the root authentication session specified by the provided realm and id.
|
void |
AuthenticationSessionProvider.onClientRemoved(RealmModel realm,
ClientModel client)
Removes all associated root authentication sessions to the given realm and client which was removed.
|
void |
AuthenticationSessionProvider.onRealmRemoved(RealmModel realm)
Removes all associated root authentication sessions to the given realm which was removed.
|
void |
AuthenticationSessionProvider.removeExpired(RealmModel realm)
Removes all expired root authentication sessions for the given realm.
|
void |
AuthenticationSessionProvider.removeRootAuthenticationSession(RealmModel realm,
RootAuthenticationSessionModel authenticationSession)
Removes provided root authentication session.
|
void |
RootAuthenticationSessionModel.restartSession(RealmModel realm)
Will completely restart whole state of authentication session.
|
Modifier and Type | Method and Description |
---|---|
default void |
UserStorageProviderFactory.onCreate(KeycloakSession session,
RealmModel realm,
ComponentModel model)
Called when UserStorageProviderModel is created.
|
default void |
UserStorageProvider.preRemove(RealmModel realm)
Callback when a realm is removed.
|
default void |
UserStorageProvider.preRemove(RealmModel realm,
GroupModel group)
Callback when a group is removed.
|
default void |
UserStorageProvider.preRemove(RealmModel realm,
RoleModel role)
Callback when a role is removed.
|
default void |
UserStorageProviderFactory.validateConfiguration(KeycloakSession session,
RealmModel realm,
ComponentModel config) |
Modifier and Type | Field and Description |
---|---|
protected RealmModel |
AbstractUserAdapterFederatedStorage.realm |
protected RealmModel |
AbstractUserAdapter.realm |
Constructor and Description |
---|
AbstractUserAdapter(KeycloakSession session,
RealmModel realm,
ComponentModel storageProviderModel) |
AbstractUserAdapterFederatedStorage(KeycloakSession session,
RealmModel realm,
ComponentModel storageProviderModel) |
Streams(KeycloakSession session,
RealmModel realm,
ComponentModel storageProviderModel) |
Streams(KeycloakSession session,
RealmModel realm,
ComponentModel storageProviderModel) |
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.
|
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 |
default void |
ClientStorageProvider.preRemove(RealmModel realm)
Callback when a realm is removed.
|
default void |
ClientStorageProvider.preRemove(RealmModel realm,
GroupModel group)
Callback when a group is removed.
|
default void |
ClientStorageProvider.preRemove(RealmModel realm,
RoleModel role)
Callback when a role is removed.
|
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 |
---|---|
ClientScopeModel |
ClientScopeLookupProvider.getClientScopeById(RealmModel realm,
String id)
Exact search for a client scope by its internal ID..
|
Modifier and Type | Method and Description |
---|---|
void |
UserConsentFederatedStorage.addConsent(RealmModel realm,
String userId,
UserConsentModel consent) |
void |
UserBrokerLinkFederatedStorage.addFederatedIdentity(RealmModel realm,
String userId,
FederatedIdentityModel socialLink) |
void |
UserRequiredActionsFederatedStorage.addRequiredAction(RealmModel realm,
String userId,
String action) |
CredentialModel |
UserFederatedUserCredentialStore.createCredential(RealmModel realm,
String userId,
CredentialModel cred) |
void |
UserRoleMappingsFederatedStorage.deleteRoleMapping(RealmModel realm,
String userId,
RoleModel role) |
org.keycloak.common.util.MultivaluedHashMap<String,String> |
UserAttributeFederatedStorage.getAttributes(RealmModel realm,
String userId) |
UserConsentModel |
UserConsentFederatedStorage.getConsentByClient(RealmModel realm,
String userId,
String clientInternalId) |
List<UserConsentModel> |
UserConsentFederatedStorage.getConsents(RealmModel realm,
String userId)
Deprecated.
Use
getConsentsStream instead. |
default List<UserConsentModel> |
UserConsentFederatedStorage.Streams.getConsents(RealmModel realm,
String userId) |
default Stream<UserConsentModel> |
UserConsentFederatedStorage.getConsentsStream(RealmModel realm,
String userId)
Obtains the consents associated with the federated user identified by
userId . |
Stream<UserConsentModel> |
UserConsentFederatedStorage.Streams.getConsentsStream(RealmModel realm,
String userId) |
Set<FederatedIdentityModel> |
UserBrokerLinkFederatedStorage.getFederatedIdentities(String userId,
RealmModel realm)
Deprecated.
Use
getFederatedIdentitiesStream instead. |
default Set<FederatedIdentityModel> |
UserBrokerLinkFederatedStorage.Streams.getFederatedIdentities(String userId,
RealmModel realm) |
default Stream<FederatedIdentityModel> |
UserBrokerLinkFederatedStorage.getFederatedIdentitiesStream(String userId,
RealmModel realm)
Obtains the identities of the federated user identified by
userId . |
Stream<FederatedIdentityModel> |
UserBrokerLinkFederatedStorage.Streams.getFederatedIdentitiesStream(String userId,
RealmModel realm) |
FederatedIdentityModel |
UserBrokerLinkFederatedStorage.getFederatedIdentity(String userId,
String socialProvider,
RealmModel realm) |
Set<GroupModel> |
UserGroupMembershipFederatedStorage.getGroups(RealmModel realm,
String userId)
Deprecated.
Use
getGroupsStream instead. |
default Set<GroupModel> |
UserGroupMembershipFederatedStorage.Streams.getGroups(RealmModel realm,
String userId) |
default Stream<GroupModel> |
UserGroupMembershipFederatedStorage.getGroupsStream(RealmModel realm,
String userId)
Obtains the groups associated with the federated user.
|
Stream<GroupModel> |
UserGroupMembershipFederatedStorage.Streams.getGroupsStream(RealmModel realm,
String userId) |
List<String> |
UserGroupMembershipFederatedStorage.getMembership(RealmModel realm,
GroupModel group,
int firstResult,
int max)
Deprecated.
Use
getMembershipStream instead. |
default List<String> |
UserGroupMembershipFederatedStorage.Streams.getMembership(RealmModel realm,
GroupModel group,
int firstResult,
int max) |
default Stream<String> |
UserGroupMembershipFederatedStorage.getMembershipStream(RealmModel realm,
GroupModel group,
Integer firstResult,
Integer max)
Obtains the federated users that are members of the given
group in the specified realm . |
Stream<String> |
UserGroupMembershipFederatedStorage.Streams.getMembershipStream(RealmModel realm,
GroupModel group,
Integer firstResult,
Integer max) |
int |
UserNotBeforeFederatedStorage.getNotBeforeOfUser(RealmModel realm,
String userId) |
Set<String> |
UserRequiredActionsFederatedStorage.getRequiredActions(RealmModel realm,
String userId)
Deprecated.
Use
getRequiredActionsStream instead. |
default Set<String> |
UserRequiredActionsFederatedStorage.Streams.getRequiredActions(RealmModel realm,
String userId) |
default Stream<String> |
UserRequiredActionsFederatedStorage.getRequiredActionsStream(RealmModel realm,
String userId)
Obtains the names of required actions associated with the federated user identified by
userId . |
Stream<String> |
UserRequiredActionsFederatedStorage.Streams.getRequiredActionsStream(RealmModel realm,
String userId) |
Set<RoleModel> |
UserRoleMappingsFederatedStorage.getRoleMappings(RealmModel realm,
String userId)
Deprecated.
Use
getRoleMappingsStream instead. |
default Set<RoleModel> |
UserRoleMappingsFederatedStorage.Streams.getRoleMappings(RealmModel realm,
String userId) |
default Stream<RoleModel> |
UserRoleMappingsFederatedStorage.getRoleMappingsStream(RealmModel realm,
String userId)
Obtains the roles associated with the federated user identified by
userId . |
Stream<RoleModel> |
UserRoleMappingsFederatedStorage.Streams.getRoleMappingsStream(RealmModel realm,
String userId) |
CredentialModel |
UserFederatedUserCredentialStore.getStoredCredentialById(RealmModel realm,
String userId,
String id) |
CredentialModel |
UserFederatedUserCredentialStore.getStoredCredentialByNameAndType(RealmModel realm,
String userId,
String name,
String type) |
List<CredentialModel> |
UserFederatedUserCredentialStore.getStoredCredentials(RealmModel realm,
String userId)
Deprecated.
Use
getStoredCredentialsStream instead. |
default List<CredentialModel> |
UserFederatedUserCredentialStore.Streams.getStoredCredentials(RealmModel realm,
String userId) |
List<CredentialModel> |
UserFederatedUserCredentialStore.getStoredCredentialsByType(RealmModel realm,
String userId,
String type)
Deprecated.
Use
getStoredCredentialsByTypeStream instead. |
default List<CredentialModel> |
UserFederatedUserCredentialStore.Streams.getStoredCredentialsByType(RealmModel realm,
String userId,
String type) |
default Stream<CredentialModel> |
UserFederatedUserCredentialStore.getStoredCredentialsByTypeStream(RealmModel realm,
String userId,
String type)
Obtains the credentials of type
type that are associated with the federated user identified by userId . |
Stream<CredentialModel> |
UserFederatedUserCredentialStore.Streams.getStoredCredentialsByTypeStream(RealmModel realm,
String userId,
String type) |
default Stream<CredentialModel> |
UserFederatedUserCredentialStore.getStoredCredentialsStream(RealmModel realm,
String userId)
Obtains the credentials associated with the federated user identified by
userId . |
Stream<CredentialModel> |
UserFederatedUserCredentialStore.Streams.getStoredCredentialsStream(RealmModel realm,
String userId) |
List<String> |
UserFederatedStorageProvider.getStoredUsers(RealmModel realm,
int first,
int max)
Deprecated.
Use
getStoredUsersStream instead. |
default List<String> |
UserFederatedStorageProvider.Streams.getStoredUsers(RealmModel realm,
int first,
int max) |
int |
UserFederatedStorageProvider.getStoredUsersCount(RealmModel realm) |
default Stream<String> |
UserFederatedStorageProvider.getStoredUsersStream(RealmModel realm,
Integer first,
Integer max)
Obtains the ids of all federated users in the realm.
|
Stream<String> |
UserFederatedStorageProvider.Streams.getStoredUsersStream(RealmModel realm,
Integer first,
Integer max) |
String |
UserBrokerLinkFederatedStorage.getUserByFederatedIdentity(FederatedIdentityModel socialLink,
RealmModel realm) |
List<String> |
UserAttributeFederatedStorage.getUsersByUserAttribute(RealmModel realm,
String name,
String value)
Deprecated.
Use
getUsersByUserAttributeStream instead. |
default List<String> |
UserAttributeFederatedStorage.Streams.getUsersByUserAttribute(RealmModel realm,
String name,
String value) |
default Stream<String> |
UserAttributeFederatedStorage.getUsersByUserAttributeStream(RealmModel realm,
String name,
String value)
Searches for federated users that have an attribute with the specified
name and value . |
Stream<String> |
UserAttributeFederatedStorage.Streams.getUsersByUserAttributeStream(RealmModel realm,
String name,
String value) |
void |
UserRoleMappingsFederatedStorage.grantRole(RealmModel realm,
String userId,
RoleModel role) |
void |
UserGroupMembershipFederatedStorage.joinGroup(RealmModel realm,
String userId,
GroupModel group) |
void |
UserGroupMembershipFederatedStorage.leaveGroup(RealmModel realm,
String userId,
GroupModel group) |
void |
UserFederatedStorageProvider.preRemove(RealmModel realm) |
void |
UserFederatedStorageProvider.preRemove(RealmModel realm,
ClientModel client) |
void |
UserFederatedStorageProvider.preRemove(RealmModel realm,
ComponentModel model) |
void |
UserFederatedStorageProvider.preRemove(RealmModel realm,
GroupModel group) |
void |
UserBrokerLinkFederatedStorage.preRemove(RealmModel realm,
IdentityProviderModel provider) |
void |
UserFederatedStorageProvider.preRemove(RealmModel realm,
RoleModel role) |
void |
UserFederatedStorageProvider.preRemove(RealmModel realm,
UserModel user) |
void |
UserAttributeFederatedStorage.removeAttribute(RealmModel realm,
String userId,
String name) |
boolean |
UserBrokerLinkFederatedStorage.removeFederatedIdentity(RealmModel realm,
String userId,
String socialProvider) |
void |
UserRequiredActionsFederatedStorage.removeRequiredAction(RealmModel realm,
String userId,
String action) |
boolean |
UserFederatedUserCredentialStore.removeStoredCredential(RealmModel realm,
String userId,
String id) |
boolean |
UserConsentFederatedStorage.revokeConsentForClient(RealmModel realm,
String userId,
String clientInternalId) |
void |
UserAttributeFederatedStorage.setAttribute(RealmModel realm,
String userId,
String name,
List<String> values) |
void |
UserNotBeforeFederatedStorage.setNotBeforeForUser(RealmModel realm,
String userId,
int notBefore) |
void |
UserAttributeFederatedStorage.setSingleAttribute(RealmModel realm,
String userId,
String name,
String value) |
void |
UserConsentFederatedStorage.updateConsent(RealmModel realm,
String userId,
UserConsentModel consent) |
void |
UserFederatedUserCredentialStore.updateCredential(RealmModel realm,
String userId,
CredentialModel cred) |
void |
UserBrokerLinkFederatedStorage.updateFederatedIdentity(RealmModel realm,
String userId,
FederatedIdentityModel federatedIdentityModel) |
Modifier and Type | Method and Description |
---|---|
GroupModel |
GroupLookupProvider.getGroupById(RealmModel realm,
String id)
Returns a group from the given realm with the corresponding id
|
default List<GroupModel> |
GroupLookupProvider.searchForGroupByName(RealmModel realm,
String search,
Integer firstResult,
Integer maxResults)
Deprecated.
Use
searchForGroupByNameStream instead. |
Stream<GroupModel> |
GroupLookupProvider.searchForGroupByNameStream(RealmModel realm,
String search,
Integer firstResult,
Integer maxResults)
Returns the group hierarchy with the given string in name for the given realm.
|
Modifier and Type | Method and Description |
---|---|
RoleModel |
RoleLookupProvider.getRealmRole(RealmModel realm,
String name)
Exact search for a role by given name.
|
RoleModel |
RoleLookupProvider.getRoleById(RealmModel realm,
String id)
Exact search for a role by its internal ID..
|
Stream<RoleModel> |
RoleLookupProvider.searchForRolesStream(RealmModel realm,
String search,
Integer first,
Integer max)
Case-insensitive search for roles that contain the given string in their name or description.
|
Modifier and Type | Method and Description |
---|---|
UserModel |
UserRegistrationProvider.addUser(RealmModel realm,
String username)
All storage providers that implement this interface will be looped through.
|
List<UserModel> |
UserQueryProvider.getGroupMembers(RealmModel realm,
GroupModel group)
Deprecated.
Use
getGroupMembersStream instead. |
default List<UserModel> |
UserQueryProvider.Streams.getGroupMembers(RealmModel realm,
GroupModel group) |
List<UserModel> |
UserQueryProvider.getGroupMembers(RealmModel realm,
GroupModel group,
int firstResult,
int maxResults)
Deprecated.
Use
getGroupMembersStream instead. |
default List<UserModel> |
UserQueryProvider.Streams.getGroupMembers(RealmModel realm,
GroupModel group,
int firstResult,
int maxResults) |
default Stream<UserModel> |
UserQueryProvider.getGroupMembersStream(RealmModel realm,
GroupModel group)
Obtains users that belong to a specific group.
|
default Stream<UserModel> |
UserQueryProvider.Streams.getGroupMembersStream(RealmModel realm,
GroupModel group) |
default Stream<UserModel> |
UserQueryProvider.getGroupMembersStream(RealmModel realm,
GroupModel group,
Integer firstResult,
Integer maxResults)
Obtains users that belong to a specific group.
|
Stream<UserModel> |
UserQueryProvider.Streams.getGroupMembersStream(RealmModel realm,
GroupModel group,
Integer firstResult,
Integer maxResults) |
default List<UserModel> |
UserQueryProvider.getRoleMembers(RealmModel realm,
RoleModel role)
Deprecated.
Use
getRoleMembersStream instead. |
default List<UserModel> |
UserQueryProvider.getRoleMembers(RealmModel realm,
RoleModel role,
int firstResult,
int maxResults)
Deprecated.
Use
getRoleMembersStream instead. |
default Stream<UserModel> |
UserQueryProvider.getRoleMembersStream(RealmModel realm,
RoleModel role)
Obtains users that have the specified role.
|
default Stream<UserModel> |
UserQueryProvider.getRoleMembersStream(RealmModel realm,
RoleModel role,
Integer firstResult,
Integer maxResults)
Searches for users that have the specified role.
|
default UserModel |
UserLookupProvider.getUserByEmail(RealmModel realm,
String email)
Returns a user with the given email belonging to the realm
|
UserModel |
UserLookupProvider.Streams.getUserByEmail(RealmModel realm,
String email) |
UserModel |
UserLookupProvider.getUserByEmail(String email,
RealmModel realm)
Deprecated.
Use
getUserByEmail instead. |
default UserModel |
UserLookupProvider.Streams.getUserByEmail(String email,
RealmModel realm) |
default UserModel |
UserLookupProvider.getUserById(RealmModel realm,
String id)
Returns a user with the given id belonging to the realm
|
UserModel |
UserLookupProvider.Streams.getUserById(RealmModel realm,
String id) |
UserModel |
UserLookupProvider.getUserById(String id,
RealmModel realm)
Deprecated.
Use
getUserById instead. |
default UserModel |
UserLookupProvider.Streams.getUserById(String id,
RealmModel realm) |
default UserModel |
UserLookupProvider.getUserByUsername(RealmModel realm,
String username)
Returns a user with the given username belonging to the realm
|
UserModel |
UserLookupProvider.Streams.getUserByUsername(RealmModel realm,
String username) |
UserModel |
UserLookupProvider.getUserByUsername(String username,
RealmModel realm)
Deprecated.
Use
getUserByUsername instead. |
default UserModel |
UserLookupProvider.Streams.getUserByUsername(String username,
RealmModel realm) |
List<UserModel> |
UserQueryProvider.getUsers(RealmModel realm)
Deprecated.
Use
getUsersStream instead. |
default List<UserModel> |
UserQueryProvider.Streams.getUsers(RealmModel realm) |
List<UserModel> |
UserQueryProvider.getUsers(RealmModel realm,
int firstResult,
int maxResults)
Deprecated.
Use
getUsersStream instead. |
default List<UserModel> |
UserQueryProvider.Streams.getUsers(RealmModel realm,
int firstResult,
int maxResults) |
default int |
UserQueryProvider.getUsersCount(Map<String,String> params,
RealmModel realm)
Deprecated.
Use
getUsersCount instead. |
default int |
UserQueryProvider.Streams.getUsersCount(Map<String,String> params,
RealmModel realm) |
default int |
UserQueryProvider.getUsersCount(Map<String,String> params,
RealmModel realm,
Set<String> groupIds)
Deprecated.
Use
getUsersCount instead. |
default int |
UserQueryProvider.Streams.getUsersCount(Map<String,String> params,
RealmModel realm,
Set<String> groupIds) |
default int |
UserQueryProvider.getUsersCount(RealmModel realm)
Returns the number of users, without consider any service account.
|
default int |
UserQueryProvider.getUsersCount(RealmModel realm,
boolean includeServiceAccount)
Returns the number of users.
|
default int |
UserQueryProvider.getUsersCount(RealmModel realm,
Map<String,String> params)
Returns the number of users that match the given filter parameters.
|
default int |
UserQueryProvider.Streams.getUsersCount(RealmModel realm,
Map<String,String> params) |
default int |
UserQueryProvider.getUsersCount(RealmModel realm,
Map<String,String> params,
Set<String> groupIds)
Returns the number of users that match the given filter parameters and is in
at least one of the given groups.
|
default int |
UserQueryProvider.Streams.getUsersCount(RealmModel realm,
Map<String,String> params,
Set<String> groupIds) |
default int |
UserQueryProvider.getUsersCount(RealmModel realm,
Set<String> groupIds)
Returns the number of users that are in at least one of the groups
given.
|
default int |
UserQueryProvider.getUsersCount(RealmModel realm,
String search)
Returns the number of users that would be returned by a call to
searchForUserStream |
default int |
UserQueryProvider.Streams.getUsersCount(RealmModel realm,
String search) |
default int |
UserQueryProvider.getUsersCount(RealmModel realm,
String search,
Set<String> groupIds)
Returns the number of users that would be returned by a call to
searchForUserStream
and are members of at least one of the groups given by the groupIds set. |
default int |
UserQueryProvider.Streams.getUsersCount(RealmModel realm,
String search,
Set<String> groupIds) |
default int |
UserQueryProvider.getUsersCount(String search,
RealmModel realm)
Deprecated.
Use
getUsersCount |
default int |
UserQueryProvider.Streams.getUsersCount(String search,
RealmModel realm) |
default int |
UserQueryProvider.getUsersCount(String search,
RealmModel realm,
Set<String> groupIds)
Deprecated.
Use
getUsersCount instead. |
default int |
UserQueryProvider.Streams.getUsersCount(String search,
RealmModel realm,
Set<String> groupIds) |
default Stream<UserModel> |
UserQueryProvider.getUsersStream(RealmModel realm)
Searches all users in the realm.
|
default Stream<UserModel> |
UserQueryProvider.Streams.getUsersStream(RealmModel realm) |
default Stream<UserModel> |
UserQueryProvider.getUsersStream(RealmModel realm,
Integer firstResult,
Integer maxResults)
Searches all users in the realm, starting from the
firstResult and containing at most maxResults . |
Stream<UserModel> |
UserQueryProvider.Streams.getUsersStream(RealmModel realm,
Integer firstResult,
Integer maxResults) |
void |
UserBulkUpdateProvider.grantToAllUsers(RealmModel realm,
RoleModel role)
Grants the given role to all users from particular realm.
|
boolean |
UserRegistrationProvider.removeUser(RealmModel realm,
UserModel user)
Called if user originated from this provider.
|
List<UserModel> |
UserQueryProvider.searchForUser(Map<String,String> params,
RealmModel realm)
Deprecated.
Use
searchForUserStream instead. |
default List<UserModel> |
UserQueryProvider.Streams.searchForUser(Map<String,String> params,
RealmModel realm) |
List<UserModel> |
UserQueryProvider.searchForUser(Map<String,String> params,
RealmModel realm,
int firstResult,
int maxResults)
Deprecated.
Use
searchForUserStream instead. |
default List<UserModel> |
UserQueryProvider.Streams.searchForUser(Map<String,String> params,
RealmModel realm,
int firstResult,
int maxResults) |
List<UserModel> |
UserQueryProvider.searchForUser(String search,
RealmModel realm)
Deprecated.
Use
searchForUserStream instead. |
default List<UserModel> |
UserQueryProvider.Streams.searchForUser(String search,
RealmModel realm) |
List<UserModel> |
UserQueryProvider.searchForUser(String search,
RealmModel realm,
int firstResult,
int maxResults)
Deprecated.
Use
searchForUserStream instead. |
default List<UserModel> |
UserQueryProvider.Streams.searchForUser(String search,
RealmModel realm,
int firstResult,
int maxResults) |
List<UserModel> |
UserQueryProvider.searchForUserByUserAttribute(String attrName,
String attrValue,
RealmModel realm)
Deprecated.
Use
searchForUserByUserAttributeStream
instead. |
default List<UserModel> |
UserQueryProvider.Streams.searchForUserByUserAttribute(String attrName,
String attrValue,
RealmModel realm) |
default Stream<UserModel> |
UserQueryProvider.searchForUserByUserAttributeStream(RealmModel realm,
String attrName,
String attrValue)
Searches for users that have a specific attribute with a specific value.
|
Stream<UserModel> |
UserQueryProvider.Streams.searchForUserByUserAttributeStream(RealmModel realm,
String attrName,
String attrValue) |
default Stream<UserModel> |
UserQueryProvider.searchForUserStream(RealmModel realm,
Map<String,String> params)
Searches for user by parameter.
|
default Stream<UserModel> |
UserQueryProvider.Streams.searchForUserStream(RealmModel realm,
Map<String,String> params) |
default Stream<UserModel> |
UserQueryProvider.searchForUserStream(RealmModel realm,
Map<String,String> params,
Integer firstResult,
Integer maxResults)
Searches for user by parameter.
|
Stream<UserModel> |
UserQueryProvider.Streams.searchForUserStream(RealmModel realm,
Map<String,String> params,
Integer firstResult,
Integer maxResults) |
default Stream<UserModel> |
UserQueryProvider.searchForUserStream(RealmModel realm,
String search)
Searches for users whose username, email, first name or last name contain any of the strings in
search separated by whitespace. |
default Stream<UserModel> |
UserQueryProvider.Streams.searchForUserStream(RealmModel realm,
String search) |
default Stream<UserModel> |
UserQueryProvider.searchForUserStream(RealmModel realm,
String search,
Integer firstResult,
Integer maxResults)
Searches for users whose username, email, first name or last name contain any of the strings in
search separated by whitespace. |
Stream<UserModel> |
UserQueryProvider.Streams.searchForUserStream(RealmModel realm,
String search,
Integer firstResult,
Integer maxResults) |
UserModel |
ImportedUserValidation.validate(RealmModel realm,
UserModel user)
If this method returns null, then the user in local storage will be removed
|
Copyright © 2021 JBoss by Red Hat. All rights reserved.