Anmeldung mit einem Transfer-Token

POST/v1/authenticate/token/

API version

v1

Request method

POST

Operation ID

authenticateWithToken

---

Löst ein zuvor über /authentication/accesstoken erstelltes kurzlebiges Transfer-Token gegen ein reguläres API-Token ein. Das Transfer-Token wird dabei als Authorization-Header übermittelt.

Request

Responses

Format

application/json

Beschreibung

Authentifizierung erfolgreich

Schema-Dokumentation

• tokenstring

  required

  Das API-Token

• expiresstring (datetime)

  required

  Ablaufzeitpunkt des Tokens

Beispiel

Content-Type: application/json

{
  "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
    }
  }
}

Usage examples

cURL

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