UserApi (Mattermost APIv4 Client for Java 0.7.1 API)

All Known Implementing Classes:

MattermostClient
```
public interface UserApi
```
User API.

Author:

Takayuki Maruyama

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`ApiResponse<Boolean>`	`attachDeviceId(String deviceId)` attaches a mobile device ID to the current session.
`default ApiResponse<UserAutocomplete>`	`autocompleteUsers(String username)` returns the users in the system based on search term.
`ApiResponse<UserAutocomplete>`	`autocompleteUsers(String username, String etag)` returns the users in the system based on search term.
`default ApiResponse<UserAutocomplete>`	`autocompleteUsersInChannel(String teamId, String channelId, String username)` returns the users in a channel based on search term.
`ApiResponse<UserAutocomplete>`	`autocompleteUsersInChannel(String teamId, String channelId, String username, String etag)` returns the users in a channel based on search term.
`default ApiResponse<UserAutocomplete>`	`autocompleteUsersInTeam(String teamId, String username)` returns the users on a team based on search term.
`ApiResponse<UserAutocomplete>`	`autocompleteUsersInTeam(String teamId, String username, String etag)` returns the users on a team based on search term.
`boolean`	`checkUserMfa(String loginId)` checks whether a user has MFA active on their account or not based on the provided login id.
`ApiResponse<User>`	`createUser(User user)` creates a user in the system based on the provided user object.
`ApiResponse<UserAccessToken>`	`createUserAccessToken(String userId, String description)`
`ApiResponse<Boolean>`	`deleteUser(String userId)` deactivates a user in the system based on the provided user id string.
`ApiResponse<Boolean>`	`disableUserAccessToken(String tokenId)`
`ApiResponse<Boolean>`	`enableUserAccessToken(String tokenId)`
`ApiResponse<MfaSecret>`	`generateMfaSecret(String userId)` will generate a new MFA secret for a user and return it as a string and as a base64 encoded image QR code.
`default ApiResponse<User>`	`getMe()` returns the logged in user.
`ApiResponse<User>`	`getMe(String etag)` returns the logged in user.
`default ApiResponse<byte[]>`	`getProfileImage(String userId)` gets user's profile image.
`ApiResponse<byte[]>`	`getProfileImage(String userId, String etag)` gets user's profile image.
`default ApiResponse<SessionList>`	`getSessions(String userId)` returns a list of sessions based on the provided user id string.
`ApiResponse<SessionList>`	`getSessions(String userId, String etag)` returns a list of sessions based on the provided user id string.
`default ApiResponse<TeamUnreadList>`	`getTeamUnreadForUser(String userId)` will return a list with TeamUnread objects that contain the amount of unread messages and mentions the current user has for the teams it belongs to.
`ApiResponse<TeamUnreadList>`	`getTeamUnreadForUser(String userId, String teamIdToExclude)` will return a list with TeamUnread objects that contain the amount of unread messages and mentions the current user has for the teams it belongs to.
`default ApiResponse<User>`	`getUser(String userId)` returns a user based on the provided user id string.
`ApiResponse<User>`	`getUser(String userId, String etag)` returns a user based on the provided user id string.
`ApiResponse<UserAccessToken>`	`getUserAccessToken(String tokenId)`
`default ApiResponse<UserAccessTokenList>`	`getUserAccessTokens(String userId)`
`ApiResponse<UserAccessTokenList>`	`getUserAccessTokens(String userId, Pager pager)`
`default ApiResponse<UserAccessTokenList>`	`getUserAccessTokensAllUsers()`
`ApiResponse<UserAccessTokenList>`	`getUserAccessTokensAllUsers(Pager pager)`
`default ApiResponse<Audits>`	`getUserAudits(String userId)` returns a list of audit based on the provided user id string.
`default ApiResponse<Audits>`	`getUserAudits(String userId, Pager pager)` returns a list of audit based on the provided user id string.
`ApiResponse<Audits>`	`getUserAudits(String userId, Pager pager, String etag)` returns a list of audit based on the provided user id string.
`default ApiResponse<User>`	`getUserByEmail(String email)` returns a user based on the provided user email string.
`ApiResponse<User>`	`getUserByEmail(String email, String etag)` returns a user based on the provided user email string.
`default ApiResponse<User>`	`getUserByUsername(String username)` returns a user based pn the provided user name string.
`ApiResponse<User>`	`getUserByUsername(String username, String etag)` returns a user based pn the provided user name string.
`default ApiResponse<UserList>`	`getUsers()` returns a page of users on the system.
`default ApiResponse<UserList>`	`getUsers(Pager pager)` returns a page of users on the system.
`ApiResponse<UserList>`	`getUsers(Pager pager, String etag)` returns a page of users on the system.
`default ApiResponse<UserList>`	`getUsersByIds(Collection<String> userIds)` returns a list of users based on the provided user ids.
`ApiResponse<UserList>`	`getUsersByIds(String... userIds)` returns a list of users based on the provided user ids.
`default ApiResponse<UserList>`	`getUsersByUsernames(Collection<String> usernames)` returns a list of users based on the provided usernames.
`ApiResponse<UserList>`	`getUsersByUsernames(String... usernames)` returns a list of users based on the provided usernames.
`default ApiResponse<UserList>`	`getUsersInChannel(String channelId)` returns a page of users on a team.
`default ApiResponse<UserList>`	`getUsersInChannel(String channelId, Pager pager)` returns a page of users on a team.
`default ApiResponse<UserList>`	`getUsersInChannel(String channelId, Pager pager, String etag)` returns a page of users on a team.
`default ApiResponse<UserList>`	`getUsersInChannel(String channelId, UsersOrder.InChannel order, Pager pager)` returns a page of users on a team.
`ApiResponse<UserList>`	`getUsersInChannel(String channelId, UsersOrder.InChannel order, Pager pager, String etag)` returns a page of users on a team.
`default ApiResponse<UserList>`	`getUsersInTeam(String teamId)` returns a page of users on a team.
`default ApiResponse<UserList>`	`getUsersInTeam(String teamId, Pager pager)` returns a page of users on a team.
`default ApiResponse<UserList>`	`getUsersInTeam(String teamId, Pager pager, String etag)` returns a page of users on a team.
`default ApiResponse<UserList>`	`getUsersInTeam(String teamId, UsersOrder.InTeam order, Pager pager)` returns a page of users on a team.
`ApiResponse<UserList>`	`getUsersInTeam(String teamId, UsersOrder.InTeam order, Pager pager, String etag)` returns a page of users on a team.
`default ApiResponse<UserList>`	`getUsersNotInChannel(String teamId, String channelId)` returns a page of users on a team.
`default ApiResponse<UserList>`	`getUsersNotInChannel(String teamId, String channelId, Pager pager)` returns a page of users on a team.
`ApiResponse<UserList>`	`getUsersNotInChannel(String teamId, String channelId, Pager pager, String etag)` returns a page of users on a team.
`default ApiResponse<UserList>`	`getUsersNotInTeam(String teamId)` returns a page of users who are not in a team.
`default ApiResponse<UserList>`	`getUsersNotInTeam(String teamId, Pager pager)` returns a page of users who are not in a team.
`ApiResponse<UserList>`	`getUsersNotInTeam(String teamId, Pager pager, String etag)` returns a page of users who are not in a team.
`default ApiResponse<UserList>`	`getUsersWithoutTeam()` returns a page of users on the system that aren't on any teams.
`default ApiResponse<UserList>`	`getUsersWithoutTeam(Pager pager)` returns a page of users on the system that aren't on any teams.
`ApiResponse<UserList>`	`getUsersWithoutTeam(Pager pager, String etag)` returns a page of users on the system that aren't on any teams.
`ApiResponse<User>`	`patchUser(String userId, UserPatch patch)` partially updates a user in the system.
`ApiResponse<Boolean>`	`resetPassword(String token, String newPassword)` uses a recovery code to update reset a user's password.
`default ApiResponse<Boolean>`	`revokeSession(Session session)` revokes a user session based on the provided user id and session id strings.
`ApiResponse<Boolean>`	`revokeSession(String userId, String sessionId)` revokes a user session based on the provided user id and session id strings.
`ApiResponse<Boolean>`	`revokeUserAccessToken(String tokenId)`
`ApiResponse<UserAccessTokenList>`	`searchTokens(String term)`
`ApiResponse<UserList>`	`searchUsers(UserSearch search)` returns a list of users based on some search criteria.
`ApiResponse<Boolean>`	`sendPasswordResetEmail(String email)` will send a link for password resetting to a user with the provided email.
`ApiResponse<Boolean>`	`sendVerificationEmail(String email)` will send an email to the user with the provided email addresses, if that user exists.
`ApiResponse<Boolean>`	`setProfileImage(String userId, Path imageFilePath)` sets profile image of the user.
`ApiResponse<User>`	`updateUser(User user)` updates a user in the system based on the provided user object.
`ApiResponse<Boolean>`	`updateUserActive(String userId, boolean active)` updates status of a user whether active or not.
`ApiResponse<Boolean>`	`updateUserMfa(String userId, String code, boolean activate)` activates multi-factor authentication for a user if activate is true and a valid code is provided.
`ApiResponse<Boolean>`	`updateUserPassword(String userId, String currentPassword, String newPassword)` updates a user's password.
`default ApiResponse<Boolean>`	`updateUserRoles(String userId, Collection<Role> roles)` updates a user's roles in the system.
`ApiResponse<Boolean>`	`updateUserRoles(String userId, Role... roles)` updates a user's roles in the system.
`ApiResponse<Boolean>`	`verifyUserEmail(String token)` will verify a user's email using the supplied token.

