Package org.keycloak.authorization.admin

Class ScopeService

java.lang.Object

org.keycloak.authorization.admin.ScopeService

public class ScopeService
extends Object

Author:

Pedro Igor

Constructor Summary

Constructors

Constructor	Description
ScopeService(KeycloakSession session, ResourceServer resourceServer, AuthorizationProvider authorization, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	create(ScopeRepresentation scope)
jakarta.ws.rs.core.Response	delete(String id)
jakarta.ws.rs.core.Response	find(String name)
Stream<ScopeRepresentation>	findAll(String id, String name, Integer firstResult, Integer maxResult)
jakarta.ws.rs.core.Response	findById(String id)
jakarta.ws.rs.core.Response	getPermissions(String id)
jakarta.ws.rs.core.Response	getResources(String id)
jakarta.ws.rs.core.Response	update(String id, ScopeRepresentation scope)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScopeService

public ScopeService(KeycloakSession session,
 ResourceServer resourceServer,
 AuthorizationProvider authorization,
 AdminPermissionEvaluator auth,
 AdminEventBuilder adminEvent)

Method Details

create

@POST
@Consumes("application/json")
@Produces("application/json")
public jakarta.ws.rs.core.Response create(ScopeRepresentation scope)

update

@Path("{scope-id}")
@PUT
@Consumes("application/json")
@Produces("application/json")
public jakarta.ws.rs.core.Response update(@PathParam("scope-id")
 String id,
 ScopeRepresentation scope)

delete

@Path("{scope-id}")
@DELETE
public jakarta.ws.rs.core.Response delete(@PathParam("scope-id")
 String id)

findById

@Path("{scope-id}")
@GET
@Produces("application/json")
public jakarta.ws.rs.core.Response findById(@PathParam("scope-id")
 String id)

getResources

@Path("{scope-id}/resources")
@GET
@Produces("application/json")
public jakarta.ws.rs.core.Response getResources(@PathParam("scope-id")
 String id)

getPermissions

@Path("{scope-id}/permissions")
@GET
@Produces("application/json")
public jakarta.ws.rs.core.Response getPermissions(@PathParam("scope-id")
 String id)

find

@Path("/search")
@GET
@Produces("application/json")
public jakarta.ws.rs.core.Response find(@QueryParam("name")
 String name)

findAll

@GET
@Produces("application/json")
public Stream<ScopeRepresentation> findAll(@QueryParam("scopeId")
 String id,
 @QueryParam("name")
 String name,
 @QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResult)