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 Details

    • 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 Details

  • 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(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 jakarta.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
    • validateClientScopeProtocol

      public static void validateClientScopeProtocol(String protocol) 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 - the ClientScopeRepresentation with the changes from the frontend.