openapi: 3.1.0 info: title: Mijn Multi-Tenant API description: > Deze API ondersteunt multi-tenancy en beschrijft hoe tenants worden geïdentificeerd, geïsoleerde resources worden beheerd, toegangscontrole wordt toegepast en authenticatie plaatsvindt. version: 1.0.0 servers: - url: https://api.mijnmultitenant.com description: Productie server components: securitySchemes: OAuth2Security: type: securityScheme scheme: oauth2 flows: authorizationCode: authorizationUrl: https://auth.mijnmultitenant.com/oauth/authorize tokenUrl: https://auth.mijnmultitenant.com/oauth/token scopes: read: Toegang tot lezen write: Toegang tot schrijven parameters: TenantIdentifier: name: X-Tenant-ID in: header description: > Identificeert de tenant. Kan worden gebruikt als een aanvraagheader. required: true schema: type: string SubdomeinTenant: name: tenant in: path description: > Het subdomein dat de tenant identificeert, bijvoorbeeld tenant1.mijnmultitenant.com. required: true schema: type: string paths: /resources: get: summary: Haal resources op voor een tenant description: > Deze endpoint retourneert resources die specifiek zijn voor de geïdentificeerde tenant. security: - OAuth2Security: [read] parameters: - $ref: '#/components/parameters/TenantIdentifier' responses: '200': description: Een lijst van resources content: application/json: schema: type: array items: type: object properties: resourceId: type: string resourceName: type: string /resources/{resourceId}: get: summary: Haal een specifiek resource op description: > Deze endpoint retourneert details van een specifiek resource binnen de tenant. security: - OAuth2Security: [read] parameters: - $ref: '#/components/parameters/TenantIdentifier' - name: resourceId in: path required: true description: Het ID van het resource schema: type: string responses: '200': description: Resource details content: application/json: schema: type: object properties: resourceId: type: string resourceName: type: string details: type: string # Multi-tenancy strategieën en toegangscontrole x-multi-tenancy: tenant-identificatie: methoden: - subdomein: beschrijving: > Identificatie via subdomein, bijvoorbeeld tenant1.mijnmultitenant.com. - aanvraagkop: beschrijving: > Identificatie via een aanvraagheader, bijvoorbeeld X-Tenant-ID. resource-isolatie: strategieën: - database-schema's: beschrijving: > Elke tenant heeft een eigen database schema. - gedeelde-resources: beschrijving: > Resources worden gedeeld, maar met tenant-specifieke isolatie via identificatie. toegangscontrole: methoden: - rolgebaseerde-toegang: beschrijving: > Toegang wordt verleend op basis van rollen en permissies. - permissies: beschrijving: > Fine-grained permissies bepalen toegangsrechten tot resources. authenticatie: methode: OAuth2 beschrijving: > OAuth2 wordt gebruikt voor authenticatie en autorisatie, met scopes voor lezen en schrijven. --- Dit is een basis OpenAPI-specificatie die de multi-tenancy aspecten beschrijft. Je kunt deze verder uitbreiden met aanvullende endpoints en specificaties afhankelijk van je API-behoeften.

Zeker, hier is een OpenAPI-specificatie (3.0.0) voor jouw multi-tenant API: ```yaml openapi: 3.0.0 info: title: Mijn Multi-Tenant API description: API voor het beheren van multi-tenancy met resource isolatie en toegangscontrole version: 1.0.0 contact: name: API Support email: support@voorbeeld.nl servers: - url: https://{tenant}.api.voorbeeld.nl description: Tenant-specifiek subdomein variables: tenant: default: demo description: Tenant identifier via subdomein - url: https://api.voorbeeld.nl description: Hoofd domein (tenant via header) paths: /gebruikers: get: summary: Lijst van gebruikers ophalen description: Haalt gebruikers op voor de huidige tenant security: - oauth2: [gebruikers.lezen] parameters: - name: X-Tenant-ID in: header required: true schema: type: string description: Tenant identificatie via header (alternatief voor subdomein) responses: '200': description: Succesvolle response content: application/json: schema: type: array items: $ref: '#/components/schemas/Gebruiker' '403': $ref: '#/components/responses/ToegangGeweigerd' /resources: post: summary: Nieuwe resource aanmaken description: Maakt een nieuwe resource aan voor de huidige tenant security: - oauth2: [resources.schrijven] parameters: - name: X-Tenant-ID in: header required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Resource' responses: '201': description: Resource succesvol aangemaakt '403': $ref: '#/components/responses/ToegangGeweigerd' components: schemas: Gebruiker: type: object properties: id: type: string naam: type: string email: type: string tenantId: type: string rollen: type: array items: type: string Resource: type: object properties: id: type: string naam: type: string type: type: string tenantId: type: string responses: ToegangGeweigerd: description: Toegang geweigerd voor de opgegeven tenant content: application/json: schema: type: object properties: error: type: string message: type: string securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://auth.voorbeeld.nl/authorize tokenUrl: https://auth.voorbeeld.nl/token scopes: gebruikers.lezen: Toegang tot gebruikersgegevens lezen gebruikers.schrijven: Toegang tot gebruikersgegevens schrijven resources.lezen: Toegang tot resources lezen resources.schrijven: Toegang tot resources schrijven parameters: TenantHeader: name: X-Tenant-ID in: header required: true schema: type: string description: Unieke tenant identifier x-multi-tenancy: tenantIdentificatie: methoden: - subdomein: "Tenant wordt geïdentificeerd via subdomein (bijv. tenant1.api.voorbeeld.nl)" - header: "Tenant wordt geïdentificeerd via X-Tenant-ID header" resourceIsolatie: strategieën: - databaseSchemas: "Elke tenant heeft een eigen database schema" - sharedDatabase: "Gedeelde database met tenant_id in alle tabellen" - fysiekeScheiding: "Volledig gescheiden databases per tenant" toegangscontrole: mechanismen: - rolgebaseerd: rollen: ["admin", "gebruiker", "beheerder"] permissies: ["lezen", "schrijven", "verwijderen"] - tenantBeperking: "Gebruikers hebben alleen toegang tot hun eigen tenant resources" authenticatie: methode: "OAuth2" details: "JWT tokens met tenant claims en gebruikersrollen" ``` **Belangrijke kenmerken van deze specificatie:** 1. **Tenant Identificatie:** - Subdomein routing (`{tenant}.api.voorbeeld.nl`) - X-Tenant-ID header voor alternatieve identificatie 2. **Resource Isolatie:** - Database schema's per tenant - Tenant-ID in alle resource modellen - Gedeelde of gescheiden database strategieën 3. **Toegangscontrole:** - Rolgebaseerde toegang met OAuth2 scopes - Tenant-beperkte resource toegang - Gedetailleerde permissies per rol 4. **Authenticatie:** - OAuth2 Authorization Code flow - JWT tokens met tenant claims - Scope-based autorisatie Deze specificatie biedt een solide basis voor een veilige en goed geïsoleerde multi-tenant API.