Class TenantConfigurationManager<TTenantOidcSetting>

Provides the APIs for managing tenant settings in a persistence store.

Inheritance
Object
TenantConfigurationManager<TTenantOidcSetting>
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: IRM.AspNetCore.Identity
Assembly: IRM.AspNetCore.Identity.dll
Syntax
public class TenantConfigurationManager<TTenantOidcSetting>
    where TTenantOidcSetting : class
Type Parameters
TTenantOidcSetting

The type of the tenant OpenID Connect setting object.

Constructors

TenantConfigurationManager(ITenantConfigurationStore<TTenantOidcSetting>, ITenantAccessor, IHttpContextAccessor, IOptions<ExtendedIdentityOptions>, ILogger<ITenantConfigurationStore<TTenantOidcSetting>>)

Constructs a new instance of TenantConfigurationManager<TTenantOidcSetting>.

Declaration
public TenantConfigurationManager(ITenantConfigurationStore<TTenantOidcSetting> store, ITenantAccessor tenantAccessor, IHttpContextAccessor contextAccessor, IOptions<ExtendedIdentityOptions> optionsAccessor, ILogger<ITenantConfigurationStore<TTenantOidcSetting>> logger)
Parameters
ITenantConfigurationStore<TTenantOidcSetting> store

The persistence store the manager will operate over.
ITenantAccessor tenantAccessor

The accessor used to access the current tenant information.
Microsoft.AspNetCore.Http.IHttpContextAccessor contextAccessor

The accessor used to access the Microsoft.AspNetCore.Http.HttpContext.
Microsoft.Extensions.Options.IOptions<ExtendedIdentityOptions> optionsAccessor

Microsoft.Extensions.Logging.ILogger<ITenantConfigurationStore<TTenantOidcSetting>> logger

The logger used to log messages, warnings and errors.

Properties

Store

Gets the persistence store the manager operates over.

Declaration
protected ITenantConfigurationStore<TTenantOidcSetting> Store { get; }
Property Value
ITenantConfigurationStore<TTenantOidcSetting>

The persistence store the manager operates over.

Methods

Dispose()

Releases all resources used by the organisation manager.

Declaration
public void Dispose()

Dispose(Boolean)

Releases the unmanaged resources used by the organisation manager and optionally releases the managed resources.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.

GetAllTenantOidcSettingsAsync()

Retrieves all configured OpenID Connect providers (per tenant).

Declaration
public virtual Task<List<TTenantOidcSetting>> GetAllTenantOidcSettingsAsync()
Returns
System.Threading.Tasks.Task<List<TTenantOidcSetting>>

The System.Threading.Tasks.Task for the asynchronous operation, containing a list of TTenantOidcSetting, if any.

GetAllTenantSaml2ProvidersAsync()

Retrieves all configured saml2 providers (per tenant).

Declaration
public virtual Task<List<TenantSaml2Provider>> GetAllTenantSaml2ProvidersAsync()
Returns
System.Threading.Tasks.Task<List<TenantSaml2Provider>>

The System.Threading.Tasks.Task for the asynchronous operation, containing a list of TenantSaml2Provider, if any.

GetTenantSaml2ProvidersAsync()

Retrieves all configured saml2 providers for the current tenant.

Declaration
public virtual Task<List<TenantSaml2Provider>> GetTenantSaml2ProvidersAsync()
Returns
System.Threading.Tasks.Task<List<TenantSaml2Provider>>

The System.Threading.Tasks.Task for the asynchronous operation, containing a list of TenantSaml2Provider, if any.

GetTenantSaml2ProvidersAsync(Guid)

Retrieves all configured saml2 providers for the specified tenant.

Declaration
public virtual Task<List<TenantSaml2Provider>> GetTenantSaml2ProvidersAsync(Guid tenantId)
Parameters
System.Guid tenantId

The unique identity of the tenant.
Returns
System.Threading.Tasks.Task<List<TenantSaml2Provider>>

The System.Threading.Tasks.Task for the asynchronous operation, containing a list of TenantSaml2Provider, if any.

ThrowIfDisposed()

Throws an System.ObjectDisposedException if the organisation manager is disposed.

Declaration
protected void ThrowIfDisposed()