Interface ITenantSettingsCache

Represents an updateable cache of TenantSettings.

Inherited Members

IRM.AspNetCore.Authentication.Dynamic.IDynamicAuthenticationSchemeCache.GetAllSchemesAsync()

Namespace: IRM.AspNetCore.Identity

Assembly: IRM.AspNetCore.Identity.dll

Syntax

public interface ITenantSettingsCache : IDynamicAuthenticationSchemeCache

Methods

GetAll(CancellationToken)

Gets a collection of TenantSettings for all tenants, if any.

Declaration

Task<List<TenantSettings>> GetAll(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<TenantSettings>> A collection of TenantSettings for all tenants, if any.

GetTenantAuthenticationSettings(Guid[], CancellationToken)

Gets a collection of TenantSettings for the specified tenantIds, if any.

Declaration

Task<List<TenantSettings>> GetTenantAuthenticationSettings(Guid[] tenantIds, CancellationToken cancellationToken = default(CancellationToken))

Parameters

System.Guid[] tenantIds A collection of unique identifier for tenants.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.

Returns

System.Threading.Tasks.Task<List<TenantSettings>> A collection of TenantSettings for the specified tenantIds, if any.

SetSignInOptionsAsync(IEnumerable<TenantSettings>, CancellationToken)

Updates the cache with all TenantSettings for all tenants.

Declaration

Task SetSignInOptionsAsync(IEnumerable<TenantSettings> authenticationSettings, CancellationToken cancellationToken = default(CancellationToken))

Parameters

IEnumerable<TenantSettings> authenticationSettings The collection of authentication settings.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken used to propagate notifications that the operation should be canceled.

Returns

System.Threading.Tasks.Task