Login über eine der Zugriffsmöglichkeiten

POST/authenticate/

API version

v1

Request method

POST

Operation ID

authenticate

---

Diese Operation liefert bei erfolgreichem Login ein access_token aus. Es kann ein zweiter Faktor notwendig sein. Dieser kann per TOTP generiert werden oder per E-Mail empfangen werden. Im letzten Fall muss dann zusätzlich eine Device-ID mitgeschickt.

Request

Responses

Format

application/json

Beschreibung

Login Token und Ablaufzeitpunkt

Schema-Dokumentation

• tokenstring

  required

  Das API-Token

• expiresstring (datetime)

  required

  Ablaufzeitpunkt des Tokens

Beispiel

{
  "token": "string",
  "expires": "string"
}

JSON Schema

{
  "title": "AuthenticationResponse",
  "required": [
    "expires",
    "token"
  ],
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "description": "Das API-Token",
      "readOnly": true
    },
    "expires": {
      "type": "string",
      "description": "Ablaufzeitpunkt des Tokens",
      "format": "datetime",
      "readOnly": true
    }
  }
}

Format

application/json

Beschreibung

Login ist nicht fehlerhalft, erfordert aber einen weiteren Faktor

Schema-Dokumentation

• namestring (one of: TOTP, DeviceCookie)

  required
• deviceIdstring

  required

Beispiel

{
  "name": "TOTP",
  "deviceId": "string"
}

JSON Schema

{
  "title": "AuthenticationIncompleteResponse",
  "type": "object",
  "required": [
    "name",
    "deviceId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "enum": [
        "TOTP",
        "DeviceCookie"
      ]
    },
    "deviceId": {
      "type": "string"
    }
  }
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"username":"string","password":"string","multiFactorCode":"string","deviceId":"string"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v1/authenticate