Method Detail

createUser
```
ApiResponse<User> createUser(User user)
```
creates a user in the system based on the provided user object.

getMe
```
default ApiResponse<User> getMe()
```
returns the logged in user.

getMe
```
ApiResponse<User> getMe(String etag)
```
returns the logged in user.

getUser
```
default ApiResponse<User> getUser(String userId)
```
returns a user based on the provided user id string.

getUser

ApiResponse<User> getUser(String userId,
                          String etag)

returns a user based on the provided user id string.

getUserByUsername
```
default ApiResponse<User> getUserByUsername(String username)
```
returns a user based pn the provided user name string.

getUserByUsername

ApiResponse<User> getUserByUsername(String username,
                                    String etag)

returns a user based pn the provided user name string.

getUserByEmail
```
default ApiResponse<User> getUserByEmail(String email)
```
returns a user based on the provided user email string.

getUserByEmail

ApiResponse<User> getUserByEmail(String email,
                                 String etag)

returns a user based on the provided user email string.

autocompleteUsersInTeam

default ApiResponse<UserAutocomplete> autocompleteUsersInTeam(String teamId,
                                                              String username)

returns the users on a team based on search term.

autocompleteUsersInTeam

ApiResponse<UserAutocomplete> autocompleteUsersInTeam(String teamId,
                                                      String username,
                                                      String etag)

