Package org.keycloak.services.resources.admin

Class AdminRoot

  • @Path("/admin")
public class AdminRoot
extends Object
    Root resource for admin console and admin REST API
    Version:
    $Revision: 1 $
    Author:
    Bill Burke

    • Field Detail

      • logger

        protected static final org.jboss.logging.Logger logger

      • clientConnection

        @Context
protected org.keycloak.common.ClientConnection clientConnection

      • request

        @Context
protected org.jboss.resteasy.spi.HttpRequest request

      • response

        @Context
protected org.jboss.resteasy.spi.HttpResponse response

      • session

        @Context
protected org.keycloak.models.KeycloakSession session

    • Constructor Detail

      • AdminRoot

        public AdminRoot()

    • Method Detail

      • adminBaseUrl

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

      • adminBaseUrl

        public static javax.ws.rs.core.UriBuilder adminBaseUrl​(javax.ws.rs.core.UriBuilder base)

      • masterRealmAdminConsoleRedirect

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

      • masterRealmAdminConsoleRedirectHtml

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

      • locateRealm

        protected org.keycloak.models.RealmModel locateRealm​(String name,
                                                     RealmManager realmManager)

      • adminConsoleUrl

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

      • adminConsoleUrl

        public static javax.ws.rs.core.UriBuilder adminConsoleUrl​(javax.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​(javax.ws.rs.core.HttpHeaders headers)

      • realmsUrl

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

      • realmsUrl

        public static javax.ws.rs.core.UriBuilder realmsUrl​(javax.ws.rs.core.UriBuilder base)

      • getRealmsAdmin

        @Path("realms")
public Object getRealmsAdmin​(@Context
                             javax.ws.rs.core.HttpHeaders headers)
        Base Path to realm admin REST interface
        Parameters:
        headers -
        Returns:

      • getServerInfo

        @Path("serverinfo")
public Object getServerInfo​(@Context
                            javax.ws.rs.core.HttpHeaders headers)
        General information about the server
        Parameters:
        headers -
        Returns:

      • getTheme

        public static org.keycloak.theme.Theme getTheme​(org.keycloak.models.KeycloakSession session,
                                                org.keycloak.models.RealmModel realm)
                                         throws IOException
        Throws:
        IOException

      • getMessages

        public static Properties getMessages​(org.keycloak.models.KeycloakSession session,
                                     org.keycloak.models.RealmModel realm,
                                     String lang)

      • getMessages

        public static Properties getMessages​(org.keycloak.models.KeycloakSession session,
                                     org.keycloak.models.RealmModel realm,
                                     String lang,
                                     String... bundles)