Zum Inhalt springen
Developer

E-Mail Login

Anmeldung / E-Mail-Anmeldung

Login und Sitzung3 EndpunkteLogin / E-Mail Login

Anmelden mit E-Mail und Passwort

POST/api/logins

Query-Parameter

tokenIdentifiersstringMit der Sitzung zurückzugebende JWTsErlaubt: iw-externaliw-mqttiw-internalfirebaselanista

Request-Body application/json

  • loginFormLoginUser
    Felder anzeigen (3)
    • usernamestring
    • passwordstring
    • tokenstring

Antworten

200Anmelden mit E-Mail und PasswortSession

Felder anzeigen (15)
  • idinteger

    Primärschlüssel der Sitzung. Interne ID.

  • sessionidstring

    ID der Sitzung.

  • selectedcustomerCustomerProfile

    In der Sitzung ausgewähltes Kundenprofil.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Kundenprofils. Interne ID.

    • slackchannelstring

      Slack-Kanal des Kundenprofils.

    • displaynamestring

      Anzeigename des Kundenprofils.

    • deletedboolean

      Ob das Kundenprofil gelöscht ist.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • startstring (date-time)

    Zeitpunkt, zu dem die Sitzung begonnen hat.

  • refreshed_startstring (date-time)

    Zeitpunkt, zu dem die Sitzung zuletzt erneuert wurde.

  • ipstring

    IP-Adresse des Clients.

  • validboolean

    Ob die Sitzung gültig ist.

  • is_api_keyboolean

    Ob die Sitzung mit einem API-Schlüssel erstellt wurde.

  • is_dgboolean

    Ob die Sitzung für den Kontext der DG (Mitgliedsorganisation) gilt.

  • missing2faboolean

    Ob die Zwei-Faktor-Authentifizierung noch fehlt.

  • start_in_vpnboolean

    Ob die Sitzung in einem VPN gestartet wurde.

  • auth_by_credentialsboolean

    Ob die Sitzung mit Benutzername und Passwort authentifiziert wurde.

  • auth_by_googleboolean

    Ob die Sitzung mit Google authentifiziert wurde.

  • auth_by_microsoftboolean

    Ob die Sitzung mit Microsoft authentifiziert wurde.

  • auth_by_cloudflareboolean

    Ob die Sitzung mit Cloudflare Access authentifiziert wurde.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/logins \
  --header 'content-type: application/json' \
  --data '
{
  "login": {
    "username": "lena.hartmann@example.org",
    "password": "••••••••",
    "token": "string"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "sessionid": "string",
  "selectedcustomer": {
    "id": 42,
    "slackchannel": "string",
    "displayname": "string",
    "deleted": true,
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  },
  "start": "2026-10-15T09:30:00+02:00",
  "refreshed_start": "2026-10-15T09:30:00+02:00",
  "ip": "string",
  "valid": true,
  "is_api_key": true,
  "is_dg": true,
  "missing2fa": true
}

Passwort-Zurücksetzung per E-Mail auslösen

POST/api/logins/resets

Request-Body application/json

  • loginFormLoginUser2
    Felder anzeigen (1)
    • usernamestring

Antworten

200Passwort-Zurücksetzung per E-Mail auslösenSuccess

Felder anzeigen (3)
  • successboolean
  • messagestring
  • error_codesarray<integer>
Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/logins/resets \
  --header 'content-type: application/json' \
  --data '
{
  "login": {
    "username": "lena.hartmann@example.org"
  }
}
'
Antwort 200 application/json
{
  "success": true,
  "message": "string",
  "error_codes": [
    1
  ]
}

Eigene Anmeldung entfernen - erfordert eigenes Passwort

POST/api/logins/delete

Request-Body application/json

  • loginFormLoginUser
    Felder anzeigen (3)
    • usernamestring
    • passwordstring
    • tokenstring

Antworten

200Eigene Anmeldung entfernen - erfordert eigenes PasswortSuccess

Felder anzeigen (3)
  • successboolean
  • messagestring
  • error_codesarray<integer>
Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/logins/delete \
  --header 'content-type: application/json' \
  --data '
{
  "login": {
    "username": "lena.hartmann@example.org",
    "password": "••••••••",
    "token": "string"
  }
}
'
Antwort 200 application/json
{
  "success": true,
  "message": "string",
  "error_codes": [
    1
  ]
}