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 ClientScopeModel
clientScope
protected static Pattern
dynamicScreenPattern
protected static org.jboss.logging.Logger
logger
protected RealmModel
realm
protected static Pattern
scopeNamePattern
protected KeycloakSession
session
-
Constructor Summary
Constructors Constructor Description ClientScopeResource(RealmModel realm, AdminPermissionEvaluator auth, ClientScopeModel clientScope, KeycloakSession session, AdminEventBuilder adminEvent)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description javax.ws.rs.core.Response
deleteClientScope()
Delete the client scopeClientScopeRepresentation
getClientScope()
Get representation of the client scopeProtocolMappersResource
getProtocolMappers()
ScopeMappedResource
getScopeMappedResource()
Base path for managing the role scope mappings for the client scopejavax.ws.rs.core.Response
update(ClientScopeRepresentation rep)
Update the client scopestatic void
validateClientScopeName(String name)
static void
validateDynamicClientScope(ClientScopeRepresentation clientScope)
Performs some validation based on attributes combinations and format.void
validateDynamicScopeUpdate(ClientScopeRepresentation rep)
Makes sure that an update that makes a Client Scope Dynamic is rejected if the Client Scope is assigned to a client as a default scope.
-
-
-
Field Detail
-
logger
protected static final org.jboss.logging.Logger logger
-
realm
protected RealmModel realm
-
clientScope
protected ClientScopeModel clientScope
-
session
protected KeycloakSession session
-
dynamicScreenPattern
protected static Pattern dynamicScreenPattern
-
scopeNamePattern
protected static final Pattern scopeNamePattern
-
-
Constructor Detail
-
ClientScopeResource
public ClientScopeResource(RealmModel realm, AdminPermissionEvaluator auth, ClientScopeModel clientScope, KeycloakSession session, AdminEventBuilder adminEvent)
-
-
Method Detail
-
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 javax.ws.rs.core.Response update(ClientScopeRepresentation rep)
Update the client scope- Parameters:
rep
-- Returns:
-
getClientScope
@GET @Produces("application/json") public ClientScopeRepresentation getClientScope()
Get representation of the client scope- Returns:
-
deleteClientScope
@DELETE public javax.ws.rs.core.Response deleteClientScope()
Delete the client scope
-
validateDynamicClientScope
public static void validateDynamicClientScope(ClientScopeRepresentation clientScope) throws ErrorResponseException
Performs some validation based on attributes combinations and format. Validations differ based on whether the DYNAMIC_SCOPES feature is enabled or not- Parameters:
clientScope
-- Throws:
ErrorResponseException
-
validateClientScopeName
public static void validateClientScopeName(String name) throws ErrorResponseException
- Throws:
ErrorResponseException
-
validateDynamicScopeUpdate
public void validateDynamicScopeUpdate(ClientScopeRepresentation rep)
Makes sure that an update that makes a Client Scope Dynamic is rejected if the Client Scope is assigned to a client as a default scope.- Parameters:
rep
- theClientScopeRepresentation
with the changes from the frontend.
-
-