Store a new ApiToken

POST /v2/users/self/api-tokens/

API version

v2

Request method

POST

Operation ID

user-create-api-token

---

Request

Responses

Format

application/json

Description

ApiToken was added.

Schema documentation

• tokenstring

  required

  The ApiToken.

Example

{
  "token": "string"
}

JSON Schema

{
  "properties": {
    "token": {
      "description": "The `ApiToken`.",
      "type": "string"
    }
  },
  "required": [
    "token"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"description":"Api Token - read","expiresAt":"2024-09-06T15:53:46.632Z","roles":{"value":["api_read"]}}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/users/self/api-tokens

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.createApiToken({
  "data": {
    "description": "Api Token - read",
    "expiresAt": "2024-09-06T15:53:46.632Z",
    "roles": {
      "value": [
        "api_read"
      ]
    }
  }
});

assertStatus(response, 201);
  

PHP SDK

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

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

$request = (new CreateApiTokenRequest(
  body: $body
));
$response = $client->user()->createApiToken($request);

var_dump($response->getBody();