returns the users on a team based on search term.

autocompleteUsersInChannel

default ApiResponse<UserAutocomplete> autocompleteUsersInChannel(String teamId,
                                                                 String channelId,
                                                                 String username)

returns the users in a channel based on search term.

autocompleteUsersInChannel

ApiResponse<UserAutocomplete> autocompleteUsersInChannel(String teamId,
                                                         String channelId,
                                                         String username,
                                                         String etag)

returns the users in a channel based on search term.

autocompleteUsers

default ApiResponse<UserAutocomplete> autocompleteUsers(String username)

returns the users in the system based on search term.

autocompleteUsers

ApiResponse<UserAutocomplete> autocompleteUsers(String username,
                                                String etag)

returns the users in the system based on search term.

getProfileImage
```
default ApiResponse<byte[]> getProfileImage(String userId)
```
gets user's profile image. Must be logged in or be a system administrator.

getProfileImage

ApiResponse<byte[]> getProfileImage(String userId,
                                    String etag)

gets user's profile image. Must be logged in or be a system administrator.

getUsers
```
default ApiResponse<UserList> getUsers()
```
returns a page of users on the system. Page counting starts at 0.

getUsers
```
default ApiResponse<UserList> getUsers(Pager pager)
```
returns a page of users on the system. Page counting starts at 0.

