Authenticate yourself to get an access token

POST/authenticate/

API version

v2

Request method

POST

Operation ID

user-authenticate

---

Request

Responses

Format

application/json

Description

Your authentication request was successfull and you've got an access token.

Schema documentation

• expiresstring (date-time)

  required

  The expiration date of the token.

• refreshTokenstring

  required

  Refresh token to refresh your access token even after it has expired.

• tokenstring

  required

  Public token to identify yourself against the api gateway.

Example

{
  "expires": "2024-12-18T07:53:22.501Z",
  "refreshToken": "string",
  "token": "string"
}

JSON Schema

{
  "properties": {
    "expires": {
      "description": "The expiration date of the token.",
      "format": "date-time",
      "type": "string"
    },
    "refreshToken": {
      "description": "Refresh token to refresh your access token even after it has expired.",
      "type": "string"
    },
    "token": {
      "description": "Public token to identify yourself against the api gateway.",
      "type": "string"
    }
  },
  "required": [
    "token",
    "refreshToken",
    "expires"
  ],
  "type": "object"
}

Format

application/json

Description

Multi factor authentication is activated for this user. After calling this, you need to call '/authentication/mfa' with a valid multi factor code.

Schema documentation

• name"SecondFactorRequired"

Example

{
  "name": "SecondFactorRequired"
}

JSON Schema

{
  "properties": {
    "name": {
      "enum": [
        "SecondFactorRequired"
      ],
      "type": "string"
    }
  },
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"email":"a.lovelace@example.com","password":"string"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/authenticate

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.user.authenticate({
  "data": {
    "email": "a.lovelace@example.com",
    "password": "string"
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\User\Authenticate\AuthenticateRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\User\Authenticate\AuthenticateRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// AuthenticateRequestBody to learn how to construct a valid instance
$body = new AuthenticateRequestBody(/* TODO: ... */);

$request = (new AuthenticateRequest(
  body: $body
));
$response = $client->user()->authenticate($request);

var_dump($response->getBody();