Get a specific ApiToken

GET/users/self/api-tokens/{apiTokenId}/

API version

v2

Request method

GET

Operation ID

user-get-api-token

---

Request

• apiTokenIdstring (uuid)

  required

  The id of an ApiToken.

Responses

Format

application/json

Description

The ApiToken.

Schema documentation

• apiTokenIdstring (uuid)

  required
• createdAtstring (date-time)

  required
• descriptionstring

  required
• expiresAtstring (date-time)
• rolesarray of string (one of: api_read, api_write)

  required
  • Array[
  • *string (one of: api_read, api_write)
  ]

Example

{
  "apiTokenId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "createdAt": "2024-11-08T18:07:47.943Z",
  "description": "Api Token - read",
  "expiresAt": "2024-11-08T18:07:47.943Z",
  "roles": [
    "api_read"
  ]
}

JSON Schema

{
  "properties": {
    "apiTokenId": {
      "format": "uuid",
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "example": "Api Token - read",
      "type": "string"
    },
    "expiresAt": {
      "format": "date-time",
      "type": "string"
    },
    "roles": {
      "items": {
        "enum": [
          "api_read",
          "api_write"
        ],
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "apiTokenId",
    "roles",
    "description",
    "createdAt"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/users/self/api-tokens/f0f86186-0a5a-45b2-aa33-502777496347

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.getApiToken({
  "apiTokenId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new GetApiTokenRequest(
  apiTokenId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->user()->getApiToken($request);

var_dump($response->getBody();