getUsers

ApiResponse<UserList> getUsers(Pager pager,
                               String etag)

returns a page of users on the system. Page counting starts at 0.

getUsersInTeam
```
default ApiResponse<UserList> getUsersInTeam(String teamId)
```
returns a page of users on a team. Page counting starts at 0.

getUsersInTeam

default ApiResponse<UserList> getUsersInTeam(String teamId,
                                             Pager pager)

returns a page of users on a team. Page counting starts at 0.

getUsersInTeam

default ApiResponse<UserList> getUsersInTeam(String teamId,
                                             UsersOrder.InTeam order,
                                             Pager pager)

returns a page of users on a team. Page counting starts at 0.

getUsersInTeam

default ApiResponse<UserList> getUsersInTeam(String teamId,
                                             Pager pager,
                                             String etag)

returns a page of users on a team. Page counting starts at 0.

getUsersInTeam

ApiResponse<UserList> getUsersInTeam(String teamId,
                                     UsersOrder.InTeam order,
                                     Pager pager,
                                     String etag)

returns a page of users on a team. Page counting starts at 0.

getUsersNotInTeam
```
default ApiResponse<UserList> getUsersNotInTeam(String teamId)
```
returns a page of users who are not in a team. Page counting starts at 0.

getUsersNotInTeam

default ApiResponse<UserList> getUsersNotInTeam(String teamId,
                                                Pager pager)

returns a page of users who are not in a team. Page counting starts at 0.

getUsersNotInTeam

ApiResponse<UserList> getUsersNotInTeam(String teamId,
                                        Pager pager,
                                        String etag)

returns a page of users who are not in a team. Page counting starts at 0.

getUsersInChannel
```
default ApiResponse<UserList> getUsersInChannel(String channelId)
```
returns a page of users on a team. Page counting starts at 0.

getUsersInChannel

default ApiResponse<UserList> getUsersInChannel(String channelId,
                                                Pager pager)

returns a page of users on a team. Page counting starts at 0.

getUsersInChannel

default ApiResponse<UserList> getUsersInChannel(String channelId,
                                                UsersOrder.InChannel order,
                                                Pager pager)

returns a page of users on a team. Page counting starts at 0.

getUsersInChannel

default ApiResponse<UserList> getUsersInChannel(String channelId,
                                                Pager pager,
                                                String etag)

returns a page of users on a team. Page counting starts at 0.

getUsersInChannel

ApiResponse<UserList> getUsersInChannel(String channelId,
                                        UsersOrder.InChannel order,
                                        Pager pager,
                                        String etag)

returns a page of users on a team. Page counting starts at 0.

getUsersNotInChannel

default ApiResponse<UserList> getUsersNotInChannel(String teamId,
                                                   String channelId)

returns a page of users on a team. Page counting starts at 0.

getUsersNotInChannel

default ApiResponse<UserList> getUsersNotInChannel(String teamId,
                                                   String channelId,
                                                   Pager pager)

returns a page of users on a team. Page counting starts at 0.

getUsersNotInChannel

ApiResponse<UserList> getUsersNotInChannel(String teamId,
                                           String channelId,
                                           Pager pager,
                                           String etag)

returns a page of users on a team. Page counting starts at 0.

getUsersWithoutTeam
```
default ApiResponse<UserList> getUsersWithoutTeam()
```
returns a page of users on the system that aren't on any teams. Page counting starts at 0.

getUsersWithoutTeam
```
default ApiResponse<UserList> getUsersWithoutTeam(Pager pager)
```
returns a page of users on the system that aren't on any teams. Page counting starts at 0.

