API Session Login über temporäres Token

Ein Administrator kann für bestimmte Benutzer temporäre Login-Tokens vergeben, sodass diese sich über die API authentifizieren können, ohne Benutzername und Passwort angeben zu müssen.

Dazu muss ein Administrator vorab ein Token erstellen.

Ein Token erstellen

---

HTTP-Method
POST

URL
/api/rest/session/token

Parameter
doAs=Username

• Geben Sie im Parameter doAs einen Benutzernamen mit, der bei Nutzung des Tokens hinterlegt sein soll.
• Der Benutzer muss in agorum core vorhanden und entsprechend den Anforderungen berechtigt sein, abhängig davon, was mit dieser Session alles möglich sein soll.

Beispielaufruf

POST: https://ihr-agorum-core-server/api/rst/session/token?doAs=demo

Rückgabe

{
  "success": true,
  "errorClass": 0,
  "errorCode": 0,
  "errorKey": 0,
  "message": "",
  "token": "uqoffph17m0e42d4d76m00pgqf"
}

• Verwenden Sie den Token für weitere Services.

Die Gültigkeit des Tokens verändern

---

Sie können die Anzahl der Tage eines Tokens ändern oder die Anzahl der Aufrufe eines Tokens limitieren.

• Das Token hat im Standard eine Gültigkeit von einem Tag und lässt eine beliebige Zahl von Aufrufen zu.
• Diese Einstellung gilt global.

So ändern Sie die Gültigkeit des Tokens:

1. Öffnen Sie links in der Seitenleiste Administration und dann MetaDB.
2. Öffnen Sie den Pfad:

   MAIN_MODULE_MANAGEMENT/api/control/Services/Session/token/

3. Doppelklicken Sie auf das Property-Entry ExpirationOffset, um den Wert in Tagen anzupassen.
   
   • Ein Wert von -1 deaktiviert das Ablaufen.
   • Das Property-Entry NumberOfReuse definiert wie oft das Token verwendet werden darf.