updates

arietimmerman · arietimmerman · commit 3879d5f3b086 · 2025-03-24T22:30:55.000+01:00
diff --git a/site/docs/.vitepress/config.ts b/site/docs/.vitepress/config.ts
@@ -8,7 +8,7 @@ export default defineConfig({
     },
     title: 'SCIM Verify',
     titleTemplate: 'verify.scim.dev',
-    description: "Verify if your SCIM server meets the SCIM specification: a free CLI tool to verify SCIM server compliance",
+    description: "SCIM Verify is a conformance testing tool to verify your SCIM 2.0 implementation complies with the specifications.",
     head: [
         [
             'meta',
@@ -30,10 +30,11 @@ export default defineConfig({
     },
     themeConfig: {
         footer: {
-            copyright: 'Copyright © 2023-present <a href="https://www.limosa.io">Limosa Digital Identity Solutions</a>'
+            copyright: 'Copyright © 2025-present <a href="https://www.a11n.nl/">a11n</a>'
         },
         nav: [
-            { text: 'Home', link: '/' },
+            { text: 'About', link: '/about/' },
+            { text: 'Documentation', link: '/docs/' },
             { text: 'SCIM Playground', link: 'https://scim.dev', target: '_blank', rel: 'noopener' }
         ],
     },
diff --git a/site/docs/about/index.md b/site/docs/about/index.md
@@ -0,0 +1,20 @@
+# About SCIM Verify
+
+## What is <span class="font-scim">SCIM</span> Verify?
+
+SCIM Verify is a testing tool designed to help developers validate their SCIM (System for Cross-domain Identity Management) API implementations. It allows you to test your live SCIM API against the SCIM specifications to ensure compatibility and proper functionality.
+
+SCIM Verify is created by the ones behind [SCIM Playground](https://scim.dev).
+
+## Why use <span class="font-scim">SCIM</span> Verify?
+
+When implementing a SCIM service provider, it's crucial to validate that your API adheres to the SCIM protocol specifications. SCIM Verify provides a straightforward way to:
+
+- Test your SCIM endpoints
+- Verify protocol compliance 
+- Ensure proper handling of SCIM operations
+- Identify potential issues before deployment
+
+## How it works
+
+Simply connect SCIM Verify to your running SCIM API by providing your endpoint URL and authentication credentials. The tool will execute a series of tests against your API and provide detailed feedback on compliance and functionality.
diff --git a/site/docs/docs/index.md b/site/docs/docs/index.md
@@ -0,0 +1,351 @@
+# Documentation
+
+SCIM Verify is a highly configurable testing framework for SCIM APIs. While it works out-of-the-box with sensible defaults, you can customize its behavior extensively through a YAML configuration file to match your specific implementation requirements. This documentation explains all available configuration options.
+
+## Global Configuration
+
+The global configuration settings control the overall behavior of the testing framework.
+
+```yaml
+detectSchema: true           # Enables automatic schema detection from responses
+detectResourceTypes: true    # Enables automatic resource type detection
+```
+
+## User Operations
+
+Configuration for testing the Users endpoint in a SCIM API.
+
+```yaml
+users:
+  enabled: true              # Enable testing of user operations
+  operations:                # HTTP methods to test
+    - GET
+    - POST
+    - PUT
+    - PATCH
+    - DELETE
+  sortAttributes:            # Attributes to sort by when retrieving users
+    - userName
+```
+
+### Filter Tests
+
+Tests for filtering users using SCIM filter expressions.
+
+```yaml
+  filter_tests:
+    - filter: userName eq "bjensen"    # Filter expression to test
+      user_schema:                     # Schema to validate response against
+        type: object
+        properties:
+          schemas:
+            type: array
+            items:
+              type: string
+            contains:
+              const: urn:ietf:params:scim:schemas:core:2.0:User
+          userName:
+            type: string
+            const: bjensen
+        required:
+          - userName
+          - schemas
+        additionalProperties: true
+```
+
+### POST Tests
+
+Tests for creating users via POST requests.
+
+```yaml
+  post_tests:
+    - request:                         # Request payload
+        schemas:
+          - urn:ietf:params:scim:schemas:core:2.0:User
+        userName: barbara jensen
+        emails:
+          - value: barbara.jensen@example.com
+      response:                        # Expected response schema
+        type: object
+        properties:
+          schemas:
+            type: array
+            items:
+              type: string
+            contains:
+              const: urn:ietf:params:scim:schemas:core:2.0:User
+          userName:
+            type: string
+            const: barbara jensen
+        required:
+          - userName
+          - schemas
+        additionalProperties: true
+    - request:                         # Another test case
+        schemas:
+          - urn:ietf:params:scim:schemas:core:2.0:User
+        userName: testuser6238
+        emails:
+          - value: barbara.jensen@example.com
+      response:
+        type: object
+        properties:
+          schemas:
+            type: array
+            items:
+              type: string
+            contains:
+              const: urn:ietf:params:scim:schemas:core:2.0:User
+          userName:
+            type: string
+            const: testuser6238
+          emails:
+            type: array
+            items:
+              type: object
+              properties:
+                value:
+                  type: string
+                  const: barbara.jensen@example.com
+        required:
+          - userName
+          - schemas
+          - emails
+        additionalProperties: true
+```
+
+### PUT Tests
+
+Tests for updating users via PUT requests.
+
+```yaml
+  put_tests:
+    - id: AUTO                         # AUTO indicates ID will be determined at runtime
+      request:
+        schemas:
+          - urn:ietf:params:scim:schemas:core:2.0:User
+        userName: testuser6238
+        emails:
+          - value: barbara.jensen@example.com
+      response:
+        type: object
+        properties:
+          schemas:
+            type: array
+            items:
+              type: string
+            contains:
+              const: urn:ietf:params:scim:schemas:core:2.0:User
+          userName:
+            type: string
+            const: testuser6238
+          emails:
+            type: array
+            items:
+              type: object
+              properties:
+                value:
+                  type: string
+                  const: barbara.jensen@example.com
+        required:
+          - userName
+          - schemas
+          - emails
+        additionalProperties: true
+```
+
+### PATCH Tests
+
+Tests for partial updates via PATCH requests.
+
+```yaml
+  patch_tests:
+    - id: AUTO
+      request:
+        schemas:
+          - urn:ietf:params:scim:api:messages:2.0:PatchOp
+        Operations:
+          - op: replace
+            path: userName
+            value: JohnDoe
+      response:
+        type: object
+        properties:
+          schemas:
+            type: array
+            items:
+              type: string
+            contains:
+              const: urn:ietf:params:scim:schemas:core:2.0:User
+          userName:
+            type: string
+            const: JohnDoe
+        required:
+          - userName
+          - schemas
+        additionalProperties: true
+```
+
+### DELETE Tests
+
+Tests for deleting users.
+
+```yaml
+  delete_tests:
+    - id: AUTO                         # AUTO indicates ID will be determined at runtime
+```
+
+## Group Operations
+
+Configuration for testing the Groups endpoint in a SCIM API.
+
+```yaml
+groups:
+  enabled: true                        # Enable testing of group operations
+  operations:                          # HTTP methods to test
+    - GET
+    - POST
+    - PUT
+    - PATCH
+    - DELETE
+  sortAttributes:                      # Attributes to sort by when retrieving groups
+    - displayName
+```
+
+### Group POST Tests
+
+Tests for creating groups via POST requests.
+
+```yaml
+  post_tests:
+    - request:
+        schemas:
+          - urn:ietf:params:scim:schemas:core:2.0:Group
+        displayName: TestGroup
+      response:
+        type: object
+        properties:
+          schemas:
+            type: array
+            items:
+              type: string
+            contains:
+              const: urn:ietf:params:scim:schemas:core:2.0:Group
+          displayName:
+            type: string
+            const: TestGroup
+        required:
+          - displayName
+          - schemas
+        additionalProperties: true
+    - request:                         # Group with members
+        schemas:
+          - urn:ietf:params:scim:schemas:core:2.0:Group
+        displayName: Engineering
+        members:
+          - value: AUTO                # Member ID will be determined at runtime
+      response:
+        type: object
+        properties:
+          schemas:
+            type: array
+            items:
+              type: string
+            contains:
+              const: urn:ietf:params:scim:schemas:core:2.0:Group
+          displayName:
+            type: string
+            const: Engineering
+          members:
+            type: array
+            items:
+              type: object
+              properties:
+                value:
+                  type: string
+        required:
+          - displayName
+          - schemas
+          - members
+        additionalProperties: true
+```
+
+### Group PUT Tests
+
+Tests for updating groups via PUT requests.
+
+```yaml
+  put_tests:
+    - id: AUTO
+      request:
+        schemas:
+          - urn:ietf:params:scim:schemas:core:2.0:Group
+        displayName: UpdatedGroup
+        members:
+          - value: AUTO
+      response:
+        type: object
+        properties:
+          schemas:
+            type: array
+            items:
+              type: string
+            contains:
+              const: urn:ietf:params:scim:schemas:core:2.0:Group
+          displayName:
+            type: string
+            const: UpdatedGroup
+          members:
+            type: array
+            items:
+              type: object
+              properties:
+                value:
+                  type: string
+        required:
+          - displayName
+          - schemas
+          - members
+        additionalProperties: true
+```
+
+### Group PATCH Tests
+
+Tests for partial updates to groups via PATCH requests.
+
+```yaml
+  patch_tests:
+    - id: AUTO
+      request:
+        schemas:
+          - urn:ietf:params:scim:api:messages:2.0:PatchOp
+        Operations:
+          - op: replace
+            path: displayName
+            value: NewGroupName
+      response:
+        type: object
+        properties:
+          schemas:
+            type: array
+            items:
+              type: string
+            contains:
+              const: urn:ietf:params:scim:schemas:core:2.0:Group
+          displayName:
+            type: string
+            const: NewGroupName
+        required:
+          - displayName
+          - schemas
+        additionalProperties: true
+```
+
+### Group DELETE Tests
+
+Tests for deleting groups.
+
+```yaml
+  delete_tests:
+    - id: AUTO                         # AUTO indicates ID will be determined at runtime
+
