Package org.keycloak.admin.client.resource

Interface ScopePermissionsResource

public interface ScopePermissionsResource

Author:

Pedro Igor

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	create(org.keycloak.representations.idm.authorization.ScopePermissionRepresentation representation)
default List<org.keycloak.representations.idm.authorization.ScopePermissionRepresentation>	findAll(String id, String name, String resource, Integer firstResult, Integer maxResult)
List<org.keycloak.representations.idm.authorization.ScopePermissionRepresentation>	findAll(String id, String name, String resource, String fields, Integer firstResult, Integer maxResult)	Search for scope permissions based on given filters.
ScopePermissionResource	findById(String id)
default org.keycloak.representations.idm.authorization.ScopePermissionRepresentation	findByName(String name)
org.keycloak.representations.idm.authorization.ScopePermissionRepresentation	findByName(String name, String fields)

Method Details

create

@POST
@Consumes("application/json")
@Produces("application/json")
jakarta.ws.rs.core.Response create(org.keycloak.representations.idm.authorization.ScopePermissionRepresentation representation)

findById

@Path("{id}")
ScopePermissionResource findById(@PathParam("id")
 String id)

findByName

@Path("/search")
@GET
@Produces("application/json")
org.keycloak.representations.idm.authorization.ScopePermissionRepresentation findByName(@QueryParam("name")
 String name,
 @QueryParam("fields")
 String fields)

findByName

default org.keycloak.representations.idm.authorization.ScopePermissionRepresentation findByName(String name)

findAll

@GET
@Produces("application/json")
List<org.keycloak.representations.idm.authorization.ScopePermissionRepresentation> findAll(@QueryParam("policyId")
 String id,
 @QueryParam("name")
 String name,
 @QueryParam("resource")
 String resource,
 @QueryParam("fields")
 String fields,
 @QueryParam("first")
 Integer firstResult,
 @QueryParam("max")
 Integer maxResult)

Search for scope permissions based on given filters.

Parameters:

id - a policy id

name - a name

resource - a resource

fields - fields to fetch. This parameter is available since Keycloak server 26.7.0

firstResult -

maxResult -

Returns:

a list containing scope permissions.

findAll

default List<org.keycloak.representations.idm.authorization.ScopePermissionRepresentation> findAll(String id,
 String name,
 String resource,
 Integer firstResult,
 Integer maxResult)