Interface ITenantSettingsStore

Provides an abstraction for a store which manages tenant authentication settings.

Inherited Members

IRM.AspNetCore.Authentication.Dynamic.IAuthenticationSchemeStore.GetAllSchemesAsync(System.Threading.CancellationToken)

IRM.AspNetCore.Authentication.Dynamic.IAuthenticationSchemeStore.GetSchemesAsync(System.String, System.Threading.CancellationToken)

System.IDisposable.Dispose()

Namespace: IRM.AspNetCore.Identity

Assembly: IRM.AspNetCore.Identity.dll

Syntax

public interface ITenantSettingsStore : IAuthenticationSchemeStore, IDisposable

Methods

FindById(Guid)

Gets the TenantSettings for the tenant identified by tenantId.

Declaration

TenantSettings FindById(Guid tenantId)

Parameters

System.Guid tenantId The unique identity of a tenant.

Returns

TenantSettings The TenantSettings for the tenant identified by tenantId.

FindByIdAsync(Guid, CancellationToken)

Gets the TenantSettings for the tenant identified by tenantId.

Declaration

Task<TenantSettings> FindByIdAsync(Guid tenantId, CancellationToken cancellationToken = default(CancellationToken))

Parameters

System.Guid tenantId The unique identity of a tenant.

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

Returns

System.Threading.Tasks.Task<TenantSettings> The TenantSettings for the tenant identified by tenantId.

FindByUniqueUrl(String, CancellationToken)

Gets the TenantSettings for the tenant identified by uniqueUrl.

Declaration

Task<TenantSettings> FindByUniqueUrl(string uniqueUrl, CancellationToken cancellationToken = default(CancellationToken))

Parameters

String uniqueUrl The unique url identifying a tenant.

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

Returns

System.Threading.Tasks.Task<TenantSettings> The TenantSettings for the tenant identified by uniqueUrl.

SaveAsync(TenantSettings, CancellationToken)

Saves the TenantSettings for a tenant.

Declaration

Task<IdentityResult> SaveAsync(TenantSettings tenantAuthenticationSettings, CancellationToken cancellationToken = default(CancellationToken))

Parameters

TenantSettings tenantAuthenticationSettings

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

Returns

System.Threading.Tasks.Task<IdentityResult> The System.Threading.Tasks.Task that represents the asynchronous operation, containing the IdentityResult of the save operation.