Files
Umbraco-CMS/src/Umbraco.Web/Security/IBackOfficeUserPasswordChecker.cs

26 lines
1.1 KiB
C#
Raw Normal View History

2017-07-20 11:21:28 +02:00
using System.Threading.Tasks;
using Umbraco.Core.Models.Identity;
namespace Umbraco.Web.Security
{
/// <summary>
2017-07-20 11:21:28 +02:00
/// Used by the BackOfficeUserManager to check the username/password which allows for developers to more easily
/// set the logic for this procedure.
/// </summary>
public interface IBackOfficeUserPasswordChecker
{
2017-08-25 17:55:26 +02:00
/// <summary>
/// Checks a password for a user
/// </summary>
/// <param name="user"></param>
/// <param name="password"></param>
/// <returns></returns>
/// <remarks>
2017-09-23 10:08:18 +02:00
/// This will allow a developer to auto-link a local account which is required if the user queried doesn't exist locally.
2017-08-25 17:55:26 +02:00
/// The user parameter will always contain the username, if the user doesn't exist locally, the other properties will not be filled in.
/// A developer can then create a local account by filling in the properties and using UserManager.CreateAsync
/// </remarks>
Task<BackOfficeUserPasswordCheckerResult> CheckPasswordAsync(BackOfficeIdentityUser user, string password);
}
2017-09-23 10:08:18 +02:00
}