Zum Inhalt springen
Developer

User2Factor

Benutzer / User2Factor

Login und Sitzung4 EndpunkteUser / User2Factor

Diese Methode erstellt ein neues User2Factor-Objekt für den angegebenen Typ

GET/api/base/2fa/new/{type}

Pfad-Parameter

typePflichtstring

Antworten

200Diese Methode erstellt ein neues User2Factor-Objekt für den angegebenen TypUser2Factor

Felder anzeigen (7)
  • idinteger

    Primärschlüssel des Zwei-Faktor-Eintrags. Interne ID.

  • factor_typestring

    Typ des zweiten Faktors, zum Beispiel TOTP.

  • shared_secretstring

    Geheimer Schlüssel des zweiten Faktors. Wird nur in den Details des Faktors zurückgegeben (Gruppe fa_details).

  • qr_code_contentstring

    Inhalt des QR-Codes zur Einrichtung des zweiten Faktors. Wird nur während der Einrichtung zurückgegeben.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/base/2fa/new/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "factor_type": "string",
  "shared_secret": "string",
  "qr_code_content": "string",
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00",
  "deleted": true
}

Diese Methode verifiziert ein User2Factor-Objekt

GET/api/base/2fa/verify/{id}/{code}

Pfad-Parameter

idPflichtstring
codePflichtstring

Antworten

200Diese Methode verifiziert ein User2Factor-ObjektUser2Factor2

Felder anzeigen (5)
  • idinteger

    Primärschlüssel des Zwei-Faktor-Eintrags. Interne ID.

  • factor_typestring

    Typ des zweiten Faktors, zum Beispiel TOTP.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/base/2fa/verify/42/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "factor_type": "string",
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00",
  "deleted": true
}

Diese Methode löscht ein User2Factor-Objekt; sie erfordert einen gültigen 2FA-Code

DELETE/api/base/2fa/delete/{id}/{code}

Pfad-Parameter

idPflichtstring
codePflichtstring

Antworten

200Diese Methode löscht ein User2Factor-Objekt; sie erfordert einen gültigen 2FA-CodeUser2Factor2

Felder anzeigen (5)
  • idinteger

    Primärschlüssel des Zwei-Faktor-Eintrags. Interne ID.

  • factor_typestring

    Typ des zweiten Faktors, zum Beispiel TOTP.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Anfrage
curl --request DELETE \
  --url https://eure-instanz.iw-erp.de/api/base/2fa/delete/42/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "factor_type": "string",
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00",
  "deleted": true
}

Diese Methode liefert alle verfügbaren User2Factor-Objekte

GET/api/base/2fa/list

Query-Parameter

searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Diese Methode liefert alle verfügbaren User2Factor-Objektearray<User2Factor2>

Felder anzeigen (5)
  • idinteger

    Primärschlüssel des Zwei-Faktor-Eintrags. Interne ID.

  • factor_typestring

    Typ des zweiten Faktors, zum Beispiel TOTP.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/base/2fa/list \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "factor_type": "string",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  }
]