java.lang.Object
- org.keycloak.services.resources.admin.UserStorageProviderResource

public class UserStorageProviderResource
extends Object

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

Field Summary

Fields
Modifier and Type	Field	Description
`protected AdminEventBuilder`	`adminEvent`
`protected AdminPermissionEvaluator`	`auth`
`protected ClientConnection`	`clientConnection`
`protected javax.ws.rs.core.HttpHeaders`	`headers`
`protected RealmModel`	`realm`
`protected KeycloakSession`	`session`

Constructor Summary

Constructors
Constructor	Description
`UserStorageProviderResource(KeycloakSession session, AdminPermissionEvaluator auth, AdminEventBuilder adminEvent)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,String>`	`getSimpleName(String id)`	Need this for admin console to display simple name of provider when displaying user detail KEYCLOAK-4328
`void`	`removeImportedUsers(String id)`	Remove imported users
`SynchronizationResult`	`syncMapperData(String parentId, String mapperId, String direction)`	Trigger sync of mapper data related to ldap mapper (roles, groups, ...) direction is "fedToKeycloak" or "keycloakToFed"
`SynchronizationResult`	`syncUsers(String id, String action)`	Trigger sync of users Action can be "triggerFullSync" or "triggerChangedUsersSync"
`void`	`unlinkUsers(String id)`	Unlink imported users from a storage provider

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

realm
```
protected final RealmModel realm
```

auth

protected final AdminPermissionEvaluator auth

adminEvent

protected final AdminEventBuilder adminEvent

clientConnection

protected final ClientConnection clientConnection

session

protected final KeycloakSession session

headers

protected final javax.ws.rs.core.HttpHeaders headers

Constructor Detail

UserStorageProviderResource

public UserStorageProviderResource(KeycloakSession session,
                                   AdminPermissionEvaluator auth,
                                   AdminEventBuilder adminEvent)

Method Detail

getSimpleName

@GET
@Path("{id}/name")
@Produces("application/json")
public Map<String,String> getSimpleName(@PathParam("id")
                                              String id)

Need this for admin console to display simple name of provider when displaying user detail KEYCLOAK-4328

Parameters:: id -
Returns:

syncUsers

@POST
@Path("{id}/sync")
@Produces("application/json")
public SynchronizationResult syncUsers(@PathParam("id")
                                       String id,
                                       @QueryParam("action")
                                       String action)

Trigger sync of users Action can be "triggerFullSync" or "triggerChangedUsersSync"

Parameters:: id -; action -
Returns:

removeImportedUsers

@POST
@Path("{id}/remove-imported-users")
public void removeImportedUsers(@PathParam("id")
                                String id)

Remove imported users

Parameters:: id -

unlinkUsers

@POST
@Path("{id}/unlink-users")
public void unlinkUsers(@PathParam("id")
                        String id)

Unlink imported users from a storage provider

Parameters:: id -

syncMapperData

@POST
@Path("{parentId}/mappers/{id}/sync")
@Produces("application/json")
public SynchronizationResult syncMapperData(@PathParam("parentId")
                                            String parentId,
                                            @PathParam("id")
                                            String mapperId,
                                            @QueryParam("direction")
                                            String direction)

Trigger sync of mapper data related to ldap mapper (roles, groups, ...) direction is "fedToKeycloak" or "keycloakToFed"

Returns:

Class UserStorageProviderResource