getUsersWithoutTeam

ApiResponse<UserList> getUsersWithoutTeam(Pager pager,
                                          String etag)

returns a page of users on the system that aren't on any teams. Page counting starts at 0.

getUsersByIds

default ApiResponse<UserList> getUsersByIds(Collection<String> userIds)

returns a list of users based on the provided user ids.

getUsersByIds
```
ApiResponse<UserList> getUsersByIds(String... userIds)
```
returns a list of users based on the provided user ids.

getUsersByUsernames

default ApiResponse<UserList> getUsersByUsernames(Collection<String> usernames)

returns a list of users based on the provided usernames.

getUsersByUsernames
```
ApiResponse<UserList> getUsersByUsernames(String... usernames)
```
returns a list of users based on the provided usernames.

searchUsers
```
ApiResponse<UserList> searchUsers(UserSearch search)
```
returns a list of users based on some search criteria.

updateUser
```
ApiResponse<User> updateUser(User user)
```
updates a user in the system based on the provided user object.

patchUser

ApiResponse<User> patchUser(String userId,
                            UserPatch patch)

partially updates a user in the system. Any missing fields are not updated.

updateUserMfa
```
ApiResponse<Boolean> updateUserMfa(String userId,
                                   String code,
                                   boolean activate)
```
activates multi-factor authentication for a user if activate is true and a valid code is provided. If activate is false, then code is not required and multi-factor authentication is disabled for the user.

checkUserMfa
```
boolean checkUserMfa(String loginId)
```
checks whether a user has MFA active on their account or not based on the provided login id.

generateMfaSecret
```
ApiResponse<MfaSecret> generateMfaSecret(String userId)
```
will generate a new MFA secret for a user and return it as a string and as a base64 encoded image QR code.

updateUserPassword

ApiResponse<Boolean> updateUserPassword(String userId,
                                        String currentPassword,
                                        String newPassword)

updates a user's password. Must be logged in as the user or be a system administrator.

updateUserRoles

default ApiResponse<Boolean> updateUserRoles(String userId,
                                             Collection<Role> roles)

updates a user's roles in the system. A user can have "system_user" and "system_admin" roles.

updateUserRoles

ApiResponse<Boolean> updateUserRoles(String userId,
                                     Role... roles)

updates a user's roles in the system. A user can have "system_user" and "system_admin" roles.

updateUserActive

ApiResponse<Boolean> updateUserActive(String userId,
                                      boolean active)

updates status of a user whether active or not.

deleteUser
```
ApiResponse<Boolean> deleteUser(String userId)
```
deactivates a user in the system based on the provided user id string.

sendPasswordResetEmail
```
ApiResponse<Boolean> sendPasswordResetEmail(String email)
```
will send a link for password resetting to a user with the provided email.

resetPassword

ApiResponse<Boolean> resetPassword(String token,
                                   String newPassword)

uses a recovery code to update reset a user's password.

getSessions
```
default ApiResponse<SessionList> getSessions(String userId)
```
returns a list of sessions based on the provided user id string.

getSessions

ApiResponse<SessionList> getSessions(String userId,
                                     String etag)

returns a list of sessions based on the provided user id string.

revokeSession
```
default ApiResponse<Boolean> revokeSession(Session session)
```
revokes a user session based on the provided user id and session id strings.

revokeSession

ApiResponse<Boolean> revokeSession(String userId,
                                   String sessionId)

revokes a user session based on the provided user id and session id strings.

attachDeviceId
```
ApiResponse<Boolean> attachDeviceId(String deviceId)
```
attaches a mobile device ID to the current session.

getTeamUnreadForUser
```
default ApiResponse<TeamUnreadList> getTeamUnreadForUser(String userId)
```
will return a list with TeamUnread objects that contain the amount of unread messages and mentions the current user has for the teams it belongs to. An optional team ID can be set to exclude that team from the results. Must be authenticated.

