Package org.keycloak.services.resources.admin

Class ClientScopeResource

java.lang.Object

org.keycloak.services.resources.admin.ClientScopeResource

public class ClientScopeResource
extends Object

Base resource class for managing one particular client of a realm.

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
protected org.keycloak.models.ClientScopeModel	clientScope
protected static final org.jboss.logging.Logger	logger
protected org.keycloak.models.RealmModel	realm
protected static final Pattern	scopeNamePattern
protected org.keycloak.models.KeycloakSession	session

Constructor Summary

Constructors

Constructor	Description
ClientScopeResource(org.keycloak.models.RealmModel realm, AdminPermissionEvaluator auth, org.keycloak.models.ClientScopeModel clientScope, org.keycloak.models.KeycloakSession session, AdminEventBuilder adminEvent)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	deleteClientScope()	Delete the client scope
org.keycloak.representations.idm.ClientScopeRepresentation	getClientScope()	Get representation of the client scope
ProtocolMappersResource	getProtocolMappers()
ScopeMappedResource	getScopeMappedResource()	Base path for managing the role scope mappings for the client scope
jakarta.ws.rs.core.Response	update(org.keycloak.representations.idm.ClientScopeRepresentation rep)	Update the client scope
static void	validateClientScope(org.keycloak.models.KeycloakSession session, org.keycloak.representations.idm.ClientScopeRepresentation clientScope)	Validates client scope during creation or update
static void	validateClientScopeName(String name)
static void	validateClientScopeProtocol(org.keycloak.models.KeycloakSession session, String protocol)
static void	validateParameterizedClientScope(org.keycloak.models.KeycloakSession session, org.keycloak.representations.idm.ClientScopeRepresentation clientScope)	Performs some validation based on attributes combinations and format.
void	validateParameterizedScopeUpdate(org.keycloak.representations.idm.ClientScopeRepresentation rep)	Makes sure that an update that makes a Client Scope Parameterized is rejected if the Client Scope is assigned as a default scope — either to a client or as a realm-level default.

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 org.keycloak.models.RealmModel realm

clientScope

protected org.keycloak.models.ClientScopeModel clientScope

session

protected org.keycloak.models.KeycloakSession session

scopeNamePattern

protected static final Pattern scopeNamePattern

Constructor Details

ClientScopeResource

public ClientScopeResource(org.keycloak.models.RealmModel realm,
 AdminPermissionEvaluator auth,
 org.keycloak.models.ClientScopeModel clientScope,
 org.keycloak.models.KeycloakSession session,
 AdminEventBuilder adminEvent)

Method Details

getProtocolMappers

@Path("protocol-mappers")
public ProtocolMappersResource getProtocolMappers()

getScopeMappedResource

@Path("scope-mappings")
public ScopeMappedResource getScopeMappedResource()

Base path for managing the role scope mappings for the client scope

Returns:

update

@PUT
@Consumes("application/json")
public jakarta.ws.rs.core.Response update(org.keycloak.representations.idm.ClientScopeRepresentation rep)

Update the client scope

Parameters:

rep -

Returns:

getClientScope

@GET
@Produces("application/json")
public org.keycloak.representations.idm.ClientScopeRepresentation getClientScope()

Get representation of the client scope

Returns:

deleteClientScope

@DELETE
public jakarta.ws.rs.core.Response deleteClientScope()

Delete the client scope

validateParameterizedClientScope

public static void validateParameterizedClientScope(org.keycloak.models.KeycloakSession session,
 org.keycloak.representations.idm.ClientScopeRepresentation clientScope)
                                             throws ErrorResponseException

Performs some validation based on attributes combinations and format. Validations differ based on whether the PARAMETERIZED_SCOPES feature is enabled or not

Parameters:

clientScope -

Throws:

ErrorResponseException

validateClientScopeName

public static void validateClientScopeName(String name)
                                    throws ErrorResponseException

Throws:

ErrorResponseException

validateClientScopeProtocol

public static void validateClientScopeProtocol(org.keycloak.models.KeycloakSession session,
 String protocol)
                                        throws ErrorResponseException

Throws:

ErrorResponseException

validateClientScope

public static void validateClientScope(org.keycloak.models.KeycloakSession session,
 org.keycloak.representations.idm.ClientScopeRepresentation clientScope)
                                throws ErrorResponseException

Validates client scope during creation or update

Parameters:

session - the Keycloak session

clientScope - clientScope to validate

Throws:

ErrorResponseException - if error happens during client-scope validation

validateParameterizedScopeUpdate

public void validateParameterizedScopeUpdate(org.keycloak.representations.idm.ClientScopeRepresentation rep)

Makes sure that an update that makes a Client Scope Parameterized is rejected if the Client Scope is assigned as a default scope — either to a client or as a realm-level default.

Parameters:

rep - the ClientScopeRepresentation with the changes from the frontend.