public interface UserStorageProviderResource

Version:: $Revision: 1 $
Author:: Bill Burke

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`removeImportedUsers(String componentId)`	Remove imported users
`SynchronizationResultRepresentation`	`syncMapperData(String componentId, String mapperId, String direction)`	REST invocation for initiating sync for an ldap mapper.
`SynchronizationResultRepresentation`	`syncUsers(String componentId, String action)`	If the provider supports synchronization, this will invoke it.
`void`	`unlink(String componentId)`	Unlink imported users from a storage provider

Method Detail

syncUsers

@POST
@Path("{componentId}/sync")
@Produces("application/json")
SynchronizationResultRepresentation syncUsers(@PathParam("componentId")
                                              String componentId,
                                              @QueryParam("action")
                                              String action)

If the provider supports synchronization, this will invoke it. Action can be "triggerFullSync" or "triggerChangedUsersSync"

Parameters:: componentId -; action -
Returns:

removeImportedUsers

@POST
@Path("{componentId}/remove-imported-users")
@Produces("application/json")
void removeImportedUsers(@PathParam("componentId")
                         String componentId)

Remove imported users

Parameters:: componentId -

unlink

@POST
@Path("{componentId}/unlink-users")
@Produces("application/json")
void unlink(@PathParam("componentId")
            String componentId)

Unlink imported users from a storage provider

Parameters:: componentId -

syncMapperData

@POST
@Path("{componentId}/mappers/{mapperId}/sync")
@Produces("application/json")
SynchronizationResultRepresentation syncMapperData(@PathParam("componentId")
                                                   String componentId,
                                                   @PathParam("mapperId")
                                                   String mapperId,
                                                   @QueryParam("direction")
                                                   String direction)

REST invocation for initiating sync for an ldap mapper. This method may be moved in the future. Right now don't have a good place for it. direction is "fedToKeycloak" or "keycloakToFed"