UserResource (Red Hat Single Sign-On CD 7 public API)

```
public interface UserResource
```
Author:

rodrigo.sasaki@icarros.com.br

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`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()`
`List<GroupRepresentation>`	`groups(Integer firstResult, Integer maxResults)`
`List<GroupRepresentation>`	`groups(String search, Integer firstResult, Integer maxResults)`
`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
```
UserRepresentation toRepresentation()
```

update

void update(UserRepresentation userRepresentation)

remove
```
void remove()
```

groups
```
List<GroupRepresentation> groups()
```

groups

List<GroupRepresentation> groups(Integer firstResult,
                                 Integer maxResults)

groups

List<GroupRepresentation> groups(String search,
                                 Integer firstResult,
                                 Integer maxResults)

joinGroup
```
void joinGroup(String groupId)
```

leaveGroup
```
void leaveGroup(String groupId)
```

logout
```
void logout()
```

removeTotp
```
void removeTotp()
```

disableCredentialType
```
void disableCredentialType(List<String> credentialTypes)
```
Disables or deletes all credentials for specific types. Type examples "otp", "password"

Parameters:

credentialTypes -

resetPassword

void resetPassword(CredentialRepresentation credentialRepresentation)

resetPasswordEmail
```
@Deprecated
void resetPasswordEmail()
```
Deprecated.

Use executeActionsEmail and pass in the UPDATE_PASSWORD required action

resetPasswordEmail
```
@Deprecated
void resetPasswordEmail(String clientId)
```
Deprecated.

Use executeActionsEmail and pass in the UPDATE_PASSWORD required action

executeActionsEmail
```
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
```
void executeActionsEmail(String clientId,
                         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
```
void sendVerifyEmail()
```

sendVerifyEmail
```
void sendVerifyEmail(String clientId)
```

getUserSessions

List<UserSessionRepresentation> getUserSessions()

getOfflineSessions

List<UserSessionRepresentation> getOfflineSessions(String clientId)

getFederatedIdentity

List<FederatedIdentityRepresentation> getFederatedIdentity()

addFederatedIdentity

Response addFederatedIdentity(String provider,
                              FederatedIdentityRepresentation rep)

removeFederatedIdentity

void removeFederatedIdentity(String provider)

roles
```
RoleMappingResource roles()
```

getConsents
```
List<Map<String,Object>> getConsents()
```

revokeConsent
```
void revokeConsent(String clientId)
```

impersonate
```
Map<String,Object> impersonate()
```

Interface UserResource

Method Summary

Method Detail

toRepresentation

update

remove

groups

groups

groups

joinGroup

leaveGroup

logout

removeTotp

disableCredentialType

resetPassword

resetPasswordEmail

resetPasswordEmail

executeActionsEmail

executeActionsEmail

sendVerifyEmail

sendVerifyEmail

getUserSessions

getOfflineSessions

getFederatedIdentity

addFederatedIdentity

removeFederatedIdentity

roles

getConsents

revokeConsent

impersonate