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	disableCredentialType(List<String> credentialTypes) Disables or deletes all credentials for specific types.
void	executeActionsEmail(List<String> actions) Sends an email to the user with a link within it.
void	executeActionsEmail(String clientId, String redirectUri, List<String> actions) Sends an email to the user with a link within it.
List<Map<String,Object>>	getConsents()
List<FederatedIdentityRepresentation>	getFederatedIdentity()
List<UserSessionRepresentation>	getOfflineSessions(String clientId)
List<UserSessionRepresentation>	getUserSessions()
List<GroupRepresentation>	groups()
Map<String,Object>	impersonate()
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.
void	revokeConsent(String clientId)
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()

disableCredentialType

@Path(value="disable-credential-types")
 @PUT
 @Consumes(value="application/json")
void disableCredentialType(List<String> credentialTypes)

Disables or deletes all credentials for specific types. Type examples "otp", "password"

Parameters:

credentialTypes -

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)

Sends an email to the user with a link within it. If they click on the link they will be asked to perform some actions i.e. reset password, update profile, etc.

Parameters:

actions -

executeActionsEmail

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

Sends an email to the user with a link within it. If they click on the link they will be asked to perform some actions i.e. reset password, update profile, etc. If redirectUri is not null, then you must specify a client id. This will set the URI you want the flow to link to after the email link is clicked and actions completed. If both parameters are null, then no page is linked to at the end of the flow.

Parameters:

clientId -

redirectUri -

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()

getOfflineSessions

@GET
 @Path(value="offline-sessions/{clientId}")
List<UserSessionRepresentation> getOfflineSessions(@PathParam(value="clientId")
                                                                                                    String clientId)

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()

getConsents

@GET
 @Path(value="consents")
List<Map<String,Object>> getConsents()

revokeConsent

@DELETE
 @Path(value="consents/{client}")
void revokeConsent(@PathParam(value="client")
                                                             String clientId)

impersonate

@POST
 @Path(value="impersonation")
 @Produces(value="application/json")
Map<String,Object> impersonate()