org.keycloak.services.resources.admin

Class ClientScopesResource

java.lang.Object

org.keycloak.services.resources.admin.ClientScopesResource

public class ClientScopesResource
extends Object

Base resource class for managing a realm's client scopes.

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.jboss.logging.Logger	logger
protected RealmModel	realm
protected KeycloakSession	session

Constructor Summary

Constructors

Constructor and Description
ClientScopesResource(RealmModel realm, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createClientScope(ClientScopeRepresentation rep) Create a new client scope Client Scope's name must be unique!
ClientScopeResource	getClientScope(String id) Base path for managing a specific client scope.
Stream<ClientScopeRepresentation>	getClientScopes() Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm

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

realm

protected RealmModel realm

session

@Context
protected KeycloakSession session

Constructor Detail

ClientScopesResource

public ClientScopesResource(RealmModel realm,
                            AdminPermissionEvaluator auth,
                            AdminEventBuilder adminEvent)

Method Detail

getClientScopes

@GET
 @Produces(value="application/json")
public Stream<ClientScopeRepresentation> getClientScopes()

Get client scopes belonging to the realm Returns a list of client scopes belonging to the realm

createClientScope

@POST
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createClientScope(ClientScopeRepresentation rep)

Create a new client scope Client Scope's name must be unique!

Parameters:

rep -

Returns:

getClientScope

@Path(value="{id}")
public ClientScopeResource getClientScope(@PathParam(value="id")
                                                              String id)

Base path for managing a specific client scope.

Parameters:

id - id of client scope (not name)

Returns: