org.keycloak.storage.user

Interface ImportedUserValidation

All Known Implementing Classes:

KerberosFederationProvider, LDAPStorageProvider, SSSDFederationProvider

public interface ImportedUserValidation

This is an optional capability interface that is intended to be implemented by any UserStorageProvider that supports validating users. You must implement this interface if your storage imports users into the Keycloak local storage and you want to sync these users with your storage. The idea is, that whenever keycloak queries users imported from your storage, the method validate() is called and if it returns null, the user is removed from local storage and reloaded from your storage by corresponding method.

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method and Description
UserModel	validate(RealmModel realm, UserModel user) If this method returns null, then the user in local storage will be removed

Method Detail

validate

UserModel validate(RealmModel realm,
                   UserModel user)

If this method returns null, then the user in local storage will be removed

Parameters:

realm -

user -

Returns:

null if user no longer valid