View Source

Class BackOfficeController

Inheritance
System.Object
ManagementApiControllerBase
SecurityControllerBase
Namespace: Umbraco.Cms.Api.Management.Controllers.Security
Assembly: Umbraco.Cms.Api.Management.dll
Syntax
public class BackOfficeController : SecurityControllerBase

Constructors

View Source

BackOfficeController(IHttpContextAccessor, IBackOfficeSignInManager, IBackOfficeUserManager, IOptions<SecuritySettings>, ILogger<BackOfficeController>, IBackOfficeTwoFactorOptions, IUserTwoFactorLoginService, IBackOfficeExternalLoginService)

Declaration
public BackOfficeController(IHttpContextAccessor httpContextAccessor, IBackOfficeSignInManager backOfficeSignInManager, IBackOfficeUserManager backOfficeUserManager, IOptions<SecuritySettings> securitySettings, ILogger<BackOfficeController> logger, IBackOfficeTwoFactorOptions backOfficeTwoFactorOptions, IUserTwoFactorLoginService userTwoFactorLoginService, IBackOfficeExternalLoginService externalLoginService)
Parameters
Type Name Description
IHttpContextAccessor httpContextAccessor
IBackOfficeSignInManager backOfficeSignInManager
IBackOfficeUserManager backOfficeUserManager
IOptions<SecuritySettings> securitySettings
ILogger<BackOfficeController> logger
IBackOfficeTwoFactorOptions backOfficeTwoFactorOptions
IUserTwoFactorLoginService userTwoFactorLoginService
IBackOfficeExternalLoginService externalLoginService

Methods

View Source

Authorize(CancellationToken)

Declaration
public async Task<IActionResult> Authorize(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<IActionResult>
View Source

ExternalLinkLoginCallback()

Callback path when the user initiates a link login request from the back office to the external provider from the LinkLogin(LinkLoginRequestModel) action

Declaration
public async Task<IActionResult> ExternalLinkLoginCallback()
Returns
Type Description
Task<IActionResult>
Remarks

An example of this is here https://github.com/dotnet/aspnetcore/blob/main/src/Identity/samples/IdentitySample.Mvc/Controllers/AccountController.cs#L155 which this is based on

View Source

LinkLogin(LinkLoginRequestModel)

Called when a user links an external login provider in the back office

Declaration
public async Task<IActionResult> LinkLogin(LinkLoginRequestModel requestModel)
Parameters
Type Name Description
LinkLoginRequestModel requestModel
Returns
Type Description
Task<IActionResult>
View Source

LinkLoginKey(String)

Declaration
public async Task<IActionResult> LinkLoginKey(string provider)
Parameters
Type Name Description
System.String provider
Returns
Type Description
Task<IActionResult>
View Source

Login(CancellationToken, LoginRequestModel)

Declaration
public async Task<IActionResult> Login(CancellationToken cancellationToken, LoginRequestModel model)
Parameters
Type Name Description
CancellationToken cancellationToken
LoginRequestModel model
Returns
Type Description
Task<IActionResult>
View Source

PostUnLinkLogin(UnLinkLoginRequestModel)

Declaration
public async Task<IActionResult> PostUnLinkLogin(UnLinkLoginRequestModel unlinkLoginRequestModel)
Parameters
Type Name Description
UnLinkLoginRequestModel unlinkLoginRequestModel
Returns
Type Description
Task<IActionResult>
View Source

Signout(CancellationToken)

Declaration
public async Task<IActionResult> Signout(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<IActionResult>
View Source

Verify2FACode(CancellationToken, Verify2FACodeModel)

Declaration
public async Task<IActionResult> Verify2FACode(CancellationToken cancellationToken, Verify2FACodeModel model)
Parameters
Type Name Description
CancellationToken cancellationToken
Verify2FACodeModel model
Returns
Type Description
Task<IActionResult>