Request a support code

GET /v2/users/self/credentials/support-code/

API version

v2

Request method

GET

Operation ID

user-support-code-request

---

Request

Responses

Format

application/json

Beschreibung

The requested support code and the expiry.

Schema-Dokumentation

• expiresAtstring (date-time)

  required

  Expiration of the support code

• supportCodestring

  required

  support code to authenticate yourself against the mittwald support via telephone

Beispiel

{
  "expiresAt": "2024-09-16T00:30:13.913Z",
  "supportCode": "123456"
}

JSON Schema

{
  "properties": {
    "expiresAt": {
      "description": "Expiration of the support code",
      "format": "date-time",
      "type": "string"
    },
    "supportCode": {
      "description": "support code to authenticate yourself against the mittwald support via telephone",
      "example": "123456",
      "type": "string"
    }
  },
  "required": [
    "supportCode",
    "expiresAt"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/users/self/credentials/support-code?forceRecreate=true

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.supportCodeRequest({
  "queryParameters": {
    "forceRecreate": true
  }
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new SupportCodeRequestRequest())
  ->withForceRecreate(true);
$response = $client->user()->supportCodeRequest($request);

var_dump($response->getBody();