net.bis5.mattermost.client4.api

Interface AuthenticationApi

All Known Implementing Classes:

MattermostClient

public interface AuthenticationApi

Authentication API.

Author:

Takayuki Maruyama

Method Summary

Modifier and Type	Method and Description
User	login(String loginId, String password) authenticates a user by login id, which can be username, email, or some sort of SSO identifier based on server configuration, and a password.
User	loginById(String id, String password) authenticates a user by user id and password.
User	loginByLdap(String loginId, String password) authenticates a user by LDAP id and password.
User	loginWithDevice(String loginId, String password, String deviceId) authenticates a user by login id (username, email or some sort of SSO identifier based on configuration), password and attaches a device id to the session.
ApiResponse<Boolean>	logout() terminates the current user's session.
ApiResponse<SwitchAccountTypeResult>	switchAccountType(SwitchRequest switchRequest) changes a user's login type from one type to another.

Method Detail

loginById

User loginById(String id,
               String password)

authenticates a user by user id and password.

login

User login(String loginId,
           String password)

authenticates a user by login id, which can be username, email, or some sort of SSO identifier based on server configuration, and a password.

loginByLdap

User loginByLdap(String loginId,
                 String password)

authenticates a user by LDAP id and password.

loginWithDevice

User loginWithDevice(String loginId,
                     String password,
                     String deviceId)

authenticates a user by login id (username, email or some sort of SSO identifier based on configuration), password and attaches a device id to the session.

logout

ApiResponse<Boolean> logout()

terminates the current user's session.

switchAccountType

ApiResponse<SwitchAccountTypeResult> switchAccountType(SwitchRequest switchRequest)

changes a user's login type from one type to another.