SignInManager.SignInByLogonParameters(Object) Method

Signs in a user based on the specified user logon parameters.

Namespace: DevExpress.ExpressApp.Security

Assembly: DevExpress.ExpressApp.Security.v25.1.dll

NuGet Package: DevExpress.ExpressApp.Security

Declaration

C#

public AuthenticationResult SignInByLogonParameters(
    object logonParameters
)

VB.NET

Public Function SignInByLogonParameters(
    logonParameters As Object
) As AuthenticationResult

Parameters

Name	Type	Description
logonParameters	Object	An object that contains a user’s logon parameters.

Returns

Type	Description
DevExpress.ExpressApp.Security.AuthenticationResult	An object of the AuthenticationResult type that contains the result of an authentication attempt.

Remarks

Use this method to programmatically sign a user into an XAF application. This method takes an object that contains a user’s logon parameters and returns an AuthenticationResult object.

The returned object exposes the following properties.

Succeeded

A boolean property that indicates whether or not the authentication attempt was successful.

Principal

If the authentication succeeds, this property contains the ClaimsPrincipal (a collection of statements about the authenticated user) returned by the Security System.

Error

If the authentication fails, this property contains the resulting Exception.

The following code snippet demonstrates how to use the SignInByLogonParameters method:

C#

using DevExpress.ExpressApp.Security;
using Microsoft.Extensions.DependencyInjection;
// ...
// Use Dependency Injection to access the IServiceProvider.
var signInManager = serviceProvider.GetRequiredService<SignInManager>();
var authResult = signInManager.SignInByLogonParameters(new AuthenticationStandardLogonParameters("User", "Password"));

Usage Considerations

• The SignInByLogonParameters method differs from the AuthenticateByLogonParameters method in the following ways:
  • The AuthenticateByLogonParameters method only uses the passed logon parameters to find a user. This method does not affect the currently logged in user.
  • The SignInByLogonParameters method implicitly calls the AuthenticateByLogonParameters method to find a user. If the user is found, SignInByLogonParameters signs in this user.

• When called, all of the UserManager.SignIn* methods first ensure that no user is logged in within the current scope. Note that in WinForms applications this guarantees that no user is logged in at all. Blazor apps allow multiple active scopes, so the same guarantee does not apply. If a user is already logged in, these methods throw the InvalidOperationException with the following message: “Authentication failed: security user already initialized.”.