Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

IAuthenticationService Interface

Definition

Namespace:
Microsoft.AspNetCore.Authentication
Assembly:
Microsoft.AspNetCore.Authentication.Abstractions.dll
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
Package:
Microsoft.AspNetCore.Authentication.Abstractions v2.0.0
Package:
Microsoft.AspNetCore.Authentication.Abstractions v2.1.0
Package:
Microsoft.AspNetCore.Authentication.Abstractions v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.36
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
IAuthenticationService.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Used to provide authentication.

public interface class IAuthenticationService
public interface IAuthenticationService
type IAuthenticationService = interface
Public Interface IAuthenticationService
Derived

Methods

Name Description
AuthenticateAsync(HttpContext, String)

Authenticate for the specified authentication scheme.

ChallengeAsync(HttpContext, String, AuthenticationProperties)

Challenge the specified authentication scheme. An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication.

ForbidAsync(HttpContext, String, AuthenticationProperties)

Forbids the specified authentication scheme. Forbid is used when an authenticated user attempts to access a resource they are not permitted to access.

SignInAsync(HttpContext, String, ClaimsPrincipal, AuthenticationProperties)

Sign a principal in for the specified authentication scheme.

SignOutAsync(HttpContext, String, AuthenticationProperties)

Sign out the specified authentication scheme.

Extension Methods

Name Description
GetTokenAsync(IAuthenticationService, HttpContext, String, String)

Authenticates the request using the specified authentication scheme and returns the value for the token.

GetTokenAsync(IAuthenticationService, HttpContext, String)

Authenticates the request using the specified authentication scheme and returns the value for the token.

Applies to


Feedback

Was this page helpful?