ums

IdpConfiguration — Aggregate Architecture

Bounded Context: Configuration
Aggregate Root: IdpConfiguration
Module: Ums.Domain.Configuration.IdpConfiguration
Status: Production

1. Aggregate Overview

Purpose

The IdpConfiguration aggregate stores a tenant and suite-specific identity-provider resolution rule. It encapsulates provider type, domain hints, external configuration payload, secret reference, activation state, fallback chaining, resolution priority, and versioning.

Business Responsibility

Register identity-provider configuration entries per tenant and suite.
Store provider resolution metadata and payload references.
Control activation/deactivation lifecycle.
Allow updates while configuration is still mutable.
Support ordered fallback resolution behavior.

Aggregate Root

IdpConfiguration is the aggregate root. Secret references, payload changes, domain hints, and lifecycle transitions are coordinated through it.

Invariants and Consistency Rules

TenantId, SystemSuiteId, and ProviderType are mandatory.
ConfigPayload must be non-empty.
New configurations start in Draft.
Only Draft and Inactive configurations may be updated.
Activating an already active configuration is invalid.
Deactivation is only valid from Active.
Every update increments the numeric Version.

Domain Events

2. Domain Model

IdpConfiguration (Aggregate Root)
└── Props: IdpConfigurationProps
    ├── Id: IdValueObject
    ├── TenantId: TenantId
    ├── SystemSuiteId: SystemSuiteId
    ├── ProviderType: ProviderType
    ├── DomainHints: string[]
    ├── ConfigPayload: string
    ├── SecretRef: string
    ├── Status: IdpConfigStatus
    ├── ResolutionPriority: int
    ├── FallbackToId?: Guid
    ├── Version: int
    └── Audit: AuditValueObject

3. Object Model Diagrams

classDiagram
    class IdpConfiguration {
        +Guid Id
        +Guid TenantId
        +Guid SystemSuiteId
        +ProviderType ProviderType
        +string[] DomainHints
        +string ConfigPayload
        +string SecretRef
        +IdpConfigStatus Status
        +int ResolutionPriority
        +Guid FallbackToId
        +int Version
        +Create(tenantId, systemSuiteId, providerType, domainHints, configPayload, secretRef, resolutionPriority, fallbackToId, actor)
        +Update(configPayload, secretRef, domainHints, actor)
        +Activate(actor)
        +Deactivate(actor)
    }

4. Sequence Diagrams

Update IdP Configuration Flow

sequenceDiagram
    participant C as Client
    participant H as Handler
    participant R as IIdpConfigurationRepository
    participant I as IdpConfiguration (AR)

    C->>H: UpdateIdpConfiguration(id, payload, secretRef, domainHints)
    H->>R: GetById(id)
    R-->>H: IdpConfiguration
    H->>I: Update(payload, secretRef, domainHints, actor)
    I->>I: Validate mutable status and payload
    I->>I: Increment Version
    I->>I: Raise IdpConfigUpdatedEvent
    H->>R: Update(configuration)

5. ER Model

erDiagram
    TENANT ||--o{ IDP_CONFIGURATION : "owns"
    SYSTEM_SUITE ||--o{ IDP_CONFIGURATION : "scopes"

    IDP_CONFIGURATION {
        uniqueidentifier Id PK
        uniqueidentifier TenantId FK
        uniqueidentifier SystemSuiteId FK
        int ProviderTypeId
        nvarchar DomainHintsJson
        nvarchar ConfigPayload
        nvarchar SecretRef
        int StatusId
        int ResolutionPriority
        uniqueidentifier FallbackToId
        int Version
        nvarchar CreatedBy
        datetime2 CreatedAtUtc
        nvarchar UpdatedBy
        datetime2 UpdatedAtUtc
        nvarchar AuditTimeSpan
    }

Tenant Isolation Rules

Strictly tenant-owned through TenantId.
Further scoped to a concrete SystemSuiteId.

6. Bounded Context Integration

Bridges tenant identity configuration with suite-level resolution behavior.
Can participate in multi-provider routing through ResolutionPriority and FallbackToId.

7. Application Layer

The domain aggregate exists, but API/application implementation is still pending in the current codebase.

8. Infrastructure/Persistence

Persistence and API exposure are still pending for this aggregate.

9. Security & Compliance

SecretRef is the sensitive integration reference and should be resolved through secure secret-management infrastructure.
ConfigPayload is authoritative for provider-specific runtime behavior and must be controlled administratively.

10. Technical Decisions

The implemented model is a suite-aware provider-resolution aggregate, not the older client-id/authority/claim-mapping style document model.
This document now reflects the current implemented aggregate as the source of truth.

Back to Configuration Index

This site is open source. Improve this page.

ums