Show / Hide Table of Contents

Interface ITenantConfigurationStore<TTenantOidcSetting>

Provides an abstraction for a store which manages tenant configuration.

Inherited Members
System.IDisposable.Dispose()
Namespace: IRM.AspNetCore.Identity
Assembly: IRM.AspNetCore.Identity.dll
Syntax
public interface ITenantConfigurationStore<TTenantOidcSetting> : IDisposable where TTenantOidcSetting : class
Type Parameters
TTenantOidcSetting

The type of the tenant OpenID Connect setting object.

Methods

GetAllTenantOidcSettingsAsync(CancellationToken)

Retrieves all configured OpenID Connect providers (per tenant).

Declaration
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.

GetAllTenantSaml2Providers(CancellationToken)

Retrieves all configured saml2 providers (per tenant).

Declaration
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.

GetTenantSaml2Providers(Guid, CancellationToken)

Retrieves all configured saml2 providers for the specified tenant.

Declaration
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.

Back to top Generated by DocFX