Show / Hide Table of Contents

Interface IOrganisationManager

Represents an API for managing organisations in a persistence store.

Inherited Members
System.IDisposable.Dispose()
Namespace: IRM.AspNetCore.Identity
Assembly: IRM.AspNetCore.Identity.dll
Syntax
public interface IOrganisationManager : IDisposable

Methods

FindByIdAsync(Guid)

Finds and returns an organisation, if any, that has the specified organisationId.

Declaration
Task<IOrganisation> FindByIdAsync(Guid organisationId)
Parameters
System.Guid organisationId

The organisation ID to search for.

Returns
System.Threading.Tasks.Task<IOrganisation>

The System.Threading.Tasks.Task that represents the asynchronous operation, containing the organisation matching the specified organisationId if it exists.

FindByTrustedDomain(String)

Finds and returns organisation keys, if any, associated with the specified domain name.

Declaration
Task<OrganisationKeys> FindByTrustedDomain(string domainName)
Parameters
String domainName

The organisation domain name to search for.

Returns
System.Threading.Tasks.Task<OrganisationKeys>

The task object containing the results of the asynchronous lookup operation, the organisation keys if any associated with the specified domain name.

FindTenantsByIdsAsync(Guid[])

Finds and returns a list of organisations, if any, who has any of the specified tenantIds.

Declaration
Task<List<IOrganisation>> FindTenantsByIdsAsync(Guid[] tenantIds)
Parameters
System.Guid[] tenantIds

The tenant ID to search for.

Returns
System.Threading.Tasks.Task<List<IOrganisation>>

The System.Threading.Tasks.Task that represents the asynchronous operation, containing the tenants matching the specified tenantIds if it exists.

GetTenantNameAsync(Guid)

Finds and returns the name of the tenant with the specified tenantId.

Declaration
Task<string> GetTenantNameAsync(Guid tenantId)
Parameters
System.Guid tenantId

The unique identity of the tenant.

Returns
System.Threading.Tasks.Task<String>

The System.Threading.Tasks.Task that represents the asynchronous operation, containing the name of the tenant.

Back to top Generated by DocFX