Click or drag to resize

UserInfoAuthenticateUser(String, String, String, String) Method

Authenticates the specified user credentials.

Namespace: GSF.Identity
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta
Syntax
public static IPrincipal AuthenticateUser(
	string domain,
	string userName,
	string password,
	out string errorMessage
)
View Source

Parameters

domain  String
Domain of user to authenticate.
userName  String
Username of user to authenticate.
password  String
Password of user to authenticate.
errorMessage  String
Error message returned, if authentication fails.

Return Value

IPrincipal
true if the user credentials are authenticated successfully; otherwise false.
Example
This example shows how to validate a user's credentials and retrieve an error message if validation fails:
C#
using System;
using GSF.Identity;

class Program
{
    static void Main(string[] args)
    {
        string domain = "XYZCorp";
        string username = "johndoe";
        string password = "password";
        string errorMessage;

        // Authenticate user credentials.
        if (UserInfo.AuthenticateUser(domain, username, password, out errorMessage) is not null)
            Console.WriteLine("Successfully authenticated user \"{0}\\{1}\".", domain, username);
        else
            Console.WriteLine("Failed to authenticate user \"{0}\\{1}\" due to exception: {2}", domain, username, errorMessage);

        Console.ReadLine();
    }
}
See Also