OAuth2-Client (join-oauth2-client)

Beachten Sie auch die Anwenderdokumentation unter https://konmedia.atlassian.net/wiki/x/TgBICg

Die App join-oauth2-client bietet zum einem die Möglichkeit beliebig viele OAuth2-Clients anzulegen und zu verwalten und zum anderen wird eine Integration in die SMTP-Server von brandbox bereitgestellt.

Abrufen eines Zugriffsschlüssels

use Brandbox\JoinOauth2Client\Join\Oauth2Client; $token = $this ->staticController(Oauth2Client\Manager::class) ->getAccessToken('[ID des OAuth2-Clients]') ;

Sollte der Zugriffsschlüssel abgelaufen sein, wird eine Aktualisierung mithilfe des Aktualisierungsschlüssels durchgeführt.

Parameter für Anfragen

Über die Parameterkonfiguration bei den einzelnen OAuth2-Clients können zusätzliche Parameter für die einzelnen Anfragen der OAuth2-Schnittstelle definiert werden. Die nachfolgenden Bereich stehen zur Verfügung und müssen, falls definiert, ebenfalls ein gültiges JSON-Objekt mit den zusätzlichen Parametern sein.

Name

Beschreibung

Name

Beschreibung

code

Diese Parameter werden bei der Autorisierung am OAuth2-Anbieter mitgesendet. Sie werden der Autorisierungs-URL hinzugefügt.

authorization_code

Diese Parameter werden beim Eintauschen des Autorisierungscodes gegen einen Zugriffsschlüssel mitgegeben.

refresh_token

Diese Parameter werden beim Aktualisieren des Zugriffsschlüssels mitgesendet.

provider

Diese Parameter werden als Optionen an den OAuth2-Client-Provider weitergegeben und sind somit in allen vorherigen Anfragen enthalten.

Beispiel

Das nachfolgende Beispiel zeigt eine Parameterkonfiguration eines OAuth2-Clients, welcher bei der Autorisierung den zusätzlichen Parameter access_type benötigt.

{ "code": { "access_type": "offline" } }