Gruppe	Basic Functions

Diese Funktion ist veraltet (deprecated).

Holt mit einem Refresh-Token einen neuen OAuth2 Access Token (und auch einen neuen Refresh Token) und aktualisiert beide im angegebenen HTTP-Kanal. Gibt true bei Erfolg, ansonsten false zurück (es wird aber keine Exception ausgelöst). Die Funktion kann nur erfolgreich ausgeführt werden, wenn der Kanal bereits einen OAuth2 Access Token abgerufen hat. In diesem Fall sehen Sie ganz unten im Kanal auch die Ablaufzeit dieses Tokens angezeigt. Nur wenn die Ablaufzeit erreicht wurde (bzw. 20 Sekunden davor), wird die Funktion hier ausgeführt. Wurde die Funktion erfolgreich durchgeführt, wird auch die Ablaufzeit im Kanal aktualisiert.

Hinweis: In den Zusatzkennungen des Kanals ist der Access Token unter dem Namen SYS_HTTP_OAUTH2 eingetragen und der Refresh Token unter dem Namen SYS_HTTP_OAUTH2_REFRESH.

Hinweis: In der URL können optional die Parameter mitgegeben werden. Fehlen diese, wird der Standard für OAuth2 verwendet. Es können auch Platzhalter verwendet werden. Diese werden dann mit den entsprechenden Werten aus den Funktionsparametern gefüllt oder mit den entsprechenden Werten aus der OAuth2-Konfiguration im Kanal. Siehe das Beispiel in Spalte 3 unten. Zu den im Beispiel gezeigten Platzhaltern kann auch noch der Platzhalter <server> verwendet werden. Dieser wird gefüllt mit dem Inhalt des Feldes "Partner-Adresse" im Kanal. Steht dort z. B. der Wert https://example.com, dann wird <server> ersetzt durch example.com.

Parameterbeschreibung

Parameter	Beschreibung
a	URL-Endpunkt für die Refresh-Operation. Ist keine URL angegeben, dann wird die OAuth2 Refresh URL aus dem Kanal verwendet. Hinweis: Sie können den Zusatz &useCredentialsInHeader angeben, damit die Credentials (C lient-ID und C lient-Secret ) im Header statt im Body angegeben werden.
b	true, um den HTTP-Request über den DMZ-Server zu senden (falls vorhanden).
c	HTTP-Kanal-ID.
d	Client-ID oder leer, falls diese im Kanal hinterlegt ist.
e	Client-Secret oder leer, falls dieses im Kanal hinterlegt ist.
f	Refresh-Token oder leer, falls dieser im Kanal hinterlegt ist.
g	Content-Type bei POST. Default: application/x-www-form-urlencoded
h	true, um HTTP-Methode GET statt POST zu verwenden. Default: false
i	(optional) Der Scope.

Beispiel

Parameter a	https://example.com/oauth/token	https://example.com/oauth/token	https://example.com/oauth/token?grant_type=refresh_token&client_id=<clientId>&client_secret=<clientSecret>&refresh_token=<refreshToken>
Parameter b	false	false	false
Parameter c	12345678900	0	12345678900
Parameter d			myClientIDToUse
Parameter e			mySecretToUse
Parameter f			myRefreshToken
Parameter g			text/html
Parameter h	true
Parameter i
Ergebnis	true	false	true
Bemerkung	Kanal wurde aktualisiert.	Ungültige Kanal-ID.	Die Platzhalter <...> wurden durch die Werte aus den entsprechenden Funktionsparametern ersetzt und der Kanal wurde aktualisiert.