getTeamUnreadForUser
```
ApiResponse<TeamUnreadList> getTeamUnreadForUser(String userId,
                                                 String teamIdToExclude)
```
will return a list with TeamUnread objects that contain the amount of unread messages and mentions the current user has for the teams it belongs to. An optional team ID can be set to exclude that team from the results. Must be authenticated.

getUserAudits
```
default ApiResponse<Audits> getUserAudits(String userId)
```
returns a list of audit based on the provided user id string.

getUserAudits

default ApiResponse<Audits> getUserAudits(String userId,
                                          Pager pager)

returns a list of audit based on the provided user id string.

getUserAudits

ApiResponse<Audits> getUserAudits(String userId,
                                  Pager pager,
                                  String etag)

returns a list of audit based on the provided user id string.

verifyUserEmail
```
ApiResponse<Boolean> verifyUserEmail(String token)
```
will verify a user's email using the supplied token.

sendVerificationEmail
```
ApiResponse<Boolean> sendVerificationEmail(String email)
```
will send an email to the user with the provided email addresses, if that user exists. The email will contain a link that can be used to verify the user's email address.

setProfileImage

ApiResponse<Boolean> setProfileImage(String userId,
                                     Path imageFilePath)

sets profile image of the user.

createUserAccessToken

ApiResponse<UserAccessToken> createUserAccessToken(String userId,
                                                   String description)

getUserAccessTokens

default ApiResponse<UserAccessTokenList> getUserAccessTokens(String userId)

getUserAccessTokens

ApiResponse<UserAccessTokenList> getUserAccessTokens(String userId,
                                                     Pager pager)

getUserAccessTokensAllUsers

default ApiResponse<UserAccessTokenList> getUserAccessTokensAllUsers()

getUserAccessTokensAllUsers

ApiResponse<UserAccessTokenList> getUserAccessTokensAllUsers(Pager pager)

revokeUserAccessToken

ApiResponse<Boolean> revokeUserAccessToken(String tokenId)

getUserAccessToken

ApiResponse<UserAccessToken> getUserAccessToken(String tokenId)

disableUserAccessToken

ApiResponse<Boolean> disableUserAccessToken(String tokenId)

enableUserAccessToken

ApiResponse<Boolean> enableUserAccessToken(String tokenId)

searchTokens

ApiResponse<UserAccessTokenList> searchTokens(String term)

Interface UserApi

Method Summary

Method Detail

createUser

getMe

getMe

getUser

getUser

getUserByUsername

getUserByUsername

getUserByEmail

getUserByEmail

autocompleteUsersInTeam

autocompleteUsersInTeam

autocompleteUsersInChannel

autocompleteUsersInChannel

autocompleteUsers

autocompleteUsers

getProfileImage

getProfileImage

getUsers

getUsers

getUsers

getUsersInTeam

getUsersInTeam

getUsersInTeam

getUsersInTeam

getUsersInTeam

getUsersNotInTeam

getUsersNotInTeam

getUsersNotInTeam

getUsersInChannel

getUsersInChannel

getUsersInChannel

getUsersInChannel

getUsersInChannel

getUsersNotInChannel

getUsersNotInChannel

getUsersNotInChannel

getUsersWithoutTeam

getUsersWithoutTeam

getUsersWithoutTeam

getUsersByIds

getUsersByIds

getUsersByUsernames

getUsersByUsernames

searchUsers

updateUser

patchUser

updateUserMfa

checkUserMfa

generateMfaSecret

updateUserPassword

updateUserRoles

updateUserRoles

updateUserActive

deleteUser

sendPasswordResetEmail

resetPassword

getSessions

getSessions

revokeSession

revokeSession

attachDeviceId

getTeamUnreadForUser

getTeamUnreadForUser

getUserAudits

getUserAudits

getUserAudits

verifyUserEmail

sendVerificationEmail

setProfileImage

createUserAccessToken

getUserAccessTokens

getUserAccessTokens

getUserAccessTokensAllUsers

getUserAccessTokensAllUsers

revokeUserAccessToken

getUserAccessToken

disableUserAccessToken