MattermostUsersApi class

Constructors

MattermostUsersApi(MattermostApiClient apiClient)

Properties

apiClient → MattermostApiClient

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

attachDeviceId(MmAttachDeviceIdRequest mmAttachDeviceIdRequest) → Future<MmStatusOK?>

Attach mobile device

attachDeviceIdWithHttpInfo(MmAttachDeviceIdRequest mmAttachDeviceIdRequest) → Future<Response>

Attach mobile device

autocompleteUsers(String name, {String? teamId, String? channelId, int? limit}) → Future<MmUserAutocomplete?>

Autocomplete users

autocompleteUsersWithHttpInfo(String name, {String? teamId, String? channelId, int? limit}) → Future<Response>

Autocomplete users

checkUserMfa(MmCheckUserMfaRequest mmCheckUserMfaRequest) → Future<MmCheckUserMfa200Response?>

Check MFA

checkUserMfaWithHttpInfo(MmCheckUserMfaRequest mmCheckUserMfaRequest) → Future<Response>

Check MFA

convertBotToUser(String botUserId, MmConvertBotToUserRequest mmConvertBotToUserRequest, {bool? setSystemAdmin}) → Future<MmStatusOK?>

Convert a bot into a user

convertBotToUserWithHttpInfo(String botUserId, MmConvertBotToUserRequest mmConvertBotToUserRequest, {bool? setSystemAdmin}) → Future<Response>

Convert a bot into a user

convertUserToBot(String userId) → Future<MmStatusOK?>

Convert a user into a bot

convertUserToBotWithHttpInfo(String userId) → Future<Response>

Convert a user into a bot

createUser(MmCreateUserRequest mmCreateUserRequest, {String? t, String? iid}) → Future<MmUser?>

Create a user

createUserAccessToken(String userId, MmCreateUserAccessTokenRequest mmCreateUserAccessTokenRequest) → Future<MmUserAccessToken?>

Create a user access token

createUserAccessTokenWithHttpInfo(String userId, MmCreateUserAccessTokenRequest mmCreateUserAccessTokenRequest) → Future<Response>

Create a user access token

createUserWithHttpInfo(MmCreateUserRequest mmCreateUserRequest, {String? t, String? iid}) → Future<Response>

Create a user

deleteUser(String userId) → Future<MmStatusOK?>

Deactivate a user account.

deleteUserWithHttpInfo(String userId) → Future<Response>

Deactivate a user account.

demoteUserToGuest(String userId) → Future<MmStatusOK?>

Demote a user to a guest

demoteUserToGuestWithHttpInfo(String userId) → Future<Response>

Demote a user to a guest

disableUserAccessToken(MmDisableUserAccessTokenRequest mmDisableUserAccessTokenRequest) → Future<MmStatusOK?>

Disable personal access token

disableUserAccessTokenWithHttpInfo(MmDisableUserAccessTokenRequest mmDisableUserAccessTokenRequest) → Future<Response>

Disable personal access token

enableUserAccessToken(MmEnableUserAccessTokenRequest mmEnableUserAccessTokenRequest) → Future<MmStatusOK?>

Enable personal access token

enableUserAccessTokenWithHttpInfo(MmEnableUserAccessTokenRequest mmEnableUserAccessTokenRequest) → Future<Response>

Enable personal access token

generateMfaSecret(String userId) → Future<MmGenerateMfaSecret200Response?>

Generate MFA secret

generateMfaSecretWithHttpInfo(String userId) → Future<Response>

Generate MFA secret

getChannelMembersWithTeamDataForUser(String userId, {int? page, int? pageSize}) → Future<List<MmChannelMemberWithTeamData>?>

Get all channel members from all teams for a user

getChannelMembersWithTeamDataForUserWithHttpInfo(String userId, {int? page, int? pageSize}) → Future<Response>

Get all channel members from all teams for a user

getDefaultProfileImage(String userId) → Future<void>

Return user's default (generated) profile image

getDefaultProfileImageWithHttpInfo(String userId) → Future<Response>

Return user's default (generated) profile image

getKnownUsers() → Future<MmUsersStats?>

Get user IDs of known users

getKnownUsersWithHttpInfo() → Future<Response>

Get user IDs of known users

getProfileImage(String userId, {num? q}) → Future<void>

