Package org.keycloak.services.resources.admin

Class RealmsAdminResource

java.lang.Object

org.keycloak.services.resources.admin.RealmsAdminResource

public class RealmsAdminResource
extends Object

Top level resource for Admin REST API

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
protected AdminAuth	auth
protected org.keycloak.common.ClientConnection	clientConnection
protected static org.jboss.logging.Logger	logger
static javax.ws.rs.core.CacheControl	noCache
protected org.keycloak.models.KeycloakSession	session
protected TokenManager	tokenManager

Constructor Summary

Constructors

Constructor	Description
RealmsAdminResource(AdminAuth auth, TokenManager tokenManager)

Method Summary

Modifier and Type	Method	Description
RealmAdminResource	getRealmAdmin(javax.ws.rs.core.HttpHeaders headers, String name)	Base path for the admin REST API for one particular realm.
Stream<org.keycloak.representations.idm.RealmRepresentation>	getRealms(boolean briefRepresentation)	Get accessible realms Returns a list of accessible realms.
javax.ws.rs.core.Response	importRealm(org.keycloak.representations.idm.RealmRepresentation rep)	Import a realm Imports a realm from a full representation of that realm.
protected org.keycloak.representations.idm.RealmRepresentation	toRealmRep(org.keycloak.models.RealmModel realm, boolean briefRep)

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

auth

protected AdminAuth auth

tokenManager

protected TokenManager tokenManager

session

@Context
protected org.keycloak.models.KeycloakSession session

clientConnection

@Context
protected org.keycloak.common.ClientConnection clientConnection

noCache

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

Constructor Detail

RealmsAdminResource

public RealmsAdminResource(AdminAuth auth,
                           TokenManager tokenManager)

Method Detail

getRealms

@GET
@Produces("application/json")
public Stream<org.keycloak.representations.idm.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 org.keycloak.representations.idm.RealmRepresentation toRealmRep(org.keycloak.models.RealmModel realm,
                                                                          boolean briefRep)

importRealm

@POST
@Consumes("application/json")
public javax.ws.rs.core.Response importRealm(org.keycloak.representations.idm.RealmRepresentation rep)

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

Parameters:

rep - JSON representation of the realm

Returns:

getRealmAdmin

@Path("{realm}")
public RealmAdminResource getRealmAdmin(@Context
                                        javax.ws.rs.core.HttpHeaders headers,
                                        @PathParam("realm")
                                        String name)

Base path for the admin REST API for one particular realm.

Parameters:

headers -

name - realm name (not id!)

Returns: