public interface UserProvider extends Provider, UserLookupProvider, UserQueryProvider, UserRegistrationProvider, UserBulkUpdateProvider
Modifier and Type | Interface and Description |
---|---|
static interface |
UserProvider.Streams |
Modifier and Type | Method and Description |
---|---|
void |
addConsent(RealmModel realm,
String userId,
UserConsentModel consent) |
void |
addFederatedIdentity(RealmModel realm,
UserModel user,
FederatedIdentityModel socialLink) |
UserModel |
addUser(RealmModel realm,
String id,
String username,
boolean addDefaultRoles,
boolean addDefaultRequiredActions)
only used for local storage
|
void |
close() |
UserConsentModel |
getConsentByClient(RealmModel realm,
String userId,
String clientInternalId) |
List<UserConsentModel> |
getConsents(RealmModel realm,
String userId)
Deprecated.
Use
getConsentsStream instead. |
default Stream<UserConsentModel> |
getConsentsStream(RealmModel realm,
String userId)
Obtains the consents associated with the user identified by the specified
userId . |
Set<FederatedIdentityModel> |
getFederatedIdentities(UserModel user,
RealmModel realm)
Deprecated.
Use
getFederatedIdentitiesStream instead. |
default Stream<FederatedIdentityModel> |
getFederatedIdentitiesStream(UserModel user,
RealmModel realm)
Obtains the federated identities of the specified user.
|
FederatedIdentityModel |
getFederatedIdentity(UserModel user,
String socialProvider,
RealmModel realm) |
int |
getNotBeforeOfUser(RealmModel realm,
UserModel user) |
UserModel |
getServiceAccount(ClientModel client) |
UserModel |
getUserByFederatedIdentity(FederatedIdentityModel socialLink,
RealmModel realm) |
List<UserModel> |
getUsers(RealmModel realm,
boolean includeServiceAccounts)
Deprecated.
Use
getUsersStream instead. |
List<UserModel> |
getUsers(RealmModel realm,
int firstResult,
int maxResults,
boolean includeServiceAccounts)
Deprecated.
Use
getUsersStream instead. |
default Stream<UserModel> |
getUsersStream(RealmModel realm,
boolean includeServiceAccounts)
Obtains the users associated with the specified realm.
|
default Stream<UserModel> |
getUsersStream(RealmModel realm,
Integer firstResult,
Integer maxResults,
boolean includeServiceAccounts)
Obtains the users associated with the specified realm.
|
void |
preRemove(ClientScopeModel clientScope) |
void |
preRemove(ProtocolMapperModel protocolMapper) |
void |
preRemove(RealmModel realm) |
void |
preRemove(RealmModel realm,
ClientModel client) |
void |
preRemove(RealmModel realm,
ComponentModel component) |
void |
preRemove(RealmModel realm,
GroupModel group) |
void |
preRemove(RealmModel realm,
IdentityProviderModel provider) |
void |
preRemove(RealmModel realm,
RoleModel role) |
boolean |
removeFederatedIdentity(RealmModel realm,
UserModel user,
String socialProvider) |
void |
removeImportedUsers(RealmModel realm,
String storageProviderId)
Removes any imported users from a specific User Storage Provider.
|
boolean |
revokeConsentForClient(RealmModel realm,
String userId,
String clientInternalId) |
void |
setNotBeforeForUser(RealmModel realm,
UserModel user,
int notBefore) |
void |
unlinkUsers(RealmModel realm,
String storageProviderId)
Set federation link to null to imported users of a specific User Storage Provider
|
void |
updateConsent(RealmModel realm,
String userId,
UserConsentModel consent) |
void |
updateFederatedIdentity(RealmModel realm,
UserModel federatedUser,
FederatedIdentityModel federatedIdentityModel) |
getUserByEmail, getUserById, getUserByUsername
countUsersInGroups, getGroupMembers, getGroupMembers, getGroupMembersStream, getGroupMembersStream, getRoleMembers, getRoleMembers, getRoleMembersStream, getRoleMembersStream, getUsers, getUsers, getUsersCount, getUsersCount, getUsersCount, getUsersCount, getUsersCount, getUsersCount, getUsersCount, getUsersStream, getUsersStream, searchForUser, searchForUser, searchForUser, searchForUser, searchForUserByUserAttribute, searchForUserByUserAttributeStream, searchForUserStream, searchForUserStream, searchForUserStream, searchForUserStream
addUser, removeUser
grantToAllUsers
void addFederatedIdentity(RealmModel realm, UserModel user, FederatedIdentityModel socialLink)
boolean removeFederatedIdentity(RealmModel realm, UserModel user, String socialProvider)
void preRemove(RealmModel realm, IdentityProviderModel provider)
void updateFederatedIdentity(RealmModel realm, UserModel federatedUser, FederatedIdentityModel federatedIdentityModel)
@Deprecated Set<FederatedIdentityModel> getFederatedIdentities(UserModel user, RealmModel realm)
getFederatedIdentitiesStream
instead.default Stream<FederatedIdentityModel> getFederatedIdentitiesStream(UserModel user, RealmModel realm)
user
- a reference to the user.realm
- a reference to the realm.Stream
of federated identities associated with the user.FederatedIdentityModel getFederatedIdentity(UserModel user, String socialProvider, RealmModel realm)
UserModel getUserByFederatedIdentity(FederatedIdentityModel socialLink, RealmModel realm)
void addConsent(RealmModel realm, String userId, UserConsentModel consent)
UserConsentModel getConsentByClient(RealmModel realm, String userId, String clientInternalId)
@Deprecated List<UserConsentModel> getConsents(RealmModel realm, String userId)
getConsentsStream
instead.default Stream<UserConsentModel> getConsentsStream(RealmModel realm, String userId)
userId
.realm
- a reference to the realm.userId
- the user identifier.Stream
of consents associated with the user.void updateConsent(RealmModel realm, String userId, UserConsentModel consent)
realm
- userId
- consent
- ModelException
- when consent doesn't exist for the userIdboolean revokeConsentForClient(RealmModel realm, String userId, String clientInternalId)
void setNotBeforeForUser(RealmModel realm, UserModel user, int notBefore)
int getNotBeforeOfUser(RealmModel realm, UserModel user)
UserModel getServiceAccount(ClientModel client)
client
- IllegalArgumentException
- when there are more service accounts associated with the given clientId@Deprecated List<UserModel> getUsers(RealmModel realm, boolean includeServiceAccounts)
getUsersStream
instead.default Stream<UserModel> getUsersStream(RealmModel realm, boolean includeServiceAccounts)
realm
- a reference to the realm being used for the search.includeServiceAccounts
- true
if service accounts should be included in the result; false
otherwise.Stream
of users associated withe the realm.@Deprecated List<UserModel> getUsers(RealmModel realm, int firstResult, int maxResults, boolean includeServiceAccounts)
getUsersStream
instead.default Stream<UserModel> getUsersStream(RealmModel realm, Integer firstResult, Integer maxResults, boolean includeServiceAccounts)
realm
- a reference to the realm being used for the search.firstResult
- first result to return. Ignored if negative.maxResults
- maximum number of results to return. Ignored if negative.includeServiceAccounts
- true
if service accounts should be included in the result; false
otherwise.Stream
of users associated withe the realm.UserModel addUser(RealmModel realm, String id, String username, boolean addDefaultRoles, boolean addDefaultRequiredActions)
realm
- id
- username
- addDefaultRoles
- addDefaultRequiredActions
- void preRemove(RealmModel realm)
void removeImportedUsers(RealmModel realm, String storageProviderId)
realm
- storageProviderId
- void unlinkUsers(RealmModel realm, String storageProviderId)
realm
- storageProviderId
- void preRemove(RealmModel realm, RoleModel role)
void preRemove(RealmModel realm, GroupModel group)
void preRemove(RealmModel realm, ClientModel client)
void preRemove(ProtocolMapperModel protocolMapper)
void preRemove(ClientScopeModel clientScope)
void preRemove(RealmModel realm, ComponentModel component)
Copyright © 2020 JBoss by Red Hat. All rights reserved.