Package org.keycloak.admin.client.resource

Interface UserStorageProviderResource

public interface UserStorageProviderResource

Version:

$Revision: 1 $

Author:

Bill Burke

Method Summary

Modifier and Type	Method	Description
void	removeImportedUsers(String componentId)	Remove imported users
org.keycloak.representations.idm.SynchronizationResultRepresentation	syncMapperData(String componentId, String mapperId, String direction)	REST invocation for initiating sync for an ldap mapper.
org.keycloak.representations.idm.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 Details

syncUsers

@POST
@Path("{componentId}/sync")
@Produces("application/json")
org.keycloak.representations.idm.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")
org.keycloak.representations.idm.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"

Parameters:

componentId -

mapperId -

direction -

Returns: