Package org.keycloak.services.resources.admin

Class RealmsAdminResource

java.lang.Object
org.keycloak.services.resources.admin.RealmsAdminResource
Direct Known Subclasses:
RealmsAdminResourcePreflight
public class RealmsAdminResource extends Object
Top level resource for Admin REST API
Version:
$Revision: 1 $
Author:
Bill Burke

  • Field Details

    • logger

      protected static final org.jboss.logging.Logger logger

    • auth

      protected final AdminAuth auth

    • tokenManager

      protected final TokenManager tokenManager

    • session

      protected final KeycloakSession session

    • clientConnection

      protected final ClientConnection clientConnection

    • noCache

      public static final jakarta.ws.rs.core.CacheControl noCache

  • Constructor Details

  • Method Details

    • getRealms

      @GET @Produces("application/json") public Stream<RealmRepresentation> getRealms(@DefaultValue("false") @QueryParam("briefRepresentation") boolean briefRepresentation)
      Get accessible realms Returns a list of accessible realms. The list is filtered based on what realms the caller is allowed to view.
      Returns:

    • toRealmRep

      protected RealmRepresentation toRealmRep(RealmModel realm, boolean briefRep)

    • importRealm

      @POST @Consumes("application/json") public jakarta.ws.rs.core.Response importRealm(InputStream requestBody)
      Import a realm.

      Imports a realm from a full representation of that realm. Realm name must be unique.

    • getRealmAdmin

      @Path("{realm}") public RealmAdminResource getRealmAdmin(@PathParam("realm") String name)
      Base path for the admin REST API for one particular realm.
      Parameters:
      name - realm name (not id!)