Authenticate your external application using the extensionInstanceSecret

POST/extension-instances/{extensionInstanceId}/tokens/

API version

v2

Request method

POST

Operation ID

extension-authenticate-instance

---

Request

• extensionInstanceIdstring (uuid)

  required

Responses

Format

application/json

Description

You received a public token with a short expiry. You can now perform domain actions.

Schema documentation

• expirystring (date-time)

  required
• publicTokenstring

  required

  Set this in the 'x-access-token' header when performing domain actions.

Example

{
  "expiry": "2024-12-18T07:53:16.500Z",
  "publicToken": "string"
}

JSON Schema

{
  "properties": {
    "expiry": {
      "format": "date-time",
      "type": "string"
    },
    "publicToken": {
      "description": "Set this in the 'x-access-token' header when performing domain actions.",
      "type": "string"
    }
  },
  "required": [
    "publicToken",
    "expiry"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"extensionInstanceSecret":"string"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/extension-instances/f0f86186-0a5a-45b2-aa33-502777496347/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.marketplace.extensionAuthenticateInstance({
  "extensionInstanceId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "data": {
    "extensionInstanceSecret": "string"
  }
});

assertStatus(response, 201);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionAuthenticateInstance\ExtensionAuthenticateInstanceRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionAuthenticateInstance\ExtensionAuthenticateInstanceRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new ExtensionAuthenticateInstanceRequest(
  extensionInstanceId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->marketplace()->extensionAuthenticateInstance($request);

var_dump($response->getBody();