org.keycloak.services.resources.admin

## Class AdminConsole

- java.lang.Object
- - org.keycloak.services.resources.admin.AdminConsole

-     public class AdminConsole
      extends Object

  Version:
    $Revision: 1 $
  Author:
    Bill Burke

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `AdminConsole.WhoAmI`

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected ClientConnection` | `clientConnection`
    `protected static org.jboss.logging.Logger` | `logger`
    `protected javax.ws.rs.ext.Providers` | `providers`
    `protected RealmModel` | `realm`
    `protected org.jboss.resteasy.spi.HttpRequest` | `request`
    `protected org.jboss.resteasy.spi.HttpResponse` | `response`
    `protected KeycloakSession` | `session`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `AdminConsole(RealmModel realm)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `ClientManager.InstallationAdapterConfig` | `config()` Adapter configuration for the admin console for this realm
    `protected RealmModel` | `getAdminstrationRealm(RealmManager realmManager)`
    `javax.ws.rs.core.Response` | `getIndexHtmlRedirect()`
    `javax.ws.rs.core.Response` | `getMainPage()` Main page of this realm's admin console
    `Properties` | `getMessages(String lang)`
    `javax.ws.rs.core.Response` | `logout()` Logout from the admin console
    `javax.ws.rs.core.Response` | `whoAmI(javax.ws.rs.core.HttpHeaders headers)` Permission information
    `javax.ws.rs.core.Response` | `whoAmIPreFlight()`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### logger

          protected static final org.jboss.logging.Logger logger

    - #### clientConnection

          @Context
          protected ClientConnection clientConnection

    - #### request

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

    - #### response

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

    - #### session

          @Context
          protected KeycloakSession session

    - #### providers

          @Context
          protected javax.ws.rs.ext.Providers providers

    - #### realm

          protected RealmModel realm

  - ### Constructor Detail

    - #### AdminConsole

          public AdminConsole(RealmModel realm)

  - ### Method Detail

    - #### config

          @Path(value="config")
           @GET
           @Produces(value="application/json")
          public ClientManager.InstallationAdapterConfig config()

      Adapter configuration for the admin console for this realm
      Returns:

    - #### whoAmIPreFlight

          @Path(value="whoami")
           @OPTIONS
          public javax.ws.rs.core.Response whoAmIPreFlight()

    - #### whoAmI

          @Path(value="whoami")
           @GET
           @Produces(value="application/json")
          public javax.ws.rs.core.Response whoAmI(@Context
                                                                                                                   javax.ws.rs.core.HttpHeaders headers)

      Permission information
      Parameters:
        `headers` -
      Returns:

    - #### logout

          @Path(value="logout")
           @GET
          public javax.ws.rs.core.Response logout()

      Logout from the admin console
      Returns:

    - #### getAdminstrationRealm

          protected RealmModel getAdminstrationRealm(RealmManager realmManager)

    - #### getMainPage

          @GET
          public javax.ws.rs.core.Response getMainPage()
                                                     throws IOException,
                                                            FreeMarkerException

      Main page of this realm's admin console
      Returns:
      Throws:
        `URISyntaxException`
        `IOException`
        `FreeMarkerException`

    - #### getIndexHtmlRedirect

          @GET
           @Path(value="{indexhtml: index.html}")
          public javax.ws.rs.core.Response getIndexHtmlRedirect()

    - #### getMessages

          @GET
           @Path(value="messages.json")
           @Produces(value="application/json")
          public Properties getMessages(@QueryParam(value="lang")
                                                                                                                String lang)

Copyright © 2021 JBoss by Red Hat. All rights reserved.