View Source

Class BackOfficeApplicationManager

Manages back office applications in the Umbraco CMS management security context.

Inheritance

object

OpenIdDictApplicationManagerBase

Namespace: Umbraco.Cms.Api.Management.Security

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public class BackOfficeApplicationManager : OpenIdDictApplicationManagerBase, IBackOfficeApplicationManager

Constructors

BackOfficeApplicationManager(IOpenIddictApplicationManager, IWebHostEnvironment, IOptions<SecuritySettings>, IRuntimeState)

Initializes a new instance of the BackOfficeApplicationManager class with the specified dependencies.

Declaration

[Obsolete("Use the non-obsolete constructor instead. Scheduled for removal in Umbraco 19.")]
public BackOfficeApplicationManager(IOpenIddictApplicationManager applicationManager, IWebHostEnvironment webHostEnvironment, IOptions<SecuritySettings> securitySettings, IRuntimeState runtimeState)

Parameters

Type	Name	Description
IOpenIddictApplicationManager	applicationManager	The OpenIddict application manager used for managing backoffice applications.
IWebHostEnvironment	webHostEnvironment	Provides information about the web hosting environment.
IOptions<SecuritySettings>	securitySettings	The security settings options for configuration.
IRuntimeState	runtimeState	The current runtime state of the Umbraco application.

BackOfficeApplicationManager(IOpenIddictApplicationManager, IWebHostEnvironment, IOptions<SecuritySettings>, IRuntimeState, ILogger<BackOfficeApplicationManager>)

Initializes a new instance of the BackOfficeApplicationManager class.

Declaration

public BackOfficeApplicationManager(IOpenIddictApplicationManager applicationManager, IWebHostEnvironment webHostEnvironment, IOptions<SecuritySettings> securitySettings, IRuntimeState runtimeState, ILogger<BackOfficeApplicationManager> logger)

Parameters

Type	Name	Description
IOpenIddictApplicationManager	applicationManager	The OpenIddict application manager used for managing backoffice authentication applications.
IWebHostEnvironment	webHostEnvironment	Provides information about the web hosting environment.
IOptions<SecuritySettings>	securitySettings	The security settings options for configuring backoffice security.
IRuntimeState	runtimeState	The current runtime state of the Umbraco application.
ILogger<BackOfficeApplicationManager>	logger	The logger used for logging events related to the backoffice application manager.

Methods

DeleteBackOfficeClientCredentialsApplicationAsync(string, CancellationToken)

Deletes a back office client credentials application by its client ID.

Declaration

public Task DeleteBackOfficeClientCredentialsApplicationAsync(string clientId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	clientId	The client ID of the application to delete.
CancellationToken	cancellationToken	A cancellation token to cancel the operation.

Returns

Type	Description
Task	A task representing the asynchronous delete operation.

EnsureBackOfficeApplicationAsync(IEnumerable<Uri>, CancellationToken)

Ensures that the back office application is properly configured with the specified back office hosts. This includes merging the provided hosts with those already configured, validating that all hosts are absolute URIs, and creating or updating the OpenId applications required for back office authentication. In production environments, developer-specific OpenId applications (such as Swagger and Postman) are removed; in non-production environments, these are created or updated as needed.

Declaration

public Task EnsureBackOfficeApplicationAsync(IEnumerable<Uri> backOfficeHosts, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IEnumerable<Uri>	backOfficeHosts	A collection of absolute System.Uri instances representing the back office hosts to configure.
CancellationToken	cancellationToken	A System.Threading.CancellationToken to observe while waiting for the task to complete.

Returns

Type	Description
Task	A System.Threading.Tasks.Task representing the asynchronous operation.

EnsureBackOfficeClientCredentialsApplicationAsync(string, string, CancellationToken)

Ensures that a back-office client credentials application with the specified client ID and secret exists. If such an application does not exist, it will be created; if it exists, it will be updated as necessary.

Declaration

public Task EnsureBackOfficeClientCredentialsApplicationAsync(string clientId, string clientSecret, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	clientId	The client identifier for the back-office application.
string	clientSecret	The client secret for the back-office application.
CancellationToken	cancellationToken	A cancellation token that can be used to cancel the operation.

Returns

Type	Description
Task	A task that represents the asynchronous operation. The task does not return a value.