org.keycloak.admin.client.resource

Interface UserResource

@Consumes(value="application/json")
 @Produces(value="application/json")
public interface UserResource

Author:

[email protected]

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addFederatedIdentity(String provider, FederatedIdentityRepresentation rep)
void	executeActionsEmail(List<String> actions)
void	executeActionsEmail(String clientId, List<String> actions)
List<FederatedIdentityRepresentation>	getFederatedIdentity()
List<UserSessionRepresentation>	getUserSessions()
List<GroupRepresentation>	groups()
void	joinGroup(String groupId)
void	leaveGroup(String groupId)
void	logout()
void	remove()
void	removeFederatedIdentity(String provider)
void	removeTotp()
void	resetPassword(CredentialRepresentation credentialRepresentation)
void	resetPasswordEmail() Deprecated.
void	resetPasswordEmail(String clientId) Deprecated.
RoleMappingResource	roles()
void	sendVerifyEmail()
void	sendVerifyEmail(String clientId)
UserRepresentation	toRepresentation()
void	update(UserRepresentation userRepresentation)

Method Detail

toRepresentation

@GET
UserRepresentation toRepresentation()

update

@PUT
void update(UserRepresentation userRepresentation)

remove

@DELETE
void remove()

groups

@Path(value="groups")
 @GET
List<GroupRepresentation> groups()

joinGroup

@Path(value="groups/{groupId}")
 @PUT
void joinGroup(@PathParam(value="groupId")
                                                     String groupId)

leaveGroup

@Path(value="groups/{groupId}")
 @DELETE
void leaveGroup(@PathParam(value="groupId")
                                                         String groupId)

logout

@POST
 @Path(value="logout")
void logout()

removeTotp

@PUT
 @Path(value="remove-totp")
void removeTotp()

resetPassword

@PUT
 @Path(value="reset-password")
void resetPassword(CredentialRepresentation credentialRepresentation)

resetPasswordEmail

@PUT
 @Path(value="reset-password-email")
 @Deprecated
void resetPasswordEmail()

Deprecated.

Use executeActionsEmail and pass in the UPDATE_PASSWORD required action

resetPasswordEmail

@PUT
 @Path(value="reset-password-email")
 @Deprecated
void resetPasswordEmail(@QueryParam(value="client_id")
                                                                               String clientId)

Deprecated.

Use executeActionsEmail and pass in the UPDATE_PASSWORD required action

executeActionsEmail

@PUT
 @Path(value="execute-actions-email")
void executeActionsEmail(List<String> actions)

executeActionsEmail

@PUT
 @Path(value="execute-actions-email")
void executeActionsEmail(@QueryParam(value="client_id")
                                                                    String clientId,
                                                                    List<String> actions)

sendVerifyEmail

@PUT
 @Path(value="send-verify-email")
void sendVerifyEmail()

sendVerifyEmail

@PUT
 @Path(value="send-verify-email")
void sendVerifyEmail(@QueryParam(value="client_id")
                                                            String clientId)

getUserSessions

@GET
 @Path(value="sessions")
List<UserSessionRepresentation> getUserSessions()

getFederatedIdentity

@GET
 @Path(value="federated-identity")
List<FederatedIdentityRepresentation> getFederatedIdentity()

addFederatedIdentity

@POST
 @Path(value="federated-identity/{provider}")
javax.ws.rs.core.Response addFederatedIdentity(@PathParam(value="provider")
                                                                                                   String provider,
                                                                                                   FederatedIdentityRepresentation rep)

removeFederatedIdentity

@Path(value="federated-identity/{provider}")
 @DELETE
void removeFederatedIdentity(@PathParam(value="provider")
                                                                                   String provider)

roles

@Path(value="role-mappings")
RoleMappingResource roles()