Create an access token retrieval key for an extension instance

POST/extension-instances/{extensionInstanceId}/actions/create-access-token-retrieval-key/

API version

v2

Request method

POST

Operation ID

extension-create-retrieval-key

---

Request

• extensionInstanceIdstring (uuid)

  required

Responses

Format

application/json

Description

An access token retrieval key. This key can be used to retrieve a scoped access token from an external application.

Schema documentation

• accessTokenRetrievalKeystring

  required
• userIdstring (uuid)

  required

Example

{
  "accessTokenRetrievalKey": "string",
  "userId": "f0f86186-0a5a-45b2-aa33-502777496347"
}

JSON Schema

{
  "properties": {
    "accessTokenRetrievalKey": {
      "type": "string"
    },
    "userId": {
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "accessTokenRetrievalKey",
    "userId"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/extension-instances/f0f86186-0a5a-45b2-aa33-502777496347/actions/create-access-token-retrieval-key

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

assertStatus(response, 200);
  

PHP SDK

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

$request = (new ExtensionCreateRetrievalKeyRequest(
  extensionInstanceId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->marketplace()->extensionCreateRetrievalKey($request);

var_dump($response->getBody();