Interface IOrganisation

Represents an organisation in the identity system. The root organisation is the tenant.

Inherited Members
Namespace: IRM.AspNetCore.Identity
Assembly: IRM.AspNetCore.Identity.dll
Syntax
public interface IOrganisation : IEventAggregate

Properties

Claims

Gets a collection of claims that is associated with the organisation.

Declaration
IEnumerable<OrganisationClaim> Claims { get; }
Property Value
IEnumerable<OrganisationClaim>

Created

Gets or sets the date and time, in UTC, when the organisation was created.

Declaration
DateTimeOffset Created { get; set; }
Property Value
System.DateTimeOffset

GroupMotherId

Gets or sets the Id of the group mother (root organisation) in the organisation tree.

Declaration
Guid GroupMotherId { get; set; }
Property Value
System.Guid

Remarks

For the group mother, this value will be the same as Id.

Id

Gets or sets the identity of the organisation.

Declaration
Guid Id { get; set; }
Property Value
System.Guid

IdentityNumber

Gets or sets the identity number for the organisation.

Declaration
string IdentityNumber { get; set; }
Property Value
String

Name

Gets the name of the tenant.

Declaration
string Name { get; set; }
Property Value
String

Parent

Gets the parent organisation, if any.

Declaration
IOrganisation Parent { get; }
Property Value
IOrganisation

ParentId

Gets the identity of this tenants parent, if any.

Declaration
Guid? ParentId { get; set; }
Property Value
System.Nullable<System.Guid>

Subsidiaries

Gets a collection of subsidiaries organisations. WARNING: An organisaiton can have subsidiaries, even if the collection is empty, because a complete tree is never loadded from the database.

Declaration
IEnumerable<IOrganisation> Subsidiaries { get; }
Property Value
IEnumerable<IOrganisation>

TrustedDomains

Gets a collection of trusted domain that the organisation owns and therefor want to allow users with e-mail addresses from that domain to sign-up.

Declaration
IEnumerable<ITrustedDomain> TrustedDomains { get; }
Property Value
IEnumerable<ITrustedDomain>

Methods

AddClaim(String, String)

Adds a claim to the organisation.

Declaration
void AddClaim(string claimType, string claimValue)
Parameters
String claimType

The type of claim.
String claimValue

The value of the claim.

AddTrustedDomain(String)

Adds domainName as a trusted domain for this organisation.

Declaration
void AddTrustedDomain(string domainName)
Parameters
String domainName

The domain name to add.

RemoveClaim(Int32)

Removes the claim with id.

Declaration
void RemoveClaim(int id)
Parameters
System.Int32 id

The id of the claim to remove.

RemoveTrustedDomain(String)

Removes domainName as a trusted domain for this organisation.

Declaration
void RemoveTrustedDomain(string domainName)
Parameters
String domainName

The domain name to delete.

Extension Methods