Package org.keycloak.services.resources

Class RealmsResource

java.lang.Object
org.keycloak.services.resources.RealmsResource
@Provider @Path("/realms") public class RealmsResource extends Object
Version:
$Revision: 1 $
Author:
Bill Burke

  • Field Details

    • logger

      protected static final org.jboss.logging.Logger logger

    • session

      @Context protected KeycloakSession session

  • Constructor Details

    • RealmsResource

      public RealmsResource()

  • Method Details

    • realmBaseUrl

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

    • realmBaseUrl

      public static jakarta.ws.rs.core.UriBuilder realmBaseUrl(jakarta.ws.rs.core.UriBuilder baseUriBuilder)

    • accountUrl

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

    • protocolUrl

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

    • protocolUrl

      public static jakarta.ws.rs.core.UriBuilder protocolUrl(jakarta.ws.rs.core.UriBuilder builder)

    • clientRegistrationUrl

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

    • brokerUrl

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

    • wellKnownProviderUrl

      public static jakarta.ws.rs.core.UriBuilder wellKnownProviderUrl(jakarta.ws.rs.core.UriBuilder builder)

    • getProtocol

      @Path("{realm}/protocol/{protocol}") public Object getProtocol(@PathParam("realm") String name, @PathParam("protocol") String protocol)

    • getRedirect

      @GET @Path("{realm}/clients/{client_id}/redirect") public jakarta.ws.rs.core.Response getRedirect(@PathParam("realm") String realmName, @PathParam("client_id") String clientId)
      Returns a temporary redirect to the client url configured for the given clientId in the given realmName.

      This allows a client to refer to other clients just by their client id in URLs, will then redirect users to the actual client url. The client url is derived according to the rules of the base url in the client configuration.

      Parameters:
      realmName -
      clientId -
      Returns:
      Since:
      2.0

    • getLoginActionsService

      @Path("{realm}/login-actions") public LoginActionsService getLoginActionsService(@PathParam("realm") String name)

    • getClientsService

      @Path("{realm}/clients-registrations") public ClientRegistrationService getClientsService(@PathParam("realm") String name)

    • getClientsManagementService

      @Path("{realm}/clients-managements") public ClientsManagementService getClientsManagementService(@PathParam("realm") String name)

    • getAccountService

      @Path("{realm}/account") public Object getAccountService(@PathParam("realm") String name)

    • getRealmResource

      @Path("{realm}") public PublicRealmResource getRealmResource(@PathParam("realm") String name)

    • getBrokerService

      @Path("{realm}/broker") public IdentityBrokerService getBrokerService(@PathParam("realm") String name)

    • getVersionPreflight

      @OPTIONS @Path("{realm}/.well-known/{provider}") @Produces("application/json") public jakarta.ws.rs.core.Response getVersionPreflight(@PathParam("realm") String name, @PathParam("provider") String providerName)

    • getWellKnown

      @GET @Path("{realm}/.well-known/{alias}") @Produces("application/json") public jakarta.ws.rs.core.Response getWellKnown(@PathParam("realm") String name, @PathParam("alias") String alias)

    • getAuthorizationService

      @Path("{realm}/authz") public Object getAuthorizationService(@PathParam("realm") String name)

    • resolveRealmExtension

      @Path("{realm}/{extension}") public Object resolveRealmExtension(@PathParam("realm") String realmName, @PathParam("extension") String extension)
      A JAX-RS sub-resource locator that uses the RealmResourceSPI to resolve sub-resources instances given an unknownPath.
      Parameters:
      extension - a path that could be to a REST extension
      Returns:
      a JAX-RS sub-resource instance for the REST extension if found. Otherwise null is returned.