Authenticates a user using a login ID and a password.
Namespace:
MattermostDriver
Assembly:
MattermostDriver (in MattermostDriver.dll) Version: 0.0.3.10 (0.0.3.10)
Syntaxpublic Self Login(
string login_id,
string password,
string device_id = ""
)
Public Function Login (
login_id As String,
password As String,
Optional device_id As String = ""
) As Self
public:
Self^ Login(
String^ login_id,
String^ password,
String^ device_id = L""
)
member Login :
login_id : string *
password : string *
?device_id : string
(* Defaults:
let _device_id = defaultArg device_id ""
*)
-> Self
Parameters
- login_id
- Type: SystemString
The login ID, which can be a username, email, or SSO identifier. - password
- Type: SystemString
The user's password. - device_id (Optional)
- Type: SystemString
(Optional) Attaches a device ID to this session.
Return Value
Type:
SelfA Self object of the newly-authenticated user.
See Also