org.keycloak.admin.client.resource

Interface UserFederationProviderResource

public interface UserFederationProviderResource

Author:

Marek Posolda

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addMapper(UserFederationMapperRepresentation mapper)
UserFederationMapperRepresentation	getMapperById(String id)
List<UserFederationMapperRepresentation>	getMappers()
Map<String,UserFederationMapperTypeRepresentation>	getMapperTypes()
void	remove()
void	removeMapper(String id)
UserFederationSyncResultRepresentation	syncMapperData(String mapperId, String direction)
UserFederationSyncResultRepresentation	syncUsers(String action)
UserFederationProviderRepresentation	toRepresentation()
void	update(UserFederationProviderRepresentation rep)
void	updateMapper(String id, UserFederationMapperRepresentation rep)

Method Detail

update

@PUT
 @Consumes(value="application/json")
void update(UserFederationProviderRepresentation rep)

toRepresentation

@GET
 @Produces(value="application/json")
UserFederationProviderRepresentation toRepresentation()

remove

@DELETE
void remove()

syncUsers

@POST
 @Path(value="sync")
 @Produces(value="application/json")
UserFederationSyncResultRepresentation syncUsers(@QueryParam(value="action")
                                                                                                                 String action)

getMapperTypes

@GET
 @Path(value="mapper-types")
 @Produces(value="application/json")
Map<String,UserFederationMapperTypeRepresentation> getMapperTypes()

getMappers

@GET
 @Path(value="mappers")
 @Produces(value="application/json")
List<UserFederationMapperRepresentation> getMappers()

addMapper

@POST
 @Path(value="mappers")
 @Consumes(value="application/json")
javax.ws.rs.core.Response addMapper(UserFederationMapperRepresentation mapper)

getMapperById

@GET
 @Path(value="mappers/{id}")
 @Produces(value="application/json")
UserFederationMapperRepresentation getMapperById(@PathParam(value="id")
                                                                                                                        String id)

updateMapper

@PUT
 @Path(value="mappers/{id}")
 @Consumes(value="application/json")
void updateMapper(@PathParam(value="id")
                                                                                         String id,
                                                                                         UserFederationMapperRepresentation rep)

removeMapper

@DELETE
 @Path(value="mappers/{id}")
void removeMapper(@PathParam(value="id")
                                                       String id)

syncMapperData

@POST
 @Path(value="mappers/{id}/sync")
 @Produces(value="application/json")
UserFederationSyncResultRepresentation syncMapperData(@PathParam(value="id")
                                                                                                                                   String mapperId,
                                                                                                                                   @QueryParam(value="direction")
                                                                                                                                   String direction)