<!DOCTYPE HTML>
<html lang="en" class="light sidebar-visible" dir="ltr">
<head>
<meta charset="UTF-8">
<title>Architecture Overview - SCIM Server Guide</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">
<link rel="icon" href="favicon.svg">
<link rel="shortcut icon" href="favicon.png">
<link rel="stylesheet" href="css/variables.css">
<link rel="stylesheet" href="css/general.css">
<link rel="stylesheet" href="css/chrome.css">
<link rel="stylesheet" href="css/print.css" media="print">
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="fonts/fonts.css">
<link rel="stylesheet" id="highlight-css" href="highlight.css">
<link rel="stylesheet" id="tomorrow-night-css" href="tomorrow-night.css">
<link rel="stylesheet" id="ayu-highlight-css" href="ayu-highlight.css">
<script>
const path_to_root = "";
const default_light_theme = "light";
const default_dark_theme = "navy";
window.path_to_searchindex_js = "searchindex.js";
</script>
<script src="toc.js"></script>
</head>
<body>
<div id="mdbook-help-container">
<div id="mdbook-help-popup">
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
<div>
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
<p>Press <kbd>?</kbd> to show this help</p>
<p>Press <kbd>Esc</kbd> to hide this help</p>
</div>
</div>
</div>
<div id="body-container">
<script>
try {
let theme = localStorage.getItem('mdbook-theme');
let sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>
<script>
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
let theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
const html = document.documentElement;
html.classList.remove('light')
html.classList.add(theme);
html.classList.add("js");
</script>
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
<script>
let sidebar = null;
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
sidebar_toggle.checked = false;
}
if (sidebar === 'visible') {
sidebar_toggle.checked = true;
} else {
html.classList.remove('sidebar-visible');
}
</script>
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
<noscript>
<iframe class="sidebar-iframe-outer" src="toc.html"></iframe>
</noscript>
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</div>
</nav>
<div id="page-wrapper" class="page-wrapper">
<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>
<h1 class="menu-title">SCIM Server Guide</h1>
<div class="right-buttons">
<a href="print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
</div>
</div>
<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<div class="search-wrapper">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
<div class="spinner-wrapper">
<i class="fa fa-spinner fa-spin"></i>
</div>
</div>
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>
<div id="content" class="content">
<main>
<h1 id="architecture"><a class="header" href="#architecture">Architecture</a></h1>
<p>The SCIM Server follows a clean trait-based architecture with clear separation of concerns designed for maximum composability and extensibility.</p>
<h2 id="component-architecture"><a class="header" href="#component-architecture">Component Architecture</a></h2>
<p>The library is built around composable traits that you implement for your specific needs:</p>
<pre><code class="language-text">┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
│ Client Layer │ │ SCIM Server │ │ Resource Layer │
│ │ │ │ │ │
│ • MCP AI │───▶│ • Operations │───▶│ ResourceProvider│
│ • Web Framework│ │ • Multi-tenant │ │ trait │
│ • Custom │ │ • Type Safety │ │ │
└─────────────────┘ └──────────────────┘ └─────────────────┘
│ │
▼ ▼
┌──────────────────┐ ┌─────────────────┐
│ Schema System │ │ Storage Layer │
│ │ │ │
│ • SchemaRegistry │ │ StorageProvider │
│ • Validation │ │ trait │
│ • Value Objects │ │ • In-Memory │
│ • Extensions │ │ • Database │
└──────────────────┘ │ • Custom │
└─────────────────┘
</code></pre>
<h2 id="layer-responsibilities"><a class="header" href="#layer-responsibilities">Layer Responsibilities</a></h2>
<p><strong>Client Layer</strong>: Your integration points - compose these components into web endpoints, AI tools, or custom applications.</p>
<p><strong>SCIM Server</strong>: Orchestration component that coordinates resource operations using your provider implementations.</p>
<p><strong>Resource Layer</strong>: <code>ResourceProvider</code> trait - implement this interface for your data model, or use the provided <code>StandardResourceProvider</code> for common scenarios.</p>
<p><strong>Schema System</strong>: Schema registry and validation components - extend with custom schemas and value objects.</p>
<p><strong>Storage Layer</strong>: <code>StorageProvider</code> trait - use the provided <code>InMemoryStorage</code> for development, or connect to any database or custom backend.</p>
<h2 id="core-traits"><a class="header" href="#core-traits">Core Traits</a></h2>
<h3 id="resourceprovider"><a class="header" href="#resourceprovider">ResourceProvider</a></h3>
<p>Your main integration point for SCIM resource operations:</p>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub trait ResourceProvider {
type Error: std::error::Error + Send + Sync + 'static;
async fn create_resource(
&self,
resource_type: &str,
data: Value,
context: &RequestContext,
) -> Result<Resource, Self::Error>;
async fn get_resource(
&self,
resource_type: &str,
id: &str,
context: &RequestContext,
) -> Result<Option<Resource>, Self::Error>;
// ... other CRUD operations
}
<span class="boring">}</span></code></pre></pre>
<p><strong>Implementation Options:</strong></p>
<ul>
<li>Use <code>StandardResourceProvider<S></code> with any <code>StorageProvider</code> for typical use cases</li>
<li>Implement directly for custom business logic and data models</li>
<li>Wrap existing services or databases</li>
</ul>
<h3 id="storageprovider"><a class="header" href="#storageprovider">StorageProvider</a></h3>
<p>Pure data persistence abstraction:</p>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub trait StorageProvider: Send + Sync {
type Error: std::error::Error + Send + Sync + 'static;
async fn put(&self, key: StorageKey, data: Value) -> Result<Value, Self::Error>;
async fn get(&self, key: StorageKey) -> Result<Option<Value>, Self::Error>;
async fn delete(&self, key: StorageKey) -> Result<bool, Self::Error>;
async fn list(&self, prefix: StoragePrefix) -> Result<Vec<Value>, Self::Error>;
}
<span class="boring">}</span></code></pre></pre>
<p><strong>Implementation Options:</strong></p>
<ul>
<li>Use <code>InMemoryStorage</code> for development and testing</li>
<li>Implement for your database (PostgreSQL, MongoDB, etc.)</li>
<li>Connect to cloud storage or external APIs</li>
</ul>
<h3 id="value-objects"><a class="header" href="#value-objects">Value Objects</a></h3>
<p>Type-safe SCIM attribute handling:</p>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub trait ValueObject: Debug + Send + Sync {
fn attribute_type(&self) -> AttributeType;
fn to_json(&self) -> ValidationResult<Value>;
fn validate_against_schema(&self, definition: &AttributeDefinition) -> ValidationResult<()>;
// ...
}
pub trait SchemaConstructible: ValueObject + Sized {
fn from_schema_and_value(
definition: &AttributeDefinition,
value: &Value,
) -> ValidationResult<Self>;
// ...
}
<span class="boring">}</span></code></pre></pre>
<p><strong>Extension Points:</strong></p>
<ul>
<li>Create custom value objects for domain-specific attributes</li>
<li>Implement validation logic for business rules</li>
<li>Support for complex multi-valued attributes</li>
</ul>
<h2 id="multi-tenant-architecture"><a class="header" href="#multi-tenant-architecture">Multi-Tenant Architecture</a></h2>
<p>The library provides several components for multi-tenant systems:</p>
<h3 id="tenantresolver"><a class="header" href="#tenantresolver">TenantResolver</a></h3>
<p>Maps authentication credentials to tenant context:</p>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub trait TenantResolver: Send + Sync {
type Error: std::error::Error + Send + Sync + 'static;
async fn resolve_tenant(&self, credential: &str) -> Result<TenantContext, Self::Error>;
}
<span class="boring">}</span></code></pre></pre>
<h3 id="requestcontext"><a class="header" href="#requestcontext">RequestContext</a></h3>
<p>Carries tenant and request information through all operations:</p>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>pub struct RequestContext {
pub request_id: String,
tenant_context: Option<TenantContext>,
}
<span class="boring">}</span></code></pre></pre>
<h3 id="tenant-isolation"><a class="header" href="#tenant-isolation">Tenant Isolation</a></h3>
<ul>
<li>All <code>ResourceProvider</code> operations include <code>RequestContext</code></li>
<li>Storage keys automatically include tenant ID</li>
<li>Schema validation respects tenant-specific extensions</li>
</ul>
<h2 id="schema-system-architecture"><a class="header" href="#schema-system-architecture">Schema System Architecture</a></h2>
<h3 id="schemaregistry"><a class="header" href="#schemaregistry">SchemaRegistry</a></h3>
<p>Central registry for SCIM schemas:</p>
<ul>
<li>Loads and validates RFC 7643 core schemas</li>
<li>Supports custom schema extensions</li>
<li>Provides validation services for all operations</li>
</ul>
<h3 id="dynamic-value-objects"><a class="header" href="#dynamic-value-objects">Dynamic Value Objects</a></h3>
<ul>
<li>Runtime creation from schema definitions</li>
<li>Type-safe attribute handling</li>
<li>Extensible factory pattern for custom types</li>
</ul>
<h3 id="extension-model"><a class="header" href="#extension-model">Extension Model</a></h3>
<ul>
<li>Custom resource types beyond User/Group</li>
<li>Organization-specific attributes</li>
<li>Maintains SCIM compliance and interoperability</li>
</ul>
<h2 id="concurrency-control"><a class="header" href="#concurrency-control">Concurrency Control</a></h2>
<h3 id="etag-based-versioning"><a class="header" href="#etag-based-versioning">ETag-Based Versioning</a></h3>
<p>Built into the core architecture:</p>
<ul>
<li>Automatic version generation from resource content</li>
<li>Conditional operations (If-Match, If-None-Match)</li>
<li>Conflict detection and resolution</li>
<li>Production-ready optimistic locking</li>
</ul>
<h3 id="version-aware-operations"><a class="header" href="#version-aware-operations">Version-Aware Operations</a></h3>
<p>All resource operations support conditional execution:</p>
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
</span><span class="boring">fn main() {
</span>// Conditional update with version check
let result = provider.conditional_update(
"User",
&user_id,
updated_data,
&expected_version,
&context
).await?;
match result {
ConditionalResult::Success(resource) => // Update succeeded
ConditionalResult::PreconditionFailed => // Version conflict
}
<span class="boring">}</span></code></pre></pre>
<h2 id="integration-patterns"><a class="header" href="#integration-patterns">Integration Patterns</a></h2>
<h3 id="web-framework-integration"><a class="header" href="#web-framework-integration">Web Framework Integration</a></h3>
<p>Components work with any HTTP framework:</p>
<ol>
<li>Extract SCIM request details</li>
<li>Create <code>RequestContext</code> with tenant info</li>
<li>Call appropriate <code>ScimServer</code> operations</li>
<li>Format responses per SCIM specification</li>
</ol>
<h3 id="ai-agent-integration"><a class="header" href="#ai-agent-integration">AI Agent Integration</a></h3>
<p>Model Context Protocol (MCP) components:</p>
<ol>
<li>Expose SCIM operations as discoverable tools</li>
<li>Structured schemas for AI understanding</li>
<li>Error handling designed for AI decision making</li>
<li>Multi-tenant aware tool descriptions</li>
</ol>
<h3 id="custom-client-integration"><a class="header" href="#custom-client-integration">Custom Client Integration</a></h3>
<p>Direct component usage:</p>
<ol>
<li>Implement <code>ResourceProvider</code> for your data model</li>
<li>Choose appropriate <code>StorageProvider</code></li>
<li>Configure schema extensions as needed</li>
<li>Build custom API layer or integration logic</li>
</ol>
<h2 id="performance-considerations"><a class="header" href="#performance-considerations">Performance Considerations</a></h2>
<h3 id="async-first-design"><a class="header" href="#async-first-design">Async-First Design</a></h3>
<ul>
<li>All I/O operations are async</li>
<li>Non-blocking concurrent operations</li>
<li>Efficient resource utilization</li>
</ul>
<h3 id="minimal-allocations"><a class="header" href="#minimal-allocations">Minimal Allocations</a></h3>
<ul>
<li>Zero-copy JSON processing where possible</li>
<li>Efficient value object system</li>
<li>Smart caching in schema registry</li>
</ul>
<h3 id="scalability-features"><a class="header" href="#scalability-features">Scalability Features</a></h3>
<ul>
<li>Pluggable storage for horizontal scaling</li>
<li>Multi-tenant isolation for SaaS platforms</li>
<li>Connection pooling support through storage traits</li>
</ul>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<a rel="prev" href="getting-started/mcp-server.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="concepts/schemas.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
<div style="clear: both"></div>
</nav>
</div>
</div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="getting-started/mcp-server.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="concepts/schemas.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
</div>
<script>
window.playground_copyable = true;
</script>
<script src="elasticlunr.min.js"></script>
<script src="mark.min.js"></script>
<script src="searcher.js"></script>
<script src="clipboard.min.js"></script>
<script src="highlight.js"></script>
<script src="book.js"></script>
</div>
</body>
</html>
