VDX Management API — Oversigt¶

VDX Management API er et eksternt machine-to-machine (M2M) REST API til administration af organisationer, grupper, brugere og autorisationer i VDX-platformen.

API'et anvender OAuth2 Client Credentials via Keycloak og leverer JWT Bearer-beskyttet adgang til alle ressource-endpoints.

Målgruppe

Denne dokumentation henvender sig til eksterne udviklere og systemintegratorer, som skal automatisere organisationsadministration mod VDX-platformen uden adgang til VDX-kodebasen.

Arkitektur — overblik¶

flowchart LR
    subgraph client [Integrationsklient]
        Service[Backend-service]
    end
    Keycloak[VDX Keycloak]
    API[VDX Management API]
    VDX[(VDX Platform)]

    Service -->|"client_credentials grant"| Keycloak
    Keycloak -->|access_token JWT| Service
    Service -->|"REST kald (Bearer token)"| API
    API -->|CRUD operationer| VDX
    API -->|JSON response| Service

Funktionsområder¶

Område	Beskrivelse
Grupper	Opret, opdater, slet og navigér i gruppehierarkiet
Lokale brugere	CRUD, flytning og password-håndtering for lokale konti
Eksterne brugere	Læs, flyt og slet eksternt provisionerede brugere
Autorisationer	Administrer rollebaserede autorisationer på gruppeniveau
Organisation	Læs og opdater organisationsstamdata

Indholdsfortegnelse¶

Guides¶

Side	Beskrivelse
Integrationsguide	Kom i gang, autentificering, scope-model og best practices
Kodeeksempler	curl, Python og C# — alle operationer
Support	Kontakt og fejlrapportering

API-reference¶

Sektion	Beskrivelse
Endpoints	Base URLs, headers og alle 24 endpoints med eksempler
Modeller	Request/response-modeller (DTO'er) med feltbeskrivelser
Reference	Fejlkoder, HTTP-statuskoder, ProblemDetails og rate limiting

Anbefalet læserækkefølge¶

Integrationsguide — start med Kom i gang og Scope-model
Endpoints — oversigt over alle operationer
Modeller — request/response-strukturer
Kodeeksempler — curl, Python og C# side om side
Reference — fejlhåndtering og rate limiting