Get user's profile image

getProfileImageWithHttpInfo(String userId, {num? q}) → Future<Response>

Get user's profile image

getSessions(String userId) → Future<List<MmSession>?>

Get user's sessions

getSessionsWithHttpInfo(String userId) → Future<Response>

Get user's sessions

getTotalUsersStats() → Future<MmUsersStats?>

Get total count of users in the system

getTotalUsersStatsFiltered({String? inTeam, String? inChannel, bool? includeDeleted, bool? includeBots, String? roles, String? channelRoles, String? teamRoles}) → Future<MmUsersStats?>

Get total count of users in the system matching the specified filters

getTotalUsersStatsFilteredWithHttpInfo({String? inTeam, String? inChannel, bool? includeDeleted, bool? includeBots, String? roles, String? channelRoles, String? teamRoles}) → Future<Response>

Get total count of users in the system matching the specified filters

getTotalUsersStatsWithHttpInfo() → Future<Response>

Get total count of users in the system

getUploadsForUser(String userId) → Future<List<MmUploadSession>?>

Get uploads for a user

getUploadsForUserWithHttpInfo(String userId) → Future<Response>

Get uploads for a user

getUser(String userId) → Future<MmUser?>

Get a user

getUserAccessToken(String tokenId) → Future<MmUserAccessTokenSanitized?>

Get a user access token

getUserAccessTokens({int? page, int? perPage}) → Future<List<MmUserAccessTokenSanitized>?>

Get user access tokens

getUserAccessTokensForUser(String userId, {int? page, int? perPage}) → Future<List<MmUserAccessTokenSanitized>?>

Get user access tokens

getUserAccessTokensForUserWithHttpInfo(String userId, {int? page, int? perPage}) → Future<Response>

Get user access tokens

getUserAccessTokensWithHttpInfo({int? page, int? perPage}) → Future<Response>

Get user access tokens

getUserAccessTokenWithHttpInfo(String tokenId) → Future<Response>

Get a user access token

getUserAudits(String userId) → Future<List<MmAudit>?>

Get user's audits

getUserAuditsWithHttpInfo(String userId) → Future<Response>

Get user's audits

getUserByEmail(String email) → Future<MmUser?>

Get a user by email

getUserByEmailWithHttpInfo(String email) → Future<Response>

Get a user by email

getUserByUsername(String username) → Future<MmUser?>

Get a user by username

getUserByUsernameWithHttpInfo(String username) → Future<Response>

Get a user by username

getUsers({int? page, int? perPage, String? inTeam, String? notInTeam, String? inChannel, String? notInChannel, String? inGroup, bool? groupConstrained, bool? withoutTeam, bool? active, bool? inactive, String? role, String? sort, String? roles, String? channelRoles, String? teamRoles}) → Future<List<MmUser>?>

Get users

getUsersByGroupChannelIds(List<String> requestBody) → Future<MmGetUsersByGroupChannelIds200Response?>

Get users by group channels ids

getUsersByGroupChannelIdsWithHttpInfo(List<String> requestBody) → Future<Response>

Get users by group channels ids

getUsersByIds(List<String> requestBody, {int? since}) → Future<List<MmUser>?>

Get users by ids

getUsersByIdsWithHttpInfo(List<String> requestBody, {int? since}) → Future<Response>

Get users by ids

getUsersByUsernames(List<String> requestBody) → Future<List<MmUser>?>

Get users by usernames

getUsersByUsernamesWithHttpInfo(List<String> requestBody) → Future<Response>

Get users by usernames

getUsersWithHttpInfo({int? page, int? perPage, String? inTeam, String? notInTeam, String? inChannel, String? notInChannel, String? inGroup, bool? groupConstrained, bool? withoutTeam, bool? active, bool? inactive, String? role, String? sort, String? roles, String? channelRoles, String? teamRoles}) → Future<Response>

Get users

getUserTermsOfService(String userId) → Future<MmUserTermsOfService?>

Fetches user's latest terms of service action if the latest action was for acceptance.

getUserTermsOfServiceWithHttpInfo(String userId) → Future<Response>

Fetches user's latest terms of service action if the latest action was for acceptance.

getUserWithHttpInfo(String userId) → Future<Response>

Get a user

login(MmLoginRequest mmLoginRequest) → Future<MmUser?>

