Package org.keycloak.services.resources
Class RealmsResource
- java.lang.Object
-
- org.keycloak.services.resources.RealmsResource
-
@Path("/realms") public class RealmsResource extends Object
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Field Summary
Fields Modifier and Type Field Description protected static org.jboss.logging.Logger
logger
protected KeycloakSession
session
-
Constructor Summary
Constructors Constructor Description RealmsResource()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static javax.ws.rs.core.UriBuilder
accountUrl(javax.ws.rs.core.UriBuilder base)
static javax.ws.rs.core.UriBuilder
brokerUrl(javax.ws.rs.core.UriInfo uriInfo)
static javax.ws.rs.core.UriBuilder
clientRegistrationUrl(javax.ws.rs.core.UriInfo uriInfo)
Object
getAccountService(String name)
Object
getAuthorizationService(String name)
IdentityBrokerService
getBrokerService(String name)
ClientsManagementService
getClientsManagementService(String name)
ClientRegistrationService
getClientsService(String name)
LoginActionsService
getLoginActionsService(String name)
Object
getProtocol(String name, String protocol)
PublicRealmResource
getRealmResource(String name)
javax.ws.rs.core.Response
getRedirect(String realmName, String clientId)
Returns a temporary redirect to the client url configured for the givenclientId
in the givenrealmName
.javax.ws.rs.core.Response
getVersionPreflight(String name, String providerName)
javax.ws.rs.core.Response
getWellKnown(String name, String alias)
static javax.ws.rs.core.UriBuilder
protocolUrl(javax.ws.rs.core.UriBuilder builder)
static javax.ws.rs.core.UriBuilder
protocolUrl(javax.ws.rs.core.UriInfo uriInfo)
static javax.ws.rs.core.UriBuilder
realmBaseUrl(javax.ws.rs.core.UriBuilder baseUriBuilder)
static javax.ws.rs.core.UriBuilder
realmBaseUrl(javax.ws.rs.core.UriInfo uriInfo)
Object
resolveRealmExtension(String realmName, String extension)
A JAX-RS sub-resource locator that uses theRealmResourceSPI
to resolve sub-resources instances given anunknownPath
.static javax.ws.rs.core.UriBuilder
wellKnownProviderUrl(javax.ws.rs.core.UriBuilder builder)
-
-
-
Field Detail
-
logger
protected static final org.jboss.logging.Logger logger
-
session
@Context protected KeycloakSession session
-
-
Method Detail
-
realmBaseUrl
public static javax.ws.rs.core.UriBuilder realmBaseUrl(javax.ws.rs.core.UriInfo uriInfo)
-
realmBaseUrl
public static javax.ws.rs.core.UriBuilder realmBaseUrl(javax.ws.rs.core.UriBuilder baseUriBuilder)
-
accountUrl
public static javax.ws.rs.core.UriBuilder accountUrl(javax.ws.rs.core.UriBuilder base)
-
protocolUrl
public static javax.ws.rs.core.UriBuilder protocolUrl(javax.ws.rs.core.UriInfo uriInfo)
-
protocolUrl
public static javax.ws.rs.core.UriBuilder protocolUrl(javax.ws.rs.core.UriBuilder builder)
-
clientRegistrationUrl
public static javax.ws.rs.core.UriBuilder clientRegistrationUrl(javax.ws.rs.core.UriInfo uriInfo)
-
brokerUrl
public static javax.ws.rs.core.UriBuilder brokerUrl(javax.ws.rs.core.UriInfo uriInfo)
-
wellKnownProviderUrl
public static javax.ws.rs.core.UriBuilder wellKnownProviderUrl(javax.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 javax.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 givenclientId
in the givenrealmName
.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 javax.ws.rs.core.Response getVersionPreflight(@PathParam("realm") String name, @PathParam("provider") String providerName)
-
getWellKnown
@GET @Path("{realm}/.well-known/{alias}") @Produces("application/json") public javax.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 theRealmResourceSPI
to resolve sub-resources instances given anunknownPath
.- 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.
-
-