org.keycloak.storage.user

Interface UserRegistrationProvider

All Known Subinterfaces:

UserCache, UserProvider

public interface UserRegistrationProvider

Optional capability interface implemented by UserStorageProviders. Implement this interface if your provider supports adding and removing users.

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method and Description
UserModel	addUser(RealmModel realm, String username) All storage providers that implement this interface will be looped through.
boolean	removeUser(RealmModel realm, UserModel user) Called if user originated from this provider.

Method Detail

addUser

UserModel addUser(RealmModel realm,
                  String username)

All storage providers that implement this interface will be looped through. If this method returns null, then the next storage provider's addUser() method will be called. If no storage providers handle the add, then the user will be created in local storage. Returning null is useful when you want optional support for adding users. For example, our LDAP provider can enable and disable the ability to add users.

Parameters:

realm -

username -

Returns:

removeUser

boolean removeUser(RealmModel realm,
                   UserModel user)

Called if user originated from this provider. If a local user is linked to this provider, this method will be called before local storage's removeUser() method is invoked. If you are using an import strategy, and this is a local user linked to this provider, this method will be called before local storage's removeUser() method is invoked. Also, you DO NOT need to remove the imported user. The runtime will handle this for you.

Parameters:

realm -

user -

Returns: