Package 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	Description
protected static final org.jboss.logging.Logger	logger
protected final RealmModel	realm
protected final KeycloakSession	session

Constructor Summary

Constructors

Constructor	Description
ClientScopesResource(KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)

Method Summary

Modifier and Type	Method	Description
jakarta.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 Details

logger

protected static final org.jboss.logging.Logger logger

realm

protected final RealmModel realm

session

protected final KeycloakSession session

Constructor Details

ClientScopesResource

public ClientScopesResource(KeycloakSession session,
 AdminPermissionEvaluator auth,
 AdminEventBuilder adminEvent)

Method Details

getClientScopes

@GET
@Produces("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("application/json")
public jakarta.ws.rs.core.Response createClientScope(ClientScopeRepresentation rep)

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

Parameters:

rep -

Returns:

getClientScope

@Path("{client-scope-id}")
public ClientScopeResource getClientScope(@PathParam("client-scope-id")
 String id)

Base path for managing a specific client scope.

Parameters:

id - id of client scope (not name)

Returns: