Package org.keycloak.services.resources.admin

Class AdminRoot

java.lang.Object
org.keycloak.services.resources.admin.AdminRoot
@Provider @Path("/admin") public class AdminRoot extends Object
Root resource for admin console and admin REST API
Version:
$Revision: 1 $
Author:
Bill Burke

  • Field Details

    • logger

      protected static final org.jboss.logging.Logger logger

    • tokenManager

      protected TokenManager tokenManager

    • session

      @Context protected KeycloakSession session

  • Constructor Details

    • AdminRoot

      public AdminRoot()

  • Method Details

    • adminBaseUrl

      public static jakarta.ws.rs.core.UriBuilder adminBaseUrl(jakarta.ws.rs.core.UriInfo uriInfo)

    • adminBaseUrl

      public static jakarta.ws.rs.core.UriBuilder adminBaseUrl(jakarta.ws.rs.core.UriBuilder base)

    • masterRealmAdminConsoleRedirect

      @GET public jakarta.ws.rs.core.Response masterRealmAdminConsoleRedirect()
      Convenience path to master realm admin console
      Returns:

    • masterRealmAdminConsoleRedirectHtml

      @Path("index.{html:html}") @GET public jakarta.ws.rs.core.Response masterRealmAdminConsoleRedirectHtml()
      Convenience path to master realm admin console
      Returns:

    • resolveRealmAndUpdateSession

      protected void resolveRealmAndUpdateSession(String name, KeycloakSession session)

    • adminConsoleUrl

      public static jakarta.ws.rs.core.UriBuilder adminConsoleUrl(jakarta.ws.rs.core.UriInfo uriInfo)

    • adminConsoleUrl

      public static jakarta.ws.rs.core.UriBuilder adminConsoleUrl(jakarta.ws.rs.core.UriBuilder base)

    • getAdminConsole

      @Path("{realm}/console") public AdminConsole getAdminConsole(@PathParam("realm") String name)
      path to realm admin console ui
      Parameters:
      name - Realm name (not id!)
      Returns:

    • authenticateRealmAdminRequest

      protected AdminAuth authenticateRealmAdminRequest(jakarta.ws.rs.core.HttpHeaders headers)

    • realmsUrl

      public static jakarta.ws.rs.core.UriBuilder realmsUrl(jakarta.ws.rs.core.UriInfo uriInfo)

    • realmsUrl

      public static jakarta.ws.rs.core.UriBuilder realmsUrl(jakarta.ws.rs.core.UriBuilder base)

    • getRealmsAdmin

      @Path("realms") public RealmsAdminResource getRealmsAdmin()
      Base Path to realm admin REST interface
      Parameters:
      headers -
      Returns:

    • preFlight

      @Path("{any:.*}") @OPTIONS public Object preFlight()

    • getServerInfo

      @Path("serverinfo") public Object getServerInfo()
      General information about the server
      Parameters:
      headers -
      Returns:

    • getTheme

      public static Theme getTheme(KeycloakSession session, RealmModel realm) throws IOException
      Throws:
      IOException

    • getMessages

      public static Properties getMessages(KeycloakSession session, RealmModel realm, String lang)

    • getMessages

      public static Properties getMessages(KeycloakSession session, RealmModel realm, String lang, String... bundles)