Package org.keycloak.services.resources.admin

Class ProtocolMappersResource

java.lang.Object

org.keycloak.services.resources.admin.ProtocolMappersResource

public class ProtocolMappersResource
extends Object

Base resource for managing users

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
protected final AdminEventBuilder	adminEvent
protected final AdminPermissionEvaluator	auth
protected final ProtocolMapperContainerModel	client
protected static final org.jboss.logging.Logger	logger
protected final AdminPermissionEvaluator.RequirePermissionCheck	managePermission
protected final RealmModel	realm
protected final KeycloakSession	session
protected final AdminPermissionEvaluator.RequirePermissionCheck	viewPermission

Constructor Summary

Constructors

Constructor	Description
ProtocolMappersResource(KeycloakSession session, ProtocolMapperContainerModel client, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent, AdminPermissionEvaluator.RequirePermissionCheck managePermission, AdminPermissionEvaluator.RequirePermissionCheck viewPermission)

Method Summary

Modifier and Type	Method	Description
void	createMapper(List<org.keycloak.representations.idm.ProtocolMapperRepresentation> reps)	Create multiple mappers
jakarta.ws.rs.core.Response	createMapper(org.keycloak.representations.idm.ProtocolMapperRepresentation rep)	Create a mapper
void	delete(String id)	Delete the mapper
org.keycloak.representations.idm.ProtocolMapperRepresentation	getMapperById(String id)	Get mapper by id
Stream<org.keycloak.representations.idm.ProtocolMapperRepresentation>	getMappers()	Get mappers
Stream<org.keycloak.representations.idm.ProtocolMapperRepresentation>	getMappersPerProtocol(String protocol)	Get mappers by name for a specific protocol
void	update(String id, org.keycloak.representations.idm.ProtocolMapperRepresentation rep)	Update the mapper

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 final RealmModel realm

client

protected final ProtocolMapperContainerModel client

auth

protected final AdminPermissionEvaluator auth

managePermission

protected final AdminPermissionEvaluator.RequirePermissionCheck managePermission

viewPermission

protected final AdminPermissionEvaluator.RequirePermissionCheck viewPermission

adminEvent

protected final AdminEventBuilder adminEvent

session

protected final KeycloakSession session

Constructor Details

ProtocolMappersResource

public ProtocolMappersResource(KeycloakSession session,
 ProtocolMapperContainerModel client,
 AdminPermissionEvaluator auth,
 AdminEventBuilder adminEvent,
 AdminPermissionEvaluator.RequirePermissionCheck managePermission,
 AdminPermissionEvaluator.RequirePermissionCheck viewPermission)

Method Details

getMappersPerProtocol

@GET
@Path("protocol/{protocol}")
@Produces("application/json")
public Stream<org.keycloak.representations.idm.ProtocolMapperRepresentation> getMappersPerProtocol(@PathParam("protocol")
 String protocol)

Get mappers by name for a specific protocol

Parameters:

protocol -

Returns:

createMapper

@Path("models")
@POST
@Consumes("application/json")
public jakarta.ws.rs.core.Response createMapper(org.keycloak.representations.idm.ProtocolMapperRepresentation rep)

Create a mapper

Parameters:

rep -

createMapper

@Path("add-models")
@POST
@Consumes("application/json")
public void createMapper(List<org.keycloak.representations.idm.ProtocolMapperRepresentation> reps)

Create multiple mappers

getMappers

@GET
@Path("models")
@Produces("application/json")
public Stream<org.keycloak.representations.idm.ProtocolMapperRepresentation> getMappers()

Get mappers

Returns:

getMapperById

@GET
@Path("models/{id}")
@Produces("application/json")
public org.keycloak.representations.idm.ProtocolMapperRepresentation getMapperById(@PathParam("id")
 String id)

Get mapper by id

Parameters:

id - Mapper id

Returns:

update

@PUT
@Path("models/{id}")
@Consumes("application/json")
public void update(@PathParam("id")
 String id,
 org.keycloak.representations.idm.ProtocolMapperRepresentation rep)

Update the mapper

Parameters:

id - Mapper id

rep -

delete

@DELETE
@Path("models/{id}")
public void delete(@PathParam("id")
 String id)

Delete the mapper

Parameters:

id - Mapper id