Generate an Extension secret for the given Extension

POST/contributors/{contributorId}/extensions/{extensionId}/secret/

API version

v2

Request method

POST

Operation ID

extension-generate-extension-secret

---

This generates a new Extension secret for the given Extension. If an Extension secret existed previously, it will deprecate the existing secret. This means, it will be invalidated after approximately one day.

Request

• contributorIdstring

  required
• extensionIdstring (uuid)

  required

Responses

Format

application/json

Description

A new Extension secret has been generated.

Schema documentation

• secretstring

  required
• secretIdstring (uuid)

  required

Example

Content-Type: application/json

{
  "secret": "string",
  "secretId": "f0f86186-0a5a-45b2-aa33-502777496347"
}

JSON Schema

{
  "properties": {
    "secret": {
      "type": "string"
    },
    "secretId": {
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "secretId",
    "secret"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/contributors/string/extensions/f0f86186-0a5a-45b2-aa33-502777496347/secret

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.extensionGenerateExtensionSecret({
  "contributorId": "string",
  "extensionId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ExtensionGenerateExtensionSecretRequest(
  contributorId: "string",
  extensionId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->marketplace()->extensionGenerateExtensionSecret($request);

var_dump($response->getBody();