Login & Logout

Login

Mittels eines Requests auf diese Ressource kann der Aufrufer versuchen, sich mit den Zugangsdaten eines persönlichen Benutzerkontos in den angegebenen Prozessplattform-Mandanten einzuloggen.

Request 

POST https://www{hostid}.prozessplattform.de/{tenant}/rest/userSession

Request-Parameter

Parameter-TypNameBedeutung
Pathhost_idHost-ID innerhalb des Hosting-Clusters, auf dem der Mandant betrieben wird (z.B. "88")
PathtenantName des Mandanten (z.B. "musterhausen")
FormusernameBenutzername
FormpasswordPasswort des o.g. Benutzerkontos

Encoding für Request-Body: "Content-Type: application/x-www-form-urlencoded; charset=UTF-8")

Reponse

  • Header:
    • HTTP-Status-Code 200 ("ok")
    • Cookie "JSESSIONID"

Hinweise

  • Im Erfolgsfall werden nachfolgende Requests, die vom HTTP-Client der gleichen HTTP-Session zugeordnet werden (durch Übermittlung des erzeugten Session-Cookies im Header der folgenden HTTP-Requests), in der Prozessplattform im Kontext des eingeloggten Nutzers ausgeführt.
  • HTTP-Sessions werden vom Server nach 20 Minuten Inaktivität automatisch beendet.
  • Werden die Zugangsdaten von einer anderen offenen HTTP-Session verwendet, ist bis zu deren Login (bzw. Ablauf wegen Inaktivität) kein paralleler Login möglich.
  • Der Zugriff auf das Benutzerkonto kann in der Benutzerverwaltung optional per Whitelist auf bestimmte IP-Adressbereiche beschränkt werden. Falls ein programmatischer Login wider Erwarten auf Grund einer IP-Adressbeschränkung nicht möglich ist, prüfen Sie daher zunächst die Einstellungen in der Benutzerverwaltung.

Logout

Beendet die zugehörige HTTP-Session auf dem Server, sodass die Zugangsdaten für eine neue HTTP-Session verwendet werden können.

Request 

DELETE https://www{hostid}.prozessplattform.de/{tenant}/rest/userSession

Request-Parameter

Parameter-TypNameBedeutung
Pathhost_idHost-ID innerhalb des Hosting-Clusters, auf dem der Mandant betrieben wird (z.B. "88")
PathtenantName des Mandanten (z.B. "musterhausen")
Cookie (Header)JSESSIONIDID einer authentifizierten HTTP-Session

Möglichkeiten zur Authentifizierung & Autorisierung

PERSÖNLICHER LOGIN

Reponse 

  • Header: HTTP-Status-Code 204 ("no content")