Keycloak custom exception in User Storage SPI

Question

We have our own implementation of UserStorageProvider and UserRegistrationProvider. In addUser I want to throw custom exception

@Override
public UserModel addUser(RealmModel realmModel, String s) {
  throw new CustomException("Custom exception");
}

But how to handle it from client side? I always getting 500 Internal Server Error with

{"error":"unknown_error"}

response in it. I want to see another status code and error message. How to achieve such behavior? Thanks.

Answer 1

You can try extending one of Keycloak's Exception classes.

For example using org.keycloak.services.ErrorResponseException you can define (String error, String errorDescription, Response.Status status) in the constructor.

You can also check all Exceptions that extend javax.ws.rs.WebApplicationException, maybe you will find more suitable example for your case.