OAuth2 Service

OAuth2 kann bereits in der Basic Lizenz verwendet werden.

Der DocCheck Login Service bietet OAuth2 Support. Dieser basiert auf dem Authorization Code Flow (opens new window). Dieser Flow beinhaltet, dass nach erfolgreicher Authentifizierung des Users auf der DocCheck Seite ein Authorization Code an die Callback-URL übermittelt wird. Dieser Code-Parameter kann genutzt werden, um einen Access Token zu erhalten.

Inhalte in diesem Bereich

Bereich	Inhalt
Endpunkte	Technische Referenz für Authorization, Access Token, Userdaten, Refresh Token und Fehlercodes.
PKCE	Wichtige Hinweise zur Verwendung von Proof Key for Code Exchange im Authorization Code Flow.
Tools & Beispiele	Ressourcen für Implementierung und Tests, z. B. Postman Guide, PHP Provider, React Native und Demo Projekt.

Authentifizierung (Access Token Endpunkt) ⓘEconomy

Im grundlegenden Szenario wird der OAuth2 Service für die Authentifizierung genutzt, ohne zusätzliche persönliche Daten freizugeben.

• Nach dem erfolgreichen Login über diesen Client wird ein Authorization Code – code – an die Ziel-URL angehängt
• Die Parameter  client_id (= Login Client ID), code und client_secret können dann gegen einen Access Token eingetauscht werden
• Wichtig: Beim Token‑Request muss grant_type=authorization_code gesetzt werden. Details und Beispiele: Access Token Endpunkt
• Sobald der Access Token Endpunkt erfolgreich antwortet, bedeutet dies, dass der Authorization Code und die übrigen Parameter valide sind und der User sich somit erfolgreich bei DocCheck authentifiziert hat

Anfragen persönlicher Daten (Userdaten Endpunkt) ⓘab Economy

Die volle OAuth2 Implementierung beinhaltet den Userdaten Endpunkt und erfordert eine Economy Lizenz. Der Userdaten Endpunkt managed die Zugriffsberechtigungen zu den persönlichen Daten.

• Sobald ein Access Token abgerufen wurde, kann dieser an den Userdaten Endpunkt übermittelt werden
• Sofern die erforderliche Lizenz dem Login Client zugewiesen ist und der User seine Zustimmung erteilt hat, antwortet der Userdaten Endpunkt mit dem freigegebenen Datenset im JSON-Format
• Der Umfang der freizugebenen Daten – scope – wird über den Login-Button festgelegt
• Rückgabewerte des Userdaten Endpunkts: Übersicht

---

Tools & Beispiele

Tool / Beispiel	Beschreibung
Demo Projekt	Live-Beispiel, mit dem Sie den OAuth2-Flow in einer Demo-Umgebung ausprobieren können.
Postman Collection	Unterstützt beim Testen des Authorization Code Flows, beim Token-Tausch und beim Abruf von Userdaten über vorbereitete Requests.
PHP Provider	Offizieller OAuth2 Provider für PHP-Anwendungen inklusive Composer-Paket und Beispielcode.
React Native	Beispiel für die Integration des DocCheck Logins in mobile Apps unter iOS und Android.