Login to Mattermost server

loginByCwsToken(MmLoginByCwsTokenRequest mmLoginByCwsTokenRequest) → Future<void>

Auto-Login to Mattermost server using CWS token

loginByCwsTokenWithHttpInfo(MmLoginByCwsTokenRequest mmLoginByCwsTokenRequest) → Future<Response>

Auto-Login to Mattermost server using CWS token

loginWithHttpInfo(MmLoginRequest mmLoginRequest) → Future<Response>

Login to Mattermost server

logout() → Future<MmStatusOK?>

Logout from the Mattermost server

logoutWithHttpInfo() → Future<Response>

Logout from the Mattermost server

migrateAuthToLdap({MmMigrateAuthToLdapRequest? mmMigrateAuthToLdapRequest}) → Future<void>

Migrate user accounts authentication type to LDAP.

migrateAuthToLdapWithHttpInfo({MmMigrateAuthToLdapRequest? mmMigrateAuthToLdapRequest}) → Future<Response>

Migrate user accounts authentication type to LDAP.

migrateAuthToSaml({MmMigrateAuthToSamlRequest? mmMigrateAuthToSamlRequest}) → Future<void>

Migrate user accounts authentication type to SAML.

migrateAuthToSamlWithHttpInfo({MmMigrateAuthToSamlRequest? mmMigrateAuthToSamlRequest}) → Future<Response>

Migrate user accounts authentication type to SAML.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patchUser(String userId, MmPatchUserRequest mmPatchUserRequest) → Future<MmUser?>

Patch a user

patchUserWithHttpInfo(String userId, MmPatchUserRequest mmPatchUserRequest) → Future<Response>

Patch a user

permanentDeleteAllUsers() → Future<void>

Permanent delete all users

permanentDeleteAllUsersWithHttpInfo() → Future<Response>

Permanent delete all users

promoteGuestToUser(String userId) → Future<MmStatusOK?>

Promote a guest to user

promoteGuestToUserWithHttpInfo(String userId) → Future<Response>

Promote a guest to user

publishUserTyping(String userId, {MmPublishUserTypingRequest? mmPublishUserTypingRequest}) → Future<void>

Publish a user typing websocket event.

publishUserTypingWithHttpInfo(String userId, {MmPublishUserTypingRequest? mmPublishUserTypingRequest}) → Future<Response>

Publish a user typing websocket event.

registerTermsOfServiceAction(String userId, MmRegisterTermsOfServiceActionRequest mmRegisterTermsOfServiceActionRequest) → Future<MmStatusOK?>

Records user action when they accept or decline custom terms of service

registerTermsOfServiceActionWithHttpInfo(String userId, MmRegisterTermsOfServiceActionRequest mmRegisterTermsOfServiceActionRequest) → Future<Response>

Records user action when they accept or decline custom terms of service

resetPassword(MmResetPasswordRequest mmResetPasswordRequest) → Future<MmStatusOK?>

Reset password

resetPasswordWithHttpInfo(MmResetPasswordRequest mmResetPasswordRequest) → Future<Response>

Reset password

revokeAllSessions(String userId) → Future<MmStatusOK?>

Revoke all active sessions for a user

revokeAllSessionsWithHttpInfo(String userId) → Future<Response>

Revoke all active sessions for a user

revokeSession(String userId, MmRevokeSessionRequest mmRevokeSessionRequest) → Future<MmStatusOK?>

Revoke a user session

revokeSessionsFromAllUsers() → Future<void>

Revoke all sessions from all users.

revokeSessionsFromAllUsersWithHttpInfo() → Future<Response>

Revoke all sessions from all users.

revokeSessionWithHttpInfo(String userId, MmRevokeSessionRequest mmRevokeSessionRequest) → Future<Response>

Revoke a user session

revokeUserAccessToken(MmRevokeUserAccessTokenRequest mmRevokeUserAccessTokenRequest) → Future<MmStatusOK?>

Revoke a user access token

revokeUserAccessTokenWithHttpInfo(MmRevokeUserAccessTokenRequest mmRevokeUserAccessTokenRequest) → Future<Response>

Revoke a user access token

searchUserAccessTokens(MmSearchUserAccessTokensRequest mmSearchUserAccessTokensRequest) → Future<List<MmUserAccessTokenSanitized>?>

