PhoenixII (PII) verwendet OAuth 2.0, um Webanwendungen und Web-APIs den Zugriff auf Daten in Ihrem PII-Mandanten zu erhalten. Der OAuth 2.0-Autorisierungscodefluss wird in Abschnitt 4.1 der OAuth 2.0-Spezifikationbeschrieben. Er wird zur Authentifizierung und Autorisierung verwendet.
...
Wenn Sie einen Autorisierungscode erworben und die Berechtigung vom Benutzer erhalten haben, können Sie den Code für ein Zugriffstoken auf PhoenixII einlösen, indem Sie eine POST-Anforderung an den oauth2/access_token -Endpunkt senden:
| Code Block | ||
|---|---|---|
| ||
POST https://{mandant}.it4sport.de/oauth2/access_token?
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIU...
Content-Type: application/json
grant_type=authorization_code
&client_id=cc69ef07-6b5b-43c6-bf5d-35a290d198e4
&code=OTg2OTQxODRhOTEzNTQ2ZDRmMTMyODc4MzhhNjMxNzI0NjMxNTk0OGZlMDIyZTVkYjAwZmIwZTAxZDM3ZWJlMw
&redirect_uri=https://myapp.de/login
&client_secret=zR6cebHdJFTZ6yI+jsAErcNxIOvMUpgLrTZc4AYL9UQ= |
...
| Parameter | Beschreibung |
|---|---|
| token_type | Gibt den Wert des Tokentyps an. Bearertoken ist der einzige Typ, den PhoenixII unterstützt. Weitere Informationen zu Bearertoken finden Sie unter OAuth 2.0-Autorisierungsframework: Verwendung von Bearertoken (RFC 6750). |
| expires_in | Gibt den Zeitstempel an, wie lange das Zugriffstoken gültig ist. |
| access_token | Das angeforderte Zugriffstoken als signiertes JSON-Webtoken (JWT). Die App kann dieses Token zur Authentifizierung auf geschützten Anforderungen verwenden. |
| refresh_token | Ein Aktualisierungstoken von OAuth2. Die App kann dieses Token verwenden, um nach Ablauf der aktuellen Zugriffstoken zusätzliche Zugriffstoken zu erhalten. Aktualisierungstoken sind langlebig und können verwendet werden, um den Zugriff auf Anfragen für längere Zeit beizubehalten. |
| data | Unter Data werden alle nötigen Daten, die in Ihrer Anwendung definiert wurden zurückgeliefert. |
| data.id | Das ist die eindeutige ID des Benutzers in PhoenixII. |
| data.user | Enthält weitere Daten zu dem angefragten Benutzer. |
| data.organisation | Enthält Daten zu Ihrem Verband. |
| data.licenses | Enthält eine Liste von allen Lizenzen die Sie abfragen wollen. |
| data.functions | Enthält eine Liste von allen Funktionen die Sie abfragen wollen. |
OAuth2 Zugriff zulassen
Der Endbenutzer erhält folgende Ansicht, wenn der Zugriff auf die Daten von PhoenixII angefragt werden.
Abbruch des OAuth2 Zugriffs - Fehler Codes
Der Benutzer kann auf der Zugriffsseite auch auswählen, dass er den Zugriff verweigert oder diese Anfrage abbrechen. In diesen Fällen wird der Benutzer auf die hinterlegte redirect_uri weitergeleitet mit folgenden Parametern:
| Parameter | Wert | Beschreibung |
|---|---|---|
| error | access_denied | Gibt die Art des Fehlers an. |
| error_code | 200 | Der Fehler Code. |
| error_description | Permission error | Die Beschreibung des Fehlers. |
| error_reason | user_denied | Der Grund für den Fehler. |
Aktuell wird der Fehler-Response nur für verwendet, wenn ein Benutzer den Zugriff verweigert. Ggf. können später weitere Fehler hinzugefügt werden. Diese werden hier dann entsprechend aufgelistet.
OAuth2 Zugriff zulassen
Der Endbenutzer erhält folgende Ansicht, wenn der Zugriff auf die Daten von PhoenixII angefragt werden.
Alle Fehlermeldungen:
| error | error_code | error_description | error_reason |
|---|---|---|---|
| access_denied | 200 | Permission error | user_denied |
| invalid_request | 400 | Invalid request. Field `code` is missing. | invalid_request |
Bibliotheken die PhoenixII OAuth2 unterstützen
...