Obtain a service token

POST/services/{accessKeyId}/actions/authenticate/

API version

v2

Request method

POST

Operation ID

servicetoken-authenticate-service

---

Request

• accessKeyIdstring

  required

Responses

Format

application/json

Beschreibung

Authentication has been successful.

Schema-Dokumentation

• accessTokenobject

  required
  • idstring

    required
  • jwtClaimsobject

    required
    • expstring

      required
    • iatstring

      required
    • issstring

      required
    • substring

      required
  • publicTokenstring

    required

Beispiel

{
  "accessToken": {
    "id": "string",
    "jwtClaims": {
      "exp": "string",
      "iat": "string",
      "iss": "string",
      "sub": "string"
    },
    "publicToken": "string"
  }
}

JSON Schema

{
  "properties": {
    "accessToken": {
      "properties": {
        "id": {
          "type": "string"
        },
        "jwtClaims": {
          "properties": {
            "exp": {
              "type": "string"
            },
            "iat": {
              "type": "string"
            },
            "iss": {
              "type": "string"
            },
            "sub": {
              "type": "string"
            }
          },
          "required": [
            "iat",
            "iss",
            "sub",
            "exp"
          ],
          "type": "object"
        },
        "publicToken": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "jwtClaims",
        "publicToken"
      ],
      "type": "object"
    }
  },
  "required": [
    "accessToken"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"secretAccessKey":"string"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/services/string/actions/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.misc.servicetokenAuthenticateService({
  "accessKeyId": "string",
  "data": {
    "secretAccessKey": "string"
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Misc\ServicetokenAuthenticateService\ServicetokenAuthenticateServiceRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Misc\ServicetokenAuthenticateService\ServicetokenAuthenticateServiceRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new ServicetokenAuthenticateServiceRequest(
  accessKeyId: "string",
  body: $body
));
$response = $client->misc()->servicetokenAuthenticateService($request);

var_dump($response->getBody();