Search tokens

searchUserAccessTokensWithHttpInfo(MmSearchUserAccessTokensRequest mmSearchUserAccessTokensRequest) → Future<Response>

Search tokens

searchUsers(MmSearchUsersRequest mmSearchUsersRequest) → Future<List<MmUser>?>

Search users

searchUsersWithHttpInfo(MmSearchUsersRequest mmSearchUsersRequest) → Future<Response>

Search users

sendPasswordResetEmail(MmSendPasswordResetEmailRequest mmSendPasswordResetEmailRequest) → Future<MmStatusOK?>

Send password reset email

sendPasswordResetEmailWithHttpInfo(MmSendPasswordResetEmailRequest mmSendPasswordResetEmailRequest) → Future<Response>

Send password reset email

sendVerificationEmail(MmSendVerificationEmailRequest mmSendVerificationEmailRequest) → Future<MmStatusOK?>

Send verification email

sendVerificationEmailWithHttpInfo(MmSendVerificationEmailRequest mmSendVerificationEmailRequest) → Future<Response>

Send verification email

setDefaultProfileImage(String userId) → Future<MmStatusOK?>

Delete user's profile image

setDefaultProfileImageWithHttpInfo(String userId) → Future<Response>

Delete user's profile image

setProfileImage(String userId, MultipartFile image) → Future<MmStatusOK?>

Set user's profile image

setProfileImageWithHttpInfo(String userId, MultipartFile image) → Future<Response>

Set user's profile image

switchAccountType(MmSwitchAccountTypeRequest mmSwitchAccountTypeRequest) → Future<MmSwitchAccountType200Response?>

Switch login method

switchAccountTypeWithHttpInfo(MmSwitchAccountTypeRequest mmSwitchAccountTypeRequest) → Future<Response>

Switch login method

toString() → String

A string representation of this object.

inherited

updateUser(String userId, MmUpdateUserRequest mmUpdateUserRequest) → Future<MmUser?>

Update a user

updateUserActive(String userId, MmUpdateUserActiveRequest mmUpdateUserActiveRequest) → Future<MmStatusOK?>

Update user active status

updateUserActiveWithHttpInfo(String userId, MmUpdateUserActiveRequest mmUpdateUserActiveRequest) → Future<Response>

Update user active status

updateUserAuth(String userId, MmUserAuthData mmUserAuthData) → Future<MmUserAuthData?>

Update a user's authentication method

updateUserAuthWithHttpInfo(String userId, MmUserAuthData mmUserAuthData) → Future<Response>

Update a user's authentication method

updateUserMfa(String userId, MmUpdateUserMfaRequest mmUpdateUserMfaRequest) → Future<MmStatusOK?>

Update a user's MFA

updateUserMfaWithHttpInfo(String userId, MmUpdateUserMfaRequest mmUpdateUserMfaRequest) → Future<Response>

Update a user's MFA

updateUserPassword(String userId, MmUpdateUserPasswordRequest mmUpdateUserPasswordRequest) → Future<MmStatusOK?>

Update a user's password

updateUserPasswordWithHttpInfo(String userId, MmUpdateUserPasswordRequest mmUpdateUserPasswordRequest) → Future<Response>

Update a user's password

updateUserRoles(String userId, MmUpdateUserRolesRequest mmUpdateUserRolesRequest) → Future<MmStatusOK?>

Update a user's roles

updateUserRolesWithHttpInfo(String userId, MmUpdateUserRolesRequest mmUpdateUserRolesRequest) → Future<Response>

Update a user's roles

updateUserWithHttpInfo(String userId, MmUpdateUserRequest mmUpdateUserRequest) → Future<Response>

Update a user

verifyUserEmail(MmVerifyUserEmailRequest mmVerifyUserEmailRequest) → Future<MmStatusOK?>

Verify user email

verifyUserEmailWithHttpInfo(MmVerifyUserEmailRequest mmVerifyUserEmailRequest) → Future<Response>

Verify user email

verifyUserEmailWithoutToken(String userId) → Future<MmUser?>

Verify user email by ID

verifyUserEmailWithoutTokenWithHttpInfo(String userId) → Future<Response>

Verify user email by ID

Operators

operator ==(Object other) → bool

The equality operator.

inherited