Class TenantConfigurationStore<TTenantOidcSetting, TContext>

Represents a new instance of a persistence store for different tenant configurations.

Inheritance
Object
TenantConfigurationStore<TTenantOidcSetting, TContext>
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.EntityFrameworkCore
Assembly: IRM.AspNetCore.Identity.EntityFrameworkCore.dll
Syntax
public class TenantConfigurationStore<TTenantOidcSetting, TContext> : ITenantConfigurationStore<TTenantOidcSetting>, IDisposable where TTenantOidcSetting : class where TContext : DbContext
Type Parameters
TTenantOidcSetting

The type of the tenant OpenID Connect setting object.
TContext

The type of the data context class used to access the store.

Constructors

TenantConfigurationStore(TContext, IdentityErrorDescriber)

Creates a new instance of TenantConfigurationStore<TTenantOidcSetting, TContext>.

Declaration
public TenantConfigurationStore(TContext context, IdentityErrorDescriber describer = null)
Parameters
TContext context

The context used to access the store.
Microsoft.AspNetCore.Identity.IdentityErrorDescriber describer

The Microsoft.AspNetCore.Identity.IdentityErrorDescriber used to describe store errors.

Properties

Context

Gets the database context for this store.

Declaration
public TContext Context { get; }
Property Value
TContext

Methods

Dispose()

Releases all resources used by the store.

Declaration
public void Dispose()
Implements
System.IDisposable.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(CancellationToken)

Retrieves all configured OpenID Connect providers (per tenant).

Declaration
public virtual Task<List<TTenantOidcSetting>> GetAllTenantOidcSettingsAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Threading.CancellationToken cancellationToken

The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.
Returns
System.Threading.Tasks.Task<List<TTenantOidcSetting>>

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

GetAllTenantSaml2Providers(CancellationToken)

Retrieves all configured saml2 providers (per tenant).

Declaration
public virtual Task<List<TenantSaml2Provider>> GetAllTenantSaml2Providers(CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Threading.CancellationToken cancellationToken

The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.
Returns
System.Threading.Tasks.Task<List<TenantSaml2Provider>>

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

GetTenantSaml2Providers(Guid, CancellationToken)

Retrieves all configured saml2 providers for the specified tenant.

Declaration
public virtual Task<List<TenantSaml2Provider>> GetTenantSaml2Providers(Guid tenantId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
System.Guid tenantId

The unique identity of the tenant.
System.Threading.CancellationToken cancellationToken

The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.
Returns
System.Threading.Tasks.Task<List<TenantSaml2Provider>>

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

SaveChanges(CancellationToken)

Saves the current store.

Declaration
protected virtual Task SaveChanges(CancellationToken cancellationToken)
Parameters
System.Threading.CancellationToken cancellationToken

The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.
Returns
System.Threading.Tasks.Task

The System.Threading.Tasks.Task that represents the asynchronous operation.

ThrowIfDisposed()

Throws an System.ObjectDisposedException if the person store is disposed.

Declaration
protected void ThrowIfDisposed()